3 <title>Function Summary of ext/http
</title>
7 font-family: sans-serif;
34 border:
1px solid #ccc;
71 <body><h1 id=
"http_functions.c">http_functions.c
</h1>
72 <h2 id=
"http_date">string http_date([int timestamp])
</h2>
73 <p>Compose a valid HTTP date regarding RFC
822/
1123<br />
74 looking like:
"Wed, 22 Dec 2004 11:34:47 GMT"</p>
75 <p>Accepts an optional unix timestamp as parameter.
</p>
76 <p>Returns the HTTP date as string.
</p>
77 <h2 id=
"http_build_url">string http_build_url(mixed url[, mixed parts[, int flags = HTTP_URL_REPLACE[, array &new_url]]])
</h2>
78 <p>Returns the new URL as string on success or FALSE on failure.
</p>
79 <h2 id=
"http_build_str">string http_build_str(array query [, string prefix[, string arg_separator]])
</h2>
80 <p>Opponent to parse_str().
</p>
81 <h2 id=
"http_negotiate_language">string http_negotiate_language(array supported[, array &result])
</h2>
82 <p>This function negotiates the clients preferred language based on its
<br />
83 Accept-Language HTTP header. The qualifier is recognized and languages
<br />
84 without qualifier are rated highest. The qualifier will be decreased by
<br />
85 10% for partial matches (i.e. matching primary language).
</p>
86 <p>Expects an array as parameter containing the supported languages as values.
<br />
87 If the optional second parameter is supplied, it will be filled with an
<br />
88 array containing the negotiation results.
</p>
89 <p>Returns the negotiated language or the default language (i.e. first array entry)
<br />
91 <p>Example:
</p><pre><blockquote><code><span style=
"color: #000000"><br />
92 <span style=
"color: #0000BB"><?php
<br />$langs
</span><span style=
"color: #007700">=
array(
<br /> </span><span style=
"color: #DD0000">'en-US'
</span><span style=
"color: #007700">,
</span><span style=
"color: #FF8000">//
default
<br /> </span><span style=
"color: #DD0000">'fr'
</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'fr-FR'
</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'de'
</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'de-DE'
</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'de-AT'
</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'de-CH'
</span><span style=
"color: #007700">,
<br />);
<br /><br />include
</span><span style=
"color: #DD0000">'./langs/'
</span><span style=
"color: #007700">.
</span><span style=
"color: #0000BB">http_negotiate_language
</span><span style=
"color: #007700">(
</span><span style=
"color: #0000BB">$langs
</span><span style=
"color: #007700">,
</span><span style=
"color: #0000BB">$result
</span><span style=
"color: #007700">)
.
</span><span style=
"color: #DD0000">'.php'
</span><span style=
"color: #007700">;
<br /><br /></span><span style=
"color: #0000BB">print_r
</span><span style=
"color: #007700">(
</span><span style=
"color: #0000BB">$result
</span><span style=
"color: #007700">);
<br /></span><span style=
"color: #0000BB">?
></span><br />
93 </span></code></blockquote></p>
95 <h2 id=
"http_negotiate_charset">string http_negotiate_charset(array supported[, array &result])
</h2>
96 <p>This function negotiates the clients preferred charset based on its
<br />
97 Accept-Charset HTTP header. The qualifier is recognized and charsets
<br />
98 without qualifier are rated highest.
</p>
99 <p>Expects an array as parameter containing the supported charsets as values.
<br />
100 If the optional second parameter is supplied, it will be filled with an
<br />
101 array containing the negotiation results.
</p>
102 <p>Returns the negotiated charset or the default charset (i.e. first array entry)
<br />
104 <p>Example:
</p><pre><blockquote><code><span style=
"color: #000000"><br />
105 <span style=
"color: #0000BB"><?php
<br />$charsets
</span><span style=
"color: #007700">=
array(
<br /> </span><span style=
"color: #DD0000">'iso-
8859-
1'
</span><span style=
"color: #007700">,
</span><span style=
"color: #FF8000">//
default
<br /> </span><span style=
"color: #DD0000">'iso-
8859-
2'
</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'iso-
8859-
15'
</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'utf-
8'
<br /></span><span style=
"color: #007700">);
<br /><br /></span><span style=
"color: #0000BB">$pref
</span><span style=
"color: #007700">=
</span><span style=
"color: #0000BB">http_negotiate_charset
</span><span style=
"color: #007700">(
</span><span style=
"color: #0000BB">$charsets
</span><span style=
"color: #007700">,
</span><span style=
"color: #0000BB">$result
</span><span style=
"color: #007700">);
<br /><br />if
(
</span><span style=
"color: #0000BB">strcmp
</span><span style=
"color: #007700">(
</span><span style=
"color: #0000BB">$pref
</span><span style=
"color: #007700">,
</span><span style=
"color: #DD0000">'iso-
8859-
1'
</span><span style=
"color: #007700">))
{
<br /> </span><span style=
"color: #0000BB">iconv_set_encoding
</span><span style=
"color: #007700">(
</span><span style=
"color: #DD0000">'internal_encoding'
</span><span style=
"color: #007700">,
</span><span style=
"color: #DD0000">'iso-
8859-
1'
</span><span style=
"color: #007700">);
<br /> </span><span style=
"color: #0000BB">iconv_set_encoding
</span><span style=
"color: #007700">(
</span><span style=
"color: #DD0000">'output_encoding'
</span><span style=
"color: #007700">,
</span><span style=
"color: #0000BB">$pref
</span><span style=
"color: #007700">);
<br /> </span><span style=
"color: #0000BB">ob_start
</span><span style=
"color: #007700">(
</span><span style=
"color: #DD0000">'ob_iconv_handler'
</span><span style=
"color: #007700">);
<br />}
<br /><br /></span><span style=
"color: #0000BB">print_r
</span><span style=
"color: #007700">(
</span><span style=
"color: #0000BB">$result
</span><span style=
"color: #007700">);
<br /></span><span style=
"color: #0000BB">?
></span><br />
106 </span></code></blockquote></p>
108 <h2 id=
"http_negotiate_content_type">string http_negotiate_ctype(array supported[, array &result])
</h2>
109 <p>This function negotiates the clients preferred content type based on its
<br />
110 Accept HTTP header. The qualifier is recognized and content types
<br />
111 without qualifier are rated highest.
</p>
112 <p>Expects an array as parameter containing the supported content types as values.
<br />
113 If the optional second parameter is supplied, it will be filled with an
<br />
114 array containing the negotiation results.
</p>
115 <p>Returns the negotiated content type or the default content type
<br />
116 (i.e. first array entry) if none match.
</p>
117 <p>Example:
</p><pre><blockquote><code><span style=
"color: #000000"><br />
118 <span style=
"color: #0000BB"><?php
<br />$ctypes
</span><span style=
"color: #007700">=
array(
</span><span style=
"color: #DD0000">'application/xhtml+xml'
</span><span style=
"color: #007700">,
</span><span style=
"color: #DD0000">'text/html'
</span><span style=
"color: #007700">);
<br /></span><span style=
"color: #0000BB">http_send_content_type
</span><span style=
"color: #007700">(
</span><span style=
"color: #0000BB">http_negotiate_content_type
</span><span style=
"color: #007700">(
</span><span style=
"color: #0000BB">$ctypes
</span><span style=
"color: #007700">));
<br /></span><span style=
"color: #0000BB">?
></span><br />
119 </span></code></blockquote></p>
121 <h2 id=
"http_send_status">bool http_send_status(int status)
</h2>
122 <p>Send HTTP status code.
</p>
123 <p>Expects an HTTP status code as parameter.
</p>
124 <p>Returns TRUE on success or FALSE on failure.
</p>
125 <h2 id=
"http_send_last_modified">bool http_send_last_modified([int timestamp])
</h2>
126 <p>Send a
"Last-Modified" header with a valid HTTP date.
</p>
127 <p>Accepts a unix timestamp, converts it to a valid HTTP date and
<br />
128 sends it as
"Last-Modified" HTTP header. If timestamp is
<br />
129 omitted, the current time will be sent.
</p>
130 <p>Returns TRUE on success or FALSE on failure.
</p>
131 <h2 id=
"http_send_content_type">bool http_send_content_type([string content_type = 'application/x-octetstream'])
</h2>
132 <p>Send the Content-Type of the sent entity. This is particularly important
<br />
133 if you use the http_send() API.
</p>
134 <p>Accepts an optional string parameter containing the desired content type
<br />
135 (primary/secondary).
</p>
136 <p>Returns TRUE on success or FALSE on failure.
</p>
137 <h2 id=
"http_send_content_disposition">bool http_send_content_disposition(string filename[, bool inline = false])
</h2>
138 <p>Send the Content-Disposition. The Content-Disposition header is very useful
<br />
139 if the data actually sent came from a file or something similar, that should
<br />
140 be
"saved" by the client/user (i.e. by browsers
"Save as..." popup window).
</p>
141 <p>Expects a string parameter specifying the file name the
"Save as..." dialog
<br />
142 should display. Optionally accepts a bool parameter, which, if set to true
<br />
143 and the user agent knows how to handle the content type, will probably not
<br />
144 cause the popup window to be shown.
</p>
145 <p>Returns TRUE on success or FALSE on failure.
</p>
146 <h2 id=
"http_match_modified">bool http_match_modified([int timestamp[, bool for_range = false]])
</h2>
147 <p>Matches the given unix timestamp against the clients
"If-Modified-Since" <br />
148 resp.
"If-Unmodified-Since" HTTP headers.
</p>
149 <p>Accepts a unix timestamp which should be matched. Optionally accepts an
<br />
150 additional bool parameter, which if set to true will check the header
<br />
151 usually used to validate HTTP ranges. If timestamp is omitted, the
<br />
152 current time will be used.
</p>
153 <p>Returns TRUE if timestamp represents an earlier date than the header,
<br />
155 <h2 id=
"http_match_etag">bool http_match_etag(string etag[, bool for_range = false])
</h2>
156 <p>Matches the given ETag against the clients
"If-Match" resp.
<br />
157 "If-None-Match" HTTP headers.
</p>
158 <p>Expects a string parameter containing the ETag to compare. Optionally
<br />
159 accepts a bool parameter, which, if set to true, will check the header
<br />
160 usually used to validate HTTP ranges.
</p>
161 <p>Returns TRUE if ETag matches or the header contained the asterisk (
"*"),
<br />
163 <h2 id=
"http_cache_last_modified">bool http_cache_last_modified([int timestamp_or_expires]])
</h2>
164 <p>Attempts to cache the sent entity by its last modification date.
</p>
165 <p>Accepts a unix timestamp as parameter which is handled as follows:
</p>
166 <p>If timestamp_or_expires is greater than
0, it is handled as timestamp
<br />
167 and will be sent as date of last modification. If it is
0 or omitted,
<br />
168 the current time will be sent as Last-Modified date. If it's negative,
<br />
169 it is handled as expiration time in seconds, which means that if the
<br />
170 requested last modification date is not between the calculated timespan,
<br />
171 the Last-Modified header is updated and the actual body will be sent.
</p>
172 <p>Returns FALSE on failure, or *exits* with
"304 Not Modified" if the entity is cached.
</p>
173 <p>A log entry will be written to the cache log if the INI entry
<br />
174 http.cache_log is set and the cache attempt was successful.
</p>
175 <h2 id=
"http_cache_etag">bool http_cache_etag([string etag])
</h2>
176 <p>Attempts to cache the sent entity by its ETag, either supplied or generated
<br />
177 by the hash algorithm specified by the INI setting
"http.etag_mode".
</p>
178 <p>If the clients
"If-None-Match" header matches the supplied/calculated
<br />
179 ETag, the body is considered cached on the clients side and
<br />
180 a
"304 Not Modified" status code is issued.
</p>
181 <p>Returns FALSE on failure, or *exits* with
"304 Not Modified" if the entity is cached.
</p>
182 <p>A log entry is written to the cache log if the INI entry
<br />
183 "http.cache_log" is set and the cache attempt was successful.
</p>
184 <h2 id=
"ob_etaghandler">string ob_etaghandler(string data, int mode)
</h2>
185 <p>For use with ob_start(). Output buffer handler generating an ETag with
<br />
186 the hash algorithm specified with the INI setting
"http.etag_mode".
</p>
187 <h2 id=
"http_throttle">void http_throttle(double sec[, int bytes =
40960])
</h2>
188 <p>Sets the throttle delay and send buffer size for use with http_send() API.
<br />
189 Provides a basic throttling mechanism, which will yield the current process
<br />
190 resp. thread until the entity has been completely sent, though.
</p>
191 <p>Expects a double parameter specifying the seconds too sleep() after
<br />
192 each chunk sent. Additionally accepts an optional int parameter
<br />
193 representing the chunk size in bytes.
</p>
194 <p>Example:
</p><pre><blockquote><code><span style=
"color: #000000"><br />
195 <span style=
"color: #0000BB"><?php
<br /></span><span style=
"color: #FF8000">//
~
20 kbyte/s
<br />#
http_throttle(
1,
20000);
<br />#
http_throttle(
0.5,
10000);
<br />#
http_throttle(
0.1,
2000);
<br /></span><span style=
"color: #0000BB">http_send_file
</span><span style=
"color: #007700">(
</span><span style=
"color: #DD0000">'document.pdf'
</span><span style=
"color: #007700">);
<br /></span><span style=
"color: #0000BB">?
></span><br />
196 </span></code></blockquote></p>
198 <h2 id=
"http_redirect">void http_redirect([string url[, array params[, bool session = false[, int status =
302]]]])
</h2>
199 <p>Redirect to the given url.
<br />
201 The supplied url will be expanded with http_build_url(), the params array will
<br />
202 be treated with http_build_query() and the session identification will be appended
<br />
203 if session is true.
</p>
204 <p>The HTTP response code will be set according to status.
<br />
205 You can use one of the following constants for convenience:
<br />
206 - HTTP_REDIRECT
302 Found for GET/HEAD, else
303 See Other
<br />
207 - HTTP_REDIRECT_PERM
301 Moved Permanently
<br />
208 - HTTP_REDIRECT_FOUND
302 Found
<br />
209 - HTTP_REDIRECT_POST
303 See Other
<br />
210 - HTTP_REDIRECT_PROXY
305 Use Proxy
<br />
211 - HTTP_REDIRECT_TEMP
307 Temporary Redirect
</p>
212 <p>Please see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3
<br />
213 for which redirect response code to use in which situation.
</p>
214 <p>To be RFC compliant,
"Redirecting to <a>URL</a>." will be displayed,
<br />
215 if the client doesn't redirect immediately, and the request method was
<br />
216 another one than HEAD.
</p>
217 <p>Returns FALSE on failure, or *exits* on success.
</p>
218 <p>A log entry will be written to the redirect log, if the INI entry
<br />
219 "http.redirect_log" is set and the redirect attempt was successful.
</p>
220 <h2 id=
"http_send_data">bool http_send_data(string data)
</h2>
221 <p>Sends raw data with support for (multiple) range requests.
</p>
222 <p>Returns TRUE on success, or FALSE on failure.
</p>
223 <h2 id=
"http_send_file">bool http_send_file(string file)
</h2>
224 <p>Sends a file with support for (multiple) range requests.
</p>
225 <p>Expects a string parameter referencing the file to send.
</p>
226 <p>Returns TRUE on success, or FALSE on failure.
</p>
227 <h2 id=
"http_send_stream">bool http_send_stream(resource stream)
</h2>
228 <p>Sends an already opened stream with support for (multiple) range requests.
</p>
229 <p>Expects a resource parameter referencing the stream to read from.
</p>
230 <p>Returns TRUE on success, or FALSE on failure.
</p>
231 <h2 id=
"http_chunked_decode">string http_chunked_decode(string encoded)
</h2>
232 <p>Decodes a string that was HTTP-chunked encoded.
</p>
233 <p>Expects a chunked encoded string as parameter.
</p>
234 <p>Returns the decoded string on success or FALSE on failure.
</p>
235 <h2 id=
"http_parse_message">object http_parse_message(string message)
</h2>
236 <p>Parses (a) http_message(s) into a simple recursive object structure.
</p>
237 <p>Expects a string parameter containing a single HTTP message or
<br />
238 several consecutive HTTP messages.
</p>
239 <p>Returns an hierarchical object structure of the parsed messages.
</p>
240 <p>Example:
</p><pre><blockquote><code><span style=
"color: #000000"><br />
241 <span style=
"color: #0000BB"><?php
<br />print_r
</span><span style=
"color: #007700">(
</span><span style=
"color: #0000BB">http_parse_message
</span><span style=
"color: #007700">(
</span><span style=
"color: #0000BB">http_get
</span><span style=
"color: #007700">(
</span><span style=
"color: #0000BB">URL
</span><span style=
"color: #007700">,
array(
</span><span style=
"color: #DD0000">'redirect'
</span><span style=
"color: #007700">=
> </span><span style=
"color: #0000BB">3</span><span style=
"color: #007700">)));
<br /><br /></span><span style=
"color: #0000BB">stdClass
object
<br /></span><span style=
"color: #007700">(
<br /> [
</span><span style=
"color: #0000BB">type
</span><span style=
"color: #007700">]
=
> </span><span style=
"color: #0000BB">2<br /> </span><span style=
"color: #007700">[
</span><span style=
"color: #0000BB">httpVersion
</span><span style=
"color: #007700">]
=
> </span><span style=
"color: #0000BB">1.1<br /> </span><span style=
"color: #007700">[
</span><span style=
"color: #0000BB">responseCode
</span><span style=
"color: #007700">]
=
> </span><span style=
"color: #0000BB">200<br /> </span><span style=
"color: #007700">[
</span><span style=
"color: #0000BB">headers
</span><span style=
"color: #007700">]
=
> Array
<br /> (
<br /> [
</span><span style=
"color: #0000BB">Content
</span><span style=
"color: #007700">-
</span><span style=
"color: #0000BB">Length
</span><span style=
"color: #007700">]
=
> </span><span style=
"color: #0000BB">3<br /> </span><span style=
"color: #007700">[
</span><span style=
"color: #0000BB">Server
</span><span style=
"color: #007700">]
=
> </span><span style=
"color: #0000BB">Apache
<br /> </span><span style=
"color: #007700">)
<br /> [
</span><span style=
"color: #0000BB">body
</span><span style=
"color: #007700">]
=
> </span><span style=
"color: #0000BB">Hi
</span><span style=
"color: #007700">!
<br /> [
</span><span style=
"color: #0000BB">parentMessage
</span><span style=
"color: #007700">]
=
> </span><span style=
"color: #0000BB">stdClass
object
<br /> </span><span style=
"color: #007700">(
<br /> [
</span><span style=
"color: #0000BB">type
</span><span style=
"color: #007700">]
=
> </span><span style=
"color: #0000BB">2<br /> </span><span style=
"color: #007700">[
</span><span style=
"color: #0000BB">httpVersion
</span><span style=
"color: #007700">]
=
> </span><span style=
"color: #0000BB">1.1<br /> </span><span style=
"color: #007700">[
</span><span style=
"color: #0000BB">responseCode
</span><span style=
"color: #007700">]
=
> </span><span style=
"color: #0000BB">302<br /> </span><span style=
"color: #007700">[
</span><span style=
"color: #0000BB">headers
</span><span style=
"color: #007700">]
=
> Array
<br /> (
<br /> [
</span><span style=
"color: #0000BB">Content
</span><span style=
"color: #007700">-
</span><span style=
"color: #0000BB">Length
</span><span style=
"color: #007700">]
=
> </span><span style=
"color: #0000BB">0<br /> </span><span style=
"color: #007700">[
</span><span style=
"color: #0000BB">Location
</span><span style=
"color: #007700">]
=
> ...
<br /> )
<br /> [
</span><span style=
"color: #0000BB">body
</span><span style=
"color: #007700">]
=
> <br /> [
</span><span style=
"color: #0000BB">parentMessage
</span><span style=
"color: #007700">]
=
> ...
<br /> )
<br />)
<br /></span><span style=
"color: #0000BB">?
></span><br />
242 </span></code></blockquote></p>
244 <h2 id=
"http_parse_headers">array http_parse_headers(string header)
</h2>
245 <p>Parses HTTP headers into an associative array.
</p>
246 <p>Expects a string parameter containing HTTP headers.
</p>
247 <p>Returns an array on success, or FALSE on failure.
</p>
248 <p>Example:
</p><pre><blockquote><code><span style=
"color: #000000"><br />
249 <span style=
"color: #0000BB"><?php
<br />$headers
</span><span style=
"color: #007700">=
</span><span style=
"color: #DD0000">"content-type: text/html; charset=UTF-8\r\n"</span><span style=
"color: #007700">.
<br /> </span><span style=
"color: #DD0000">"Server: Funky/1.0\r\n"</span><span style=
"color: #007700">.
<br /> </span><span style=
"color: #DD0000">"Set-Cookie: foo=bar\r\n"</span><span style=
"color: #007700">.
<br /> </span><span style=
"color: #DD0000">"Set-Cookie: baz=quux\r\n"</span><span style=
"color: #007700">.
<br /> </span><span style=
"color: #DD0000">"Folded: works\r\n\ttoo\r\n"</span><span style=
"color: #007700">;
<br /></span><span style=
"color: #0000BB">print_r
</span><span style=
"color: #007700">(
</span><span style=
"color: #0000BB">http_parse_headers
</span><span style=
"color: #007700">(
</span><span style=
"color: #0000BB">$headers
</span><span style=
"color: #007700">));
<br /><br />Array
<br />(
<br /> [
</span><span style=
"color: #0000BB">Content
</span><span style=
"color: #007700">-
</span><span style=
"color: #0000BB">Type
</span><span style=
"color: #007700">]
=
> </span><span style=
"color: #0000BB">text
</span><span style=
"color: #007700">/
</span><span style=
"color: #0000BB">html
</span><span style=
"color: #007700">;
</span><span style=
"color: #0000BB">chatset
</span><span style=
"color: #007700">=
</span><span style=
"color: #0000BB">UTF
</span><span style=
"color: #007700">-
</span><span style=
"color: #0000BB">8<br /> </span><span style=
"color: #007700">[
</span><span style=
"color: #0000BB">Server
</span><span style=
"color: #007700">]
=
> </span><span style=
"color: #0000BB">Funky
</span><span style=
"color: #007700">/
</span><span style=
"color: #0000BB">1.0<br /> </span><span style=
"color: #007700">[
</span><span style=
"color: #0000BB">Set
</span><span style=
"color: #007700">-
</span><span style=
"color: #0000BB">Cookie
</span><span style=
"color: #007700">]
=
> Array
<br /> (
<br /> [
</span><span style=
"color: #0000BB">0</span><span style=
"color: #007700">]
=
> </span><span style=
"color: #0000BB">foo
</span><span style=
"color: #007700">=
</span><span style=
"color: #0000BB">bar
<br /> </span><span style=
"color: #007700">[
</span><span style=
"color: #0000BB">1</span><span style=
"color: #007700">]
=
> </span><span style=
"color: #0000BB">baz
</span><span style=
"color: #007700">=
</span><span style=
"color: #0000BB">quux
<br /> </span><span style=
"color: #007700">)
<br /> [
</span><span style=
"color: #0000BB">Folded
</span><span style=
"color: #007700">]
=
> </span><span style=
"color: #0000BB">works
<br /> too
<br /></span><span style=
"color: #007700">)
<br /></span><span style=
"color: #0000BB">?
></span><br />
250 </span></code></blockquote></p>
252 <h2 id=
"http_parse_cookie">object http_parse_cookie(string cookie)
</h2>
253 <p>Parses HTTP cookies like sent in a response into a struct.
</p>
254 <p>Expects a string as parameter containing the value of a Set-Cookie response header.
</p>
255 <p>Returns an stdClass object with the cookie params as properties on success or FALSE on failure.
</p>
256 <p>Example:
</p><pre><blockquote><code><span style=
"color: #000000"><br />
257 <span style=
"color: #0000BB"><?php
<br />print_r
</span><span style=
"color: #007700">(
</span><span style=
"color: #0000BB">http_parse_cookie
</span><span style=
"color: #007700">(
</span><span style=
"color: #DD0000">"foo=bar; path=/"</span><span style=
"color: #007700">));
<br /><br /></span><span style=
"color: #0000BB">stdClass
Object
<br /></span><span style=
"color: #007700">(
<br /> [
</span><span style=
"color: #0000BB">name
</span><span style=
"color: #007700">]
=
> </span><span style=
"color: #0000BB">foo
<br /> </span><span style=
"color: #007700">[
</span><span style=
"color: #0000BB">value
</span><span style=
"color: #007700">]
=
> </span><span style=
"color: #0000BB">bar
<br /> </span><span style=
"color: #007700">[
</span><span style=
"color: #0000BB">path
</span><span style=
"color: #007700">]
=
> /
<br />)
<br /></span><span style=
"color: #0000BB">?
></span><br />
258 </span></code></blockquote></p>
260 <h2 id=
"http_get_request_headers">array http_get_request_headers(void)
</h2>
261 <p>Get a list of incoming HTTP headers.
</p>
262 <p>Returns an associative array of incoming request headers.
</p>
263 <h2 id=
"http_get_request_body">string http_get_request_body(void)
</h2>
264 <p>Get the raw request body (e.g. POST or PUT data).
</p>
265 <p>This function can not be used after http_get_request_body_stream()
<br />
266 if the request method was another than POST.
</p>
267 <p>Returns the raw request body as string on success or NULL on failure.
</p>
268 <h2 id=
"http_get_request_body_stream">resource http_get_request_body_stream(void)
</h2>
269 <p>Create a stream to read the raw request body (e.g. POST or PUT data).
</p>
270 <p>This function can only be used once if the request method was another than POST.
</p>
271 <p>Returns the raw request body as stream on success or NULL on failure.
</p>
272 <h2 id=
"http_match_request_header">bool http_match_request_header(string header, string value[, bool match_case = false])
</h2>
273 <p>Match an incoming HTTP header.
</p>
274 <p>Expects two string parameters representing the header name (case-insensitive)
<br />
275 and the header value that should be compared. The case sensitivity of the
<br />
276 header value depends on the additional optional bool parameter accepted.
</p>
277 <p>Returns TRUE if header value matches, else FALSE.
</p>
278 <h2 id=
"http_get">string http_get(string url[, array options[, array &info]])
</h2>
279 <p>Performs an HTTP GET request on the supplied url.
</p>
280 <p>The second parameter, if set, is expected to be an associative
<br />
281 array where the following keys will be recognized:
</p><pre> - redirect: int, whether and how many redirects to follow
<br />
282 - unrestrictedauth: bool, whether to continue sending credentials on
<br />
283 redirects to a different host
<br />
284 - proxyhost: string, proxy host in
"host[:port]" format
<br />
285 - proxyport: int, use another proxy port as specified in proxyhost
<br />
286 - proxyauth: string, proxy credentials in
"user:pass" format
<br />
287 - proxyauthtype: int, HTTP_AUTH_BASIC and/or HTTP_AUTH_NTLM
<br />
288 - httpauth: string, http credentials in
"user:pass" format
<br />
289 - httpauthtype: int, HTTP_AUTH_BASIC, DIGEST and/or NTLM
<br />
290 - compress: bool, whether to allow gzip/deflate content encoding
<br />
291 - port: int, use another port as specified in the url
<br />
292 - referer: string, the referer to send
<br />
293 - useragent: string, the user agent to send
<br />
294 (defaults to PECL::HTTP/version (PHP/version)))
<br />
295 - headers: array, list of custom headers as associative array
<br />
296 like array(
"header" =
> "value")
<br />
297 - cookies: array, list of cookies as associative array
<br />
298 like array(
"cookie" =
> "value")
<br />
299 - cookiestore: string, path to a file where cookies are/will be stored
<br />
300 - resume: int, byte offset to start the download from;
<br />
301 if the server supports ranges
<br />
302 - maxfilesize: int, maximum file size that should be downloaded;
<br />
303 has no effect, if the size of the requested entity is not known
<br />
304 - lastmodified: int, timestamp for If-(Un)Modified-Since header
<br />
305 - etag: string, quoted etag for If-(None-)Match header
<br />
306 - timeout: int, seconds the request may take
<br />
307 - connecttimeout: int, seconds the connect may take
<br />
308 - onprogress: mixed, progress callback
<br />
309 - ssl: array, with the following options:
<br />
310 cert: string, path to certificate
<br />
311 certtype: string, type of certificate
<br />
312 certpasswd: string, password for certificate
<br />
313 key: string, path to key
<br />
314 keytype: string, type of key
<br />
315 keypasswd: string, pasword for key
<br />
316 engine: string, ssl engine to use
<br />
317 version: int, ssl version to use
<br />
318 verifypeer: bool, whether to verify the peer
<br />
319 verifyhost: bool whether to verify the host
<br />
320 cipher_list: string, list of allowed ciphers
<br />
323 random_file: string
<br />
324 egdsocket: string
<br />
326 <p>The optional third parameter will be filled with some additional information
<br />
327 in form of an associative array, if supplied, like the following example:
</p><pre><blockquote><code><span style=
"color: #000000"><br />
328 <span style=
"color: #0000BB"><?php
<br /></span><span style=
"color: #007700">array
(
<br /> </span><span style=
"color: #DD0000">'effective_url'
</span><span style=
"color: #007700">=
> </span><span style=
"color: #DD0000">'http://localhost'
</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'response_code'
</span><span style=
"color: #007700">=
> </span><span style=
"color: #0000BB">403</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'total_time'
</span><span style=
"color: #007700">=
> </span><span style=
"color: #0000BB">0.017</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'namelookup_time'
</span><span style=
"color: #007700">=
> </span><span style=
"color: #0000BB">0.013</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'connect_time'
</span><span style=
"color: #007700">=
> </span><span style=
"color: #0000BB">0.014</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'pretransfer_time'
</span><span style=
"color: #007700">=
> </span><span style=
"color: #0000BB">0.014</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'size_upload'
</span><span style=
"color: #007700">=
> </span><span style=
"color: #0000BB">0</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'size_download'
</span><span style=
"color: #007700">=
> </span><span style=
"color: #0000BB">202</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'speed_download'
</span><span style=
"color: #007700">=
> </span><span style=
"color: #0000BB">11882</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'speed_upload'
</span><span style=
"color: #007700">=
> </span><span style=
"color: #0000BB">0</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'header_size'
</span><span style=
"color: #007700">=
> </span><span style=
"color: #0000BB">145</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'request_size'
</span><span style=
"color: #007700">=
> </span><span style=
"color: #0000BB">62</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'ssl_verifyresult'
</span><span style=
"color: #007700">=
> </span><span style=
"color: #0000BB">0</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'filetime'
</span><span style=
"color: #007700">=
> -
</span><span style=
"color: #0000BB">1</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'content_length_download'
</span><span style=
"color: #007700">=
> </span><span style=
"color: #0000BB">202</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'content_length_upload'
</span><span style=
"color: #007700">=
> </span><span style=
"color: #0000BB">0</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'starttransfer_time'
</span><span style=
"color: #007700">=
> </span><span style=
"color: #0000BB">0.017</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'content_type'
</span><span style=
"color: #007700">=
> </span><span style=
"color: #DD0000">'text/html;
charset=iso-
8859-
1'
</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'redirect_time'
</span><span style=
"color: #007700">=
> </span><span style=
"color: #0000BB">0</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'redirect_count'
</span><span style=
"color: #007700">=
> </span><span style=
"color: #0000BB">0</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'http_connectcode'
</span><span style=
"color: #007700">=
> </span><span style=
"color: #0000BB">0</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'httpauth_avail'
</span><span style=
"color: #007700">=
> </span><span style=
"color: #0000BB">0</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #DD0000">'proxyauth_avail'
</span><span style=
"color: #007700">=
> </span><span style=
"color: #0000BB">0</span><span style=
"color: #007700">,
<br />)
<br /></span><span style=
"color: #0000BB">?
></span><br />
329 </span></code></blockquote></p>
331 <p>Returns the HTTP response(s) as string on success, or FALSE on failure.
</p>
332 <h2 id=
"http_head">string http_head(string url[, array options[, array &info]])
</h2>
333 <p>Performs an HTTP HEAD request on the supplied url.
</p>
334 <p>See http_get() for a full list of available parameters and options.
</p>
335 <p>Returns the HTTP response as string on success, or FALSE on failure.
</p>
336 <h2 id=
"http_post_data">string http_post_data(string url, string data[, array options[, array &info]])
</h2>
337 <p>Performs an HTTP POST request on the supplied url.
</p>
338 <p>Expects a string as second parameter containing the pre-encoded post data.
<br />
339 See http_get() for a full list of available parameters and options.
<br />
341 Returns the HTTP response(s) as string on success, or FALSE on failure.
</p>
342 <h2 id=
"http_post_fields">string http_post_fields(string url, array data[, array files[, array options[, array &info]]])
</h2>
343 <p>Performs an HTTP POST request on the supplied url.
</p>
344 <p>Expects an associative array as second parameter, which will be
<br />
345 www-form-urlencoded. See http_get() for a full list of available options.
</p>
346 <p>Returns the HTTP response(s) as string on success, or FALSE on failure.
</p>
347 <h2 id=
"http_put_file">string http_put_file(string url, string file[, array options[, array &info]])
</h2>
348 <p>Performs an HTTP PUT request on the supplied url.
</p>
349 <p>Expects the second parameter to be a string referencing the file to upload.
<br />
350 See http_get() for a full list of available options.
</p>
351 <p>Returns the HTTP response(s) as string on success, or FALSE on failure.
</p>
352 <h2 id=
"http_put_stream">string http_put_stream(string url, resource stream[, array options[, array &info]])
</h2>
353 <p>Performs an HTTP PUT request on the supplied url.
</p>
354 <p>Expects the second parameter to be a resource referencing an already
<br />
355 opened stream, from which the data to upload should be read.
<br />
356 See http_get() for a full list of available options.
</p>
357 <p>Returns the HTTP response(s) as string on success. or FALSE on failure.
</p>
358 <h2 id=
"http_request_method_register">int http_request_method_register(string method)
</h2>
359 <p>Register a custom request method.
</p>
360 <p>Expects a string parameter containing the request method name to register.
</p>
361 <p>Returns the ID of the request method on success, or FALSE on failure.
</p>
362 <h2 id=
"http_request_method_unregister">bool http_request_method_unregister(mixed method)
</h2>
363 <p>Unregister a previously registered custom request method.
</p>
364 <p>Expects either the request method name or ID.
</p>
365 <p>Returns TRUE on success, or FALSE on failure.
</p>
366 <h2 id=
"http_request_method_exists">int http_request_method_exists(mixed method)
</h2>
367 <p>Check if a request method is registered (or available by default).
</p>
368 <p>Expects either the request method name or ID as parameter.
</p>
369 <p>Returns TRUE if the request method is known, else FALSE.
</p>
370 <h2 id=
"http_request_method_name">string http_request_method_name(int method)
</h2>
371 <p>Get the literal string representation of a standard or registered request method.
</p>
372 <p>Expects the request method ID as parameter.
</p>
373 <p>Returns the request method name as string on success, or FALSE on failure.
</p>
374 <h2 id=
"http_deflate">string http_deflate(string data[, int flags =
0])
</h2>
375 <p>Compress data with gzip, zlib AKA deflate or raw deflate encoding.
</p>
376 <p>Expects the first parameter to be a string containing the data that should
<br />
378 <p>Returns the encoded string on success, or NULL on failure.
</p>
379 <h2 id=
"http_inflate">string http_inflate(string data)
</h2>
380 <p>Decompress data compressed with either gzip, deflate AKA zlib or raw
<br />
381 deflate encoding.
</p>
382 <p>Expects a string as parameter containing the compressed data.
</p>
383 <p>Returns the decoded string on success, or NULL on failure.
</p>
384 <h2 id=
"ob_deflatehandler">string ob_deflatehandler(string data, int mode)
</h2>
385 <p>For use with ob_start(). The deflate output buffer handler can only be used once.
<br />
386 It conflicts with ob_gzhandler and zlib.output_compression as well and should
<br />
387 not be used after ext/mbstrings mb_output_handler and ext/sessions URL-Rewriter (AKA
<br />
388 session.use_trans_sid).
</p>
389 <h2 id=
"ob_inflatehandler">string ob_inflatehandler(string data, int mode)
</h2>
390 <p>For use with ob_start(). Same restrictions as with ob_deflatehandler apply.
</p>
391 <h2 id=
"http_support">int http_support([int feature =
0])
</h2>
392 <p>Check for feature that require external libraries.
</p>
393 <p>Accepts an optional in parameter specifying which feature to probe for.
<br />
394 If the parameter is
0 or omitted, the return value contains a bitmask of
<br />
395 all supported features that depend on external libraries.
</p>
396 <p>Available features to probe for are:
<br />
398 <li> HTTP_SUPPORT: always set
<br />
399 <li> HTTP_SUPPORT_REQUESTS: whether ext/http was linked against libcurl,
<br />
400 and HTTP requests can be issued
<br />
401 <li> HTTP_SUPPORT_SSLREQUESTS: whether libcurl was linked against openssl,
<br />
402 and SSL requests can be issued
<br />
403 <li> HTTP_SUPPORT_ENCODINGS: whether ext/http was linked against zlib,
<br />
404 and compressed HTTP responses can be decoded
<br />
405 <li> HTTP_SUPPORT_MAGICMIME: whether ext/http was linked against libmagic,
<br />
406 and the HttpResponse::guessContentType() method is usable
<br />
408 <p>Returns int, whether requested feature is supported, or a bitmask with
<br />
409 all supported features.
</p>
411 <h1 id=
"http_deflatestream_object.c">http_deflatestream_object.c
</h1>
412 <h2 id=
"HttpDeflateStream" class=
"o">HttpDeflateStream
</h2>
413 <h3 id=
"HttpDeflateStream___construct">void HttpDeflateStream::__construct([int flags =
0])
</h3>
414 <p>Creates a new HttpDeflateStream object instance.
</p>
415 <p>Accepts an optional int parameter specifying how to initialize the deflate stream.
</p>
416 <h3 id=
"HttpDeflateStream_update">string HttpDeflateStream::update(string data)
</h3>
417 <p>Passes more data through the deflate stream.
</p>
418 <p>Expects a string parameter containing (a part of) the data to deflate.
</p>
419 <p>Returns deflated data on success or FALSE on failure.
</p>
420 <h3 id=
"HttpDeflateStream_flush">string HttpDeflateStream::flush([string data])
</h3>
421 <p>Flushes the deflate stream.
</p>
422 <p>Returns some deflated data as string on success or FALSE on failure.
</p>
423 <h3 id=
"HttpDeflateStream_finish">string HttpDeflateStream::finish([string data])
</h3>
424 <p>Finalizes the deflate stream. The deflate stream can be reused after finalizing.
</p>
425 <p>Returns the final part of deflated data.
</p>
427 <h1 id=
"http_inflatestream_object.c">http_inflatestream_object.c
</h1>
428 <h2 id=
"HttpInflateStream" class=
"o">HttpInflateStream
</h2>
429 <h3 id=
"HttpInflateStream_update">string HttpInflateStream::update(string data)
</h3>
430 <p>Passes more data through the inflate stream.
</p>
431 <p>Expects a string parameter containing (a part of) the data to inflate.
</p>
432 <p>Returns inflated data on success or FALSE on failure.
</p>
433 <h3 id=
"HttpInflateStream_flush">string HttpInflateStream::flush([string data])
</h3>
434 <p>Flush the inflate stream.
</p>
435 <p>Returns some inflated data as string on success or FALSE on failure.
</p>
436 <h3 id=
"HttpInflateStream_finish">string HttpInflateStream::finish([string data])
</h3>
437 <p>Finalizes the inflate stream. The inflate stream can be reused after finalizing.
</p>
438 <p>Returns the final part of inflated data.
</p>
440 <h1 id=
"http_message_object.c">http_message_object.c
</h1>
441 <h2 id=
"HttpMessage" class=
"o">HttpMessage
</h2>
442 <h3 id=
"HttpMessage___construct">void HttpMessage::__construct([string message])
</h3>
443 <p>Instantiate a new HttpMessage object.
</p>
444 <p>Accepts an optional string parameter containing a single or several
<br />
445 consecutive HTTP messages. The constructed object will actually
<br />
446 represent the *last* message of the passed string. If there were
<br />
447 prior messages, those can be accessed by HttpMessage::getParentMessage().
</p>
448 <p>Throws HttpMalformedHeaderException.
</p>
449 <h3 id=
"HttpMessage_fromString">static HttpMessage HttpMessage::fromString(string raw_message[, string class_name =
"HttpMessage"])
</h3>
450 <p>Create an HttpMessage object from a string. Kind of a static constructor.
</p>
451 <p>Expects a string parameter containing a single or several consecutive
<br />
452 HTTP messages. Accepts an optional string parameter specifying the class to use.
</p>
453 <p>Returns an HttpMessage object on success or NULL on failure.
</p>
454 <p>Throws HttpMalformedHeadersException.
</p>
455 <h3 id=
"HttpMessage_getBody">string HttpMessage::getBody()
</h3>
456 <p>Get the body of the parsed HttpMessage.
</p>
457 <p>Returns the message body as string.
</p>
458 <h3 id=
"HttpMessage_setBody">void HttpMessage::setBody(string body)
</h3>
459 <p>Set the body of the HttpMessage.
<br />
460 NOTE: Don't forget to update any headers accordingly.
</p>
461 <p>Expects a string parameter containing the new body of the message.
</p>
462 <h3 id=
"HttpMessage_getHeaders">array HttpMessage::getHeaders()
</h3>
463 <p>Get Message Headers.
</p>
464 <p>Returns an associative array containing the messages HTTP headers.
</p>
465 <h3 id=
"HttpMessage_setHeaders">void HttpMessage::setHeaders(array headers)
</h3>
466 <p>Sets new headers.
</p>
467 <p>Expects an associative array as parameter containing the new HTTP headers,
<br />
468 which will replace *all* previous HTTP headers of the message.
</p>
469 <h3 id=
"HttpMessage_addHeaders">void HttpMessage::addHeaders(array headers[, bool append = false])
</h3>
470 <p>Add headers. If append is true, headers with the same name will be separated, else overwritten.
</p>
471 <p>Expects an associative array as parameter containing the additional HTTP headers
<br />
472 to add to the messages existing headers. If the optional bool parameter is true,
<br />
473 and a header with the same name of one to add exists already, this respective
<br />
474 header will be converted to an array containing both header values, otherwise
<br />
475 it will be overwritten with the new header value.
</p>
476 <h3 id=
"HttpMessage_getType">int HttpMessage::getType()
</h3>
477 <p>Get Message Type. (HTTP_MSG_NONE|HTTP_MSG_REQUEST|HTTP_MSG_RESPONSE)
</p>
478 <p>Returns the HttpMessage::TYPE.
</p>
479 <h3 id=
"HttpMessage_setType">void HttpMessage::setType(int type)
</h3>
480 <p>Set Message Type. (HTTP_MSG_NONE|HTTP_MSG_REQUEST|HTTP_MSG_RESPONSE)
</p>
481 <p>Expects an int parameter, the HttpMessage::TYPE.
</p>
482 <h3 id=
"HttpMessage_getResponseCode">int HttpMessage::getResponseCode()
</h3>
483 <p>Get the Response Code of the Message.
</p>
484 <p>Returns the HTTP response code if the message is of type
<br />
485 HttpMessage::TYPE_RESPONSE, else FALSE.
</p>
486 <h3 id=
"HttpMessage_setResponseCode">bool HttpMessage::setResponseCode(int code)
</h3>
487 <p>Set the response code of an HTTP Response Message.
</p>
488 <p>Expects an int parameter with the HTTP response code.
</p>
489 <p>Returns TRUE on success, or FALSE if the message is not of type
<br />
490 HttpMessage::TYPE_RESPONSE or the response code is out of range (
100-
510).
</p>
491 <h3 id=
"HttpMessage_getResponseStatus">string HttpMessage::getResponseStatus()
</h3>
492 <p>Get the Response Status of the message (i.e. the string following the response code).
</p>
493 <p>Returns the HTTP response status string if the message is of type
<br />
494 HttpMessage::TYPE_RESPONSE, else FALSE.
</p>
495 <h3 id=
"HttpMessage_setResponseStatus">bool HttpMessage::setResponseStatus(string status)
</h3>
496 <p>Set the Response Status of the HTTP message (i.e. the string following the response code).
</p>
497 <p>Expects a string parameter containing the response status text.
</p>
498 <p>Returns TRUE on success or FALSE if the message is not of type
<br />
499 HttpMessage::TYPE_RESPONSE.
</p>
500 <h3 id=
"HttpMessage_getRequestMethod">string HttpMessage::getRequestMethod()
</h3>
501 <p>Get the Request Method of the Message.
</p>
502 <p>Returns the request method name on success, or FALSE if the message is
<br />
503 not of type HttpMessage::TYPE_REQUEST.
</p>
504 <h3 id=
"HttpMessage_setRequestMethod">bool HttpMessage::setRequestMethod(string method)
</h3>
505 <p>Set the Request Method of the HTTP Message.
</p>
506 <p>Expects a string parameter containing the request method name.
</p>
507 <p>Returns TRUE on success, or FALSE if the message is not of type
<br />
508 HttpMessage::TYPE_REQUEST or an invalid request method was supplied.
</p>
509 <h3 id=
"HttpMessage_getRequestUrl">string HttpMessage::getRequestUrl()
</h3>
510 <p>Get the Request URL of the Message.
</p>
511 <p>Returns the request url as string on success, or FALSE if the message
<br />
512 is not of type HttpMessage::TYPE_REQUEST.
</p>
513 <h3 id=
"HttpMessage_setRequestUrl">bool HttpMessage::setRequestUrl(string url)
</h3>
514 <p>Set the Request URL of the HTTP Message.
</p>
515 <p>Expects a string parameters containing the request url.
</p>
516 <p>Returns TRUE on success, or FALSE if the message is not of type
<br />
517 HttpMessage::TYPE_REQUEST or supplied URL was empty.
</p>
518 <h3 id=
"HttpMessage_getHttpVersion">string HttpMessage::getHttpVersion()
</h3>
519 <p>Get the HTTP Protocol Version of the Message.
</p>
520 <p>Returns the HTTP protocol version as string.
</p>
521 <h3 id=
"HttpMessage_setHttpVersion">bool HttpMessage::setHttpVersion(string version)
</h3>
522 <p>Set the HTTP Protocol version of the Message.
</p>
523 <p>Expects a string parameter containing the HTTP protocol version.
</p>
524 <p>Returns TRUE on success, or FALSE if supplied version is out of range (
1.0/
1.1).
</p>
525 <h3 id=
"HttpMessage_getParentMessage">HttpMessage HttpMessage::getParentMessage()
</h3>
526 <p>Get parent Message.
</p>
527 <p>Returns the parent HttpMessage on success, or NULL if there's none.
</p>
528 <h3 id=
"HttpMessage_send">bool HttpMessage::send()
</h3>
529 <p>Send the Message according to its type as Response or Request.
<br />
530 This provides limited functionality compared to HttpRequest and HttpResponse.
</p>
531 <p>Returns TRUE on success, or FALSE on failure.
</p>
532 <h3 id=
"HttpMessage_toString">string HttpMessage::toString([bool include_parent = false])
</h3>
533 <p>Get the string representation of the Message.
</p>
534 <p>Accepts a bool parameter which specifies whether the returned string
<br />
535 should also contain any parent messages.
</p>
536 <p>Returns the full message as string.
</p>
537 <h3 id=
"HttpMessage_toMessageTypeObject">HttpRequest|HttpResponse HttpMessage::toMessageTypeObject(void)
</h3>
538 <p>Creates an object regarding to the type of the message.
</p>
539 <p>Returns either an HttpRequest or HttpResponse object on success, or NULL on failure.
</p>
540 <p>Throws HttpRuntimeException, HttpMessageTypeException, HttpHeaderException.
</p>
541 <h3 id=
"HttpMessage_count">int HttpMessage::count()
</h3>
542 <p>Implements Countable.
</p>
543 <p>Returns the number of parent messages +
1.
</p>
544 <h3 id=
"HttpMessage_serialize">string HttpMessage::serialize()
</h3>
545 <p>Implements Serializable.
</p>
546 <p>Returns the serialized representation of the HttpMessage.
</p>
547 <h3 id=
"HttpMessage_unserialize">void HttpMessage::unserialize(string serialized)
</h3>
548 <p>Implements Serializable.
</p>
549 <p>Re-constructs the HttpMessage based upon the serialized string.
</p>
550 <h3 id=
"HttpMessage_detach">HttpMessage HttpMessage::detach(void)
</h3>
551 <p>Returns a clone of an HttpMessage object detached from any parent messages.
</p>
552 <h3 id=
"HttpMessage_prepend">void HttpMessage::prepend(HttpMessage message)
</h3>
553 <p>Prepends message(s) to the HTTP message.
</p>
554 <p>Expects an HttpMessage object as parameter.
</p>
555 <h3 id=
"HttpMessage_rewind">void HttpMessage::rewind(void)
</h3>
556 <p>Implements Iterator.
</p>
557 <h3 id=
"HttpMessage_valid">bool HttpMessage::valid(void)
</h3>
558 <p>Implements Iterator.
</p>
559 <h3 id=
"HttpMessage_next">void HttpMessage::next(void)
</h3>
560 <p>Implements Iterator.
</p>
561 <h3 id=
"HttpMessage_key">int HttpMessage::key(void)
</h3>
562 <p>Implements Iterator.
</p>
563 <h3 id=
"HttpMessage_current">HttpMessage HttpMessage::current(void)
</h3>
564 <p>Implements Iterator.
</p>
566 <h1 id=
"http_querystring_object.c">http_querystring_object.c
</h1>
567 <h2 id=
"HttpQueryString" class=
"o">HttpQueryString
</h2>
568 <h3 id=
"HttpQueryString___construct">void HttpQueryString::__construct([bool global = true[, mixed add])
</h3>
569 <p>Creates a new HttpQueryString object instance.
<br />
570 Operates on and modifies $_GET and $_SERVER['QUERY_STRING'] if global is TRUE.
</p>
571 <h3 id=
"HttpQueryString_toString">string HttpQueryString::toString()
</h3>
572 <p>Returns the string representation.
</p>
573 <h3 id=
"HttpQueryString_toArray">array HttpQueryString::toArray()
</h3>
574 <p>Returns the array representation.
</p>
575 <h3 id=
"HttpQueryString_get">mixed HttpQueryString::get([string key[, mixed type =
0[, mixed defval = NULL[, bool delete = false]]]])
</h3>
576 <p>Get (part of) the query string.
</p>
577 <p>The type parameter is either one of the HttpQueryString::TYPE_* constants or a type abbreviation like
<br />
578 "b" for bool,
"i" for int,
"f" for float,
"s" for string,
"a" for array and
"o" for a stdClass object.
</p>
579 <h3 id=
"HttpQueryString_set">string HttpQueryString::set(mixed params)
</h3>
580 <p>Set query string entry/entries. NULL values will unset the variable.
</p>
581 <h3 id=
"HttpQueryString_getInstance">HttpQueryString HttpQueryString::getInstance([bool global = true])
</h3>
582 <p>Get a single instance (differentiates between the global setting).
</p>
584 <h1 id=
"http_request_object.c">http_request_object.c
</h1>
585 <h2 id=
"HttpRequest" class=
"o">HttpRequest
</h2>
586 <h3 id=
"HttpRequest___construct">void HttpRequest::__construct([string url[, int request_method = HTTP_METH_GET[, array options]]])
</h3>
587 <p>Instantiate a new HttpRequest object.
</p>
588 <p>Accepts a string as optional parameter containing the target request url.
<br />
589 Additionally accepts an optional int parameter specifying the request method
<br />
590 to use and an associative array as optional third parameter which will be
<br />
591 passed to HttpRequest::setOptions().
</p>
592 <p>Throws HttpException.
</p>
593 <h3 id=
"HttpRequest_setOptions">bool HttpRequest::setOptions([array options])
</h3>
594 <p>Set the request options to use. See http_get() for a full list of available options.
</p>
595 <p>Accepts an array as optional parameters, which values will overwrite the
<br />
596 currently set request options. If the parameter is empty or omitted,
<br />
597 the options of the HttpRequest object will be reset.
</p>
598 <p>Returns TRUE on success, or FALSE on failure.
</p>
599 <h3 id=
"HttpRequest_getOptions">array HttpRequest::getOptions()
</h3>
600 <p>Get currently set options.
</p>
601 <p>Returns an associative array containing currently set options.
</p>
602 <h3 id=
"HttpRequest_setSslOptions">bool HttpRequest::setSslOptions([array options])
</h3>
603 <p>Set SSL options.
</p>
604 <p>Accepts an associative array as parameter containing any SSL specific options.
<br />
605 If the parameter is empty or omitted, the SSL options will be reset.
</p>
606 <p>Returns TRUE on success, or FALSE on failure.
</p>
607 <h3 id=
"HttpRequest_addSslOptions">bool HttpRequest::addSslOptions(array options)
</h3>
608 <p>Set additional SSL options.
</p>
609 <p>Expects an associative array as parameter containing additional SSL specific options.
</p>
610 <p>Returns TRUE on success, or FALSE on failure.
</p>
611 <h3 id=
"HttpRequest_getSslOptions">array HttpRequest::getSslOtpions()
</h3>
612 <p>Get previously set SSL options.
</p>
613 <p>Returns an associative array containing any previously set SSL options.
</p>
614 <h3 id=
"HttpRequest_addHeaders">bool HttpRequest::addHeaders(array headers)
</h3>
615 <p>Add request header name/value pairs.
</p>
616 <p>Expects an associative array as parameter containing additional header
<br />
617 name/value pairs.
</p>
618 <p>Returns TRUE on success, or FALSE on failure.
</p>
619 <h3 id=
"HttpRequest_setHeaders">bool HttpRequest::setHeaders([array headers])
</h3>
620 <p>Set request header name/value pairs.
</p>
621 <p>Accepts an associative array as parameter containing header name/value pairs.
<br />
622 If the parameter is empty or omitted, all previously set headers will be unset.
</p>
623 <p>Returns TRUE on success, or FALSE on failure.
</p>
624 <h3 id=
"HttpRequest_getHeaders">array HttpRequest::getHeaders()
</h3>
625 <p>Get previously set request headers.
</p>
626 <p>Returns an associative array containing all currently set headers.
</p>
627 <h3 id=
"HttpRequest_setCookies">bool HttpRequest::setCookies([array cookies])
</h3>
629 <p>Accepts an associative array as parameter containing cookie name/value pairs.
<br />
630 If the parameter is empty or omitted, all previously set cookies will be unset.
</p>
631 <p>Returns TRUE on success, or FALSE on failure.
</p>
632 <h3 id=
"HttpRequest_addCookies">bool HttpRequest::addCookies(array cookies)
</h3>
634 <p>Expects an associative array as parameter containing any cookie name/value
<br />
636 <p>Returns TRUE on success, or FALSE on failure.
</p>
637 <h3 id=
"HttpRequest_getCookies">array HttpRequest::getCookies()
</h3>
638 <p>Get previously set cookies.
</p>
639 <p>Returns an associative array containing any previously set cookies.
</p>
640 <h3 id=
"HttpRequest_setUrl">bool HttpRequest::setUrl(string url)
</h3>
641 <p>Set the request URL.
</p>
642 <p>Expects a string as parameter specifying the request url.
</p>
643 <p>Returns TRUE on success, or FALSE on failure.
</p>
644 <h3 id=
"HttpRequest_getUrl">string HttpRequest::getUrl()
</h3>
645 <p>Get the previously set request URL.
</p>
646 <p>Returns the currently set request url as string.
</p>
647 <h3 id=
"HttpRequest_setMethod">bool HttpRequest::setMethod(int request_method)
</h3>
648 <p>Set the request method.
</p>
649 <p>Expects an int as parameter specifying the request method to use.
<br />
650 In PHP
5.1+ HttpRequest::METH_*, otherwise the HTTP_METH_* constants can be used.
</p>
651 <p>Returns TRUE on success, or FALSE on failure.
</p>
652 <h3 id=
"HttpRequest_getMethod">int HttpRequest::getMethod()
</h3>
653 <p>Get the previously set request method.
</p>
654 <p>Returns the currently set request method.
</p>
655 <h3 id=
"HttpRequest_setContentType">bool HttpRequest::setContentType(string content_type)
</h3>
656 <p>Set the content type the post request should have.
</p>
657 <p>Expects a string as parameters containing the content type of the request
<br />
658 (primary/secondary).
</p>
659 <p>Returns TRUE on success, or FALSE if the content type does not seem to
<br />
660 contain a primary and a secondary part.
</p>
661 <h3 id=
"HttpRequest_getContentType">string HttpRequest::getContentType()
</h3>
662 <p>Get the previously content type.
</p>
663 <p>Returns the previously set content type as string.
</p>
664 <h3 id=
"HttpRequest_setQueryData">bool HttpRequest::setQueryData([mixed query_data])
</h3>
665 <p>Set the URL query parameters to use, overwriting previously set query parameters.
<br />
666 Affects any request types.
</p>
667 <p>Accepts a string or associative array parameter containing the pre-encoded
<br />
668 query string or to be encoded query fields. If the parameter is empty or
<br />
669 omitted, the query data will be unset.
</p>
670 <p>Returns TRUE on success, or FALSE on failure.
</p>
671 <h3 id=
"HttpRequest_getQueryData">string HttpRequest::getQueryData()
</h3>
672 <p>Get the current query data in form of an urlencoded query string.
</p>
673 <p>Returns a string containing the urlencoded query.
</p>
674 <h3 id=
"HttpRequest_addQueryData">bool HttpRequest::addQueryData(array query_params)
</h3>
675 <p>Add parameters to the query parameter list, leaving previously set unchanged.
<br />
676 Affects any request type.
</p>
677 <p>Expects an associative array as parameter containing the query fields to add.
</p>
678 <p>Returns TRUE on success, or FALSE on failure.
</p>
679 <h3 id=
"HttpRequest_addPostFields">bool HttpRequest::addPostFields(array post_data)
</h3>
680 <p>Adds POST data entries, leaving previously set unchanged, unless a
<br />
681 post entry with the same name already exists.
<br />
682 Affects only POST and custom requests.
</p>
683 <p>Expects an associative array as parameter containing the post fields.
</p>
684 <p>Returns TRUE on success, or FALSE on failure.
</p>
685 <h3 id=
"HttpRequest_setPostFields">bool HttpRequest::setPostFields([array post_data])
</h3>
686 <p>Set the POST data entries, overwriting previously set POST data.
<br />
687 Affects only POST and custom requests.
</p>
688 <p>Accepts an associative array as parameter containing the post fields.
<br />
689 If the parameter is empty or omitted, the post data will be unset.
</p>
690 <p>Returns TRUE on success, or FALSE on failure.
</p>
691 <h3 id=
"HttpRequest_getPostFields">array HttpRequest::getPostFields()
</h3>
692 <p>Get previously set POST data.
</p>
693 <p>Returns the currently set post fields as associative array.
</p>
694 <h3 id=
"HttpRequest_setRawPostData">bool HttpRequest::setRawPostData([string raw_post_data])
</h3>
695 <p>Set raw post data to send, overwriting previously set raw post data. Don't
<br />
696 forget to specify a content type. Affects only POST and custom requests.
<br />
697 Only either post fields or raw post data can be used for each request.
<br />
698 Raw post data has higher precedence and will be used even if post fields
<br />
700 <p>Accepts a string as parameter containing the *raw* post data.
</p>
701 <p>Returns TRUE on success, or FALSE on failure.
</p>
702 <h3 id=
"HttpRequest_addRawPostData">bool HttpRequest::addRawPostData(string raw_post_data)
</h3>
703 <p>Add raw post data, leaving previously set raw post data unchanged.
<br />
704 Affects only POST and custom requests.
</p>
705 <p>Expects a string as parameter containing the raw post data to concatenate.
</p>
706 <p>Returns TRUE on success, or FALSE on failure.
</p>
707 <h3 id=
"HttpRequest_getRawPostData">string HttpRequest::getRawPostData()
</h3>
708 <p>Get previously set raw post data.
</p>
709 <p>Returns a string containing the currently set raw post data.
</p>
710 <h3 id=
"HttpRequest_addPostFile">bool HttpRequest::addPostFile(string name, string file[, string content_type =
"application/x-octetstream"])
</h3>
711 <p>Add a file to the POST request, leaving previously set files unchanged.
<br />
712 Affects only POST and custom requests. Cannot be used with raw post data.
</p>
713 <p>Expects a string parameter containing the form element name, and a string
<br />
714 paremeter containing the path to the file which should be uploaded.
<br />
715 Additionally accepts an optional string parameter which should contain
<br />
716 the content type of the file.
</p>
717 <p>Returns TRUE on success, or FALSE if the content type seems not to contain a
<br />
718 primary and a secondary content type part.
</p>
719 <h3 id=
"HttpRequest_setPostFiles">bool HttpRequest::setPostFiles([array post_files])
</h3>
720 <p>Set files to post, overwriting previously set post files.
<br />
721 Affects only POST and requests. Cannot be used with raw post data.
</p>
722 <p>Accepts an array containing the files to post. Each entry should be an
<br />
723 associative array with
"name",
"file" and
"type" keys. If the parameter
<br />
724 is empty or omitted the post files will be unset.
</p>
725 <p>Returns TRUE on success, or FALSE on failure.
</p>
726 <h3 id=
"HttpRequest_getPostFiles">array HttpRequest::getPostFiles()
</h3>
727 <p>Get all previously added POST files.
</p>
728 <p>Returns an array containing currently set post files.
</p>
729 <h3 id=
"HttpRequest_setPutFile">bool HttpRequest::setPutFile([string file])
</h3>
730 <p>Set file to put. Affects only PUT requests.
</p>
731 <p>Accepts a string as parameter referencing the path to file.
<br />
732 If the parameter is empty or omitted the put file will be unset.
</p>
733 <p>Returns TRUE on success, or FALSE on failure.
</p>
734 <h3 id=
"HttpRequest_getPutFile">string HttpRequest::getPutFile()
</h3>
735 <p>Get previously set put file.
</p>
736 <p>Returns a string containing the path to the currently set put file.
</p>
737 <h3 id=
"HttpRequest_getResponseData">array HttpRequest::getResponseData()
</h3>
738 <p>Get all response data after the request has been sent.
</p>
739 <p>Returns an associative array with the key
"headers" containing an associative
<br />
740 array holding all response headers, as well as the key
"body" containing a
<br />
741 string with the response body.
</p>
742 <p>If redirects were allowed and several responses were received, the data
<br />
743 references the last received response.
</p>
744 <h3 id=
"HttpRequest_getResponseHeader">mixed HttpRequest::getResponseHeader([string name])
</h3>
745 <p>Get response header(s) after the request has been sent.
</p>
746 <p>Accepts an string as optional parameter specifying a certain header to read.
<br />
747 If the parameter is empty or omitted all response headers will be returned.
</p>
748 <p>Returns either a string with the value of the header matching name if requested,
<br />
749 FALSE on failure, or an associative array containing all response headers.
</p>
750 <p>If redirects were allowed and several responses were received, the data
<br />
751 references the last received response.
</p>
752 <h3 id=
"HttpRequest_getResponseCookie">array HttpRequest::getResponseCookie([string name])
</h3>
753 <p>Get response cookie(s) after the request has been sent.
</p>
754 <p>Accepts a string as optional parameter specifying the name of the cookie to read.
<br />
755 If the parameter is empty or omitted, an associative array with all received
<br />
756 cookies will be returned.
</p>
757 <p>Returns either an associative array with the cookie's name, value and any
<br />
758 additional params of the cookie matching name if requested, FALSE on failure,
<br />
759 or an array containing all received cookies as arrays.
</p>
760 <p>If redirects were allowed and several responses were received, the data
<br />
761 references the last received response.
</p>
762 <h3 id=
"HttpRequest_getResponseBody">string HttpRequest::getResponseBody()
</h3>
763 <p>Get the response body after the request has been sent.
</p>
764 <p>Returns a string containing the response body.
</p>
765 <p>If redirects were allowed and several responses were received, the data
<br />
766 references the last received response.
</p>
767 <h3 id=
"HttpRequest_getResponseCode">int HttpRequest::getResponseCode()
</h3>
768 <p>Get the response code after the request has been sent.
</p>
769 <p>Returns an int representing the response code.
</p>
770 <p>If redirects were allowed and several responses were received, the data
<br />
771 references the last received response.
</p>
772 <h3 id=
"HttpRequest_getResponseStatus">string HttpRequest::getResponseStatus()
</h3>
773 <p>Get the response status (i.e. the string after the response code) after the message has been sent.
</p>
774 <p>Returns a string containing the response status text.
</p>
775 <h3 id=
"HttpRequest_getResponseInfo">mixed HttpRequest::getResponseInfo([string name])
</h3>
776 <p>Get response info after the request has been sent.
<br />
777 See http_get() for a full list of returned info.
</p>
778 <p>Accepts a string as optional parameter specifying the info to read.
<br />
779 If the parameter is empty or omitted, an associative array containing
<br />
780 all available info will be returned.
</p>
781 <p>Returns either a scalar containing the value of the info matching name if
<br />
782 requested, FALSE on failure, or an associative array containing all
<br />
784 <p>If redirects were allowed and several responses were received, the data
<br />
785 references the last received response.
</p>
786 <h3 id=
"HttpRequest_getResponseMessage">HttpMessage HttpRequest::getResponseMessage()
</h3>
787 <p>Get the full response as HttpMessage object after the request has been sent.
</p>
788 <p>Returns an HttpMessage object of the response.
</p>
789 <p>If redirects were allowed and several responses were received, the data
<br />
790 references the last received response. Use HttpMessage::getParentMessage()
<br />
791 to access the data of previously received responses within this request
<br />
793 <p>Throws HttpException.
</p>
794 <h3 id=
"HttpRequest_getRequestMessage">HttpMessage HttpRequest::getRequestMessage()
</h3>
795 <p>Get sent HTTP message.
</p>
796 <p>Returns an HttpMessage object representing the sent request.
</p>
797 <p>If redirects were allowed and several responses were received, the data
<br />
798 references the last received response. Use HttpMessage::getParentMessage()
<br />
799 to access the data of previously sent requests within this request
<br />
801 <p>Note that the internal request message is immutable, that means that the
<br />
802 request message received through HttpRequest::getRequestMessage() will
<br />
803 always look the same for the same request, regardless of any changes you
<br />
804 may have made to the returned object.
</p>
805 <p>Throws HttpMalformedHeadersException, HttpEncodingException.
</p>
806 <h3 id=
"HttpRequest_getRawRequestMessage">string HttpRequest::getRawRequestMessage()
</h3>
807 <p>Get sent HTTP message.
</p>
808 <p>Returns an HttpMessage in a form of a string
</p>
809 <h3 id=
"HttpRequest_getRawResponseMessage">string HttpRequest::getRawResponseMessage()
</h3>
810 <p>Get the entire HTTP response.
</p>
811 <p>Returns the complete web server response, including the headers in a form of a string.
</p>
812 <h3 id=
"HttpRequest_getHistory">HttpMessage HttpRequest::getHistory()
</h3>
813 <p>Get all sent requests and received responses as an HttpMessage object.
</p>
814 <p>If you don't want to record history at all, set the instance variable
<br />
815 HttpRequest::$recordHistory to FALSE.
</p>
816 <p>Returns an HttpMessage object representing the complete request/response
<br />
818 <p>The object references the last received response, use HttpMessage::getParentMessage()
<br />
819 to access the data of previously sent requests and received responses.
</p>
820 <p>Note that the internal history is immutable, that means that any changes
<br />
821 you make the the message list won't affect a history message list newly
<br />
822 created by another call to HttpRequest::getHistory().
</p>
823 <p>Throws HttpMalformedHeaderException, HttpEncodingException.
</p>
824 <h3 id=
"HttpRequest_clearHistory">void HttpRequest::clearHistory()
</h3>
825 <p>Clear the history.
</p>
826 <h3 id=
"HttpRequest_send">HttpMessage HttpRequest::send()
</h3>
827 <p>Send the HTTP request.
</p>
828 <p>Returns the received response as HttpMessage object.
</p>
829 <p>NOTE: While an exception may be thrown, the transfer could have succeeded
<br />
830 at least partially, so you might want to check the return values of various
<br />
831 HttpRequest::getResponse*() methods.
</p>
832 <p>Throws HttpRuntimeException, HttpRequestException,
<br />
833 HttpMalformedHeaderException, HttpEncodingException.
</p>
834 <p>GET example:
</p><pre><blockquote><code><span style=
"color: #000000"><br />
835 <span style=
"color: #0000BB"><?php
<br />$r
</span><span style=
"color: #007700">=
new
</span><span style=
"color: #0000BB">HttpRequest
</span><span style=
"color: #007700">(
</span><span style=
"color: #DD0000">'http://example.com/feed.rss'
</span><span style=
"color: #007700">,
</span><span style=
"color: #0000BB">HttpRequest
</span><span style=
"color: #007700">::
</span><span style=
"color: #0000BB">METH_GET
</span><span style=
"color: #007700">);
<br /></span><span style=
"color: #0000BB">$r
</span><span style=
"color: #007700">-
></span><span style=
"color: #0000BB">setOptions
</span><span style=
"color: #007700">(array(
</span><span style=
"color: #DD0000">'lastmodified'
</span><span style=
"color: #007700">=
> </span><span style=
"color: #0000BB">filemtime
</span><span style=
"color: #007700">(
</span><span style=
"color: #DD0000">'local.rss'
</span><span style=
"color: #007700">)));
<br /></span><span style=
"color: #0000BB">$r
</span><span style=
"color: #007700">-
></span><span style=
"color: #0000BB">addQueryData
</span><span style=
"color: #007700">(array(
</span><span style=
"color: #DD0000">'category'
</span><span style=
"color: #007700">=
> </span><span style=
"color: #0000BB">3</span><span style=
"color: #007700">));
<br />try
{
<br /> </span><span style=
"color: #0000BB">$r
</span><span style=
"color: #007700">-
></span><span style=
"color: #0000BB">send
</span><span style=
"color: #007700">();
<br /> if
(
</span><span style=
"color: #0000BB">$r
</span><span style=
"color: #007700">-
></span><span style=
"color: #0000BB">getResponseCode
</span><span style=
"color: #007700">()
==
</span><span style=
"color: #0000BB">200</span><span style=
"color: #007700">)
{
<br /> </span><span style=
"color: #0000BB">file_put_contents
</span><span style=
"color: #007700">(
</span><span style=
"color: #DD0000">'local.rss'
</span><span style=
"color: #007700">,
</span><span style=
"color: #0000BB">$r
</span><span style=
"color: #007700">-
></span><span style=
"color: #0000BB">getResponseBody
</span><span style=
"color: #007700">());
<br /> }
<br />}
catch
(
</span><span style=
"color: #0000BB">HttpException
$ex
</span><span style=
"color: #007700">)
{
<br /> echo
</span><span style=
"color: #0000BB">$ex
</span><span style=
"color: #007700">;
<br />}
<br /></span><span style=
"color: #0000BB">?
></span><br />
836 </span></code></blockquote></p>
838 <p>POST example:
</p><pre><blockquote><code><span style=
"color: #000000"><br />
839 <span style=
"color: #0000BB"><?php
<br />$r
</span><span style=
"color: #007700">=
new
</span><span style=
"color: #0000BB">HttpRequest
</span><span style=
"color: #007700">(
</span><span style=
"color: #DD0000">'http://example.com/form.php'
</span><span style=
"color: #007700">,
</span><span style=
"color: #0000BB">HttpRequest
</span><span style=
"color: #007700">::
</span><span style=
"color: #0000BB">METH_POST
</span><span style=
"color: #007700">);
<br /></span><span style=
"color: #0000BB">$r
</span><span style=
"color: #007700">-
></span><span style=
"color: #0000BB">setOptions
</span><span style=
"color: #007700">(array(
</span><span style=
"color: #DD0000">'cookies'
</span><span style=
"color: #007700">=
> array(
</span><span style=
"color: #DD0000">'lang'
</span><span style=
"color: #007700">=
> </span><span style=
"color: #DD0000">'de'
</span><span style=
"color: #007700">)));
<br /></span><span style=
"color: #0000BB">$r
</span><span style=
"color: #007700">-
></span><span style=
"color: #0000BB">addPostFields
</span><span style=
"color: #007700">(array(
</span><span style=
"color: #DD0000">'user'
</span><span style=
"color: #007700">=
> </span><span style=
"color: #DD0000">'mike'
</span><span style=
"color: #007700">,
</span><span style=
"color: #DD0000">'pass'
</span><span style=
"color: #007700">=
> </span><span style=
"color: #DD0000">'s3c|r3t'
</span><span style=
"color: #007700">));
<br /></span><span style=
"color: #0000BB">$r
</span><span style=
"color: #007700">-
></span><span style=
"color: #0000BB">addPostFile
</span><span style=
"color: #007700">(
</span><span style=
"color: #DD0000">'image'
</span><span style=
"color: #007700">,
</span><span style=
"color: #DD0000">'profile.jpg'
</span><span style=
"color: #007700">,
</span><span style=
"color: #DD0000">'image/jpeg'
</span><span style=
"color: #007700">);
<br />try
{
<br /> echo
</span><span style=
"color: #0000BB">$r
</span><span style=
"color: #007700">-
></span><span style=
"color: #0000BB">send
</span><span style=
"color: #007700">()-
></span><span style=
"color: #0000BB">getBody
</span><span style=
"color: #007700">();
<br />}
catch
(
</span><span style=
"color: #0000BB">HttpException
$ex
</span><span style=
"color: #007700">)
{
<br /> echo
</span><span style=
"color: #0000BB">$ex
</span><span style=
"color: #007700">;
<br />}
<br /></span><span style=
"color: #0000BB">?
></span><br />
840 </span></code></blockquote></p>
843 <h1 id=
"http_requestpool_object.c">http_requestpool_object.c
</h1>
844 <h2 id=
"HttpRequestPool" class=
"o">HttpRequestPool
</h2>
845 <h3 id=
"HttpRequestPool___construct">void HttpRequestPool::__construct([HttpRequest request[, ...]])
</h3>
846 <p>Instantiate a new HttpRequestPool object. An HttpRequestPool is
<br />
847 able to send several HttpRequests in parallel.
</p>
848 <p>WARNING: Don't attach/detach HttpRequest objects to the HttpRequestPool
<br />
849 object while you're using the implemented Iterator interface.
</p>
850 <p>Accepts virtual infinite optional parameters each referencing an
<br />
851 HttpRequest object.
</p>
852 <p>Throws HttpRequestPoolException (HttpRequestException, HttpInvalidParamException).
</p>
853 <p>Example:
</p><pre><blockquote><code><span style=
"color: #000000"><br />
854 <span style=
"color: #0000BB"><?php
<br /></span><span style=
"color: #007700">try
{
<br /> </span><span style=
"color: #0000BB">$pool
</span><span style=
"color: #007700">=
new
</span><span style=
"color: #0000BB">HttpRequestPool
</span><span style=
"color: #007700">(
<br /> new
</span><span style=
"color: #0000BB">HttpRequest
</span><span style=
"color: #007700">(
</span><span style=
"color: #DD0000">'http://www.google.com/'
</span><span style=
"color: #007700">,
</span><span style=
"color: #0000BB">HttpRequest
</span><span style=
"color: #007700">::
</span><span style=
"color: #0000BB">METH_HEAD
</span><span style=
"color: #007700">),
<br /> new
</span><span style=
"color: #0000BB">HttpRequest
</span><span style=
"color: #007700">(
</span><span style=
"color: #DD0000">'http://www.php.net/'
</span><span style=
"color: #007700">,
</span><span style=
"color: #0000BB">HttpRequest
</span><span style=
"color: #007700">::
</span><span style=
"color: #0000BB">METH_HEAD
</span><span style=
"color: #007700">)
<br /> );
<br /> </span><span style=
"color: #0000BB">$pool
</span><span style=
"color: #007700">-
></span><span style=
"color: #0000BB">send
</span><span style=
"color: #007700">();
<br /> foreach(
</span><span style=
"color: #0000BB">$pool
</span><span style=
"color: #007700">as
</span><span style=
"color: #0000BB">$request
</span><span style=
"color: #007700">)
{
<br /> </span><span style=
"color: #0000BB">printf
</span><span style=
"color: #007700">(
</span><span style=
"color: #DD0000">"%s is %s (%d)\n"</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #0000BB">$request
</span><span style=
"color: #007700">-
></span><span style=
"color: #0000BB">getUrl
</span><span style=
"color: #007700">(),
<br /> </span><span style=
"color: #0000BB">$request
</span><span style=
"color: #007700">-
></span><span style=
"color: #0000BB">getResponseCode
</span><span style=
"color: #007700">()
?
</span><span style=
"color: #DD0000">'alive'
</span><span style=
"color: #007700">:
</span><span style=
"color: #DD0000">'not
alive'
</span><span style=
"color: #007700">,
<br /> </span><span style=
"color: #0000BB">$request
</span><span style=
"color: #007700">-
></span><span style=
"color: #0000BB">getResponseCode
</span><span style=
"color: #007700">()
<br /> );
<br /> }
<br />}
catch
(
</span><span style=
"color: #0000BB">HttpException
$e
</span><span style=
"color: #007700">)
{
<br /> echo
</span><span style=
"color: #0000BB">$e
</span><span style=
"color: #007700">;
<br />}
<br /></span><span style=
"color: #0000BB">?
></span><br />
855 </span></code></blockquote></p>
857 <h3 id=
"HttpRequestPool___destruct">void HttpRequestPool::__destruct()
</h3>
858 <p>Clean up HttpRequestPool object.
</p>
859 <h3 id=
"HttpRequestPool_reset">void HttpRequestPool::reset()
</h3>
860 <p>Detach all attached HttpRequest objects.
</p>
861 <h3 id=
"HttpRequestPool_attach">bool HttpRequestPool::attach(HttpRequest request)
</h3>
862 <p>Attach an HttpRequest object to this HttpRequestPool.
<br />
863 WARNING: set all options prior attaching!
</p>
864 <p>Expects the parameter to be an HttpRequest object not already attached to
<br />
865 antother HttpRequestPool object.
</p>
866 <p>Returns TRUE on success, or FALSE on failure.
</p>
867 <p>Throws HttpInvalidParamException, HttpRequestException,
<br />
868 HttpRequestPoolException, HttpEncodingException.
</p>
869 <h3 id=
"HttpRequestPool_detach">bool HttpRequestPool::detach(HttpRequest request)
</h3>
870 <p>Detach an HttpRequest object from this HttpRequestPool.
</p>
871 <p>Expects the parameter to be an HttpRequest object attached to this
<br />
872 HttpRequestPool object.
</p>
873 <p>Returns TRUE on success, or FALSE on failure.
</p>
874 <p>Throws HttpInvalidParamException, HttpRequestPoolException.
</p>
875 <h3 id=
"HttpRequestPool_send">bool HttpRequestPool::send()
</h3>
876 <p>Send all attached HttpRequest objects in parallel.
</p>
877 <p>Returns TRUE on success, or FALSE on failure.
</p>
878 <p>Throws HttpRequestPoolException (HttpSocketException, HttpRequestException, HttpMalformedHeaderException).
</p>
879 <h3 id=
"HttpRequestPool_socketPerform">protected bool HttpRequestPool::socketPerform()
</h3>
880 <p>Returns TRUE until each request has finished its transaction.
</p>
881 <p>Usage:
</p><pre><blockquote><code><span style=
"color: #000000"><br />
882 <span style=
"color: #0000BB"><?php
<br /></span><span style=
"color: #007700">class
</span><span style=
"color: #0000BB">MyPool
</span><span style=
"color: #007700">extends
</span><span style=
"color: #0000BB">HttpRequestPool
<br /></span><span style=
"color: #007700">{
<br /> public
function
</span><span style=
"color: #0000BB">send
</span><span style=
"color: #007700">()
<br /> {
<br /> while
(
</span><span style=
"color: #0000BB">$this
</span><span style=
"color: #007700">-
></span><span style=
"color: #0000BB">socketPerform
</span><span style=
"color: #007700">())
{
<br /> if
(!
</span><span style=
"color: #0000BB">$this
</span><span style=
"color: #007700">-
></span><span style=
"color: #0000BB">socketSelect
</span><span style=
"color: #007700">())
{
<br /> throw
new
</span><span style=
"color: #0000BB">HttpSocketExcpetion
</span><span style=
"color: #007700">;
<br /> }
<br /> }
<br /> }
<br /> <br /> protected
final
function
</span><span style=
"color: #0000BB">socketPerform
</span><span style=
"color: #007700">()
<br /> {
<br /> </span><span style=
"color: #0000BB">$result
</span><span style=
"color: #007700">=
</span><span style=
"color: #0000BB">parent
</span><span style=
"color: #007700">::
</span><span style=
"color: #0000BB">socketPerform
</span><span style=
"color: #007700">();
<br /> foreach
(
</span><span style=
"color: #0000BB">$this
</span><span style=
"color: #007700">-
></span><span style=
"color: #0000BB">getFinishedRequests
</span><span style=
"color: #007700">()
as
</span><span style=
"color: #0000BB">$r
</span><span style=
"color: #007700">)
{
<br /> </span><span style=
"color: #0000BB">$this
</span><span style=
"color: #007700">-
></span><span style=
"color: #0000BB">detach
</span><span style=
"color: #007700">(
</span><span style=
"color: #0000BB">$r
</span><span style=
"color: #007700">);
<br /> </span><span style=
"color: #FF8000">//
handle
response
of
finished
request
<br /> </span><span style=
"color: #007700">}
<br /> return
</span><span style=
"color: #0000BB">$result
</span><span style=
"color: #007700">;
<br /> }
<br />}
<br /></span><span style=
"color: #0000BB">?
></span><br />
883 </span></code></blockquote></p>
885 <h3 id=
"HttpRequestPool_socketSelect">protected bool HttpRequestPool::socketSelect()
</h3>
886 <p>See HttpRequestPool::socketPerform().
</p>
887 <p>Returns TRUE on success, or FALSE on failure.
</p>
888 <h3 id=
"HttpRequestPool_valid">bool HttpRequestPool::valid()
</h3>
889 <p>Implements Iterator::valid().
</p>
890 <h3 id=
"HttpRequestPool_current">HttpRequest HttpRequestPool::current()
</h3>
891 <p>Implements Iterator::current().
</p>
892 <h3 id=
"HttpRequestPool_key">int HttpRequestPool::key()
</h3>
893 <p>Implements Iterator::key().
</p>
894 <h3 id=
"HttpRequestPool_next">void HttpRequestPool::next()
</h3>
895 <p>Implements Iterator::next().
</p>
896 <h3 id=
"HttpRequestPool_rewind">void HttpRequestPool::rewind()
</h3>
897 <p>Implements Iterator::rewind().
</p>
898 <h3 id=
"HttpRequestPool_count">int HttpRequestPool::count()
</h3>
899 <p>Implements Countable.
</p>
900 <p>Returns the number of attached HttpRequest objects.
</p>
901 <h3 id=
"HttpRequestPool_getAttachedRequests">array HttpRequestPool::getAttachedRequests()
</h3>
902 <p>Get attached HttpRequest objects.
</p>
903 <p>Returns an array containing all currently attached HttpRequest objects.
</p>
904 <h3 id=
"HttpRequestPool_getFinishedRequests">array HttpRequestPool::getFinishedRequests()
</h3>
905 <p>Get attached HttpRequest objects that already have finished their work.
</p>
906 <p>Returns an array containing all attached HttpRequest objects that
<br />
907 already have finished their work.
</p>
909 <h1 id=
"http_response_object.c">http_response_object.c
</h1>
910 <h2 id=
"HttpResponse" class=
"o">HttpResponse
</h2>
911 <h3 id=
"HttpResponse_setHeader">static bool HttpResponse::setHeader(string name, mixed value[, bool replace = true])
</h3>
912 <p>Send an HTTP header.
</p>
913 <p>Expects a string parameter containing the name of the header and a mixed
<br />
914 parameter containing the value of the header, which will be converted to
<br />
915 a string. Additionally accepts an optional boolean parameter, which
<br />
916 specifies whether an existing header should be replaced. If the second
<br />
917 parameter is unset no header with this name will be sent.
</p>
918 <p>Returns TRUE on success, or FALSE on failure.
</p>
919 <p>Throws HttpHeaderException if http.only_exceptions is TRUE.
</p>
920 <h3 id=
"HttpResponse_getHeader">static mixed HttpResponse::getHeader([string name])
</h3>
921 <p>Get header(s) about to be sent.
</p>
922 <p>Accepts a string as optional parameter which specifies the name of the
<br />
923 header to read. If the parameter is empty or omitted, an associative array
<br />
924 with all headers will be returned.
</p>
925 <p>Returns either a string containing the value of the header matching name,
<br />
926 FALSE on failure, or an associative array with all headers.
</p>
927 <h3 id=
"HttpResponse_setCache">static bool HttpResponse::setCache(bool cache)
</h3>
928 <p>Whether it should be attempted to cache the entity.
<br />
929 This will result in necessary caching headers and checks of clients
<br />
930 "If-Modified-Since" and
"If-None-Match" headers. If one of those headers
<br />
931 matches a
"304 Not Modified" status code will be issued.
</p>
932 <p>NOTE: If you're using sessions, be sure that you set session.cache_limiter
<br />
933 to something more appropriate than
"no-cache"!
</p>
934 <p>Expects a boolean as parameter specifying whether caching should be attempted.
</p>
935 <p>Returns TRUE on success, or FALSE on failure.
</p>
936 <h3 id=
"HttpResponse_getCache">static bool HttpResponse::getCache()
</h3>
937 <p>Get current caching setting.
</p>
938 <p>Returns TRUE if caching should be attempted, else FALSE.
</p>
939 <h3 id=
"HttpResponse_setGzip">static bool HttpResponse::setGzip(bool gzip)
</h3>
940 <p>Enable on-thy-fly gzipping of the sent entity.
</p>
941 <p>Expects a boolean as parameter indicating if GZip compression should be enabled.
</p>
942 <p>Returns TRUE on success, or FALSE on failure.
</p>
943 <h3 id=
"HttpResponse_getGzip">static bool HttpResponse::getGzip()
</h3>
944 <p>Get current gzipping setting.
</p>
945 <p>Returns TRUE if GZip compression is enabled, else FALSE.
</p>
946 <h3 id=
"HttpResponse_setCacheControl">static bool HttpResponse::setCacheControl(string control[, int max_age =
0])
</h3>
947 <p>Set a custom cache-control header, usually being
"private" or
"public";
<br />
948 The max_age parameter controls how long the cache entry is valid on the client side.
</p>
949 <p>Expects a string parameter containing the primary cache control setting.
<br />
950 Additionally accepts an int parameter specifying the max-age setting.
</p>
951 <p>Returns TRUE on success, or FALSE if control does not match one of
<br />
952 "public" ,
"private" or
"no-cache".
</p>
953 <p>Throws HttpInvalidParamException if http.only_exceptions is TRUE.
</p>
954 <h3 id=
"HttpResponse_getCacheControl">static string HttpResponse::getCacheControl()
</h3>
955 <p>Get current Cache-Control header setting.
</p>
956 <p>Returns the current cache control setting as a string like sent in a header.
</p>
957 <h3 id=
"HttpResponse_setContentType">static bool HttpResponse::setContentType(string content_type)
</h3>
958 <p>Set the content-type of the sent entity.
</p>
959 <p>Expects a string as parameter specifying the content type of the sent entity.
</p>
960 <p>Returns TRUE on success, or FALSE if the content type does not seem to
<br />
961 contain a primary and secondary content type part.
</p>
962 <p>Throws HttpInvalidParamException if http.only_exceptions is TRUE.
</p>
963 <h3 id=
"HttpResponse_getContentType">static string HttpResponse::getContentType()
</h3>
964 <p>Get current Content-Type header setting.
</p>
965 <p>Returns the currently set content type as string.
</p>
966 <h3 id=
"HttpResponse_guessContentType">static string HttpResponse::guessContentType(string magic_file[, int magic_mode = MAGIC_MIME])
</h3>
967 <p>Attempts to guess the content type of supplied payload through libmagic.
<br />
968 If the attempt is successful, the guessed content type will automatically
<br />
969 be set as response content type.
</p>
970 <p>Expects a string parameter specifying the magic.mime database to use.
<br />
971 Additionally accepts an optional int parameter, being flags for libmagic.
</p>
972 <p>Returns the guessed content type on success, or FALSE on failure.
</p>
973 <p>Throws HttpRuntimeException, HttpInvalidParamException
<br />
974 if http.only_exceptions is TRUE.
</p>
975 <h3 id=
"HttpResponse_setContentDisposition">static bool HttpResponse::setContentDisposition(string filename[, bool inline = false])
</h3>
976 <p>Set the Content-Disposition. The Content-Disposition header is very useful
<br />
977 if the data actually sent came from a file or something similar, that should
<br />
978 be
"saved" by the client/user (i.e. by browsers
"Save as..." popup window).
</p>
979 <p>Expects a string parameter specifying the file name the
"Save as..." dialog
<br />
980 should display. Optionally accepts a bool parameter, which, if set to true
<br />
981 and the user agent knows how to handle the content type, will probably not
<br />
982 cause the popup window to be shown.
</p>
983 <p>Returns TRUE on success or FALSE on failure.
</p>
984 <h3 id=
"HttpResponse_getContentDisposition">static string HttpResponse::getContentDisposition()
</h3>
985 <p>Get current Content-Disposition setting.
</p>
986 <p>Returns the current content disposition as string like sent in a header.
</p>
987 <h3 id=
"HttpResponse_setETag">static bool HttpResponse::setETag(string etag)
</h3>
988 <p>Set a custom ETag. Use this only if you know what you're doing.
</p>
989 <p>Expects an unquoted string as parameter containing the ETag.
</p>
990 <p>Returns TRUE on success, or FALSE on failure.
</p>
991 <h3 id=
"HttpResponse_getETag">static string HttpResponse::getETag()
</h3>
992 <p>Get calculated or previously set custom ETag.
</p>
993 <p>Returns the calculated or previously set ETag as unquoted string.
</p>
994 <h3 id=
"HttpResponse_setLastModified">static bool HttpResponse::setLastModified(int timestamp)
</h3>
995 <p>Set a custom Last-Modified date.
</p>
996 <p>Expects an unix timestamp as parameter representing the last modification
<br />
997 time of the sent entity.
</p>
998 <p>Returns TRUE on success, or FALSE on failure.
</p>
999 <h3 id=
"HttpResponse_getLastModified">static int HttpResponse::getLastModified()
</h3>
1000 <p>Get calculated or previously set custom Last-Modified date.
</p>
1001 <p>Returns the calculated or previously set unix timestamp.
</p>
1002 <h3 id=
"HttpResponse_setThrottleDelay">static bool HttpResponse::setThrottleDelay(double seconds)
</h3>
1003 <p>Sets the throttle delay for use with HttpResponse::setBufferSize().
</p>
1004 <p>Provides a basic throttling mechanism, which will yield the current process
<br />
1005 resp. thread until the entity has been completely sent, though.
</p>
1006 <p>Note: This doesn't really work with the FastCGI SAPI.
</p>
1007 <p>Expects a double parameter specifying the seconds too sleep() after
<br />
1008 each chunk sent.
</p>
1009 <p>Returns TRUE on success, or FALSE on failure.
</p>
1010 <h3 id=
"HttpResponse_getThrottleDelay">static double HttpResponse::getThrottleDelay()
</h3>
1011 <p>Get the current throttle delay.
</p>
1012 <p>Returns a double representing the throttle delay in seconds.
</p>
1013 <h3 id=
"HttpResponse_setBufferSize">static bool HttpResponse::setBufferSize(int bytes)
</h3>
1014 <p>Sets the send buffer size for use with HttpResponse::setThrottleDelay().
</p>
1015 <p>Provides a basic throttling mechanism, which will yield the current process
<br />
1016 resp. thread until the entity has been completely sent, though.
</p>
1017 <p>Note: This doesn't really work with the FastCGI SAPI.
</p>
1018 <p>Expects an int parameter representing the chunk size in bytes.
</p>
1019 <p>Returns TRUE on success, or FALSE on failure.
</p>
1020 <h3 id=
"HttpResponse_getBufferSize">static int HttpResponse::getBufferSize()
</h3>
1021 <p>Get current buffer size.
</p>
1022 <p>Returns an int representing the current buffer size in bytes.
</p>
1023 <h3 id=
"HttpResponse_setData">static bool HttpResponse::setData(mixed data)
</h3>
1024 <p>Set the data to be sent.
</p>
1025 <p>Expects one parameter, which will be converted to a string and contains
<br />
1026 the data to send.
</p>
1027 <p>Returns TRUE on success, or FALSE on failure.
</p>
1028 <h3 id=
"HttpResponse_getData">static string HttpResponse::getData()
</h3>
1029 <p>Get the previously set data to be sent.
</p>
1030 <p>Returns a string containing the previously set data to send.
</p>
1031 <h3 id=
"HttpResponse_setStream">static bool HttpResponse::setStream(resource stream)
</h3>
1032 <p>Set the resource to be sent.
</p>
1033 <p>Expects a resource parameter referencing an already opened stream from
<br />
1034 which the data to send will be read.
</p>
1035 <p>Returns TRUE on success, or FALSE on failure.
</p>
1036 <h3 id=
"HttpResponse_getStream">static resource HttpResponse::getStream()
</h3>
1037 <p>Get the previously set resource to be sent.
</p>
1038 <p>Returns the previously set resource.
</p>
1039 <h3 id=
"HttpResponse_setFile">static bool HttpResponse::setFile(string file)
</h3>
1040 <p>Set the file to be sent.
</p>
1041 <p>Expects a string as parameter, specifying the path to the file to send.
</p>
1042 <p>Returns TRUE on success, or FALSE on failure.
</p>
1043 <h3 id=
"HttpResponse_getFile">static string HttpResponse::getFile()
</h3>
1044 <p>Get the previously set file to be sent.
</p>
1045 <p>Returns the previously set path to the file to send as string.
</p>
1046 <h3 id=
"HttpResponse_send">static bool HttpResponse::send([bool clean_ob = true])
</h3>
1047 <p>Finally send the entity.
</p>
1048 <p>Accepts an optional boolean parameter, specifying whether the output
<br />
1049 buffers should be discarded prior sending. A successful caching attempt
<br />
1050 will cause a script termination, and write a log entry if the INI setting
<br />
1051 http.cache_log is set.
</p>
1052 <p>Returns TRUE on success, or FALSE on failure.
</p>
1053 <p>Throws HttpHeaderException, HttpResponseException if http.only_exceptions is TRUE.
</p>
1054 <p>Example:
</p><pre><blockquote><code><span style=
"color: #000000"><br />
1055 <span style=
"color: #0000BB"><?php
<br />HttpResponse
</span><span style=
"color: #007700">::
</span><span style=
"color: #0000BB">setCache
</span><span style=
"color: #007700">(
</span><span style=
"color: #0000BB">true
</span><span style=
"color: #007700">);
<br /></span><span style=
"color: #0000BB">HttpResponse
</span><span style=
"color: #007700">::
</span><span style=
"color: #0000BB">setContentType
</span><span style=
"color: #007700">(
</span><span style=
"color: #DD0000">'application/pdf'
</span><span style=
"color: #007700">);
<br /></span><span style=
"color: #0000BB">HttpResponse
</span><span style=
"color: #007700">::
</span><span style=
"color: #0000BB">setContentDisposition
</span><span style=
"color: #007700">(
</span><span style=
"color: #DD0000">"$user.pdf"</span><span style=
"color: #007700">,
</span><span style=
"color: #0000BB">false
</span><span style=
"color: #007700">);
<br /></span><span style=
"color: #0000BB">HttpResponse
</span><span style=
"color: #007700">::
</span><span style=
"color: #0000BB">setFile
</span><span style=
"color: #007700">(
</span><span style=
"color: #DD0000">'sheet.pdf'
</span><span style=
"color: #007700">);
<br /></span><span style=
"color: #0000BB">HttpResponse
</span><span style=
"color: #007700">::
</span><span style=
"color: #0000BB">send
</span><span style=
"color: #007700">();
<br /></span><span style=
"color: #0000BB">?
></span><br />
1056 </span></code></blockquote></p>
1058 <h3 id=
"HttpResponse_capture">static void HttpResponse::capture()
</h3>
1059 <p>Capture script output.
</p>
1060 <p>Example:
</p><pre><blockquote><code><span style=
"color: #000000"><br />
1061 <span style=
"color: #0000BB"><?php
<br />HttpResponse
</span><span style=
"color: #007700">::
</span><span style=
"color: #0000BB">setCache
</span><span style=
"color: #007700">(
</span><span style=
"color: #0000BB">true
</span><span style=
"color: #007700">);
<br /></span><span style=
"color: #0000BB">HttpResponse
</span><span style=
"color: #007700">::
</span><span style=
"color: #0000BB">capture
</span><span style=
"color: #007700">();
<br /></span><span style=
"color: #FF8000">//
script
follows
<br /></span><span style=
"color: #0000BB">?
></span><br />
1062 </span></code></blockquote></p>
1065 <div class=
"toc"><strong>Table of Contents
</strong>
1067 <li><a class=
"tocfile" href=
"#http_functions.c">http_functions.c
</a>
1069 <li><a href=
"#http_date">http_date
</a>
1071 <li><a href=
"#http_build_url">http_build_url
</a>
1073 <li><a href=
"#http_build_str">http_build_str
</a>
1075 <li><a href=
"#http_negotiate_language">http_negotiate_language
</a>
1077 <li><a href=
"#http_negotiate_charset">http_negotiate_charset
</a>
1079 <li><a href=
"#http_negotiate_content_type">http_negotiate_content_type
</a>
1081 <li><a href=
"#http_send_status">http_send_status
</a>
1083 <li><a href=
"#http_send_last_modified">http_send_last_modified
</a>
1085 <li><a href=
"#http_send_content_type">http_send_content_type
</a>
1087 <li><a href=
"#http_send_content_disposition">http_send_content_disposition
</a>
1089 <li><a href=
"#http_match_modified">http_match_modified
</a>
1091 <li><a href=
"#http_match_etag">http_match_etag
</a>
1093 <li><a href=
"#http_cache_last_modified">http_cache_last_modified
</a>
1095 <li><a href=
"#http_cache_etag">http_cache_etag
</a>
1097 <li><a href=
"#ob_etaghandler">ob_etaghandler
</a>
1099 <li><a href=
"#http_throttle">http_throttle
</a>
1101 <li><a href=
"#http_redirect">http_redirect
</a>
1103 <li><a href=
"#http_send_data">http_send_data
</a>
1105 <li><a href=
"#http_send_file">http_send_file
</a>
1107 <li><a href=
"#http_send_stream">http_send_stream
</a>
1109 <li><a href=
"#http_chunked_decode">http_chunked_decode
</a>
1111 <li><a href=
"#http_parse_message">http_parse_message
</a>
1113 <li><a href=
"#http_parse_headers">http_parse_headers
</a>
1115 <li><a href=
"#http_parse_cookie">http_parse_cookie
</a>
1117 <li><a href=
"#http_get_request_headers">http_get_request_headers
</a>
1119 <li><a href=
"#http_get_request_body">http_get_request_body
</a>
1121 <li><a href=
"#http_get_request_body_stream">http_get_request_body_stream
</a>
1123 <li><a href=
"#http_match_request_header">http_match_request_header
</a>
1125 <li><a href=
"#http_get">http_get
</a>
1127 <li><a href=
"#http_head">http_head
</a>
1129 <li><a href=
"#http_post_data">http_post_data
</a>
1131 <li><a href=
"#http_post_fields">http_post_fields
</a>
1133 <li><a href=
"#http_put_file">http_put_file
</a>
1135 <li><a href=
"#http_put_stream">http_put_stream
</a>
1137 <li><a href=
"#http_request_method_register">http_request_method_register
</a>
1139 <li><a href=
"#http_request_method_unregister">http_request_method_unregister
</a>
1141 <li><a href=
"#http_request_method_exists">http_request_method_exists
</a>
1143 <li><a href=
"#http_request_method_name">http_request_method_name
</a>
1145 <li><a href=
"#http_deflate">http_deflate
</a>
1147 <li><a href=
"#http_inflate">http_inflate
</a>
1149 <li><a href=
"#ob_deflatehandler">ob_deflatehandler
</a>
1151 <li><a href=
"#ob_inflatehandler">ob_inflatehandler
</a>
1153 <li><a href=
"#http_support">http_support
</a>
1157 <li><a class=
"tocfile" href=
"#http_deflatestream_object.c">http_deflatestream_object.c
</a>
1159 <li><a href=
"#HttpDeflateStream___construct">HttpDeflateStream::__construct()
</a></li>
1160 <li><a href=
"#HttpDeflateStream_update">HttpDeflateStream::update()
</a></li>
1161 <li><a href=
"#HttpDeflateStream_flush">HttpDeflateStream::flush()
</a></li>
1162 <li><a href=
"#HttpDeflateStream_finish">HttpDeflateStream::finish()
</a></li>
1166 <li><a class=
"tocfile" href=
"#http_inflatestream_object.c">http_inflatestream_object.c
</a>
1168 <li><a href=
"#HttpInflateStream_update">HttpInflateStream::update()
</a></li>
1169 <li><a href=
"#HttpInflateStream_flush">HttpInflateStream::flush()
</a></li>
1170 <li><a href=
"#HttpInflateStream_finish">HttpInflateStream::finish()
</a></li>
1174 <li><a class=
"tocfile" href=
"#http_message_object.c">http_message_object.c
</a>
1176 <li><a href=
"#HttpMessage___construct">HttpMessage::__construct()
</a></li>
1177 <li><a href=
"#HttpMessage_fromString">HttpMessage::fromString()
</a></li>
1178 <li><a href=
"#HttpMessage_getBody">HttpMessage::getBody()
</a></li>
1179 <li><a href=
"#HttpMessage_setBody">HttpMessage::setBody()
</a></li>
1180 <li><a href=
"#HttpMessage_getHeaders">HttpMessage::getHeaders()
</a></li>
1181 <li><a href=
"#HttpMessage_setHeaders">HttpMessage::setHeaders()
</a></li>
1182 <li><a href=
"#HttpMessage_addHeaders">HttpMessage::addHeaders()
</a></li>
1183 <li><a href=
"#HttpMessage_getType">HttpMessage::getType()
</a></li>
1184 <li><a href=
"#HttpMessage_setType">HttpMessage::setType()
</a></li>
1185 <li><a href=
"#HttpMessage_getResponseCode">HttpMessage::getResponseCode()
</a></li>
1186 <li><a href=
"#HttpMessage_setResponseCode">HttpMessage::setResponseCode()
</a></li>
1187 <li><a href=
"#HttpMessage_getResponseStatus">HttpMessage::getResponseStatus()
</a></li>
1188 <li><a href=
"#HttpMessage_setResponseStatus">HttpMessage::setResponseStatus()
</a></li>
1189 <li><a href=
"#HttpMessage_getRequestMethod">HttpMessage::getRequestMethod()
</a></li>
1190 <li><a href=
"#HttpMessage_setRequestMethod">HttpMessage::setRequestMethod()
</a></li>
1191 <li><a href=
"#HttpMessage_getRequestUrl">HttpMessage::getRequestUrl()
</a></li>
1192 <li><a href=
"#HttpMessage_setRequestUrl">HttpMessage::setRequestUrl()
</a></li>
1193 <li><a href=
"#HttpMessage_getHttpVersion">HttpMessage::getHttpVersion()
</a></li>
1194 <li><a href=
"#HttpMessage_setHttpVersion">HttpMessage::setHttpVersion()
</a></li>
1195 <li><a href=
"#HttpMessage_getParentMessage">HttpMessage::getParentMessage()
</a></li>
1196 <li><a href=
"#HttpMessage_send">HttpMessage::send()
</a></li>
1197 <li><a href=
"#HttpMessage_toString">HttpMessage::toString()
</a></li>
1198 <li><a href=
"#HttpMessage_toMessageTypeObject">HttpMessage::toMessageTypeObject()
</a></li>
1199 <li><a href=
"#HttpMessage_count">HttpMessage::count()
</a></li>
1200 <li><a href=
"#HttpMessage_serialize">HttpMessage::serialize()
</a></li>
1201 <li><a href=
"#HttpMessage_unserialize">HttpMessage::unserialize()
</a></li>
1202 <li><a href=
"#HttpMessage_detach">HttpMessage::detach()
</a></li>
1203 <li><a href=
"#HttpMessage_prepend">HttpMessage::prepend()
</a></li>
1204 <li><a href=
"#HttpMessage_rewind">HttpMessage::rewind()
</a></li>
1205 <li><a href=
"#HttpMessage_valid">HttpMessage::valid()
</a></li>
1206 <li><a href=
"#HttpMessage_next">HttpMessage::next()
</a></li>
1207 <li><a href=
"#HttpMessage_key">HttpMessage::key()
</a></li>
1208 <li><a href=
"#HttpMessage_current">HttpMessage::current()
</a></li>
1212 <li><a class=
"tocfile" href=
"#http_querystring_object.c">http_querystring_object.c
</a>
1214 <li><a href=
"#HttpQueryString___construct">HttpQueryString::__construct()
</a></li>
1215 <li><a href=
"#HttpQueryString_toString">HttpQueryString::toString()
</a></li>
1216 <li><a href=
"#HttpQueryString_toArray">HttpQueryString::toArray()
</a></li>
1217 <li><a href=
"#HttpQueryString_get">HttpQueryString::get()
</a></li>
1218 <li><a href=
"#HttpQueryString_set">HttpQueryString::set()
</a></li>
1219 <li><a href=
"#HttpQueryString_getInstance">HttpQueryString::getInstance()
</a></li>
1223 <li><a class=
"tocfile" href=
"#http_request_object.c">http_request_object.c
</a>
1225 <li><a href=
"#HttpRequest___construct">HttpRequest::__construct()
</a></li>
1226 <li><a href=
"#HttpRequest_setOptions">HttpRequest::setOptions()
</a></li>
1227 <li><a href=
"#HttpRequest_getOptions">HttpRequest::getOptions()
</a></li>
1228 <li><a href=
"#HttpRequest_setSslOptions">HttpRequest::setSslOptions()
</a></li>
1229 <li><a href=
"#HttpRequest_addSslOptions">HttpRequest::addSslOptions()
</a></li>
1230 <li><a href=
"#HttpRequest_getSslOptions">HttpRequest::getSslOptions()
</a></li>
1231 <li><a href=
"#HttpRequest_addHeaders">HttpRequest::addHeaders()
</a></li>
1232 <li><a href=
"#HttpRequest_setHeaders">HttpRequest::setHeaders()
</a></li>
1233 <li><a href=
"#HttpRequest_getHeaders">HttpRequest::getHeaders()
</a></li>
1234 <li><a href=
"#HttpRequest_setCookies">HttpRequest::setCookies()
</a></li>
1235 <li><a href=
"#HttpRequest_addCookies">HttpRequest::addCookies()
</a></li>
1236 <li><a href=
"#HttpRequest_getCookies">HttpRequest::getCookies()
</a></li>
1237 <li><a href=
"#HttpRequest_setUrl">HttpRequest::setUrl()
</a></li>
1238 <li><a href=
"#HttpRequest_getUrl">HttpRequest::getUrl()
</a></li>
1239 <li><a href=
"#HttpRequest_setMethod">HttpRequest::setMethod()
</a></li>
1240 <li><a href=
"#HttpRequest_getMethod">HttpRequest::getMethod()
</a></li>
1241 <li><a href=
"#HttpRequest_setContentType">HttpRequest::setContentType()
</a></li>
1242 <li><a href=
"#HttpRequest_getContentType">HttpRequest::getContentType()
</a></li>
1243 <li><a href=
"#HttpRequest_setQueryData">HttpRequest::setQueryData()
</a></li>
1244 <li><a href=
"#HttpRequest_getQueryData">HttpRequest::getQueryData()
</a></li>
1245 <li><a href=
"#HttpRequest_addQueryData">HttpRequest::addQueryData()
</a></li>
1246 <li><a href=
"#HttpRequest_addPostFields">HttpRequest::addPostFields()
</a></li>
1247 <li><a href=
"#HttpRequest_setPostFields">HttpRequest::setPostFields()
</a></li>
1248 <li><a href=
"#HttpRequest_getPostFields">HttpRequest::getPostFields()
</a></li>
1249 <li><a href=
"#HttpRequest_setRawPostData">HttpRequest::setRawPostData()
</a></li>
1250 <li><a href=
"#HttpRequest_addRawPostData">HttpRequest::addRawPostData()
</a></li>
1251 <li><a href=
"#HttpRequest_getRawPostData">HttpRequest::getRawPostData()
</a></li>
1252 <li><a href=
"#HttpRequest_addPostFile">HttpRequest::addPostFile()
</a></li>
1253 <li><a href=
"#HttpRequest_setPostFiles">HttpRequest::setPostFiles()
</a></li>
1254 <li><a href=
"#HttpRequest_getPostFiles">HttpRequest::getPostFiles()
</a></li>
1255 <li><a href=
"#HttpRequest_setPutFile">HttpRequest::setPutFile()
</a></li>
1256 <li><a href=
"#HttpRequest_getPutFile">HttpRequest::getPutFile()
</a></li>
1257 <li><a href=
"#HttpRequest_getResponseData">HttpRequest::getResponseData()
</a></li>
1258 <li><a href=
"#HttpRequest_getResponseHeader">HttpRequest::getResponseHeader()
</a></li>
1259 <li><a href=
"#HttpRequest_getResponseCookie">HttpRequest::getResponseCookie()
</a></li>
1260 <li><a href=
"#HttpRequest_getResponseBody">HttpRequest::getResponseBody()
</a></li>
1261 <li><a href=
"#HttpRequest_getResponseCode">HttpRequest::getResponseCode()
</a></li>
1262 <li><a href=
"#HttpRequest_getResponseStatus">HttpRequest::getResponseStatus()
</a></li>
1263 <li><a href=
"#HttpRequest_getResponseInfo">HttpRequest::getResponseInfo()
</a></li>
1264 <li><a href=
"#HttpRequest_getResponseMessage">HttpRequest::getResponseMessage()
</a></li>
1265 <li><a href=
"#HttpRequest_getRequestMessage">HttpRequest::getRequestMessage()
</a></li>
1266 <li><a href=
"#HttpRequest_getRawRequestMessage">HttpRequest::getRawRequestMessage()
</a></li>
1267 <li><a href=
"#HttpRequest_getRawResponseMessage">HttpRequest::getRawResponseMessage()
</a></li>
1268 <li><a href=
"#HttpRequest_getHistory">HttpRequest::getHistory()
</a></li>
1269 <li><a href=
"#HttpRequest_clearHistory">HttpRequest::clearHistory()
</a></li>
1270 <li><a href=
"#HttpRequest_send">HttpRequest::send()
</a></li>
1274 <li><a class=
"tocfile" href=
"#http_requestpool_object.c">http_requestpool_object.c
</a>
1276 <li><a href=
"#HttpRequestPool___construct">HttpRequestPool::__construct()
</a></li>
1277 <li><a href=
"#HttpRequestPool___destruct">HttpRequestPool::__destruct()
</a></li>
1278 <li><a href=
"#HttpRequestPool_reset">HttpRequestPool::reset()
</a></li>
1279 <li><a href=
"#HttpRequestPool_attach">HttpRequestPool::attach()
</a></li>
1280 <li><a href=
"#HttpRequestPool_detach">HttpRequestPool::detach()
</a></li>
1281 <li><a href=
"#HttpRequestPool_send">HttpRequestPool::send()
</a></li>
1282 <li><a href=
"#HttpRequestPool_socketPerform">HttpRequestPool::socketPerform()
</a></li>
1283 <li><a href=
"#HttpRequestPool_socketSelect">HttpRequestPool::socketSelect()
</a></li>
1284 <li><a href=
"#HttpRequestPool_valid">HttpRequestPool::valid()
</a></li>
1285 <li><a href=
"#HttpRequestPool_current">HttpRequestPool::current()
</a></li>
1286 <li><a href=
"#HttpRequestPool_key">HttpRequestPool::key()
</a></li>
1287 <li><a href=
"#HttpRequestPool_next">HttpRequestPool::next()
</a></li>
1288 <li><a href=
"#HttpRequestPool_rewind">HttpRequestPool::rewind()
</a></li>
1289 <li><a href=
"#HttpRequestPool_count">HttpRequestPool::count()
</a></li>
1290 <li><a href=
"#HttpRequestPool_getAttachedRequests">HttpRequestPool::getAttachedRequests()
</a></li>
1291 <li><a href=
"#HttpRequestPool_getFinishedRequests">HttpRequestPool::getFinishedRequests()
</a></li>
1295 <li><a class=
"tocfile" href=
"#http_response_object.c">http_response_object.c
</a>
1297 <li><a href=
"#HttpResponse_setHeader">HttpResponse::setHeader()
</a></li>
1298 <li><a href=
"#HttpResponse_getHeader">HttpResponse::getHeader()
</a></li>
1299 <li><a href=
"#HttpResponse_setCache">HttpResponse::setCache()
</a></li>
1300 <li><a href=
"#HttpResponse_getCache">HttpResponse::getCache()
</a></li>
1301 <li><a href=
"#HttpResponse_setGzip">HttpResponse::setGzip()
</a></li>
1302 <li><a href=
"#HttpResponse_getGzip">HttpResponse::getGzip()
</a></li>
1303 <li><a href=
"#HttpResponse_setCacheControl">HttpResponse::setCacheControl()
</a></li>
1304 <li><a href=
"#HttpResponse_getCacheControl">HttpResponse::getCacheControl()
</a></li>
1305 <li><a href=
"#HttpResponse_setContentType">HttpResponse::setContentType()
</a></li>
1306 <li><a href=
"#HttpResponse_getContentType">HttpResponse::getContentType()
</a></li>
1307 <li><a href=
"#HttpResponse_guessContentType">HttpResponse::guessContentType()
</a></li>
1308 <li><a href=
"#HttpResponse_setContentDisposition">HttpResponse::setContentDisposition()
</a></li>
1309 <li><a href=
"#HttpResponse_getContentDisposition">HttpResponse::getContentDisposition()
</a></li>
1310 <li><a href=
"#HttpResponse_setETag">HttpResponse::setETag()
</a></li>
1311 <li><a href=
"#HttpResponse_getETag">HttpResponse::getETag()
</a></li>
1312 <li><a href=
"#HttpResponse_setLastModified">HttpResponse::setLastModified()
</a></li>
1313 <li><a href=
"#HttpResponse_getLastModified">HttpResponse::getLastModified()
</a></li>
1314 <li><a href=
"#HttpResponse_setThrottleDelay">HttpResponse::setThrottleDelay()
</a></li>
1315 <li><a href=
"#HttpResponse_getThrottleDelay">HttpResponse::getThrottleDelay()
</a></li>
1316 <li><a href=
"#HttpResponse_setBufferSize">HttpResponse::setBufferSize()
</a></li>
1317 <li><a href=
"#HttpResponse_getBufferSize">HttpResponse::getBufferSize()
</a></li>
1318 <li><a href=
"#HttpResponse_setData">HttpResponse::setData()
</a></li>
1319 <li><a href=
"#HttpResponse_getData">HttpResponse::getData()
</a></li>
1320 <li><a href=
"#HttpResponse_setStream">HttpResponse::setStream()
</a></li>
1321 <li><a href=
"#HttpResponse_getStream">HttpResponse::getStream()
</a></li>
1322 <li><a href=
"#HttpResponse_setFile">HttpResponse::setFile()
</a></li>
1323 <li><a href=
"#HttpResponse_getFile">HttpResponse::getFile()
</a></li>
1324 <li><a href=
"#HttpResponse_send">HttpResponse::send()
</a></li>
1325 <li><a href=
"#HttpResponse_capture">HttpResponse::capture()
</a></li>
1331 <p><b>Generated at: Mon,
06 Feb
2006 13:
45:
38 +
0100</b></p>
projects / m6w6 / ext-http / blob