reference/yaf/yaf_controller_abstract/forward.xml
c9389e4a0e96801fd14d91336ff3f12e45929a73
c9389e4a0e96801fd14d91336ff3f12e45929a73
...
...
@@ -4,24 +4,24 @@
4
4
<refentry xml:id="yaf-controller-abstract.forward" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5
5
<refnamediv>
6
6
<refname>Yaf_Controller_Abstract::forward</refname>
7
-
<refpurpose>Foward to another action</refpurpose>
7
+
<refpurpose>Forward to another action</refpurpose>
8
8
</refnamediv>
9
9
10
10
<refsect1 role="description">
11
11
&reftitle.description;
12
12
<methodsynopsis>
13
-
<modifier>public</modifier> <type>void</type><methodname>Yaf_Controller_Abstract::forward</methodname>
13
+
<modifier>public</modifier> <type>bool</type><methodname>Yaf_Controller_Abstract::forward</methodname>
14
14
<methodparam><type>string</type><parameter>action</parameter></methodparam>
15
15
<methodparam choice="opt"><type>array</type><parameter>paramters</parameter></methodparam>
16
16
</methodsynopsis>
17
17
<methodsynopsis>
18
-
<modifier>public</modifier> <type>void</type><methodname>Yaf_Controller_Abstract::forward</methodname>
18
+
<modifier>public</modifier> <type>bool</type><methodname>Yaf_Controller_Abstract::forward</methodname>
19
19
<methodparam><type>string</type><parameter>controller</parameter></methodparam>
20
20
<methodparam><type>string</type><parameter>action</parameter></methodparam>
21
21
<methodparam choice="opt"><type>array</type><parameter>paramters</parameter></methodparam>
22
22
</methodsynopsis>
23
23
<methodsynopsis>
24
-
<modifier>public</modifier> <type>void</type><methodname>Yaf_Controller_Abstract::forward</methodname>
24
+
<modifier>public</modifier> <type>bool</type><methodname>Yaf_Controller_Abstract::forward</methodname>
25
25
<methodparam><type>string</type><parameter>module</parameter></methodparam>
26
26
<methodparam><type>string</type><parameter>controller</parameter></methodparam>
27
27
<methodparam><type>string</type><parameter>action</parameter></methodparam>
...
...
@@ -77,6 +77,13 @@
77
77
</variablelist>
78
78
</refsect1>
79
79
80
+
<refsect1 role="returnvalues">
81
+
&reftitle.returnvalues;
82
+
<para>
83
+
&return.success;
84
+
</para>
85
+
</refsect1>
86
+
80
87
<refsect1 role="examples">
81
88
&reftitle.examples;
82
89
<example>
...
...
@@ -113,14 +120,6 @@ class IndexController extends Yaf_Controller_Abstract
113
120
</example>
114
121
</refsect1>
115
122
116
-
117
-
<refsect1 role="returnvalues">
118
-
&reftitle.returnvalues;
119
-
<para>
120
-
return FALSE on failure
121
-
</para>
122
-
</refsect1>
123
-
124
123
<refsect1 role="seealso">
125
124
&reftitle.seealso;
126
125
<simplelist>
127
126