class JsonResponse extends JsonResponse (View source)
| ResponseTrait | |
| Macroable |
| 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 |
| 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 |
| void | 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 |
| 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} | |
| 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. |
Get the status code for the response.
Get the status text for the response.
Get the content of the response.
Get the original response content.
Set a header on the Response.
Add an array of headers to the response.
Add a cookie to the response.
Add a cookie to the response.
Expire a cookie when sending the response.
Get the callback of the response.
Set the exception to attach to the response.
Throws the response in a HttpResponseException instance.
Register a custom macro.
Mix another object into the class.
Checks if macro is registered.
Flush the existing macros.
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.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Http/JsonResponse.html