sync with EN

This commit is contained in:
yannick
2006-10-08 12:39:15 +00:00
parent a88922ae3a
commit bb46b87b66
17 changed files with 444 additions and 347 deletions

View File

@@ -1,6 +1,7 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1.3 Maintainer: yannick Status: ready -->
<!-- EN-Revision: 1.4 Maintainer: yannick Status: ready -->
<sect1 id="plugins.block.functions">
<title>Fonctions de blocs</title>
<funcsynopsis>
@@ -12,89 +13,95 @@
</funcprototype>
</funcsynopsis>
<para>
Les fonctions de blocs sont des fonctions de la forme {func} .. {/func}.
Les fonctions de blocs sont des fonctions de la forme <literal>{func} .. {/func}</literal>.
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}.
<link linkend="language.custom.functions">fonctions utilisateurs</link>
de m<>me nom, ce qui signifie que vous ne
pouvez avoir une fonction utilisateur <literal>{func}</literal> et une fonction de bloc
<literal>{func}..{/func}</literal>.
</para>
<para>
Par d<>faut, 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 (voir <literal>&amp;$repeat</literal> ci-dessous
sur la fa<66>on de modifier ce comportement).
</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
contenus dans le tableau associatif <parameter>$params</parameter>.
Vous pouvez acc<63>der <20> ces valeurs directement par
<varname>$params['start']</varname>.
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 <20>
<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>
Le param<61>tre <parameter>&amp;$repeat</parameter> est pass<73>
par r<>f<EFBFBD>rence <20> la fonction d'impl<70>mentation et fournit la possibilit<69>
de contr<74>ler le nombre d'affichage du bloc. Par d<>faut,
<parameter>$repeat</parameter> vaut <literal>true</literal>
lors du premier appel <20> la fonction de bloc (le bloc d'ouverture du tag) et
<literal>false</literal> lors de tous les autres appels <20> la fonction
de bloc (le bloc de fermeture du tag). Chaque fois que la fonction
d'impl<70>mentation retourne avec le param<61>tre
<parameter>&amp;$repeat</parameter> vallant true, le contenu situ<74>
entre {func} .. {/func} est <20>valu<6C> et la fonction d'impl<70>mentation est appel<65>
une nouvelle fois avec le nouveau bloc de contenu en tant que param<61>tre
<parameter>$content</parameter>.
</para>
<itemizedlist>
<listitem><para>
Par d<>faut, 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 (voir <literal>$repeat</literal> ci-dessous
sur la fa<66>on de modifier ce comportement).
</para></listitem>
<listitem><para>
Seule la balise ouvrante d'une fonction de bloc peut avoir des
<link linkend="language.syntax.attributes">attributs</link>.
Tous les attributs pass<73>s par le template aux fonctions de templates sont
contenus dans le tableau associatif <parameter>$params</parameter>.
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></listitem>
<listitem><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 <20> &null; et si c'est la balise fermante,
elle sera <EFBFBD>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></listitem>
<listitem><para>
Le param<61>tre <parameter>$repeat</parameter> est pass<73>
par r<>f<EFBFBD>rence <20> la fonction d'impl<70>mentation et fournit la possibilit<69>
de contr<74>ler le nombre d'affichage du bloc. Par d<>faut,
<parameter>$repeat</parameter> vaut
&true; lors du premier appel <20> la fonction de bloc (le bloc d'ouverture du tag) et
&false; lors de tous les autres appels <20> la fonction
de bloc (le bloc de fermeture du tag). Chaque fois que la fonction
d'impl<70>mentation retourne avec le param<61>tre
<parameter>$repeat</parameter> vallant &true;, le contenu situ<74>
<literal>{func}...{/func}</literal> est <20>valu<6C> et la fonction d'impl<70>mentation est appel<65>
une nouvelle fois avec le nouveau bloc de contenu en tant que param<61>tre
<parameter>$content</parameter>.
</para></listitem>
</itemizedlist>
<para>
Si vous imbriqu<71> des fonctions de bloc, il est possible de conna<6E>tre
la fonction de bloc parente gr<67>ce <20> la variable <varname>$smarty->_tag_stack</varname>.
Fa<46>tes un var_dump() dessus et la structure devrait appara<72>tre.
</para>
<para>
Regardez aussi :
<link linkend="api.register.block">register_block()</link>,
<link linkend="api.unregister.block">unregister_block()</link>.
la fonction de bloc parente gr<67>ce <20> la variable <literal>$smarty->_tag_stack</literal>.
Fa<46>tes un <ulink url="&url.php-manual;var_dump"><varname>var_dump()</varname></ulink>
dessus et la structure devrait appara<72>tre.
</para>
<example>
<title>Fonction de bloc</title>
<programlisting role="php">
<![CDATA[
<![CDATA[
<?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)
* Smarty plugin
* -------------------------------------------------------------
* Fichier : block.translate.php
* Type : bloc
* Nom : translate
* R<>le : traduire un bloc de texte
* -------------------------------------------------------------
*/
function smarty_block_translate($params, $content, &$smarty, &$repeat)
{
if ($content) {
$lang = $params['lang'];
// fait une traduction de $content
echo $translation;
}
// n'affiche que lors de la balise fermante
if(!$repeat){
if (isset($content)) {
$lang = $params['lang'];
// effectuer une bonne traduction ici avec $content
return $translation;
}
}
}
?>
]]>
</programlisting>
</example>
<para>
Voir aussi :
<link linkend="api.register.block"><varname>register_block()</varname></link> et
<link linkend="api.unregister.block"><varname>unregister_block()</varname></link>.
</para>
</sect1>
<!-- Keep this comment at the end of the file
Local variables: