Un contrôleur (jControllerDaoCrud) est fourni avec jelix pour faire du CRUD. CRUD veut dire Create, Read, Update, Delete. En substance, c'est un contrôleur qui contient toutes les actions pour créer, lire, mettre à jour et effacer un enregistrement d'une table, et lister les enregistrements de cette table. Il lui faut en gros pour fonctionner, le nom d'un fichier DAO et d'un fichier jForms. Il s'occupe du reste.

C'est donc un contrôleur permettant de mettre en place rapidement une gestion d'un enregistrement de table.

Note : ce contrôleur ne fonctionne que pour les tables avec une clé primaire simple. Si votre table possède une clé primaire composée de deux champs il faut utiliser jControllerDaoCrudDfk. Pour le reste vous devrez faire votre propre contrôleur.

Pour l'utiliser, il faut créer un contrôleur dans votre module, qui hérite non pas de jController, mais de jControllerDaoCrud. Exemple, dans un fichier samplecrud.classic.php

class sampleCrudCtrl extends jControllerDaoCrud {

}

Il faut ensuite lui indiquer un DAO qui utilise la table que l'on veut gérer, et un fichier jforms, qui permettra d'afficher le formulaire d'édition d'un enregistrement. Cela se fait au travers des propriétés $dao et $form :

class sampleCrudCtrl extends jControllerDaoCrud {

    protected $dao = 'testapp~products';

    protected $form = 'testapp~products';

}

Et c'est tout ! En imaginant que ce contrôleur se trouve dans le module main, affichez alors la page (url pour une appli en mode basic_significant)

  index.php/main/samplecrud/index

Vous avez alors toutes les pages qu'il faut pour gérer les enregistrements de la table.

Important : par défaut, le controleur récupère la réponse HTML définie dans jelix, c'est à dire qu'il vous faut faire une réponse HTML personnalisée. Si vous n'en avez pas, rien ne s'affichera. Si vous ne voulez pas faire de réponse personnalisée (ce qui est dommage), il faudra configurer le contrôleur.

Note : vous pouvez aussi utiliser la commande jelix createdaocrud qui vous permet de créer à la fois le contrôleur, le dao et le formulaire, en indiquant la table que l'on veut gérer.

php cmd.php createdaocrud le_module la_table le_nom_du_controleur

Voir l'aide de cette commande (php cmd.php help createdaocrud) pour les options.

Il se peut que le comportement par défaut du contrôleur et des affichages des pages ne correspondent pas à ce que vous voulez, et qu'il faille faire des choses au niveau du formulaire (pré remplir à la main des listbox par exemple). Voici donc ce qui est possible de faire.

Indiquer le profil jDb ¶

  protected $dbProfile = 'admin';

Configurer la réponse ¶

    protected function _getResponse(){
        return $this->getResponse('html');
    }

    protected function _getResponse(){
        $rep = $this->getResponse('html');
        $rep->addCSSLink('admin.css');
        $rep->body->assignZone('menu', 'adminmenu');
        return $rep;
    }

Configurer le formulaire ¶

    protected function _createForm($formId = null) {
        return jForms::create($this->form, $formId);
    }

    protected function _getForm($formId = null) {
        return jForms::get($this->form, $formId);
    }

Définir les templates ¶

    protected $listTemplate = 'jelix~crud_list';
    protected $editTemplate = 'jelix~crud_edit';
    protected $viewTemplate = 'jelix~crud_view';

    $rep->body->assign('MAIN', $resultatTemplateAction);

class sampleCrudCtrl extends jControllerDaoCrud {
   //...
    protected $templateAssign = 'AUTRE';
   //...
}

Elle est affichée par l'action index. Des propriétés du contrôleur CRUD permettent de configurer l'affichage de la liste.

Nombre d'enregistrements par page ¶

    protected $listPageSize = 20;

Liste des propriétés ¶

    protected $propertiesForList = array('titre','date_creation','auteur');

Ordre et critères d'affichage ¶

    protected $propertiesForRecordsOrder = array('date'=>'desc', 'title'=>'asc');

Configuration avancée de la liste ¶

Elle est affichée par les actions precreate, create, savecreate.

L'action precreate crée et prépare le formulaire puis redirige vers l'action create. L'action create affiche le formulaire pour éditer le nouvel enregistrement, et envoi les données vers l'action savecreate. Cette dernière action vérifie le contenu du formulaire, et enregistre les données si c'est ok.

En plus de la méthode _create indiquée plus haut pour personnaliser l'affichage, vous pouvez aussi redéfinir les autres méthodes:

• _preCreate($form): pour préparer le formulaire juste après sa création.
• _checkData($form, $calltype): pour vérifier des données supplémentaires. Cette méthode est aussi appelée par la méthode saveupdate (voir plus bas).
• _beforeSaveCreate($form, $form_daorec): pour faire des choses juste avant la sauvegarde du nouvel enregistrement.
• _afterCreate($form, $id, $resp): pour faire des traitements après la sauvegarde.

Elle est affichée et gérée par les actions preupdate, editupdate et saveupdate.

Le processus suit le même schéma que pour la création d'un enregistrement. preupdate crée et prépare le formulaire et redirige vers l'action editupdate. L'action editupdate affiche le formulaire pour éditer l'enregistrement, et envoi les données vers l'action saveupdate. Cette dernière action vérifie le contenu du formulaire, et enregistre les données si c'est ok.

En plus de la méthode _update indiquée plus haut pour personnaliser l'affichage, vous pouvez aussi redéfinir les autres méthodes:

• _preUpdate($form): pour préparer le formulaire juste après sa création.
• _checkData($form, $calltype): pour vérifier des données supplémentaires.
• _beforeSaveUpdate($form, $form_daorec, $id): pour faire des choses juste avant la sauvegarde de l'enregistrement.
• _afterUpdate($form, $id, $resp): pour faire des traitements après la sauvegarde.

Elle est affichée par l'action delete. Vous pouvez redéfinir la méthode _delete pour faire des traitements additionnels.

Si vous avez activé les urls significatives, voici le contenu que vous pouvez mettre dans le fichier urls.xml du module, dans l’hypothèse ici où le contrôleur s'appelle "mycrud" et que l'on veut avoir des urls vers ce contrôleur qui commencent par "thedata" :

<url pathinfo="/thedata/" action="mycrud:index" />
<url pathinfo="/thedata/view/:id" action="mycrud:view" />
<url pathinfo="/thedata/precreate" action="mycrud:precreate" />
<url pathinfo="/thedata/create" action="mycrud:create" />
<url pathinfo="/thedata/savecreate" action="mycrud:savecreate" />
<url pathinfo="/thedata/preedit/:id" action="mycrud:preupdate" />
<url pathinfo="/thedata/edit/:id" action="mycrud:editupdate" />
<url pathinfo="/thedata/save/:id" action="mycrud:saveupdate" />
<url pathinfo="/thedata/delete/:id" action="mycrud:delete" />

Il y a donc en tout 9 actions donc 9 urls à définir.