Carnet Documentation SPIP

NouveauCritere

SPIP-Contrib :: Carnet Wiki :: Carnet Documentation SPIP :: Recherche :

NouveauCritere

2015 : Page remise à jour, à finir de relire et valider.
Todo : illustrer avec critere_logo_dist()

Voir aussi : Créer un critère avec pipeline pre_boucle

CreerUnCritere avec pipeline pre_boucle | [4732]


Le compilateur permet de définir ses propres critères pour toutes les boucles sur les tables SPIP ou sur de nouvelles tables.

Pour des critères de base, une boucle dans le squelette est traduite en requête SQL vers la base de données. Un critère de boucle se traduit comme une nouvelle contrainte dans la requête. D’autres critères peuvent requérir l’exécution de code php.

Par exemple, quand on ajoute le critère {exclus} à une boucle d’articles, SPIP va ajouter une contrainte disant que l’on ne veut pas récupérer l’article en cours de la table, mais juste les autres :
WHERE ... AND spip_articles.id_articles != XX

Le compilateur SPIP analyse le source et crée la structure de donnée représentative du squelette, de ses boucles et donc des critères qu’on veut analyser.

Les critères ’maison’ doivent donc respecter la syntaxe SPIP.

Pour les définir, on peut
-  définir une fonction critère_nomducritere : c’est ce qu’on voit ici.
-  ou glisser un code de traitement dans le pipeline pre_boucle

Implémentation

Les critères du noyau de SPIP sont tous déclarés dans ecrire/public/criteres.php.

Pour déclarer un nouveau critère truc, il faut déclarer une fonction critere_truc dans le mes_options.php de votre site ou plugin.

Les fonctions critere_ reçoivent à la fois
-  l’identifiant $idb de la boucle courante
-  les données $boucles de structure de toutes les boucles du squelette,
-  les données sur le critère lui-même.
Elles peuvent récupèrer la boucle courante, où notre critère est présent :
$boucle = &$boucles[$idb];
Elles peuvent alors modifier la boucle et ses attributs. Par exemple : ->where[] est un tableau des bouts de requete SQL qu’on veut voir dans la partie WHERE de la requête SQL.

Par exemple, la fonction pour le critère {exclus} est déclarée comme cela :

  1. function critere_exclus_dist($idb, &$boucles, $param, $not) {
  2. $boucle = &$boucles[$idb];
  3.  
  4. if ($param != 'exclus' OR $not)
  5. erreur_squelette(_T('info_erreur_squelette'), $param);
  6.  
  7. $boucle->where[] = $boucle->id_table . '.' . $boucle->primary."!='"."
  8. . calculer_argument_precedent($idb,$boucle->primary, $boucles) .
  9. "."'";
  10.  
  11. }

Télécharger

Cette fonction a un _dist à la fin, parce que c’est une fonction du noyau, on peut la surcharger en déclarant sa propre fonction critere_exclus.

La fonction prend quatre paramètres :
1- $idb qui est l’identifiant de la boucle (le nom après BOUCLE dans le squelette),
2- &$boucles qui est un tableau de toutes les boucles de ce squelette, indexé par leur identifiant,
3- $param qui est le critère qui a fait appeler cette fonction, ainsi, si on veut passer des paramètres, on peut les récupérer ici,
4- $not qui indique si le critère est inversé.

Elle commence par deux morceaux de code assez commun :
$boucle = &$boucles[$idb];
qui permet de récupérer la boucle actuelle.

if ($param != 'exclus' OR $not)
                erreur_squelette(_T('info_erreur_squelette'), $param);


qui vérifie que le critère passé n’est pas accompagné d’autres paramètres et qu’il n’est pas nié (ce qui n’aurait pas de sens pour ce critère)

La dernière partie du code ajoute la nouvelle contrainte à la requête :

$boucle->where[] = $boucle->id_table . '.' . $boucle->primary."!='"."
        . calculer_argument_precedent($idb,$boucle->primary, $boucles) .
         "."'";

On peut modifier un certain nombre de champs de la requête d’une boucle :

-  $select quels champs seront sélectionnés et rendus accessible pour l’affichage (c’est un tableau de nom de champ),

-  $from sur quelles tables faire la requête, (ici aussi, un tableau de nom de table), mais attention à la notive de ESJ : « Il faut remarquer qu’un critère n’a a priori pas à affecter le champ from de la requête SQL à construire. Les exceptions dans le code de Spip sont des scories à évacuer. »

-  $where quelles sont les contraintes sur la requête, toutes les contraintes seront associées avec un AND, si on veut faire un OR entre deux contraintes, il faut le mettre comme une seule contrainte (encore un tableau de contraintes),

-  $limit limiter le nombre de résultat (format SQL de LIMIT : {$debut, $nombre}, l’indexation commence à 0 bien entendu. C’est le critère {a, b} des boucles.)

-  $group quelle colonne groupée (un nom de champ),

-  $order par quelle colonne trier (une chaîne entre guillemets, ainsi il faudra toujours retourner quelque chose du genre : "'colonne'"),

-  sous_requete ????

-  compte_requete ????

Un certain nombre de ’sucres syntaxiques’ (éléments facilitants) sont présents pour nous aider à garder des critères génériques qui puissent marcher avec le plus de boucles possible :
-  $boucle->id_table est le nom de la table sur laquelle la boucle s’applique,
-  $boucle->primary est la clef "primaire" de la table,
-  on peut récupérer un argument passé dans la boucle (soit par le contexte, soit par assignation) grâce à la méthode calculer_argument_precedent qui prend trois paramètres :

Pour chaque boucle, dans le fichier inc-boucles.php, une requête de base est déjà spécifiée, il faut donc faire attention à ajouter des nouvelles contraintes compatibles avec cela. En général, cela implique de mettre une contrainte sur la clef "primaire" de la table :$boucle->id_table . '.' . $boucle->primary

Pour accéder aux champs nouveaux demandés dans la requête, il y a deux méthodes :
-  si c’est un champ déclaré dans le fichier de configuration, on y a accès directement par la balise #NOM_CHAMP,
-  sinon (c’est une balise calculée), il faut déclarer une fonction balise_CHAMP qui explique à Spip comment récupérer ce nouveau champ (voir la page sur le NouveauCompilo).

Exemple 2

Dans un critère, tester si une rubrique est positive ou = -1

        $boucle->where[] = array("'>'", "'articles.id_rubrique'", "'\"0\"'");
        $boucle->where[] = array("'='", "'articles.id_rubrique'", "'\"-1\"'");       

Exemple 3

-  Nouveau Critére : trouver les articles (ou autres) similaires
-  critère LIKE MySQL : {like titre %machin-chose%}

  1. function critere_like($idb, &$boucles, $crit) {
  2.  
  3. $boucle = $boucles[$idb]; //la boucle actuelle
  4. $not = $crit->not; //est-ce que le critère est inversé: !like
  5. $id = $boucle->primary; //l'id de la table actuelle
  6.  
  7. if (count($params) < 2) //vérifie le nombre de paramètres
  8. erreur_squelette(_T('zbug_info_erreur_squelette'),
  9. "{like ?} BOUCLE$idb");
  10.  
  11. $champ = array_shift($crit->param);
  12. $champ = $champ[0]->texte; //on prend le premier paramètre comme un champ fixe
  13.  
  14. $variable = array_shift($crit->param);
  15. $variable = calculer_liste($variable, array(), $boucles, $boucle->id_parent); //on calcule la valeur du 2e~paramètre. Ainsi, on peut utiliser une balise SPIP dedans.
  16.  
  17. $boucle->where[] = "$id.$champ ".($not?'NOT ':'')."LIKE $variable"; //on ajoute une nouvelle condition WHERE
  18. }

Télécharger

Exemple 4 : tester l’environnement

Voir : Accéder à l’environnement

Ex 1 : Pour accéder à la valeur de id_rubrique, le compilateur doit renvoyer :
$env_id = "\$Pile[0]['id_rubrique']";

Si un critère doit tester si sa valeur est positive, il doit modifier where ainsi :

 $boucle->where[] = array(
        "'?'",
        "(isset($env_id)?(is_array($env_id)?count($env_id):strlen($env_id)):'')",
        "''",
        "'articles.id_rubrique>0'");

Incertitude : pourquoi tester si complexement in_array et count et strlen ici ?

CreerUnCritere avec pipeline pre_boucle | [4732]