class JsonResponse extends JsonResponse

Traits

Properties

mixed $original

The original content of the response.

from  ResponseTrait
Exception|null $exception

The exception that triggered the error response (if applicable).

from  ResponseTrait

Methods

int
status()

Get the status code for the response.

string
content()

Get the content of the response.

mixed
getOriginalContent()

Get the original response content.

$this
header(string $key, array|string $values, bool $replace = true)

Set a header on the Response.

$this
withHeaders(array $headers)

Add an array of headers to the response.

$this
cookie(Cookie|mixed $cookie)

Add a cookie to the response.

$this
withCookie(Cookie|mixed $cookie)

Add a cookie to the response.

$this
withException(Exception $e)

Set the exception to attach to the response.

throwResponse()

Throws the response in a HttpResponseException instance.

__construct(mixed $data = null, int $status = 200, array $headers = [], int $options = 0)

Constructor.

$this
withCallback(string|null $callback = null)

Sets the JSONP callback.

mixed
getData(bool $assoc = false, int $depth = 512)

Get the json_decoded data from the response.

setData($data = [])

{@inheritdoc}

bool
hasValidJson(int $jsonError)

Determine if an error occurred during JSON encoding.

setEncodingOptions($options)

{@inheritdoc}

bool
hasEncodingOption(int $option)

Determine if a JSON encoding option is set.

Details

in ResponseTrait at line 29
int status()

Get the status code for the response.

Return Value

int

in ResponseTrait at line 39
string content()

Get the content of the response.

Return Value

string

in ResponseTrait at line 49
mixed getOriginalContent()

Get the original response content.

Return Value

mixed

in ResponseTrait at line 62
$this header(string $key, array|string $values, bool $replace = true)

Set a header on the Response.

Parameters

string $key
array|string $values
bool $replace

Return Value

$this

in ResponseTrait at line 75
$this withHeaders(array $headers)

Add an array of headers to the response.

Parameters

array $headers

Return Value

$this

Add a cookie to the response.

Parameters

Cookie|mixed $cookie

Return Value

$this

in ResponseTrait at line 101
$this withCookie(Cookie|mixed $cookie)

Add a cookie to the response.

Parameters

Cookie|mixed $cookie

Return Value

$this

in ResponseTrait at line 118
$this withException(Exception $e)

Set the exception to attach to the response.

Parameters

Exception $e

Return Value

$this

in ResponseTrait at line 130
throwResponse()

Throws the response in a HttpResponseException instance.

at line 23
__construct(mixed $data = null, int $status = 200, array $headers = [], int $options = 0)

Constructor.

Parameters

mixed $data
int $status
array $headers
int $options

at line 36
$this withCallback(string|null $callback = null)

Sets the JSONP callback.

Parameters

string|null $callback

Return Value

$this

at line 48
mixed getData(bool $assoc = false, int $depth = 512)

Get the json_decoded data from the response.

Parameters

bool $assoc
int $depth

Return Value

mixed

at line 56
setData($data = [])

{@inheritdoc}

Parameters

$data

at line 83
protected bool hasValidJson(int $jsonError)

Determine if an error occurred during JSON encoding.

Parameters

int $jsonError

Return Value

bool

at line 93
setEncodingOptions($options)

{@inheritdoc}

Parameters

$options

at line 106
bool hasEncodingOption(int $option)

Determine if a JSON encoding option is set.

Parameters

int $option

Return Value

bool