1. class
  2. Illuminate
  3. \
  4. Http
  5. \
  6. JsonResponse

JsonResponse

class JsonResponse extends JsonResponse (View source)

Traits

ResponseTrait
Macroable

Properties

mixed $original

The original content of the response.

 from  ResponseTrait
Throwable|null $exception

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

 from  ResponseTrait
static protected array $macros

The registered string macros.

 from  Macroable

Methods

int
status()

Get the status code for the response.

from  ResponseTrait
string
statusText()

Get the status text for the response.

from  ResponseTrait
string
content()

Get the content of the response.

from  ResponseTrait
mixed
getOriginalContent()

Get the original response content.

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

Set a header on the Response.

from  ResponseTrait
$this
withHeaders(HeaderBag|array $headers)

Add an array of headers to the response.

from  ResponseTrait
$this
cookie(Cookie|mixed $cookie)

Add a cookie to the response.

from  ResponseTrait
$this
withCookie(Cookie|mixed $cookie)

Add a cookie to the response.

from  ResponseTrait
$this
withoutCookie(Cookie|mixed $cookie, string|null $path = null, string|null $domain = null)

Expire a cookie when sending the response.

from  ResponseTrait
string|null
getCallback()

Get the callback of the response.

from  ResponseTrait
$this
withException(Throwable $e)

Set the exception to attach to the response.

from  ResponseTrait
never
throwResponse()

Throws the response in a HttpResponseException instance.

from  ResponseTrait
static void
macro(string $name, object|callable $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
__construct(mixed $data = null, int $status = 200, array $headers = [], int $options = 0, bool $json = false)

Create a new JSON response instance.

static JsonResponse
fromJsonString(string|null $data = null, int $status = 200, array $headers = [])

{@inheritdoc}

$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.

JsonResponse
setData($data = [])

{@inheritdoc}

bool
hasValidJson(int $jsonError)

Determine if an error occurred during JSON encoding.

JsonResponse
setEncodingOptions($options)

{@inheritdoc}

bool
hasEncodingOption(int $option)

Determine if a JSON encoding option is set.

Details

in ResponseTrait at line 30
int status()

Get the status code for the response.

Return Value

int

in ResponseTrait at line 40
string statusText()

Get the status text for the response.

Return Value

string

in ResponseTrait at line 50
string content()

Get the content of the response.

Return Value

string

in ResponseTrait at line 60
mixed getOriginalContent()

Get the original response content.

Return Value

mixed

in ResponseTrait at line 75
$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 88
$this withHeaders(HeaderBag|array $headers)

Add an array of headers to the response.

Parameters

HeaderBag|array $headers

Return Value

$this

Add a cookie to the response.

Parameters

Cookie|mixed $cookie

Return Value

$this

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

Add a cookie to the response.

Parameters

Cookie|mixed $cookie

Return Value

$this

in ResponseTrait at line 137
$this withoutCookie(Cookie|mixed $cookie, string|null $path = null, string|null $domain = null)

Expire a cookie when sending the response.

Parameters

Cookie|mixed $cookie
string|null $path
string|null $domain

Return Value

$this

in ResponseTrait at line 153
string|null getCallback()

Get the callback of the response.

Return Value

string|null

in ResponseTrait at line 164
$this withException(Throwable $e)

Set the exception to attach to the response.

Parameters

Throwable $e

Return Value

$this

in ResponseTrait at line 178
never throwResponse()

Throws the response in a HttpResponseException instance.

Return Value

never

Exceptions

HttpResponseException

in Macroable at line 29
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 43
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 62
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 86
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 112
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

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

Create a new JSON response instance.

Parameters

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

at line 39
static JsonResponse fromJsonString(string|null $data = null, int $status = 200, array $headers = [])

{@inheritdoc}

Parameters

string|null $data
int $status
array $headers

Return Value

JsonResponse

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

Sets the JSONP callback.

Parameters

string|null $callback

Return Value

$this

at line 63
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 73
JsonResponse setData($data = [])

{@inheritdoc}

Parameters

$data

Return Value

JsonResponse

at line 101
protected bool hasValidJson(int $jsonError)

Determine if an error occurred during JSON encoding.

Parameters

int $jsonError

Return Value

bool

at line 120
JsonResponse setEncodingOptions($options)

{@inheritdoc}

Parameters

$options

Return Value

JsonResponse

at line 134
bool hasEncodingOption(int $option)

Determine if a JSON encoding option is set.

Parameters

int $option

Return Value

bool