Files
smarty/docs/pt_BR/designers/language-builtin-functions/language-function-include-php.xml
2004-04-13 08:46:28 +00:00

129 lines
4.6 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<sect1 id="language.function.include.php">
<title>include_php</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>Requerido</entry>
<entry>Padrão</entry>
<entry>Descrição</entry>
</row>
</thead>
<tbody>
<row>
<entry>file</entry>
<entry>string</entry>
<entry>Sim</entry>
<entry><emphasis>n/a</emphasis></entry>
<entry>O nome do arquivo php a incluir</entry>
</row>
<row>
<entry>once</entry>
<entry>boolean</entry>
<entry>Não</entry>
<entry><emphasis>true</emphasis></entry>
<entry>Quando incluir ou não o arquivo php mais de uma vez se
incluído várias vezes</entry>
</row>
<row>
<entry>assign</entry>
<entry>string</entry>
<entry>Não</entry>
<entry><emphasis>n/a</emphasis></entry>
<entry>O nome da variável
que receberá a saída do arquivo php</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>
Tags include_php são usadas para incluir um script php no seu template.
Se a segurança estiver ativada, então o script php deve estar localizado
no caminho $trusted_dir. A tag include_php deve ter o atributo
"file", o qual contém o caminho para o arquivo php a ser incluído,
ou relativo a $trusted_dir, ou um caminho absoluto.
</para>
<para>
include_php é um bom meio de manipular templates com componentes,
e mante o código PHP separado dos arquivos de template. Vamos dizer
que você tenha um template que mostre a navegação do seu site, o qual
é prenchido automaticamente a partir de um banco de dados. Você pode
manter a sua lógica PHP que obtém os dados em um diretório separado,
e inclui-la no topo do template. Agora você pode incluir este template
em qualquer lugar sem se preocupar se a informação do banco de dados foi
obtida antes de usar.
</para>
<para>
Por padrão, os arquivos php são incluídos apenas uma vez mesmo
se incluídos várias vezes no template. Você pode especificar que ele
seja incluído todas as vezes com o atributo <emphasis>once</emphasis>.
Definindo once para false irá incluir o script php a cada vez que
ele seja incluído no template.
</para>
<para>
Você pode opcionalmente passar o atributo <emphasis>assign</emphasis>,
o qual irá especificar uma variável de template a qual irá conter
toda a saída de
<emphasis>include_php</emphasis> em vez de mostra-la.
</para>
<para>
O objeto smarty esta disponível como $this dentro do
script php que você incluiu.
</para>
<example>
<title>Função include_php</title>
<programlisting>
load_nav.php
-------------
&lt;?php
// carrega variáveis de um banco de dados mysql e define ela para o template
require_once("MySQL.class.php");
$sql = new MySQL;
$sql->query("select * from site_nav_sections order by name",SQL_ALL);
$this->assign('sections',$sql->record);
?&gt;
index.tpl
---------
{* caminho absoluto ou relativo a $trusted_dir *}
{include_php file="/path/to/load_nav.php"}
{foreach item="curr_section" from=$sections}
&lt;a href="{$curr_section.url}"&gt;{$curr_section.name}&lt;/a&gt;&lt;br&gt;
{/foreach}</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
-->