1. class
  2. Illuminate
  3. Database
  4. Eloquent
  5. Model

Model

class Model implements ArrayAccess, Arrayable, Jsonable, JsonSerializable, QueueableEntity, UrlRoutable (View source)

Constants

CREATED_AT

The name of the "created at" column.
UPDATED_AT

The name of the "updated at" column.

Properties

bool $incrementing Indicates if the IDs are auto-incrementing.
bool $timestamps Indicates if the model should be timestamped.
bool $exists Indicates if the model exists.
bool $wasRecentlyCreated Indicates if the model was inserted during the current request lifecycle.
static bool $snakeAttributes Indicates whether attributes are snake cased on arrays.
static array $manyMethods The many to many relationship methods.

Methods

void
__construct( array $attributes = array())

Create a new Eloquent model instance.

static  void
clearBootedModels()

Clear the list of booted models so they will be re-booted.

static  mixed
addGlobalScope( Scope|Closure|string $scope, Closure $implementation = null)

Register a new global scope on the model.

static  bool
hasGlobalScope( Scope|string $scope)

Determine if a model has a global scope.

static  Scope|Closure|null
getGlobalScope( Scope|string $scope)

Get a global scope registered with the model.

array
getGlobalScopes()

Get the global scopes for this class instance.

static  void
observe( object|string $class, int $priority)

Register an observer with the Model.

$this
fill( array $attributes)

Fill the model with an array of attributes.

$this
forceFill( array $attributes)

Fill the model with an array of attributes. Force mass assignment.

Model
newInstance( array $attributes = array(), bool $exists = false)

Create a new instance of the given model.

Model
newFromBuilder( array $attributes = array(), string|null $connection = null)

Create a new model instance that is existing.

static  Collection
hydrate( array $items, string|null $connection = null)

Create a collection of models from plain arrays.

static  Collection
hydrateRaw( string $query, array $bindings = array(), string|null $connection = null)

Create a collection of models from a raw query.

static  Model
create( array $attributes = array())

Save a new model and return the instance.

static  Model
forceCreate( array $attributes)

Save a new model and return the instance. Allow mass-assignment.

static  Builder
query()

Begin querying the model.

static  Builder
on( string|null $connection = null)

Begin querying the model on a given connection.

static  Builder
onWriteConnection()

Begin querying the model on the write connection.

static  Collection|Model[]
all( array|mixed $columns = array('*'))

Get all of the models from the database.

$this|null
fresh( array|string $with = array())

Reload a fresh model instance from the database.

$this
load( array|string $relations)

Eager load relations on the model.

static  Builder|Model
with( array|string $relations)

Begin querying a model with eager loading.

$this
append( array|string $attributes)

Append attributes to query when building a query.

HasOne
hasOne( string $related, string $foreignKey = null, string $localKey = null)

Define a one-to-one relationship.

MorphOne
morphOne( string $related, string $name, string $type = null, string $id = null, string $localKey = null)

Define a polymorphic one-to-one relationship.

BelongsTo
belongsTo( string $related, string $foreignKey = null, string $otherKey = null, string $relation = null)

Define an inverse one-to-one or many relationship.

MorphTo
morphTo( string $name = null, string $type = null, string $id = null)

Define a polymorphic, inverse one-to-one or many relationship.

string
getActualClassNameForMorph( string $class)

Retrieve the fully qualified class name from a slug.

HasMany
hasMany( string $related, string $foreignKey = null, string $localKey = null)

Define a one-to-many relationship.

HasManyThrough
hasManyThrough( string $related, string $through, string|null $firstKey = null, string|null $secondKey = null, string|null $localKey = null)

Define a has-many-through relationship.

MorphMany
morphMany( string $related, string $name, string $type = null, string $id = null, string $localKey = null)

Define a polymorphic one-to-many relationship.

BelongsToMany
belongsToMany( string $related, string $table = null, string $foreignKey = null, string $otherKey = null, string $relation = null)

Define a many-to-many relationship.

MorphToMany
morphToMany( string $related, string $name, string $table = null, string $foreignKey = null, string $otherKey = null, bool $inverse = false)

Define a polymorphic many-to-many relationship.

MorphToMany
morphedByMany( string $related, string $name, string $table = null, string $foreignKey = null, string $otherKey = null)

Define a polymorphic, inverse many-to-many relationship.

string
joiningTable( string $related)

Get the joining table name for a many-to-many relation.

static  int
destroy( array|int $ids)

Destroy the models for the given IDs.

bool|null
delete()

Delete the model from the database.

bool|null
forceDelete()

Force a hard delete on a soft deleted model.

static  void
saving( Closure|string $callback, int $priority)

Register a saving model event with the dispatcher.

static  void
saved( Closure|string $callback, int $priority)

Register a saved model event with the dispatcher.

static  void
updating( Closure|string $callback, int $priority)

Register an updating model event with the dispatcher.

static  void
updated( Closure|string $callback, int $priority)

Register an updated model event with the dispatcher.

static  void
creating( Closure|string $callback, int $priority)

Register a creating model event with the dispatcher.

static  void
created( Closure|string $callback, int $priority)

Register a created model event with the dispatcher.

static  void
deleting( Closure|string $callback, int $priority)

Register a deleting model event with the dispatcher.

static  void
deleted( Closure|string $callback, int $priority)

Register a deleted model event with the dispatcher.

static  void
flushEventListeners()

Remove all of the event listeners for the model.

array
getObservableEvents()

Get the observable event names.

$this
setObservableEvents( array $observables)

Set the observable event names.

void
addObservableEvents( array|mixed $observables)

Add an observable event name.

void
removeObservableEvents( array|mixed $observables)

Remove an observable event name.

bool|int
update( array $attributes = array(), array $options = array())

Update the model in the database.

bool
push()

Save the model and all of its relationships.

bool
save( array $options = array())

Save the model to the database.

bool
saveOrFail( array $options = array())

Save the model to the database using transaction.

void
touchOwners()

Touch the owning relations of the model.

bool
touches( string $relation)

Determine if the model touches a given relation.

bool
touch()

Update the model's update timestamp.

$this
setCreatedAt( mixed $value)

Set the value of the "created at" attribute.

$this
setUpdatedAt( mixed $value)

Set the value of the "updated at" attribute.

string
getCreatedAtColumn()

Get the name of the "created at" column.

string
getUpdatedAtColumn()

Get the name of the "updated at" column.

Carbon
freshTimestamp()

Get a fresh timestamp for the model.

string
freshTimestampString()

Get a fresh timestamp for the model.

Builder
newQuery()

Get a new query builder for the model's table.

Builder
newQueryWithoutScope( Scope|string $scope)

Get a new query instance without a given scope.

Builder|Model
newQueryWithoutScopes()

Get a new query builder that doesn't have any global scopes.

Builder|Model
newEloquentBuilder( Builder $query)

Create a new Eloquent query builder for the model.

Collection
newCollection( array $models = array())

Create a new Eloquent Collection instance.

Pivot
newPivot( Model $parent, array $attributes, string $table, bool $exists)

Create a new pivot model instance.

string
getTable()

Get the table associated with the model.

$this
setTable( string $table)

Set the table associated with the model.

mixed
getKey()

Get the value of the model's primary key.

mixed
getQueueableId()

Get the queueable identity for the entity.

string
getKeyName()

Get the primary key for the model.

$this
setKeyName( string $key)

Set the primary key for the model.

string
getQualifiedKeyName()

Get the table qualified key name.

mixed
getRouteKey()

Get the value of the model's route key.

string
getRouteKeyName()

Get the route key for the model.

bool
usesTimestamps()

Determine if the model uses timestamps.

string
getMorphClass()

Get the class name for polymorphic relations.

int
getPerPage()

Get the number of models to return per page.

$this
setPerPage( int $perPage)

Set the number of models to return per page.

string
getForeignKey()

Get the default foreign key name for the model.

array
getHidden()

Get the hidden attributes for the model.

$this
setHidden( array $hidden)

Set the hidden attributes for the model.

void
addHidden( array|string|null $attributes = null)

Add hidden attributes for the model.

$this
makeVisible( array|string $attributes)

Make the given, typically hidden, attributes visible.

$this
withHidden( array|string $attributes)

Make the given, typically hidden, attributes visible.

array
getVisible()

Get the visible attributes for the model.

$this
setVisible( array $visible)

Set the visible attributes for the model.

void
addVisible( array|string|null $attributes = null)

Add visible attributes for the model.

$this
setAppends( array $appends)

Set the accessors to append to model arrays.

array
getFillable()

Get the fillable attributes for the model.

$this
fillable( array $fillable)

Set the fillable attributes for the model.

array
getGuarded()

Get the guarded attributes for the model.

$this
guard( array $guarded)

Set the guarded attributes for the model.

static  void
unguard( bool $state = true)

Disable all mass assignable restrictions.

static  void
reguard()

Enable the mass assignment restrictions.

static  bool
isUnguarded()

Determine if current state is "unguarded".

static  mixed
unguarded( callable $callback)

Run the given callable while being unguarded.

bool
isFillable( string $key)

Determine if the given attribute may be mass assigned.

bool
isGuarded( string $key)

Determine if the given key is guarded.

bool
totallyGuarded()

Determine if the model is totally guarded.

array
getTouchedRelations()

Get the relationships that are touched on save.

$this
setTouchedRelations( array $touches)

Set the relationships that are touched on save.

bool
getIncrementing()

Get the value indicating whether the IDs are incrementing.

$this
setIncrementing( bool $value)

Set whether IDs are incrementing.

string
toJson( int $options)

Convert the model instance to JSON.

array
jsonSerialize()

Convert the object into something JSON serializable.

array
toArray()

Convert the model instance to an array.

array
attributesToArray()

Convert the model's attributes to an array.

array
relationsToArray()

Get the model's relationships in array form.

mixed
getAttribute( string $key)

Get an attribute from the model.

mixed
getAttributeValue( string $key)

Get a plain attribute (not a relationship).

mixed
getRelationValue( string $key)

Get a relationship.

bool
hasGetMutator( string $key)

Determine if a get mutator exists for an attribute.

bool
hasCast( string $key, array|string|null $types = null)

Determine whether an attribute should be cast to a native type.

array
getCasts()

Get the casts array.

$this
setAttribute( string $key, mixed $value)

Set a given attribute on the model.

bool
hasSetMutator( string $key)

Determine if a set mutator exists for an attribute.

array
getDates()

Get the attributes that should be converted to dates.

string
fromDateTime( DateTime|int $value)

Convert a DateTime to a storable string.

$this
setDateFormat( string $format)

Set the date format used by the model.

mixed
fromJson( string $value, bool $asObject = false)

Decode the given JSON back into an array or object.

Model
replicate( array $except = null)

Clone the model into a new, non-existing instance.

array
getAttributes()

Get all of the current attributes on the model.

$this
setRawAttributes( array $attributes, bool $sync = false)

Set the array of model attributes. No checking is done.

mixed|array
getOriginal( string|null $key = null, mixed $default = null)

Get the model's original attribute values.

$this
syncOriginal()

Sync the original attributes with the current.

$this
syncOriginalAttribute( string $attribute)

Sync a single original attribute with its current value.

bool
isDirty( array|string|null $attributes = null)

Determine if the model or given attribute(s) have been modified.

array
getDirty()

Get the attributes that have been changed since last sync.

array
getRelations()

Get all the loaded relations for the instance.

mixed
getRelation( string $relation)

Get a specified relationship.

bool
relationLoaded( string $key)

Determine if the given relation is loaded.

$this
setRelation( string $relation, mixed $value)

Set the specific relationship in the model.

$this
setRelations( array $relations)

Set the entire relations array on the model.

Connection
getConnection()

Get the database connection for the model.

string
getConnectionName()

Get the current connection name for the model.

$this
setConnection( string $name)

Set the connection associated with the model.

static  Connection
resolveConnection( string|null $connection = null)

Resolve a connection instance.

static  ConnectionResolverInterface
getConnectionResolver()

Get the connection resolver instance.

static  void
setConnectionResolver( ConnectionResolverInterface $resolver)

Set the connection resolver instance.

static  void
unsetConnectionResolver()

Unset the connection resolver for models.

static  Dispatcher
getEventDispatcher()

Get the event dispatcher instance.

static  void
setEventDispatcher( Dispatcher $dispatcher)

Set the event dispatcher instance.

static  void
unsetEventDispatcher()

Unset the event dispatcher for models.

array
getMutatedAttributes()

Get the mutated attributes for a given instance.

static  void
cacheMutatedAttributes( string $class)

Extract and cache all the mutated attributes of a class.

mixed
__get( string $key)

Dynamically retrieve attributes on the model.

void
__set( string $key, mixed $value)

Dynamically set attributes on the model.

bool
offsetExists( mixed $offset)

Determine if the given attribute exists.

mixed
offsetGet( mixed $offset)

Get the value for a given offset.

void
offsetSet( mixed $offset, mixed $value)

Set the value for a given offset.

void
offsetUnset( mixed $offset)

Unset the value for a given offset.

bool
__isset( string $key)

Determine if an attribute exists on the model.

void
__unset( string $key)

Unset an attribute on the model.

mixed
__call( string $method, array $parameters)

Handle dynamic method calls into the model.

static  mixed
__callStatic( string $method, array $parameters)

Handle dynamic static method calls into the method.

string
__toString()

Convert the model to its string representation.

void
__wakeup()

When a model is being unserialized, check if it needs to be booted.

Details

at line line 275
void __construct( array $attributes = array())

Create a new Eloquent model instance.

Parameters

array $attributes

Return Value

void

at line line 333
static void clearBootedModels()

Clear the list of booted models so they will be re-booted.

Return Value

void

at line line 348
static mixed addGlobalScope( Scope|Closure|string $scope, Closure $implementation = null)

Register a new global scope on the model.

Parameters

Scope|Closure|string $scope
Closure $implementation

Return Value

mixed

Exceptions

InvalidArgumentException

at line line 371
static bool hasGlobalScope( Scope|string $scope)

Determine if a model has a global scope.

Parameters

Scope|string $scope

Return Value

bool

at line line 382
static Scope|Closure|null getGlobalScope( Scope|string $scope)

Get a global scope registered with the model.

Parameters

Scope|string $scope

Return Value

Scope|Closure|null

at line line 400
array getGlobalScopes()

Get the global scopes for this class instance.

Return Value

array

at line line 412
static void observe( object|string $class, int $priority)

Register an observer with the Model.

Parameters

object|string $class
int $priority

Return Value

void

at line line 436
$this fill( array $attributes)

Fill the model with an array of attributes.

Parameters

array $attributes

Return Value

$this

Exceptions

MassAssignmentException

at line line 462
$this forceFill( array $attributes)

Fill the model with an array of attributes. Force mass assignment.

Parameters

array $attributes

Return Value

$this

at line line 496
Model newInstance( array $attributes = array(), bool $exists = false)

Create a new instance of the given model.

Parameters

array $attributes
bool $exists

Return Value

Model

at line line 515
Model newFromBuilder( array $attributes = array(), string|null $connection = null)

Create a new model instance that is existing.

Parameters

array $attributes
string|null $connection

Return Value

Model

at line line 533
static Collection hydrate( array $items, string|null $connection = null)

Create a collection of models from plain arrays.

Parameters

array $items
string|null $connection

Return Value

Collection

at line line 552
static Collection hydrateRaw( string $query, array $bindings = array(), string|null $connection = null)

Create a collection of models from a raw query.

Parameters

string $query
array $bindings
string|null $connection

Return Value

Collection

at line line 567
static Model create( array $attributes = array())

Save a new model and return the instance.

Parameters

array $attributes

Return Value

Model

at line line 582
static Model forceCreate( array $attributes)

Save a new model and return the instance. Allow mass-assignment.

Parameters

array $attributes

Return Value

Model

at line line 599
static Builder query()

Begin querying the model.

Return Value

Builder

at line line 610
static Builder on( string|null $connection = null)

Begin querying the model on a given connection.

Parameters

string|null $connection

Return Value

Builder

at line line 627
static Builder onWriteConnection()

Begin querying the model on the write connection.

Return Value

Builder

at line line 640
static Collection|Model[] all( array|mixed $columns = array('*'))

Get all of the models from the database.

Parameters

array|mixed $columns

Return Value

Collection|Model[]

at line line 655
$this|null fresh( array|string $with = array())

Reload a fresh model instance from the database.

Parameters

array|string $with

Return Value

$this|null

at line line 672
$this load( array|string $relations)

Eager load relations on the model.

Parameters

array|string $relations

Return Value

$this

at line line 691
static Builder|Model with( array|string $relations)

Begin querying a model with eager loading.

Parameters

array|string $relations

Return Value

Builder|Model

at line line 708
$this append( array|string $attributes)

Append attributes to query when building a query.

Parameters

array|string $attributes

Return Value

$this

at line line 729
HasOne hasOne( string $related, string $foreignKey = null, string $localKey = null)

Define a one-to-one relationship.

Parameters

string $related
string $foreignKey
string $localKey

Return Value

HasOne

at line line 750
MorphOne morphOne( string $related, string $name, string $type = null, string $id = null, string $localKey = null)

Define a polymorphic one-to-one relationship.

Parameters

string $related
string $name
string $type
string $id
string $localKey

Return Value

MorphOne

at line line 772
BelongsTo belongsTo( string $related, string $foreignKey = null, string $otherKey = null, string $relation = null)

Define an inverse one-to-one or many relationship.

Parameters

string $related
string $foreignKey
string $otherKey
string $relation

Return Value

BelongsTo

at line line 810
MorphTo morphTo( string $name = null, string $type = null, string $id = null)

Define a polymorphic, inverse one-to-one or many relationship.

Parameters

string $name
string $type
string $id

Return Value

MorphTo

at line line 852
string getActualClassNameForMorph( string $class)

Retrieve the fully qualified class name from a slug.

Parameters

string $class

Return Value

string

at line line 865
HasMany hasMany( string $related, string $foreignKey = null, string $localKey = null)

Define a one-to-many relationship.

Parameters

string $related
string $foreignKey
string $localKey

Return Value

HasMany

at line line 886
HasManyThrough hasManyThrough( string $related, string $through, string|null $firstKey = null, string|null $secondKey = null, string|null $localKey = null)

Define a has-many-through relationship.

Parameters

string $related
string $through
string|null $firstKey
string|null $secondKey
string|null $localKey

Return Value

HasManyThrough

at line line 909
MorphMany morphMany( string $related, string $name, string $type = null, string $id = null, string $localKey = null)

Define a polymorphic one-to-many relationship.

Parameters

string $related
string $name
string $type
string $id
string $localKey

Return Value

MorphMany

at line line 935
BelongsToMany belongsToMany( string $related, string $table = null, string $foreignKey = null, string $otherKey = null, string $relation = null)

Define a many-to-many relationship.

Parameters

string $related
string $table
string $foreignKey
string $otherKey
string $relation

Return Value

BelongsToMany

at line line 979
MorphToMany morphToMany( string $related, string $name, string $table = null, string $foreignKey = null, string $otherKey = null, bool $inverse = false)

Define a polymorphic many-to-many relationship.

Parameters

string $related
string $name
string $table
string $foreignKey
string $otherKey
bool $inverse

Return Value

MorphToMany

at line line 1015
MorphToMany morphedByMany( string $related, string $name, string $table = null, string $foreignKey = null, string $otherKey = null)

Define a polymorphic, inverse many-to-many relationship.

Parameters

string $related
string $name
string $table
string $foreignKey
string $otherKey

Return Value

MorphToMany

at line line 1051
string joiningTable( string $related)

Get the joining table name for a many-to-many relation.

Parameters

string $related

Return Value

string

at line line 1076
static int destroy( array|int $ids)

Destroy the models for the given IDs.

Parameters

array|int $ids

Return Value

int

at line line 1108
bool|null delete()

Delete the model from the database.

Return Value

bool|null

Exceptions

Exception

at line line 1144
bool|null forceDelete()

Force a hard delete on a soft deleted model.

This method protects developers from running forceDelete when trait is missing.

Return Value

bool|null

at line line 1166
static void saving( Closure|string $callback, int $priority)

Register a saving model event with the dispatcher.

Parameters

Closure|string $callback
int $priority

Return Value

void

at line line 1178
static void saved( Closure|string $callback, int $priority)

Register a saved model event with the dispatcher.

Parameters

Closure|string $callback
int $priority

Return Value

void

at line line 1190
static void updating( Closure|string $callback, int $priority)

Register an updating model event with the dispatcher.

Parameters

Closure|string $callback
int $priority

Return Value

void

at line line 1202
static void updated( Closure|string $callback, int $priority)

Register an updated model event with the dispatcher.

Parameters

Closure|string $callback
int $priority

Return Value

void

at line line 1214
static void creating( Closure|string $callback, int $priority)

Register a creating model event with the dispatcher.

Parameters

Closure|string $callback
int $priority

Return Value

void

at line line 1226
static void created( Closure|string $callback, int $priority)

Register a created model event with the dispatcher.

Parameters

Closure|string $callback
int $priority

Return Value

void

at line line 1238
static void deleting( Closure|string $callback, int $priority)

Register a deleting model event with the dispatcher.

Parameters

Closure|string $callback
int $priority

Return Value

void

at line line 1250
static void deleted( Closure|string $callback, int $priority)

Register a deleted model event with the dispatcher.

Parameters

Closure|string $callback
int $priority

Return Value

void

at line line 1260
static void flushEventListeners()

Remove all of the event listeners for the model.

Return Value

void

at line line 1295
array getObservableEvents()

Get the observable event names.

Return Value

array

at line line 1313
$this setObservableEvents( array $observables)

Set the observable event names.

Parameters

array $observables

Return Value

$this

at line line 1326
void addObservableEvents( array|mixed $observables)

Add an observable event name.

Parameters

array|mixed $observables

Return Value

void

at line line 1339
void removeObservableEvents( array|mixed $observables)

Remove an observable event name.

Parameters

array|mixed $observables

Return Value

void

at line line 1416
bool|int update( array $attributes = array(), array $options = array())

Update the model in the database.

Parameters

array $attributes
array $options

Return Value

bool|int

at line line 1430
bool push()

Save the model and all of its relationships.

Return Value

bool

at line line 1459
bool save( array $options = array())

Save the model to the database.

Parameters

array $options

Return Value

bool

at line line 1499
bool saveOrFail( array $options = array())

Save the model to the database using transaction.

Parameters

array $options

Return Value

bool

Exceptions

Throwable

at line line 1631
void touchOwners()

Touch the owning relations of the model.

Return Value

void

at line line 1654
bool touches( string $relation)

Determine if the model touches a given relation.

Parameters

string $relation

Return Value

bool

at line line 1714
bool touch()

Update the model's update timestamp.

Return Value

bool

at line line 1749
$this setCreatedAt( mixed $value)

Set the value of the "created at" attribute.

Parameters

mixed $value

Return Value

$this

at line line 1762
$this setUpdatedAt( mixed $value)

Set the value of the "updated at" attribute.

Parameters

mixed $value

Return Value

$this

at line line 1774
string getCreatedAtColumn()

Get the name of the "created at" column.

Return Value

string

at line line 1784
string getUpdatedAtColumn()

Get the name of the "updated at" column.

Return Value

string

at line line 1794
Carbon freshTimestamp()

Get a fresh timestamp for the model.

Return Value

Carbon

at line line 1804
string freshTimestampString()

Get a fresh timestamp for the model.

Return Value

string

at line line 1814
Builder newQuery()

Get a new query builder for the model's table.

Return Value

Builder

at line line 1831
Builder newQueryWithoutScope( Scope|string $scope)

Get a new query instance without a given scope.

Parameters

Scope|string $scope

Return Value

Builder

at line line 1843
Builder|Model newQueryWithoutScopes()

Get a new query builder that doesn't have any global scopes.

Return Value

Builder|Model

at line line 1861
Builder|Model newEloquentBuilder( Builder $query)

Create a new Eloquent query builder for the model.

Parameters

Builder $query

Return Value

Builder|Model

at line line 1886
Collection newCollection( array $models = array())

Create a new Eloquent Collection instance.

Parameters

array $models

Return Value

Collection

at line line 1900
Pivot newPivot( Model $parent, array $attributes, string $table, bool $exists)

Create a new pivot model instance.

Parameters

Model $parent
array $attributes
string $table
bool $exists

Return Value

Pivot

at line line 1910
string getTable()

Get the table associated with the model.

Return Value

string

at line line 1925
$this setTable( string $table)

Set the table associated with the model.

Parameters

string $table

Return Value

$this

at line line 1937
mixed getKey()

Get the value of the model's primary key.

Return Value

mixed

at line line 1947
mixed getQueueableId()

Get the queueable identity for the entity.

Return Value

mixed

at line line 1957
string getKeyName()

Get the primary key for the model.

Return Value

string

at line line 1968
$this setKeyName( string $key)

Set the primary key for the model.

Parameters

string $key

Return Value

$this

at line line 1980
string getQualifiedKeyName()

Get the table qualified key name.

Return Value

string

at line line 1990
mixed getRouteKey()

Get the value of the model's route key.

Return Value

mixed

at line line 2000
string getRouteKeyName()

Get the route key for the model.

Return Value

string

at line line 2010
bool usesTimestamps()

Determine if the model uses timestamps.

Return Value

bool

at line line 2037
string getMorphClass()

Get the class name for polymorphic relations.

Return Value

string

at line line 2055
int getPerPage()

Get the number of models to return per page.

Return Value

int

at line line 2066
$this setPerPage( int $perPage)

Set the number of models to return per page.

Parameters

int $perPage

Return Value

$this

at line line 2078
string getForeignKey()

Get the default foreign key name for the model.

Return Value

string

at line line 2088
array getHidden()

Get the hidden attributes for the model.

Return Value

array

at line line 2099
$this setHidden( array $hidden)

Set the hidden attributes for the model.

Parameters

array $hidden

Return Value

$this

at line line 2112
void addHidden( array|string|null $attributes = null)

Add hidden attributes for the model.

Parameters

array|string|null $attributes

Return Value

void

at line line 2125
$this makeVisible( array|string $attributes)

Make the given, typically hidden, attributes visible.

Parameters

array|string $attributes

Return Value

$this

at line line 2140
$this withHidden( array|string $attributes)

Make the given, typically hidden, attributes visible.

Parameters

array|string $attributes

Return Value

$this

at line line 2150
array getVisible()

Get the visible attributes for the model.

Return Value

array

at line line 2161
$this setVisible( array $visible)

Set the visible attributes for the model.

Parameters

array $visible

Return Value

$this

at line line 2174
void addVisible( array|string|null $attributes = null)

Add visible attributes for the model.

Parameters

array|string|null $attributes

Return Value

void

at line line 2187
$this setAppends( array $appends)

Set the accessors to append to model arrays.

Parameters

array $appends

Return Value

$this

at line line 2199
array getFillable()

Get the fillable attributes for the model.

Return Value

array

at line line 2210
$this fillable( array $fillable)

Set the fillable attributes for the model.

Parameters

array $fillable

Return Value

$this

at line line 2222
array getGuarded()

Get the guarded attributes for the model.

Return Value

array

at line line 2233
$this guard( array $guarded)

Set the guarded attributes for the model.

Parameters

array $guarded

Return Value

$this

at line line 2246
static void unguard( bool $state = true)

Disable all mass assignable restrictions.

Parameters

bool $state

Return Value

void

at line line 2256
static void reguard()

Enable the mass assignment restrictions.

Return Value

void

at line line 2266
static bool isUnguarded()

Determine if current state is "unguarded".

Return Value

bool

at line line 2277
static mixed unguarded( callable $callback)

Run the given callable while being unguarded.

Parameters

callable $callback

Return Value

mixed

at line line 2298
bool isFillable( string $key)

Determine if the given attribute may be mass assigned.

Parameters

string $key

Return Value

bool

at line line 2324
bool isGuarded( string $key)

Determine if the given key is guarded.

Parameters

string $key

Return Value

bool

at line line 2334
bool totallyGuarded()

Determine if the model is totally guarded.

Return Value

bool

at line line 2359
array getTouchedRelations()

Get the relationships that are touched on save.

Return Value

array

at line line 2370
$this setTouchedRelations( array $touches)

Set the relationships that are touched on save.

Parameters

array $touches

Return Value

$this

at line line 2382
bool getIncrementing()

Get the value indicating whether the IDs are incrementing.

Return Value

bool

at line line 2393
$this setIncrementing( bool $value)

Set whether IDs are incrementing.

Parameters

bool $value

Return Value

$this

at line line 2406
string toJson( int $options)

Convert the model instance to JSON.

Parameters

int $options

Return Value

string

at line line 2416
array jsonSerialize()

Convert the object into something JSON serializable.

Return Value

array

at line line 2426
array toArray()

Convert the model instance to an array.

Return Value

array

at line line 2438
array attributesToArray()

Convert the model's attributes to an array.

Return Value

array

at line line 2529
array relationsToArray()

Get the model's relationships in array form.

Return Value

array

at line line 2599
mixed getAttribute( string $key)

Get an attribute from the model.

Parameters

string $key

Return Value

mixed

at line line 2614
mixed getAttributeValue( string $key)

Get a plain attribute (not a relationship).

Parameters

string $key

Return Value

mixed

at line line 2648
mixed getRelationValue( string $key)

Get a relationship.

Parameters

string $key

Return Value

mixed

at line line 2706
bool hasGetMutator( string $key)

Determine if a get mutator exists for an attribute.

Parameters

string $key

Return Value

bool

at line line 2744
bool hasCast( string $key, array|string|null $types = null)

Determine whether an attribute should be cast to a native type.

Parameters

string $key
array|string|null $types

Return Value

bool

at line line 2758
array getCasts()

Get the casts array.

Return Value

array

at line line 2852
$this setAttribute( string $key, mixed $value)

Set a given attribute on the model.

Parameters

string $key
mixed $value

Return Value

$this

at line line 2885
bool hasSetMutator( string $key)

Determine if a set mutator exists for an attribute.

Parameters

string $key

Return Value

bool

at line line 2895
array getDates()

Get the attributes that should be converted to dates.

Return Value

array

at line line 2908
string fromDateTime( DateTime|int $value)

Convert a DateTime to a storable string.

Parameters

DateTime|int $value

Return Value

string

at line line 2999
$this setDateFormat( string $format)

Set the date format used by the model.

Parameters

string $format

Return Value

$this

at line line 3024
mixed fromJson( string $value, bool $asObject = false)

Decode the given JSON back into an array or object.

Parameters

string $value
bool $asObject

Return Value

mixed

at line line 3035
Model replicate( array $except = null)

Clone the model into a new, non-existing instance.

Parameters

array $except

Return Value

Model

at line line 3057
array getAttributes()

Get all of the current attributes on the model.

Return Value

array

at line line 3069
$this setRawAttributes( array $attributes, bool $sync = false)

Set the array of model attributes. No checking is done.

Parameters

array $attributes
bool $sync

Return Value

$this

at line line 3087
mixed|array getOriginal( string|null $key = null, mixed $default = null)

Get the model's original attribute values.

Parameters

string|null $key
mixed $default

Return Value

mixed|array

at line line 3097
$this syncOriginal()

Sync the original attributes with the current.

Return Value

$this

at line line 3110
$this syncOriginalAttribute( string $attribute)

Sync a single original attribute with its current value.

Parameters

string $attribute

Return Value

$this

at line line 3123
bool isDirty( array|string|null $attributes = null)

Determine if the model or given attribute(s) have been modified.

Parameters

array|string|null $attributes

Return Value

bool

at line line 3149
array getDirty()

Get the attributes that have been changed since last sync.

Return Value

array

at line line 3185
array getRelations()

Get all the loaded relations for the instance.

Return Value

array

at line line 3196
mixed getRelation( string $relation)

Get a specified relationship.

Parameters

string $relation

Return Value

mixed

at line line 3207
bool relationLoaded( string $key)

Determine if the given relation is loaded.

Parameters

string $key

Return Value

bool

at line line 3219
$this setRelation( string $relation, mixed $value)

Set the specific relationship in the model.

Parameters

string $relation
mixed $value

Return Value

$this

at line line 3232
$this setRelations( array $relations)

Set the entire relations array on the model.

Parameters

array $relations

Return Value

$this

at line line 3244
Connection getConnection()

Get the database connection for the model.

Return Value

Connection

at line line 3254
string getConnectionName()

Get the current connection name for the model.

Return Value

string

at line line 3265
$this setConnection( string $name)

Set the connection associated with the model.

Parameters

string $name

Return Value

$this

at line line 3278
static Connection resolveConnection( string|null $connection = null)

Resolve a connection instance.

Parameters

string|null $connection

Return Value

Connection

at line line 3288
static ConnectionResolverInterface getConnectionResolver()

Get the connection resolver instance.

Return Value

ConnectionResolverInterface

at line line 3299
static void setConnectionResolver( ConnectionResolverInterface $resolver)

Set the connection resolver instance.

Parameters

ConnectionResolverInterface $resolver

Return Value

void

at line line 3309
static void unsetConnectionResolver()

Unset the connection resolver for models.

Return Value

void

at line line 3319
static Dispatcher getEventDispatcher()

Get the event dispatcher instance.

Return Value

Dispatcher

at line line 3330
static void setEventDispatcher( Dispatcher $dispatcher)

Set the event dispatcher instance.

Parameters

Dispatcher $dispatcher

Return Value

void

at line line 3340
static void unsetEventDispatcher()

Unset the event dispatcher for models.

Return Value

void

at line line 3350
array getMutatedAttributes()

Get the mutated attributes for a given instance.

Return Value

array

at line line 3367
static void cacheMutatedAttributes( string $class)

Extract and cache all the mutated attributes of a class.

Parameters

string $class

Return Value

void

at line line 3393
mixed __get( string $key)

Dynamically retrieve attributes on the model.

Parameters

string $key

Return Value

mixed

at line line 3405
void __set( string $key, mixed $value)

Dynamically set attributes on the model.

Parameters

string $key
mixed $value

Return Value

void

at line line 3416
bool offsetExists( mixed $offset)

Determine if the given attribute exists.

Parameters

mixed $offset

Return Value

bool

at line line 3427
mixed offsetGet( mixed $offset)

Get the value for a given offset.

Parameters

mixed $offset

Return Value

mixed

at line line 3439
void offsetSet( mixed $offset, mixed $value)

Set the value for a given offset.

Parameters

mixed $offset
mixed $value

Return Value

void

at line line 3450
void offsetUnset( mixed $offset)

Unset the value for a given offset.

Parameters

mixed $offset

Return Value

void

at line line 3461
bool __isset( string $key)

Determine if an attribute exists on the model.

Parameters

string $key

Return Value

bool

at line line 3473
void __unset( string $key)

Unset an attribute on the model.

Parameters

string $key

Return Value

void

at line line 3485
mixed __call( string $method, array $parameters)

Handle dynamic method calls into the model.

Parameters

string $method
array $parameters

Return Value

mixed

at line line 3503
static mixed __callStatic( string $method, array $parameters)

Handle dynamic static method calls into the method.

Parameters

string $method
array $parameters

Return Value

mixed

at line line 3515
string __toString()

Convert the model to its string representation.

Return Value

string

at line line 3525
void __wakeup()

When a model is being unserialized, check if it needs to be booted.

Return Value

void