Créer un nouvel objet éditorial A pas de chat…

, par Matthieu Marcillaud

Nous allons étudier comment créer un nouvel objet éditorial très simple et sans relation, pour SPIP 2.0. De ces explications vont naître un petit plugin d’exemple. Mais le tout fait appel à un grand nombre de fonctions de SPIP et n’est pas évident à mettre en œuvre. Nous en profitons pour relever un défi : aucun affichage géré en PHP, mais tout en squelette SPIP.

Nous allons définir un nouvel objet SPIP. Cet objet sera un « chat » ! Pourquoi pas ? Nous allons voir dans un premier temps comment créer la table SQL correspondante et donner un exemple de mise à jour. Nous décrirons ensuite la création d’une page de visualisation des chats, celle pour éditer un chat existant, et le formulaire CVT qui correspond. Enfin, nous ajouterons une action pour pouvoir supprimer un chat ! Et que la SPA ne m’en veuille pas trop, ce n’est qu’un exemple ! Et pour terminer, nous verrons comment interfacer le plugin « Champs Extras 2 » sur le nouvel objet !

Création du plugin

On commence par un fichier plugin.xml rudimentaire. On déclare dedans cependant une information qui peut être utile : 1 dépendance, à SPIP 2.

  1. <plugin>
  2. <nom>Chats (plugin d'exemple)</nom>
  3. <auteur>Matthieu Marcillaud</auteur>
  4. <version>1.0</version>
  5. <etat>stable</etat>
  6. <description>
  7. Ce plugin est un exemple de cr&eacute;ation
  8. d'un nouvel objet &eacute;ditorial dans SPIP
  9. </description>
  10. <lien>http://marcimat.magraine.net/?article344</lien>
  11. <icon>images/chat-128.png</icon>
  12. <prefix>chats</prefix>
  13.  
  14. <necessite id="SPIP" version="[2.0.9;]" />
  15.  
  16. </plugin>

Télécharger

Nous créons un premier dossier images pour stocker les images relatives au plugin, et un dossier lang pour stocker les traductions, avec un premier fichier dedans chats_fr.php contenant quelques premiers mots :

  1. <?php
  2.  
  3. // This is a SPIP language file -- Ceci est un fichier langue de SPIP
  4. if (!defined("_ECRIRE_INC_VERSION")) return;
  5.  
  6. $GLOBALS[$GLOBALS['idx_lang']] = array(
  7. // C
  8. 'chats' => 'Chats',
  9. );
  10.  
  11. ?>

Télécharger

Déclaration de la table spip_chats

Nous allons déclarer une table très simple « spip_chats » contenant les champs :

  • id_chat
  • race
  • nom
  • age
  • maj (mise à jour)

Pour cela nous devons utiliser des pipelines adaptés : declarer_tables_principales et declarer_tables_interfaces. Nous ajoutons donc leur appel dans le fichier plugin.xml :

  1. <pipeline>
  2. <nom>declarer_tables_interfaces</nom>
  3. <inclure>base/chats.php</inclure>
  4. </pipeline>
  5. <pipeline>
  6. <nom>declarer_tables_principales</nom>
  7. <inclure>base/chats.php</inclure>
  8. </pipeline>

Télécharger

Nous créons alors le fichier base/chats.php contenant les fonctions qui seront appelés par les pipelines en question. Voici son contenu. La première fonction chats_declarer_tables_interfaces indique que l’on peut utiliser le raccourcis « CHATS » comme table de boucle SPIP et que la balise #RACE reçoit par défaut des traitements typographiques. La seconde fonction chats_declarer_tables_principales déclare la table « spip_chats » et ses champs SQL associés.

  1. <?php
  2.  
  3. function chats_declarer_tables_interfaces($interface){
  4. $interface['table_des_tables']['chats'] = 'chats';
  5. $interface['table_des_traitements']['RACE']['chats'] = _TRAITEMENT_TYPO;
  6. return $interface;
  7. }
  8.  
  9.  
  10. function chats_declarer_tables_principales($tables_principales){
  11. //-- Table CHATS ------------------------------------------
  12. $chats = array(
  13. "id_chat" => "bigint(21) NOT NULL",
  14. "race" => "tinytext DEFAULT '' NOT NULL",
  15. "nom" => "tinytext DEFAULT '' NOT NULL",
  16. "annee_naissance" => "int(4) DEFAULT '0' NOT NULL",
  17. "maj" => "TIMESTAMP"
  18. );
  19.  
  20. $chats_key = array(
  21. "PRIMARY KEY" => "id_chat",
  22. );
  23.  
  24. $tables_principales['spip_chats'] =
  25. array('field' => &$chats, 'key' => &$chats_key);
  26.  
  27. return $tables_principales;
  28. }
  29.  
  30. ?>

Télécharger

Installation/désinstallation de la table spip_chats

Pour gérer l’installation et la désinstallation, il faut indiquer un numéro de version des informations SQL du plugin ainsi qu’un fichier d’installation dans plugin.xml :

  1. <version_base>1.0</version_base>
  2. <install>base/chats_upgrade.php</install>

Télécharger

Ce fichier base/chats_upgrade.php contient deux fonctions :

  • chats_upgrade sert à l’installation et aux mises à jour. Ici, à la première activation du plugin, $current_version vaut encore "0.0" et la fonction creer_base() est executée. Cette fonction crée les tables SQL déclarées à SPIP mais absentes de la base de donnée. Par conséquent, la table spip_chats sera créée ;
  • chats_vider_tables sert pour la désinstallation. Elle supprime simplement la table SQL spip_chats ainsi que la variable meta contenant le numéro de version SQL installé du plugin.
  1. <?php
  2. include_spip('inc/meta');
  3. include_spip('base/create');
  4.  
  5. function chats_upgrade($nom_meta_base_version, $version_cible){
  6. $current_version = "0.0";
  7.  
  8. if (isset($GLOBALS['meta'][$nom_meta_base_version]))
  9. $current_version = $GLOBALS['meta'][$nom_meta_base_version];
  10.  
  11. if ($current_version=="0.0") {
  12. creer_base();
  13. ecrire_meta($nom_meta_base_version, $current_version=$version_cible);
  14. }
  15. }
  16.  
  17. function chats_vider_tables($nom_meta_base_version) {
  18. sql_drop_table("spip_chats");
  19. effacer_meta($nom_meta_base_version);
  20. }
  21.  
  22. ?>

Télécharger

Mise à jour de la table

Mince ! Nous avons oublié les champs « robe » et « infos » ! Mettons à jour le plugin :

  • on ajoute la déclaration des champs dans base/chats.php ("robe" => "tinytext DEFAULT '' NOT NULL", et "infos"        => "text DEFAULT '' NOT NULL", au dessus de « maj ») ;
  • on modifie la version SQL du plugin dans plugin.xml (<version_base>1.1</version_base>) ;
  • on crée une mise à jour dans la fonction chats_upgrade() de base/chats_upgrade.php qui devient :
  1. function chats_upgrade($nom_meta_base_version, $version_cible){
  2. $current_version = "0.0";
  3.  
  4. if ($current_version=="0.0") {
  5. creer_base();
  6. ecrire_meta($nom_meta_base_version, $current_version=$version_cible);
  7. }
  8. if (version_compare($current_version,"1.1","<")){
  9. // ajout du champ "robe" et "infos"
  10. maj_tables('spip_chats');
  11. ecrire_meta($nom_meta_base_version,$current_version="1.1");
  12. }
  13. }

Télécharger

On remarque que l’on teste si la version des tables SQL du plugin est inférieur à la nouvelle version renseignée dans plugin.xml. Si c’est le cas, on lance la fonction maj_tables('spip_chats') qui va créer tous les champs manquant de la table désignée. Cette fonction ne fait qu’ajouter des champs, en aucun cas elle ne supprime ou modifie des champs existants. Pour des opérations plus complexes, il faut utiliser les fonctions sql_* adaptées, tel que sql_alter().

Création du bouton pour accéder à la liste des chats

Commençons par créer un bouton dans le menu d’édition pour amener à la page qui listera les chats. On ajoute au plugin.xml la déclaration suivante d’un bouton, ainsi que l’usage du pipelines d’autorisations :

  1. <bouton id='chats' parent='naviguer'>
  2. <icone>images/chat-24.png</icone>
  3. <titre>chats:chats</titre>
  4. </bouton>
  5. <pipeline>
  6. <nom>autoriser</nom>
  7. <inclure>chats_autorisations.php</inclure>
  8. </pipeline>

Télécharger

Le bouton indique que l’on crée un lien vers la page ?exec=chats (indiquée par l’attribut id) dans le menu « Édition » de SPIP. A chaque bouton est associé une autorisation de le voir. Nous créons donc le fichier chats_autorisations.php pour déclarer cette fonction (autoriser_chats_bouton_dist) :

  1. <?php
  2. if (!defined("_ECRIRE_INC_VERSION")) return;
  3.  
  4. // fonction pour le pipeline, n'a rien a effectuer
  5. function chats_autoriser(){}
  6.  
  7. // declarations d'autorisations
  8. function autoriser_chats_bouton_dist($faire, $type, $id, $qui, $opt) {
  9. return autoriser('voir', 'chats', $id, $qui, $opt);
  10. }
  11.  
  12. function autoriser_chats_voir_dist($faire, $type, $id, $qui, $opt) {
  13. return true;
  14. }
  15.  
  16. ?>

Télécharger

Bouton d’accès aux Chats

Création d’une page privée pour lister les chats

Nous créons alors le fichier prive/exec/chats.html. Il liste les chats présents et propose des actions pour « voir », « modifier » ou « supprimer » chaque chat. Dans la colonne de navigation, une description du plugin ainsi qu’un lien pour créer un nouveau chat est présent. Le filtre icone utilisé qui facilite la création d’icone en squelette provient du plugin « spip_bonux ». Nous devons donc ajouter cette dépendance dans le fichier plugin.xml. De nouvelles autorisations permettent de gérer l’affichage des actions possibles, il faut aussi les renseigner.

Le fichier ne doit retourner aucun contenu si le visiteur n’a pas le droit de voir cette page. On place donc la même autorisation que pour le bouton du menu qui conditionne l’affichage du contenu. Dedans, une inclusion appelle une boucle sur la table chats.

  1. [(#AUTORISER{voir, chats})
  2. <h1><:chats:liste_des_chats:></h1>
  3.  
  4. <div class='ajax'>
  5. <INCLURE{fond=inclure/liste_chats,env,ajax} />
  6. </div>
  7.  
  8. <!--#navigation-->
  9. <div class='cadre cadre-info'>
  10. <p><:chats:description_chats:></p>
  11.  
  12. [(#AUTORISER{modifier, chat})
  13. [(#URL_ECRIRE{chat_edit}
  14. |parametre_url{new,oui}
  15. |icone{<:chats:action_ajouter:>, #CHEMIN{images/chat-24.png}, center, creer.gif})]
  16. ]
  17. </div>
  18. <!--/#navigation-->
  19. ]

Télécharger

Contenu de inclure/liste_chats.html :

  1. <B_chats>
  2. <table class='chats spip'>
  3. <thead>
  4. <tr>
  5. <th><:chats:label_id:></th>
  6. <th><:chats:label_nom:></th>
  7. <th><:chats:label_race:></th>
  8. <th><:chats:label_robe:></th>
  9. <th><:chats:label_annee_naissance:></td>
  10. <th><:chats:label_actions:></td>
  11. </tr>
  12. </thead>
  13. <tbody>
  14. <BOUCLE_chats(CHATS){par nom}{pagination 10}>
  15. <tr class="[(#COMPTEUR_BOUCLE|alterner{row_odd,row_even})]">
  16. <td>#ID_CHAT</td>
  17. <td>#NOM</td>
  18. <td>#RACE</td>
  19. <td>#ROBE</td>
  20. [(#SET{nb,[(#DATE{Y}|moins{#ANNEE_NAISSANCE})]})]
  21. <td>[(#ANNEE_NAISSANCE|oui)<:chats:nb_ans{nb=#GET{nb}}:>]</td>
  22. <td>
  23. [(#AUTORISER{voir,chat,#ID_CHAT})
  24. <a href='[(#URL_ECRIRE{chat_voir}|parametre_url{id_chat,#ID_CHAT})]'><:chats:action_voir:></a>
  25. ]
  26. [(#AUTORISER{modifier,chat,#ID_CHAT})
  27. |
  28. <a href='[(#URL_ECRIRE{chat_edit}|parametre_url{id_chat,#ID_CHAT})]'><:chats:action_modifier:></a>
  29. |
  30. <a href='[(#URL_ACTION_AUTEUR{supprimer_chat,#ID_CHAT,#SELF})]'><:chats:action_supprimer:></a>
  31. ]
  32. </td>
  33. </tr>
  34. </BOUCLE_chats>
  35. </tbody>
  36. </table>
  37. [<p class='pagination'>(#PAGINATION)</p>]
  38. </B_chats>

Télécharger

Les autorisations correspondantes sont ajoutées au fichier chats_autorisations.php :

  1. function autoriser_chat_voir_dist($faire, $type, $id, $qui, $opt) {
  2. return autoriser('modifier', 'chat', $id, $qui, $opt);
  3. }
  4.  
  5. function autoriser_chat_modifier_dist($faire, $type, $id, $qui, $opt) {
  6. return in_array($qui['statut'], array('0minirezo', '1comite'));
  7. }

Télécharger

Liste des chats

Création d’une page privée pour voir un chat

Nous cherchons maintenant à afficher une page, nommée « chat_voir » qui détaille un chat. On va créer pour cela 3 fichiers :

  • prive/exec/chat_voir.html gère l’ensemble de la page,
  • prive/contenu/chat.html, s’occupe simplement du contenu à afficher au centre et
  • prive/infos/chat.html décrit l’objet dans la colonne gauche.

Code de prive/exec/chat_voir.html. Comme précédemment, une autorisation teste si on a le droit d’acceder au contenu. Ici, on utilise la boucle CONDITION du plugin « spip_bonux » pour pouvoir insérer des boucles dans la condition. En l’occurrence une boucle sur le chat sélectionné.

Un lien pour modifier ansi que le titre sont affichés avant d’appeler le fichier affichant le contenu ([(#INCLURE{fond=prive/contenu/chat,id=#ID_CHAT})]) dont tout le contenu est envoyé au pipeline « afficher_contenu_objet » (qui servira notamment au plugin « Champs Extras »).

Enfin, dans la navigation, on appelle le pipeline « boite_infos » ; c’est lui qui chargera le fichier prive/infos/chat.html.

  1. <BOUCLE_si_autorise(CONDITION){si (#ID_CHAT|intval|et{#AUTORISER{voir,chat,#ID_CHAT}})}>
  2. <BOUCLE_chat(CHATS){id_chat}{tout}>
  3. <div class='fiche_objet'>
  4. [(#AUTORISER{modifier,chat,#ID_CHAT})
  5. <div class='bandeau_actions'>
  6.  
  7. [(#URL_ECRIRE{chat_edit}
  8. |parametre_url{id_chat,#ID_CHAT}
  9. |parametre_url{retour,#SELF}
  10. |icone{<:chats:action_modifier:>, #CHEMIN{images/chat-24.png}, #LANG_RIGHT, edit.gif})]
  11. </div>
  12. ]
  13.  
  14.  
  15. <h1>#NOM</h1>
  16.  
  17. <div id='wysiwyg'>
  18. [(#PIPELINE{afficher_contenu_objet,[(#ARRAY{
  19. args,[(#ARRAY{
  20. type,chat,
  21. id_objet,#ID_CHAT,
  22. contexte,[(#ARRAY{
  23. id_chat,#ID_CHAT})]})],
  24. data,[(#INCLURE{fond=prive/contenu/chat,id=#ID_CHAT})]})]})]
  25. </div>
  26. </div>
  27.  
  28. <!--#navigation-->
  29. [(#REM) Ce pipeline charge prive/infos/$type ]
  30. [<div class='cadre cadre-info'>
  31. (#PIPELINE{boite_infos,[(#ARRAY{
  32. args,[(#ARRAY{
  33. type,chat,
  34. id,#ID_CHAT})],
  35. data,''})]})
  36. </div>]
  37. <!--/#navigation-->
  38. </BOUCLE_chat>
  39. </BOUCLE_si_autorise>

Télécharger

Le second fichier prive/contenu/chat.html affiche le contenu du chat et se présente comme une liste de champs à afficher. C’est le même code répété pour chaque champ (pour notre exemple) :

  1. <BOUCLE_afficher_contenu(CHATS){id_chat=#ENV{id}}{tout}>
  2. <div class="champ contenu_nom[ (#NOM*|strlen|?{'',vide})]">
  3. <div class='label'><:chats:label_nom:></div>
  4. <div dir='#LANG_DIR' class='#EDIT{nom} nom'>#NOM</div>
  5. </div>
  6. <div class="champ contenu_race[ (#RACE*|strlen|?{'',vide})]">
  7. <div class='label'><:chats:label_race:></div>
  8. <div dir='#LANG_DIR' class='#EDIT{race} race'>#RACE</div>
  9. </div>
  10. <div class="champ contenu_robe[ (#ROBE*|strlen|?{'',vide})]">
  11. <div class='label'><:chats:label_robe:></div>
  12. <div dir='#LANG_DIR' class='#EDIT{robe} robe'>#ROBE</div>
  13. </div>
  14. <div class="champ contenu_annee_naissance[ (#ANNEE_NAISSANCE*|strlen|?{'',vide})]">
  15. <div class='label'><:chats:label_annee_naissance:></div>
  16. <div dir='#LANG_DIR' class='#EDIT{annee_naissance} annee_naissance'>#ANNEE_NAISSANCE</div>
  17. </div>
  18. <div class="champ contenu_infos[ (#INFOS*|strlen|?{'',vide})]">
  19. <div class='label'><:chats:label_infos:></div>
  20. <div dir='#LANG_DIR' class='#EDIT{infos} infos'>#INFOS</div>
  21. </div>
  22. </BOUCLE_afficher_contenu>

Télécharger

Le dernier fichier prive/infos/chat.html décrit quelques statistiques des objets. Ici rien d’intéressant ne nous concerne, on affiche simplement l’identifiant du chat :

  1. <BOUCLE_chat_info(CHATS){id_chat=#ENV{id}}{tout}>
  2. <div class='infos'>
  3. <div class='numero'>
  4. <:chats:info_gauche_numero_chat:>
  5. <p>#ID_CHAT</p>
  6. </div>
  7. </div>
  8. </BOUCLE_chat_info>

Télécharger

Vue du chat

Création d’une page privée pour ajouter ou modifier un chat

Nous créons pour cela 2 fichiers :

  • prive/exec/chat_edit.html gère l’affichage de l’ensemble de la page et appelle le fichier suivant
  • prive/editer/chat.html charge le formulaire. On pourrait cela dit mettre l’intégralité de ce fichier dans le premier. Cette inclusion est simplement là pour reprendre le même schéma que le core de SPIP.

Le code le prive/exec/chat_edit.html calcule une icone de retour (pour revenir en arrière sans valider le formulaire), et un titre, puis appelle l’inclusion avec ces valeurs.

  1. #CACHE{0}
  2. [(#SET{id_chat,#ENV{id_chat,#ENV{new,oui}}})]
  3. <BOUCLE_si_autorise(CONDITION){si (#AUTORISER{modifier,chat,#GET{id_chat}})}>
  4.  
  5. [(#SET{retour, #URL_ECRIRE{chats}})]
  6. <BOUCLE_titre(CHATS){id_chat=#GET{id_chat}}{tout}>
  7. [(#SET{titre, #NOM})]
  8. [(#SET{retour, [(#URL_ECRIRE{chat_voir}|parametre_url{id_chat,#ID_CHAT})]})]
  9. </BOUCLE_titre>
  10.  
  11. [(#INCLURE{fond=prive/editer/chat,
  12. id_chat=#GET{id_chat},
  13. icone_retour=[(#ENV{retour,#GET{retour}}
  14. |icone{<:icone_retour:>, #CHEMIN{images/chat-24.png}, #LANG_LEFT })],
  15. titre=#GET{titre}
  16. })]
  17.  
  18. </BOUCLE_si_autorise>

Télécharger

Le second fichier, prive/editer/chat.html affiche l’icone, le titre, et appelle le formulaire d’édition CVT.

  1. <div class='cadre-formulaire-editer'>
  2. <div class="entete-formulaire">
  3. #ENV**{icone_retour}
  4. [<:chats:info_modifier_chat:>
  5. <h1>(#ENV{titre,<:chats:texte_nouveau_chat:>})</h1>]
  6. </div>
  7.  
  8. #FORMULAIRE_EDITER_CHAT{#ENV{new},#ENV{redirect}}
  9. </div>

Télécharger

Création du formulaire CVT d’édition

Nous créons 3 fichiers en tout :

  • formulaires/editer_chat.html contenant le HTML du formulaire,
  • formulaires/editer_chat.php contenant les 3 fonctions Charger, Vérifier et Traiter, mais qui appellent simplement des fonctions SPIP génériques,
  • action/editer_chat.php qui contient le traitement du formulaire.

Le code HTML du formulaire CVT, utilise ici la balise #SAISIE du plugin « saisies » simplement pour se simplifier l’écriture (Oui je sais, y l’heure actuelle ce plugin n’est pas documenté !). Le fichier formulaires/editer_chat.html contient :

  1. <div class='formulaire_spip formulaire_editer formulaire_#FORM formulaire_#FORM-#ENV{id_chat,nouveau}'>
  2.  
  3. [<p class="reponse_formulaire reponse_formulaire_ok">(#ENV**{message_ok})</p>]
  4. [<p class="reponse_formulaire reponse_formulaire_erreur">(#ENV*{message_erreur})</p>]
  5.  
  6. [(#ENV{editable}|oui)
  7. <form method='post' action='#ENV{action}'><div>
  8. #ACTION_FORMULAIRE{#ENV{action}}
  9. <input type='hidden' name='id_chat' value='#ENV{id_chat}' />
  10. <ul class='editer-groupe'>
  11. [(#SAISIE{input, nom,
  12. label=<:chats:label_nom:>,
  13. obligatoire=oui})]
  14.  
  15. [(#SAISIE{input, race,
  16. label=<:chats:label_race:>})]
  17.  
  18. [(#SAISIE{input, robe,
  19. label=<:chats:label_robe:>,
  20. size=4})]
  21.  
  22. [(#SAISIE{input, annee_naissance,
  23. label=<:chats:label_annee_naissance:>,
  24. size=4})]
  25.  
  26. [(#SAISIE{textarea, infos,
  27. label=<:chats:label_infos:>,
  28. explication=<:chats:explication_infos:>})]
  29. </ul>
  30. [(#REM) ajouter les saisies supplementaires : extra et autre, a cet endroit ]
  31. <!--extra-->
  32. <p class="boutons"><input type='submit' class='submit' value='<:bouton_enregistrer:>' /></p>
  33. </div></form>
  34. ]
  35. </div>

Télécharger

Edition d’un chat

Le fichier PHP correspondant formulaires/editer_chat.php quant à lui contient :

  1. <?php
  2.  
  3. if (!defined("_ECRIRE_INC_VERSION")) return;
  4.  
  5. include_spip('inc/actions');
  6. include_spip('inc/editer');
  7.  
  8. function formulaires_editer_chat_charger_dist($id_chat='new', $retour=''){
  9. $valeurs = formulaires_editer_objet_charger('chat', $id_chat, '', '', $retour, '');
  10. return $valeurs;
  11. }
  12.  
  13. function formulaires_editer_chat_verifier_dist($id_chat='new', $retour=''){
  14. $erreurs = formulaires_editer_objet_verifier('chat', $id_chat, array('nom'));
  15. return $erreurs;
  16. }
  17.  
  18. function formulaires_editer_chat_traiter_dist($id_chat='new', $retour=''){
  19. return formulaires_editer_objet_traiter('chat', $id_chat, '', '', $retour, '');
  20. }
  21.  
  22. ?>

Télécharger

Les fonctions génériques formulaires_editer_objet_$action() ont des arguments prédéfinis. Certains nous sont inutiles et nous mettons simplement une chaine vide '' à la place. Les deux premières fonctions (charger et vérifier) peuvent être complètement prises en charge sans rien faire de plus (si nous n’avons pas de besoins particuliers). Seule la fonction traiter nécessite de créer une action de traitement, dans un fichier action/editer_chat.php.

Ce dernier fichier contient 3 fonctions :

  • action_editer_chat_dist() verifie l’argument, appelle insert_chat() si on a besoin d’un nouveau chat, puis appelle revisions_chats($id_chat) qui va appliquer les modifications.
  • insert_chat() crée un nouvel enregistrement de chat, en appelant juste avant le pipeline « pre_insertion ».
  • revisions_chats($id_chat), récupère les champs postés du formulaire, puis appelle la fonction générique « modifier_contenu » en passant le nom de la table, l’identifiant, et les champs à modifier. Cette fonction appellera automatiquement les pipelines « pre_edition » et « post_edition ». Peu connu, on peut aussi lui passer en paramètre d’option la clé pour invalider le cache en même temps.

Voici le contenu de ce fichier :

  1. <?php
  2.  
  3. if (!defined("_ECRIRE_INC_VERSION")) return;
  4.  
  5. function action_editer_chat_dist() {
  6. $securiser_action = charger_fonction('securiser_action', 'inc');
  7. $arg = $securiser_action();
  8.  
  9. // pas de chat ? on en cree un nouveau, mais seulement si 'oui' en argument.
  10. if (!$id_chat = intval($arg)) {
  11. if ($arg != 'oui') {
  12. include_spip('inc/headers');
  13. redirige_url_ecrire();
  14. }
  15. $id_chat = insert_chat();
  16. }
  17.  
  18. if ($id_chat) $err = revisions_chats($id_chat);
  19. return array($id_chat,$err);
  20. }
  21.  
  22.  
  23. function insert_chat() {
  24. $champs = array(
  25. 'nom' => _T('chats:item_nouveau_chat')
  26. );
  27.  
  28. // Envoyer aux plugins
  29. $champs = pipeline('pre_insertion', array(
  30. 'args' => array(
  31. 'table' => 'spip_chats',
  32. ),
  33. 'data' => $champs
  34. ));
  35.  
  36. $id_chat = sql_insertq("spip_chats", $champs);
  37. return $id_chat;
  38. }
  39.  
  40.  
  41. // Enregistrer certaines modifications d'un chat
  42. function revisions_chats($id_chat, $c=false) {
  43.  
  44. // recuperer les champs dans POST s'ils ne sont pas transmis
  45. if ($c === false) {
  46. $c = array();
  47. foreach (array('nom', 'race', 'robe', 'annee_naissance', 'infos') as $champ) {
  48. if (($a = _request($champ)) !== null) {
  49. $c[$champ] = $a;
  50. }
  51. }
  52. }
  53.  
  54. include_spip('inc/modifier');
  55. modifier_contenu('chat', $id_chat, array(
  56. 'nonvide' => array('nom' => _T('info_sans_titre')),
  57. 'invalideur' => "id='id_chat/$id_chat'"
  58. ),
  59. $c);
  60. }
  61. ?>

Télécharger

Création de l’action de suppression

L’action de suppression nécessite de créer un fichier action/supprimer_chat.php qui va réaliser la suppression après avoir vérifié que l’argument attendu est correct.

  1. <?php
  2.  
  3. if (!defined("_ECRIRE_INC_VERSION")) return;
  4.  
  5. function action_supprimer_chat_dist() {
  6. $securiser_action = charger_fonction('securiser_action', 'inc');
  7. $arg = $securiser_action();
  8.  
  9. if (!preg_match(",^(\d+)$,", $arg, $r)) {
  10. spip_log("action_supprimer_chat_dist $arg pas compris");
  11. } else {
  12. action_supprimer_chat_post($r[1]);
  13. }
  14. }
  15.  
  16. function action_supprimer_chat_post($id_chat) {
  17. sql_delete("spip_chats", "id_chat=" . sql_quote($id_chat));
  18.  
  19. include_spip('inc/invalideur');
  20. suivre_invalideur("id='id_chat/$id_chat'");
  21. }
  22. ?>

Télécharger

Interface avec « Champs Extras 2 »

Figurez-vous que c’est le plus simple maintenant, car notre objet CHAT traverse tous les pipelines qu’il faut pour que Champs Extras insère de nouveaux champs à cet objet.

Il suffit donc de déclarer à Champs Extras que l’objet Chat peut-être utilisé. Pour cela, on déclare utiliser un pipeline dans plugin.xml, et l’on crée un fichier chats_pipelines.php pour accueillir la fonction correspondante.

plugin.xml :

  1. <!-- avec plugin champs extras 2 -->
  2. <pipeline>
  3. <nom>objets_extensibles</nom>
  4. <inclure>chats_pipelines.php</inclure>
  5. </pipeline>

Télécharger

chats_pipelines.php :

  1. <?php
  2.  
  3. function chats_objets_extensibles($objets){
  4. return array_merge($objets, array('chat' => _T('chats:chats')));
  5. }
  6.  
  7. ?>

Télécharger

Champs Extras des Chats
Liste des champs extras déclarés.
Edition d’un chat avec extras
Vue du chat avec extra

Conclusions

Cet objet « Chat » très sommaire montre que réaliser l’interface et l’outil de modification nécessite encore beaucoup de code et de squelettes SPIP. Cependant, créer un nouvel objet est possible et de nombreuses fonctions de l’API de SPIP 2.0 permettent un gain de temps appréciable.

Le chemin parcouru par SPIP en quelques temps est bien visible mais il reste encore des outils qui mériteraient d’être simplifiées et améliorées, comme créer une fonction inserer_contenu($objet, $champs) pour la création d’éléments, ou encore $c = recuperer_champs_post($noms). Je n’ai pas réussi, sans chercher non plus, si on avait un moyen de créer un fil d’ariane sur les pages exec en squelette, mais je n’ai pas ce souvenir.

Tout cela m’a entre autre permis de distinguer qu’un plugin « Tables Extras » est difficilement envisageable encore sans faire écrire du code, mais en même temps que des parties pourraient se réaliser automatiquement.

Coup de pouce

Pour me maintenir en éveil et en pleine forme physique et mentale, vous pouvez me faire le cadeau d'un jus de fruit pressé.

En plus de m'hydrater, de m'offrir une alimentation saine crudivore et frugivore, cela peut aussi me motiver à produire d'autres documentations ou peut-être à prendre des vacances ! :)

Vous pouvez également me « Flattrer » si vous utilisez le service en ligne très malin Flattr de microdonations qui permet d'allouer un budget mensuel à des créateurs de contenu. Votre budget est partagé chaque mois entre toutes les personnes que vous avez flattées ce mois là.