Response
class Response implements Arrayable (View source)
Properties
| protected bool | $allowed | Indicates whether the response was allowed. |
|
| protected string|null | $message | The response message. |
|
| protected mixed | $code | The response code. |
|
| protected int|null | $status | The HTTP response status code. |
Methods
Create a new response.
Create a new "allow" Response.
Create a new "deny" Response with a HTTP status code.
Create a new "deny" Response with a 404 HTTP status code.
Determine if the response was allowed.
Determine if the response was denied.
Get the response message.
Get the response code / reason.
Set the HTTP response status code.
Set the HTTP response status code to 404.
Get the HTTP status code.
Convert the response to an array.
Get the string representation of the message.
Details
void
__construct(bool $allowed, string $message = '', mixed $code = null)
Create a new response.
static Response
allow(string|null $message = null, mixed $code = null)
Create a new "allow" Response.
static Response
deny(string|null $message = null, mixed $code = null)
Create a new "deny" Response.
static Response
denyWithStatus(int $status, string|null $message = null, mixed $code = null)
Create a new "deny" Response with a HTTP status code.
static Response
denyAsNotFound(string|null $message = null, mixed $code = null)
Create a new "deny" Response with a 404 HTTP status code.
bool
allowed()
Determine if the response was allowed.
bool
denied()
Determine if the response was denied.
string|null
message()
Get the response message.
mixed
code()
Get the response code / reason.
Response
authorize()
Throw authorization exception if response was denied.
$this
withStatus(null|int $status)
Set the HTTP response status code.
$this
asNotFound()
Set the HTTP response status code to 404.
int|null
status()
Get the HTTP status code.
toArray()
Convert the response to an array.
string
__toString()
Get the string representation of the message.