Les plugins ressources sont un moyen générique de fournir des sources de templates ou des composants de scripts PHP à Smarty. Quelques exemples de ressources : bases de données, LDAP, mémoire partagée, sockets, etc.
Il y au total quatre fonctions qui ont besoin d'être enregistrées pour chaque type de ressource. Chaque fonction reçoit le nom de la ressource demandée comme premier paramètre et l'objet Smarty comme dernier paramètre. Les autres paramètres dépendent de la fonction.
bool smarty_resource_name_source( |
$rsrc_name, | |
| &$source, | ||
&$smarty); |
string $rsrc_name;string &$source;object &$smarty;bool smarty_resource_name_timestamp( |
$rsrc_name, | |
| &$timestamp, | ||
&$smarty); |
string $rsrc_name;int &$timestamp;object &$smarty;bool smarty_resource_name_secure( |
$rsrc_name, | |
&$smarty); |
string $rsrc_name;object &$smarty;bool smarty_resource_name_trusted( |
$rsrc_name, | |
&$smarty); |
string $rsrc_name;object &$smarty;La première fonction est supposée récupérer la ressource. Son second paramètre est une variable passée par référence où le résultat doit être stocké. La fonction est supposée retourner
TRUEsi elle réussit à récupérer la ressource etFALSEsinon.La seconde fonction est supposée récupérer la date de dernière modification de la ressource demandée (comme un timestamp UNIX). Le second paramètre est une variable passée par référence dans laquelle la date doit être stockée. La fonction est supposée renvoyer
TRUEsi elle réussit à récupérer la date etFALSEsinon.La troisième fonction est supposée retourner
TRUEouFALSEselon si la ressource demandée est sûre ou non. La fonction est utilisée seulement pour les ressources templates mais doit tout de même être définie.La quatrième fonction est supposée retourner
TRUEouFALSEselon si l'on peut faire confiance ou non à la ressource demandée. Cette fonction est utilisée seulement pour les composants de scripts PHP demandés par les balises{include_php}ou{insert}ayant un attributsrc. Quoiqu'il en soit, elle doit être définie pour les ressources templates.
Example 16.10. resource plugin
<?php
/*
* Smarty plugin
* -------------------------------------------------------------
* Fichier : resource.db.php
* Type : ressource
* Nom : db
* Rôle : Récupére des templates depuis une base de données
* -------------------------------------------------------------
*/
function smarty_resource_db_source($tpl_name, &$tpl_source, &$smarty)
{
// fait des requêtes BD pour récupérer votre template
// et remplir $tpl_source
$sql = new SQL;
$sql->query("select tpl_source
from my_table
where tpl_name='$tpl_name'");
if ($sql->num_rows) {
$tpl_source = $sql->record['tpl_source'];
return true;
} else {
return false;
}
}
function smarty_resource_db_timestamp($tpl_name, &$tpl_timestamp, &$smarty)
{
// fait des requêtes BD pour remplir $tpl_timestamp
$sql = new SQL;
$sql->query("select tpl_timestamp
from my_table
where tpl_name='$tpl_name'");
if ($sql->num_rows) {
$tpl_timestamp = $sql->record['tpl_timestamp'];
return true;
} else {
return false;
}
}
function smarty_resource_db_secure($tpl_name, &$smarty)
{
// suppose que tous les templates sont svrs
return true;
}
function smarty_resource_db_trusted($tpl_name, &$smarty)
{
// inutilisée pour les templates
}
?>
Voir aussi : register_resource() et unregister_resource().