AccessToken
class AccessToken extends AbstractModel
Constants
| LAST_ACTIVITY_UPDATE_DIFF |
<p>Difference from the current <code>last_activity_at</code> attribute value before <code>updateLastSeen()</code> will update the attribute on the DB. Measured in seconds.</p> |
Properties
| bool | $timestamps | <p>Indicates if the model should be timestamped. Turn off by default.</p> | from AbstractModel |
|
| protected callable[] | $afterSaveCallbacks | <p>An array of callbacks to be run once after the model is saved.</p> | from AbstractModel |
|
| protected callable[] | $afterDeleteCallbacks | <p>An array of callbacks to be run once after the model is deleted.</p> | from AbstractModel |
|
| static | $customRelations | from AbstractModel |
|
|
| static | $dateAttributes | from AbstractModel |
|
|
| static | $defaults | from AbstractModel |
|
|
| int | $id |
|
||
| protected | $table |
|
||
| protected | $dates |
|
||
| static protected array | $models | <p>A map of access token types, as specified in the <code>type</code> column, to their classes.</p> |
|
|
| string | $type |
|
||
| static protected int | $lifetime | <p>How long this access token should be valid from the time of last activity.</p> |
|
|
| string | $token |
|
||
| int | $user_id |
|
||
| Carbon | $created_at |
|
||
| Carbon|null | $last_activity_at |
|
||
| string | $title |
|
||
| string|null | $last_ip_address |
|
||
| string|null | $last_user_agent |
|
||
| User|null | $user |
|
Methods
<p>Get an attribute from the model. If nothing is found, attempt to load a custom relation method with this key.</p>
<p>Register a callback to be run once after the model is saved.</p>
<p>Register a callback to be run once after the model is deleted.</p>
<p>Filters which tokens are valid at the given date for this particular token type.</p>
<p>Filters which tokens are expired at the given date and ready for garbage collection.</p>
<p>This query scope is intended to be used on the base AccessToken object to query for valid tokens of any type.</p>
<p>This query scope is intended to be used on the base AccessToken object to query for expired tokens of any type.</p>
<p>Create a new model instance according to the access token type.</p>
<p>Set the model for the given access token type.</p>
Details
in AbstractModel
at
line 67
static
boot()
<p>{@inheritdoc}</p>
in AbstractModel
at
line 87
__construct(array $attributes = [])
<p>{@inheritdoc}</p>
in AbstractModel
at
line 107
array
getDates()
<p>Get the attributes that should be converted to dates.</p>
in AbstractModel
at
line 125
mixed
getAttribute(string $key)
<p>Get an attribute from the model. If nothing is found, attempt to load a custom relation method with this key.</p>
in AbstractModel
at
line 151
protected mixed
getCustomRelation(string $name)
<p>Get a custom relation object.</p>
in AbstractModel
at
line 167
void
afterSave(callable $callback)
<p>Register a callback to be run once after the model is saved.</p>
in AbstractModel
at
line 178
void
afterDelete(callable $callback)
<p>Register a callback to be run once after the model is deleted.</p>
in AbstractModel
at
line 186
callable[]
releaseAfterSaveCallbacks()
in AbstractModel
at
line 198
callable[]
releaseAfterDeleteCallbacks()
in AbstractModel
at
line 210
__call($method, $arguments)
<p>{@inheritdoc}</p>
at
line 78
static AccessToken
generate(int $userId)
<p>Generate an access token for the specified user.</p>
at
line 102
bool
touch(ServerRequestInterface $request = null)
<p>Update the time of last usage of a token.</p>
<p>If a request object is provided, the IP address and User Agent will also be logged.</p>
at
line 132
BelongsTo
user()
<p>Define the relationship with the owner of this access token.</p>
at
line 143
static protected
scopeValid(Builder $query, Carbon $date)
<p>Filters which tokens are valid at the given date for this particular token type.</p>
<p>Uses the static::$lifetime value by default, can be overridden by children classes.</p>
at
line 156
static protected
scopeExpired(Builder $query, Carbon $date)
<p>Filters which tokens are expired at the given date and ready for garbage collection.</p>
<p>Uses the static::$lifetime value by default, can be overridden by children classes.</p>
at
line 170
static AccessToken|null
findValid(string $token)
<p>Shortcut to find a valid token.</p>
at
line 180
scopeWhereValid(Builder $query, Carbon $date = null)
<p>This query scope is intended to be used on the base AccessToken object to query for valid tokens of any type.</p>
at
line 201
scopeWhereExpired(Builder $query, Carbon $date = null)
<p>This query scope is intended to be used on the base AccessToken object to query for expired tokens of any type.</p>
at
line 224
AccessToken|object
newFromBuilder(array $attributes = [], string|null $connection = null)
<p>Create a new model instance according to the access token type.</p>
at
line 249
static array
getModels()
<p>Get the type-to-model map.</p>
at
line 261
static void
setModel(string $type, string $model)
<p>Set the model for the given access token type.</p>