Jaxon

•    Version 4.x
•    Version 3.x
•    Version 2.x

Armada fournit pour l'affichage des vues une API simple et unique, qui peut être utilisée avec différents moteurs de templates.

L'installation

Pour afficher les vues avec un moteur de template, il faut d'abord installer le package correspondant. Des packages existent actuellement pour 6 moteurs de templates.

• Twig https://github.com/jaxon-php/jaxon-twig. Son identifiant est twig.
• Smarty https://github.com/jaxon-php/jaxon-smarty. Son identifiant est smarty.
• Blade https://github.com/jaxon-php/jaxon-blade. Son identifiant est blade.
• Dwoo https://github.com/jaxon-php/jaxon-dwoo. Son identifiant est dwoo.
• Latte https://github.com/jaxon-php/jaxon-latte. Son identifiant est latte.
• RainTpl https://github.com/jaxon-php/jaxon-raintpl. Son identifiant est raintpl.

Plusieurs peuvent être utilisés simultanément dans une application Armada.

La configuration

La section app.views de la configuration de Armada contient un tableau des répertoires dans lesquels se trouvent les vues. Chaque entrée du tableau représente un répertoire, défini avec les informations suivantes:

• directory : le chemin complet du répertoire.
• extension : l'extension à ajouter aux vues du répertoire.
• renderer : l'identifiant du moteur de templates à utiliser pour afficher les vues du répertoire.
• register : optionnel, indique s'il faut enregistrer le répertoire dans le moteur de template, par défaut true.

Chaque entrée du tableau est indexé par un identifiant unique, qui sera utilisé lors de l'affichage pour indiquer dans quel répertoire se trouve la vue.

L'affichage

La configuration suivante définit un répertoire /path/to/users/views qui contient des templates Smarty.

    'app' => array(
        'views' => array(
            'users' => array(
                'directory' => '/path/to/users/views',
                'extension' => '.tpl',
                'renderer' => 'smarty',
            ),
        ),
    ),

Le code suivant affiche le template dans le fichier /path/to/users/views/path/to/view.tpl avec le moteur Smarty.

    $html = $this->view()->render('users::path/to/view');

Si on ajoute dans la configuration un namespace par défaut, alors l'identifiant peut être omis dans l'appel.

    'app' => array(
        'views' => array(
            'users' => array(
                'directory' => '/path/to/users/views',
                'extension' => '.tpl',
                'renderer' => 'smarty',
            ),
        ),
        'options' => array(
            'views' => array(
                'default' => 'users',
            ), 
        ),
    ),

    $html = $this->view()->render('path/to/view');

Les variables

Les fonctions suivantes permettent de passer des variables aux vues.

La fonction share() rend une variable disponible dans toutes les vues.

    $this->view()->share('count', 5);

La fonction set() rend une variable disponible dans la prochaine vue à afficher. Elle peut être chaînée avec la fonction render().

    $this->view()->set('count', 5)->set('current', 1)->render('path/to/view');

La fonction with() ajoute une variable à la vue créée avec la fonction render().

    $this->view()->render('path/to/view')->with('count', 5)->with('current', 1);

Les variables peuvent aussi être passées dans un tableau en second paramètre de la fonction render().

    $this->view()->render('path/to/view', array('count' => 5, 'current' => 1));

Ajouter un moteur de template

Pour ajouter un moteur de templates à Armada, il faut créer une classe qui implémente l'interface Jaxon\Sentry\Interfaces\View, définie dans le package jaxon-sentry.

interface View
{
    /**
     * Add a namespace to the view renderer
     *
     * @param string        $sNamespace         The namespace name
     * @param string        $sDirectory         The namespace directory
     * @param string        $sExtension         The extension to append to template names
     *
     * @return void
     */
    public function addNamespace($sNamespace, $sDirectory, $sExtension = '');

    /**
     * Render a view
     * 
     * @param Store         $store        A store populated with the view data
     * 
     * @return string        The string representation of the view
     */
    public function render(\Jaxon\Sentry\View\Store $store);
}

La méthode addNamespace() est appelée pour chaque répertoire associé au moteur de template dans la la configuration. La méthode render() retourne le code HTML d'une vue. Elle prend en paramètre un objet de la classe \Jaxon\Sentry\View\Store qui contient les informations sur la vue.

Après avoir défini la classe, il faut l'enregistrer dans Armada avec l'appel suivant.

jaxon()->armada()->addViewRenderer($myViewId, function(){
    return new View();
});

Le paramètre $myViewId est l'identifiant qui sera défini comme valeur de l'option renderer dans la configuration.