Jaxon

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

La librairie Jaxon peut démarrer à partir d'un fichier de configuration, qui définit tout ce dont la librairie a besoin pour fonctionner: les fonctions, les classes, les vues, et les options.

// Configuration
jaxon()->app()->setup('/path/to/config.php');

Le fichier de configuration comporte deux sections principales, identifiées avec les mots-clés app et lib.

La section lib contient la configuration de la librairie, et de ses plugins.

La section app contient la configuration des fonctions, des classes, et des vues.

Les fonctions

La section app.functions de la configuration contient un tableau de fonctions à exporter.

En voici un exemple.

    'app' => [
        'functions' => [
            'hello_world',
            'sayhello',
        ],
    ],

Des options peuvent être ajoutées aux fonctions.

    'app' => [
        'functions' => [
            'hello_world' => [
                'mode' => "'asynchronous'",
            ],
        ],
    ],

Les classes

La section app.classes de la configuration contient un tableau de classes à exporter.

En voici un exemple.

    'app' => [
        'classes' => [
            'HelloWorld',
            'OtherClass',
        ],
    ],

Des options peuvent être ajoutées aux méthodes des classes.

    'app' => [
        'classes' => [
            'HelloWorld' => [
                'setColor' => [
                    'mode' => "'synchronous'"
                ],
                '*' => [
                    'mode' => "'asynchronous'"
                ],
            ],
        ],
    ],

Les répertoires

La section app.directories de la configuration contient un tableau des répertoires dans lesquels se trouvent les classes à exporter. Chaque entrée du tableau représente un répertoire, défini avec son chemin complet et les informations suivantes:

• namespace : le namespace associé au répertoire.
• autoload : optionnel, booléen, true par défaut, indique si les classes dans le répertoire doivent être autoloadées.
• separator : optionnel, le séparateur dans les noms des classes javascript, peut prendre les valeurs . (par défaut) ou _.
• protected : optionnel, un tableau de méthodes à ne pas exporter dans les classes javascript, vide par défaut.

En voici un exemple.

    'app' => [
        'directories' => [
            dirname(__DIR__) . '/classes' => [
                'namespace' => '\\Jaxon\\App',
                // 'autoload' => true,
                // 'separator' => '.',
                // 'protected' => [],
            ],
        ],
    ],

Des options peuvent être ajoutées aux méthodes des classes.

    'app' => [
        'directories' => [
            dirname(__DIR__) . '/classes' => [
                'namespace' => '\\Jaxon\\App',
                // 'autoload' => true,
                // 'separator' => '.',
                // 'protected' => [],
                \Jaxon\App\Test\Bts::class => [
                    '*' => [
                        'mode' => "'asynchronous'",
                    ]
                ]
            ],
        ],
    ],

Les vues

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.

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.

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

    'app' => [
        'views' => [
            'users' => [
                '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 = jaxon()->view()->render('users::path/to/view');

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

    'app' => [
        'views' => [
            'users' => [
                'directory' => '/path/to/users/views',
                'extension' => '.tpl',
                'renderer' => 'smarty',
            ]
        ],
        'options' => [
            'views' => [
                'default' => 'users',
            ]
        ]
    ],

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

La vue de pagination

Avec Armada, les liens de pagination peuvent être affichés avec n'importe quel moteur de templates (voir la documentation des vues). Pour personnaliser la pagination, il faut créer tous les templates de pagination dans un répertoire, puis l'indiquer dans la configuration des vues.

        'views' => [
            'pagination' => [
                'directory' => '/chemin/vers/le/repertoire',
                'extension' => '.tpl',
                'renderer' => 'smarty',
            ],
        ],

Par exemple, voici le contenu du fichier /chemin/vers/le/repertoire/wrapper.tpl, qui est un template Smarty.

{if !empty($prev)}
{$prev}
{/if}
{$links}
{if !empty($next)}
{$next}
{/if}