PHP Class Illuminate\Database\Eloquent\Model

Inheritance: implements ArrayAcces\ArrayAccess, implements Illuminate\Contracts\Support\Arrayable, implements Illuminate\Contracts\Support\Jsonable, implements JsonSerializabl\JsonSerializable, implements Illuminate\Contracts\Queue\QueueableEntity, implements Illuminate\Contracts\Routing\UrlRoutable
Show file Open project: illuminate/database Class Usage Examples

Public Properties

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

Protected Properties

Property Type Description
$appends array The accessors to append to the model's array form.
$attributes array The model's attributes.
$booted array The array of booted models.
$casts array The attributes that should be cast to native types.
$connection string The connection name for the model.
$dateFormat string The storage format of the model's date columns.
$dates array The attributes that should be mutated to dates.
$dispatcher Illuminate\Contracts\Events\Dispatcher The event dispatcher instance.
$events array Allows for object-based events for native Eloquent events.
$fillable array The attributes that are mass assignable.
$globalScopes array The array of global scopes on the model.
$guarded array The attributes that aren't mass assignable.
$hidden array The attributes that should be hidden for arrays.
$keyType string The "type" of the auto-incrementing ID.
$mutatorCache array The cache of the mutated attributes for each class.
$observables array User exposed observable events.
$original array The model attribute's original state.
$perPage integer The number of models to return for pagination.
$primaryKey string The primary key for the model.
$relations array The loaded relationships for the model.
$resolver Illuminate\Database\ConnectionResolverInterface The connection resolver instance.
$table string The table associated with the model.
$touches array The relationships that should be touched on save.
$unguarded boolean Indicates if all mass assignment is enabled.
$visible array The attributes that should be visible in arrays.
$with array The relations to eager load on every query.

Public Methods

Method Description
__call ( string $method, array $parameters ) : mixed Handle dynamic method calls into the model.
__callStatic ( string $method, array $parameters ) : mixed Handle dynamic static method calls into the method.
__construct ( array $attributes = [] ) : void Create a new Eloquent model instance.
__get ( string $key ) : mixed Dynamically retrieve attributes on the model.
__isset ( string $key ) : boolean Determine if an attribute or relation exists on the model.
__set ( string $key, mixed $value ) : void Dynamically set attributes on the model.
__toString ( ) : string Convert the model to its string representation.
__unset ( string $key ) : void Unset an attribute on the model.
__wakeup ( ) : void When a model is being unserialized, check if it needs to be booted.
addGlobalScope ( Illuminate\Database\Eloquent\Scope | Closure | string $scope, Closur\Closure $implementation = null ) : mixed Register a new global scope on the model.
addHidden ( array | string | null $attributes = null ) : void Add hidden attributes for the model.
addObservableEvents ( array | mixed $observables ) : void Add an observable event name.
addVisible ( array | string | null $attributes = null ) : void Add visible attributes for the model.
all ( array | mixed $columns = ['*'] ) : Illuminate\Database\Eloquent\Collection | static[] Get all of the models from the database.
append ( array | string $attributes ) Append attributes to query when building a query.
attributesToArray ( ) : array Convert the model's attributes to an array.
belongsTo ( string $related, string $foreignKey = null, string $otherKey = null, string $relation = null ) : BelongsTo Define an inverse one-to-one or many relationship.
belongsToMany ( string $related, string $table = null, string $foreignKey = null, string $otherKey = null, string $relation = null ) : Illuminate\Database\Eloquent\Relations\BelongsToMany Define a many-to-many relationship.
cacheMutatedAttributes ( string $class ) : void Extract and cache all the mutated attributes of a class.
clearBootedModels ( ) : void Clear the list of booted models so they will be re-booted.
create ( array $attributes = [] ) : static Save a new model and return the instance.
created ( Closure | string $callback, integer $priority ) : void Register a created model event with the dispatcher.
creating ( Closure | string $callback, integer $priority ) : void Register a creating model event with the dispatcher.
delete ( ) : boolean | null Delete the model from the database.
deleted ( Closure | string $callback, integer $priority ) : void Register a deleted model event with the dispatcher.
deleting ( Closure | string $callback, integer $priority ) : void Register a deleting model event with the dispatcher.
destroy ( array | integer $ids ) : integer Destroy the models for the given IDs.
fill ( array $attributes ) Fill the model with an array of attributes.
fillJsonAttribute ( string $key, mixed $value ) Set a given JSON attribute on the model.
fillable ( array $fillable ) Set the fillable attributes for the model.
flushEventListeners ( ) : void Remove all of the event listeners for the model.
forceCreate ( array $attributes ) : static Save a new model and return the instance. Allow mass-assignment.
forceDelete ( ) : boolean | null Force a hard delete on a soft deleted model.
forceFill ( array $attributes ) Fill the model with an array of attributes. Force mass assignment.
fresh ( array | string $with = [] ) : static | null Reload a fresh model instance from the database.
freshTimestamp ( ) : Carbon\Carbon Get a fresh timestamp for the model.
freshTimestampString ( ) : string Get a fresh timestamp for the model.
fromDateTime ( DateTime | integer $value ) : string Convert a DateTime to a storable string.
fromJson ( string $value, boolean $asObject = false ) : mixed Decode the given JSON back into an array or object.
getActualClassNameForMorph ( string $class ) : string Retrieve the fully qualified class name from a slug.
getAttribute ( string $key ) : mixed Get an attribute from the model.
getAttributeValue ( string $key ) : mixed Get a plain attribute (not a relationship).
getAttributes ( ) : array Get all of the current attributes on the model.
getCasts ( ) : array Get the casts array.
getConnection ( ) : Connection Get the database connection for the model.
getConnectionName ( ) : string Get the current connection name for the model.
getConnectionResolver ( ) : Illuminate\Database\ConnectionResolverInterface Get the connection resolver instance.
getCreatedAtColumn ( ) : string Get the name of the "created at" column.
getDates ( ) : array Get the attributes that should be converted to dates.
getDirty ( ) : array Get the attributes that have been changed since last sync.
getEventDispatcher ( ) : Illuminate\Contracts\Events\Dispatcher Get the event dispatcher instance.
getFillable ( ) : array Get the fillable attributes for the model.
getForeignKey ( ) : string Get the default foreign key name for the model.
getGlobalScope ( Illuminate\Database\Eloquent\Scope | string $scope ) : Illuminate\Database\Eloquent\Scope | Closure | null Get a global scope registered with the model.
getGlobalScopes ( ) : array Get the global scopes for this class instance.
getGuarded ( ) : array Get the guarded attributes for the model.
getHidden ( ) : array Get the hidden attributes for the model.
getIncrementing ( ) : boolean Get the value indicating whether the IDs are incrementing.
getKey ( ) : mixed Get the value of the model's primary key.
getKeyName ( ) : string Get the primary key for the model.
getKeyType ( ) : string Get the auto incrementing key type.
getMorphClass ( ) : string Get the class name for polymorphic relations.
getMutatedAttributes ( ) : array Get the mutated attributes for a given instance.
getObservableEvents ( ) : array Get the observable event names.
getOriginal ( string | null $key = null, mixed $default = null ) : mixed | array Get the model's original attribute values.
getPerPage ( ) : integer Get the number of models to return per page.
getQualifiedKeyName ( ) : string Get the table qualified key name.
getQueueableId ( ) : mixed Get the queueable identity for the entity.
getRelation ( string $relation ) : mixed Get a specified relationship.
getRelationValue ( string $key ) : mixed Get a relationship.
getRelations ( ) : array Get all the loaded relations for the instance.
getRouteKey ( ) : mixed Get the value of the model's route key.
getRouteKeyName ( ) : string Get the route key for the model.
getTable ( ) : string Get the table associated with the model.
getTouchedRelations ( ) : array Get the relationships that are touched on save.
getUpdatedAtColumn ( ) : string Get the name of the "updated at" column.
getVisible ( ) : array Get the visible attributes for the model.
guard ( array $guarded ) Set the guarded attributes for the model.
hasCast ( string $key, array | string | null $types = null ) : boolean Determine whether an attribute should be cast to a native type.
hasGetMutator ( string $key ) : boolean Determine if a get mutator exists for an attribute.
hasGlobalScope ( Illuminate\Database\Eloquent\Scope | string $scope ) : boolean Determine if a model has a global scope.
hasMany ( string $related, string $foreignKey = null, string $localKey = null ) : Illuminate\Database\Eloquent\Relations\HasMany Define a one-to-many relationship.
hasManyThrough ( string $related, string $through, string | null $firstKey = null, string | null $secondKey = null, string | null $localKey = null ) : Illuminate\Database\Eloquent\Relations\HasManyThrough Define a has-many-through relationship.
hasOne ( string $related, string $foreignKey = null, string $localKey = null ) : Illuminate\Database\Eloquent\Relations\HasOne Define a one-to-one relationship.
hasSetMutator ( string $key ) : boolean Determine if a set mutator exists for an attribute.
hydrate ( array $items, string | null $connection = null ) : Illuminate\Database\Eloquent\Collection Create a collection of models from plain arrays.
hydrateRaw ( string $query, array $bindings = [], string | null $connection = null ) : Illuminate\Database\Eloquent\Collection Create a collection of models from a raw query.
is ( Model $model ) : boolean Determine if two models have the same ID and belong to the same table.
isClean ( array | string | null $attributes = null ) : boolean Determine if the model or given attribute(s) have remained the same.
isDirty ( array | string | null $attributes = null ) : boolean Determine if the model or given attribute(s) have been modified.
isFillable ( string $key ) : boolean Determine if the given attribute may be mass assigned.
isGuarded ( string $key ) : boolean Determine if the given key is guarded.
isUnguarded ( ) : boolean Determine if current state is "unguarded".
joiningTable ( string $related ) : string Get the joining table name for a many-to-many relation.
jsonSerialize ( ) : array Convert the object into something JSON serializable.
load ( array | string $relations ) Eager load relations on the model.
makeHidden ( array | string $attributes ) Make the given, typically visible, attributes hidden.
makeVisible ( array | string $attributes ) Make the given, typically hidden, attributes visible.
morphMany ( string $related, string $name, string $type = null, string $id = null, string $localKey = null ) : Illuminate\Database\Eloquent\Relations\MorphMany Define a polymorphic one-to-many relationship.
morphOne ( string $related, string $name, string $type = null, string $id = null, string $localKey = null ) : Illuminate\Database\Eloquent\Relations\MorphOne Define a polymorphic one-to-one relationship.
morphTo ( string $name = null, string $type = null, string $id = null ) : Illuminate\Database\Eloquent\Relations\MorphTo Define a polymorphic, inverse one-to-one or many relationship.
morphToMany ( string $related, string $name, string $table = null, string $foreignKey = null, string $otherKey = null, boolean $inverse = false ) : Illuminate\Database\Eloquent\Relations\MorphToMany Define a polymorphic many-to-many relationship.
morphedByMany ( string $related, string $name, string $table = null, string $foreignKey = null, string $otherKey = null ) : Illuminate\Database\Eloquent\Relations\MorphToMany Define a polymorphic, inverse many-to-many relationship.
newCollection ( array $models = [] ) : Illuminate\Database\Eloquent\Collection Create a new Eloquent Collection instance.
newEloquentBuilder ( Builder $query ) : Builder | static Create a new Eloquent query builder for the model.
newFromBuilder ( array $attributes = [], string | null $connection = null ) : static Create a new model instance that is existing.
newInstance ( array $attributes = [], boolean $exists = false ) : static Create a new instance of the given model.
newPivot ( Model $parent, array $attributes, string $table, boolean $exists, string | null $using = null ) : Illuminate\Database\Eloquent\Relations\Pivot Create a new pivot model instance.
newQuery ( ) : Builder Get a new query builder for the model's table.
newQueryWithoutScope ( Illuminate\Database\Eloquent\Scope | string $scope ) : Builder Get a new query instance without a given scope.
newQueryWithoutScopes ( ) : Builder | static Get a new query builder that doesn't have any global scopes.
observe ( object | string $class, integer $priority ) : void Register an observer with the Model.
offsetExists ( mixed $offset ) : boolean Determine if the given attribute exists.
offsetGet ( mixed $offset ) : mixed Get the value for a given offset.
offsetSet ( mixed $offset, mixed $value ) : void Set the value for a given offset.
offsetUnset ( mixed $offset ) : void Unset the value for a given offset.
on ( string | null $connection = null ) : Builder Begin querying the model on a given connection.
onWriteConnection ( ) : Builder Begin querying the model on the write connection.
push ( ) : boolean Save the model and all of its relationships.
query ( ) : Builder Begin querying the model.
reguard ( ) : void Enable the mass assignment restrictions.
relationLoaded ( string $key ) : boolean Determine if the given relation is loaded.
relationsToArray ( ) : array Get the model's relationships in array form.
removeObservableEvents ( array | mixed $observables ) : void Remove an observable event name.
replicate ( array $except = null ) : Model Clone the model into a new, non-existing instance.
resolveConnection ( string | null $connection = null ) : Connection Resolve a connection instance.
save ( array $options = [] ) : boolean Save the model to the database.
saveOrFail ( array $options = [] ) : boolean Save the model to the database using transaction.
saved ( Closure | string $callback, integer $priority ) : void Register a saved model event with the dispatcher.
saving ( Closure | string $callback, integer $priority ) : void Register a saving model event with the dispatcher.
setAppends ( array $appends ) Set the accessors to append to model arrays.
setAttribute ( string $key, mixed $value ) Set a given attribute on the model.
setConnection ( string $name ) Set the connection associated with the model.
setConnectionResolver ( Illuminate\Database\ConnectionResolverInterface $resolver ) : void Set the connection resolver instance.
setCreatedAt ( mixed $value ) Set the value of the "created at" attribute.
setDateFormat ( string $format ) Set the date format used by the model.
setEventDispatcher ( Illuminate\Contracts\Events\Dispatcher $dispatcher ) : void Set the event dispatcher instance.
setHidden ( array $hidden ) Set the hidden attributes for the model.
setIncrementing ( boolean $value ) Set whether IDs are incrementing.
setKeyName ( string $key ) Set the primary key for the model.
setObservableEvents ( array $observables ) Set the observable event names.
setPerPage ( integer $perPage ) Set the number of models to return per page.
setRawAttributes ( array $attributes, boolean $sync = false ) Set the array of model attributes. No checking is done.
setRelation ( string $relation, mixed $value ) Set the specific relationship in the model.
setRelations ( array $relations ) Set the entire relations array on the model.
setTable ( string $table ) Set the table associated with the model.
setTouchedRelations ( array $touches ) Set the relationships that are touched on save.
setUpdatedAt ( mixed $value ) Set the value of the "updated at" attribute.
setVisible ( array $visible ) Set the visible attributes for the model.
syncOriginal ( ) Sync the original attributes with the current.
syncOriginalAttribute ( string $attribute ) Sync a single original attribute with its current value.
toArray ( ) : array Convert the model instance to an array.
toJson ( integer $options ) : string Convert the model instance to JSON.
totallyGuarded ( ) : boolean Determine if the model is totally guarded.
touch ( ) : boolean Update the model's update timestamp.
touchOwners ( ) : void Touch the owning relations of the model.
touches ( string $relation ) : boolean Determine if the model touches a given relation.
unguard ( boolean $state = true ) : void Disable all mass assignable restrictions.
unguarded ( callable $callback ) : mixed Run the given callable while being unguarded.
unsetConnectionResolver ( ) : void Unset the connection resolver for models.
unsetEventDispatcher ( ) : void Unset the event dispatcher for models.
update ( array $attributes = [], array $options = [] ) : boolean Update the model in the database.
updated ( Closure | string $callback, integer $priority ) : void Register an updated model event with the dispatcher.
updating ( Closure | string $callback, integer $priority ) : void Register an updating model event with the dispatcher.
usesTimestamps ( ) : boolean Determine if the model uses timestamps.
with ( array | string $relations ) : Builder | static Begin querying a model with eager loading.

Protected Methods

Method Description
asDateTime ( mixed $value ) : Carbon\Carbon Return a timestamp as DateTime object.
asJson ( mixed $value ) : string Encode the given value as JSON.
asTimeStamp ( mixed $value ) : integer Return a timestamp as unix timestamp.
boot ( ) : void The "booting" method of the model.
bootIfNotBooted ( ) : void Check if the model needs to be booted and if so, do it.
bootTraits ( ) : void Boot all of the bootable traits on the model.
castAttribute ( string $key, mixed $value ) : mixed Cast an attribute to a native PHP type.
decrement ( string $column, integer $amount = 1, array $extra = [] ) : integer Decrement a column's value by a given amount.
fillableFromArray ( array $attributes ) : array Get the fillable attributes of a given array.
finishSave ( array $options ) : void Finish processing on a successful save operation.
fireModelEvent ( string $event, boolean $halt = true ) : mixed Fire the given event for the model.
getArrayableAppends ( ) : array Get all of the appendable values that are arrayable.
getArrayableAttributes ( ) : array Get an attribute array of all arrayable attributes.
getArrayableItems ( array $values ) : array Get an attribute array of all arrayable values.
getArrayableRelations ( ) : array Get an attribute array of all arrayable relations.
getAttributeFromArray ( string $key ) : mixed Get an attribute from the $attributes array.
getBelongsToManyCaller ( ) : string Get the relationship name of the belongs to many.
getCastType ( string $key ) : string Get the type of cast for a model attribute.
getDateFormat ( ) : string Get the format for database stored dates.
getKeyForSaveQuery ( ) : mixed Get the primary key value for a save query.
getMorphs ( string $name, string $type, string $id ) : array Get the polymorphic relationship columns.
getRelationshipFromMethod ( string $method ) : mixed Get a relationship value from a method.
increment ( string $column, integer $amount = 1, array $extra = [] ) : integer Increment a column's value by a given amount.
incrementOrDecrement ( string $column, integer $amount, array $extra, string $method ) : integer Run the increment or decrement method on the model.
incrementOrDecrementAttributeValue ( string $column, integer $amount, string $method ) : void Increment the underlying attribute value and sync with original.
insertAndSetId ( Builder $query, array $attributes ) : void Insert the given attributes and set the ID on the model.
isDateCastable ( string $key ) : boolean Determine whether a value is Date / DateTime castable for inbound manipulation.
isJsonCastable ( string $key ) : boolean Determine whether a value is JSON castable for inbound manipulation.
mutateAttribute ( string $key, mixed $value ) : mixed Get the value of an attribute using its mutator.
mutateAttributeForArray ( string $key, mixed $value ) : mixed Get the value of an attribute using its mutator for array conversion.
newBaseQueryBuilder ( ) : Builder Get a new query builder instance for the connection.
originalIsNumericallyEquivalent ( string $key ) : boolean Determine if the new and old values for a given key are numerically equivalent.
performDeleteOnModel ( ) : void Perform the actual delete query on this model instance.
performInsert ( Builder $query ) : boolean Perform a model insert operation.
performUpdate ( Builder $query, array $options = [] ) : boolean Perform a model update operation.
registerModelEvent ( string $event, Closure | string $callback, integer $priority ) : void Register a model event with the dispatcher.
removeTableFromKey ( string $key ) : string Remove the table name from a given key.
serializeDate ( DateTimeInterfac\DateTimeInterface $date ) : string Prepare a date for array / JSON serialization.
setKeysForSaveQuery ( Builder $query ) : Builder Set the keys for a save update query.
updateTimestamps ( ) : void Update the creation and update timestamps.

Method Details

__call() public method

Handle dynamic method calls into the model.
public __call ( string $method, array $parameters ) : mixed
$method string
$parameters array
return mixed

__callStatic() public static method

Handle dynamic static method calls into the method.
public static __callStatic ( string $method, array $parameters ) : mixed
$method string
$parameters array
return mixed

__construct() public method

Create a new Eloquent model instance.
public __construct ( array $attributes = [] ) : void
$attributes array
return void

__get() public method

Dynamically retrieve attributes on the model.
public __get ( string $key ) : mixed
$key string
return mixed

__isset() public method

Determine if an attribute or relation exists on the model.
public __isset ( string $key ) : boolean
$key string
return boolean

__set() public method

Dynamically set attributes on the model.
public __set ( string $key, mixed $value ) : void
$key string
$value mixed
return void

__toString() public method

Convert the model to its string representation.
public __toString ( ) : string
return string

__unset() public method

Unset an attribute on the model.
public __unset ( string $key ) : void
$key string
return void

__wakeup() public method

When a model is being unserialized, check if it needs to be booted.
public __wakeup ( ) : void
return void

addGlobalScope() public static method

Register a new global scope on the model.
public static addGlobalScope ( Illuminate\Database\Eloquent\Scope | Closure | string $scope, Closur\Closure $implementation = null ) : mixed
$scope Illuminate\Database\Eloquent\Scope | Closure | string
$implementation Closur\Closure
return mixed

addHidden() public method

Add hidden attributes for the model.
public addHidden ( array | string | null $attributes = null ) : void
$attributes array | string | null
return void

addObservableEvents() public method

Add an observable event name.
public addObservableEvents ( array | mixed $observables ) : void
$observables array | mixed
return void

addVisible() public method

Add visible attributes for the model.
public addVisible ( array | string | null $attributes = null ) : void
$attributes array | string | null
return void

all() public static method

Get all of the models from the database.
public static all ( array | mixed $columns = ['*'] ) : Illuminate\Database\Eloquent\Collection | static[]
$columns array | mixed
return Illuminate\Database\Eloquent\Collection | static[]

append() public method

Append attributes to query when building a query.
public append ( array | string $attributes )
$attributes array | string

asDateTime() protected method

Return a timestamp as DateTime object.
protected asDateTime ( mixed $value ) : Carbon\Carbon
$value mixed
return Carbon\Carbon

asJson() protected method

Encode the given value as JSON.
protected asJson ( mixed $value ) : string
$value mixed
return string

asTimeStamp() protected method

Return a timestamp as unix timestamp.
protected asTimeStamp ( mixed $value ) : integer
$value mixed
return integer

attributesToArray() public method

Convert the model's attributes to an array.
public attributesToArray ( ) : array
return array

belongsTo() public method

Define an inverse one-to-one or many relationship.
public belongsTo ( string $related, string $foreignKey = null, string $otherKey = null, string $relation = null ) : BelongsTo
$related string
$foreignKey string
$otherKey string
$relation string
return Illuminate\Database\Eloquent\Relations\BelongsTo

belongsToMany() public method

Define a many-to-many relationship.
public belongsToMany ( string $related, string $table = null, string $foreignKey = null, string $otherKey = null, string $relation = null ) : Illuminate\Database\Eloquent\Relations\BelongsToMany
$related string
$table string
$foreignKey string
$otherKey string
$relation string
return Illuminate\Database\Eloquent\Relations\BelongsToMany

boot() protected static method

The "booting" method of the model.
protected static boot ( ) : void
return void

bootIfNotBooted() protected method

Check if the model needs to be booted and if so, do it.
protected bootIfNotBooted ( ) : void
return void

bootTraits() protected static method

Boot all of the bootable traits on the model.
protected static bootTraits ( ) : void
return void

cacheMutatedAttributes() public static method

Extract and cache all the mutated attributes of a class.
public static cacheMutatedAttributes ( string $class ) : void
$class string
return void

castAttribute() protected method

Cast an attribute to a native PHP type.
protected castAttribute ( string $key, mixed $value ) : mixed
$key string
$value mixed
return mixed

clearBootedModels() public static method

Clear the list of booted models so they will be re-booted.
public static clearBootedModels ( ) : void
return void

create() public static method

Save a new model and return the instance.
public static create ( array $attributes = [] ) : static
$attributes array
return static

created() public static method

Register a created model event with the dispatcher.
public static created ( Closure | string $callback, integer $priority ) : void
$callback Closure | string
$priority integer
return void

creating() public static method

Register a creating model event with the dispatcher.
public static creating ( Closure | string $callback, integer $priority ) : void
$callback Closure | string
$priority integer
return void

decrement() protected method

Decrement a column's value by a given amount.
protected decrement ( string $column, integer $amount = 1, array $extra = [] ) : integer
$column string
$amount integer
$extra array
return integer

delete() public method

Delete the model from the database.
public delete ( ) : boolean | null
return boolean | null

deleted() public static method

Register a deleted model event with the dispatcher.
public static deleted ( Closure | string $callback, integer $priority ) : void
$callback Closure | string
$priority integer
return void

deleting() public static method

Register a deleting model event with the dispatcher.
public static deleting ( Closure | string $callback, integer $priority ) : void
$callback Closure | string
$priority integer
return void

destroy() public static method

Destroy the models for the given IDs.
public static destroy ( array | integer $ids ) : integer
$ids array | integer
return integer

fill() public method

Fill the model with an array of attributes.
public fill ( array $attributes )
$attributes array

fillJsonAttribute() public method

Set a given JSON attribute on the model.
public fillJsonAttribute ( string $key, mixed $value )
$key string
$value mixed

fillable() public method

Set the fillable attributes for the model.
public fillable ( array $fillable )
$fillable array

fillableFromArray() protected method

Get the fillable attributes of a given array.
protected fillableFromArray ( array $attributes ) : array
$attributes array
return array

finishSave() protected method

Finish processing on a successful save operation.
protected finishSave ( array $options ) : void
$options array
return void

fireModelEvent() protected method

Fire the given event for the model.
protected fireModelEvent ( string $event, boolean $halt = true ) : mixed
$event string
$halt boolean
return mixed

flushEventListeners() public static method

Remove all of the event listeners for the model.
public static flushEventListeners ( ) : void
return void

forceCreate() public static method

Save a new model and return the instance. Allow mass-assignment.
public static forceCreate ( array $attributes ) : static
$attributes array
return static

forceDelete() public method

This method protects developers from running forceDelete when trait is missing.
public forceDelete ( ) : boolean | null
return boolean | null

forceFill() public method

Fill the model with an array of attributes. Force mass assignment.
public forceFill ( array $attributes )
$attributes array

fresh() public method

Reload a fresh model instance from the database.
public fresh ( array | string $with = [] ) : static | null
$with array | string
return static | null

freshTimestamp() public method

Get a fresh timestamp for the model.
public freshTimestamp ( ) : Carbon\Carbon
return Carbon\Carbon

freshTimestampString() public method

Get a fresh timestamp for the model.
public freshTimestampString ( ) : string
return string

fromDateTime() public method

Convert a DateTime to a storable string.
public fromDateTime ( DateTime | integer $value ) : string
$value DateTime | integer
return string

fromJson() public method

Decode the given JSON back into an array or object.
public fromJson ( string $value, boolean $asObject = false ) : mixed
$value string
$asObject boolean
return mixed

getActualClassNameForMorph() public method

Retrieve the fully qualified class name from a slug.
public getActualClassNameForMorph ( string $class ) : string
$class string
return string

getArrayableAppends() protected method

Get all of the appendable values that are arrayable.
protected getArrayableAppends ( ) : array
return array

getArrayableAttributes() protected method

Get an attribute array of all arrayable attributes.
protected getArrayableAttributes ( ) : array
return array

getArrayableItems() protected method

Get an attribute array of all arrayable values.
protected getArrayableItems ( array $values ) : array
$values array
return array

getArrayableRelations() protected method

Get an attribute array of all arrayable relations.
protected getArrayableRelations ( ) : array
return array

getAttribute() public method

Get an attribute from the model.
public getAttribute ( string $key ) : mixed
$key string
return mixed

getAttributeFromArray() protected method

Get an attribute from the $attributes array.
protected getAttributeFromArray ( string $key ) : mixed
$key string
return mixed

getAttributeValue() public method

Get a plain attribute (not a relationship).
public getAttributeValue ( string $key ) : mixed
$key string
return mixed

getAttributes() public method

Get all of the current attributes on the model.
public getAttributes ( ) : array
return array

getBelongsToManyCaller() protected method

Get the relationship name of the belongs to many.
protected getBelongsToManyCaller ( ) : string
return string

getCastType() protected method

Get the type of cast for a model attribute.
protected getCastType ( string $key ) : string
$key string
return string

getCasts() public method

Get the casts array.
public getCasts ( ) : array
return array

getConnection() public method

Get the database connection for the model.
public getConnection ( ) : Connection
return Illuminate\Database\Connection

getConnectionName() public method

Get the current connection name for the model.
public getConnectionName ( ) : string
return string

getConnectionResolver() public static method

Get the connection resolver instance.
public static getConnectionResolver ( ) : Illuminate\Database\ConnectionResolverInterface
return Illuminate\Database\ConnectionResolverInterface

getCreatedAtColumn() public method

Get the name of the "created at" column.
public getCreatedAtColumn ( ) : string
return string

getDateFormat() protected method

Get the format for database stored dates.
protected getDateFormat ( ) : string
return string

getDates() public method

Get the attributes that should be converted to dates.
public getDates ( ) : array
return array

getDirty() public method

Get the attributes that have been changed since last sync.
public getDirty ( ) : array
return array

getEventDispatcher() public static method

Get the event dispatcher instance.
public static getEventDispatcher ( ) : Illuminate\Contracts\Events\Dispatcher
return Illuminate\Contracts\Events\Dispatcher

getFillable() public method

Get the fillable attributes for the model.
public getFillable ( ) : array
return array

getForeignKey() public method

Get the default foreign key name for the model.
public getForeignKey ( ) : string
return string

getGlobalScope() public static method

Get a global scope registered with the model.
public static getGlobalScope ( Illuminate\Database\Eloquent\Scope | string $scope ) : Illuminate\Database\Eloquent\Scope | Closure | null
$scope Illuminate\Database\Eloquent\Scope | string
return Illuminate\Database\Eloquent\Scope | Closure | null

getGlobalScopes() public method

Get the global scopes for this class instance.
public getGlobalScopes ( ) : array
return array

getGuarded() public method

Get the guarded attributes for the model.
public getGuarded ( ) : array
return array

getHidden() public method

Get the hidden attributes for the model.
public getHidden ( ) : array
return array

getIncrementing() public method

Get the value indicating whether the IDs are incrementing.
public getIncrementing ( ) : boolean
return boolean

getKey() public method

Get the value of the model's primary key.
public getKey ( ) : mixed
return mixed

getKeyForSaveQuery() protected method

Get the primary key value for a save query.
protected getKeyForSaveQuery ( ) : mixed
return mixed

getKeyName() public method

Get the primary key for the model.
public getKeyName ( ) : string
return string

getKeyType() public method

Get the auto incrementing key type.
public getKeyType ( ) : string
return string

getMorphClass() public method

Get the class name for polymorphic relations.
public getMorphClass ( ) : string
return string

getMorphs() protected method

Get the polymorphic relationship columns.
protected getMorphs ( string $name, string $type, string $id ) : array
$name string
$type string
$id string
return array

getMutatedAttributes() public method

Get the mutated attributes for a given instance.
public getMutatedAttributes ( ) : array
return array

getObservableEvents() public method

Get the observable event names.
public getObservableEvents ( ) : array
return array

getOriginal() public method

Get the model's original attribute values.
public getOriginal ( string | null $key = null, mixed $default = null ) : mixed | array
$key string | null
$default mixed
return mixed | array

getPerPage() public method

Get the number of models to return per page.
public getPerPage ( ) : integer
return integer

getQualifiedKeyName() public method

Get the table qualified key name.
public getQualifiedKeyName ( ) : string
return string

getQueueableId() public method

Get the queueable identity for the entity.
public getQueueableId ( ) : mixed
return mixed

getRelation() public method

Get a specified relationship.
public getRelation ( string $relation ) : mixed
$relation string
return mixed

getRelationValue() public method

Get a relationship.
public getRelationValue ( string $key ) : mixed
$key string
return mixed

getRelations() public method

Get all the loaded relations for the instance.
public getRelations ( ) : array
return array

getRelationshipFromMethod() protected method

Get a relationship value from a method.
protected getRelationshipFromMethod ( string $method ) : mixed
$method string
return mixed

getRouteKey() public method

Get the value of the model's route key.
public getRouteKey ( ) : mixed
return mixed

getRouteKeyName() public method

Get the route key for the model.
public getRouteKeyName ( ) : string
return string

getTable() public method

Get the table associated with the model.
public getTable ( ) : string
return string

getTouchedRelations() public method

Get the relationships that are touched on save.
public getTouchedRelations ( ) : array
return array

getUpdatedAtColumn() public method

Get the name of the "updated at" column.
public getUpdatedAtColumn ( ) : string
return string

getVisible() public method

Get the visible attributes for the model.
public getVisible ( ) : array
return array

guard() public method

Set the guarded attributes for the model.
public guard ( array $guarded )
$guarded array

hasCast() public method

Determine whether an attribute should be cast to a native type.
public hasCast ( string $key, array | string | null $types = null ) : boolean
$key string
$types array | string | null
return boolean

hasGetMutator() public method

Determine if a get mutator exists for an attribute.
public hasGetMutator ( string $key ) : boolean
$key string
return boolean

hasGlobalScope() public static method

Determine if a model has a global scope.
public static hasGlobalScope ( Illuminate\Database\Eloquent\Scope | string $scope ) : boolean
$scope Illuminate\Database\Eloquent\Scope | string
return boolean

hasMany() public method

Define a one-to-many relationship.
public hasMany ( string $related, string $foreignKey = null, string $localKey = null ) : Illuminate\Database\Eloquent\Relations\HasMany
$related string
$foreignKey string
$localKey string
return Illuminate\Database\Eloquent\Relations\HasMany

hasManyThrough() public method

Define a has-many-through relationship.
public hasManyThrough ( string $related, string $through, string | null $firstKey = null, string | null $secondKey = null, string | null $localKey = null ) : Illuminate\Database\Eloquent\Relations\HasManyThrough
$related string
$through string
$firstKey string | null
$secondKey string | null
$localKey string | null
return Illuminate\Database\Eloquent\Relations\HasManyThrough

hasOne() public method

Define a one-to-one relationship.
public hasOne ( string $related, string $foreignKey = null, string $localKey = null ) : Illuminate\Database\Eloquent\Relations\HasOne
$related string
$foreignKey string
$localKey string
return Illuminate\Database\Eloquent\Relations\HasOne

hasSetMutator() public method

Determine if a set mutator exists for an attribute.
public hasSetMutator ( string $key ) : boolean
$key string
return boolean

hydrate() public static method

Create a collection of models from plain arrays.
public static hydrate ( array $items, string | null $connection = null ) : Illuminate\Database\Eloquent\Collection
$items array
$connection string | null
return Illuminate\Database\Eloquent\Collection

hydrateRaw() public static method

Create a collection of models from a raw query.
public static hydrateRaw ( string $query, array $bindings = [], string | null $connection = null ) : Illuminate\Database\Eloquent\Collection
$query string
$bindings array
$connection string | null
return Illuminate\Database\Eloquent\Collection

increment() protected method

Increment a column's value by a given amount.
protected increment ( string $column, integer $amount = 1, array $extra = [] ) : integer
$column string
$amount integer
$extra array
return integer

incrementOrDecrement() protected method

Run the increment or decrement method on the model.
protected incrementOrDecrement ( string $column, integer $amount, array $extra, string $method ) : integer
$column string
$amount integer
$extra array
$method string
return integer

incrementOrDecrementAttributeValue() protected method

Increment the underlying attribute value and sync with original.
protected incrementOrDecrementAttributeValue ( string $column, integer $amount, string $method ) : void
$column string
$amount integer
$method string
return void

insertAndSetId() protected method

Insert the given attributes and set the ID on the model.
protected insertAndSetId ( Builder $query, array $attributes ) : void
$query Builder
$attributes array
return void

is() public method

Determine if two models have the same ID and belong to the same table.
public is ( Model $model ) : boolean
$model Model
return boolean

isClean() public method

Determine if the model or given attribute(s) have remained the same.
public isClean ( array | string | null $attributes = null ) : boolean
$attributes array | string | null
return boolean

isDateCastable() protected method

Determine whether a value is Date / DateTime castable for inbound manipulation.
protected isDateCastable ( string $key ) : boolean
$key string
return boolean

isDirty() public method

Determine if the model or given attribute(s) have been modified.
public isDirty ( array | string | null $attributes = null ) : boolean
$attributes array | string | null
return boolean

isFillable() public method

Determine if the given attribute may be mass assigned.
public isFillable ( string $key ) : boolean
$key string
return boolean

isGuarded() public method

Determine if the given key is guarded.
public isGuarded ( string $key ) : boolean
$key string
return boolean

isJsonCastable() protected method

Determine whether a value is JSON castable for inbound manipulation.
protected isJsonCastable ( string $key ) : boolean
$key string
return boolean

isUnguarded() public static method

Determine if current state is "unguarded".
public static isUnguarded ( ) : boolean
return boolean

joiningTable() public method

Get the joining table name for a many-to-many relation.
public joiningTable ( string $related ) : string
$related string
return string

jsonSerialize() public method

Convert the object into something JSON serializable.
public jsonSerialize ( ) : array
return array

load() public method

Eager load relations on the model.
public load ( array | string $relations )
$relations array | string

makeHidden() public method

Make the given, typically visible, attributes hidden.
public makeHidden ( array | string $attributes )
$attributes array | string

makeVisible() public method

Make the given, typically hidden, attributes visible.
public makeVisible ( array | string $attributes )
$attributes array | string

morphMany() public method

Define a polymorphic one-to-many relationship.
public morphMany ( string $related, string $name, string $type = null, string $id = null, string $localKey = null ) : Illuminate\Database\Eloquent\Relations\MorphMany
$related string
$name string
$type string
$id string
$localKey string
return Illuminate\Database\Eloquent\Relations\MorphMany

morphOne() public method

Define a polymorphic one-to-one relationship.
public morphOne ( string $related, string $name, string $type = null, string $id = null, string $localKey = null ) : Illuminate\Database\Eloquent\Relations\MorphOne
$related string
$name string
$type string
$id string
$localKey string
return Illuminate\Database\Eloquent\Relations\MorphOne

morphTo() public method

Define a polymorphic, inverse one-to-one or many relationship.
public morphTo ( string $name = null, string $type = null, string $id = null ) : Illuminate\Database\Eloquent\Relations\MorphTo
$name string
$type string
$id string
return Illuminate\Database\Eloquent\Relations\MorphTo

morphToMany() public method

Define a polymorphic many-to-many relationship.
public morphToMany ( string $related, string $name, string $table = null, string $foreignKey = null, string $otherKey = null, boolean $inverse = false ) : Illuminate\Database\Eloquent\Relations\MorphToMany
$related string
$name string
$table string
$foreignKey string
$otherKey string
$inverse boolean
return Illuminate\Database\Eloquent\Relations\MorphToMany

morphedByMany() public method

Define a polymorphic, inverse many-to-many relationship.
public morphedByMany ( string $related, string $name, string $table = null, string $foreignKey = null, string $otherKey = null ) : Illuminate\Database\Eloquent\Relations\MorphToMany
$related string
$name string
$table string
$foreignKey string
$otherKey string
return Illuminate\Database\Eloquent\Relations\MorphToMany

mutateAttribute() protected method

Get the value of an attribute using its mutator.
protected mutateAttribute ( string $key, mixed $value ) : mixed
$key string
$value mixed
return mixed

mutateAttributeForArray() protected method

Get the value of an attribute using its mutator for array conversion.
protected mutateAttributeForArray ( string $key, mixed $value ) : mixed
$key string
$value mixed
return mixed

newBaseQueryBuilder() protected method

Get a new query builder instance for the connection.
protected newBaseQueryBuilder ( ) : Builder
return Illuminate\Database\Query\Builder

newCollection() public method

Create a new Eloquent Collection instance.
public newCollection ( array $models = [] ) : Illuminate\Database\Eloquent\Collection
$models array
return Illuminate\Database\Eloquent\Collection

newEloquentBuilder() public method

Create a new Eloquent query builder for the model.
public newEloquentBuilder ( Builder $query ) : Builder | static
$query Illuminate\Database\Query\Builder
return Builder | static

newFromBuilder() public method

Create a new model instance that is existing.
public newFromBuilder ( array $attributes = [], string | null $connection = null ) : static
$attributes array
$connection string | null
return static

newInstance() public method

Create a new instance of the given model.
public newInstance ( array $attributes = [], boolean $exists = false ) : static
$attributes array
$exists boolean
return static

newPivot() public method

Create a new pivot model instance.
public newPivot ( Model $parent, array $attributes, string $table, boolean $exists, string | null $using = null ) : Illuminate\Database\Eloquent\Relations\Pivot
$parent Model
$attributes array
$table string
$exists boolean
$using string | null
return Illuminate\Database\Eloquent\Relations\Pivot

newQuery() public method

Get a new query builder for the model's table.
public newQuery ( ) : Builder
return Builder

newQueryWithoutScope() public method

Get a new query instance without a given scope.
public newQueryWithoutScope ( Illuminate\Database\Eloquent\Scope | string $scope ) : Builder
$scope Illuminate\Database\Eloquent\Scope | string
return Builder

newQueryWithoutScopes() public method

Get a new query builder that doesn't have any global scopes.
public newQueryWithoutScopes ( ) : Builder | static
return Builder | static

observe() public static method

Register an observer with the Model.
public static observe ( object | string $class, integer $priority ) : void
$class object | string
$priority integer
return void

offsetExists() public method

Determine if the given attribute exists.
public offsetExists ( mixed $offset ) : boolean
$offset mixed
return boolean

offsetGet() public method

Get the value for a given offset.
public offsetGet ( mixed $offset ) : mixed
$offset mixed
return mixed

offsetSet() public method

Set the value for a given offset.
public offsetSet ( mixed $offset, mixed $value ) : void
$offset mixed
$value mixed
return void

offsetUnset() public method

Unset the value for a given offset.
public offsetUnset ( mixed $offset ) : void
$offset mixed
return void

on() public static method

Begin querying the model on a given connection.
public static on ( string | null $connection = null ) : Builder
$connection string | null
return Builder

onWriteConnection() public static method

Begin querying the model on the write connection.
public static onWriteConnection ( ) : Builder
return Illuminate\Database\Query\Builder

originalIsNumericallyEquivalent() protected method

Determine if the new and old values for a given key are numerically equivalent.
protected originalIsNumericallyEquivalent ( string $key ) : boolean
$key string
return boolean

performDeleteOnModel() protected method

Perform the actual delete query on this model instance.
protected performDeleteOnModel ( ) : void
return void

performInsert() protected method

Perform a model insert operation.
protected performInsert ( Builder $query ) : boolean
$query Builder
return boolean

performUpdate() protected method

Perform a model update operation.
protected performUpdate ( Builder $query, array $options = [] ) : boolean
$query Builder
$options array
return boolean

push() public method

Save the model and all of its relationships.
public push ( ) : boolean
return boolean

query() public static method

Begin querying the model.
public static query ( ) : Builder
return Builder

registerModelEvent() protected static method

Register a model event with the dispatcher.
protected static registerModelEvent ( string $event, Closure | string $callback, integer $priority ) : void
$event string
$callback Closure | string
$priority integer
return void

reguard() public static method

Enable the mass assignment restrictions.
public static reguard ( ) : void
return void

relationLoaded() public method

Determine if the given relation is loaded.
public relationLoaded ( string $key ) : boolean
$key string
return boolean

relationsToArray() public method

Get the model's relationships in array form.
public relationsToArray ( ) : array
return array

removeObservableEvents() public method

Remove an observable event name.
public removeObservableEvents ( array | mixed $observables ) : void
$observables array | mixed
return void

removeTableFromKey() protected method

Remove the table name from a given key.
protected removeTableFromKey ( string $key ) : string
$key string
return string

replicate() public method

Clone the model into a new, non-existing instance.
public replicate ( array $except = null ) : Model
$except array
return Model

resolveConnection() public static method

Resolve a connection instance.
public static resolveConnection ( string | null $connection = null ) : Connection
$connection string | null
return Illuminate\Database\Connection

save() public method

Save the model to the database.
public save ( array $options = [] ) : boolean
$options array
return boolean

saveOrFail() public method

Save the model to the database using transaction.
public saveOrFail ( array $options = [] ) : boolean
$options array
return boolean

saved() public static method

Register a saved model event with the dispatcher.
public static saved ( Closure | string $callback, integer $priority ) : void
$callback Closure | string
$priority integer
return void

saving() public static method

Register a saving model event with the dispatcher.
public static saving ( Closure | string $callback, integer $priority ) : void
$callback Closure | string
$priority integer
return void

serializeDate() protected method

Prepare a date for array / JSON serialization.
protected serializeDate ( DateTimeInterfac\DateTimeInterface $date ) : string
$date DateTimeInterfac\DateTimeInterface
return string

setAppends() public method

Set the accessors to append to model arrays.
public setAppends ( array $appends )
$appends array

setAttribute() public method

Set a given attribute on the model.
public setAttribute ( string $key, mixed $value )
$key string
$value mixed

setConnection() public method

Set the connection associated with the model.
public setConnection ( string $name )
$name string

setConnectionResolver() public static method

Set the connection resolver instance.
public static setConnectionResolver ( Illuminate\Database\ConnectionResolverInterface $resolver ) : void
$resolver Illuminate\Database\ConnectionResolverInterface
return void

setCreatedAt() public method

Set the value of the "created at" attribute.
public setCreatedAt ( mixed $value )
$value mixed

setDateFormat() public method

Set the date format used by the model.
public setDateFormat ( string $format )
$format string

setEventDispatcher() public static method

Set the event dispatcher instance.
public static setEventDispatcher ( Illuminate\Contracts\Events\Dispatcher $dispatcher ) : void
$dispatcher Illuminate\Contracts\Events\Dispatcher
return void

setHidden() public method

Set the hidden attributes for the model.
public setHidden ( array $hidden )
$hidden array

setIncrementing() public method

Set whether IDs are incrementing.
public setIncrementing ( boolean $value )
$value boolean

setKeyName() public method

Set the primary key for the model.
public setKeyName ( string $key )
$key string

setKeysForSaveQuery() protected method

Set the keys for a save update query.
protected setKeysForSaveQuery ( Builder $query ) : Builder
$query Builder
return Builder

setObservableEvents() public method

Set the observable event names.
public setObservableEvents ( array $observables )
$observables array

setPerPage() public method

Set the number of models to return per page.
public setPerPage ( integer $perPage )
$perPage integer

setRawAttributes() public method

Set the array of model attributes. No checking is done.
public setRawAttributes ( array $attributes, boolean $sync = false )
$attributes array
$sync boolean

setRelation() public method

Set the specific relationship in the model.
public setRelation ( string $relation, mixed $value )
$relation string
$value mixed

setRelations() public method

Set the entire relations array on the model.
public setRelations ( array $relations )
$relations array

setTable() public method

Set the table associated with the model.
public setTable ( string $table )
$table string

setTouchedRelations() public method

Set the relationships that are touched on save.
public setTouchedRelations ( array $touches )
$touches array

setUpdatedAt() public method

Set the value of the "updated at" attribute.
public setUpdatedAt ( mixed $value )
$value mixed

setVisible() public method

Set the visible attributes for the model.
public setVisible ( array $visible )
$visible array

syncOriginal() public method

Sync the original attributes with the current.
public syncOriginal ( )

syncOriginalAttribute() public method

Sync a single original attribute with its current value.
public syncOriginalAttribute ( string $attribute )
$attribute string

toArray() public method

Convert the model instance to an array.
public toArray ( ) : array
return array

toJson() public method

Convert the model instance to JSON.
public toJson ( integer $options ) : string
$options integer
return string

totallyGuarded() public method

Determine if the model is totally guarded.
public totallyGuarded ( ) : boolean
return boolean

touch() public method

Update the model's update timestamp.
public touch ( ) : boolean
return boolean

touchOwners() public method

Touch the owning relations of the model.
public touchOwners ( ) : void
return void

touches() public method

Determine if the model touches a given relation.
public touches ( string $relation ) : boolean
$relation string
return boolean

unguard() public static method

Disable all mass assignable restrictions.
public static unguard ( boolean $state = true ) : void
$state boolean
return void

unguarded() public static method

Run the given callable while being unguarded.
public static unguarded ( callable $callback ) : mixed
$callback callable
return mixed

unsetConnectionResolver() public static method

Unset the connection resolver for models.
public static unsetConnectionResolver ( ) : void
return void

unsetEventDispatcher() public static method

Unset the event dispatcher for models.
public static unsetEventDispatcher ( ) : void
return void

update() public method

Update the model in the database.
public update ( array $attributes = [], array $options = [] ) : boolean
$attributes array
$options array
return boolean

updateTimestamps() protected method

Update the creation and update timestamps.
protected updateTimestamps ( ) : void
return void

updated() public static method

Register an updated model event with the dispatcher.
public static updated ( Closure | string $callback, integer $priority ) : void
$callback Closure | string
$priority integer
return void

updating() public static method

Register an updating model event with the dispatcher.
public static updating ( Closure | string $callback, integer $priority ) : void
$callback Closure | string
$priority integer
return void

usesTimestamps() public method

Determine if the model uses timestamps.
public usesTimestamps ( ) : boolean
return boolean

with() public static method

Begin querying a model with eager loading.
public static with ( array | string $relations ) : Builder | static
$relations array | string
return Builder | static

Property Details

$appends protected property

The accessors to append to the model's array form.
protected array $appends
return array

$attributes protected property

The model's attributes.
protected array $attributes
return array

$booted protected static property

The array of booted models.
protected static array $booted
return array

$casts protected property

The attributes that should be cast to native types.
protected array $casts
return array

$connection protected property

The connection name for the model.
protected string $connection
return string

$dateFormat protected property

The storage format of the model's date columns.
protected string $dateFormat
return string

$dates protected property

The attributes that should be mutated to dates.
protected array $dates
return array

$dispatcher protected static property

The event dispatcher instance.
protected static Dispatcher,Illuminate\Contracts\Events $dispatcher
return Illuminate\Contracts\Events\Dispatcher

$events protected property

Allows for object-based events for native Eloquent events.
protected array $events
return array

$exists public property

Indicates if the model exists.
public bool $exists
return boolean

$fillable protected property

The attributes that are mass assignable.
protected array $fillable
return array

$globalScopes protected static property

The array of global scopes on the model.
protected static array $globalScopes
return array

$guarded protected property

The attributes that aren't mass assignable.
protected array $guarded
return array

$hidden protected property

The attributes that should be hidden for arrays.
protected array $hidden
return array

$incrementing public property

Indicates if the IDs are auto-incrementing.
public bool $incrementing
return boolean

$keyType protected property

The "type" of the auto-incrementing ID.
protected string $keyType
return string

$manyMethods public static property

The many to many relationship methods.
public static array $manyMethods
return array

$mutatorCache protected static property

The cache of the mutated attributes for each class.
protected static array $mutatorCache
return array

$observables protected property

User exposed observable events.
protected array $observables
return array

$original protected property

The model attribute's original state.
protected array $original
return array

$perPage protected property

The number of models to return for pagination.
protected int $perPage
return integer

$primaryKey protected property

The primary key for the model.
protected string $primaryKey
return string

$relations protected property

The loaded relationships for the model.
protected array $relations
return array

$resolver protected static property

The connection resolver instance.
protected static ConnectionResolverInterface,Illuminate\Database $resolver
return Illuminate\Database\ConnectionResolverInterface

$snakeAttributes public static property

Indicates whether attributes are snake cased on arrays.
public static bool $snakeAttributes
return boolean

$table protected property

The table associated with the model.
protected string $table
return string

$timestamps public property

Indicates if the model should be timestamped.
public bool $timestamps
return boolean

$touches protected property

The relationships that should be touched on save.
protected array $touches
return array

$unguarded protected static property

Indicates if all mass assignment is enabled.
protected static bool $unguarded
return boolean

$visible protected property

The attributes that should be visible in arrays.
protected array $visible
return array

$wasRecentlyCreated public property

Indicates if the model was inserted during the current request lifecycle.
public bool $wasRecentlyCreated
return boolean

$with protected property

The relations to eager load on every query.
protected array $with
return array