1. interface
  2. Hypervel
  3. \
  4. Passport
  5. \
  6. Contracts
  7. \
  8. OAuthenticatable

OAuthenticatable

interface OAuthenticatable implements Authenticatable

Methods

string
getAuthIdentifierName()

Get the name of the unique identifier for the user.

from  Authenticatable
mixed
getAuthIdentifier()

Get the unique identifier for the user.

from  Authenticatable
string
getAuthPasswordName()

Get the name of the password attribute for the user.

from  Authenticatable
string|null
getAuthPassword()

Get the password for the user.

from  Authenticatable
string|null
getRememberToken()

Get the token value for the "remember me" session.

from  Authenticatable
void
setRememberToken(string|null $value)

Set the token value for the "remember me" session.

from  Authenticatable
string
getRememberTokenName()

Get the column name for the "remember me" token.

from  Authenticatable
MorphMany
oauthApps()

Get all the user's registered OAuth applications.

HasMany
tokens()

Get all the access tokens for the user.

bool
tokenCan(string $scope)

Determine if the current API token has a given scope.

bool
tokenCant(string $scope)

Determine if the current API token is missing a given scope.

PersonalAccessTokenResult
createToken(string $name, array $scopes = [])

Create a new personal access token for the user.

ScopeAuthorizable|null
currentAccessToken()

Get the access token currently associated with the user.

OAuthenticatable
withAccessToken(ScopeAuthorizable|null $accessToken)

Set the current access token for the user.

string
getProviderName()

Get the user provider name.

Details

in Authenticatable at line 12
string getAuthIdentifierName()

Get the name of the unique identifier for the user.

Return Value

string

in Authenticatable at line 17
mixed getAuthIdentifier()

Get the unique identifier for the user.

Return Value

mixed

in Authenticatable at line 22
string getAuthPasswordName()

Get the name of the password attribute for the user.

Return Value

string

in Authenticatable at line 27
string|null getAuthPassword()

Get the password for the user.

Return Value

string|null

in Authenticatable at line 32
string|null getRememberToken()

Get the token value for the "remember me" session.

Return Value

string|null

in Authenticatable at line 37
void setRememberToken(string|null $value)

Set the token value for the "remember me" session.

Parameters

string|null $value

Return Value

void

in Authenticatable at line 42
string getRememberTokenName()

Get the column name for the "remember me" token.

Return Value

string

at line 22
MorphMany oauthApps()

Get all the user's registered OAuth applications.

Return Value

MorphMany

at line 29
HasMany tokens()

Get all the access tokens for the user.

Return Value

HasMany

at line 34
bool tokenCan(string $scope)

Determine if the current API token has a given scope.

Parameters

string $scope

Return Value

bool

at line 39
bool tokenCant(string $scope)

Determine if the current API token is missing a given scope.

Parameters

string $scope

Return Value

bool

at line 46
PersonalAccessTokenResult createToken(string $name, array $scopes = [])

Create a new personal access token for the user.

Parameters

string $name
array $scopes

Return Value

PersonalAccessTokenResult

at line 51
ScopeAuthorizable|null currentAccessToken()

Get the access token currently associated with the user.

Return Value

ScopeAuthorizable|null

at line 56
OAuthenticatable withAccessToken(ScopeAuthorizable|null $accessToken)

Set the current access token for the user.

Parameters

ScopeAuthorizable|null $accessToken

Return Value

OAuthenticatable

at line 61
string getProviderName()

Get the user provider name.

Return Value

string