JsonResponse

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

__clone()

Clones the current Response instance.

Response 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

A Request instance

Return Value

The current response

Response sendHeaders()

Sends HTTP headers.

Return Value

Response sendContent()

Sends content for the current web response.

Return Value

Response send()

Sends HTTP headers and content.

Return Value

Response 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

Exceptions

UnexpectedValueException

string getContent()

Gets the current response content.

Return Value

string

Content

Response setProtocolVersion(string $version)

Sets the HTTP protocol version (1.0 or 1.1).

Parameters

string

$version

The HTTP protocol version

Return Value

string getProtocolVersion()

Gets the HTTP protocol version.

Return Value

string

The HTTP protocol version

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

Sets the response status code.

Parameters

int	$code	HTTP status code
mixed	$text	HTTP status text If the status text is null it will be automatically populated for the known status codes and left empty otherwise.

Return Value

Exceptions

When the HTTP status code is not valid

int getStatusCode()

Retrieves the status code for the current web response.

Return Value

int	Status code

Response setCharset(string $charset)

Sets the response charset.

Parameters

string

$charset

Character set

Return Value

string getCharset()

Retrieves the response charset.

Return Value

string

Character set

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

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

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

Response setPrivate()

Marks the response as "private".

It makes the response ineligible for serving other clients.

Return Value

Response setPublic()

Marks the response as "public".

It makes the response eligible for serving other clients.

Return Value

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

DateTime getDate()

Returns the Date header as a DateTime instance.

Return Value

A \DateTime instance

Exceptions

RuntimeException

When the header is not parseable

Response setDate(DateTime $date)

Sets the Date header.

Parameters

$date

A \DateTime instance

Return Value

int getAge()

Returns the age of the response.

Return Value

int	The age of the response in seconds

Response expire()

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

Return Value

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

Response setExpires(DateTime $date = null)

Sets the Expires HTTP header with a DateTime instance.

Passing null as value will remove the header.

Parameters

$date

A \DateTime instance or null to remove the header

Return Value

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

Response 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

Response 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

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

Response 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

Response 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

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

Response setLastModified(DateTime $date = null)

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

Passing null as value will remove the header.

Parameters

$date

A \DateTime instance or null to remove the header

Return Value

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

Response 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

Response 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

Exceptions

Response 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

bool hasVary()

Returns true if the response includes a Vary header.

Return Value

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

array getVary()

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

Return Value

array

An array of Vary names

Response 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

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

A Request instance

Return Value

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

bool isInvalid()

Is response invalid?

Return Value

bool

bool isInformational()

Is response informative?

Return Value

bool

bool isSuccessful()

Is response successful?

Return Value

bool

bool isRedirection()

Is the response a redirect?

Return Value

bool

bool isClientError()

Is there a client error?

Return Value

bool

bool isServerError()

Was there a server side error?

Return Value

bool

bool isOk()

Is the response OK?

Return Value

bool

bool isForbidden()

Is the response forbidden?

Return Value

bool

bool isNotFound()

Is the response a not found error?

Return Value

bool

bool isRedirect(string $location = null)

Is the response a redirect of some form?

Parameters

string

$location

Return Value

bool

bool isEmpty()

Is the response empty?

Return Value

bool

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

JsonResponse setCallback(string|null $callback = null)

Sets the JSONP callback.

Parameters

string|null

$callback

The JSONP callback or null to use none

Return Value

Exceptions

When the callback name is not valid

JsonResponse setJson(string $json)

Sets a raw string containing a JSON document to be sent.

Parameters

string

$json

Return Value

Exceptions

JsonResponse setData(mixed $data = array())

Sets the data to be sent as JSON.

Parameters

mixed

$data

Return Value

Exceptions

int getEncodingOptions()

Returns options used while encoding data to JSON.

Return Value

int

JsonResponse setEncodingOptions(int $encodingOptions)

Sets options used while encoding data to JSON.

Parameters

int

$encodingOptions

Return Value