Files
smarty/docs/ru/designers/language-builtin-functions/language-function-include-php.xml
2008-05-25 15:06:11 +00:00

148 lines
5.5 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0 Maintainer: freespace Status: ready -->
<sect1 id="language.function.include.php">
<title>{include_php}</title>
<note>
<title>Техническое замечание</title>
<para>
{include_php} достаточно устарела в Smarty, вы можете достичь этой
функциональности при помощи собственных функций шаблона.
Единственная причина для использования {include_php} - это серьёзная
необходимость отделить PHP-функцию от директории
<link linkend="variable.plugins.dir">plugins</link>
или кода вашего приложения. См. <link
linkend="tips.componentized.templates">примеры составных шаблонов</link>
для дополнительной информации.
</para>
</note>
<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>Имя атрибута</entry>
<entry>Тип</entry>
<entry>Обязателен</entry>
<entry>По умолчанию</entry>
<entry>Описание</entry>
</row>
</thead>
<tbody>
<row>
<entry>file</entry>
<entry>string</entry>
<entry>Да</entry>
<entry><emphasis>n/a</emphasis></entry>
<entry>Имя подключаемого php файла</entry>
</row>
<row>
<entry>once</entry>
<entry>boolean</entry>
<entry>Нет</entry>
<entry><emphasis>true</emphasis></entry>
<entry>Указывает подключать файл или нет,
если он уже был однажды подключен</entry>
</row>
<row>
<entry>assign</entry>
<entry>string</entry>
<entry>Нет</entry>
<entry><emphasis>n/a</emphasis></entry>
<entry>Название переменной, которой будет
присвоен вывод include_php</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>
Тэги {include_php} используются для подключения PHP-скрипта в шаблон.
Если режим <link linkend="variable.security">$security</link> включен,
то PHP-скрипт должен быть расположен в директории
<link linkend="variable.trusted.dir">$trusted_dir</link>.
Тэг {include_php} должен иметь атрибут "file", который
указывает путь к подключаемому PHP-файлу, либо относительный к
<link linkend="variable.trusted.dir">$trusted_dir</link>,
либо абсолютный путь.
</para>
<para>
По умолчанию, PHP-файлы подключаются только один раз, даже если
вызываются несколько раз в шаблоне. Можно указать, что файл должен
быть подключен каждый раз, указав атрибут <emphasis>once</emphasis>.
Установив once в ложь (false) указывает, что файл должен быть
подключен вне зависимости от того, был ли он подключен раньше.
</para>
<para>
Можно указать опциональный атрибут <emphasis>assign</emphasis>,
который указывает имя переменной, которой будет присвоен вывод
<emphasis>{include_php}</emphasis>, вместо отображения.
</para>
<para>
Объект smarty доступен в подключаемом PHP-файле как $this.
</para>
<example>
<title>Функция {include_php}</title>
<para>load_nav.php</para>
<programlisting role="php">
<![CDATA[
<?php
// загружает переменные из БД MySQL и присваивает их шаблону
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);
?>
]]>
</programlisting>
<para>index.tpl</para>
<programlisting>
<![CDATA[
{* абсолютный путь, либо относительный к $trusted_dir *}
{include_php file='/path/to/load_nav.php'}
{foreach item="curr_section" from=$sections}
<a href="{$curr_section.url}">{$curr_section.name}</a><br />
{/foreach}
]]>
</programlisting>
</example>
<para>
См. также
<link linkend="language.function.include">{include}</link>,
<link linkend="language.function.php">{php}</link>,
<link linkend="language.function.capture">{capture}</link>,
<link linkend="template.resources">Ресурсы</link>
и
<link linkend="tips.componentized.templates">Составные шаблоны</link>
</para>
</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
-->