/
forward.xml
151 lines (142 loc) · 4.81 KB
/
forward.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c9389e4a0e96801fd14d91336ff3f12e45929a73 Maintainer: sergey Status: ready -->
<!-- Reviewed: no -->
<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>Переходит к другому действию</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</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>bool</type><methodname>Yaf_Controller_Abstract::forward</methodname>
<methodparam><type>string</type><parameter>controller</parameter></methodparam>
<methodparam><type>string</type><parameter>action</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>paramters</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>Yaf_Controller_Abstract::forward</methodname>
<methodparam><type>string</type><parameter>module</parameter></methodparam>
<methodparam><type>string</type><parameter>controller</parameter></methodparam>
<methodparam><type>string</type><parameter>action</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>paramters</parameter></methodparam>
</methodsynopsis>
<para>
Перенаправляет текущий процесс выполнения на другое действие.
<note>
<para>
Метод не переключается на указанное действие немедленно,
переход происходит после завершения текущего потока.
</para>
</note>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>module</parameter></term>
<listitem>
<para>
Имя целевого модуля, если задано NULL, то подразумевается
имя модуля по умолчанию
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>controller</parameter></term>
<listitem>
<para>
Имя целевого контроллера
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>action</parameter></term>
<listitem>
<para>
Имя целевого действия
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>paramters</parameter></term>
<listitem>
<para>
Аргументы вызова
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Пример использования <function>Yaf_Controller_Abstract::forward</function></title>
<programlisting role="php">
<![CDATA[
<?php
class IndexController extends Yaf_Controller_Abstract
{
public function indexAction(){
$logined = $_SESSION["login"];
if (!$logined) {
$this->forward("login", array("from" => "Index")); // вперёд к действию login
return FALSE; // это важно, это закончить текущий рабочий поток
// и сказать Yaf не делать авторендеринг
}
// other processes
}
public function loginAction() {
echo "Вход, перенаправлено с действия ", $this->_request->getParam("from");
}
}
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Вход, перенаправлено с действия Index
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>Yaf_Request_Abstrace::getParam</methodname></member>
</simplelist>
</refsect1>
</refentry>
<!-- 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:"~/.phpdoc/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
-->