Un nouveau raccourci pour appeler vos fonctions

Ce patch permet aux rédacteurs d’ajouter simplement un bloque de texte créé par une fonction php gérée par le webmaster.
Le principe est simple est très ouvert.
Nous ajoutons un raccourci typographique type :

[![nom_fonction("param1","param2",...)]!]

à chaque fois que ce raccourci est trouvé, nous faisons un eval(« nom_fonction( »param1« , »param2« ,...) ; ») et ce que renvoie cette fonction remplace le fameux raccourci (normal c’est le but !). Attention c’est une description simpliste, donc lisez l’article jusqu’au bout.

Installation du PATCH

-  Première étape, ajouter le raccourci typographique.

Dans le fichier
ecrire/mes_options.php3 (créez le si besoin)
Ajoutez

# false / true
$GLOBALS['activer_fonctions_raccouci_perso'] = 'true';

if ( $GLOBALS['activer_fonctions_raccouci_perso'] == 'true' ) {
	include("inc_fonctions_raccouci_perso.php3");
}

function avant_propre($letexte)
{
	if ( $GLOBALS['activer_fonctions_raccouci_perso'] == 'true' ) {
		// les caractères utilisables dans ce raccourci sont restreints
		while (eregi ("\[\!\[([a-z0-9\%_\"\,\(\)]*)\]\!\]", $letexte, $regs)) {
		// toutes les fonctions déclarées devront commencer par "fct_perso"
		// afin de bloquer le lancement d'instructions "problématiques"
		    $ret = @eval( "return(fct_perso_".$regs[1].");" );
		    $strtmp = str_replace("(", "\(", $regs[1] );
		    $strtmp = str_replace(")", "\)", $strtmp );
		    $letexte = ereg_replace("\[\!\[".$strtmp."\]\!\]", "".$ret."", $letexte);
		}
	}
	return $letexte;
}

$GLOBALS[’activer_fonctions_raccouci_perso’]
peut avoir deux états :
-  false : fonction inactive
-  true : fonction active seulement dans le site public

-  Deuxième étape, inclure les fonctions/raccourcis que vous créez.

Créer le fichier
/ecrire/inc_fonctions_raccouci_perso.php3
mettez-y vos fonctions

<?php
function fct_perso_TEST( $var1, $var2,... ) {
...
?>

Mode d’emploi

À un raccourci

[![nom_fonction("param1","param2",...)]!]

correspond une fonction

fct_perso_nom_fonction($param1,$param2,...)

dans le fichier /ecrire/inc_fonctions_raccouci_perso.php3

Le raccourci n’accepte que les caractères suivant (cf eregi) :
« a » à « z » « 0 » à « 9 » « »« « _ » »," « % »

Si votre fonction doit agir en temps réel (sans système de cache) modifiez votre squelette (ou créez un squelette spécial pour cette article) : la variable $delais = -1

Exemple
Personnellement, je dois mettre en place cette fonction afin de pouvoir ajouter simplement des informations d’une base de données, mais vous pouvez vous en servir pour ajouter un compteur personnalisé, du code javascript, ou toutes autres fonctions non encore intégrées à SPIP.

Pour être plus claire, je vais prendre l’exemple de l’insertion d’une base de données :

Je dois créer un article dont le sujet est les bibliothèques de la ville de Marseille et Martigues, et je possède une base de données qui regroupe toutes les bibliothèques du département.
L’article pourrait se présenter comme ci dessous (dans le champs texte)

 Liste complète des bibliothèques de Marseille :
 [![liste_bibliotheque("marseille")]!]

 Liste complete des bibliothèques de Martigues :
 [![liste_bibliotheque("martigues")]!]
 
 Ces listes sont mises à jour régulièrement.

Passons à la mise en place de la fonction :

Exemple de fonction :

 function fct_perso_liste_bibliotheque( $ville ) {
 $link_perso = mysql_connect("localhost", "XXXXXX", "XXXXX", "new_link") or die("Could not connect");
 mysql_select_db("bibliotheque",$link_perso) or die("Could not select database");
 $query = "SELECT * FROM bibliotheque WHERE nom='$ville'";
 $result = mysql_query($query, $link_perso) or die("Query failed");
 while ($row = mysql_fetch_assoc($result)) {
// JAMAIS DE PRINT ou ECHO
   $str .= " .....";
 }
 mysql_free_result($result);
 mysql_close($link_perso);
// reconnecter SPIP à sa base de données 
 @spip_connect_db('hostname','','login','','database'); // BD de SPIP
 return $str;
}