BaliseCommentaire

Attention, cet exemple ne marche plus avec la version actuelle du cvs. C’est juste une histoire de commentaires imbriqués, alors les principes décris ici restent intéressant à lire.

Dans SPIP, quand on veut commenter un squelette, c’est pas toujours jolie. On se retrouve dans la page html avec des commentaires pas très pertinents et souvent répétés (à cause des boucles).

Voyons donc comment utiliser la magie du nouveau compilateur pour créer des balises de commentaire.

But

On veut tout simplement émuler /* et */ (commentaire en bloc) comme dans beaucoup de langages de programmation. On déclare donc deux nouvelles balises :
-  #DEBUT_COMMENT
-  #FIN_COMMENT

Comment on déclare une nouvelle balise

Avec la nouvelle version du compilateur proposé par ESJ et actuellement inclus dans la version 1.8a4, on peut facilement déclarer (ou redéclarer) une balise. Il suffit pour cela de placer dans mes_options.php3 une fonction qui s’appelle :
balise_MABALISE

qu’est ce qui se passe dans SPIP

On apprend en regardant dans le code de spip, que cette nouvelle fonction doit :

[...] genere le code PHP correspondant a la balise Spip.

Retourne [...] une EXPRESSION php [...]

La nouvelle fonction de calcul de balise doit donc retourner du code PHP. Mais pourquoi ?

SPIP va utiliser ce code pour construire un fichier .php dans le cache. Ce fichier sera ensuite exécuter pour créer une page — si possible — totalement en html. MAIS il ne faut pas renvoyer n’importe quel code ! il faut renvoyer du code qui renvois une chaîne de caractères. En effet, le compilateur concatène les chaînes retournées par le code de chaque balise avec le code html — ou autre — qui les entoure dans le squelette.

Le code

Regardons le code pour nos deux nouvelles balises :

function balise_DEBUT_COMMENT($params) {
  $params->code = "''/*";
return $params;
}

function balise_FIN_COMMENT($params) {
  $params->code = "*/";
return $params;
}

Explication

Spip va donc essayer de concatener la chaîne retournée par notre code avec le reste des chaînes calculées. On ne peut donc pas juste retourner /* et */, sinon on aura quelque chose comme ça :

$ducode . "du texte brute<br/>"./*. un commentaire .*/ . $leresteducode

Il y aura donc un . de trop. C’est pourquoi — dans le code de la 1^er balise — on retourne ''/*. Ainsi on annule le point en trop :

$ducode . "du texte brute<br/>".''/*. un commentaire .*/ . $leresteducode