Crayons controleurs et vues - doc complémentaire

Utilisation sur des objets non déclarés

Les crayons peuvent être utilisés, dans une boucle sur une table non déclarée à SPIP.

C’est transparent et il n’y a rien à coder au moins lorsque la table a un nom habituel pour SPIP avec un s à la fin du nom de la table. (Il est aussi conseillé en général, mais non nécessaire pour les crayons, que le nom de la clé primaire soit composé de ’id_’ suivi du nom de la table au singulier.)

Fonctions personnalisées de mise à jour

Dans des cas particuliers, il est possible de définir une fonction revision_typobjet ou typobjet_revision pour gérer l’enregistrement des valeurs. Cette fonction reçoit 3 arguments :
-  $id : l’identifiant de l’enregistrement à modifier (valeur de la clé primaire)
-  $colval : tableau de couples (champ, nouvelle valeur)
-  $type : nom de la table, sans le s

Exemple :

function revision_spip_theme($id, $colval, $type) {
  sql_updateq($type.'s', $colval, "id_theme=".intval($id));
}

Edition par un input ligne ou par un textarea ?

La doc indique que « si un texte crayonnable est un champ MySQL MEDIUMTEXT ou plus long, les crayons affichent un TEXTAREA, et sinon, un INPUT. » mais en fait le code teste AUSSI si il y a des fins de ligne dans la valeur du champ, auquel cas c’est toujours un TEXTAREA.

C’est le code de _plugins_/crayons/action/crayons_html.php qui fait ça et qu’il est possible de surcharger localement pour modifier ce comportement, au niveau de la ligne 97.

Par exemple on peut simplement ajouter la condition suivante au test :

        OR (strlen ($valeur[$champ]) > 30)                                

En langue diff, ça donnerait :

@@ -94,7 +94,8 @@

    // si la valeur fait plusieurs lignes on doit mettre un textarea
+    // idem si la valeur fait plus de 30 caractères
-    // derogation specifique pour descriptif_site de spip_metas
+    // et derogation specifique pour descriptif_site de spip_metas
    if (
        preg_match(",[\n\r],", $valeur[$champ])
        OR (($champ == 'valeur') && ($id == 'descriptif_site'))
+        OR (strlen ($valeur[$champ]) > 30)                            
        OR
    // on regarde le type tel que defini dans serial

Nom servant d’index dans l’environnement reçu par un contrôleur

Le contrôleur reçoit une variable d’environnement avec la valeur de l’index de l’enregistrement édité. Le nom de cette variable est toujours de la forme ’id_table’ lorsque la table s’appelle ’TABLE’ ou ’TABLES’. C’est donc bien l’index de la table si la table suit les conventions de nommage élémentaires de SPIP.

Mais si la table ne suit pas les conventions de nommage de SPIP, l’index reçu n’est pas le bon et il faut donc définir un contrôleur sur mesure. Exemple : si la table est "PLOUF’, l’index reçu a pour nom ’id_plouf’ même si le vrai champ index de la table PLOUF est « mon_idploc_rahlala ». Dans ce dernier cas, il faudra faire le lien dans la boucle avec :
<BOUCLE(PLOUF){mon_idploc_rahlala=#ENV{id_plouf}}>

Exemples d’un contrôleur unique servant à saisir plusieurs champs constitutifs d’une adresse

Ce squelette implémente un contrôleur pour le crayon detailsdeladresse qui permet de modifier les champs des adresses enregistrées dans la table adresses.

Pour activer ce contrôleur
-  Il faut le mettre dans le sous-dossier controleur du dossier squelette.
-  Dans le squelette qui affiche l’adresse, il faut encadrer le code qui affiche l’adresse par les balises #EDIT appelant le contrôleur.
Par exemple

<span class="#EDIT{detailsdeladresse}">
  #NOM #PRENOM, 
  #ADRESSE, 
  #CP #VILLE 
  #TEL 
  #EMAIL #SITE
</span>

Ce contrôleur est implémenté par un simple fichier HTML controleur/adresse_detailsdeladresse.html. Il est donc basique et ne réalise pas de vérifications. Voici le code :

#CACHE{0}

<BOUCLE_adresse(adresses){id_adresse=#ENV{id_adresse}}>
<fieldset style="width:#ENV{largeur}px;#ENV{style}">
<legend>Détails de l'adresse</legend>

<label>Nom</label>
<input class="crayon-active" name="#ENV{name_nom}"  value="[(#NOM**|entites_html)]" />

<label>Prénom</label>
<input class="crayon-active" name="#ENV{name_prenom}"  value="[(#PRENOM**|entites_html)]" />

<label>Adresse</label>
<textarea class="crayon-active" name="#ENV{name_adresse}"	 style="height:#ENV{hauteur}|mul{2}px;">
[(#ADRESSE**|entites_html)]</textarea>

<label>CP</label>
<input class="crayon-active" name="#ENV{name_cp}"  value="[(#CP**|entites_html)]" />

<label>Ville</label>
<input class="crayon-active" name="#ENV{name_ville}"  value="[(#VILLE**|entites_html)]" />

<label>Tel</label>
<input class="crayon-active" name="#ENV{name_tel}"  value="[(#TEL**|entites_html)]" />

<label>Email</label>
<input class="crayon-active" name="#ENV{name_email}"  value="[(#EMAIL**|entites_html)]" />

<label>Site</label>
<input class="crayon-active" name="#ENV{name_site}"  value="[(#SITE**|entites_html)]" />
</fieldset>

</BOUCLE_adresse>

Utiliser un datepicker dans un controleur

1. dans le controleur

#CACHE{0}
<BOUCLE_toto(MA_TABLE){id_ma_table}>
<input class="crayon-active date" type="text" name="#ENV{name_madate}" value="[(#MADATE|affdate{d/m/Y})]">
</BOUCLE_toto>
#INCLURE{fond=formulaires/dateur/inc-dateur}

2. dans le pipeline : crayons_verifier

function prefix_crayons_verifier($flux){
	$date = $flux['args']['content']['madate'];
	list($date,$heures)        = explode(' ' , $date);
	list($jour, $mois, $annee) = explode('/',$date);
	$heures = ( $heures ) ? $heures : "00:00:00";
	$date = intval($annee) .'-'. $mois .'-'. $jour. ' ' . $heures;

	$flux['data']['normaliser']['madate'] = $date;
	return $flux;
}

ou avec le plugin verifier :

function prefix_crayons_verifier($flux){
	$date = $flux['args']['content']['madate'];
	$verifier = charger_fonction('verifier', 'inc/');
	$verifier($date, 'date', ['normaliser' => 'datetime'], $date);
	$flux['data']['normaliser']['madate'] = $date;
	return $flux;
}

3. La vue

#CACHE{0}
<BOUCLE_toto(MA_TABLE){id_ma_table}>
[(#MADATE|affdate{d/m/Y})]
</BOUCLE_toto>

Verifier la saisie sur un champ crayonnable

Crayons propose un pipeline permettant de vérifier la saisie d’un champ.

Par exemple, pour vérifier qu’une référence d’un produit n’existe pas déjà :

function produits_crayons_verifier($flux){

  if ( $flux['args']['type'] == 'produit' && $flux['args']['modele'] == 'reference' ) {
    $str = $flux['args']['content']['reference'];
    $id_produit =  $flux['args']['id_objet'];
    if ( sql_getfetsel('reference','spip_produits',"reference='$str' AND id_produit!=intval($id_produit)") )
      $flux['data']['erreurs']['reference'] = _T('produits:reference_existante');
  }
  // Voir dans les logs ce qui se passe...
  // spip_log($flux, _LOG_DEBUG);

  return $flux;
} 

Il faudrait certainement utiliser sql_quote pour échapper l’argument utilisant $str