Files
smarty/docs/ja/designers/language-builtin-functions/language-function-include-php.xml
2008-05-26 08:47:23 +00:00

150 lines
5.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 2663 Maintainer: takagi Status: ready -->
<!-- CREDITS: mat-sh,daichi,joe -->
<sect1 id="language.function.include.php">
<title>{include_php}</title>
<note>
<title>テクニカルノート</title>
<para>
<varname>{include_php}</varname> は Smarty ではほとんど推奨されていません。
カスタムテンプレート関数を使用すれば、同等の機能を実現できます。
<varname>{include_php}</varname> を使用する理由がもしあるとすれば、
<link linkend="variable.plugins.dir"><filename>plugins/</filename></link>
ディレクトリやアプリケーションのコードから PHP 関数を完全に隔離したい場合などです。
詳細は <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>Yes</entry>
<entry><emphasis>n/a</emphasis></entry>
<entry>インクルードする PHP ファイル名</entry>
</row>
<row>
<entry>once</entry>
<entry>boolean</entry>
<entry>No</entry>
<entry><emphasis>&true;</emphasis></entry>
<entry>同じ PHP ファイルが複数回インクルードされた場合に、一度だけインクルードするかどうか</entry>
</row>
<row>
<entry>assign</entry>
<entry>string</entry>
<entry>No</entry>
<entry><emphasis>n/a</emphasis></entry>
<entry>include_php の出力を格納する変数名</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>
<varname>{include_php}</varname> タグを使用して、PHP スクリプトをテンプレートにインクルードします。
<link linkend="variable.security"><parameter>$security</parameter></link>
が有効な場合は、PHP スクリプトは <link
linkend="variable.trusted.dir"><parameter>$trusted_dir</parameter></link>
で指定されたディレクトリに存在する必要があります。<varname>{include_php}</varname>
タグには <parameter>file</parameter> 属性が必須で、
ここにはインクルードする PHP ファイルへのパスを指定します。
このパスは <link linkend="variable.trusted.dir"><parameter>$trusted_dir</parameter></link>
からの相対パスか絶対パスのいずれかとなります。
</para>
<para>
デフォルトでは、PHPファイルはテンプレート内で複数回呼ばれても一度しかインクルードしません。
<parameter>once</parameter> 属性によって毎回インクルードするべきかどうかを指定できます。
この属性を &false; に設定すると、テンプレート内でインクルードの指示がある毎に
PHP スクリプトをインクルードします。
</para>
<para>
オプションで <parameter>assign</parameter> 属性を渡すこともできます。
これは、<varname>{include_php}</varname> の出力をブラウザに表示させる代わりに
変数に格納したい場合に、その変数名を指定します。
</para>
<para>
Smarty オブジェクトは、インクルードした PHP スクリプト内で
<parameter>$this</parameter> として使用可能です。
</para>
<example>
<title>{include_php} 関数</title>
<para><filename>load_nav.php</filename> ファイル</para>
<programlisting role="php">
<![CDATA[
<?php
// mysql データベースから変数の値を読み込み、それをテンプレートに割り当てます
require_once('database.class.php');
$db = new Db();
$db->query('select url, name from navigation order by name');
$this->assign('navigation', $db->getRows());
?>
]]>
</programlisting>
<para>
テンプレート
</para>
<programlisting>
<![CDATA[
{* 絶対パス、あるいは $trusted_dir からの相対パスか *}
{include_php file='/path/to/load_nav.php'}
{foreach item='nav' from=$navigation}
<a href="{$nav.url}">{$nav.name}</a><br />
{/foreach}
]]>
</programlisting>
</example>
<para>
<link linkend="language.function.include"><varname>{include}</varname></link>
<link linkend="variable.security"><parameter>$security</parameter></link>
<link linkend="variable.trusted.dir"><parameter>$trusted_dir</parameter></link>
<link linkend="language.function.php"><varname>{php}</varname></link><link
linkend="language.function.capture"><varname>{capture}</varname></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
-->