Classes assistantes ¶

Note: cette section est en cours de développement.

Yii procure de nombreuses classes qui vous aident à simplifier le code de tâches courantes, telles que la manipulation de chaînes de caractères ou de tableaux, la génération de code HTML, et ainsi de suite. Ces classes assistantes sont organisées dans l'espace de noms yii\helpers et sont toutes des classes statiques (ce qui signifie qu'elles ne contiennent que des propriétés et des méthodes statiques et ne doivent jamais être instanciées).

Vous utilisez une classe assistante en appelant directement une de ses méthodes statiques, comme ceci :

use yii\helpers\Html;

echo Html::encode('Test > test');

Note: pour prendre en charge la personnalisation des classes assistantes, Yii éclate chacune des classes assistantes du noyau en deux classes : une classe de base (p. ex. BaseArrayHelper) et une classe concrète (p. ex. ArrayHelper). Lorsque vous utilisez une classe assistante, vous devez utiliser la version concrète uniquement et ne jamais utiliser la classe de base.

Classes assistantes du noyau ¶

Les versions de Yii fournissent les classes assistantes du noyau suivantes :

• ArrayHelper
• Console
• FileHelper
• FormatConverter
• Html
• HtmlPurifier
• Imagine (provided by yii2-imagine extension)
• Inflector
• Json
• Markdown
• StringHelper
• Url
• VarDumper

Personnalisation des classes assistantes ¶

Pour personnaliser une classe assistante du noyau (p. ex. yii\helpers\ArrayHelper), vous devez créer une nouvelle classe qui étend la classe de base correspondant à la classe assistante (p. ex. yii\helpers\ArrayHelper), y compris son espace de noms. Cette classe sera ensuite configurée pour remplacer l'implémentation originale de Yii.

L'exemple qui suit montre comment personnaliser la méthode merge() de la classe yii\helpers\ArrayHelper :

<?php

namespace yii\helpers;

class ArrayHelper extends BaseArrayHelper
{
    public static function merge($a, $b)
    {
        // votre implémentation personnalisée
    }
}

Sauvegardez votre classe dans un fichier nommé ArrayHelper.php. Le fichier peut se trouver dans n'importe quel dossier, par exemple, @app/components.

Ensuite, dans le script d'entrée de votre application, ajoutez la ligne de code suivante, après l'inclusion du fichier yii.php pour dire à la classe autoloader de Yii de charger votre classe personnalisée au lieu de la classe assistance originale de Yii.

Yii::$classMap['yii\helpers\ArrayHelper'] = '@app/components/ArrayHelper.php';

Notez que la personnalisation d'une classe assistante n'est utile que si vous désirez changer le comportement d'une fonction existante de la classe assistante. Si vous désirez ajouter une fonction additionnelle à utiliser dans votre application, le mieux est de créer une classe assistante séparée pour cela.