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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="Yaf_Dispatcher" namespace="" name="Yaf_Dispatcher">
<member name="_router" static="false" visibility="protected">
<default>null</default>
<docblock>
<description compact=""/>
</docblock>
</member>
<member name="_view" static="false" visibility="protected">
<default>null</default>
<docblock>
<description compact=""/>
</docblock>
</member>
<member name="_request" static="false" visibility="protected">
<default>null</default>
<docblock>
<description compact=""/>
</docblock>
</member>
<member name="_plugins" static="false" visibility="protected">
<default>null</default>
<docblock>
<description compact=""/>
</docblock>
</member>
<member name="_instance" static="false" visibility="protected">
<default>null</default>
<docblock>
<description compact=""/>
</docblock>
</member>
<member name="_auto_render" static="false" visibility="protected">
<default>null</default>
<docblock>
<description compact=""/>
</docblock>
</member>
<member name="_return_response" static="false" visibility="protected">
<default>null</default>
<docblock>
<description compact=""/>
</docblock>
</member>
<member name="_instantly_flush" static="false" visibility="protected">
<default>null</default>
<docblock>
<description compact=""/>
</docblock>
</member>
<member name="_default_module" static="false" visibility="protected">
<default>null</default>
<docblock>
<description compact=""/>
</docblock>
</member>
<member name="_default_controller" static="false" visibility="protected">
<default>null</default>
<docblock>
<description compact=""/>
</docblock>
</member>
<member name="_default_action" static="false" visibility="protected">
<default>null</default>
<docblock>
<description compact=""/>
</docblock>
</member>
<method name="autoRender" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Switch on/off autorendering">Yaf_Dispatcher will render automatically after dispatches a incoming request, you can prevent the rendering by calling this method with flag TRUE you can simply return FALSE in a action to prevent the auto-rendering of that action</description>
<return type="Yaf_Dispatcher"/>
</docblock>
<parameter name="flag" optional="true" byreference="false" type="object" class="bool"/>
</method>
<method name="catchException" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Switch on/off exception catching">While the application.dispatcher.throwException is On(you can also calling to Yaf_Dispatcher::throwException(TRUE) to enable it), Yaf will throw Exception whe error occurrs instead of trigger error.</description>
<return type="Yaf_Dispatcher"/>
</docblock>
<parameter name="flag" optional="true" byreference="false" type="object" class="bool"/>
</method>
<method name="__clone" abstract="false" static="false" final="false">
<docblock>
<description compact="Yaf_Dispatcher can not be cloned"/>
<return type="void"/>
</docblock>
</method>
<constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Yaf_Dispatcher constructor"/>
<return type="void"/>
</docblock>
</constructor>
<method name="disableView" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Disable view rendering">disable view engine, used in some app that user will output by theirself you can simply return FALSE in a action to prevent the auto-rendering of that action</description>
<return type="bool"/>
</docblock>
</method>
<method name="dispatch" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Dispatch a request">This method does the heavy work of the Yaf_Dispatcher. It take a request object.</description>
<return type="Yaf_Response_Abstract"/>
</docblock>
<parameter name="request" optional="false" byreference="false" type="object" class="Yaf_Request_Abstract"/>
</method>
<method name="enableView" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Enable view rendering"/>
<return type="Yaf_Dispatcher"/>
</docblock>
</method>
<method name="flushInstantly" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Switch on/off the instant flushing"/>
<return type="Yaf_Dispatcher"/>
</docblock>
<parameter name="flag" optional="true" byreference="false" type="object" class="bool"/>
</method>
<method name="getApplication" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Retrive the application"/>
<return type="Yaf_Application"/>
</docblock>
</method>
<method name="getInstance" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Retrive the dispatcher instance"/>
<return type="Yaf_Dispatcher"/>
</docblock>
</method>
<method name="getRequest" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Retrive the request instance"/>
<return type="Yaf_Request_Abstract"/>
</docblock>
</method>
<method name="getRouter" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Retrive router instance"/>
<return type="Yaf_Router"/>
</docblock>
</method>
<method name="initView" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Initialize view and return it"/>
<return type="Yaf_View_Interface"/>
</docblock>
<parameter name="templates_dir" optional="false" byreference="false" type="string"/>
<parameter name="options" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="registerPlugin" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Register a plugin"/>
<return type="Yaf_Dispatcher"/>
</docblock>
<parameter name="plugin" optional="false" byreference="false" type="object" class="Yaf_Plugin_Abstract"/>
</method>
<method name="returnResponse" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="The returnResponse purpose"/>
<return type="Yaf_Dispatcher"/>
</docblock>
<parameter name="flag" optional="false" byreference="false" type="object" class="bool"/>
</method>
<method name="setDefaultAction" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Change default action name"/>
<return type="Yaf_Dispatcher"/>
</docblock>
<parameter name="action" optional="false" byreference="false" type="string"/>
</method>
<method name="setDefaultController" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Change default controller name"/>
<return type="Yaf_Dispatcher"/>
</docblock>
<parameter name="controller" optional="false" byreference="false" type="string"/>
</method>
<method name="setDefaultModule" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Change default module name"/>
<return type="Yaf_Dispatcher"/>
</docblock>
<parameter name="module" optional="false" byreference="false" type="string"/>
</method>
<method name="setErrorHandler" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set error handler">Set error handler for Yaf. when application.dispatcher.throwException is off, Yaf will trigger catchable error while unexpected errors occrred.</description>
<return type="Yaf_Dispatcher"/>
</docblock>
<parameter name="callback" optional="false" byreference="false" type="object" class="call"/>
<parameter name="error_types" optional="false" byreference="false" type="int"/>
</method>
<method name="setRequest" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="The setRequest purpose"/>
<return type="Yaf_Dispatcher"/>
</docblock>
<parameter name="request" optional="false" byreference="false" type="object" class="Yaf_Request_Abstract"/>
</method>
<method name="setView" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set a custom view engine"/>
<return type="Yaf_Dispatcher"/>
</docblock>
<parameter name="view" optional="false" byreference="false" type="object" class="Yaf_View_Interface"/>
</method>
<method name="__sleep" abstract="false" static="false" final="false">
<docblock>
<description compact="Yaf_Dispatcher can not be serialized"/>
<return type="void"/>
</docblock>
</method>
<method name="throwException" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Switch on/off exception throwing">Siwtch on/off exception throwing while unexpected error occurring. When this is on, Yaf will throwing exceptions instead of triggering catchable errors.</description>
<return type="Yaf_Dispatcher"/>
</docblock>
<parameter name="flag" optional="true" byreference="false" type="object" class="bool"/>
</method>
<method name="__wakeup" abstract="false" static="false" final="false">
<docblock>
<description compact="Yaf_Dispatcher can not be unserialized"/>
<return type="void"/>
</docblock>
</method>
</class>
|
