smarty/docs/fr/programmers/plugins/plugins-resources.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1.3 Maintainer: yannick Status: ready -->

<sect1 id="plugins.resources"><title>Ressources</title>
 <para>
  Les plugins ressources sont un moyen g<>n<EFBFBD>rique de fournir des sources
  de templates ou des composants de scripts PHP <20> Smarty. Quelques exemples
  de ressources : bases de donn<6E>es, LDAP, m<>moire partag<61>e, sockets, etc.
 </para>
 <para>
  Il y au total quatre fonctions qui ont besoin d'<27>tre enregistr<74>es pour
  chaque type de ressource. Chaque fonction re<72>oit le nom de la ressource demand<6E>e
  comme premier param<61>tre et l'objet Smarty comme dernier param<61>tre.
  Les autres param<61>tres d<>pendent de la fonction.
 </para>
 <funcsynopsis>
  <funcprototype>
   <funcdef>bool <function>smarty_resource_<replaceable>name</replaceable>_source</function></funcdef>
   <paramdef>string <parameter>$rsrc_name</parameter></paramdef>
   <paramdef>string <parameter>&amp;$source</parameter></paramdef>
   <paramdef>object <parameter>&amp;$smarty</parameter></paramdef>
  </funcprototype>
  <funcprototype>
   <funcdef>bool <function>smarty_resource_<replaceable>name</replaceable>_timestamp</function></funcdef>
   <paramdef>string <parameter>$rsrc_name</parameter></paramdef>
   <paramdef>int <parameter>&amp;$timestamp</parameter></paramdef>
   <paramdef>object <parameter>&amp;$smarty</parameter></paramdef>
  </funcprototype>
  <funcprototype>
   <funcdef>bool <function>smarty_resource_<replaceable>name</replaceable>_secure</function></funcdef>
   <paramdef>string <parameter>$rsrc_name</parameter></paramdef>
   <paramdef>object <parameter>&amp;$smarty</parameter></paramdef>
  </funcprototype>
  <funcprototype>
   <funcdef>bool <function>smarty_resource_<replaceable>name</replaceable>_trusted</function></funcdef>
   <paramdef>string <parameter>$rsrc_name</parameter></paramdef>
   <paramdef>object <parameter>&amp;$smarty</parameter></paramdef>
  </funcprototype>
 </funcsynopsis>

 <itemizedlist>
  <listitem>
   <para>
    La premi<6D>re fonction est suppos<6F>e r<>cup<75>rer la ressource. Son second
    param<61>tre est une variable pass<73>e par r<>f<EFBFBD>rence o<> le r<>sultat doit <20>tre
    stock<63>. La fonction est suppos<6F>e retourner &true; si
    elle r<>ussit <20> r<>cup<75>rer la ressource et &false; sinon.
   </para></listitem>

  <listitem><para>
    La seconde fonction est suppos<6F>e r<>cup<75>rer la date de derni<6E>re modification
    de la ressource demand<6E>e (comme un timestamp UNIX). Le second param<61>tre
    est une variable pass<73>e par r<>f<EFBFBD>rence dans laquelle la date doit
    <20>tre stock<63>e. La fonction est suppos<6F>e renvoyer &true; si elle
    r<>ussit <20> r<>cup<75>rer la date et &false; sinon.
   </para></listitem>

  <listitem><para>
    La troisi<73>me fonction est suppos<6F>e retourner &true;
    ou &false; selon si la ressource demand<6E>e est s<>re
    ou non. La fonction est utilis<69>e seulement pour les ressources templates
    mais doit tout de m<>me <20>tre d<>finie.
   </para></listitem>

  <listitem><para>
    La quatri<72>me fonction est suppos<6F>e retourner &true;
    ou &false; selon si l'on peut faire confiance ou
    non <20> la ressource demand<6E>e. Cette fonction est utilis<69>e seulement
    pour les composants de scripts PHP demand<6E>s par les balises
    <link linkend="language.function.include.php">
     <varname>{include_php}</varname></link> ou
    <link linkend="language.function.insert"><varname>{insert}</varname></link>
    ayant un attribut <parameter>src</parameter>. Quoiqu'il en soit,
    elle doit <20>tre d<>finie pour les ressources templates.
   </para></listitem>
 </itemizedlist>

 <example>
  <title>resource plugin</title>
  <programlisting role="php">
<![CDATA[
<?php
/*
* Smarty plugin
* ------------------------------------------------------------- 
* Fichier :  resource.db.php
* Type :     ressource
* Nom :      db
* R<>le :     R<>cup<75>re des templates depuis une base de donn<6E>es
* -------------------------------------------------------------
*/
function smarty_resource_db_source($tpl_name, &$tpl_source, &$smarty)
{
   // fait des requ<71>tes BD pour r<>cup<75>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<71>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<69>e pour les templates
}
?>
]]>
  </programlisting>
 </example>
 <para>
  Voir aussi :
  <link linkend="api.register.resource">register_resource()</link> et
  <link linkend="api.unregister.resource">unregister_resource()</link>.
 </para>
</sect1>

 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
 sgml-omittag:t
 sgml-shorttag:t
 sgml-minimize-attributes:nil
 sgml-always-quote-attributes:t
 sgml-indent-step:1
 sgml-indent-data:t
 indent-tabs-mode:nil
 sgml-parent-document:nil
 sgml-default-dtd-file:"../../../../manual.ced"
 sgml-exposed-tags:nil
 sgml-local-catalogs:nil
 sgml-local-ecat-files:nil
 End:
 vim600: syn=xml fen fdm=syntax fdl=2 si
 vim: et tw=78 syn=sgml
 vi: ts=1 sw=1
 -->