Programmer avec SPIP 3.0
Documentation technique sur SPIP 3.0

> > > > Récupérer objet et id_objet

Récupérer objet et id_objet

Nous allons voir comment récupérer le type (objet) et l’identifiant d’une boucle pour s’en servir dans les calculs d’une balise.

Balise statique

Avec les paramètres de balise $p, il est très simple de récupérer objet et id_objet :

  1. function balise_DEMO($p){
  2. // on prend nom de la cle primaire de l'objet pour calculer sa valeur
  3. $_id_objet = $p->boucles[$p->id_boucle]->primary;
  4. $id_objet = champ_sql($_id_objet, $p);
  5. $objet = $p->boucles[$p->id_boucle]->id_table;
  6. $p->code = "calculer_balise_DEMO('$objet', $id_objet)";
  7. return $p;
  8. }
  9. function calculer_balise_DEMO($objet, $id_objet){
  10. $objet = objet_type($objet);
  11. return "Objet : $objet, id_objet : $id_objet";
  12. }

Télécharger

Observons les deux fonctions. La première récupère dans la description de la balise le nom de sa boucle parente, le nom de la clé primaire, et demande à récupérer via la fonction champ_sql() la valeur de la clé primaire. Attention : ce que l’on récupère dans la variable $id_objet est un code qui doit être évalué en PHP (ce n’est pas une valeur numérique encore).

Une fois ces paramètres récupérés, on demande d’ajouter un code PHP à évaluer dans le code généré par la compilation du squelette (ce code sera mis en cache). C’est ce qu’on ajoute dans $p->code. Ce code là sera évalué par la suite au moment de la création du cache de la page appelée.

La fonction calculer_balise_DEMO() reçoit alors les deux arguments souhaités et retourne un texte qui les affiche sur la page.

  1. <BOUCLE_a(ARTICLES){0,2}>
  2. #DEMO<br />
  3. </BOUCLE_a>
  4. <hr />
  5. <BOUCLE_r(RUBRIQUES){0,2}>
  6. #DEMO<br />
  7. </BOUCLE_r>

Télécharger

Ce squelette permet alors de voir le résultat, la balise #DEMO reçoit des informations différentes en fonction du contexte dans lequel elle se trouve :

  1. Objet : article, id_objet : 128
  2. Objet : article, id_objet : 7
  3. ----
  4. Objet : rubrique, id_objet : 1
  5. Objet : rubrique, id_objet : 2

Télécharger

Balise dynamique

Dans le cas d’une balise dynamique, son fonctionnement même empêche de récupérer facilement le type et l’identifiant de la boucle dans laquelle elle est inscrite.

Lorsqu’on a néanmoins besoin de cela, par exemple pour créer des formulaires CVT qui adaptent leurs traitements en fonction du type de boucle, il faut envoyer à la fonction _dyn() (et par conséquent aux fonctions charger, vérifier et traiter de CVT) le type (objet) et l’identifiant de la boucle en cours.

L’appel à calculer_balise_dynamique() permet de récupérer des éléments du contexte de compilation. Si l’on demande à récupérer ’id_article’, on l’obtiendra bien dans une boucle ARTICLES, mais pas dans une boucle RUBRIQUES. En étant plus précis, lorsqu’on demande une valeur ’id_article’, SPIP fait comme s’il récupérait le résultat d’une balise #ID_ARTICLE, il cherche donc la valeur dans la boucle la plus proche, sinon dans le contexte, et aussi en fonction des balises qui ont été déclarées spécifiquement.

On peut demander à calculer id_objet facilement, mais objet va nécessiter de passer par une balise renvoyant la valeur de l’objet. Cette balise n’existant pas par défaut dans SPIP 2.0, il faut en créer une (DEMODYN_OBJET), ce qui donne :

  1. function balise_DEMODYN($p){
  2. // cle primaire
  3. $_id_objet = $p->boucles[$p->id_boucle]->primary;
  4. return calculer_balise_dynamique(
  5. $p, 'DEMODYN', array('DEMODYN_OBJET', $_id_objet)
  6. );
  7. }
  8.  
  9. function balise_DEMODYN_OBJET($p) {
  10. $objet = $p->boucles[$p->id_boucle]->id_table;
  11. $p->code = $objet ? objet_type($objet) : "balise_hors_boucle";
  12. return $p;
  13. }
  14.  
  15. function balise_DEMODYN_dyn($objet, $id_objet){
  16. return "Objet : $objet, id_objet : $id_objet";
  17. }

Télécharger