1. class
  2. Hypervel
  3. \
  4. Sanctum
  5. \
  6. Exceptions
  7. \
  8. MissingAbilityException

MissingAbilityException

class MissingAbilityException extends AuthorizationException

Properties

protected Response|null $response

The response from the gate.

 from  AuthorizationException
protected int|null $status

The HTTP response status code.

 from  AuthorizationException
protected string[] $abilities

The abilities that the user did not have.

Methods

__construct(array|string $abilities = [], string|null $message = 'Invalid ability provided.')

Create a new missing scope exception.

Response|null
response()

Get the response from the gate.

from  AuthorizationException
AuthorizationException
setResponse(Response|null $response)

Set the response from the gate.

from  AuthorizationException
AuthorizationException
withStatus(int|null $status)

Set the HTTP response status code.

from  AuthorizationException
AuthorizationException
asNotFound()

Set the HTTP response status code to 404.

from  AuthorizationException
bool
hasStatus()

Determine if the HTTP status code has been set.

from  AuthorizationException
int|null
status()

Get the HTTP status code.

from  AuthorizationException
Response
toResponse()

Create a deny response object from this exception.

from  AuthorizationException
array
abilities()

Get the abilities that the user did not have.

Details

at line 24
__construct(array|string $abilities = [], string|null $message = 'Invalid ability provided.')

Create a new missing scope exception.

Parameters

array|string $abilities
string|null $message

in AuthorizationException at line 35
Response|null response()

Get the response from the gate.

Return Value

Response|null

in AuthorizationException at line 43
AuthorizationException setResponse(Response|null $response)

Set the response from the gate.

Parameters

Response|null $response

Return Value

AuthorizationException

in AuthorizationException at line 53
AuthorizationException withStatus(int|null $status)

Set the HTTP response status code.

Parameters

int|null $status

Return Value

AuthorizationException

in AuthorizationException at line 63
AuthorizationException asNotFound()

Set the HTTP response status code to 404.

Return Value

AuthorizationException

in AuthorizationException at line 71
bool hasStatus()

Determine if the HTTP status code has been set.

Return Value

bool

in AuthorizationException at line 79
int|null status()

Get the HTTP status code.

Return Value

int|null

in AuthorizationException at line 87
Response toResponse()

Create a deny response object from this exception.

Return Value

Response

at line 36
array abilities()

Get the abilities that the user did not have.

Return Value

array