File: EventHttpRequest.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 (213 lines) | stat: -rw-r--r-- 8,472 bytes parent folder | download | duplicates (3)
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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="EventHttpRequest" namespace="" name="EventHttpRequest">
  <constant name="CMD_GET" value="1">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="CMD_POST" value="2">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="CMD_HEAD" value="4">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="CMD_PUT" value="8">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="CMD_DELETE" value="16">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="CMD_OPTIONS" value="32">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="CMD_TRACE" value="64">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="CMD_CONNECT" value="128">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="CMD_PATCH" value="256">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="INPUT_HEADER" value="1">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="OUTPUT_HEADER" value="2">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <method name="addHeader" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Adds an HTTP header to the headers of the request"/>
      <return type="bool"/>
    </docblock>
    <parameter name="key" optional="false" byreference="false" type="string"/>
    <parameter name="value" optional="false" byreference="false" type="string"/>
    <parameter name="type" optional="false" byreference="false" type="int"/>
  </method>
  <method name="cancel" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Cancels a pending HTTP request">Cancels a pending HTTP request.</description>
      <return type="void"/>
    </docblock>
  </method>
  <method name="clearHeaders" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Removes all output headers from the header list of the request"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="closeConnection" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Closes associated HTTP connection"/>
      <return type="void"/>
    </docblock>
  </method>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Constructs EventHttpRequest object"/>
      <return type="void"/>
    </docblock>
    <parameter name="callback" optional="false" byreference="false" type="object" class="callable"/>
    <parameter name="data" optional="true" byreference="false" type="object" class="mixed"/>
  </constructor>
  <method name="findHeader" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Finds the value belonging a header"/>
      <return type="void"/>
    </docblock>
    <parameter name="key" optional="false" byreference="false" type="string"/>
    <parameter name="type" optional="false" byreference="false" type="string"/>
  </method>
  <method name="free" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Frees the object and removes associated events"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="closeConnection" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Closes associated HTTP connection"/>
      <return type="EventBufferEvent"/>
    </docblock>
  </method>
  <method name="getCommand" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the request command(method)"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="closeConnection" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Closes associated HTTP connection"/>
      <return type="EventHttpConnection"/>
    </docblock>
  </method>
  <method name="getHost" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the request host"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getInputBuffer" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the input buffer"/>
      <return type="EventBuffer"/>
    </docblock>
  </method>
  <method name="getInputHeaders" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns associative array of the input headers"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getOutputBuffer" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the output buffer of the request"/>
      <return type="EventBuffer"/>
    </docblock>
  </method>
  <method name="getOutputHeaders" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns associative array of the output headers"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="getResponseCode" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the response code"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getUri" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the request URI"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="removeHeader" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Removes an HTTP header from the headers of the request"/>
      <return type="void"/>
    </docblock>
    <parameter name="key" optional="false" byreference="false" type="string"/>
    <parameter name="type" optional="false" byreference="false" type="string"/>
  </method>
  <method name="sendError" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Send an HTML error message to the client"/>
      <return type="void"/>
    </docblock>
    <parameter name="error" optional="false" byreference="false" type="int"/>
    <parameter name="reason" optional="true" byreference="false" type="string"/>
  </method>
  <method name="sendReply" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Send an HTML reply to the client"/>
      <return type="void"/>
    </docblock>
    <parameter name="code" optional="false" byreference="false" type="int"/>
    <parameter name="reason" optional="false" byreference="false" type="string"/>
    <parameter name="buf" optional="true" byreference="false" type="object" class="EventBuffer"/>
  </method>
  <method name="sendReplyChunk" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Send another data chunk as part of an ongoing chunked reply"/>
      <return type="void"/>
    </docblock>
    <parameter name="buf" optional="false" byreference="false" type="object" class="EventBuffer"/>
  </method>
  <method name="sendReplyEnd" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Complete a chunked reply, freeing the request as appropriate"/>
      <return type="void"/>
    </docblock>
  </method>
  <method name="sendReplyStart" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Initiate a chunked reply">Initiate a reply that uses Transfer-Encoding chunked .</description>
      <return type="void"/>
    </docblock>
    <parameter name="code" optional="false" byreference="false" type="int"/>
    <parameter name="reason" optional="false" byreference="false" type="string"/>
  </method>
</class>