-Content-type: text/html
-X-Powered-By: PHP/5.0.1
-
<html>
<head>
<title>Function Summary of ext/http</title>
<p>Generates a form-encoded query string from an associative array or object.</p>
<hr noshade>
<h1>http_methods.c</h1>
-<h2 id="HTTPi_Response___construct">void HTTPi_Response::__construct(bool cache, bool gzip)</h2>
-<p>Instantiates a new HTTPi_Response object, which can be used to send<br />
+<h2 id="HttpResponse___construct">void HttpResponse::__construct(bool cache, bool gzip)</h2>
+<p>Instantiates a new HttpResponse object, which can be used to send<br />
any data/resource/file to an HTTP client with caching and multiple<br />
ranges/resuming support.<br />
<br />
NOTE: GZIPping is not implemented yet.</p>
-<h2 id="HTTPi_Response_setCache">bool HTTPi_Response::setCache(bool cache)</h2>
+<h2 id="HttpResponse_setCache">bool HttpResponse::setCache(bool cache)</h2>
<p>Whether it sould be attempted to cache the entitity.<br />
This will result in necessary caching headers and checks of clients<br />
"If-Modified-Since" and "If-None-Match" headers. If one of those headers<br />
<br />
NOTE: If you're using sessions, be shure that you set session.cache_limiter<br />
to something more appropriate than "no-cache"!</p>
-<h2 id="HTTPi_Response_getCache">bool HTTPi_Response::getCache()</h2>
+<h2 id="HttpResponse_getCache">bool HttpResponse::getCache()</h2>
<p>Get current caching setting.</p>
-<h2 id="HTTPi_Response_setGzip">bool HTTPi_Response::setGzip(bool gzip)</h2>
+<h2 id="HttpResponse_setGzip">bool HttpResponse::setGzip(bool gzip)</h2>
<p>Enable on-thy-fly gzipping of the sent entity. NOT IMPLEMENTED YET.</p>
-<h2 id="HTTPi_Response_getGzip">bool HTTPi_Response::getGzip()</h2>
+<h2 id="HttpResponse_getGzip">bool HttpResponse::getGzip()</h2>
<p>Get current gzipping setting.</p>
-<h2 id="HTTPi_Response_setCacheControl">bool HTTPi_Response::setCacheControl(string control[, bool raw = false])</h2>
+<h2 id="HttpResponse_setCacheControl">bool HttpResponse::setCacheControl(string control[, bool raw = false])</h2>
<p>Set a custom cache-control header, usually being "private" or "public"; if<br />
$raw is set to true the header will be sent as-is.</p>
-<h2 id="HTTPi_Response_getCacheControl">string HTTPi_Response::getCacheControl()</h2>
+<h2 id="HttpResponse_getCacheControl">string HttpResponse::getCacheControl()</h2>
<p>Get current Cache-Control header setting.</p>
-<h2 id="HTTPi_Response_setContentType">bool HTTPi_Response::setContentType(string content_type)</h2>
+<h2 id="HttpResponse_setContentType">bool HttpResponse::setContentType(string content_type)</h2>
<p>Set the content-type of the sent entity.</p>
-<h2 id="HTTPi_Response_getContentType">string HTTPi_Response::getContentType()</h2>
+<h2 id="HttpResponse_getContentType">string HttpResponse::getContentType()</h2>
<p>Get current Content-Type header setting.</p>
-<h2 id="HTTPi_Response_setContentDisposition">bool HTTPi_Response::setContentDisposition(string filename[, bool inline = false])</h2>
+<h2 id="HttpResponse_setContentDisposition">bool HttpResponse::setContentDisposition(string filename[, bool inline = false])</h2>
<p>Set the Content-Disposition of the sent entity. This setting aims to suggest<br />
the receiveing user agent how to handle the sent entity; usually the client<br />
will show the user a "Save As..." popup.</p>
-<h2 id="HTTPi_Response_getContentDisposition">array HTTPi_Response::getContentDisposition()</h2>
+<h2 id="HttpResponse_getContentDisposition">array HttpResponse::getContentDisposition()</h2>
<p>Get current Content-Disposition setting.<br />
Will return an associative array like:</p><pre>array(<br />
'filename' => 'foo.bar',<br />
'inline' => false<br />
)<br />
</pre></p>
-<h2 id="HTTPi_Response_setETag">bool HTTPi_Response::setETag(string etag)</h2>
+<h2 id="HttpResponse_setETag">bool HttpResponse::setETag(string etag)</h2>
<p>Set a custom ETag. Use this only if you know what you're doing.</p>
-<h2 id="HTTPi_Response_getETag">string HTTPi_Response::getETag()</h2>
+<h2 id="HttpResponse_getETag">string HttpResponse::getETag()</h2>
<p>Get the previously set custom ETag.</p>
-<h2 id="HTTPi_Response_setData">bool HTTPi_Response::setData(string data)</h2>
+<h2 id="HttpResponse_setData">bool HttpResponse::setData(string data)</h2>
<p>Set the data to be sent.</p>
-<h2 id="HTTPi_Response_getData">string HTTPi_Response::getData()</h2>
+<h2 id="HttpResponse_getData">string HttpResponse::getData()</h2>
<p>Get the previously set data to be sent.</p>
-<h2 id="HTTPi_Response_setStream">bool HTTPi_Response::setStream(resource stream)</h2>
+<h2 id="HttpResponse_setStream">bool HttpResponse::setStream(resource stream)</h2>
<p>Set the resource to be sent.</p>
-<h2 id="HTTPi_Response_getStream">resource HTTPi_Response::getStream()</h2>
+<h2 id="HttpResponse_getStream">resource HttpResponse::getStream()</h2>
<p>Get the previously set resource to be sent.</p>
-<h2 id="HTTPi_Response_setFile">bool HTTPi_Response::setFile(string file)</h2>
+<h2 id="HttpResponse_setFile">bool HttpResponse::setFile(string file)</h2>
<p>Set the file to be sent.</p>
-<h2 id="HTTPi_Response_getFile">string HTTPi_Response::getFile()</h2>
+<h2 id="HttpResponse_getFile">string HttpResponse::getFile()</h2>
<p>Get the previously set file to be sent.</p>
-<h2 id="HTTPi_Response_send">bool HTTPi_Response::send()</h2>
+<h2 id="HttpResponse_send">bool HttpResponse::send()</h2>
<p>Finally send the entity.<br />
<br />
Example:</p><pre><blockquote><code><span style="color: #000000"><br />
-<span style="color: #0000BB"><?php<br />$r </span><span style="color: #007700">= new </span><span style="color: #0000BB">HTTPi_Response</span><span style="color: #007700">(</span><span style="color: #0000BB">true</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$r</span><span style="color: #007700">-></span><span style="color: #0000BB">setFile</span><span style="color: #007700">(</span><span style="color: #DD0000">'../hidden/contract.pdf'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$r</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">$r</span><span style="color: #007700">-></span><span style="color: #0000BB">send</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?></span><br />
+<span style="color: #0000BB"><?php<br />$r </span><span style="color: #007700">= new </span><span style="color: #0000BB">HttpResponse</span><span style="color: #007700">(</span><span style="color: #0000BB">true</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$r</span><span style="color: #007700">-></span><span style="color: #0000BB">setFile</span><span style="color: #007700">(</span><span style="color: #DD0000">'../hidden/contract.pdf'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$r</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">$r</span><span style="color: #007700">-></span><span style="color: #0000BB">send</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?></span><br />
</span><br />
</code></blockquote><br />
<br />
</pre></p>
-<h2 id="HTTPi_Request___construct">void HTTPi_Request::__construct([string url[, long request_method = HTTP_GET]])</h2>
-<p>Instantiate a new HTTPi_Request object which can be used to issue HEAD, GET<br />
+<h2 id="HttpRequest___construct">void HttpRequest::__construct([string url[, long request_method = HTTP_GET]])</h2>
+<p>Instantiate a new HttpRequest object which can be used to issue HEAD, GET<br />
and POST (including posting files) HTTP requests.</p>
-<h2 id="HTTPi_Request___destruct">void HTTPi_Request::__destruct()</h2>
-<p>Destroys the HTTPi_Request object.</p>
-<h2 id="HTTPi_Request_setOptions">bool HTTPi_Request::setOptions(array options)</h2>
+<h2 id="HttpRequest___destruct">void HttpRequest::__destruct()</h2>
+<p>Destroys the HttpRequest object.</p>
+<h2 id="HttpRequest_setOptions">bool HttpRequest::setOptions(array options)</h2>
<p>Set the request options to use. See http_get() for a full list of available options.</p>
-<h2 id="HTTPi_Request_getOptions">array HTTPi_Request::getOptions()</h2>
+<h2 id="HttpRequest_getOptions">array HttpRequest::getOptions()</h2>
<p>Get current set options.</p>
-<h2 id="HTTPi_Request_setURL">bool HTTPi_Request::setURL(string url)</h2>
+<h2 id="HttpRequest_unsetOptions">void HttpRequest::unsetOptions()</h2>
+<p>Unset all options/headers/cookies.</p>
+<h2 id="HttpRequest_addHeader">bool HttpRequest::addHeader(array header)</h2>
+<p>Add (a) request header name/value pair(s).</p>
+<h2 id="HttpRequest_addCookie">bool HttpRequest::addCookie(array cookie)</h2>
+<p>Add (a) cookie(s).</p>
+<h2 id="HttpRequest_setURL">bool HttpRequest::setURL(string url)</h2>
<p>Set the request URL.</p>
-<h2 id="HTTPi_Request_getURL">string HTTPi_Request::getUrl()</h2>
+<h2 id="HttpRequest_getURL">string HttpRequest::getUrl()</h2>
<p>Get the previously set request URL.</p>
-<h2 id="HTTPi_Request_setMethod">bool HTTPi_Request::setMethod(long request_method)</h2>
+<h2 id="HttpRequest_setMethod">bool HttpRequest::setMethod(long request_method)</h2>
<p>Set the request methods; one of the <tt>HTTP_HEAD</tt>, <tt>HTTP_GET</tt> or<br />
<tt>HTTP_POST</tt> constants.</p>
-<h2 id="HTTPi_Request_getMethod">long HTTPi_Request::getMethod()</h2>
+<h2 id="HttpRequest_getMethod">long HttpRequest::getMethod()</h2>
<p>Get the previously set request method.</p>
-<h2 id="HTTPi_Request_setContentType">bool HTTPi_Request::setContentType(string content_type)</h2>
+<h2 id="HttpRequest_setContentType">bool HttpRequest::setContentType(string content_type)</h2>
<p>Set the content type the post request should have.<br />
Use this only if you know what you're doing.</p>
-<h2 id="HTTPi_Request_getContentType">string HTTPi_Request::getContentType()</h2>
+<h2 id="HttpRequest_getContentType">string HttpRequest::getContentType()</h2>
<p>Get the previously content type.</p>
-<h2 id="HTTPi_Request_setQueryData">bool HTTPi_Request::setQueryData(mixed query_data)</h2>
+<h2 id="HttpRequest_setQueryData">bool HttpRequest::setQueryData(mixed query_data)</h2>
<p>Set the URL query parameters to use.<br />
Overwrites previously set query parameters.<br />
Affects any request types.</p>
-<h2 id="HTTPi_Request_getQueryData">string HTTPi_Request::getQueryData()</h2>
+<h2 id="HttpRequest_getQueryData">string HttpRequest::getQueryData()</h2>
<p>Get the current query data in form of an urlencoded query string.</p>
-<h2 id="HTTPi_Request_addQueryData">bool HTTPi_Request::addQueryData(array query_params)</h2>
+<h2 id="HttpRequest_addQueryData">bool HttpRequest::addQueryData(array query_params)</h2>
<p>Add parameters to the query parameter list.<br />
Affects any request type.</p>
-<h2 id="HTTPi_Request_unsetQueryData">void HTTPi_Request::unsetQueryData()</h2>
+<h2 id="HttpRequest_unsetQueryData">void HttpRequest::unsetQueryData()</h2>
<p>Clean the query parameters.<br />
Affects any request type.</p>
-<h2 id="HTTPi_Request_addPostData">bool HTTPi_Request::addPostData(array post_data)</h2>
+<h2 id="HttpRequest_addPostData">bool HttpRequest::addPostData(array post_data)</h2>
<p>Adds POST data entries.<br />
Affects only POST requests.</p>
-<h2 id="HTTPi_Request_setPostData">bool HTTPi_Request::setPostData(array post_data)</h2>
+<h2 id="HttpRequest_setPostData">bool HttpRequest::setPostData(array post_data)</h2>
<p>Set the POST data entries.<br />
Overwrites previously set POST data.<br />
Affects only POST requests.</p>
-<h2 id="HTTPi_Request_getPostData">array HTTPi_Request::getPostData()</h2>
+<h2 id="HttpRequest_getPostData">array HttpRequest::getPostData()</h2>
<p>Get previously set POST data.</p>
-<h2 id="HTTPi_Request_unsetPostData">void HTTPi_Request::unsetPostData()</h2>
+<h2 id="HttpRequest_unsetPostData">void HttpRequest::unsetPostData()</h2>
<p>Clean POST data entires.<br />
Affects only POST requests.</p>
-<h2 id="HTTPi_Request_addPostFile">bool HTTPi_Request::addPostFile(string name, string file[, string content_type = "application/x-octetstream"])</h2>
+<h2 id="HttpRequest_addPostFile">bool HttpRequest::addPostFile(string name, string file[, string content_type = "application/x-octetstream"])</h2>
<p>Add a file to the POST request.<br />
Affects only POST requests.</p>
-<h2 id="HTTPi_Request_getPostFiles">array HTTPi_Request::getPostFiles()</h2>
+<h2 id="HttpRequest_getPostFiles">array HttpRequest::getPostFiles()</h2>
<p>Get all previously added POST files.</p>
-<h2 id="HTTPi_Request_unsetPostFiles">void HTTPi_Request::unsetPostFiles()</h2>
+<h2 id="HttpRequest_unsetPostFiles">void HttpRequest::unsetPostFiles()</h2>
<p>Unset the POST files list.<br />
Affects only POST requests.</p>
-<h2 id="HTTPi_Request_getResponseData">array HTTPi_Request::getResponseData()</h2>
+<h2 id="HttpRequest_getResponseData">array HttpRequest::getResponseData()</h2>
<p>Get all response data after the request has been sent.</p>
-<h2 id="HTTPi_Request_getResponseHeader">string HTTPi_Request::getResponseHeader([string name])</h2>
+<h2 id="HttpRequest_getResponseHeader">string HttpRequest::getResponseHeader([string name])</h2>
<p>Get response header(s) after the request has been sent.</p>
-<h2 id="HTTPi_Request_getResponseBody">string HTTPi_Request::getResponseBody()</h2>
+<h2 id="HttpRequest_getResponseBody">string HttpRequest::getResponseBody()</h2>
<p>Get the response body after the request has been sent.</p>
-<h2 id="HTTPi_Request_getResponseCode">int HTTPi_Request::getResponseCode()</h2>
+<h2 id="HttpRequest_getResponseCode">int HttpRequest::getResponseCode()</h2>
<p>Get the response code after the request has been sent.</p>
-<h2 id="HTTPi_Request_getResponseInfo">array HTTPi_Request::getResponseInfo([string name])</h2>
+<h2 id="HttpRequest_getResponseInfo">array HttpRequest::getResponseInfo([string name])</h2>
<p>Get response info after the request has been sent.<br />
See http_get() for a full list of returned info.</p>
-<h2 id="HTTPi_Request_send">bool HTTPi_Request::send()</h2>
+<h2 id="HttpRequest_send">bool HttpRequest::send()</h2>
<p>Send the HTTP request.<br />
<br />
GET example:</p><pre><blockquote><code><span style="color: #000000"><br />
-<span style="color: #0000BB"><?php<br />$r </span><span style="color: #007700">= new </span><span style="color: #0000BB">HTTPi_Request</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">HTTP_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 />if (</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">$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 /></span><span style="color: #0000BB">?></span><br />
+<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">HTTP_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 />if (</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">$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 /></span><span style="color: #0000BB">?></span><br />
</span><br />
</code></blockquote></pre><p>POST example:</p><pre><blockquote><code><span style="color: #000000"><br />
-<span style="color: #0000BB"><?php<br />$r </span><span style="color: #007700">= new </span><span style="color: #0000BB">HTTPi_Request</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">HTTP_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">addPostData</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 />if (</span><span style="color: #0000BB">$r</span><span style="color: #007700">-></span><span style="color: #0000BB">send</span><span style="color: #007700">()) {<br /> echo </span><span style="color: #0000BB">$r</span><span style="color: #007700">-></span><span style="color: #0000BB">getResponseBody</span><span style="color: #007700">();<br />}<br /></span><span style="color: #0000BB">?></span><br />
+<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">HTTP_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">addPostData</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 />if (</span><span style="color: #0000BB">$r</span><span style="color: #007700">-></span><span style="color: #0000BB">send</span><span style="color: #007700">()) {<br /> echo </span><span style="color: #0000BB">$r</span><span style="color: #007700">-></span><span style="color: #0000BB">getResponseBody</span><span style="color: #007700">();<br />}<br /></span><span style="color: #0000BB">?></span><br />
</span><br />
</code></blockquote><br />
<br />
</pre></p>
<hr noshade>
- <p><b>Generated at: Mon, 7 Mar 2005 14:09:33 +0100</b></p>
+ <p><b>Generated at: Tue, 22 Mar 2005 15:41:10 +0100</b></p>
</body>
</html>
projects / m6w6 / ext-http / commitdiff
