sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update forward entry

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@329501 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Xinchen Hui 2013-02-19 10:53:22 +00:00
parent af871c29a5
commit 04f882eb0d
1 changed files with 25 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
reference/yaf/yaf_controller_abstract/forward.xml
View file

@ -4,11 +4,22 @@
<refentry xml:id="yaf-controller-abstract.forward" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Controller_Abstract::forward</refname>
<refpurpose>The forward purpose</refpurpose>
<refpurpose>foward to another action</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Controller_Abstract::forward</methodname>
<methodparam><type>string</type><parameter>action</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>paramters</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Controller_Abstract::forward</methodname>
<methodparam><type>string</type><parameter>controller</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>action</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>paramters</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Controller_Abstract::forward</methodname>
<methodparam><type>string</type><parameter>module</parameter></methodparam>
@ -17,7 +28,13 @@
<methodparam choice="opt"><type>array</type><parameter>paramters</parameter></methodparam>
</methodsynopsis>
<para>
forward current execution process to other action.
<note>
<para>
it doesn't switch to other action immediately, the forwarding will
only occurr after current execution flow over.
</para>
</note>
</para>
</refsect1>
@ -28,7 +45,8 @@
<term><parameter>module</parameter></term>
<listitem>
<para>
destination module name, if NULL was given, then default module name
is assumed
</para>
</listitem>
</varlistentry>
@ -36,7 +54,7 @@
<term><parameter>controller</parameter></term>
<listitem>
<para>
destination controller name
</para>
</listitem>
</varlistentry>
@ -44,7 +62,7 @@
<term><parameter>action</parameter></term>
<listitem>
<para>
destination action name
</para>
</listitem>
</varlistentry>
@ -52,7 +70,7 @@
<term><parameter>paramters</parameter></term>
<listitem>
<para>
calling arguments
</para>
</listitem>
</varlistentry>
@ -62,7 +80,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
return FALSE on failure
</para>
</refsect1>