Les classes
- Version 4.x
- Version 3.x
- Version 2.x
La configuration
La section app.classes de la configuration de Armada 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 les informations suivantes:
directory: le chemin complet du répertoire.namespace: le namespace associé au répertoire.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, par défaut vide.
Ce tableau doit toujours contenir au moins une entrée. Le code suivant est extrait de l'exemple d'utilisation de Armada.
'app' => [
'classes' => [
[
'directory' => dirname(__DIR__) . '/classes',
'namespace' => '\\Jaxon\\App',
// 'separator' => '.',
// 'protected' => [],
],
],
],Les options des requêtes Jaxon peuvent être définies dans la section app.options.classes du fichier de configuration.
'app' => [
'options' => [
'classes' => [
\Jaxon\App\Test\Bts::class => [
'*' => [
'mode' => "'asynchronous'",
]
]
],
],
],La classe Jaxon\Sentry\Armada
Les classes de l'application doivent hériter de Jaxon\Sentry\Armada, qui leur fournit des fonctions pour accéder à d'autres classes, et pour gérer les requêtes, les réponses, les vues et les sessions.
La méthode instance() (ou sa version courte cl()) retourne une instance d'un autre classe Jaxon dans le même namespace. Elle prend en paramètre le nom de la classe, sans le namespace.
Par exemple l'instance de la classe \Namespace\Subdir\Class dans le namespace Namespace sera retrouvée avec l'appel suivant.
$myClass = $this->instance(':Subdir.Class');Si les deux classes sont dans le même répertoire, le sous-répertoire peut être omis, et le nom de la classe est précédé par un point.
$myClass = $this->instance('.Class');L'objet Response
Toutes les instances de classes enregistrées dans une application Armada ont accès à un même objet Response avec leur attribut response.
Cet objet est automatiquement initialisé par la librairie, et permet de construire la réponse à une requête en appelant plusieurs méthodes ou plusieurs classes.
class ClassA extends \Jaxon\Sentry\Armada
{
public function doA()
{
$this->response->alert('ClassA::doAB() called.');
// Appeler la méthode doB() de cette classe
$this->doB();
return $this->response;
}
public function doB()
{
$this->response->alert('ClassA::doB() called.');
// Appeler la méthode doB() de la classe ClassB
$this->instance('.ClassB')->doB();
return $this->response;
}
}class ClassB extends \Jaxon\Sentry\Armada
{
public function doB()
{
$this->response->alert('ClassB::doB() called.');
return $this->response;
}
}La fabrique de requête
La méthode request() (ou sa version courte rq()) renvoie une requête vers la classe qui l'appelle.
Elle fournit une interface fluide qui transforme chaque appel reçu en requête vers la même méthode dans la classe qui l'appelle.
class ClassA extends \Jaxon\Sentry\Armada
{
public function doA()
{
// Lier le click sur le bouton avec l'id "btn-a" à un appel à la méthode doB() de cette classe
$this->response->onClick('btn-a', $this->rq()->doB());
// Lier le click sur le bouton avec l'id "btn-b" à un appel à la méthode doB() de la classe ClassB
$this->response->onClick('btn-b', $this->ct('.ClassB')->rq()->doB());
return $this->response;
}
}Le contenu de la page peut être passé en paramètre aux appels à l'aide de la fabrique de requête ou de l'API jQuery PHP, et leurs fonctions globales rq() et jq().
class ClassA extends \Jaxon\Sentry\Armada
{
public function doA()
{
// Paramètre avec la fabrique de requête
$this->response->onClick('btn-a', $this->rq()->doB(rq()->form('form-user')));
// Paramètre avec l'API jQuery PHP
$this->response->onClick('btn-b', $this->ct('.ClassB')->rq()->doB(jq('#username')->val()));
return $this->response;
}
}L'API jQuery PHP
La méthode jQuery() (ou sa version courte jq()) ajoute un appel jQuery dans la réponse.
class ClassA extends \Jaxon\Sentry\Armada
{
public function doA()
{
// Lier le click sur le bouton avec l'id "btn-a" à un appel à la méthode doB() de cette classe
$this->jQuery('#btn-a')->click($this->rq()->doB(rq()->form('form-user')));
// Lier le click sur le bouton avec l'id "btn-b" à un appel à la méthode doB() de la classe ClassB
$this->jQuery('#btn-b')->click($this->ct('.ClassB')->rq()->doB(jq('#username')->val()));
return $this->response;
}
}L'appel $this->jQuery() est l'équivalent de $this->response->jQuery().
La pagination
La méthode paginator() (ou sa version courte pg()) crée les liens de pagination vers une méthode d'une classe Jaxon.
class ClassA extends \Jaxon\Sentry\Armada
{
public function doA($pageNumber)
{
// Insert the pagination links into the page
$pagination = $this->paginator($totalPages, $itemsPerPage, $currentPage)->doA(rq()->page());
$this->response->assign('pagination-links', 'innerHTML', $pagination);
return $this->response;
}
}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' => array(
'pagination' => array(
'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}