update docs

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@319951 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Xinchen Hui 2011-11-26 12:08:23 +00:00
parent 3569677043
commit 83a6761c73
4 changed files with 16 additions and 13 deletions

View file

@ -4,18 +4,18 @@
<refentry xml:id="yaf-view-interface.assign" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_View_Interface::assign</refname>
<refpurpose>The assign purpose</refpurpose>
<refpurpose>Assign value to View engine</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>abstract</modifier> <modifier>public</modifier> <type>void</type><methodname>Yaf_View_Interface::assign</methodname>
<modifier>abstract</modifier> <modifier>public</modifier> <type>bool</type><methodname>Yaf_View_Interface::assign</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
Assigan values to View engine, then the value can access directly by name in template.
</para>
&warn.undocumented.func;

View file

@ -4,18 +4,18 @@
<refentry xml:id="yaf-view-interface.display" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_View_Interface::display</refname>
<refpurpose>The display purpose</refpurpose>
<refpurpose>Render and output a template</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>abstract</modifier> <modifier>public</modifier> <type>void</type><methodname>Yaf_View_Interface::display</methodname>
<modifier>abstract</modifier> <modifier>public</modifier> <type>bool</type><methodname>Yaf_View_Interface::display</methodname>
<methodparam><type>string</type><parameter>tpl</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>tpl_vars</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>tpl_vars</parameter></methodparam>
</methodsynopsis>
<para>
Render a template and output the result immediatly.
</para>
&warn.undocumented.func;

View file

@ -4,18 +4,18 @@
<refentry xml:id="yaf-view-interface.render" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_View_Interface::render</refname>
<refpurpose>The render purpose</refpurpose>
<refpurpose>Render a template</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>abstract</modifier> <modifier>public</modifier> <type>void</type><methodname>Yaf_View_Interface::render</methodname>
<modifier>abstract</modifier> <modifier>public</modifier> <type>string</type><methodname>Yaf_View_Interface::render</methodname>
<methodparam><type>string</type><parameter>tpl</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>tpl_vars</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>tpl_vars</parameter></methodparam>
</methodsynopsis>
<para>
Render a template and return the result.
</para>
&warn.undocumented.func;

View file

@ -14,7 +14,8 @@
<methodparam><type>string</type><parameter>template_dir</parameter></methodparam>
</methodsynopsis>
<para>
Set the templates base directory, this is usually called by
<classname>Yaf_Dispatcher</classname>
</para>
&warn.undocumented.func;
@ -28,7 +29,9 @@
<term><parameter>template_dir</parameter></term>
<listitem>
<para>
A absolute path to the template directory, by default,
<classname>Yaf_Dispatcher</classname> use
APPLICATION_PATH . "/views" as this paramter.
</para>
</listitem>
</varlistentry>