Edit Report a Bug

The HttpResponse

(PECL pecl_http >= 0.7.0)

Class synopsis

HttpResponse {

static void capture ( void )

static int getBufferSize ( void )

static bool getCache ( void )

static string getCacheControl ( void )

static string getContentDisposition ( void )

static string getContentType ( void )

static string getData ( void )

static string getETag ( void )

static string getFile ( void )

static bool getGzip ( void )

static mixed getHeader ([ string $name ] )

static int getLastModified ( void )

static string getRequestBody ( void )

static resource getRequestBodyStream ( void )

static array getRequestHeaders ( void )

static resource getStream ( void )

static float getThrottleDelay ( void )

static string guessContentType ( string $magic_file [, int $magic_mode = MAGIC_MIME ] )

static void redirect ([ string $url [, array $params [, bool $session = false [, int $status ]]]] )

static bool send ([ bool $clean_ob = true ] )

static bool setBufferSize ( int $bytes )

static bool setCache ( bool $cache )

static bool setCacheControl ( string $control [, int $max_age = 0 [, bool $must_revalidate = true ]] )

static bool setContentDisposition ( string $filename [, bool $inline = false ] )

static bool setContentType ( string $content_type )

static bool setData ( mixed $data )

static bool setETag ( string $etag )

static bool setFile ( string $file )

static bool setGzip ( bool $gzip )

static bool setHeader ( string $name [, mixed $value [, bool $replace = true ]] )

static bool setLastModified ( int $timestamp )

static bool setStream ( resource $stream )

static bool setThrottleDelay ( float $seconds )

static bool status ( int $status )

}

Class Members

Properties

**Static Properties**
Modifiers	Type	Name	Description
protected	boolean	cache	whether caching the response should be attempted
protected	boolean	gzip	whether the sent entity should be gzip'ed on the fly
protected	string	eTag	the generated or custom ETag
protected	integer	lastModified	the generated or custom timestamp of last modification
protected	string	cacheControl	Cache-Control setting
protected	string	contentType	the Content-Type of the sent entity
protected	string	contentDisposition	the Content-Disposition of the sent entity
protected	integer	bufferSize	the chunk buffer size used for throttling
protected	double	throttleDelay	the seconds to delay when throttling

Predefined Constants

Type	Name	Description
integer	REDIRECT	guess applicable redirect method
integer	REDIRECT_PERM	permanent redirect (301 Moved permanently)
integer	REDIRECT_FOUND	standard redirect (302 Found)
integer	REDIRECT_POST	redirect applicable to POST requests (303 See other)
integer	REDIRECT_PROXY	proxy redirect (305 Use proxy)
integer	REDIRECT_TEMP	temporary redirect (307 Temporary Redirect)

HttpResponse::capture — Capture script output
HttpResponse::getBufferSize — Get buffer size
HttpResponse::getCache — Get cache
HttpResponse::getCacheControl — Get cache control
HttpResponse::getContentDisposition — Get content disposition
HttpResponse::getContentType — Get content type
HttpResponse::getData — Get data
HttpResponse::getETag — Get ETag
HttpResponse::getFile — Get file
HttpResponse::getGzip — Get gzip
HttpResponse::getHeader — Get header
HttpResponse::getLastModified — Get last modified
HttpResponse::getRequestBody — Get request body
HttpResponse::getRequestBodyStream — Get request body stream
HttpResponse::getRequestHeaders — Get request headers
HttpResponse::getStream — Get Stream
HttpResponse::getThrottleDelay — Get throttle delay
HttpResponse::guessContentType — Guess content type
HttpResponse::redirect — Redirect
HttpResponse::send — Send response
HttpResponse::setBufferSize — Set buffer size
HttpResponse::setCache — Set cache
HttpResponse::setCacheControl — Set cache control
HttpResponse::setContentDisposition — Set content disposition
HttpResponse::setContentType — Set content type
HttpResponse::setData — Set data
HttpResponse::setETag — Set ETag
HttpResponse::setFile — Set file
HttpResponse::setGzip — Set gzip
HttpResponse::setHeader — Set header
HttpResponse::setLastModified — Set last modified
HttpResponse::setStream — Set stream
HttpResponse::setThrottleDelay — Set throttle delay
HttpResponse::status — Send HTTP response status

add a note

User Contributed Notes

There are no user contributed notes for this page.