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

JsonResponse

class JsonResponse extends JsonResponse

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
ResponseTrait
header(string $key, array|string $values, bool $replace = true)

Set a header on the Response.

from  ResponseTrait
ResponseTrait
withHeaders(HeaderBag|array $headers)

Add an array of headers to the response.

from  ResponseTrait
ResponseTrait
withoutHeader(array|string $key)

Remove a header(s) from the response.

from  ResponseTrait
ResponseTrait
cookie(mixed $cookie)

Add a cookie to the response.

from  ResponseTrait
ResponseTrait
withCookie(mixed $cookie)

Add a cookie to the response.

from  ResponseTrait
ResponseTrait
withoutCookie(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
ResponseTrait
withException(Throwable $e)

Set the exception to attach to the response.

from  ResponseTrait
never
throwResponse()

Throw the response in a HttpResponseException instance.

from  ResponseTrait
static void
macro(string $name, callable|object $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)

Check 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 = [])

Create an instance from a JSON string.

JsonResponse
withCallback(string|null $callback = null)

Set the JSONP callback.

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

Get the decoded JSON data from the response.

JsonResponse
setData($data = [])

Set the data to be sent as JSON.

bool
hasValidJson(int $jsonError)

Determine if an error occurred during JSON encoding.

JsonResponse
setEncodingOptions($options)

Set the JSON encoding options.

bool
hasEncodingOption(int $option)

Determine if a JSON encoding option is set.

static void
flushState()

Flush all static state.

Details

in ResponseTrait at line 26
int status()

Get the status code for the response.

Return Value

int

in ResponseTrait at line 34
string statusText()

Get the status text for the response.

Return Value

string

in ResponseTrait at line 42
string content()

Get the content of the response.

Return Value

string

in ResponseTrait at line 50
mixed getOriginalContent()

Get the original response content.

Return Value

mixed

in ResponseTrait at line 62
ResponseTrait 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

ResponseTrait

in ResponseTrait at line 74
ResponseTrait withHeaders(HeaderBag|array $headers)

Add an array of headers to the response.

Parameters

HeaderBag|array $headers

Return Value

ResponseTrait

in ResponseTrait at line 92
ResponseTrait withoutHeader(array|string $key)

Remove a header(s) from the response.

Parameters

array|string $key

Return Value

ResponseTrait

Add a cookie to the response.

Parameters

mixed $cookie

Return Value

ResponseTrait

in ResponseTrait at line 116
ResponseTrait withCookie(mixed $cookie)

Add a cookie to the response.

Parameters

mixed $cookie

Return Value

ResponseTrait

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

Expire a cookie when sending the response.

Parameters

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

Return Value

ResponseTrait

in ResponseTrait at line 146
string|null getCallback()

Get the callback of the response.

Return Value

string|null

in ResponseTrait at line 156
ResponseTrait withException(Throwable $e)

Set the exception to attach to the response.

Parameters

Throwable $e

Return Value

ResponseTrait

in ResponseTrait at line 168
never throwResponse()

Throw the response in a HttpResponseException instance.

Return Value

never

Exceptions

HttpResponseException

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

Register a custom macro.

Boot-only. Macros persist in a static property for the worker lifetime and apply to every subsequent call on the macroable class.

Parameters

string $name
callable|object $macro

Return Value

void

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

Mix another object into the class.

Boot-only. Delegates to macro() for each method; registered macros persist in a static property for the worker lifetime.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

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

Check if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 68
static void flushMacros()

Flush the existing macros.

Boot or tests only. Clears worker-wide macros; concurrent coroutines may resolve different methods depending on timing.

Return Value

void

in Macroable at line 78
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 103
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 24
__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 34
static JsonResponse fromJsonString(string|null $data = null, int $status = 200, array $headers = [])

Create an instance from a JSON string.

Parameters

string|null $data
int $status
array $headers

Return Value

JsonResponse

at line 43
JsonResponse withCallback(string|null $callback = null)

Set the JSONP callback.

Parameters

string|null $callback

Return Value

JsonResponse

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

Get the decoded JSON data from the response.

Parameters

bool $assoc
int $depth

Return Value

mixed

at line 61
JsonResponse setData($data = [])

Set the data to be sent as JSON.

Parameters

$data

Return Value

JsonResponse

Exceptions

InvalidArgumentException

at line 86
protected bool hasValidJson(int $jsonError)

Determine if an error occurred during JSON encoding.

Parameters

int $jsonError

Return Value

bool

at line 103
JsonResponse setEncodingOptions($options)

Set the JSON encoding options.

Parameters

$options

Return Value

JsonResponse

at line 114
bool hasEncodingOption(int $option)

Determine if a JSON encoding option is set.

Parameters

int $option

Return Value

bool

at line 122
static void flushState()

Flush all static state.

Return Value

void