File: Yaf_Request_Abstract.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (267 lines) | stat: -rw-r--r-- 10,345 bytes parent folder | download | duplicates (2)
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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="Yaf_Request_Abstract" namespace="" name="Yaf_Request_Abstract">
  <constant name="SCHEME_HTTP" value="http">
    <docblock>
      <var type="string"/>
    </docblock>
  </constant>
  <constant name="SCHEME_HTTPS" value="https">
    <docblock>
      <var type="string"/>
    </docblock>
  </constant>
  <member name="module" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact=""/>
    </docblock>
  </member>
  <member name="controller" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact=""/>
    </docblock>
  </member>
  <member name="action" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact=""/>
    </docblock>
  </member>
  <member name="method" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact=""/>
    </docblock>
  </member>
  <member name="params" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact=""/>
    </docblock>
  </member>
  <member name="language" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact=""/>
    </docblock>
  </member>
  <member name="_exception" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact=""/>
    </docblock>
  </member>
  <member name="_base_uri" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact=""/>
    </docblock>
  </member>
  <member name="uri" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact=""/>
    </docblock>
  </member>
  <member name="dispatched" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact=""/>
    </docblock>
  </member>
  <member name="routed" static="false" visibility="protected">
    <default>null</default>
    <docblock>
      <description compact=""/>
    </docblock>
  </member>
  <method name="getActionName" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="The getActionName purpose"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="getBaseUri" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="The getBaseUri purpose"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="getControllerName" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="The getControllerName purpose"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="getEnv" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Retrieve ENV varialbe"/>
      <return type="void"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
    <parameter name="default" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getException" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="The getException purpose"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="getLanguage" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Retrieve client's prefered language"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="getMethod" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Retrieve the request method"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getModuleName" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="The getModuleName purpose"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="getParam" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Retrieve calling parameter"/>
      <return type="mixed"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
    <parameter name="default" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getParams" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Retrieve all calling parameters"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getRequestUri" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="The getRequestUri purpose"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="getServer" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Retrieve SERVER variable"/>
      <return type="void"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
    <parameter name="default" optional="true" byreference="false" type="string"/>
  </method>
  <method name="isCli" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Determine if request is CLI request"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isDispatched" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Determin if the request is dispatched"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isGet" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Determine if request is GET request"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isHead" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Determine if request is HEAD request"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isOptions" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Determine if request is OPTIONS request"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isPost" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Determine if request is POST request"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isPut" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Determine if request is PUT request"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isRouted" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Determin if request has been routed"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isXmlHttpRequest" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Determine if request is AJAX request"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="setActionName" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="The setActionName purpose"/>
      <return type="void"/>
    </docblock>
    <parameter name="action" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setBaseUri" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set base URI">Set base URI, base URI is used when doing routing, in routing phase request URI is used to route a request, while base URI is used to skip the leadding part(base URI) of request URI. That is, if comes a request with request URI a/b/c, then if you set base URI to "a/b", only "/c" will be used in routing phase. generally, you don't need to set this, Yaf will determine it automatically.</description>
      <return type="bool"/>
    </docblock>
    <parameter name="uir" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setControllerName" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="The setControllerName purpose"/>
      <return type="void"/>
    </docblock>
    <parameter name="controller" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setDispatched" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="The setDispatched purpose"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="setModuleName" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="The setModuleName purpose"/>
      <return type="void"/>
    </docblock>
    <parameter name="module" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setParam" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set a calling parameter to a request"/>
      <return type="bool"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
    <parameter name="value" optional="true" byreference="false" type="string"/>
  </method>
  <method name="setRequestUri" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="The setRequestUri purpose"/>
      <return type="void"/>
    </docblock>
    <parameter name="uir" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setRouted" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="The setRouted purpose"/>
      <return type="void"/>
    </docblock>
    <parameter name="flag" optional="true" byreference="false" type="string"/>
  </method>
</class>