SessionAccessToken  

class SessionAccessToken extends AccessToken

Traits

ScopeVisibilityTrait

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 $customCasts from AbstractModel
static $defaults from AbstractModel
protected string|null $tableAlias <p>An alias for the table name, used in queries.</p> from AbstractModel
int $id from AccessToken
static protected $visibilityScopers from ScopeVisibilityTrait
protected $table from AccessToken
protected $dates from AccessToken
static protected array $models <p>A map of access token types, as specified in the <code>type</code> column, to their classes.</p> from AccessToken
static $type
static protected $lifetime
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|null $last_ip_address from AccessToken
string|null $last_user_agent from AccessToken
User|null $user from AccessToken
protected $hidden

Methods

static 
boot()

<p>{@inheritdoc}</p>

from AbstractModel
__construct(array $attributes = [])

<p>{@inheritdoc}</p>

from AbstractModel
getCasts()

<p>{@inheritdoc}</p>

from AbstractModel
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>

from AbstractModel
mixed
getCustomRelation(string $name)

<p>Get a custom relation object.</p>

from AbstractModel
void
afterSave(callable $callback)

<p>Register a callback to be run once after the model is saved.</p>

from AbstractModel
void
afterDelete(callable $callback)

<p>Register a callback to be run once after the model is deleted.</p>

from AbstractModel
callable[]
releaseAfterSaveCallbacks()

No description

from AbstractModel
callable[]
releaseAfterDeleteCallbacks()

No description

from AbstractModel
__call($method, $arguments)

<p>{@inheritdoc}</p>

from AbstractModel
newModelQuery()

No description

from AbstractModel
qualifyColumn($column)

No description

from AbstractModel
withTableAlias(callable $callback)

No description

from AbstractModel
newCollection(Collection|array $models = [])

No description

from AbstractModel
static 
registerVisibilityScoper($scoper, $ability = null)

No description

from ScopeVisibilityTrait
scopeWhereVisibleTo(Builder $query, User $actor, string $ability = 'view')

<p>Scope a query to only include records that are visible to a user.</p>

from ScopeVisibilityTrait
static AccessToken
generate(int $userId)

<p>Generate an access token for the specified user.</p>

from AccessToken
bool
touch(ServerRequestInterface $request = null)

<p>Update the time of last usage of a token.</p>

from AccessToken
BelongsTo
user()

<p>Define the relationship with the owner of this access token.</p>

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

<p>Filters which tokens are valid at the given date for this particular token type.</p>

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

<p>Filters which tokens are expired at the given date and ready for garbage collection.</p>

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

<p>Shortcut to find a valid token.</p>

from AccessToken
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>

from AccessToken
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>

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

<p>Create a new model instance according to the access token type.</p>

from AccessToken
static array
getModels()

<p>Get the type-to-model map.</p>

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

<p>Set the model for the given access token type.</p>

from AccessToken

Details

in AbstractModel at line 77
static boot()

<p>{@inheritdoc}</p>

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

<p>{@inheritdoc}</p>

Parameters

array $attributes

in AbstractModel at line 115
getCasts()

<p>{@inheritdoc}</p>

in AbstractModel at line 133
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>

Parameters

string $key

Return Value

mixed

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

<p>Get a custom relation object.</p>

Parameters

string $name

Return Value

mixed

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

<p>Register a callback to be run once after the model is saved.</p>

Parameters

callable $callback

Return Value

void

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

<p>Register a callback to be run once after the model is deleted.</p>

Parameters

callable $callback

Return Value

void

in AbstractModel at line 194
callable[] releaseAfterSaveCallbacks()

Return Value

callable[]

in AbstractModel at line 206
callable[] releaseAfterDeleteCallbacks()

Return Value

callable[]

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

<p>{@inheritdoc}</p>

Parameters

$method
$arguments

in AbstractModel at line 227
newModelQuery()

in AbstractModel at line 238
qualifyColumn($column)

Parameters

$column

in AbstractModel at line 247
withTableAlias(callable $callback)

Parameters

callable $callback

in AbstractModel at line 262
newCollection(Collection|array $models = [])

Parameters

Collection|array $models

in ScopeVisibilityTrait at line 20
static registerVisibilityScoper($scoper, $ability = null)

Parameters

$scoper
$ability

in ScopeVisibilityTrait at line 41
scopeWhereVisibleTo(Builder $query, User $actor, string $ability = 'view')

<p>Scope a query to only include records that are visible to a user.</p>

Parameters

Builder $query
User $actor
string $ability

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

<p>Generate an access token for the specified user.</p>

Parameters

int $userId

Return Value

AccessToken

in AccessToken at line 105
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>

Parameters

ServerRequestInterface $request

Return Value

bool

in AccessToken at line 135
BelongsTo user()

<p>Define the relationship with the owner of this access token.</p>

Return Value

BelongsTo

in AccessToken at line 146
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>

Parameters

Builder $query
Carbon $date

in AccessToken at line 159
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>

Parameters

Builder $query
Carbon $date

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

<p>Shortcut to find a valid token.</p>

Parameters

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

Return Value

AccessToken|null

in AccessToken at line 183
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>

Parameters

Builder $query
Carbon $date

in AccessToken at line 204
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>

Parameters

Builder $query
Carbon $date

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

<p>Create a new model instance according to the access token type.</p>

Parameters

array $attributes
string|null $connection

Return Value

AccessToken|object

in AccessToken at line 252
static array getModels()

<p>Get the type-to-model map.</p>

Return Value

array

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

<p>Set the model for the given access token type.</p>

Parameters

string $type <p>The access token type.</p>
string $model <p>The class name of the model for that type.</p>

Return Value

void