Files
smarty/docs/pt_BR/designers/language-builtin-functions/language-function-foreach.xml
2004-10-02 12:49:29 +00:00

204 lines
6.3 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1.2 Maintainer: thomasgm Status: ready -->
<sect1 id="language.function.foreach">
<title>foreach,foreachelse</title>
<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>Nome do Atributo</entry>
<entry>Tipo</entry>
<entry>Obrigatório</entry>
<entry>Padrão</entry>
<entry>Descrição</entry>
</row>
</thead>
<tbody>
<row>
<entry>from</entry>
<entry>string</entry>
<entry>Sim</entry>
<entry><emphasis>n/d</emphasis></entry>
<entry>O nome da matriz que você estará pegando os elementos</entry>
</row>
<row>
<entry>item</entry>
<entry>string</entry>
<entry>Yes</entry>
<entry><emphasis>n/d</emphasis></entry>
<entry>O nome da variável
que é o elemento atual</entry>
</row>
<row>
<entry>key</entry>
<entry>string</entry>
<entry>Não</entry>
<entry><emphasis>n/d</emphasis></entry>
<entry>O nome da variável que é a chave atual</entry>
</row>
<row>
<entry>name</entry>
<entry>string</entry>
<entry>Não</entry>
<entry><emphasis>n/d</emphasis></entry>
<entry>O nome do loop foreach para acessar as
propriedades foreach</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>
Loops <emphasis>foreach</emphasis> são uma alternativa para loops
<emphasis>section</emphasis>. <emphasis>foreach</emphasis> é usado
para pegar cada elemento de uma matriz associativa simples.
A sintaxe para <emphasis>foreach</emphasis> é muito mais simples do que
<emphasis>section</emphasis>, mas tem a desvantagem de poder ser usada
apenas para uma única matriz. Tags <emphasis>foreach</emphasis> devem ter
seu par <emphasis>/foreach</emphasis>. Os parâmetros requeridos são
<emphasis>from</emphasis> e <emphasis>item</emphasis>. O nome do loop
foreach pode ser qualquer coisa que você queira, feito de letras, números
e sublinhados. Loops <emphasis>foreach</emphasis>
podem ser aninhados, e o nome dos loops aninhados devem ser diferentes
um dos outros. A variável <emphasis>from</emphasis> (normalmente uma
matriz de valores) determina o número de vezes do loop
<emphasis>foreach</emphasis>.
<emphasis>foreachelse</emphasis> é executado quando não houverem mais valores
na variável <emphasis>from</emphasis>.
</para>
<example>
<title>foreach</title>
<programlisting>
<![CDATA[
{* este exemplo irá mostrar todos os valores da matriz $custid *}
{foreach from=$custid item=curr_id}
id: {$curr_id}<br>
{/foreach}
]]>
</programlisting>
<para>MOSTRA:</para>
<programlisting>
<![CDATA[
id: 1000<br>
id: 1001<br>
id: 1002<br>
]]>
</programlisting>
</example>
<example>
<title>foreach key</title>
<programlisting>
<![CDATA[
{* A key contém a chave para cada valor do loop
A definição se parece com isso:
$smarty->assign("contacts", array(array("phone" => "1", "fax" => "2", "cell" => "3"),
array("phone" => "555-4444", "fax" => "555-3333", "cell" => "760-1234")));
*}
{foreach name=outer item=contact from=$contacts}
{foreach key=key item=item from=$contact}
{$key}: {$item}<br>
{/foreach}
{/foreach}
]]>
</programlisting>
<para>MOSTRA:</para>
<programlisting>
<![CDATA[
phone: 1<br>
fax: 2<br>
cell: 3<br>
phone: 555-4444<br>
fax: 555-3333<br>
cell: 760-1234<br>
]]>
</programlisting>
</example>
<para>
Loop foreach também tem as suas próprias variáveis para manipilar as propriedades
foreach. Estas são indicadas assim: {$smarty.foreach.foreachname.varname} com
foreachname sendo o nome especificado no atributo
<emphasis>name</emphasis> do foreach.
</para>
<sect2 id="foreach.property.iteration">
<title>iteration</title>
<para>
iteration é usado para mostrar a interação atual do loop.
</para>
<para>
Iteration sempre começa em 1 e
é incrementado um a um em cada interação.
</para>
</sect2>
<sect2 id="foreach.property.first">
<title>first</title>
<para>
<emphasis>first</emphasis> é definido como true se a interação atual
do foreach for a primeira.
</para>
</sect2>
<sect2 id="foreach.property.last">
<title>last</title>
<para>
<emphasis>last</emphasis> é definido como true se a interação atual
do foreach for a última.
</para>
</sect2>
<sect2 id="foreach.property.show">
<title>show</title>
<para>
<emphasis>show</emphasis> é usado como parâmetro para o foreach.
<emphasis>show</emphasis> é um valor booleano, true ou false. Se
false, o foreach não será mostrado. Se tiver um foreachelse
presente, este será alternativamente mostrado.
</para>
</sect2>
<sect2 id="foreach.property.total">
<title>total</title>
<para>
<emphasis>total</emphasis> é usado para mostrar o número de interações do
foreach. Isto pode ser usado dentro ou depois do foreach.
</para>
</sect2>
</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
-->