Overview

Namespaces

  • Alpha
    • Controller
      • Front
    • Exception
    • Model
      • Type
    • Task
    • Util
      • Backup
      • Cache
      • Code
        • Highlight
        • Metric
      • Config
      • Convertor
      • Email
      • Extension
      • Feed
      • File
      • Graph
      • Helper
      • Http
        • Filter
        • Session
      • Image
      • Logging
      • Search
      • Security
    • View
      • Renderer
        • Html
        • Json
      • Widget

Classes

  • AgentUtils
  • PHPServerUtils
  • Request
  • Response
  • Overview
  • Namespace
  • Class
  • Tree

Class Response

A class to encapsulate a HTTP Response.

Namespace: Alpha\Util\Http
Copyright: Copyright (c) 2015, John Collins (founder of Alpha Framework). All rights reserved. <pre> 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. </pre>
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
int $status The HTTP status code of the response.
$body
string $body The body of the response (optional).
$headers
array $headers The headers to set on the response (optional).

Throws

Alpha\Exception\IllegalArguementException
Alpha\Exception\IllegalArguementException
public string|null
# getBody( )

Get the response body.

Get the response body.

Returns

string|null
string|null

Since

2.0
public
# setBody( string $body )

Set the response body.

Set the response body.

Parameters

$body
string $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
int

Since

2.0
public string
# getStatusMessage( )

Get the status message of the response.

Get the status message of the response.

Returns

string
string
public
# setStatus( integer $status )

Set the status code of the response.

Set the status code of the response.

Parameters

$status
int $status The response code.

Throws

Alpha\Exception\IllegalArguementException
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
string $header The header key name.
$value
string $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
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
string $key The key to search for
$default
mixed $default If key is not found, return this instead

Returns

mixed
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
string $cookie The cookie key name.
$value
string $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
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
string $key The key to search for
$default
mixed $default If key is not found, return this instead

Returns

mixed
mixed

Since

2.0
public integer
# getContentLength( )

Get the content length of the response.

Get the content length of the response.

Returns

integer
int

Since

2.0
public
# redirect( string $URL )

Builds a redirect response.

Builds a redirect response.

Parameters

$URL
string $URL The URL to redirect the client to.

Throws

Alpha\Exception\IllegalArguementException
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
Alpha Framework 2.0.4 API Documentation API documentation generated by ApiGen 2.8.0