declarer_tables_interfaces

Ce pipeline sert à déclarer des informations relatives aux tables SQL ou à certains champs de ces tables. Il permet de compléter les informations données par ecrire/public/interfaces.php

La fonction prend en paramètre le tableau des éléments déclarés, souvent nommé $interface et doit le retourner. Ce tableau est composé de différents éléments eux aussi tabulaires :

  • table_des_tables déclare des alias de tables SQL,
  • exceptions_des_tables attribue des alias de colonne SQL sur une table donnée,
  • table_titre indique la colonne SQL d’un objet servant à définir le titre pour certains types de jeux d’URL
  • table_date indique une colonne SQL de type date pour une table SQL donnée, permettant d’utiliser dessus des critères spécifiques (age, age_relatif, ...)
  • tables_jointures explicite des jointures possibles entre tables SQL
  • exceptions_des_jointures crée des alias de colonnes SQL issus d’une jointure
  • table_des_traitements indique des filtres à appliquer systématiquement sur des balises SPIP.

table_des_tables

Déclare des alias pour des tables SQL, relatifs aux déclarations données dans les tables principales ou auxiliaires.

En général, tout plugin proposant un nouvel objet éditorial déclare également un alias identique au nom de l’objet. Cela permet d’écrire des boucles <BOUCLEx(NOM)>, identiques à <BOUCLEx(spip_nom)> (qui indique simplement le nom de la table SQL).

  1. // 'nom_declare' = 'spip_rubriques', mais sans le prefixe 'spip_'
  2. $interface['table_des_tables']['alias'] = 'nom_declare';
  3. // exemples
  4. $interface['table_des_tables']['articles'] = 'articles'; // boucles ARTICLES sur spip_articles
  5. $interface['table_des_tables']['billets'] = 'articles'; // boucles BILLETS sur spip_articles

Télécharger

exceptions_des_tables

De la même manière que la déclaration d’alias de table SQL, il est possible de déclarer des alias de colonnes SQL. Ces alias peuvent aussi forcer une jointure sur une autre table.

  1. // balise #COLONNE_ALIAS ou critere {colonne_alias} dans la boucle concernee
  2. $interface['exceptions_des_tables']['alias']['colonne_alias'] = 'colonne';
  3. $interface['exceptions_des_tables']['alias']['colonne_alias'] = array('table', 'colonne');
  4. // exemples
  5. $interface['exceptions_des_tables']['breves']['date'] = 'date_heure';
  6. $interface['exceptions_des_tables']['billets']['id_billet'] = 'id_article';
  7. $interface['exceptions_des_tables']['documents']['type_document'] = array('types_documents'
  8. , 'titre');
  9. // permet d'utiliser les criteres racine, meme_parent, id_parent
  10. $interface['exceptions_des_tables']['evenements']['id_parent'] = 'id_evenement_source';
  11. $interface['exceptions_des_tables']['evenements']['id_rubrique'] = array('spip_articles', 'id_rubrique');

Télécharger

table_titre

Indique quel champ sera utilisé pour générer des titres pour certains jeux d’URL (propre, arborescent...). La chaîne transmise est une déclaration de sélection SQL (SELECT), qui doit renvoyer 2 colonnes (ou alias de colonne SQL) : « titre » et « lang ». Lorsque l’objet n’a pas de champ « lang » correspondant, on doit donc renvoyer '' AS lang.

  1. $interface['table_titre']['alias']= "colonne_titre AS titre, colonne_lang AS lang";
  2. // exemples
  3. $interface['table_titre']['mots']= "titre, '' AS lang";
  4. $interface['table_titre']['breves']= 'titre , lang';

Télécharger

Lorsqu’un objet a déclaré son titre, le générateur d’URL peut créer de belles URL automatiquement (en fonction du jeu d’URL utilisé par le site).

table_date

Cette information permet de déclarer certaines colonnes SQL comme des entrées de type date. Le compilateur de SPIP pourra alors appliquer des critères spécifiques à ces types de champs, tel que « age », « age_relatif », « jour_relatif »... Il n’y a qu’un seul champ déclaré de type date possible par table.

  1. $interface['table_date']['alias'] = 'colonne';
  2. // exemples
  3. $interface['table_date']['articles']='date';
  4. $interface['table_date']['evenements'] = 'date_debut';

Télécharger

tables_jointures

Ces déclarations permettent au compilateur de déterminer explicitement les jointures possibles lorsqu’une boucle sur une table demande un champ (balise ou critère) inconnu.

Le compilateur sait retrouver de façon implicite certaines jointures (sans les déclarer donc) en recherchant la colonne demandée dans les autres tables SQL qu’il connait. Le compilateur ne cherche pas sur toutes les tables, mais uniquement sur celles ayant des colonnes spécifiques communes :

  • même nom que la clé primaire,
  • même nom qu’une colonne déclarée en jointure potentielle dans le descriptif join des tables principales ou auxiliaires.

Dans de nombreux cas, il est utile et préférable de déclarer de façon explicite au compilateur les jointures qu’il peut tenter lorsqu’un champ inconnu sur une table se présente à lui. C’est le but de cette déclaration. L’ordre des déclarations a parfois son importance, puisque dès que le compilateur trouvera le champ recherché dans une des tables possibles à joindre, il liera alors cette table. Même si le champ voulu se trouvait dans la table déclarée ensuite.

  1. $interface['tables_jointures']['spip_nom'][] = 'autre_table';
  2. $interface['tables_jointures']['spip_nom']['colonne'] = 'autre_table';
  3. // exemples
  4. // {id_mot} sur ARTICLES
  5. $interface['tables_jointures']['spip_articles'][]= 'mots_articles';
  6. $interface['tables_jointures']['spip_articles'][]= 'mots';
  7. // jointures evenements (plugin agenda) sur les mots ou articles
  8. $interface['tables_jointures']['spip_evenements'][]= 'mots'; // a placer avant la jointure sur articles
  9. $interface['tables_jointures']['spip_evenements'][] = 'articles';
  10. $interface['tables_jointures']['spip_evenements'][] = 'mots_evenements';
  11. // jointures articles vers evenements
  12. $interface['tables_jointures']['spip_articles'][] = 'evenements';

Télécharger

La plupart du temps, aidé aussi de la description « exceptions_des_jointures » expliqué ensuite, cela suffit pour qu’une boucle SPIP sache calculer les jointures qui lui sont nécessaires pour afficher les différentes balises demandées. Si ce n’est toujours pas suffisant, ne pas oublier que les squelettes aussi peuvent indiquer les jointures qu’ils souhaitent avec les boucles et critères (cf. Forcer des jointures).

exceptions_des_jointures

Cette définition permet d’attribuer un alias de colonne créant une jointure sur une table pour récupérer un autre champ, si la jointure est réalisable. C’est un peu le pendant de « exception_des_tables » déclarant une jointure, mais non spécifique à une table donnée. On pourra alors utiliser cet alias comme balise SPIP ou comme critère de boucle.

Notons que lorsqu’on utilise ces jointures uniquement comme critère de boucle tel que {titre_mots=xx}, il est préférable d’écrire {mots.titre=xx}, plus générique et qui ne nécessite pas de déclaration.

  1. $interface['exceptions_des_jointures']['colonne_alias'] = array('table', 'colonne');
  2. // exemples
  3. $interface['exceptions_des_jointures']['titre_mot'] = array('spip_mots', 'titre');

Télécharger

Un cas particulier existe : un troisième argument peut être donné contenant le nom de la fonction qui va créer la jointure. C’est un usage rare, utilisé par le plugin « Forms & Tables »

  1. // cas particulier
  2. $interface['exceptions_des_jointures']['forms_donnees']['id_mot'] = array('spip_forms_donnees_champs', 'valeur', 'forms_calculer_critere_externe');

Télécharger

table_des_traitements

Cette description est très utile ; elle permet de définir des traitements systématiques (filtres) sur certaines balises de SPIP. L’étoile (#BALISE*) désactive ces traitements.

Concrètement, pour chaque balise, ou couple balise / boucle, les fonctions indiquées seront exécutées. %s sera remplacé par le contenu réel que retourne la balise.

Deux constantes sont à disposition pour les usages les plus fréquents :

  1. // traitements typographiques
  2. define('_TRAITEMENT_TYPO', 'typo(%s, "TYPO", $connect)');
  3. // traitements des raccourcis SPIP ([->artXX], <cadre>, {{}}, ...)
  4. define('_TRAITEMENT_RACCOURCIS', 'propre(%s, $connect)');

Télécharger

  1. $interface['table_des_traitements']['BALISE'][]= 'filtre_A(%s)';
  2. $interface['table_des_traitements']['BALISE'][]= 'filtre_B(filtre_A(%s))';
  3. $interface['table_des_traitements']['BALISE'][]= _TRAITEMENT_TYPO;
  4. $interface['table_des_traitements']['BALISE'][]= _TRAITEMENT_RACCOURCIS;
  5. $interface['table_des_traitements']['BALISE']['boucle']= _TRAITEMENT_TYPO;
  6. // exemples dans SPIP
  7. $interface['table_des_traitements']['BIO'][]= _TRAITEMENT_RACCOURCIS;
  8. $interface['table_des_traitements']['CHAPO'][]= _TRAITEMENT_RACCOURCIS;
  9. $interface['table_des_traitements']['DATE'][]= 'normaliser_date(%s)';
  10. $interface['table_des_traitements']['ENV'][]= 'entites_html(%s,true)';
  11. // exemples dans le plugin d'exemple "chat"
  12. $interface['table_des_traitements']['RACE']['chats'] = _TRAITEMENT_TYPO;
  13. $interface['table_des_traitements']['INFOS']['chats'] = _TRAITEMENT_RACCOURCIS;

Télécharger

Un exemple très souvent utile est la suppression automatique des numéros sur des titres de rubriques. Cela peut être réalisé comme ceci dans son fichier config/mes_options.php (ou en utilsant ce pipeline dans un plugin évidemment !) :

  1. // version simple
  2. $GLOBALS['table_des_traitements']['TITRE'][]= 'typo(supprimer_numero(%s), "TYPO", $connect)';
  3.  
  4. // version complexe (ne pas ecraser la definition existante)
  5. if (isset($GLOBALS['table_des_traitements']['TITRE'][0])) {
  6. $s = $GLOBALS['table_des_traitements']['TITRE'][0];
  7. } else {
  8. $s = '%s';
  9. }
  10. $GLOBALS['table_des_traitements']['TITRE'][0] = str_replace('%s', 'supprimer_numero(%s)', $s);

Télécharger

Exemple

Prenons l’exemple complexe du plugin Agenda, qui déclare une table spip_evenements, une table de liaison spip_mots_evenenents et une seconde table de liaison spip_evenements_participants.

Un alias est posé pour boucler sur les évènements. Des jointures explicites sont déclarées, un champ date et des traitements également. Il y a presque tout !

  1. function agenda_declarer_tables_interfaces($interface){
  2. // 'spip_' dans l'index de $tables_principales
  3. $interface['table_des_tables']['evenements']='evenements';
  4.  
  5. //-- Jointures ----------------------------------------------------
  6. $interface['tables_jointures']['spip_evenements'][]= 'mots'; // a placer avant la jointure sur articles
  7. $interface['tables_jointures']['spip_articles'][]= 'evenements';
  8. $interface['tables_jointures']['spip_evenements'][] = 'articles';
  9. $interface['tables_jointures']['spip_mots'][]= 'mots_evenements';
  10. $interface['tables_jointures']['spip_evenements'][] = 'mots_evenements';
  11. $interface['tables_jointures']['spip_evenements'][] = 'evenements_participants';
  12. $interface['tables_jointures']['spip_auteurs'][] = 'evenements_participants';
  13.  
  14. $interface['table_des_traitements']['LIEU'][]= 'propre(%s)';
  15.  
  16. // permet d'utiliser les criteres racine, meme_parent, id_parent
  17. $interface['exceptions_des_tables']['evenements']['id_parent']='id_evenement_source';
  18. $interface['exceptions_des_tables']['evenements']['id_rubrique']=array('spip_articles', 'id_rubrique');
  19.  
  20. $interface['table_date']['evenements'] = 'date_debut';
  21.  
  22. return $interface;
  23. }

Télécharger

Auteur Matthieu Marcillaud Publié le : Mis à jour : 17/05/10

Traductions : English, français