Création d'un CRUD

Piste : • 1.5.x
Cette page est en lecture seule. Vous pouvez afficher le texte source, mais ne pourrez pas le modifier. Contactez votre administrateur si vous pensez qu'il s'agit d'une erreur.
Nous avons vu [[fr:tutoriels:jelixnews-1.6:formulaire-de-news|dans un chapitre précédent]],
comment créer un formulaire simple. Cependant nous n'avons pas réalisé tout ce
qu'une interface d'administration de donnée exige : vérification de la saisie,
affichage des erreurs, affichage d'une liste de news avec des liens pour
modifier, suppression, modification etc...

Ce sont souvent des développements rébarbatifs, aussi Jelix propose une solution :
un système de formulaire jForms, et un contrôleur générique pour faire du CRUD
(Create/Read/Update/Delete).


===== Création du formulaire jForms =====

On va d'abord créer un formulaire jForms. Il s'agit d'un fichier XML dans
lequel on liste tout les champs de saisie du formulaire, ainsi que leur
libellé, les éventuelles contraintes sur leur contenu etc..

Il existe une commande jelix-scripts qui permet de créer un formulaire jForms
à partir d'un DAO, et ça tombe bien, nous avons déjà un DAO pour les news.
Dans le répertoire de l'application, tapez la commande suivante :

<code bash>
php cmd.php createform news newsform news
</code>

createform prend trois arguments :
  - le nom du module,
  - le nom du futur formulaire,
  - le nom du DAO.

Nous obtenons alors dans le fichier @@actu.org/modules/news/forms/newsform.form.xml@@ :

<code xml>
<?xml version="1.0" encoding="utf-8"?>
<form xmlns="http://jelix.org/ns/forms/1.1">

 <input ref="sujet" required="true" maxlength="255">
   <label>Sujet</label>
 </input>

  <textarea ref="texte" required="true">
    <label>Texte</label>
  </textarea>

  <input ref="news_date" required="true" type="date">
    <label>News Date</label>
  </input>

  <submit ref="_submit">
    <label>ok</label>
  </submit>
</form>
</code>

La commande génère un formulaire très basique qu'il faut la plupart du temps
adapter car le script ne peut pas tout deviner. Ici par exemple, il va falloir
indiquer des libellés plus parlant. Dans d'autre cas, il vous faudra
certainement changer le type de champs de saisie,etc.

Changeons les libellés, indiquons que tous les champs sont obligatoires et
ajoutons une petite aide pour la date :

<code xml>
<?xml version="1.0" encoding="utf-8"?>
<form xmlns="http://jelix.org/ns/forms/1.1">

 <input ref="sujet" required="true" maxlength="255">
   <label>Sujet de la news</label>
 </input>

  <textarea ref="texte" required="true">
    <label>Contenu</label>
  </textarea>

  <input ref="news_date" required="true" type="date">
    <label>Date</label>
    <hint>Le format de la date est aaaa-mm-jj</hint>
  </input>

  <submit ref="_submit">
    <label>ok</label>
  </submit>
</form>

</code>

Notre formulaire est prêt à être traité. On devrait utiliser l'API de jForms
pour le manipuler, mais dans notre tutoriel, le contrôleur générique va le faire
pour nous.



===== Création du contrôleur CRUD =====

Créons le fichier @@F@modules/news/controllers/admin.classic.php@@, et
commençons à y écrire un contrôleur pour faire une gestion de news :

<code php>
<?php

class adminCtrl extends jControllerDaoCrud {

}

?>
</code>

Le contrôleur n'hérite pas de @@C@jController@@, mais de
@@C@jControllerDaoCrud@@. C'est un contrôleur qui contient un ensemble d'actions
prédéfinies. Il suffit alors de compléter certaines informations dans ses
propriétés pour que la gestion des news soit opérationnelle.

En principe, dans un premier temps, indiquer le dao et le formulaire à utiliser
suffit :

<code php>
<?php

class adminCtrl extends jControllerDaoCrud {

    protected $dao = 'news~news';

    protected $form = 'news~newsform';

}

?>
</code>

Lancez maintenant dans votre navigateur : http://localhost:8080/index.php/news/admin/.

Vous devriez obtenir une liste de news avec des liens pour les voir, un lien
pour créer un nouvel enregistrement etc.. Bref, une véritable gestion
opérationnelle des news.

===== Personnaliser le contrôleur CRUD =====

Si on veut changer des propriétés de la réponse HTML par défaut, qui,
dans notre cas, est la classe @@C@myHtmlResponse@@, il faut redéfinir
la méthode @@M@_getResponse@@, spécifique à @@C@jControllerDaoCrud@@. On va
ici indiquer un titre de page.

<code php>
<?php

class adminCtrl extends jControllerDaoCrud {

    protected $dao = 'news~news';
    protected $form = 'news~newsform';

    protected function _getResponse(){
        $rep = $this->getResponse('html');
        $rep->title = "Gestion des news";
        return $rep;
    }
}
?>
</code>

On peut aussi redéfinir les templates pour chaque page du contrôleur CRUD.
Par défaut, le contrôleur CRUD utilise ceux fourni par le module jelix.
Par exemple, créons un template pour la liste des news. Recopions
le template @@F@vendor/jelix/jelix/lib/jelix/core-modules/jelix/templates/crud_list.tpl@@ dans
@@F@actu.org/modules/news/templates@@ et changeons par exemple le titre en @@E@<h1>@@:


<code html>
<h1>Gestion des news</h1>
...
</code>

On va ensuite indiquer ce template au contrôleur:

<code php>
<?php

class adminCtrl extends jControllerDaoCrud {

    protected $dao = 'news~news';
    protected $form = 'news~newsform';

    protected $listTemplate = 'news~crud_list';
...
}
?>
</code>


Maintenant vous pouvez relancer http://localhost:8080/index.php/news/admin/, et
vous devriez voir votre nouveau template.

Pour personnaliser encore plus, voir le [[https://docs.jelix.org/fr/manuel-1.6/modules/controleurs/crud|chapitre sur le contrôleur CRUD dans le manuel]].


=== Note ===

Nous avions créé le formulaire, le dao et le contrôleur CRUD séparément, mais
il est possible en une seule ligne de commande de créer ces trois fichiers
directement :

<code bash>
  php cmd.php createdaocrud <module> <table> [<ctrlname>]

  # soit :

  php cmd.php createdaocrud news news admin
</code>

Et ensuite, on peut directement appeler la page correspondante http://localhost:8080/index.php/news/admin/ pour voir le résultat.
fr/tutoriels/jelixnews-1.6/crud.txt · Dernière modification : 2020/08/03 15:17 de 127.0.0.1