• Accueil
• Illuminate
• Database
• Eloquent
• Model

PHP Class Illuminate\Database\Eloquent\Model

Afficher le fichier Open project: illuminate/database Class Usage Examples

Méthodes publiques

Свойство	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

Свойство	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.

Méthodes publiques

Méthode	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.

Méthodes protégées

Méthode	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

Property Details