banana split

docs/fr/programmers/plugins/plugins-block-functions.xml

@@ -0,0 +1,96 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision$ -->
+   <sect1 id="plugins.block.functions"><title>Fonctions de blocs</title>
+    <funcsynopsis>
+     <funcprototype>
+      <funcdef>void <function>smarty_block_<replaceable>name</replaceable></function></funcdef>
+      <paramdef>array <parameter>$params</parameter></paramdef>
+      <paramdef>mixed <parameter>$content</parameter></paramdef>
+      <paramdef>object <parameter>&amp;$smarty</parameter></paramdef>
+     </funcprototype>
+    </funcsynopsis>
+    <para>
+    Les fonctions de blocs sont des fonctions de la forme {func} .. {/func}.
+    En d'autres mots, elles englobent des blocs de template et op<6F>rent sur les
+    contenus de ces blocs. Les fonctions de blocs ont la priorit<69> sur les
+    fonctions utilisateurs de m<>me nom, ce qui signifie que vous ne
+    pouvez avoir une fonction utilisateur {func} et une fonction de bloc
+    {func} .. {/func}.
+    </para>
+    <para>
+    L'impl<70>mentation de votre fonction est appel<65>e deux fois par Smarty :
+    une fois pour la balise ouvrante et une autre fois pour la balise
+    fermante.
+    </para>
+    <para>
+    Seule la balise ouvrante d'une fonction de bloc peut avoir des attributs.
+    Tous les attributs pass<73>s par le template aux fonctions de templates sont
+    contenues dans le tableau associatif <parameter>$params</parameter>.
+    Vous pouvez acc<63>der a ces valeurs soit directement, par exemple
+    <varname>$params['start']</varname>, soit en utilisant
+    <varname>extract($params)</varname> pour les importer dans la table
+    des symboles. Votre fonction a aussi acc<63>s aux attributs de la balise
+    ouvrante quand c'est la balise fermante qui est ex<65>cut<75>e.     
+    </para>
+    <para>
+    La valeur de la variable <parameter>$content</parameter> est diff<66>rente
+    selon si votre fonction est appel<65>e pour la balise ouvrante ou la
+    balise fermante. Si c'est pour la balise ouvrante, elle sera a
+    <literal>null</literal> et si c'est la balise fermante elle sera
+    <20>gale au contenu du bloc de template. Notez que le bloc de template
+    aura d<>j<EFBFBD> <20>t<EFBFBD> ex<65>cut<75> par Smarty, vous recevrez donc la sortie du
+    template et non sa source.    
+    </para>
+    <para>
+    Si vous imbriqu<71> des fonctions de bloc, il est possible de connaetre
+    la fonction de bloc parente grGce a la variable <varname>$smarty->_tag_stack</varname>.
+    Faites un var_dump() dessus et la structure devrait apparaetre.
+    </para>    
+    <para>
+     Regardez aussi :
+     <link linkend="api.register.block">register_block()</link>,
+     <link linkend="api.unregister.block">unregister_block()</link>.
+    </para>
+    <example>
+     <title>fonction de bloc</title>
+     <programlisting>
+&lt;?php
+/*
+ * Smarty plugin
+ * -------------------------------------------------------------
+ * Fichier :  block.translate.php
+ * Type :     bloc
+ * Nom :      translate
+ * R<>le :     traduire un bloc de texte
+ * -------------------------------------------------------------
+ */
+function smarty_block_translate($params, $content, &amp;$smarty)
+{
+    if ($content) {
+        $lang = $params['lang'];
+        // fait une traduction de $content
+        echo $translation;
+    }
+}</programlisting>
+    </example>
+</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
+-->