<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>The HttpResponse</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="httprequestpool.socketselect.html">HttpRequestPool::socketSelect</a></div>
<div class="next" style="text-align: right; float: right;"><a href="httpresponse.capture.html">HttpResponse::capture</a></div>
<div class="up"><a href="book.http.html">HTTP</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.httpresponse" class="reference">
<h1 class="title">The <a href="class.httpresponse.html" class="classname">HttpResponse</a></h1>
<div class="partintro"><p class="verinfo">(PECL pecl_http >= 0.7.0)</p>
<div class="section" id="httpresponse.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass"><strong class="classname">HttpResponse</strong></span>
{</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">void</span> <span class="methodname"><a href="httpresponse.capture.html" class="methodname">capture</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">int</span> <span class="methodname"><a href="httpresponse.getbuffersize.html" class="methodname">getBufferSize</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">bool</span> <span class="methodname"><a href="httpresponse.getcache.html" class="methodname">getCache</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">string</span> <span class="methodname"><a href="httpresponse.getcachecontrol.html" class="methodname">getCacheControl</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">string</span> <span class="methodname"><a href="httpresponse.getcontentdisposition.html" class="methodname">getContentDisposition</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">string</span> <span class="methodname"><a href="httpresponse.getcontenttype.html" class="methodname">getContentType</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">string</span> <span class="methodname"><a href="httpresponse.getdata.html" class="methodname">getData</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">string</span> <span class="methodname"><a href="httpresponse.getetag.html" class="methodname">getETag</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">string</span> <span class="methodname"><a href="httpresponse.getfile.html" class="methodname">getFile</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">bool</span> <span class="methodname"><a href="httpresponse.getgzip.html" class="methodname">getGzip</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">mixed</span> <span class="methodname"><a href="httpresponse.getheader.html" class="methodname">getHeader</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">int</span> <span class="methodname"><a href="httpresponse.getlastmodified.html" class="methodname">getLastModified</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">string</span> <span class="methodname"><a href="httpresponse.getrequestbody.html" class="methodname">getRequestBody</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">resource</span> <span class="methodname"><a href="httpresponse.getrequestbodystream.html" class="methodname">getRequestBodyStream</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">array</span> <span class="methodname"><a href="httpresponse.getrequestheaders.html" class="methodname">getRequestHeaders</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">resource</span> <span class="methodname"><a href="httpresponse.getstream.html" class="methodname">getStream</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">float</span> <span class="methodname"><a href="httpresponse.getthrottledelay.html" class="methodname">getThrottleDelay</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">string</span> <span class="methodname"><a href="httpresponse.guesscontenttype.html" class="methodname">guessContentType</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$magic_file</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$magic_mode</code><span class="initializer"> = MAGIC_MIME</span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">void</span> <span class="methodname"><a href="httpresponse.redirect.html" class="methodname">redirect</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$url</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$params</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$session</code><span class="initializer"> = false</span></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$status</code></span>
]]]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">bool</span> <span class="methodname"><a href="httpresponse.send.html" class="methodname">send</a></span>
([ <span class="methodparam"><span class="type">bool</span> <code class="parameter">$clean_ob</code><span class="initializer"> = true</span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">bool</span> <span class="methodname"><a href="httpresponse.setbuffersize.html" class="methodname">setBufferSize</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$bytes</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">bool</span> <span class="methodname"><a href="httpresponse.setcache.html" class="methodname">setCache</a></span>
( <span class="methodparam"><span class="type">bool</span> <code class="parameter">$cache</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">bool</span> <span class="methodname"><a href="httpresponse.setcachecontrol.html" class="methodname">setCacheControl</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$control</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$max_age</code><span class="initializer"> = 0</span></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$must_revalidate</code><span class="initializer"> = true</span></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">bool</span> <span class="methodname"><a href="httpresponse.setcontentdisposition.html" class="methodname">setContentDisposition</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$filename</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$inline</code><span class="initializer"> = false</span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">bool</span> <span class="methodname"><a href="httpresponse.setcontenttype.html" class="methodname">setContentType</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$content_type</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">bool</span> <span class="methodname"><a href="httpresponse.setdata.html" class="methodname">setData</a></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$data</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">bool</span> <span class="methodname"><a href="httpresponse.setetag.html" class="methodname">setETag</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$etag</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">bool</span> <span class="methodname"><a href="httpresponse.setfile.html" class="methodname">setFile</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$file</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">bool</span> <span class="methodname"><a href="httpresponse.setgzip.html" class="methodname">setGzip</a></span>
( <span class="methodparam"><span class="type">bool</span> <code class="parameter">$gzip</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">bool</span> <span class="methodname"><a href="httpresponse.setheader.html" class="methodname">setHeader</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$value</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$replace</code><span class="initializer"> = true</span></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">bool</span> <span class="methodname"><a href="httpresponse.setlastmodified.html" class="methodname">setLastModified</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$timestamp</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">bool</span> <span class="methodname"><a href="httpresponse.setstream.html" class="methodname">setStream</a></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$stream</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">bool</span> <span class="methodname"><a href="httpresponse.setthrottledelay.html" class="methodname">setThrottleDelay</a></span>
( <span class="methodparam"><span class="type">float</span> <code class="parameter">$seconds</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static</span>
<span class="type">bool</span> <span class="methodname"><a href="httpresponse.status.html" class="methodname">status</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$status</code></span>
)</div>
}</div>
</div>
<div class="section" id="http.httpresponse.members">
<h2 class="title">Class Members</h2>
<div class="section" id="http.httpresponse.properties">
<h2 class="title">Properties</h2>
<table id="http.httpresponse.properties.static" class="doctable table">
<caption><strong>Static Properties</strong></caption>
<thead>
<tr>
<th>Modifiers</th>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>protected</td>
<td>boolean</td>
<td>cache</td>
<td>whether caching the response should be attempted</td>
</tr>
<tr>
<td>protected</td>
<td>boolean</td>
<td>gzip</td>
<td>whether the sent entity should be gzip'ed on the fly</td>
</tr>
<tr>
<td>protected</td>
<td>string</td>
<td>eTag</td>
<td>the generated or custom ETag</td>
</tr>
<tr>
<td>protected</td>
<td>integer</td>
<td>lastModified</td>
<td>the generated or custom timestamp of last modification</td>
</tr>
<tr>
<td>protected</td>
<td>string</td>
<td>cacheControl</td>
<td><em>Cache-Control</em> setting</td>
</tr>
<tr>
<td>protected</td>
<td>string</td>
<td>contentType</td>
<td>the <em>Content-Type</em> of the sent entity</td>
</tr>
<tr>
<td>protected</td>
<td>string</td>
<td>contentDisposition</td>
<td>the <em>Content-Disposition</em> of the sent entity</td>
</tr>
<tr>
<td>protected</td>
<td>integer</td>
<td>bufferSize</td>
<td>the chunk buffer size used for throttling</td>
</tr>
<tr>
<td>protected</td>
<td>double</td>
<td>throttleDelay</td>
<td>the seconds to delay when throttling</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="http.httpresponse.constants">
<h2 class="title">Predefined Constants</h2>
<table class="doctable table">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>integer</td>
<td>REDIRECT</td>
<td>guess applicable redirect method</td>
</tr>
<tr>
<td>integer</td>
<td>REDIRECT_PERM</td>
<td>permanent redirect (<em>301 Moved permanently</em>)</td>
</tr>
<tr>
<td>integer</td>
<td>REDIRECT_FOUND</td>
<td>standard redirect (<em>302 Found</em>)</td>
</tr>
<tr>
<td>integer</td>
<td>REDIRECT_POST</td>
<td>redirect applicable to POST requests (<em>303 See other</em>)</td>
</tr>
<tr>
<td>integer</td>
<td>REDIRECT_PROXY</td>
<td>proxy redirect (<em>305 Use proxy</em>)</td>
</tr>
<tr>
<td>integer</td>
<td>REDIRECT_TEMP</td>
<td>temporary redirect (<em>307 Temporary Redirect</em>)</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="httpresponse.capture.html">HttpResponse::capture</a> — Capture script output</li><li><a href="httpresponse.getbuffersize.html">HttpResponse::getBufferSize</a> — Get buffer size</li><li><a href="httpresponse.getcache.html">HttpResponse::getCache</a> — Get cache</li><li><a href="httpresponse.getcachecontrol.html">HttpResponse::getCacheControl</a> — Get cache control</li><li><a href="httpresponse.getcontentdisposition.html">HttpResponse::getContentDisposition</a> — Get content disposition</li><li><a href="httpresponse.getcontenttype.html">HttpResponse::getContentType</a> — Get content type</li><li><a href="httpresponse.getdata.html">HttpResponse::getData</a> — Get data</li><li><a href="httpresponse.getetag.html">HttpResponse::getETag</a> — Get ETag</li><li><a href="httpresponse.getfile.html">HttpResponse::getFile</a> — Get file</li><li><a href="httpresponse.getgzip.html">HttpResponse::getGzip</a> — Get gzip</li><li><a href="httpresponse.getheader.html">HttpResponse::getHeader</a> — Get header</li><li><a href="httpresponse.getlastmodified.html">HttpResponse::getLastModified</a> — Get last modified</li><li><a href="httpresponse.getrequestbody.html">HttpResponse::getRequestBody</a> — Get request body</li><li><a href="httpresponse.getrequestbodystream.html">HttpResponse::getRequestBodyStream</a> — Get request body stream</li><li><a href="httpresponse.getrequestheaders.html">HttpResponse::getRequestHeaders</a> — Get request headers</li><li><a href="httpresponse.getstream.html">HttpResponse::getStream</a> — Get Stream</li><li><a href="httpresponse.getthrottledelay.html">HttpResponse::getThrottleDelay</a> — Get throttle delay</li><li><a href="httpresponse.guesscontenttype.html">HttpResponse::guessContentType</a> — Guess content type</li><li><a href="httpresponse.redirect.html">HttpResponse::redirect</a> — Redirect</li><li><a href="httpresponse.send.html">HttpResponse::send</a> — Send response</li><li><a href="httpresponse.setbuffersize.html">HttpResponse::setBufferSize</a> — Set buffer size</li><li><a href="httpresponse.setcache.html">HttpResponse::setCache</a> — Set cache</li><li><a href="httpresponse.setcachecontrol.html">HttpResponse::setCacheControl</a> — Set cache control</li><li><a href="httpresponse.setcontentdisposition.html">HttpResponse::setContentDisposition</a> — Set content disposition</li><li><a href="httpresponse.setcontenttype.html">HttpResponse::setContentType</a> — Set content type</li><li><a href="httpresponse.setdata.html">HttpResponse::setData</a> — Set data</li><li><a href="httpresponse.setetag.html">HttpResponse::setETag</a> — Set ETag</li><li><a href="httpresponse.setfile.html">HttpResponse::setFile</a> — Set file</li><li><a href="httpresponse.setgzip.html">HttpResponse::setGzip</a> — Set gzip</li><li><a href="httpresponse.setheader.html">HttpResponse::setHeader</a> — Set header</li><li><a href="httpresponse.setlastmodified.html">HttpResponse::setLastModified</a> — Set last modified</li><li><a href="httpresponse.setstream.html">HttpResponse::setStream</a> — Set stream</li><li><a href="httpresponse.setthrottledelay.html">HttpResponse::setThrottleDelay</a> — Set throttle delay</li><li><a href="httpresponse.status.html">HttpResponse::status</a> — Send HTTP response status</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="httprequestpool.socketselect.html">HttpRequestPool::socketSelect</a></div>
<div class="next" style="text-align: right; float: right;"><a href="httpresponse.capture.html">HttpResponse::capture</a></div>
<div class="up"><a href="book.http.html">HTTP</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
