JsonResponse
class JsonResponse extends JsonResponse (View source)
Traits
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
Set a header on the Response.
Add an array of headers to the response.
Expire a cookie when sending the response.
Mix another object into the class.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Create a new JSON response instance.
{@inheritdoc}
Sets the JSONP callback.
Get the json_decoded data from the response.
{@inheritdoc}
Determine if an error occurred during JSON encoding.
{@inheritdoc}
Determine if a JSON encoding option is set.
Details
int
status()
Get the status code for the response.
string
statusText()
Get the status text 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(HeaderBag|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
withoutCookie(Cookie|mixed $cookie, string|null $path = null, string|null $domain = null)
Expire a cookie when sending the response.
string|null
getCallback()
Get the callback of the response.
$this
withException(Throwable $e)
Set the exception to attach to the response.
never
throwResponse()
Throws the response in a HttpResponseException instance.
static void
macro(string $name, object|callable $macro)
Register a custom macro.
static void
mixin(object $mixin, bool $replace = true)
Mix another object into the class.
static bool
hasMacro(string $name)
Checks if macro is registered.
static void
flushMacros()
Flush the existing macros.
static mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
mixed
__call(string $method, array $parameters)
Dynamically handle calls to the class.
void
__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}
protected 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.