DeveloperAccessToken  

class DeveloperAccessToken extends AccessToken

Constants

LAST_ACTIVITY_UPDATE_DIFF

Difference from the current `last_activity_at` attribute value before `updateLastSeen()` will update the attribute on the DB. Measured in seconds.

Properties

bool $timestamps Indicates if the model should be timestamped. Turn off by default. from AbstractModel
protected callable[] $afterSaveCallbacks An array of callbacks to be run once after the model is saved. from AbstractModel
protected callable[] $afterDeleteCallbacks An array of callbacks to be run once after the model is deleted. from AbstractModel
static $customRelations from AbstractModel
static $dateAttributes from AbstractModel
static $defaults from AbstractModel
protected $table from AccessToken
protected $dates from AccessToken
static protected array $models A map of access token types, as specified in the `type` column, to their classes. from AccessToken
static $type
static protected $lifetime
int $id from AccessToken
string $token from AccessToken
int $user_id from AccessToken
Carbon $created_at from AccessToken
Carbon|null $last_activity_at from AccessToken
string $title from AccessToken
string $last_ip_address from AccessToken
string $last_user_agent from AccessToken
User|null $user from AccessToken

Methods

static 
boot()

{@inheritdoc}

from AbstractModel
__construct(array $attributes = [])

{@inheritdoc}

from AbstractModel
array
getDates()

Get the attributes that should be converted to dates.

from AbstractModel
mixed
getAttribute(string $key)

Get an attribute from the model. If nothing is found, attempt to load a custom relation method with this key.

from AbstractModel
mixed
getCustomRelation(string $name)

Get a custom relation object.

from AbstractModel
void
afterSave(callable $callback)

Register a callback to be run once after the model is saved.

from AbstractModel
void
afterDelete(callable $callback)

Register a callback to be run once after the model is deleted.

from AbstractModel
callable[]
releaseAfterSaveCallbacks()

No description

from AbstractModel
callable[]
releaseAfterDeleteCallbacks()

No description

from AbstractModel
__call($method, $arguments)

{@inheritdoc}

from AbstractModel
static AccessToken
generate(int $userId)

Generate an access token for the specified user.

from AccessToken
bool
touch(ServerRequestInterface $request = null)

Update the time of last usage of a token.

from AccessToken
BelongsTo
user()

Define the relationship with the owner of this access token.

from AccessToken
static 
scopeValid(Builder $query, Carbon $date)

Filters which tokens are valid at the given date for this particular token type.

from AccessToken
static 
scopeExpired(Builder $query, Carbon $date)

Filters which tokens are expired at the given date and ready for garbage collection.

from AccessToken
static AccessToken|null
findValid(string $token)

Shortcut to find a valid token.

from AccessToken
scopeWhereValid(Builder $query, Carbon $date = null)

This query scope is intended to be used on the base AccessToken object to query for valid tokens of any type.

from AccessToken
scopeWhereExpired(Builder $query, Carbon $date = null)

This query scope is intended to be used on the base AccessToken object to query for expired tokens of any type.

from AccessToken
AccessToken|object
newFromBuilder(array $attributes = [], string|null $connection = null)

Create a new model instance according to the access token type.

from AccessToken
static array
getModels()

Get the type-to-model map.

from AccessToken
static void
setModel(string $type, string $model)

Set the model for the given access token type.

from AccessToken

Details

in AbstractModel at line 65
static boot()

{@inheritdoc}

in AbstractModel at line 85
__construct(array $attributes = [])

{@inheritdoc}

Parameters

array $attributes

in AbstractModel at line 105
array getDates()

Get the attributes that should be converted to dates.

Return Value

array

in AbstractModel at line 123
mixed getAttribute(string $key)

Get an attribute from the model. If nothing is found, attempt to load a custom relation method with this key.

Parameters

string $key

Return Value

mixed

in AbstractModel at line 149
protected mixed getCustomRelation(string $name)

Get a custom relation object.

Parameters

string $name

Return Value

mixed

in AbstractModel at line 165
void afterSave(callable $callback)

Register a callback to be run once after the model is saved.

Parameters

callable $callback

Return Value

void

in AbstractModel at line 176
void afterDelete(callable $callback)

Register a callback to be run once after the model is deleted.

Parameters

callable $callback

Return Value

void

in AbstractModel at line 184
callable[] releaseAfterSaveCallbacks()

Return Value

callable[]

in AbstractModel at line 196
callable[] releaseAfterDeleteCallbacks()

Return Value

callable[]

in AbstractModel at line 208
__call($method, $arguments)

{@inheritdoc}

Parameters

$method
$arguments

in AccessToken at line 78
static AccessToken generate(int $userId)

Generate an access token for the specified user.

Parameters

int $userId

Return Value

AccessToken

in AccessToken at line 102
bool touch(ServerRequestInterface $request = null)

Update the time of last usage of a token.

If a request object is provided, the IP address and User Agent will also be logged.

Parameters

ServerRequestInterface $request

Return Value

bool

in AccessToken at line 132
BelongsTo user()

Define the relationship with the owner of this access token.

Return Value

BelongsTo

in AccessToken at line 143
static protected scopeValid(Builder $query, Carbon $date)

Filters which tokens are valid at the given date for this particular token type.

Uses the static::$lifetime value by default, can be overridden by children classes.

Parameters

Builder $query
Carbon $date

in AccessToken at line 156
static protected scopeExpired(Builder $query, Carbon $date)

Filters which tokens are expired at the given date and ready for garbage collection.

Uses the static::$lifetime value by default, can be overridden by children classes.

Parameters

Builder $query
Carbon $date

in AccessToken at line 170
static AccessToken|null findValid(string $token)

Shortcut to find a valid token.

Parameters

string $token Token as sent by the user. We allow non-string values like null so we can directly feed any value from a request.

Return Value

AccessToken|null

in AccessToken at line 180
scopeWhereValid(Builder $query, Carbon $date = null)

This query scope is intended to be used on the base AccessToken object to query for valid tokens of any type.

Parameters

Builder $query
Carbon $date

in AccessToken at line 201
scopeWhereExpired(Builder $query, Carbon $date = null)

This query scope is intended to be used on the base AccessToken object to query for expired tokens of any type.

Parameters

Builder $query
Carbon $date

in AccessToken at line 224
AccessToken|object newFromBuilder(array $attributes = [], string|null $connection = null)

Create a new model instance according to the access token type.

Parameters

array $attributes
string|null $connection

Return Value

AccessToken|object

in AccessToken at line 249
static array getModels()

Get the type-to-model map.

Return Value

array

in AccessToken at line 261
static void setModel(string $type, string $model)

Set the model for the given access token type.

Parameters

string $type The access token type.
string $model The class name of the model for that type.

Return Value

void