Route
extends Model
in package
Uses
Timezonable, SoftDelete
Clake\Userextended\Models\Route
Tags
Table of Contents
- $attachMany : mixed
- $attachOne : mixed
- $attempts : int
- $belongsTo : mixed
- $belongsToMany : mixed
- $cascade : int
- $created_at : Carbon|null
- $deleted_at : Carbon|null
- $description : string
- $enabled : int
- $hasMany : mixed
- $hasOne : array<string|int, mixed>
- $id : int
- $last_accessed_at : string|null
- $morphMany : mixed
- $morphOne : mixed
- $morphTo : mixed
- $route : string
- $table : string
- $updated_at : Carbon|null
- $dates : array<string|int, mixed>
- $fillable : array<string|int, mixed>
- $forceDeleting : bool
- Indicates if the model is currently force deleting.
- $guarded : array<string|int, mixed>
- $jsonable : mixed
- $timezonable : array<string|int, mixed>
- all() :
- bootSoftDelete() : void
- Boot the soft deleting trait for a model.
- bootTimezonable() : mixed
- Called by the system on runtime, Binds an event to the model to adjust timezones
- forceDelete() : void
- Force a hard delete on a soft deleted model.
- get() :
- getDeletedAtColumn() : string
- Get the name of the "deleted at" column.
- getPossibleRoutes() : mixed
- getQualifiedDeletedAtColumn() : string
- Get the fully qualified "deleted at" column.
- getTime() : mixed
- Returns a timestamp adjusted by the logged in users Timezone
- getTimezonableAttributes() : array<string|int, mixed>
- Returns a collection of fields that will be encrypted.
- isSoftDelete() : bool
- Helper method to check if the model is currently being hard or soft deleted, useful in events.
- newModelQuery() :
- newQuery() :
- onlyTrashed() : Builder|static
- Get a new query builder that only includes soft deletes.
- query() :
- restore() : bool|null
- Restore a soft-deleted model instance.
- restored() : void
- Register a restored model event with the dispatcher.
- restoring() : void
- Register a restoring model event with the dispatcher.
- timezonify() : mixed
- Returns a timestamp adjusted by the logged in users Timezone Alias for getTime()
- trashed() : bool
- Determine if the model instance has been soft-deleted.
- whereAttempts() :
- whereCascade() :
- whereCreatedAt() :
- whereDeletedAt() :
- whereDescription() :
- whereEnabled() :
- whereId() :
- whereLastAccessedAt() :
- whereRoute() :
- whereUpdatedAt() :
- withTrashed() : Builder|static
- Get a new query builder that includes soft deletes.
- performDeleteOnModel() : mixed
- Perform the actual delete query on this model instance.
- performRestoreOnRelations() : void
- Locates relations with softDelete flag and cascades the restore event.
- performSoftDeleteOnRelations() : void
- Locates relations with softDelete flag and cascades the delete event.
- runSoftDelete() : void
- Perform the actual delete query on this model instance.
Properties
$attachMany
public
mixed
$attachMany
= []
$attachOne
public
mixed
$attachOne
= []
$attempts
public
int
$attempts
$belongsTo
public
mixed
$belongsTo
= []
$belongsToMany
public
mixed
$belongsToMany
= ['restrictions' => ['Clake\Userextended\Models\RouteRestriction', 'otherKey' => 'restriction_id', 'key' => 'route_Id', 'table' => 'clake_userextended_routes_pivot']]
$cascade
public
int
$cascade
$created_at
public
Carbon|null
$created_at
$deleted_at
public
Carbon|null
$deleted_at
$description
public
string
$description
$enabled
public
int
$enabled
$hasMany
public
mixed
$hasMany
= []
$hasOne
public
array<string|int, mixed>
$hasOne
= []
Relations
$id
public
int
$id
$last_accessed_at
public
string|null
$last_accessed_at
$morphMany
public
mixed
$morphMany
= []
$morphOne
public
mixed
$morphOne
= []
$morphTo
public
mixed
$morphTo
= []
$route
public
string
$route
$table
public
string
$table
= 'clake_userextended_routes'
The database table used by the model.
$updated_at
public
Carbon|null
$updated_at
$dates
protected
array<string|int, mixed>
$dates
= ['deleted_at']
$fillable
protected
array<string|int, mixed>
$fillable
= []
Fillable fields
$forceDeleting
Indicates if the model is currently force deleting.
protected
bool
$forceDeleting
= false
$guarded
protected
array<string|int, mixed>
$guarded
= ['*']
Guarded fields
$jsonable
protected
mixed
$jsonable
= []
$timezonable
protected
array<string|int, mixed>
$timezonable
= ['last_accessed_at', 'updated_at', 'created_at', 'deleted_at']
Methods
all()
public
static all(mixed $columns) :
Parameters
- $columns : mixed
Return values
—bootSoftDelete()
Boot the soft deleting trait for a model.
public
static bootSoftDelete() : void
Return values
void —bootTimezonable()
Called by the system on runtime, Binds an event to the model to adjust timezones
public
static bootTimezonable() : mixed
Tags
Return values
mixed —forceDelete()
Force a hard delete on a soft deleted model.
public
forceDelete() : void
Return values
void —get()
public
static get(mixed $columns) :
Parameters
- $columns : mixed
Return values
—getDeletedAtColumn()
Get the name of the "deleted at" column.
public
getDeletedAtColumn() : string
Return values
string —getPossibleRoutes()
public
getPossibleRoutes() : mixed
Return values
mixed —getQualifiedDeletedAtColumn()
Get the fully qualified "deleted at" column.
public
getQualifiedDeletedAtColumn() : string
Return values
string —getTime()
Returns a timestamp adjusted by the logged in users Timezone
public
getTime( $timestamp[, UserExtended|null $user = null ]) : mixed
Parameters
- $timestamp :
- $user : UserExtended|null = null
Return values
mixed —getTimezonableAttributes()
Returns a collection of fields that will be encrypted.
public
getTimezonableAttributes() : array<string|int, mixed>
Return values
array<string|int, mixed> —isSoftDelete()
Helper method to check if the model is currently being hard or soft deleted, useful in events.
public
isSoftDelete() : bool
Return values
bool —newModelQuery()
public
static newModelQuery() :
Return values
—newQuery()
public
static newQuery() :
Return values
—onlyTrashed()
Get a new query builder that only includes soft deletes.
public
static onlyTrashed() : Builder|static
Return values
Builder|static —query()
public
static query() :
Return values
—restore()
Restore a soft-deleted model instance.
public
restore() : bool|null
Return values
bool|null —restored()
Register a restored model event with the dispatcher.
public
static restored(Closure|string $callback) : void
Parameters
- $callback : Closure|string
Return values
void —restoring()
Register a restoring model event with the dispatcher.
public
static restoring(Closure|string $callback) : void
Parameters
- $callback : Closure|string
Return values
void —timezonify()
Returns a timestamp adjusted by the logged in users Timezone Alias for getTime()
public
timezonify( $timestamp) : mixed
Parameters
Return values
mixed —trashed()
Determine if the model instance has been soft-deleted.
public
trashed() : bool
Return values
bool —whereAttempts()
public
static whereAttempts(mixed $value) :
Parameters
- $value : mixed
Return values
—whereCascade()
public
static whereCascade(mixed $value) :
Parameters
- $value : mixed
Return values
—whereCreatedAt()
public
static whereCreatedAt(mixed $value) :
Parameters
- $value : mixed
Return values
—whereDeletedAt()
public
static whereDeletedAt(mixed $value) :
Parameters
- $value : mixed
Return values
—whereDescription()
public
static whereDescription(mixed $value) :
Parameters
- $value : mixed
Return values
—whereEnabled()
public
static whereEnabled(mixed $value) :
Parameters
- $value : mixed
Return values
—whereId()
public
static whereId(mixed $value) :
Parameters
- $value : mixed
Return values
—whereLastAccessedAt()
public
static whereLastAccessedAt(mixed $value) :
Parameters
- $value : mixed
Return values
—whereRoute()
public
static whereRoute(mixed $value) :
Parameters
- $value : mixed
Return values
—whereUpdatedAt()
public
static whereUpdatedAt(mixed $value) :
Parameters
- $value : mixed
Return values
—withTrashed()
Get a new query builder that includes soft deletes.
public
static withTrashed() : Builder|static
Return values
Builder|static —performDeleteOnModel()
Perform the actual delete query on this model instance.
protected
performDeleteOnModel() : mixed
Return values
mixed —performRestoreOnRelations()
Locates relations with softDelete flag and cascades the restore event.
protected
performRestoreOnRelations() : void
Return values
void —performSoftDeleteOnRelations()
Locates relations with softDelete flag and cascades the delete event.
protected
performSoftDeleteOnRelations() : void
Return values
void —runSoftDelete()
Perform the actual delete query on this model instance.
protected
runSoftDelete() : void