EmailToken  

class EmailToken extends AbstractModel

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 $customCasts from AbstractModel
static $defaults from AbstractModel
int|null $id from AbstractModel
protected array $dates The attributes that should be mutated to dates.
bool $incrementing Use a custom primary key for this model.
protected $primaryKey {@inheritdoc}
string $token
int $user_id
Carbon $created_at
string $email

Methods

static 
boot()

{@inheritdoc}

from AbstractModel
__construct(array $attributes = [])

{@inheritdoc}

from AbstractModel
getCasts()

{@inheritdoc}

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 EmailToken
generate(string $email, int $userId)

Generate an email token for the specified user.

BelongsTo
user()

Define the relationship with the owner of this email token.

EmailToken
scopeValidOrFail(Builder $query, string $id)

Find the token with the given ID, and assert that it has not expired.

Details

in AbstractModel at line 67
static boot()

{@inheritdoc}

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

{@inheritdoc}

Parameters

array $attributes

in AbstractModel at line 105
getCasts()

{@inheritdoc}

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

at line 52
static EmailToken generate(string $email, int $userId)

Generate an email token for the specified user.

Parameters

string $email
int $userId

Return Value

EmailToken

at line 69
BelongsTo user()

Define the relationship with the owner of this email token.

Return Value

BelongsTo

at line 82
EmailToken scopeValidOrFail(Builder $query, string $id)

Find the token with the given ID, and assert that it has not expired.

Parameters

Builder $query
string $id

Return Value

EmailToken

Exceptions

InvalidConfirmationTokenException