Files
smarty/docs/pt_BR/programmers/plugins/plugins-block-functions.xml

114 lines
4.4 KiB
XML
Raw Normal View History

2004-04-13 11:47:32 +00:00
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1.1 Maintainer: nobody Status: ready -->
<sect1 id="plugins.block.functions"><title>Block Functions</title>
2004-04-13 11:47:32 +00:00
<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>
Fun<75><6E>es de Block s<>o fun<75><6E>es da forma: {func} .. {/func}. Em outras palavras, ele enclausura
um bloco de template e opera no conte<74>do deste bloco. Fun<75><6E>es de Block tem preced<65>ncia sobre
fun<75><6E>es customizadas com mesmo nome,
assim, voc<6F> n<>o pode ter ambas, fun<75><6E>o customiz<69>vel {func} e
fun<75><6E>o de Bloco {func} .. {/func}.
</para>
<para>
Por defini<6E><69>o a implementa<74><61>o de sua fun<75><6E>o <20> chamada duas vezes pela Smarty: uma vez pela tag de abertura,
e outra pela tag de fechamento
(veja <literal>&amp;$repeat</literal> abaixo para como mudar isto).
</para>
<para>
Apenas a tag de abertura da fun<75><6E>o de bloco pode ter atributos.
Todos os atributos passados para as fun<75><6E>es de
template est<73>o contidos em <parameter>$params</parameter> como um array associativo. Voc<6F> pode ou acessar
esses valores diretamente, i.e. <varname>$params['start']</varname>
ou usar <varname>extract($params)</varname>
para import<72>-los para dentro da tabela s<>mbolo. Os atributos da tag de
abertura s<>o tamb<6D>m acess<73>veis a sua fun<75><6E>o
quando processando a tag de fechamento.
</para>
<para>
O valor da vari<72>vel <parameter>$content</parameter>
depende de que se sua fun<75><6E>o <20> chamada pela tag de
fechamento ou de abertura. Caso seja a de abertura, ele ser<65>
<literal>null</literal>, se for a de fechamento
o valor ser<65> do conte<74>do do bloco de template.
Note que o bloco de template j<> ter<65> sido processado pela
Smarty, ent<6E>o tudo que voc<6F> receber<65> <20> sa<73>da do template, n<>o o template original.
</para>
<para>
O par<61>metro <parameter>&amp;$repeat</parameter> <20> passado por
refer<65>ncia para a fun<75><6E>o de implementa<74><61>o
e fornece uma possibilidade para ele controlar quantas
vezes o bloco <20> mostrado. Por defini<6E><69>o
<parameter>$repeat</parameter> <20> <literal>true</literal> na primeira chamada da block-function
(a tag de abertura do bloco) e <literal>false</literal>
em todas as chamadas subsequentes <20> fun<75><6E>o de bloco
(a tag de fechamento do bloco). Cada vez que a
implementa<74><61>o da fun<75><6E>o retorna com o <parameter>&amp;$repeat</parameter>
sendo true, o conte<74>do entre {func} .. {/func} <20> avaliado
e a implementa<74><61>o da fun<75><6E>o <20> chamada novamente com
o novo conte<74>do do bloco no par<61>metro <parameter>$content</parameter>.
</para>
<para>
Se voc<6F> tem fun<75><6E>es de bloco aninhadas, <20> poss<73>vel
descobrir qual <20> a fun<75><6E>o de bloco pai acessando
a vari<72>vel <varname>$smarty->_tag_stack</varname>. Apenas fa<66>a um var_dump()
nela e a estrutura estaria vis<69>vel.
</para>
<para>
See also:
<link linkend="api.register.block">register_block()</link>,
<link linkend="api.unregister.block">unregister_block()</link>.
</para>
<example>
<title>fun<EFBFBD><EFBFBD>o de bloco</title>
<programlisting>
&lt;?php
/*
* Smarty plugin
* -------------------------------------------------------------
* File: block.translate.php
* Type: block
* Name: translate
* Purpose: translate a block of text
* -------------------------------------------------------------
*/
function smarty_block_translate($params, $content, &amp;$smarty)
{
if (isset($content)) {
$lang = $params['lang'];
// do some intelligent translation thing here with $content
return $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
-->