Class Response

A class to encapsulate a HTTP Response.

Namespace: Alpha\Util\Http
Copyright:

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the
following conditions are met:

* Redistributions of source code must retain the above
  copyright notice, this list of conditions and the
  following disclaimer.
* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the
  following disclaimer in the documentation and/or other
  materials provided with the distribution.
* Neither the name of the Alpha Framework nor the names
  of its contributors may be used to endorse or promote
  products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

License: The BSD License
Author: John Collins dev@alphaframework.org
Since: 2.0
Located at Util/Http/Response.php

Methods summary

`public`	# `__construct( integer $status, string $body = null, array $headers = array() )` Build the response. Build the response. Parameters `$status` The HTTP status code of the response. `$body` The body of the response (optional). `$headers` The headers to set on the response (optional). Throws `Alpha\Exception\IllegalArguementException`
`public string\|null`	# `getBody( )` Get the response body. Get the response body. Returns string\|null Since 2.0
`public`	# `setBody( string $body )` Set the response body. Set the response body. Parameters `$body` The response body. Since 2.0
`public integer`	# `getStatus( )` Get the status code of the response. Get the status code of the response. Returns integer Since 2.0
`public string`	# `getStatusMessage( )` Get the status message of the response. Get the status message of the response. Returns string
`public`	# `setStatus( integer $status )` Set the status code of the response. Set the status code of the response. Parameters `$status` The response code. Throws `Alpha\Exception\IllegalArguementException` Since 2.0
`public`	# `setHeader( string $header, string $value )` Set a header key/value tuple for the response. Set a header key/value tuple for the response. Parameters `$header` The header key name. `$value` The header value. Since 2.0
`public array`	# `getHeaders( )` Get all of the headers for the response. Get all of the headers for the response. Returns array Since 2.0
`public mixed`	# `getHeader( string $key, mixed $default = null )` Get the header matching the key provided. Get the header matching the key provided. Parameters `$key` The key to search for `$default` If key is not found, return this instead Returns mixed Since 2.0
`public`	# `setCookie( string $cookie, string $value )` Set a cookie key/value tuple for the response. Set a cookie key/value tuple for the response. Parameters `$cookie` The cookie key name. `$value` The cookie value. Since 2.0
`public array`	# `getCookies( )` Get all of the cookies for the response. Get all of the cookies for the response. Returns array Since 2.0
`public mixed`	# `getCookie( string $key, mixed $default = null )` Get the cookie matching the key provided. Get the cookie matching the key provided. Parameters `$key` The key to search for `$default` If key is not found, return this instead Returns mixed Since 2.0
`public integer`	# `getContentLength( )` Get the content length of the response. Get the content length of the response. Returns integer Since 2.0
`public`	# `redirect( string $URL )` Builds a redirect response. Builds a redirect response. Parameters `$URL` The URL to redirect the client to. Throws `Alpha\Exception\IllegalArguementException` Since 2.0
`public`	# `send( )` Sends the current response to standard output before exiting the current process. Sends the current response to standard output before exiting the current process. Since 2.0

Namespaces

Classes

Class Response

Methods summary

Parameters

Throws

Returns

Since

Parameters

Since

Returns

Since

Returns

Parameters

Throws

Since

Parameters

Since

Returns

Since

Parameters

Returns

Since

Parameters

Since

Returns

Since

Parameters

Returns

Since

Returns

Since

Parameters

Throws

Since

Since