class Response

Response represents an HTTP response.

Constants

HTTP_CONTINUE

HTTP_SWITCHING_PROTOCOLS

HTTP_PROCESSING

HTTP_OK

HTTP_CREATED

HTTP_ACCEPTED

HTTP_NON_AUTHORITATIVE_INFORMATION

HTTP_NO_CONTENT

HTTP_RESET_CONTENT

HTTP_PARTIAL_CONTENT

HTTP_MULTI_STATUS

HTTP_ALREADY_REPORTED

HTTP_IM_USED

HTTP_MULTIPLE_CHOICES

HTTP_MOVED_PERMANENTLY

HTTP_FOUND

HTTP_SEE_OTHER

HTTP_NOT_MODIFIED

HTTP_USE_PROXY

HTTP_RESERVED

HTTP_TEMPORARY_REDIRECT

HTTP_PERMANENTLY_REDIRECT

HTTP_BAD_REQUEST

HTTP_UNAUTHORIZED

HTTP_PAYMENT_REQUIRED

HTTP_FORBIDDEN

HTTP_NOT_FOUND

HTTP_METHOD_NOT_ALLOWED

HTTP_NOT_ACCEPTABLE

HTTP_PROXY_AUTHENTICATION_REQUIRED

HTTP_REQUEST_TIMEOUT

HTTP_CONFLICT

HTTP_GONE

HTTP_LENGTH_REQUIRED

HTTP_PRECONDITION_FAILED

HTTP_REQUEST_ENTITY_TOO_LARGE

HTTP_REQUEST_URI_TOO_LONG

HTTP_UNSUPPORTED_MEDIA_TYPE

HTTP_REQUESTED_RANGE_NOT_SATISFIABLE

HTTP_EXPECTATION_FAILED

HTTP_I_AM_A_TEAPOT

HTTP_MISDIRECTED_REQUEST

HTTP_UNPROCESSABLE_ENTITY

HTTP_LOCKED

HTTP_FAILED_DEPENDENCY

HTTP_RESERVED_FOR_WEBDAV_ADVANCED_COLLECTIONS_EXPIRED_PROPOSAL

HTTP_UPGRADE_REQUIRED

HTTP_PRECONDITION_REQUIRED

HTTP_TOO_MANY_REQUESTS

HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE

HTTP_UNAVAILABLE_FOR_LEGAL_REASONS

HTTP_INTERNAL_SERVER_ERROR

HTTP_NOT_IMPLEMENTED

HTTP_BAD_GATEWAY

HTTP_SERVICE_UNAVAILABLE

HTTP_GATEWAY_TIMEOUT

HTTP_VERSION_NOT_SUPPORTED

HTTP_VARIANT_ALSO_NEGOTIATES_EXPERIMENTAL

HTTP_INSUFFICIENT_STORAGE

HTTP_LOOP_DETECTED

HTTP_NOT_EXTENDED

HTTP_NETWORK_AUTHENTICATION_REQUIRED

Properties

ResponseHeaderBag $headers
static array $statusTexts Status codes translation table.

Methods

__construct(mixed $content = '', int $status = 200, array $headers = array())

No description

static Response
create(mixed $content = '', int $status = 200, array $headers = array())

Factory method for chainability.

string
__toString()

Returns the Response as an HTTP string.

__clone()

Clones the current Response instance.

$this
prepare(Request $request)

Prepares the Response before it is sent to the client.

$this
sendHeaders()

Sends HTTP headers.

$this
sendContent()

Sends content for the current web response.

$this
send()

Sends HTTP headers and content.

$this
setContent(mixed $content)

Sets the response content.

string
getContent()

Gets the current response content.

$this
setProtocolVersion(string $version)

Sets the HTTP protocol version (1.0 or 1.1).

string
getProtocolVersion()

Gets the HTTP protocol version.

$this
setStatusCode(int $code, mixed $text = null)

Sets the response status code.

int
getStatusCode()

Retrieves the status code for the current web response.

$this
setCharset(string $charset)

Sets the response charset.

string
getCharset()

Retrieves the response charset.

bool
isCacheable()

Returns true if the response is worth caching under any circumstance.

bool
isFresh()

Returns true if the response is "fresh".

bool
isValidateable()

Returns true if the response includes headers that can be used to validate the response with the origin server using a conditional GET request.

$this
setPrivate()

Marks the response as "private".

$this
setPublic()

Marks the response as "public".

$this
setImmutable(bool $immutable = true)

Marks the response as "immutable".

bool
isImmutable()

Returns true if the response is marked as "immutable".

bool
mustRevalidate()

Returns true if the response must be revalidated by caches.

getDate()

Returns the Date header as a DateTime instance.

$this
setDate(DateTime $date)

Sets the Date header.

int
getAge()

Returns the age of the response.

$this
expire()

Marks the response stale by setting the Age header to be equal to the maximum age of the response.

DateTime|null
getExpires()

Returns the value of the Expires header as a DateTime instance.

$this
setExpires(DateTime $date = null)

Sets the Expires HTTP header with a DateTime instance.

int|null
getMaxAge()

Returns the number of seconds after the time specified in the response's Date header when the response should no longer be considered fresh.

$this
setMaxAge(int $value)

Sets the number of seconds after which the response should no longer be considered fresh.

$this
setSharedMaxAge(int $value)

Sets the number of seconds after which the response should no longer be considered fresh by shared caches.

int|null
getTtl()

Returns the response's time-to-live in seconds.

$this
setTtl(int $seconds)

Sets the response's time-to-live for shared caches.

$this
setClientTtl(int $seconds)

Sets the response's time-to-live for private/client caches.

DateTime|null
getLastModified()

Returns the Last-Modified HTTP header as a DateTime instance.

$this
setLastModified(DateTime $date = null)

Sets the Last-Modified HTTP header with a DateTime instance.

string|null
getEtag()

Returns the literal value of the ETag HTTP header.

$this
setEtag(string|null $etag = null, bool $weak = false)

Sets the ETag value.

$this
setCache(array $options)

Sets the response's cache headers (validation and/or expiration).

$this
setNotModified()

Modifies the response so that it conforms to the rules defined for a 304 status code.

bool
hasVary()

Returns true if the response includes a Vary header.

array
getVary()

Returns an array of header names given in the Vary header.

$this
setVary(string|array $headers, bool $replace = true)

Sets the Vary header.

bool
isNotModified(Request $request)

Determines if the Response validators (ETag, Last-Modified) match a conditional value specified in the Request.

bool
isInvalid()

Is response invalid?

bool
isInformational()

Is response informative?

bool
isSuccessful()

Is response successful?

bool
isRedirection()

Is the response a redirect?

bool
isClientError()

Is there a client error?

bool
isServerError()

Was there a server side error?

bool
isOk()

Is the response OK?

bool
isForbidden()

Is the response forbidden?

bool
isNotFound()

Is the response a not found error?

bool
isRedirect(string $location = null)

Is the response a redirect of some form?

bool
isEmpty()

Is the response empty?

static 
closeOutputBuffers(int $targetLevel, bool $flush)

Cleans or flushes output buffers up to target level.

Details

at line line 197
__construct(mixed $content = '', int $status = 200, array $headers = array())

Parameters

mixed $content The response content, see setContent()
int $status The response status code
array $headers An array of response headers

Exceptions

InvalidArgumentException When the HTTP status code is not valid

at line line 219
static Response create(mixed $content = '', int $status = 200, array $headers = array())

Factory method for chainability.

Example:

return Response::create($body, 200)
    ->setSharedMaxAge(300);

Parameters

mixed $content The response content, see setContent()
int $status The response status code
array $headers An array of response headers

Return Value

Response

at line line 235
string __toString()

Returns the Response as an HTTP string.

The string representation of the Response is the same as the one that will be sent to the client only if the prepare() method has been called before.

Return Value

string The Response as an HTTP string

See also

prepare()

at line line 246
__clone()

Clones the current Response instance.

at line line 260
$this prepare(Request $request)

Prepares the Response before it is sent to the client.

This method tweaks the Response to ensure that it is compliant with RFC 2616. Most of the changes are based on the Request that is "associated" with this Response.

Parameters

Request $request

Return Value

$this

at line line 322
$this sendHeaders()

Sends HTTP headers.

Return Value

$this

at line line 356
$this sendContent()

Sends content for the current web response.

Return Value

$this

at line line 368
$this send()

Sends HTTP headers and content.

Return Value

$this

at line line 393
$this setContent(mixed $content)

Sets the response content.

Valid types are strings, numbers, null, and objects that implement a __toString() method.

Parameters

mixed $content Content that can be cast to string

Return Value

$this

Exceptions

UnexpectedValueException

at line line 409
string getContent()

Gets the current response content.

Return Value

string Content

at line line 423
$this setProtocolVersion(string $version)

Sets the HTTP protocol version (1.0 or 1.1).

Parameters

string $version The HTTP protocol version

Return Value

$this

at line line 437
string getProtocolVersion()

Gets the HTTP protocol version.

Return Value

string The HTTP protocol version

at line line 457
$this setStatusCode(int $code, mixed $text = null)

Sets the response status code.

If the status text is null it will be automatically populated for the known status codes and left empty otherwise.

Parameters

int $code HTTP status code
mixed $text HTTP status text

Return Value

$this

Exceptions

InvalidArgumentException When the HTTP status code is not valid

at line line 488
int getStatusCode()

Retrieves the status code for the current web response.

Return Value

int Status code

at line line 502
$this setCharset(string $charset)

Sets the response charset.

Parameters

string $charset Character set

Return Value

$this

at line line 516
string getCharset()

Retrieves the response charset.

Return Value

string Character set

at line line 534
bool isCacheable()

Returns true if the response is worth caching under any circumstance.

Responses marked "private" with an explicit Cache-Control directive are considered uncacheable.

Responses with neither a freshness lifetime (Expires, max-age) nor cache validator (Last-Modified, ETag) are considered uncacheable.

Return Value

bool true if the response is worth caching, false otherwise

at line line 558
bool isFresh()

Returns true if the response is "fresh".

Fresh responses may be served from cache without any interaction with the origin. A response is considered fresh when it includes a Cache-Control/max-age indicator or Expires header and the calculated age is less than the freshness lifetime.

Return Value

bool true if the response is fresh, false otherwise

at line line 571
bool isValidateable()

Returns true if the response includes headers that can be used to validate the response with the origin server using a conditional GET request.

Return Value

bool true if the response is validateable, false otherwise

at line line 585
$this setPrivate()

Marks the response as "private".

It makes the response ineligible for serving other clients.

Return Value

$this

at line line 602
$this setPublic()

Marks the response as "public".

It makes the response eligible for serving other clients.

Return Value

$this

at line line 619
$this setImmutable(bool $immutable = true)

Marks the response as "immutable".

Parameters

bool $immutable enables or disables the immutable directive

Return Value

$this

at line line 637
bool isImmutable()

Returns true if the response is marked as "immutable".

Return Value

bool returns true if the response is marked as "immutable"; otherwise false

at line line 654
bool mustRevalidate()

Returns true if the response must be revalidated by caches.

This method indicates that the response must not be served stale by a cache in any circumstance without first revalidating with the origin. When present, the TTL of the response should not be overridden to be greater than the value provided by the origin.

Return Value

bool true if the response must be revalidated by a cache, false otherwise

at line line 668
DateTime getDate()

Returns the Date header as a DateTime instance.

Return Value

DateTime A \DateTime instance

Exceptions

RuntimeException When the header is not parseable

at line line 680
$this setDate(DateTime $date)

Sets the Date header.

Parameters

DateTime $date

Return Value

$this

at line line 695
int getAge()

Returns the age of the response.

Return Value

int The age of the response in seconds

at line line 709
$this expire()

Marks the response stale by setting the Age header to be equal to the maximum age of the response.

Return Value

$this

at line line 725
DateTime|null getExpires()

Returns the value of the Expires header as a DateTime instance.

Return Value

DateTime|null A DateTime instance or null if the header does not exist

at line line 746
$this setExpires(DateTime $date = null)

Sets the Expires HTTP header with a DateTime instance.

Passing null as value will remove the header.

Parameters

DateTime $date A \DateTime instance or null to remove the header

Return Value

$this

at line line 770
int|null getMaxAge()

Returns the number of seconds after the time specified in the response's Date header when the response should no longer be considered fresh.

First, it checks for a s-maxage directive, then a max-age directive, and then it falls back on an expires header. It returns null when no maximum age can be established.

Return Value

int|null Number of seconds

at line line 796
$this setMaxAge(int $value)

Sets the number of seconds after which the response should no longer be considered fresh.

This methods sets the Cache-Control max-age directive.

Parameters

int $value Number of seconds

Return Value

$this

at line line 814
$this setSharedMaxAge(int $value)

Sets the number of seconds after which the response should no longer be considered fresh by shared caches.

This methods sets the Cache-Control s-maxage directive.

Parameters

int $value Number of seconds

Return Value

$this

at line line 834
int|null getTtl()

Returns the response's time-to-live in seconds.

It returns null when no freshness information is present in the response.

When the responses TTL is <= 0, the response may not be served from cache without first revalidating with the origin.

Return Value

int|null The TTL in seconds

at line line 852
$this setTtl(int $seconds)

Sets the response's time-to-live for shared caches.

This method adjusts the Cache-Control/s-maxage directive.

Parameters

int $seconds Number of seconds

Return Value

$this

at line line 870
$this setClientTtl(int $seconds)

Sets the response's time-to-live for private/client caches.

This method adjusts the Cache-Control/max-age directive.

Parameters

int $seconds Number of seconds

Return Value

$this

at line line 886
DateTime|null getLastModified()

Returns the Last-Modified HTTP header as a DateTime instance.

Return Value

DateTime|null A DateTime instance or null if the header does not exist

Exceptions

RuntimeException When the HTTP header is not parseable

at line line 902
$this setLastModified(DateTime $date = null)

Sets the Last-Modified HTTP header with a DateTime instance.

Passing null as value will remove the header.

Parameters

DateTime $date A \DateTime instance or null to remove the header

Return Value

$this

at line line 922
string|null getEtag()

Returns the literal value of the ETag HTTP header.

Return Value

string|null The ETag HTTP header or null if it does not exist

at line line 937
$this setEtag(string|null $etag = null, bool $weak = false)

Sets the ETag value.

Parameters

string|null $etag The ETag unique identifier or null to remove the header
bool $weak Whether you want a weak ETag or not

Return Value

$this

at line line 965
$this setCache(array $options)

Sets the response's cache headers (validation and/or expiration).

Available options are: etag, lastmodified, maxage, s_maxage, private, and public.

Parameters

array $options An array of cache options

Return Value

$this

Exceptions

InvalidArgumentException

at line line 1022
$this setNotModified()

Modifies the response so that it conforms to the rules defined for a 304 status code.

This sets the status, removes the body, and discards any headers that MUST NOT be included in 304 responses.

Return Value

$this

See also

http://tools.ietf.org/html/rfc2616#section-10.3.5

at line line 1042
bool hasVary()

Returns true if the response includes a Vary header.

Return Value

bool true if the response includes a Vary header, false otherwise

at line line 1054
array getVary()

Returns an array of header names given in the Vary header.

Return Value

array An array of Vary names

at line line 1078
$this setVary(string|array $headers, bool $replace = true)

Sets the Vary header.

Parameters

string|array $headers
bool $replace Whether to replace the actual value or not (true by default)

Return Value

$this

at line line 1096
bool isNotModified(Request $request)

Determines if the Response validators (ETag, Last-Modified) match a conditional value specified in the Request.

If the Response is not modified, it sets the status code to 304 and removes the actual content by calling the setNotModified() method.

Parameters

Request $request

Return Value

bool true if the Response validators match the Request, false otherwise

at line line 1130
bool isInvalid()

Is response invalid?

Return Value

bool

See also

http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

at line line 1142
bool isInformational()

Is response informative?

Return Value

bool

at line line 1154
bool isSuccessful()

Is response successful?

Return Value

bool

at line line 1166
bool isRedirection()

Is the response a redirect?

Return Value

bool

at line line 1178
bool isClientError()

Is there a client error?

Return Value

bool

at line line 1190
bool isServerError()

Was there a server side error?

Return Value

bool

at line line 1202
bool isOk()

Is the response OK?

Return Value

bool

at line line 1214
bool isForbidden()

Is the response forbidden?

Return Value

bool

at line line 1226
bool isNotFound()

Is the response a not found error?

Return Value

bool

at line line 1240
bool isRedirect(string $location = null)

Is the response a redirect of some form?

Parameters

string $location

Return Value

bool

at line line 1252
bool isEmpty()

Is the response empty?

Return Value

bool

at line line 1267
static closeOutputBuffers(int $targetLevel, bool $flush)

Cleans or flushes output buffers up to target level.

Resulting level can be greater than target level if a non-removable buffer has been encountered.

Parameters

int $targetLevel The target output buffering level
bool $flush Whether to flush or clean the buffers