File: Yaf_Request_Http.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 (262 lines) | stat: -rw-r--r-- 10,348 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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="Yaf_Request_Http" namespace="" name="Yaf_Request_Http">
  <extends name="Yaf_Request_Abstract" full="Yaf_Request_Abstract"/>
  <method name="__clone" abstract="false" static="false" final="false">
    <docblock>
      <description compact="Yaf_Request_Http can not be cloned"/>
      <return type="void"/>
    </docblock>
  </method>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Constructor of Yaf_Request_Http"/>
      <return type="void"/>
    </docblock>
    <parameter name="request_uri" optional="true" byreference="false" type="string"/>
    <parameter name="base_uri" optional="true" byreference="false" type="string"/>
  </constructor>
  <method name="get" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Retrieve variable from client"/>
      <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="getCookie" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Retrieve Cookie variable"/>
      <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="getFiles" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="The getFiles purpose"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="getPost" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Retrieve POST variable"/>
      <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="getQuery" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Fetch a query 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="getRaw" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Retrieve Raw request body"/>
      <return type="mixed"/>
    </docblock>
  </method>
  <method name="getRequest" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="The getRequest purpose"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="isXmlHttpRequest" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Determin if request is Ajax Request">Check the request whether it is a Ajax Request. This method depends on the request header: HTTP_X_REQUESTED_WITH, some Javascript library doesn't set this header while doing Ajax request</description>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="getActionName" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="getBaseUri" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="getControllerName" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="getEnv" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <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=""/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="getLanguage" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="getMethod" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getModuleName" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="getParam" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <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=""/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getRequestUri" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="getServer" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <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=""/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isDispatched" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isGet" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isHead" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isOptions" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isPost" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isPut" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isRouted" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isXmlHttpRequest" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="setActionName" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <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=""/>
      <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=""/>
      <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=""/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="setModuleName" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <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=""/>
      <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=""/>
      <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=""/>
      <return type="void"/>
    </docblock>
    <parameter name="flag" optional="true" byreference="false" type="string"/>
  </method>
</class>