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.

Methods

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.

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.

authorize()

Throw authorization exception if response was denied.

array
toArray()

Convert the response to an array.

string
__toString()

Get the string representation of the message.

Details

void __construct(bool $allowed, string $message = '', mixed $code = null)

Create a new response.

Parameters

bool $allowed
string $message
mixed $code

Return Value

void

static Response allow(string|null $message = null, mixed $code = null)

Create a new "allow" Response.

Parameters

string|null $message
mixed $code

Return Value

Response

static Response deny(string|null $message = null, mixed $code = null)

Create a new "deny" Response.

Parameters

string|null $message
mixed $code

Return Value

Response

bool allowed()

Determine if the response was allowed.

Return Value

bool

bool denied()

Determine if the response was denied.

Return Value

bool

string|null message()

Get the response message.

Return Value

string|null

mixed code()

Get the response code / reason.

Return Value

mixed

Response authorize()

Throw authorization exception if response was denied.

Return Value

Response

Exceptions

AuthorizationException

array toArray()

Convert the response to an array.

Return Value

array

string __toString()

Get the string representation of the message.

Return Value

string