smarty/docs/fr/designers/language-builtin-functions/language-function-insert.xml

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

<sect1 id="language.function.insert">
 <title>{insert}</title>

 <para>
  Les balises <varname>{insert}</varname> fonctionnent <20> peu pr<70>s comme les balises
  <link linkend="language.function.include"><varname>{include}</varname></link>,
  <20> l'exception que leur sortie n'est PAS plac<61>e en cache lorsque
  <link linkend="caching">le cache</link> du template est activ<69>.
  Les balises {insert} seront ex<65>cut<75>es <20> chaque appel du template.
 </para>

 <informaltable frame="all">
  <tgroup cols="5">
   <colspec colname="param" align="center" />
   <colspec colname="type" align="center" />
   <colspec colname="required" align="center" />
   <colspec colname="default" align="center" />
   <colspec colname="desc" />
   <thead>
    <row>
     <entry>Nom attribut</entry>
     <entry>Type</entry>
     <entry>Requis</entry>
     <entry>Defaut</entry>
     <entry>Description</entry>
    </row>
   </thead>
   <tbody>
    <row>
     <entry>name</entry>
     <entry>cha<EFBFBD>ne de caract<63>res</entry>
     <entry>Oui</entry>
     <entry><emphasis>n/a</emphasis></entry>
     <entry>le nom de la fonction insert (insert_name)</entry>
    </row>
    <row>
     <entry>assign</entry>
     <entry>cha<EFBFBD>ne de caract<63>re</entry>
     <entry>Non</entry>
     <entry><emphasis>n/a</emphasis></entry>
     <entry>Le nom de la variable qui recevra la sortie</entry>
    </row>
    <row>
     <entry>script</entry>
     <entry>cha<EFBFBD>ne de caract<63>res</entry>
     <entry>Non</entry>
     <entry><emphasis>n/a</emphasis></entry>
     <entry>Le nom du script PHP inclus avant que la fonction
      insert ne soit appel<65>e.</entry>
    </row>
    <row>
     <entry>[var ...]</entry>
     <entry>[var type]</entry>
     <entry>Non</entry>
     <entry><emphasis>n/a</emphasis></entry>
     <entry>Variable <20> passer <20> la fonction insert</entry>
    </row>
   </tbody>
  </tgroup>
 </informaltable>
 <para>
  Supposons que vous avez un template avec un emplacement
  pour un bandeau publicitaire en haut de page.
  Ce bandeau publicitaire peut contenir toutes sortes de contenus
  HTML, images, flash, etc. Nous ne pouvons pas placer du contenu
  statique <20> cet endroit. Nous ne voulons pas non plus que ce
  contenu fasse partie du cache. Arrive alors la balise {insert}.
  Le template connais #emplacement_bandeau# et #id_site# (r<>cup<75>r<EFBFBD>s
  depuis un <link linkend="config.files">fichier de configuration</link>),
  et <20> besoin d'un appel de fonction pour r<>cup<75>rer le contenu du bandeau.
 </para>
 <example>
  <title>Fonction {insert}</title>
  <programlisting>
{* exemple de r<>cup<75>ration d'un bandeau publicitaire *}
{insert name="getBanner" lid=#emplacement_bandeau# sid=#id_site#}
  </programlisting>
 </example>
 <para>
  Dans cet exemple, nous utilisons le nom <quote>getBanner</quote> et lui passons les
  param<61>tres #emplacement_bandeau# et #id_site#. Smarty va rechercher une
  fonction appel<65>e insert_getBanner () dans votre application PHP, et lui
  passer les valeurs #banner_location_id# et #site_id# comme premier
  param<61>tre, dans un tableau associatif. Tous les noms des fonctions {insert}
  de votre application doivent <20>tre prefix<69>es de "insert_" pour rem<65>dier
  <20> d'<27>ventuels conflits de nommage. Votre fonction insert_getBanner ()
  est suppos<6F>e traiter les valeurs pass<73>es et retourner
  un r<>sultat. Ces r<>sultats sont affich<63>s dans le template en lieu et
  place de la balise. Dans cet exemple, Smarty appellera cette fonction
  insert_getBanner(array("lid" => "12345","sid" => "67890")); et affichera
   le r<>sultat retourn<72> <20> la place de la balise {insert}.
  </para>
  <itemizedlist>
  <listitem>
  <para>
   Si vous donnez une valeur <20> l'attribut <parameter>assign</parameter>, la sortie de la balise
   <varname>{insert}</varname> sera assign<67> <20> une variable de template de ce nom au lieu d'<27>tre
   affich<63>e	directement.
   <note>
   <para>
    Assigner la sortie <20> une variable n'est pas
    tr<74>s utile lorsque le <link linkend="variable.caching">cache</link> est activ<69>.
   </para>
  </note>
 </para></listitem>

  <listitem>
  <para>
   Si vous donnez une valeur <20> l'attribut <parameter>script</parameter>, ce script PHP sera
   inclus (une seule fois) avant l'ex<65>cution de la fonction <varname>{insert}</varname>.
   Le cas peut survenir lorsque la fonction <varname>{insert}</varname> n'existe pas encore,
   et que le script PHP charg<72> de sa d<>finission doit <20>tre inclus.
  </para>
   <para>
    Le chemin doit <20>tre absolu ou relatif <20>
    <link linkend="variable.trusted.dir"><parameter>$trusted_dir</parameter></link>.
   Lorsque
   <link linkend="variable.security"><parameter>$security</parameter></link> est actif,
   le script doit <20>tre situ<74> dans
   <link linkend="variable.trusted.dir"><parameter>$trusted_dir</parameter></link>.
  </para></listitem>
</itemizedlist>
  <para>
   L'objet Smarty est pass<73> comme second argument. De cette fa<66>on, vous
   pouvez utiliser ou modifier des informations sur l'objet Smarty,
   directement depuis votre fonction <varname>{insert}</varname>.
  </para>
  <note>
   <title>Note technique</title>
   <para>
    Il est possible d'avoir des portions de template qui ne soient pas
    g<>rables par le cache. M<>me si vous avez activ<69> l'option
    <link linkend="caching">caching</link>, les balises <varname>{insert}</varname>
    ne feront pas partie du cache. Elles retourneront un contenu dynamique
    <20> chaque invocation de la page. Cette m<>thode est tr<74>s pratique pour
    des <20>l<EFBFBD>ments tels que les bandeaux publicitaires, les enqu<71>tes,
    la m<>t<EFBFBD>o, les r<>sultats de recherche, retours utilisateurs, etc.
   </para>
  </note>
  <para>
   Voir aussi
   <link linkend="language.function.include"><varname>{include}</varname></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
-->