1. trait
  2. Hypervel
  3. \
  4. Sanctum
  5. \
  6. HasApiTokens

HasApiTokens

trait HasApiTokens

Properties

protected null|TToken $accessToken

The access token the user is using for the current request.

Methods

MorphMany
tokens()

Get the access tokens that belong to model.

bool
tokenCan(UnitEnum|string $ability)

Determine if the current API token has a given ability.

bool
tokenCant(UnitEnum|string $ability)

Determine if the current API token does not have a given ability.

NewAccessToken
createToken(string $name, array $abilities = ['*'], DateTimeInterface|null $expiresAt = null)

Create a new personal access token for the user.

string
generateTokenString()

Generate the token string.

HasAbilities|null
currentAccessToken()

Get the access token currently associated with the user.

HasApiTokens
withAccessToken(HasAbilities|null $accessToken)

Set the current access token for the user.

Details

at line 32
MorphMany tokens()

Get the access tokens that belong to model.

Return Value

MorphMany

at line 40
bool tokenCan(UnitEnum|string $ability)

Determine if the current API token has a given ability.

Parameters

UnitEnum|string $ability

Return Value

bool

at line 48
bool tokenCant(UnitEnum|string $ability)

Determine if the current API token does not have a given ability.

Parameters

UnitEnum|string $ability

Return Value

bool

at line 58
NewAccessToken createToken(string $name, array $abilities = ['*'], DateTimeInterface|null $expiresAt = null)

Create a new personal access token for the user.

Parameters

string $name
array $abilities
DateTimeInterface|null $expiresAt

Return Value

NewAccessToken

at line 78
string generateTokenString()

Generate the token string.

Return Value

string

at line 93
HasAbilities|null currentAccessToken()

Get the access token currently associated with the user.

Return Value

HasAbilities|null

at line 104
HasApiTokens withAccessToken(HasAbilities|null $accessToken)

Set the current access token for the user.

Parameters

HasAbilities|null $accessToken

Return Value

HasApiTokens