1. class
  2. Illuminate
  3. \
  4. Foundation
  5. \
  6. Auth
  7. \
  8. User

User

class User extends Model implements Authenticatable, Authorizable, CanResetPassword (View source)

Traits

Authenticatable
Authorizable
CanResetPassword
MustVerifyEmail
HasAttributes
HasEvents
HasGlobalScopes
HasRelationships
HasTimestamps
HasUniqueIds
HidesAttributes
GuardsAttributes
PreventsCircularRecursion
ForwardsCalls
HasCollection

Constants

CREATED_AT

The name of the "created at" column.
UPDATED_AT

The name of the "updated at" column.

Properties

protected array $attributes

The model's attributes.

 from  HasAttributes
protected array $original

The model attribute's original state.

 from  HasAttributes
protected array $changes

The changed model attributes.

 from  HasAttributes
protected array $casts

The attributes that should be cast.

 from  HasAttributes
protected array $classCastCache

The attributes that have been cast using custom classes.

 from  HasAttributes
protected array $attributeCastCache

The attributes that have been cast using "Attribute" return type mutators.

 from  HasAttributes
static protected string[] $primitiveCastTypes

The built-in, primitive cast types supported by Eloquent.

 from  HasAttributes
protected string|null $dateFormat

The storage format of the model's date columns.

 from  HasAttributes
protected array $appends

The accessors to append to the model's array form.

 from  HasAttributes
static bool $snakeAttributes

Indicates whether attributes are snake cased on arrays.

 from  HasAttributes
static protected array $mutatorCache

The cache of the mutated attributes for each class.

 from  HasAttributes
static protected array $attributeMutatorCache

The cache of the "Attribute" return type marked mutated attributes for each class.

 from  HasAttributes
static protected array $getAttributeMutatorCache

The cache of the "Attribute" return type marked mutated, gettable attributes for each class.

 from  HasAttributes
static protected array $setAttributeMutatorCache

The cache of the "Attribute" return type marked mutated, settable attributes for each class.

 from  HasAttributes
static protected array $castTypeCache

The cache of the converted cast types.

 from  HasAttributes
static Encrypter|null $encrypter

The encrypter instance that is used to encrypt attributes.

 from  HasAttributes
protected array $dispatchesEvents

The event map for the model.

 from  HasEvents
protected array $observables

User exposed observable events.

 from  HasEvents
protected array $relations

The loaded relationships for the model.

 from  HasRelationships
protected array $touches

The relationships that should be touched on save.

 from  HasRelationships
static string[] $manyMethods

The many to many relationship methods.

 from  HasRelationships
static protected array $relationResolvers

The relation resolver callbacks.

 from  HasRelationships
bool $timestamps

Indicates if the model should be timestamped.

 from  HasTimestamps
static protected array $ignoreTimestampsOn

The list of models classes that have timestamps temporarily disabled.

 from  HasTimestamps
bool $usesUniqueIds

Indicates if the model uses unique ids.

 from  HasUniqueIds
protected string[] $hidden

The attributes that should be hidden for serialization.

 from  HidesAttributes
protected string[] $visible

The attributes that should be visible in serialization.

 from  HidesAttributes
protected array<int,string> $fillable

The attributes that are mass assignable.

 from  GuardsAttributes
protected string[]|bool $guarded

The attributes that aren't mass assignable.

 from  GuardsAttributes
static protected bool $unguarded

Indicates if all mass assignment is enabled.

 from  GuardsAttributes
static protected string[] $guardableColumns

The actual columns that exist on the database and can be guarded.

 from  GuardsAttributes
static protected WeakMap<static,array<string,mixed>> $recursionCache

The cache of objects processed to prevent infinite recursion.

 from  PreventsCircularRecursion
static protected $resolvedCollectionClasses from  HasCollection
protected string|null $connection

The connection name for the model.

 from  Model
protected string|null $table

The table associated with the model.

 from  Model
protected string $primaryKey

The primary key for the model.

 from  Model
protected string $keyType

The "type" of the primary key ID.

 from  Model
bool $incrementing

Indicates if the IDs are auto-incrementing.

 from  Model
protected array $with

The relations to eager load on every query.

 from  Model
protected array $withCount

The relationship counts that should be eager loaded on every query.

 from  Model
bool $preventsLazyLoading

Indicates whether lazy loading will be prevented on this model.

 from  Model
protected int $perPage

The number of models to return for pagination.

 from  Model
bool $exists

Indicates if the model exists.

 from  Model
bool $wasRecentlyCreated

Indicates if the model was inserted during the object's lifecycle.

 from  Model
protected bool $escapeWhenCastingToString

Indicates that the object's string representation should be escaped when __toString is invoked.

 from  Model
static protected ConnectionResolverInterface $resolver

The connection resolver instance.

 from  Model
static protected Dispatcher|null $dispatcher

The event dispatcher instance.

 from  Model
static protected array $booted

The array of booted models.

 from  Model
static protected array $traitInitializers

The array of trait initializers that will be called on each new instance.

 from  Model
static protected array $globalScopes

The array of global scopes on the model.

 from  Model
static protected array $ignoreOnTouch

The list of models classes that should not be affected with touch.

 from  Model
static protected bool $modelsShouldPreventLazyLoading

Indicates whether lazy loading should be restricted on all models.

 from  Model
static protected callable|null $lazyLoadingViolationCallback

The callback that is responsible for handling lazy loading violations.

 from  Model
static protected bool $modelsShouldPreventSilentlyDiscardingAttributes

Indicates if an exception should be thrown instead of silently discarding non-fillable attributes.

 from  Model
static protected callable|null $discardedAttributeViolationCallback

The callback that is responsible for handling discarded attribute violations.

 from  Model
static protected bool $modelsShouldPreventAccessingMissingAttributes

Indicates if an exception should be thrown when trying to access a missing attribute on a retrieved model.

 from  Model
static protected callable|null $missingAttributeViolationCallback

The callback that is responsible for handling missing attribute violations.

 from  Model
static protected bool $isBroadcasting

Indicates if broadcasting is currently enabled.

 from  Model
static protected $builder

The Eloquent query builder class to use for the model.

 from  Model
static protected $collectionClass

The Eloquent collection class to use for the model.

 from  Model
protected string $authPasswordName

The column name of the password field using during authentication.

 from  Authenticatable
protected string $rememberTokenName

The column name of the "remember me" token.

 from  Authenticatable

Methods

void
initializeHasAttributes()

Initialize the trait.

from  HasAttributes
array
attributesToArray()

Convert the model's attributes to an array.

from  HasAttributes
array
addDateAttributesToArray(array $attributes)

Add the date attributes to the attributes array.

from  HasAttributes
array
addMutatedAttributesToArray(array $attributes, array $mutatedAttributes)

Add the mutated attributes to the attributes array.

from  HasAttributes
array
addCastAttributesToArray(array $attributes, array $mutatedAttributes)

Add the casted attributes to the attributes array.

from  HasAttributes
array
getArrayableAttributes()

Get an attribute array of all arrayable attributes.

from  HasAttributes
array
getArrayableAppends()

Get all of the appendable values that are arrayable.

from  HasAttributes
array
relationsToArray()

Get the model's relationships in array form.

from  HasAttributes
array
getArrayableRelations()

Get an attribute array of all arrayable relations.

from  HasAttributes
array
getArrayableItems(array $values)

Get an attribute array of all arrayable values.

from  HasAttributes
bool
hasAttribute(string $key)

Determine whether an attribute exists on the model.

from  HasAttributes
mixed
getAttribute(string $key)

Get an attribute from the model.

from  HasAttributes
null
throwMissingAttributeExceptionIfApplicable(string $key)

Either throw a missing attribute exception or return null depending on Eloquent's configuration.

from  HasAttributes
mixed
getAttributeValue(string $key)

Get a plain attribute (not a relationship).

from  HasAttributes
mixed
getAttributeFromArray(string $key)

Get an attribute from the $attributes array.

from  HasAttributes
mixed
getRelationValue(string $key)

Get a relationship.

from  HasAttributes
bool
isRelation(string $key)

Determine if the given key is a relationship method on the model.

from  HasAttributes
mixed
handleLazyLoadingViolation(string $key)

Handle a lazy loading violation.

from  HasAttributes
mixed
getRelationshipFromMethod(string $method)

Get a relationship value from a method.

from  HasAttributes
bool
hasGetMutator(string $key)

Determine if a get mutator exists for an attribute.

from  HasAttributes
bool
hasAttributeMutator(string $key)

Determine if a "Attribute" return type marked mutator exists for an attribute.

from  HasAttributes
bool
hasAttributeGetMutator(string $key)

Determine if a "Attribute" return type marked get mutator exists for an attribute.

from  HasAttributes
bool
hasAnyGetMutator(string $key)

Determine if any get mutator exists for an attribute.

from  HasAttributes
mixed
mutateAttribute(string $key, mixed $value)

Get the value of an attribute using its mutator.

from  HasAttributes
mixed
mutateAttributeMarkedAttribute(string $key, mixed $value)

Get the value of an "Attribute" return type marked attribute using its mutator.

from  HasAttributes
mixed
mutateAttributeForArray(string $key, mixed $value)

Get the value of an attribute using its mutator for array conversion.

from  HasAttributes
$this
mergeCasts(array $casts)

Merge new casts with existing casts on the model.

from  HasAttributes
array
ensureCastsAreStringValues(array $casts)

Ensure that the given casts are strings.

from  HasAttributes
mixed
castAttribute(string $key, mixed $value)

Cast an attribute to a native PHP type.

from  HasAttributes
mixed
getClassCastableAttributeValue(string $key, mixed $value)

Cast the given attribute using a custom cast class.

from  HasAttributes
mixed
getEnumCastableAttributeValue(string $key, mixed $value)

Cast the given attribute to an enum.

from  HasAttributes
string
getCastType(string $key)

Get the type of cast for a model attribute.

from  HasAttributes
mixed
deviateClassCastableAttribute(string $method, string $key, mixed $value)

Increment or decrement the given attribute using the custom cast class.

from  HasAttributes
mixed
serializeClassCastableAttribute(string $key, mixed $value)

Serialize the given attribute using the custom cast class.

from  HasAttributes
bool
isCustomDateTimeCast(string $cast)

Determine if the cast type is a custom date time cast.

from  HasAttributes
bool
isImmutableCustomDateTimeCast(string $cast)

Determine if the cast type is an immutable custom date time cast.

from  HasAttributes
bool
isDecimalCast(string $cast)

Determine if the cast type is a decimal cast.

from  HasAttributes
mixed
setAttribute(string $key, mixed $value)

Set a given attribute on the model.

from  HasAttributes
bool
hasSetMutator(string $key)

Determine if a set mutator exists for an attribute.

from  HasAttributes
bool
hasAttributeSetMutator(string $key)

Determine if an "Attribute" return type marked set mutator exists for an attribute.

from  HasAttributes
mixed
setMutatedAttributeValue(string $key, mixed $value)

Set the value of an attribute using its mutator.

from  HasAttributes
mixed
setAttributeMarkedMutatedAttributeValue(string $key, mixed $value)

Set the value of a "Attribute" return type marked attribute using its mutator.

from  HasAttributes
bool
isDateAttribute(string $key)

Determine if the given attribute is a date or date castable.

from  HasAttributes
$this
fillJsonAttribute(string $key, mixed $value)

Set a given JSON attribute on the model.

from  HasAttributes
void
setClassCastableAttribute(string $key, mixed $value)

Set the value of a class castable attribute.

from  HasAttributes
void
setEnumCastableAttribute(string $key, UnitEnum|string|int|null $value)

Set the value of an enum castable attribute.

from  HasAttributes
UnitEnum|BackedEnum
getEnumCaseFromValue(string $enumClass, string|int $value)

Get an enum case instance from a given class and value.

from  HasAttributes
string|int
getStorableEnumValue(string $expectedEnum, UnitEnum|BackedEnum $value)

Get the storable value from the given enum.

from  HasAttributes
$this
getArrayAttributeWithValue(string $path, string $key, mixed $value)

Get an array attribute with the given key and value set.

from  HasAttributes
array
getArrayAttributeByKey(string $key)

Get an array attribute or return an empty array if it is not set.

from  HasAttributes
string
castAttributeAsJson(string $key, mixed $value)

Cast the given attribute to JSON.

from  HasAttributes
int
getJsonCastFlags(string $key)

Get the JSON casting flags for the given attribute.

from  HasAttributes
string
asJson(mixed $value, int $flags = 0)

Encode the given value as JSON.

from  HasAttributes
mixed
fromJson(string|null $value, bool $asObject = false)

Decode the given JSON back into an array or object.

from  HasAttributes
mixed
fromEncryptedString(string $value)

Decrypt the given encrypted string.

from  HasAttributes
string
castAttributeAsEncryptedString(string $key, mixed $value)

Cast the given attribute to an encrypted string.

from  HasAttributes
static void
encryptUsing(Encrypter|null $encrypter)

Set the encrypter instance that will be used to encrypt attributes.

from  HasAttributes
static Encrypter
currentEncrypter()

Get the current encrypter being used by the model.

from  HasAttributes
string
castAttributeAsHashedString(string $key, mixed $value)

Cast the given attribute to a hashed string.

from  HasAttributes
mixed
fromFloat(mixed $value)

Decode the given float.

from  HasAttributes
string
asDecimal(float|string $value, int $decimals)

Return a decimal as string.

from  HasAttributes
Carbon
asDate(mixed $value)

Return a timestamp as DateTime object with time set to 00:00:00.

from  HasAttributes
Carbon
asDateTime(mixed $value)

Return a timestamp as DateTime object.

from  HasAttributes
bool
isStandardDateFormat(string $value)

Determine if the given value is a standard date format.

from  HasAttributes
string|null
fromDateTime(mixed $value)

Convert a DateTime to a storable string.

from  HasAttributes
int
asTimestamp(mixed $value)

Return a timestamp as unix timestamp.

from  HasAttributes
string
serializeDate(DateTimeInterface $date)

Prepare a date for array / JSON serialization.

from  HasAttributes
array
getDates()

Get the attributes that should be converted to dates.

from  HasAttributes
string
getDateFormat()

Get the format for database stored dates.

from  HasAttributes
$this
setDateFormat(string $format)

Set the date format used by the model.

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

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

from  HasAttributes
array
getCasts()

Get the attributes that should be cast.

from  HasAttributes
array<string,string>
casts()

Get the attributes that should be cast.

from  HasAttributes
bool
isDateCastable(string $key)

Determine whether a value is Date / DateTime castable for inbound manipulation.

from  HasAttributes
bool
isDateCastableWithCustomFormat(string $key)

Determine whether a value is Date / DateTime custom-castable for inbound manipulation.

from  HasAttributes
bool
isJsonCastable(string $key)

Determine whether a value is JSON castable for inbound manipulation.

from  HasAttributes
bool
isEncryptedCastable(string $key)

Determine whether a value is an encrypted castable for inbound manipulation.

from  HasAttributes
bool
isClassCastable(string $key)

Determine if the given key is cast using a custom class.

from  HasAttributes
bool
isEnumCastable(string $key)

Determine if the given key is cast using an enum.

from  HasAttributes
bool
isClassDeviable(string $key)

Determine if the key is deviable using a custom class.

from  HasAttributes
bool
isClassSerializable(string $key)

Determine if the key is serializable using a custom class.

from  HasAttributes
mixed
resolveCasterClass(string $key)

Resolve the custom caster class for a given key.

from  HasAttributes
string
parseCasterClass(string $class)

Parse the given caster class, removing any arguments.

from  HasAttributes
void
mergeAttributesFromCachedCasts()

Merge the cast class and attribute cast attributes back into the model.

from  HasAttributes
void
mergeAttributesFromClassCasts()

Merge the cast class attributes back into the model.

from  HasAttributes
void
mergeAttributesFromAttributeCasts()

Merge the cast class attributes back into the model.

from  HasAttributes
array
normalizeCastClassResponse(string $key, mixed $value)

Normalize the response from a custom class caster.

from  HasAttributes
array<string,mixed>
getAttributes()

Get all of the current attributes on the model.

from  HasAttributes
array
getAttributesForInsert()

Get all of the current attributes on the model for an insert operation.

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

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

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

Get the model's original attribute values.

from  HasAttributes
mixed|array
getOriginalWithoutRewindingModel(string|null $key = null, mixed $default = null)

Get the model's original attribute values.

from  HasAttributes
mixed|array
getRawOriginal(string|null $key = null, mixed $default = null)

Get the model's raw original attribute values.

from  HasAttributes
array
only(array|mixed $attributes)

Get a subset of the model's attributes.

from  HasAttributes
array
except(array|mixed $attributes)

Get all attributes except the given ones.

from  HasAttributes
$this
syncOriginal()

Sync the original attributes with the current.

from  HasAttributes
$this
syncOriginalAttribute(string $attribute)

Sync a single original attribute with its current value.

from  HasAttributes
$this
syncOriginalAttributes(array|string $attributes)

Sync multiple original attribute with their current values.

from  HasAttributes
$this
syncChanges()

Sync the changed attributes.

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

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

from  HasAttributes
bool
isClean(array|string|null $attributes = null)

Determine if the model or all the given attribute(s) have remained the same.

from  HasAttributes
$this
discardChanges()

Discard attribute changes and reset the attributes to their original state.

from  HasAttributes
bool
wasChanged(array|string|null $attributes = null)

Determine if the model or any of the given attribute(s) were changed when the model was last saved.

from  HasAttributes
bool
hasChanges(array $changes, array|string|null $attributes = null)

Determine if any of the given attributes were changed when the model was last saved.

from  HasAttributes
array
getDirty()

Get the attributes that have been changed since the last sync.

from  HasAttributes
array
getDirtyForUpdate()

Get the attributes that have been changed since the last sync for an update operation.

from  HasAttributes
array
getChanges()

Get the attributes that were changed when the model was last saved.

from  HasAttributes
bool
originalIsEquivalent(string $key)

Determine if the new and old values for a given key are equivalent.

from  HasAttributes
mixed
transformModelValue(string $key, mixed $value)

Transform a raw model value using mutators, casts, etc.

from  HasAttributes
$this
append(array|string $attributes)

Append attributes to query when building a query.

from  HasAttributes
array
getAppends()

Get the accessors that are being appended to model arrays.

from  HasAttributes
$this
setAppends(array $appends)

Set the accessors to append to model arrays.

from  HasAttributes
bool
hasAppended(string $attribute)

Return whether the accessor attribute has been appended.

from  HasAttributes
array
getMutatedAttributes()

Get the mutated attributes for a given instance.

from  HasAttributes
static void
cacheMutatedAttributes(object|string $classOrInstance)

Extract and cache all the mutated attributes of a class.

from  HasAttributes
static array
getMutatorMethods(mixed $class)

Get all of the attribute mutator methods.

from  HasAttributes
static array
getAttributeMarkedMutatorMethods(mixed $class)

Get all of the "Attribute" return typed attribute mutator methods.

from  HasAttributes
static void
bootHasEvents()

Boot the has event trait for a model.

from  HasEvents
static array
resolveObserveAttributes()

Resolve the observe class names from the attributes.

from  HasEvents
static void
observe(object|array|string $classes)

Register observers with the model.

from  HasEvents
void
registerObserver(object|string $class)

Register a single observer with the model.

from  HasEvents
array
getObservableEvents()

Get the observable event names.

from  HasEvents
$this
setObservableEvents(array $observables)

Set the observable event names.

from  HasEvents
void
addObservableEvents(array|mixed $observables)

Add an observable event name.

from  HasEvents
void
removeObservableEvents(array|mixed $observables)

Remove an observable event name.

from  HasEvents
static void
registerModelEvent(string $event, QueuedClosure|callable|array|class-string $callback)

Register a model event with the dispatcher.

from  HasEvents
mixed
fireModelEvent(string $event, bool $halt = true)

Fire the given event for the model.

from  HasEvents
mixed|null
fireCustomModelEvent(string $event, string $method)

Fire a custom model event for the given event.

from  HasEvents
mixed
filterModelEventResults(mixed $result)

Filter the model event results.

from  HasEvents
static void
retrieved(QueuedClosure|callable|array|class-string $callback)

Register a retrieved model event with the dispatcher.

from  HasEvents
static void
saving(QueuedClosure|callable|array|class-string $callback)

Register a saving model event with the dispatcher.

from  HasEvents
static void
saved(QueuedClosure|callable|array|class-string $callback)

Register a saved model event with the dispatcher.

from  HasEvents
static void
updating(QueuedClosure|callable|array|class-string $callback)

Register an updating model event with the dispatcher.

from  HasEvents
static void
updated(QueuedClosure|callable|array|class-string $callback)

Register an updated model event with the dispatcher.

from  HasEvents
static void
creating(QueuedClosure|callable|array|class-string $callback)

Register a creating model event with the dispatcher.

from  HasEvents
static void
created(QueuedClosure|callable|array|class-string $callback)

Register a created model event with the dispatcher.

from  HasEvents
static void
replicating(QueuedClosure|callable|array|class-string $callback)

Register a replicating model event with the dispatcher.

from  HasEvents
static void
deleting(QueuedClosure|callable|array|class-string $callback)

Register a deleting model event with the dispatcher.

from  HasEvents
static void
deleted(QueuedClosure|callable|array|class-string $callback)

Register a deleted model event with the dispatcher.

from  HasEvents
static void
flushEventListeners()

Remove all the event listeners for the model.

from  HasEvents
array
dispatchesEvents()

Get the event map for the model.

from  HasEvents
static Dispatcher|null
getEventDispatcher()

Get the event dispatcher instance.

from  HasEvents
static void
setEventDispatcher(Dispatcher $dispatcher)

Set the event dispatcher instance.

from  HasEvents
static void
unsetEventDispatcher()

Unset the event dispatcher for models.

from  HasEvents
static mixed
withoutEvents(callable $callback)

Execute a callback without firing any model events for any model type.

from  HasEvents
static void
bootHasGlobalScopes()

Boot the has global scopes trait for a model.

from  HasGlobalScopes
static array
resolveGlobalScopeAttributes()

Resolve the global scope class names from the attributes.

from  HasGlobalScopes
static mixed
addGlobalScope($scope, $implementation = null)

Register a new global scope on the model.

from  HasGlobalScopes
static void
addGlobalScopes(array $scopes)

Register multiple global scopes on the model.

from  HasGlobalScopes
static bool
hasGlobalScope(Scope|string $scope)

Determine if a model has a global scope.

from  HasGlobalScopes
static 
getGlobalScope(Scope|string $scope)

Get a global scope registered with the model.

from  HasGlobalScopes
static array
getAllGlobalScopes()

Get all of the global scopes that are currently registered.

from  HasGlobalScopes
static void
setAllGlobalScopes(array $scopes)

Set the current global scopes.

from  HasGlobalScopes
array
getGlobalScopes()

Get the global scopes for this class instance.

from  HasGlobalScopes
Closure|null
relationResolver(TRelatedModel> $class, string $key)

Get the dynamic relation resolver if defined or inherited, or return null.

from  HasRelationships
static void
resolveRelationUsing(string $name, Closure $callback)

Define a dynamic relation resolver.

from  HasRelationships
TRelatedModel,$this>
hasOne(TRelatedModel> $related, string|null $foreignKey = null, string|null $localKey = null)

Define a one-to-one relationship.

from  HasRelationships
TDeclaringModel>
newHasOne(Builder $query, Model $parent, string $foreignKey, string $localKey)

Instantiate a new HasOne relationship.

from  HasRelationships
hasOneThrough($related, $through, $firstKey = null, $secondKey = null, $localKey = null, $secondLocalKey = null)

No description

from  HasRelationships
newHasOneThrough(Builder $query, Model $farParent, Model $throughParent, $firstKey, $secondKey, $localKey, $secondLocalKey)

No description

from  HasRelationships
TRelatedModel,$this>
morphOne(TRelatedModel> $related, string $name, string|null $type = null, string|null $id = null, string|null $localKey = null)

Define a polymorphic one-to-one relationship.

from  HasRelationships
TDeclaringModel>
newMorphOne(Builder $query, Model $parent, string $type, string $id, string $localKey)

Instantiate a new MorphOne relationship.

from  HasRelationships
TRelatedModel,$this>
belongsTo(TRelatedModel> $related, string|null $foreignKey = null, string|null $ownerKey = null, string|null $relation = null)

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

from  HasRelationships
TDeclaringModel>
newBelongsTo(Builder $query, Model $child, string $foreignKey, string $ownerKey, string $relation)

Instantiate a new BelongsTo relationship.

from  HasRelationships
Model,$this>
morphTo(string|null $name = null, string|null $type = null, string|null $id = null, string|null $ownerKey = null)

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

from  HasRelationships
Model,$this>
morphEagerTo(string $name, string $type, string $id, string|null $ownerKey)

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

from  HasRelationships
Model,$this>
morphInstanceTo(string $target, string $name, string $type, string $id, string|null $ownerKey)

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

from  HasRelationships
TDeclaringModel>
newMorphTo(Builder $query, Model $parent, string $foreignKey, string|null $ownerKey, string $type, string $relation)

Instantiate a new MorphTo relationship.

from  HasRelationships
static string
getActualClassNameForMorph(string $class)

Retrieve the actual class name for a given morph class.

from  HasRelationships
string
guessBelongsToRelation()

Guess the "belongs to" relationship name.

from  HasRelationships
through($relationship)

Create a pending has-many-through or has-one-through relationship.

from  HasRelationships
TRelatedModel,$this>
hasMany(TRelatedModel> $related, string|null $foreignKey = null, string|null $localKey = null)

Define a one-to-many relationship.

from  HasRelationships
TDeclaringModel>
newHasMany(Builder $query, Model $parent, string $foreignKey, string $localKey)

Instantiate a new HasMany relationship.

from  HasRelationships
hasManyThrough($related, $through, $firstKey = null, $secondKey = null, $localKey = null, $secondLocalKey = null)

No description

from  HasRelationships
newHasManyThrough(Builder $query, Model $farParent, Model $throughParent, $firstKey, $secondKey, $localKey, $secondLocalKey)

No description

from  HasRelationships
TRelatedModel,$this>
morphMany(TRelatedModel> $related, string $name, string|null $type = null, string|null $id = null, string|null $localKey = null)

Define a polymorphic one-to-many relationship.

from  HasRelationships
TDeclaringModel>
newMorphMany(Builder $query, Model $parent, string $type, string $id, string $localKey)

Instantiate a new MorphMany relationship.

from  HasRelationships
belongsToMany($related, $table = null, $foreignPivotKey = null, $relatedPivotKey = null, $parentKey = null, $relatedKey = null, $relation = null)

No description

from  HasRelationships
newBelongsToMany(Builder $query, Model $parent, $table, $foreignPivotKey, $relatedPivotKey, $parentKey, $relatedKey, $relationName = null)

No description

from  HasRelationships
TRelatedModel,$this>
morphToMany(TRelatedModel> $related, string $name, string|null $table = null, string|null $foreignPivotKey = null, string|null $relatedPivotKey = null, string|null $parentKey = null, string|null $relatedKey = null, string|null $relation = null, bool $inverse = false)

Define a polymorphic many-to-many relationship.

from  HasRelationships
TDeclaringModel>
newMorphToMany(Builder $query, Model $parent, string $name, string $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string|null $relationName = null, bool $inverse = false)

Instantiate a new MorphToMany relationship.

from  HasRelationships
TRelatedModel,$this>
morphedByMany(TRelatedModel> $related, string $name, string|null $table = null, string|null $foreignPivotKey = null, string|null $relatedPivotKey = null, string|null $parentKey = null, string|null $relatedKey = null, string|null $relation = null)

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

from  HasRelationships
string|null
guessBelongsToManyRelation()

Get the relationship name of the belongsToMany relationship.

from  HasRelationships
string
joiningTable(string $related, Model|null $instance = null)

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

from  HasRelationships
string
joiningTableSegment()

Get this model's half of the intermediate table name for belongsToMany relationships.

from  HasRelationships
bool
touches(string $relation)

Determine if the model touches a given relation.

from  HasRelationships
void
touchOwners()

Touch the owning relations of the model.

from  HasRelationships
array
getMorphs(string $name, string $type, string $id)

Get the polymorphic relationship columns.

from  HasRelationships
string
getMorphClass()

Get the class name for polymorphic relations.

from  HasRelationships
TRelatedModel
newRelatedInstance(TRelatedModel> $class)

Create a new model instance for a related model.

from  HasRelationships
TRelatedModel
newRelatedThroughInstance(TRelatedModel> $class)

Create a new model instance for a related "through" model.

from  HasRelationships
array
getRelations()

Get all the loaded relations for the instance.

from  HasRelationships
mixed
getRelation(string $relation)

Get a specified relationship.

from  HasRelationships
bool
relationLoaded(string $key)

Determine if the given relation is loaded.

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

Set the given relationship on the model.

from  HasRelationships
$this
unsetRelation(string $relation)

Unset a loaded relationship.

from  HasRelationships
$this
setRelations(array $relations)

Set the entire relations array on the model.

from  HasRelationships
$this
withoutRelations()

Duplicate the instance and unset all the loaded relations.

from  HasRelationships
$this
unsetRelations()

Unset all the loaded relations for the instance.

from  HasRelationships
array
getTouchedRelations()

Get the relationships that are touched on save.

from  HasRelationships
$this
setTouchedRelations(array $touches)

Set the relationships that are touched on save.

from  HasRelationships
bool
touch(string|null $attribute = null)

Update the model's update timestamp.

from  HasTimestamps
bool
touchQuietly(string|null $attribute = null)

Update the model's update timestamp without raising any events.

from  HasTimestamps
$this
updateTimestamps()

Update the creation and update timestamps.

from  HasTimestamps
$this
setCreatedAt(mixed $value)

Set the value of the "created at" attribute.

from  HasTimestamps
$this
setUpdatedAt(mixed $value)

Set the value of the "updated at" attribute.

from  HasTimestamps
Carbon
freshTimestamp()

Get a fresh timestamp for the model.

from  HasTimestamps
string
freshTimestampString()

Get a fresh timestamp for the model.

from  HasTimestamps
bool
usesTimestamps()

Determine if the model uses timestamps.

from  HasTimestamps
string|null
getCreatedAtColumn()

Get the name of the "created at" column.

from  HasTimestamps
string|null
getUpdatedAtColumn()

Get the name of the "updated at" column.

from  HasTimestamps
string|null
getQualifiedCreatedAtColumn()

Get the fully qualified "created at" column.

from  HasTimestamps
string|null
getQualifiedUpdatedAtColumn()

Get the fully qualified "updated at" column.

from  HasTimestamps
static mixed
withoutTimestamps(callable $callback)

Disable timestamps for the current class during the given callback scope.

from  HasTimestamps
static mixed
withoutTimestampsOn(array $models, callable $callback)

Disable timestamps for the given model classes during the given callback scope.

from  HasTimestamps
static bool
isIgnoringTimestamps(string|null $class = null)

Determine if the given model is ignoring timestamps / touches.

from  HasTimestamps
bool
usesUniqueIds()

Determine if the model uses unique ids.

from  HasUniqueIds
void
setUniqueIds()

Generate unique keys for the model.

from  HasUniqueIds
string
newUniqueId()

Generate a new key for the model.

from  HasUniqueIds
array
uniqueIds()

Get the columns that should receive a unique identifier.

from  HasUniqueIds
string[]
getHidden()

Get the hidden attributes for the model.

from  HidesAttributes
$this
setHidden(array $hidden)

Set the hidden attributes for the model.

from  HidesAttributes
string[]
getVisible()

Get the visible attributes for the model.

from  HidesAttributes
$this
setVisible(array $visible)

Set the visible attributes for the model.

from  HidesAttributes
$this
makeVisible(string[]|string|null $attributes)

Make the given, typically hidden, attributes visible.

from  HidesAttributes
$this
makeVisibleIf(bool|Closure $condition, string[]|string|null $attributes)

Make the given, typically hidden, attributes visible if the given truth test passes.

from  HidesAttributes
$this
makeHidden(string[]|string|null $attributes)

Make the given, typically visible, attributes hidden.

from  HidesAttributes
$this
makeHiddenIf(bool|Closure $condition, string[]|string|null $attributes)

Make the given, typically visible, attributes hidden if the given truth test passes.

from  HidesAttributes
string[]
getFillable()

Get the fillable attributes for the model.

from  GuardsAttributes
$this
fillable(array $fillable)

Set the fillable attributes for the model.

from  GuardsAttributes
$this
mergeFillable(array $fillable)

Merge new fillable attributes with existing fillable attributes on the model.

from  GuardsAttributes
string[]
getGuarded()

Get the guarded attributes for the model.

from  GuardsAttributes
$this
guard(array $guarded)

Set the guarded attributes for the model.

from  GuardsAttributes
$this
mergeGuarded(array $guarded)

Merge new guarded attributes with existing guarded attributes on the model.

from  GuardsAttributes
static void
unguard(bool $state = true)

Disable all mass assignable restrictions.

from  GuardsAttributes
static void
reguard()

Enable the mass assignment restrictions.

from  GuardsAttributes
static bool
isUnguarded()

Determine if the current state is "unguarded".

from  GuardsAttributes
static mixed
unguarded(callable $callback)

Run the given callable while being unguarded.

from  GuardsAttributes
bool
isFillable(string $key)

Determine if the given attribute may be mass assigned.

from  GuardsAttributes
bool
isGuarded(string $key)

Determine if the given key is guarded.

from  GuardsAttributes
bool
isGuardableColumn(string $key)

Determine if the given column is a valid, guardable column.

from  GuardsAttributes
bool
totallyGuarded()

Determine if the model is totally guarded.

from  GuardsAttributes
array
fillableFromArray(array $attributes)

Get the fillable attributes of a given array.

from  GuardsAttributes
mixed
withoutRecursion(callable $callback, mixed $default = null)

Prevent a method from being called multiple times on the same object within the same call stack.

from  PreventsCircularRecursion
static 
clearRecursiveCallValue(object $object, string $hash)

Remove an entry from the recursion cache for an object.

from  PreventsCircularRecursion
static array
getRecursiveCallStack(object $object)

Get the stack of methods being called recursively for the current object.

from  PreventsCircularRecursion
static WeakMap
getRecursionCache()

Get the current recursion cache being used by the model.

from  PreventsCircularRecursion
static mixed
setRecursiveCallValue(object $object, string $hash, mixed $value)

Set a value in the recursion cache for the given object and method.

from  PreventsCircularRecursion
mixed
forwardCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object.

from  ForwardsCalls
mixed
forwardDecoratedCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object, returning $this if the forwarded call returned itself.

from  ForwardsCalls
static never
throwBadMethodCallException(string $method)

Throw a bad method call exception for the given method.

from  ForwardsCalls
TCollection
newCollection(array $models = [])

Create a new Eloquent Collection instance.

from  HasCollection
TCollection>|null
resolveCollectionFromAttribute()

Resolve the collection class name from the CollectedBy attribute.

from  HasCollection
__construct(array $attributes = [])

Create a new Eloquent model instance.

from  Model
void
bootIfNotBooted()

Check if the model needs to be booted and if so, do it.

from  Model
static void
booting()

Perform any actions required before the model boots.

from  Model
static void
boot()

Bootstrap the model and its traits.

from  Model
static void
bootTraits()

Boot all of the bootable traits on the model.

from  Model
void
initializeTraits()

Initialize any initializable traits on the model.

from  Model
static void
booted()

Perform any actions required after the model boots.

from  Model
static void
clearBootedModels()

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

from  Model
static void
withoutTouching(callable $callback)

Disables relationship model touching for the current class during given callback scope.

from  Model
static void
withoutTouchingOn(array $models, callable $callback)

Disables relationship model touching for the given model classes during given callback scope.

from  Model
static bool
isIgnoringTouch(string|null $class = null)

Determine if the given model is ignoring touches.

from  Model
static void
shouldBeStrict(bool $shouldBeStrict = true)

Indicate that models should prevent lazy loading, silently discarding attributes, and accessing missing attributes.

from  Model
static void
preventLazyLoading(bool $value = true)

Prevent model relationships from being lazy loaded.

from  Model
static void
handleLazyLoadingViolationUsing(callable|null $callback)

Register a callback that is responsible for handling lazy loading violations.

from  Model
static void
preventSilentlyDiscardingAttributes(bool $value = true)

Prevent non-fillable attributes from being silently discarded.

from  Model
static void
handleDiscardedAttributeViolationUsing(callable|null $callback)

Register a callback that is responsible for handling discarded attribute violations.

from  Model
static void
preventAccessingMissingAttributes(bool $value = true)

Prevent accessing missing attributes on retrieved models.

from  Model
static void
handleMissingAttributeViolationUsing(callable|null $callback)

Register a callback that is responsible for handling missing attribute violations.

from  Model
static mixed
withoutBroadcasting(callable $callback)

Execute a callback without broadcasting any model events for all model types.

from  Model
$this
fill(array $attributes)

Fill the model with an array of attributes.

from  Model
$this
forceFill(array $attributes)

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

from  Model
string
qualifyColumn(string $column)

Qualify the given column name by the model's table.

from  Model
array
qualifyColumns(array $columns)

Qualify the given columns with the model's table.

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

Create a new instance of the given model.

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

Create a new model instance that is existing.

from  Model
static Builder<static>
on(string|null $connection = null)

Begin querying the model on a given connection.

from  Model
static Builder<static>
onWriteConnection()

Begin querying the model on the write connection.

from  Model
static Collection<int,static>
all(array|string $columns = ['*'])

Get all of the models from the database.

from  Model
static Builder<static>
with(array|string $relations)

Begin querying a model with eager loading.

from  Model
$this
load(array|string $relations)

Eager load relations on the model.

from  Model
$this
loadMorph(string $relation, array $relations)

Eager load relationships on the polymorphic relation of a model.

from  Model
$this
loadMissing(array|string $relations)

Eager load relations on the model if they are not already eager loaded.

from  Model
$this
loadAggregate(array|string $relations, string $column, string|null $function = null)

Eager load relation's column aggregations on the model.

from  Model
$this
loadCount(array|string $relations)

Eager load relation counts on the model.

from  Model
$this
loadMax(array|string $relations, string $column)

Eager load relation max column values on the model.

from  Model
$this
loadMin(array|string $relations, string $column)

Eager load relation min column values on the model.

from  Model
$this
loadSum(array|string $relations, string $column)

Eager load relation's column summations on the model.

from  Model
$this
loadAvg(array|string $relations, string $column)

Eager load relation average column values on the model.

from  Model
$this
loadExists(array|string $relations)

Eager load related model existence values on the model.

from  Model
$this
loadMorphAggregate(string $relation, array $relations, string $column, string|null $function = null)

Eager load relationship column aggregation on the polymorphic relation of a model.

from  Model
$this
loadMorphCount(string $relation, array $relations)

Eager load relationship counts on the polymorphic relation of a model.

from  Model
$this
loadMorphMax(string $relation, array $relations, string $column)

Eager load relationship max column values on the polymorphic relation of a model.

from  Model
$this
loadMorphMin(string $relation, array $relations, string $column)

Eager load relationship min column values on the polymorphic relation of a model.

from  Model
$this
loadMorphSum(string $relation, array $relations, string $column)

Eager load relationship column summations on the polymorphic relation of a model.

from  Model
$this
loadMorphAvg(string $relation, array $relations, string $column)

Eager load relationship average column values on the polymorphic relation of a model.

from  Model
int
increment(string $column, float|int $amount = 1, array $extra = [])

Increment a column's value by a given amount.

from  Model
int
decrement(string $column, float|int $amount = 1, array $extra = [])

Decrement a column's value by a given amount.

from  Model
int
incrementOrDecrement(string $column, float|int $amount, array $extra, string $method)

Run the increment or decrement method on the model.

from  Model
bool
update(array $attributes = [], array $options = [])

Update the model in the database.

from  Model
bool
updateOrFail(array $attributes = [], array $options = [])

Update the model in the database within a transaction.

from  Model
bool
updateQuietly(array $attributes = [], array $options = [])

Update the model in the database without raising any events.

from  Model
int
incrementQuietly(string $column, float|int $amount = 1, array $extra = [])

Increment a column's value by a given amount without raising any events.

from  Model
int
decrementQuietly(string $column, float|int $amount = 1, array $extra = [])

Decrement a column's value by a given amount without raising any events.

from  Model
bool
push()

Save the model and all of its relationships.

from  Model
bool
pushQuietly()

Save the model and all of its relationships without raising any events to the parent model.

from  Model
bool
saveQuietly(array $options = [])

Save the model to the database without raising any events.

from  Model
bool
save(array $options = [])

Save the model to the database.

from  Model
bool
saveOrFail(array $options = [])

Save the model to the database within a transaction.

from  Model
void
finishSave(array $options)

Perform any actions that are necessary after the model is saved.

from  Model
bool
performUpdate(Builder $query)

Perform a model update operation.

from  Model
Builder<static>
setKeysForSelectQuery(Builder<static> $query)

Set the keys for a select query.

from  Model
mixed
getKeyForSelectQuery()

Get the primary key value for a select query.

from  Model
Builder<static>
setKeysForSaveQuery(Builder<static> $query)

Set the keys for a save update query.

from  Model
mixed
getKeyForSaveQuery()

Get the primary key value for a save query.

from  Model
bool
performInsert(Builder $query)

Perform a model insert operation.

from  Model
void
insertAndSetId(Builder $query, array $attributes)

Insert the given attributes and set the ID on the model.

from  Model
static int
destroy(Collection|array|int|string $ids)

Destroy the models for the given IDs.

from  Model
bool|null
delete()

Delete the model from the database.

from  Model
bool
deleteQuietly()

Delete the model from the database without raising any events.

from  Model
bool|null
deleteOrFail()

Delete the model from the database within a transaction.

from  Model
bool|null
forceDelete()

Force a hard delete on a soft deleted model.

from  Model
static bool|null
forceDestroy(Collection|array|int|string $ids)

Force a hard destroy on a soft deleted model.

from  Model
void
performDeleteOnModel()

Perform the actual delete query on this model instance.

from  Model
static Builder<static>
query()

Begin querying the model.

from  Model
Builder<static>
newQuery()

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

from  Model
Builder<static>
newModelQuery()

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

from  Model
Builder<static>
newQueryWithoutRelationships()

Get a new query builder with no relationships loaded.

from  Model
Builder<static>
registerGlobalScopes(Builder<static> $builder)

Register the global scopes for this builder instance.

from  Model
Builder<static>
newQueryWithoutScopes()

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

from  Model
Builder<static>
newQueryWithoutScope(Scope|string $scope)

Get a new query instance without a given scope.

from  Model
Builder<static>
newQueryForRestoration(array|int $ids)

Get a new query to restore one or more models by their queueable IDs.

from  Model
newEloquentBuilder(Builder $query)

Create a new Eloquent query builder for the model.

from  Model
Builder
newBaseQueryBuilder()

Get a new query builder instance for the connection.

from  Model
Pivot
newPivot(Model $parent, array $attributes, string $table, bool $exists, string|null $using = null)

Create a new pivot model instance.

from  Model
bool
hasNamedScope(string $scope)

Determine if the model has a given scope.

from  Model
mixed
callNamedScope(string $scope, array $parameters = [])

Apply the given named scope if possible.

from  Model
static bool
isScopeMethodWithAttribute(string $method)

Determine if the given method has a scope attribute.

from  Model
toArray()

Convert the model instance to an array.

from  Model
string
toJson(int $options = 0)

Convert the model instance to JSON.

from  Model
mixed
jsonSerialize()

Convert the object into something JSON serializable.

from  Model
Model|null
fresh(array|string $with = [])

Reload a fresh model instance from the database.

from  Model
$this
refresh()

Reload the current model instance with fresh attributes from the database.

from  Model
Model
replicate(array|null $except = null)

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

from  Model
Model
replicateQuietly(array|null $except = null)

Clone the model into a new, non-existing instance without raising any events.

from  Model
bool
is(Model|null $model)

Determine if two models have the same ID and belong to the same table.

from  Model
bool
isNot(Model|null $model)

Determine if two models are not the same.

from  Model
Connection
getConnection()

Get the database connection for the model.

from  Model
string|null
getConnectionName()

Get the current connection name for the model.

from  Model
$this
setConnection(string|null $name)

Set the connection associated with the model.

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

Resolve a connection instance.

from  Model
static ConnectionResolverInterface|null
getConnectionResolver()

Get the connection resolver instance.

from  Model
static void
setConnectionResolver(ConnectionResolverInterface $resolver)

Set the connection resolver instance.

from  Model
static void
unsetConnectionResolver()

Unset the connection resolver for models.

from  Model
string
getTable()

Get the table associated with the model.

from  Model
$this
setTable(string $table)

Set the table associated with the model.

from  Model
string
getKeyName()

Get the primary key for the model.

from  Model
$this
setKeyName(string $key)

Set the primary key for the model.

from  Model
string
getQualifiedKeyName()

Get the table qualified key name.

from  Model
string
getKeyType()

Get the auto-incrementing key type.

from  Model
$this
setKeyType(string $type)

Set the data type for the primary key.

from  Model
bool
getIncrementing()

Get the value indicating whether the IDs are incrementing.

from  Model
$this
setIncrementing(bool $value)

Set whether IDs are incrementing.

from  Model
mixed
getKey()

Get the value of the model's primary key.

from  Model
mixed
getQueueableId()

Get the queueable identity for the entity.

from  Model
array
getQueueableRelations()

Get the queueable relationships for the entity.

from  Model
string|null
getQueueableConnection()

Get the queueable connection for the entity.

from  Model
mixed
getRouteKey()

Get the value of the model's route key.

from  Model
string
getRouteKeyName()

Get the route key for the model.

from  Model
Model|null
resolveRouteBinding(mixed $value, string|null $field = null)

Retrieve the model for a bound value.

from  Model
Model|null
resolveSoftDeletableRouteBinding(mixed $value, string|null $field = null)

Retrieve the model for a bound value.

from  Model
Model|null
resolveChildRouteBinding(string $childType, mixed $value, string|null $field)

Retrieve the child model for a bound value.

from  Model
Model|null
resolveSoftDeletableChildRouteBinding(string $childType, mixed $value, string|null $field)

Retrieve the child model for a bound value.

from  Model
resolveChildRouteBindingQuery($childType, $value, $field)

No description

from  Model
string
childRouteBindingRelationshipName(string $childType)

Retrieve the child route model binding relationship name for the given child type.

from  Model
Builder
resolveRouteBindingQuery(Model|Builder|Relation $query, mixed $value, string|null $field = null)

Retrieve the model for a bound value.

from  Model
string
getForeignKey()

Get the default foreign key name for the model.

from  Model
int
getPerPage()

Get the number of models to return per page.

from  Model
$this
setPerPage(int $perPage)

Set the number of models to return per page.

from  Model
static bool
preventsLazyLoading()

Determine if lazy loading is disabled.

from  Model
static bool
preventsSilentlyDiscardingAttributes()

Determine if discarding guarded attribute fills is disabled.

from  Model
static bool
preventsAccessingMissingAttributes()

Determine if accessing missing attributes is disabled.

from  Model
string
broadcastChannelRoute()

Get the broadcast channel route definition that is associated with the given entity.

from  Model
string
broadcastChannel()

Get the broadcast channel name that is associated with the given entity.

from  Model
mixed
__get(string $key)

Dynamically retrieve attributes on the model.

from  Model
void
__set(string $key, mixed $value)

Dynamically set attributes on the model.

from  Model
bool
offsetExists(mixed $offset)

Determine if the given attribute exists.

from  Model
mixed
offsetGet(mixed $offset)

Get the value for a given offset.

from  Model
void
offsetSet(mixed $offset, mixed $value)

Set the value for a given offset.

from  Model
void
offsetUnset(mixed $offset)

Unset the value for a given offset.

from  Model
bool
__isset(string $key)

Determine if an attribute or relation exists on the model.

from  Model
void
__unset(string $key)

Unset an attribute on the model.

from  Model
mixed
__call(string $method, array $parameters)

Handle dynamic method calls into the model.

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

Handle dynamic static method calls into the model.

from  Model
string
__toString()

Convert the model to its string representation.

from  Model
$this
escapeWhenCastingToString(bool $escape = true)

Indicate that the object's string representation should be escaped when __toString is invoked.

from  Model
array
__sleep()

Prepare the object for serialization.

from  Model
void
__wakeup()

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

from  Model
string
getAuthIdentifierName()

Get the name of the unique identifier for the user.

from  Authenticatable
mixed
getAuthIdentifier()

Get the unique identifier for the user.

from  Authenticatable
mixed
getAuthIdentifierForBroadcasting()

Get the unique broadcast identifier for the user.

from  Authenticatable
string
getAuthPasswordName()

Get the name of the password attribute for the user.

from  Authenticatable
string
getAuthPassword()

Get the password for the user.

from  Authenticatable
string|null
getRememberToken()

Get the token value for the "remember me" session.

from  Authenticatable
void
setRememberToken(string $value)

Set the token value for the "remember me" session.

from  Authenticatable
string
getRememberTokenName()

Get the column name for the "remember me" token.

from  Authenticatable
bool
can(iterable|BackedEnum|string $abilities, array|mixed $arguments = [])

Determine if the entity has the given abilities.

from  Authorizable
bool
canAny(iterable|BackedEnum|string $abilities, array|mixed $arguments = [])

Determine if the entity has any of the given abilities.

from  Authorizable
bool
cant(iterable|BackedEnum|string $abilities, array|mixed $arguments = [])

Determine if the entity does not have the given abilities.

from  Authorizable
bool
cannot(iterable|BackedEnum|string $abilities, array|mixed $arguments = [])

Determine if the entity does not have the given abilities.

from  Authorizable
string
getEmailForPasswordReset()

Get the e-mail address where password reset links are sent.

from  CanResetPassword
void
sendPasswordResetNotification(string $token)

Send the password reset notification.

from  CanResetPassword
bool
hasVerifiedEmail()

Determine if the user has verified their email address.

from  MustVerifyEmail
bool
markEmailAsVerified()

Mark the given user's email as verified.

from  MustVerifyEmail
void
sendEmailVerificationNotification()

Send the email verification notification.

from  MustVerifyEmail
string
getEmailForVerification()

Get the email address that should be used for verification.

from  MustVerifyEmail

Details

in HasAttributes at line 195
protected void initializeHasAttributes()

Initialize the trait.

Return Value

void

in HasAttributes at line 207
array attributesToArray()

Convert the model's attributes to an array.

Return Value

array

in HasAttributes at line 243
protected array addDateAttributesToArray(array $attributes)

Add the date attributes to the attributes array.

Parameters

array $attributes

Return Value

array

in HasAttributes at line 265
protected array addMutatedAttributesToArray(array $attributes, array $mutatedAttributes)

Add the mutated attributes to the attributes array.

Parameters

array $attributes
array $mutatedAttributes

Return Value

array

in HasAttributes at line 293
protected array addCastAttributesToArray(array $attributes, array $mutatedAttributes)

Add the casted attributes to the attributes array.

Parameters

array $attributes
array $mutatedAttributes

Return Value

array

in HasAttributes at line 346
protected array getArrayableAttributes()

Get an attribute array of all arrayable attributes.

Return Value

array

in HasAttributes at line 356
protected array getArrayableAppends()

Get all of the appendable values that are arrayable.

Return Value

array

in HasAttributes at line 372
array relationsToArray()

Get the model's relationships in array form.

Return Value

array

in HasAttributes at line 416
protected array getArrayableRelations()

Get an attribute array of all arrayable relations.

Return Value

array

in HasAttributes at line 427
protected array getArrayableItems(array $values)

Get an attribute array of all arrayable values.

Parameters

array $values

Return Value

array

in HasAttributes at line 446
bool hasAttribute(string $key)

Determine whether an attribute exists on the model.

Parameters

string $key

Return Value

bool

in HasAttributes at line 465
mixed getAttribute(string $key)

Get an attribute from the model.

Parameters

string $key

Return Value

mixed

in HasAttributes at line 498
protected null throwMissingAttributeExceptionIfApplicable(string $key)

Either throw a missing attribute exception or return null depending on Eloquent's configuration.

Parameters

string $key

Return Value

null

Exceptions

MissingAttributeException

in HasAttributes at line 519
mixed getAttributeValue(string $key)

Get a plain attribute (not a relationship).

Parameters

string $key

Return Value

mixed

in HasAttributes at line 530
protected mixed getAttributeFromArray(string $key)

Get an attribute from the $attributes array.

Parameters

string $key

Return Value

mixed

in HasAttributes at line 541
mixed getRelationValue(string $key)

Get a relationship.

Parameters

string $key

Return Value

mixed

in HasAttributes at line 570
bool isRelation(string $key)

Determine if the given key is a relationship method on the model.

Parameters

string $key

Return Value

bool

in HasAttributes at line 586
protected mixed handleLazyLoadingViolation(string $key)

Handle a lazy loading violation.

Parameters

string $key

Return Value

mixed

in HasAttributes at line 607
protected mixed getRelationshipFromMethod(string $method)

Get a relationship value from a method.

Parameters

string $method

Return Value

mixed

Exceptions

LogicException

in HasAttributes at line 634
bool hasGetMutator(string $key)

Determine if a get mutator exists for an attribute.

Parameters

string $key

Return Value

bool

in HasAttributes at line 645
bool hasAttributeMutator(string $key)

Determine if a "Attribute" return type marked mutator exists for an attribute.

Parameters

string $key

Return Value

bool

in HasAttributes at line 668
bool hasAttributeGetMutator(string $key)

Determine if a "Attribute" return type marked get mutator exists for an attribute.

Parameters

string $key

Return Value

bool

in HasAttributes at line 687
bool hasAnyGetMutator(string $key)

Determine if any get mutator exists for an attribute.

Parameters

string $key

Return Value

bool

in HasAttributes at line 699
protected mixed mutateAttribute(string $key, mixed $value)

Get the value of an attribute using its mutator.

Parameters

string $key
mixed $value

Return Value

mixed

in HasAttributes at line 711
protected mixed mutateAttributeMarkedAttribute(string $key, mixed $value)

Get the value of an "Attribute" return type marked attribute using its mutator.

Parameters

string $key
mixed $value

Return Value

mixed

in HasAttributes at line 739
protected mixed mutateAttributeForArray(string $key, mixed $value)

Get the value of an attribute using its mutator for array conversion.

Parameters

string $key
mixed $value

Return Value

mixed

in HasAttributes at line 763
$this mergeCasts(array $casts)

Merge new casts with existing casts on the model.

Parameters

array $casts

Return Value

$this

in HasAttributes at line 778
protected array ensureCastsAreStringValues(array $casts)

Ensure that the given casts are strings.

Parameters

array $casts

Return Value

array

in HasAttributes at line 805
protected mixed castAttribute(string $key, mixed $value)

Cast an attribute to a native PHP type.

Parameters

string $key
mixed $value

Return Value

mixed

in HasAttributes at line 877
protected mixed getClassCastableAttributeValue(string $key, mixed $value)

Cast the given attribute using a custom cast class.

Parameters

string $key
mixed $value

Return Value

mixed

in HasAttributes at line 909
protected mixed getEnumCastableAttributeValue(string $key, mixed $value)

Cast the given attribute to an enum.

Parameters

string $key
mixed $value

Return Value

mixed

in HasAttributes at line 930
protected string getCastType(string $key)

Get the type of cast for a model attribute.

Parameters

string $key

Return Value

string

in HasAttributes at line 961
protected mixed deviateClassCastableAttribute(string $method, string $key, mixed $value)

Increment or decrement the given attribute using the custom cast class.

Parameters

string $method
string $key
mixed $value

Return Value

mixed

in HasAttributes at line 975
protected mixed serializeClassCastableAttribute(string $key, mixed $value)

Serialize the given attribute using the custom cast class.

Parameters

string $key
mixed $value

Return Value

mixed

in HasAttributes at line 988
protected bool isCustomDateTimeCast(string $cast)

Determine if the cast type is a custom date time cast.

Parameters

string $cast

Return Value

bool

in HasAttributes at line 1000
protected bool isImmutableCustomDateTimeCast(string $cast)

Determine if the cast type is an immutable custom date time cast.

Parameters

string $cast

Return Value

bool

in HasAttributes at line 1012
protected bool isDecimalCast(string $cast)

Determine if the cast type is a decimal cast.

Parameters

string $cast

Return Value

bool

in HasAttributes at line 1024
mixed setAttribute(string $key, mixed $value)

Set a given attribute on the model.

Parameters

string $key
mixed $value

Return Value

mixed

in HasAttributes at line 1084
bool hasSetMutator(string $key)

Determine if a set mutator exists for an attribute.

Parameters

string $key

Return Value

bool

in HasAttributes at line 1095
bool hasAttributeSetMutator(string $key)

Determine if an "Attribute" return type marked set mutator exists for an attribute.

Parameters

string $key

Return Value

bool

in HasAttributes at line 1122
protected mixed setMutatedAttributeValue(string $key, mixed $value)

Set the value of an attribute using its mutator.

Parameters

string $key
mixed $value

Return Value

mixed

in HasAttributes at line 1134
protected mixed setAttributeMarkedMutatedAttributeValue(string $key, mixed $value)

Set the value of a "Attribute" return type marked attribute using its mutator.

Parameters

string $key
mixed $value

Return Value

mixed

in HasAttributes at line 1164
protected bool isDateAttribute(string $key)

Determine if the given attribute is a date or date castable.

Parameters

string $key

Return Value

bool

in HasAttributes at line 1177
$this fillJsonAttribute(string $key, mixed $value)

Set a given JSON attribute on the model.

Parameters

string $key
mixed $value

Return Value

$this

in HasAttributes at line 1203
protected void setClassCastableAttribute(string $key, mixed $value)

Set the value of a class castable attribute.

Parameters

string $key
mixed $value

Return Value

void

in HasAttributes at line 1230
protected void setEnumCastableAttribute(string $key, UnitEnum|string|int|null $value)

Set the value of an enum castable attribute.

Parameters

string $key
UnitEnum|string|int|null $value

Return Value

void

in HasAttributes at line 1252
protected UnitEnum|BackedEnum getEnumCaseFromValue(string $enumClass, string|int $value)

Get an enum case instance from a given class and value.

Parameters

string $enumClass
string|int $value

Return Value

UnitEnum|BackedEnum

in HasAttributes at line 1266
protected string|int getStorableEnumValue(string $expectedEnum, UnitEnum|BackedEnum $value)

Get the storable value from the given enum.

Parameters

string $expectedEnum
UnitEnum|BackedEnum $value

Return Value

string|int

in HasAttributes at line 1283
protected $this getArrayAttributeWithValue(string $path, string $key, mixed $value)

Get an array attribute with the given key and value set.

Parameters

string $path
string $key
mixed $value

Return Value

$this

in HasAttributes at line 1296
protected array getArrayAttributeByKey(string $key)

Get an array attribute or return an empty array if it is not set.

Parameters

string $key

Return Value

array

in HasAttributes at line 1316
protected string castAttributeAsJson(string $key, mixed $value)

Cast the given attribute to JSON.

Parameters

string $key
mixed $value

Return Value

string

in HasAttributes at line 1335
protected int getJsonCastFlags(string $key)

Get the JSON casting flags for the given attribute.

Parameters

string $key

Return Value

int

in HasAttributes at line 1353
protected string asJson(mixed $value, int $flags = 0)

Encode the given value as JSON.

Parameters

mixed $value
int $flags

Return Value

string

in HasAttributes at line 1365
mixed fromJson(string|null $value, bool $asObject = false)

Decode the given JSON back into an array or object.

Parameters

string|null $value
bool $asObject

Return Value

mixed

in HasAttributes at line 1380
mixed fromEncryptedString(string $value)

Decrypt the given encrypted string.

Parameters

string $value

Return Value

mixed

in HasAttributes at line 1392
protected string castAttributeAsEncryptedString(string $key, mixed $value)

Cast the given attribute to an encrypted string.

Parameters

string $key
mixed $value

Return Value

string

in HasAttributes at line 1403
static void encryptUsing(Encrypter|null $encrypter)

Set the encrypter instance that will be used to encrypt attributes.

Parameters

Encrypter|null $encrypter

Return Value

void

in HasAttributes at line 1413
static protected Encrypter currentEncrypter()

Get the current encrypter being used by the model.

Return Value

Encrypter

in HasAttributes at line 1425
protected string castAttributeAsHashedString(string $key, mixed $value)

Cast the given attribute to a hashed string.

Parameters

string $key
mixed $value

Return Value

string

in HasAttributes at line 1449
mixed fromFloat(mixed $value)

Decode the given float.

Parameters

mixed $value

Return Value

mixed

in HasAttributes at line 1466
protected string asDecimal(float|string $value, int $decimals)

Return a decimal as string.

Parameters

float|string $value
int $decimals

Return Value

string

in HasAttributes at line 1481
protected Carbon asDate(mixed $value)

Return a timestamp as DateTime object with time set to 00:00:00.

Parameters

mixed $value

Return Value

Carbon

in HasAttributes at line 1492
protected Carbon asDateTime(mixed $value)

Return a timestamp as DateTime object.

Parameters

mixed $value

Return Value

Carbon

in HasAttributes at line 1544
protected bool isStandardDateFormat(string $value)

Determine if the given value is a standard date format.

Parameters

string $value

Return Value

bool

in HasAttributes at line 1555
string|null fromDateTime(mixed $value)

Convert a DateTime to a storable string.

Parameters

mixed $value

Return Value

string|null

in HasAttributes at line 1568
protected int asTimestamp(mixed $value)

Return a timestamp as unix timestamp.

Parameters

mixed $value

Return Value

int

in HasAttributes at line 1579
protected string serializeDate(DateTimeInterface $date)

Prepare a date for array / JSON serialization.

Parameters

DateTimeInterface $date

Return Value

string

in HasAttributes at line 1591
array getDates()

Get the attributes that should be converted to dates.

Return Value

array

in HasAttributes at line 1604
string getDateFormat()

Get the format for database stored dates.

Return Value

string

in HasAttributes at line 1615
$this setDateFormat(string $format)

Set the date format used by the model.

Parameters

string $format

Return Value

$this

in HasAttributes at line 1629
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

in HasAttributes at line 1643
array getCasts()

Get the attributes that should be cast.

Return Value

array

in HasAttributes at line 1657
protected array<string,string> casts()

Get the attributes that should be cast.

Return Value

array<string,string>

in HasAttributes at line 1668
protected bool isDateCastable(string $key)

Determine whether a value is Date / DateTime castable for inbound manipulation.

Parameters

string $key

Return Value

bool

in HasAttributes at line 1679
protected bool isDateCastableWithCustomFormat(string $key)

Determine whether a value is Date / DateTime custom-castable for inbound manipulation.

Parameters

string $key

Return Value

bool

in HasAttributes at line 1690
protected bool isJsonCastable(string $key)

Determine whether a value is JSON castable for inbound manipulation.

Parameters

string $key

Return Value

bool

in HasAttributes at line 1701
protected bool isEncryptedCastable(string $key)

Determine whether a value is an encrypted castable for inbound manipulation.

Parameters

string $key

Return Value

bool

in HasAttributes at line 1714
protected bool isClassCastable(string $key)

Determine if the given key is cast using a custom class.

Parameters

string $key

Return Value

bool

Exceptions

InvalidCastException

in HasAttributes at line 1741
protected bool isEnumCastable(string $key)

Determine if the given key is cast using an enum.

Parameters

string $key

Return Value

bool

in HasAttributes at line 1766
protected bool isClassDeviable(string $key)

Determine if the key is deviable using a custom class.

Parameters

string $key

Return Value

bool

Exceptions

InvalidCastException

in HasAttributes at line 1785
protected bool isClassSerializable(string $key)

Determine if the key is serializable using a custom class.

Parameters

string $key

Return Value

bool

Exceptions

InvalidCastException

in HasAttributes at line 1798
protected mixed resolveCasterClass(string $key)

Resolve the custom caster class for a given key.

Parameters

string $key

Return Value

mixed

in HasAttributes at line 1828
protected string parseCasterClass(string $class)

Parse the given caster class, removing any arguments.

Parameters

string $class

Return Value

string

in HasAttributes at line 1840
protected void mergeAttributesFromCachedCasts()

Merge the cast class and attribute cast attributes back into the model.

Return Value

void

in HasAttributes at line 1851
protected void mergeAttributesFromClassCasts()

Merge the cast class attributes back into the model.

Return Value

void

in HasAttributes at line 1870
protected void mergeAttributesFromAttributeCasts()

Merge the cast class attributes back into the model.

Return Value

void

in HasAttributes at line 1899
protected array normalizeCastClassResponse(string $key, mixed $value)

Normalize the response from a custom class caster.

Parameters

string $key
mixed $value

Return Value

array

in HasAttributes at line 1909
array<string,mixed> getAttributes()

Get all of the current attributes on the model.

Return Value

array<string,mixed>

in HasAttributes at line 1921
protected array getAttributesForInsert()

Get all of the current attributes on the model for an insert operation.

Return Value

array

in HasAttributes at line 1933
$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

in HasAttributes at line 1954
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

in HasAttributes at line 1968
protected mixed|array getOriginalWithoutRewindingModel(string|null $key = null, mixed $default = null)

Get the model's original attribute values.

Parameters

string|null $key
mixed $default

Return Value

mixed|array

in HasAttributes at line 1988
mixed|array getRawOriginal(string|null $key = null, mixed $default = null)

Get the model's raw original attribute values.

Parameters

string|null $key
mixed $default

Return Value

mixed|array

in HasAttributes at line 1999
array only(array|mixed $attributes)

Get a subset of the model's attributes.

Parameters

array|mixed $attributes

Return Value

array

in HasAttributes at line 2016
array except(array|mixed $attributes)

Get all attributes except the given ones.

Parameters

array|mixed $attributes

Return Value

array

in HasAttributes at line 2036
$this syncOriginal()

Sync the original attributes with the current.

Return Value

$this

in HasAttributes at line 2049
$this syncOriginalAttribute(string $attribute)

Sync a single original attribute with its current value.

Parameters

string $attribute

Return Value

$this

in HasAttributes at line 2060
$this syncOriginalAttributes(array|string $attributes)

Sync multiple original attribute with their current values.

Parameters

array|string $attributes

Return Value

$this

in HasAttributes at line 2078
$this syncChanges()

Sync the changed attributes.

Return Value

$this

in HasAttributes at line 2091
bool isDirty(array|string|null $attributes = null)

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

Parameters

array|string|null $attributes

Return Value

bool

in HasAttributes at line 2104
bool isClean(array|string|null $attributes = null)

Determine if the model or all the given attribute(s) have remained the same.

Parameters

array|string|null $attributes

Return Value

bool

in HasAttributes at line 2114
$this discardChanges()

Discard attribute changes and reset the attributes to their original state.

Return Value

$this

in HasAttributes at line 2127
bool wasChanged(array|string|null $attributes = null)

Determine if the model or any of the given attribute(s) were changed when the model was last saved.

Parameters

array|string|null $attributes

Return Value

bool

in HasAttributes at line 2141
protected bool hasChanges(array $changes, array|string|null $attributes = null)

Determine if any of the given attributes were changed when the model was last saved.

Parameters

array $changes
array|string|null $attributes

Return Value

bool

in HasAttributes at line 2167
array getDirty()

Get the attributes that have been changed since the last sync.

Return Value

array

in HasAttributes at line 2185
protected array getDirtyForUpdate()

Get the attributes that have been changed since the last sync for an update operation.

Return Value

array

in HasAttributes at line 2195
array getChanges()

Get the attributes that were changed when the model was last saved.

Return Value

array

in HasAttributes at line 2206
bool originalIsEquivalent(string $key)

Determine if the new and old values for a given key are equivalent.

Parameters

string $key

Return Value

bool

in HasAttributes at line 2259
protected mixed transformModelValue(string $key, mixed $value)

Transform a raw model value using mutators, casts, etc.

Parameters

string $key
mixed $value

Return Value

mixed

in HasAttributes at line 2301
$this append(array|string $attributes)

Append attributes to query when building a query.

Parameters

array|string $attributes

Return Value

$this

in HasAttributes at line 2315
array getAppends()

Get the accessors that are being appended to model arrays.

Return Value

array

in HasAttributes at line 2326
$this setAppends(array $appends)

Set the accessors to append to model arrays.

Parameters

array $appends

Return Value

$this

in HasAttributes at line 2339
bool hasAppended(string $attribute)

Return whether the accessor attribute has been appended.

Parameters

string $attribute

Return Value

bool

in HasAttributes at line 2349
array getMutatedAttributes()

Get the mutated attributes for a given instance.

Return Value

array

in HasAttributes at line 2364
static void cacheMutatedAttributes(object|string $classOrInstance)

Extract and cache all the mutated attributes of a class.

Parameters

object|string $classOrInstance

Return Value

void

in HasAttributes at line 2386
static protected array getMutatorMethods(mixed $class)

Get all of the attribute mutator methods.

Parameters

mixed $class

Return Value

array

in HasAttributes at line 2399
static protected array getAttributeMarkedMutatorMethods(mixed $class)

Get all of the "Attribute" return typed attribute mutator methods.

Parameters

mixed $class

Return Value

array

in HasEvents at line 39
static void bootHasEvents()

Boot the has event trait for a model.

Return Value

void

in HasEvents at line 49
static array resolveObserveAttributes()

Resolve the observe class names from the attributes.

Return Value

array

in HasEvents at line 74
static void observe(object|array|string $classes)

Register observers with the model.

Parameters

object|array|string $classes

Return Value

void

Exceptions

RuntimeException

in HasEvents at line 91
protected void registerObserver(object|string $class)

Register a single observer with the model.

Parameters

object|string $class

Return Value

void

Exceptions

RuntimeException

in HasEvents at line 131
array getObservableEvents()

Get the observable event names.

Return Value

array

in HasEvents at line 149
$this setObservableEvents(array $observables)

Set the observable event names.

Parameters

array $observables

Return Value

$this

in HasEvents at line 162
void addObservableEvents(array|mixed $observables)

Add an observable event name.

Parameters

array|mixed $observables

Return Value

void

in HasEvents at line 175
void removeObservableEvents(array|mixed $observables)

Remove an observable event name.

Parameters

array|mixed $observables

Return Value

void

in HasEvents at line 189
static protected void registerModelEvent(string $event, QueuedClosure|callable|array|class-string $callback)

Register a model event with the dispatcher.

Parameters

string $event
QueuedClosure|callable|array|class-string $callback

Return Value

void

in HasEvents at line 205
protected mixed fireModelEvent(string $event, bool $halt = true)

Fire the given event for the model.

Parameters

string $event
bool $halt

Return Value

mixed

in HasEvents at line 236
protected mixed|null fireCustomModelEvent(string $event, string $method)

Fire a custom model event for the given event.

Parameters

string $event
string $method

Return Value

mixed|null

in HasEvents at line 255
protected mixed filterModelEventResults(mixed $result)

Filter the model event results.

Parameters

mixed $result

Return Value

mixed

in HasEvents at line 272
static void retrieved(QueuedClosure|callable|array|class-string $callback)

Register a retrieved model event with the dispatcher.

Parameters

QueuedClosure|callable|array|class-string $callback

Return Value

void

in HasEvents at line 283
static void saving(QueuedClosure|callable|array|class-string $callback)

Register a saving model event with the dispatcher.

Parameters

QueuedClosure|callable|array|class-string $callback

Return Value

void

in HasEvents at line 294
static void saved(QueuedClosure|callable|array|class-string $callback)

Register a saved model event with the dispatcher.

Parameters

QueuedClosure|callable|array|class-string $callback

Return Value

void

in HasEvents at line 305
static void updating(QueuedClosure|callable|array|class-string $callback)

Register an updating model event with the dispatcher.

Parameters

QueuedClosure|callable|array|class-string $callback

Return Value

void

in HasEvents at line 316
static void updated(QueuedClosure|callable|array|class-string $callback)

Register an updated model event with the dispatcher.

Parameters

QueuedClosure|callable|array|class-string $callback

Return Value

void

in HasEvents at line 327
static void creating(QueuedClosure|callable|array|class-string $callback)

Register a creating model event with the dispatcher.

Parameters

QueuedClosure|callable|array|class-string $callback

Return Value

void

in HasEvents at line 338
static void created(QueuedClosure|callable|array|class-string $callback)

Register a created model event with the dispatcher.

Parameters

QueuedClosure|callable|array|class-string $callback

Return Value

void

in HasEvents at line 349
static void replicating(QueuedClosure|callable|array|class-string $callback)

Register a replicating model event with the dispatcher.

Parameters

QueuedClosure|callable|array|class-string $callback

Return Value

void

in HasEvents at line 360
static void deleting(QueuedClosure|callable|array|class-string $callback)

Register a deleting model event with the dispatcher.

Parameters

QueuedClosure|callable|array|class-string $callback

Return Value

void

in HasEvents at line 371
static void deleted(QueuedClosure|callable|array|class-string $callback)

Register a deleted model event with the dispatcher.

Parameters

QueuedClosure|callable|array|class-string $callback

Return Value

void

in HasEvents at line 381
static void flushEventListeners()

Remove all the event listeners for the model.

Return Value

void

in HasEvents at line 403
array dispatchesEvents()

Get the event map for the model.

Return Value

array

in HasEvents at line 413
static Dispatcher|null getEventDispatcher()

Get the event dispatcher instance.

Return Value

Dispatcher|null

in HasEvents at line 424
static void setEventDispatcher(Dispatcher $dispatcher)

Set the event dispatcher instance.

Parameters

Dispatcher $dispatcher

Return Value

void

in HasEvents at line 434
static void unsetEventDispatcher()

Unset the event dispatcher for models.

Return Value

void

in HasEvents at line 445
static mixed withoutEvents(callable $callback)

Execute a callback without firing any model events for any model type.

Parameters

callable $callback

Return Value

mixed

in HasGlobalScopes at line 20
static void bootHasGlobalScopes()

Boot the has global scopes trait for a model.

Return Value

void

in HasGlobalScopes at line 30
static array resolveGlobalScopeAttributes()

Resolve the global scope class names from the attributes.

Return Value

array

in HasGlobalScopes at line 49
static mixed addGlobalScope($scope, $implementation = null)

Register a new global scope on the model.

Parameters

$scope
$implementation

Return Value

mixed

Exceptions

InvalidArgumentException

in HasGlobalScopes at line 70
static void addGlobalScopes(array $scopes)

Register multiple global scopes on the model.

Parameters

array $scopes

Return Value

void

in HasGlobalScopes at line 87
static bool hasGlobalScope(Scope|string $scope)

Determine if a model has a global scope.

Parameters

Scope|string $scope

Return Value

bool

in HasGlobalScopes at line 98
static getGlobalScope(Scope|string $scope)

Get a global scope registered with the model.

Parameters

Scope|string $scope

in HasGlobalScopes at line 114
static array getAllGlobalScopes()

Get all of the global scopes that are currently registered.

Return Value

array

in HasGlobalScopes at line 125
static void setAllGlobalScopes(array $scopes)

Set the current global scopes.

Parameters

array $scopes

Return Value

void

in HasGlobalScopes at line 135
array getGlobalScopes()

Get the global scopes for this class instance.

Return Value

array

in HasRelationships at line 67
Closure|null relationResolver(TRelatedModel> $class, string $key)

Get the dynamic relation resolver if defined or inherited, or return null.

Parameters

TRelatedModel> $class
string $key

Return Value

Closure|null

in HasRelationships at line 87
static void resolveRelationUsing(string $name, Closure $callback)

Define a dynamic relation resolver.

Parameters

string $name
Closure $callback

Return Value

void

in HasRelationships at line 105
TRelatedModel,$this> hasOne(TRelatedModel> $related, string|null $foreignKey = null, string|null $localKey = null)

Define a one-to-one relationship.

Parameters

TRelatedModel> $related
string|null $foreignKey
string|null $localKey

Return Value

TRelatedModel,$this>

in HasRelationships at line 128
protected TDeclaringModel> newHasOne(Builder $query, Model $parent, string $foreignKey, string $localKey)

Instantiate a new HasOne relationship.

Parameters

Builder $query
Model $parent
string $foreignKey
string $localKey

Return Value

TDeclaringModel>

in HasRelationships at line 147
hasOneThrough($related, $through, $firstKey = null, $secondKey = null, $localKey = null, $secondLocalKey = null)

No description

Parameters

$related
$through
$firstKey
$secondKey
$localKey
$secondLocalKey

in HasRelationships at line 182
protected newHasOneThrough(Builder $query, Model $farParent, Model $throughParent, $firstKey, $secondKey, $localKey, $secondLocalKey)

No description

Parameters

Builder $query
Model $farParent
Model $throughParent
$firstKey
$secondKey
$localKey
$secondLocalKey

in HasRelationships at line 199
TRelatedModel,$this> morphOne(TRelatedModel> $related, string $name, string|null $type = null, string|null $id = null, string|null $localKey = null)

Define a polymorphic one-to-one relationship.

Parameters

TRelatedModel> $related
string $name
string|null $type
string|null $id
string|null $localKey

Return Value

TRelatedModel,$this>

in HasRelationships at line 223
protected TDeclaringModel> newMorphOne(Builder $query, Model $parent, string $type, string $id, string $localKey)

Instantiate a new MorphOne relationship.

Parameters

Builder $query
Model $parent
string $type
string $id
string $localKey

Return Value

TDeclaringModel>

in HasRelationships at line 239
TRelatedModel,$this> belongsTo(TRelatedModel> $related, string|null $foreignKey = null, string|null $ownerKey = null, string|null $relation = null)

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

Parameters

TRelatedModel> $related
string|null $foreignKey
string|null $ownerKey
string|null $relation

Return Value

TRelatedModel,$this>

in HasRelationships at line 280
protected TDeclaringModel> newBelongsTo(Builder $query, Model $child, string $foreignKey, string $ownerKey, string $relation)

Instantiate a new BelongsTo relationship.

Parameters

Builder $query
Model $child
string $foreignKey
string $ownerKey
string $relation

Return Value

TDeclaringModel>

in HasRelationships at line 294
Model,$this> morphTo(string|null $name = null, string|null $type = null, string|null $id = null, string|null $ownerKey = null)

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

Parameters

string|null $name
string|null $type
string|null $id
string|null $ownerKey

Return Value

Model,$this>

in HasRelationships at line 322
protected Model,$this> morphEagerTo(string $name, string $type, string $id, string|null $ownerKey)

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

Parameters

string $name
string $type
string $id
string|null $ownerKey

Return Value

Model,$this>

in HasRelationships at line 339
protected Model,$this> morphInstanceTo(string $target, string $name, string $type, string $id, string|null $ownerKey)

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

Parameters

string $target
string $name
string $type
string $id
string|null $ownerKey

Return Value

Model,$this>

in HasRelationships at line 364
protected TDeclaringModel> newMorphTo(Builder $query, Model $parent, string $foreignKey, string|null $ownerKey, string $type, string $relation)

Instantiate a new MorphTo relationship.

Parameters

Builder $query
Model $parent
string $foreignKey
string|null $ownerKey
string $type
string $relation

Return Value

TDeclaringModel>

in HasRelationships at line 375
static string getActualClassNameForMorph(string $class)

Retrieve the actual class name for a given morph class.

Parameters

string $class

Return Value

string

in HasRelationships at line 385
protected string guessBelongsToRelation()

Guess the "belongs to" relationship name.

Return Value

string

in HasRelationships at line 408
through($relationship)

Create a pending has-many-through or has-one-through relationship.

Parameters

$relationship

in HasRelationships at line 427
TRelatedModel,$this> hasMany(TRelatedModel> $related, string|null $foreignKey = null, string|null $localKey = null)

Define a one-to-many relationship.

Parameters

TRelatedModel> $related
string|null $foreignKey
string|null $localKey

Return Value

TRelatedModel,$this>

in HasRelationships at line 452
protected TDeclaringModel> newHasMany(Builder $query, Model $parent, string $foreignKey, string $localKey)

Instantiate a new HasMany relationship.

Parameters

Builder $query
Model $parent
string $foreignKey
string $localKey

Return Value

TDeclaringModel>

in HasRelationships at line 471
hasManyThrough($related, $through, $firstKey = null, $secondKey = null, $localKey = null, $secondLocalKey = null)

No description

Parameters

$related
$through
$firstKey
$secondKey
$localKey
$secondLocalKey

in HasRelationships at line 506
protected newHasManyThrough(Builder $query, Model $farParent, Model $throughParent, $firstKey, $secondKey, $localKey, $secondLocalKey)

No description

Parameters

Builder $query
Model $farParent
Model $throughParent
$firstKey
$secondKey
$localKey
$secondLocalKey

in HasRelationships at line 523
TRelatedModel,$this> morphMany(TRelatedModel> $related, string $name, string|null $type = null, string|null $id = null, string|null $localKey = null)

Define a polymorphic one-to-many relationship.

Parameters

TRelatedModel> $related
string $name
string|null $type
string|null $id
string|null $localKey

Return Value

TRelatedModel,$this>

in HasRelationships at line 550
protected TDeclaringModel> newMorphMany(Builder $query, Model $parent, string $type, string $id, string $localKey)

Instantiate a new MorphMany relationship.

Parameters

Builder $query
Model $parent
string $type
string $id
string $localKey

Return Value

TDeclaringModel>

in HasRelationships at line 569
belongsToMany($related, $table = null, $foreignPivotKey = null, $relatedPivotKey = null, $parentKey = null, $relatedKey = null, $relation = null)

No description

Parameters

$related
$table
$foreignPivotKey
$relatedPivotKey
$parentKey
$relatedKey
$relation

in HasRelationships at line 629
protected newBelongsToMany(Builder $query, Model $parent, $table, $foreignPivotKey, $relatedPivotKey, $parentKey, $relatedKey, $relationName = null)

No description

Parameters

Builder $query
Model $parent
$table
$foreignPivotKey
$relatedPivotKey
$parentKey
$relatedKey
$relationName

in HasRelationships at line 658
TRelatedModel,$this> morphToMany(TRelatedModel> $related, string $name, string|null $table = null, string|null $foreignPivotKey = null, string|null $relatedPivotKey = null, string|null $parentKey = null, string|null $relatedKey = null, string|null $relation = null, bool $inverse = false)

Define a polymorphic many-to-many relationship.

Parameters

TRelatedModel> $related
string $name
string|null $table
string|null $foreignPivotKey
string|null $relatedPivotKey
string|null $parentKey
string|null $relatedKey
string|null $relation
bool $inverse

Return Value

TRelatedModel,$this>

in HasRelationships at line 723
protected TDeclaringModel> newMorphToMany(Builder $query, Model $parent, string $name, string $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string|null $relationName = null, bool $inverse = false)

Instantiate a new MorphToMany relationship.

Parameters

Builder $query
Model $parent
string $name
string $table
string $foreignPivotKey
string $relatedPivotKey
string $parentKey
string $relatedKey
string|null $relationName
bool $inverse

Return Value

TDeclaringModel>

in HasRelationships at line 764
TRelatedModel,$this> morphedByMany(TRelatedModel> $related, string $name, string|null $table = null, string|null $foreignPivotKey = null, string|null $relatedPivotKey = null, string|null $parentKey = null, string|null $relatedKey = null, string|null $relation = null)

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

Parameters

TRelatedModel> $related
string $name
string|null $table
string|null $foreignPivotKey
string|null $relatedPivotKey
string|null $parentKey
string|null $relatedKey
string|null $relation

Return Value

TRelatedModel,$this>

in HasRelationships at line 799
protected string|null guessBelongsToManyRelation()

Get the relationship name of the belongsToMany relationship.

Return Value

string|null

in HasRelationships at line 818
string joiningTable(string $related, Model|null $instance = null)

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

Parameters

string $related
Model|null $instance

Return Value

string

in HasRelationships at line 843
string joiningTableSegment()

Get this model's half of the intermediate table name for belongsToMany relationships.

Return Value

string

in HasRelationships at line 854
bool touches(string $relation)

Determine if the model touches a given relation.

Parameters

string $relation

Return Value

bool

in HasRelationships at line 864
void touchOwners()

Touch the owning relations of the model.

Return Value

void

in HasRelationships at line 889
protected array getMorphs(string $name, string $type, string $id)

Get the polymorphic relationship columns.

Parameters

string $name
string $type
string $id

Return Value

array

in HasRelationships at line 899
string getMorphClass()

Get the class name for polymorphic relations.

Return Value

string

in HasRelationships at line 926
protected TRelatedModel newRelatedInstance(TRelatedModel> $class)

Create a new model instance for a related model.

Parameters

TRelatedModel> $class

Return Value

TRelatedModel

in HasRelationships at line 943
protected TRelatedModel newRelatedThroughInstance(TRelatedModel> $class)

Create a new model instance for a related "through" model.

Parameters

TRelatedModel> $class

Return Value

TRelatedModel

in HasRelationships at line 953
array getRelations()

Get all the loaded relations for the instance.

Return Value

array

in HasRelationships at line 964
mixed getRelation(string $relation)

Get a specified relationship.

Parameters

string $relation

Return Value

mixed

in HasRelationships at line 975
bool relationLoaded(string $key)

Determine if the given relation is loaded.

Parameters

string $key

Return Value

bool

in HasRelationships at line 987
$this setRelation(string $relation, mixed $value)

Set the given relationship on the model.

Parameters

string $relation
mixed $value

Return Value

$this

in HasRelationships at line 1000
$this unsetRelation(string $relation)

Unset a loaded relationship.

Parameters

string $relation

Return Value

$this

in HasRelationships at line 1013
$this setRelations(array $relations)

Set the entire relations array on the model.

Parameters

array $relations

Return Value

$this

in HasRelationships at line 1025
$this withoutRelations()

Duplicate the instance and unset all the loaded relations.

Return Value

$this

in HasRelationships at line 1037
$this unsetRelations()

Unset all the loaded relations for the instance.

Return Value

$this

in HasRelationships at line 1049
array getTouchedRelations()

Get the relationships that are touched on save.

Return Value

array

in HasRelationships at line 1060
$this setTouchedRelations(array $touches)

Set the relationships that are touched on save.

Parameters

array $touches

Return Value

$this

in HasTimestamps at line 29
bool touch(string|null $attribute = null)

Update the model's update timestamp.

Parameters

string|null $attribute

Return Value

bool

in HasTimestamps at line 52
bool touchQuietly(string|null $attribute = null)

Update the model's update timestamp without raising any events.

Parameters

string|null $attribute

Return Value

bool

in HasTimestamps at line 62
$this updateTimestamps()

Update the creation and update timestamps.

Return Value

$this

in HasTimestamps at line 87
$this setCreatedAt(mixed $value)

Set the value of the "created at" attribute.

Parameters

mixed $value

Return Value

$this

in HasTimestamps at line 100
$this setUpdatedAt(mixed $value)

Set the value of the "updated at" attribute.

Parameters

mixed $value

Return Value

$this

in HasTimestamps at line 112
Carbon freshTimestamp()

Get a fresh timestamp for the model.

Return Value

Carbon

in HasTimestamps at line 122
string freshTimestampString()

Get a fresh timestamp for the model.

Return Value

string

in HasTimestamps at line 132
bool usesTimestamps()

Determine if the model uses timestamps.

Return Value

bool

in HasTimestamps at line 142
string|null getCreatedAtColumn()

Get the name of the "created at" column.

Return Value

string|null

in HasTimestamps at line 152
string|null getUpdatedAtColumn()

Get the name of the "updated at" column.

Return Value

string|null

in HasTimestamps at line 162
string|null getQualifiedCreatedAtColumn()

Get the fully qualified "created at" column.

Return Value

string|null

in HasTimestamps at line 174
string|null getQualifiedUpdatedAtColumn()

Get the fully qualified "updated at" column.

Return Value

string|null

in HasTimestamps at line 187
static mixed withoutTimestamps(callable $callback)

Disable timestamps for the current class during the given callback scope.

Parameters

callable $callback

Return Value

mixed

in HasTimestamps at line 199
static mixed withoutTimestampsOn(array $models, callable $callback)

Disable timestamps for the given model classes during the given callback scope.

Parameters

array $models
callable $callback

Return Value

mixed

in HasTimestamps at line 220
static bool isIgnoringTimestamps(string|null $class = null)

Determine if the given model is ignoring timestamps / touches.

Parameters

string|null $class

Return Value

bool

in HasUniqueIds at line 19
bool usesUniqueIds()

Determine if the model uses unique ids.

Return Value

bool

in HasUniqueIds at line 29
void setUniqueIds()

Generate unique keys for the model.

Return Value

void

in HasUniqueIds at line 43
string newUniqueId()

Generate a new key for the model.

Return Value

string

in HasUniqueIds at line 53
array uniqueIds()

Get the columns that should receive a unique identifier.

Return Value

array

in HidesAttributes at line 26
string[] getHidden()

Get the hidden attributes for the model.

Return Value

string[]

in HidesAttributes at line 37
$this setHidden(array $hidden)

Set the hidden attributes for the model.

Parameters

array $hidden

Return Value

$this

in HidesAttributes at line 49
string[] getVisible()

Get the visible attributes for the model.

Return Value

string[]

in HidesAttributes at line 60
$this setVisible(array $visible)

Set the visible attributes for the model.

Parameters

array $visible

Return Value

$this

in HidesAttributes at line 73
$this makeVisible(string[]|string|null $attributes)

Make the given, typically hidden, attributes visible.

Parameters

string[]|string|null $attributes

Return Value

$this

in HidesAttributes at line 93
$this makeVisibleIf(bool|Closure $condition, string[]|string|null $attributes)

Make the given, typically hidden, attributes visible if the given truth test passes.

Parameters

bool|Closure $condition
string[]|string|null $attributes

Return Value

$this

in HidesAttributes at line 104
$this makeHidden(string[]|string|null $attributes)

Make the given, typically visible, attributes hidden.

Parameters

string[]|string|null $attributes

Return Value

$this

in HidesAttributes at line 120
$this makeHiddenIf(bool|Closure $condition, string[]|string|null $attributes)

Make the given, typically visible, attributes hidden if the given truth test passes.

Parameters

bool|Closure $condition
string[]|string|null $attributes

Return Value

$this

in GuardsAttributes at line 40
string[] getFillable()

Get the fillable attributes for the model.

Return Value

string[]

in GuardsAttributes at line 51
$this fillable(array $fillable)

Set the fillable attributes for the model.

Parameters

array $fillable

Return Value

$this

in GuardsAttributes at line 64
$this mergeFillable(array $fillable)

Merge new fillable attributes with existing fillable attributes on the model.

Parameters

array $fillable

Return Value

$this

in GuardsAttributes at line 76
string[] getGuarded()

Get the guarded attributes for the model.

Return Value

string[]

in GuardsAttributes at line 89
$this guard(array $guarded)

Set the guarded attributes for the model.

Parameters

array $guarded

Return Value

$this

in GuardsAttributes at line 102
$this mergeGuarded(array $guarded)

Merge new guarded attributes with existing guarded attributes on the model.

Parameters

array $guarded

Return Value

$this

in GuardsAttributes at line 115
static void unguard(bool $state = true)

Disable all mass assignable restrictions.

Parameters

bool $state

Return Value

void

in GuardsAttributes at line 125
static void reguard()

Enable the mass assignment restrictions.

Return Value

void

in GuardsAttributes at line 135
static bool isUnguarded()

Determine if the current state is "unguarded".

Return Value

bool

in GuardsAttributes at line 146
static mixed unguarded(callable $callback)

Run the given callable while being unguarded.

Parameters

callable $callback

Return Value

mixed

in GuardsAttributes at line 167
bool isFillable(string $key)

Determine if the given attribute may be mass assigned.

Parameters

string $key

Return Value

bool

in GuardsAttributes at line 198
bool isGuarded(string $key)

Determine if the given key is guarded.

Parameters

string $key

Return Value

bool

in GuardsAttributes at line 215
protected bool isGuardableColumn(string $key)

Determine if the given column is a valid, guardable column.

Parameters

string $key

Return Value

bool

in GuardsAttributes at line 241
bool totallyGuarded()

Determine if the model is totally guarded.

Return Value

bool

in GuardsAttributes at line 252
protected array fillableFromArray(array $attributes)

Get the fillable attributes of a given array.

Parameters

array $attributes

Return Value

array

in PreventsCircularRecursion at line 25
protected mixed withoutRecursion(callable $callback, mixed $default = null)

Prevent a method from being called multiple times on the same object within the same call stack.

Parameters

callable $callback
mixed $default

Return Value

mixed

in PreventsCircularRecursion at line 58
static protected clearRecursiveCallValue(object $object, string $hash)

Remove an entry from the recursion cache for an object.

Parameters

object $object
string $hash

in PreventsCircularRecursion at line 73
static protected array getRecursiveCallStack(object $object)

Get the stack of methods being called recursively for the current object.

Parameters

object $object

Return Value

array

in PreventsCircularRecursion at line 85
static protected WeakMap getRecursionCache()

Get the current recursion cache being used by the model.

Return Value

WeakMap

in PreventsCircularRecursion at line 98
static protected mixed setRecursiveCallValue(object $object, string $hash, mixed $value)

Set a value in the recursion cache for the given object and method.

Parameters

object $object
string $hash
mixed $value

Return Value

mixed

in ForwardsCalls at line 20
protected mixed forwardCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object.

Parameters

mixed $object
string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in ForwardsCalls at line 50
protected mixed forwardDecoratedCallTo(mixed $object, string $method, array $parameters)

Forward a method call to the given object, returning $this if the forwarded call returned itself.

Parameters

mixed $object
string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in ForwardsCalls at line 65
static protected never throwBadMethodCallException(string $method)

Throw a bad method call exception for the given method.

Parameters

string $method

Return Value

never

Exceptions

BadMethodCallException

in HasCollection at line 26
TCollection newCollection(array $models = [])

Create a new Eloquent Collection instance.

Parameters

array $models

Return Value

TCollection

in HasCollection at line 38
TCollection>|null resolveCollectionFromAttribute()

Resolve the collection class name from the CollectedBy attribute.

Return Value

TCollection>|null

in Model at line 254
__construct(array $attributes = [])

Create a new Eloquent model instance.

Parameters

array $attributes

in Model at line 270
protected void bootIfNotBooted()

Check if the model needs to be booted and if so, do it.

Return Value

void

in Model at line 290
static protected void booting()

Perform any actions required before the model boots.

Return Value

void

in Model at line 300
static protected void boot()

Bootstrap the model and its traits.

Return Value

void

in Model at line 310
static protected void bootTraits()

Boot all of the bootable traits on the model.

Return Value

void

in Model at line 342
protected void initializeTraits()

Initialize any initializable traits on the model.

Return Value

void

in Model at line 354
static protected void booted()

Perform any actions required after the model boots.

Return Value

void

in Model at line 364
static void clearBootedModels()

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

Return Value

void

in Model at line 377
static void withoutTouching(callable $callback)

Disables relationship model touching for the current class during given callback scope.

Parameters

callable $callback

Return Value

void

in Model at line 389
static void withoutTouchingOn(array $models, callable $callback)

Disables relationship model touching for the given model classes during given callback scope.

Parameters

array $models
callable $callback

Return Value

void

in Model at line 406
static bool isIgnoringTouch(string|null $class = null)

Determine if the given model is ignoring touches.

Parameters

string|null $class

Return Value

bool

in Model at line 429
static void shouldBeStrict(bool $shouldBeStrict = true)

Indicate that models should prevent lazy loading, silently discarding attributes, and accessing missing attributes.

Parameters

bool $shouldBeStrict

Return Value

void

in Model at line 442
static void preventLazyLoading(bool $value = true)

Prevent model relationships from being lazy loaded.

Parameters

bool $value

Return Value

void

in Model at line 453
static void handleLazyLoadingViolationUsing(callable|null $callback)

Register a callback that is responsible for handling lazy loading violations.

Parameters

callable|null $callback

Return Value

void

in Model at line 464
static void preventSilentlyDiscardingAttributes(bool $value = true)

Prevent non-fillable attributes from being silently discarded.

Parameters

bool $value

Return Value

void

in Model at line 475
static void handleDiscardedAttributeViolationUsing(callable|null $callback)

Register a callback that is responsible for handling discarded attribute violations.

Parameters

callable|null $callback

Return Value

void

in Model at line 486
static void preventAccessingMissingAttributes(bool $value = true)

Prevent accessing missing attributes on retrieved models.

Parameters

bool $value

Return Value

void

in Model at line 497
static void handleMissingAttributeViolationUsing(callable|null $callback)

Register a callback that is responsible for handling missing attribute violations.

Parameters

callable|null $callback

Return Value

void

in Model at line 508
static mixed withoutBroadcasting(callable $callback)

Execute a callback without broadcasting any model events for all model types.

Parameters

callable $callback

Return Value

mixed

in Model at line 529
$this fill(array $attributes)

Fill the model with an array of attributes.

Parameters

array $attributes

Return Value

$this

Exceptions

MassAssignmentException

in Model at line 577
$this forceFill(array $attributes)

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

Parameters

array $attributes

Return Value

$this

in Model at line 588
string qualifyColumn(string $column)

Qualify the given column name by the model's table.

Parameters

string $column

Return Value

string

in Model at line 603
array qualifyColumns(array $columns)

Qualify the given columns with the model's table.

Parameters

array $columns

Return Value

array

in Model at line 617
Model newInstance(array $attributes = [], bool $exists = false)

Create a new instance of the given model.

Parameters

array $attributes
bool $exists

Return Value

Model

in Model at line 646
Model newFromBuilder(array $attributes = [], string|null $connection = null)

Create a new model instance that is existing.

Parameters

array $attributes
string|null $connection

Return Value

Model

in Model at line 665
static Builder<static> on(string|null $connection = null)

Begin querying the model on a given connection.

Parameters

string|null $connection

Return Value

Builder<static>

in Model at line 682
static Builder<static> onWriteConnection()

Begin querying the model on the write connection.

Return Value

Builder<static>

in Model at line 693
static Collection<int,static> all(array|string $columns = ['*'])

Get all of the models from the database.

Parameters

array|string $columns

Return Value

Collection<int,static>

in Model at line 706
static Builder<static> with(array|string $relations)

Begin querying a model with eager loading.

Parameters

array|string $relations

Return Value

Builder<static>

in Model at line 719
$this load(array|string $relations)

Eager load relations on the model.

Parameters

array|string $relations

Return Value

$this

in Model at line 737
$this loadMorph(string $relation, array $relations)

Eager load relationships on the polymorphic relation of a model.

Parameters

string $relation
array $relations

Return Value

$this

in Model at line 756
$this loadMissing(array|string $relations)

Eager load relations on the model if they are not already eager loaded.

Parameters

array|string $relations

Return Value

$this

in Model at line 773
$this loadAggregate(array|string $relations, string $column, string|null $function = null)

Eager load relation's column aggregations on the model.

Parameters

array|string $relations
string $column
string|null $function

Return Value

$this

in Model at line 786
$this loadCount(array|string $relations)

Eager load relation counts on the model.

Parameters

array|string $relations

Return Value

$this

in Model at line 800
$this loadMax(array|string $relations, string $column)

Eager load relation max column values on the model.

Parameters

array|string $relations
string $column

Return Value

$this

in Model at line 812
$this loadMin(array|string $relations, string $column)

Eager load relation min column values on the model.

Parameters

array|string $relations
string $column

Return Value

$this

in Model at line 824
$this loadSum(array|string $relations, string $column)

Eager load relation's column summations on the model.

Parameters

array|string $relations
string $column

Return Value

$this

in Model at line 836
$this loadAvg(array|string $relations, string $column)

Eager load relation average column values on the model.

Parameters

array|string $relations
string $column

Return Value

$this

in Model at line 847
$this loadExists(array|string $relations)

Eager load related model existence values on the model.

Parameters

array|string $relations

Return Value

$this

in Model at line 861
$this loadMorphAggregate(string $relation, array $relations, string $column, string|null $function = null)

Eager load relationship column aggregation on the polymorphic relation of a model.

Parameters

string $relation
array $relations
string $column
string|null $function

Return Value

$this

in Model at line 881
$this loadMorphCount(string $relation, array $relations)

Eager load relationship counts on the polymorphic relation of a model.

Parameters

string $relation
array $relations

Return Value

$this

in Model at line 894
$this loadMorphMax(string $relation, array $relations, string $column)

Eager load relationship max column values on the polymorphic relation of a model.

Parameters

string $relation
array $relations
string $column

Return Value

$this

in Model at line 907
$this loadMorphMin(string $relation, array $relations, string $column)

Eager load relationship min column values on the polymorphic relation of a model.

Parameters

string $relation
array $relations
string $column

Return Value

$this

in Model at line 920
$this loadMorphSum(string $relation, array $relations, string $column)

Eager load relationship column summations on the polymorphic relation of a model.

Parameters

string $relation
array $relations
string $column

Return Value

$this

in Model at line 933
$this loadMorphAvg(string $relation, array $relations, string $column)

Eager load relationship average column values on the polymorphic relation of a model.

Parameters

string $relation
array $relations
string $column

Return Value

$this

in Model at line 946
protected int increment(string $column, float|int $amount = 1, array $extra = [])

Increment a column's value by a given amount.

Parameters

string $column
float|int $amount
array $extra

Return Value

int

in Model at line 959
protected int decrement(string $column, float|int $amount = 1, array $extra = [])

Decrement a column's value by a given amount.

Parameters

string $column
float|int $amount
array $extra

Return Value

int

in Model at line 973
protected int incrementOrDecrement(string $column, float|int $amount, array $extra, string $method)

Run the increment or decrement method on the model.

Parameters

string $column
float|int $amount
array $extra
string $method

Return Value

int

in Model at line 1009
bool update(array $attributes = [], array $options = [])

Update the model in the database.

Parameters

array $attributes
array $options

Return Value

bool

in Model at line 1027
bool updateOrFail(array $attributes = [], array $options = [])

Update the model in the database within a transaction.

Parameters

array $attributes
array $options

Return Value

bool

Exceptions

Throwable

in Model at line 1043
bool updateQuietly(array $attributes = [], array $options = [])

Update the model in the database without raising any events.

Parameters

array $attributes
array $options

Return Value

bool

in Model at line 1060
protected int incrementQuietly(string $column, float|int $amount = 1, array $extra = [])

Increment a column's value by a given amount without raising any events.

Parameters

string $column
float|int $amount
array $extra

Return Value

int

in Model at line 1075
protected int decrementQuietly(string $column, float|int $amount = 1, array $extra = [])

Decrement a column's value by a given amount without raising any events.

Parameters

string $column
float|int $amount
array $extra

Return Value

int

in Model at line 1087
bool push()

Save the model and all of its relationships.

Return Value

bool

in Model at line 1118
bool pushQuietly()

Save the model and all of its relationships without raising any events to the parent model.

Return Value

bool

in Model at line 1129
bool saveQuietly(array $options = [])

Save the model to the database without raising any events.

Parameters

array $options

Return Value

bool

in Model at line 1140
bool save(array $options = [])

Save the model to the database.

Parameters

array $options

Return Value

bool

in Model at line 1191
bool saveOrFail(array $options = [])

Save the model to the database within a transaction.

Parameters

array $options

Return Value

bool

Exceptions

Throwable

in Model at line 1202
protected void finishSave(array $options)

Perform any actions that are necessary after the model is saved.

Parameters

array $options

Return Value

void

in Model at line 1219
protected bool performUpdate(Builder $query)

Perform a model update operation.

Parameters

Builder $query

Return Value

bool

in Model at line 1257
protected Builder<static> setKeysForSelectQuery(Builder<static> $query)

Set the keys for a select query.

Parameters

Builder<static> $query

Return Value

Builder<static>

in Model at line 1269
protected mixed getKeyForSelectQuery()

Get the primary key value for a select query.

Return Value

mixed

in Model at line 1280
protected Builder<static> setKeysForSaveQuery(Builder<static> $query)

Set the keys for a save update query.

Parameters

Builder<static> $query

Return Value

Builder<static>

in Model at line 1292
protected mixed getKeyForSaveQuery()

Get the primary key value for a save query.

Return Value

mixed

in Model at line 1303
protected bool performInsert(Builder $query)

Perform a model insert operation.

Parameters

Builder $query

Return Value

bool

in Model at line 1359
protected void insertAndSetId(Builder $query, array $attributes)

Insert the given attributes and set the ID on the model.

Parameters

Builder $query
array $attributes

Return Value

void

in Model at line 1372
static int destroy(Collection|array|int|string $ids)

Destroy the models for the given IDs.

Parameters

Collection|array|int|string $ids

Return Value

int

in Model at line 1411
bool|null delete()

Delete the model from the database.

Return Value

bool|null

Exceptions

LogicException

in Model at line 1450
bool deleteQuietly()

Delete the model from the database without raising any events.

Return Value

bool

in Model at line 1462
bool|null deleteOrFail()

Delete the model from the database within a transaction.

Return Value

bool|null

Exceptions

Throwable

in Model at line 1478
bool|null forceDelete()

Force a hard delete on a soft deleted model.

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

Return Value

bool|null

in Model at line 1491
static bool|null forceDestroy(Collection|array|int|string $ids)

Force a hard destroy on a soft deleted model.

This method protects developers from running forceDestroy when the trait is missing.

Parameters

Collection|array|int|string $ids

Return Value

bool|null

in Model at line 1501
protected void performDeleteOnModel()

Perform the actual delete query on this model instance.

Return Value

void

in Model at line 1513
static Builder<static> query()

Begin querying the model.

Return Value

Builder<static>

in Model at line 1523
Builder<static> newQuery()

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

Return Value

Builder<static>

in Model at line 1533
Builder<static> newModelQuery()

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

Return Value

Builder<static>

in Model at line 1545
Builder<static> newQueryWithoutRelationships()

Get a new query builder with no relationships loaded.

Return Value

Builder<static>

in Model at line 1556
Builder<static> registerGlobalScopes(Builder<static> $builder)

Register the global scopes for this builder instance.

Parameters

Builder<static> $builder

Return Value

Builder<static>

in Model at line 1570
Builder<static> newQueryWithoutScopes()

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

Return Value

Builder<static>

in Model at line 1583
Builder<static> newQueryWithoutScope(Scope|string $scope)

Get a new query instance without a given scope.

Parameters

Scope|string $scope

Return Value

Builder<static>

in Model at line 1594
Builder<static> newQueryForRestoration(array|int $ids)

Get a new query to restore one or more models by their queueable IDs.

Parameters

array|int $ids

Return Value

Builder<static>

in Model at line 1605
newEloquentBuilder(Builder $query)

Create a new Eloquent query builder for the model.

Parameters

Builder $query

in Model at line 1615
protected Builder newBaseQueryBuilder()

Get a new query builder instance for the connection.

Return Value

Builder

in Model at line 1630
Pivot newPivot(Model $parent, array $attributes, string $table, bool $exists, string|null $using = null)

Create a new pivot model instance.

Parameters

Model $parent
array $attributes
string $table
bool $exists
string|null $using

Return Value

Pivot

in Model at line 1642
bool hasNamedScope(string $scope)

Determine if the model has a given scope.

Parameters

string $scope

Return Value

bool

in Model at line 1655
mixed callNamedScope(string $scope, array $parameters = [])

Apply the given named scope if possible.

Parameters

string $scope
array $parameters

Return Value

mixed

in Model at line 1670
static protected bool isScopeMethodWithAttribute(string $method)

Determine if the given method has a scope attribute.

Parameters

string $method

Return Value

bool

in Model at line 1682
toArray()

Convert the model instance to an array.

in Model at line 1698
string toJson(int $options = 0)

Convert the model instance to JSON.

Parameters

int $options

Return Value

string

Exceptions

JsonEncodingException

in Model at line 1714
mixed jsonSerialize()

Convert the object into something JSON serializable.

Return Value

mixed

in Model at line 1725
Model|null fresh(array|string $with = [])

Reload a fresh model instance from the database.

Parameters

array|string $with

Return Value

Model|null

in Model at line 1742
$this refresh()

Reload the current model instance with fresh attributes from the database.

Return Value

$this

in Model at line 1771
Model replicate(array|null $except = null)

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

Parameters

array|null $except

Return Value

Model

in Model at line 1800
Model replicateQuietly(array|null $except = null)

Clone the model into a new, non-existing instance without raising any events.

Parameters

array|null $except

Return Value

Model

in Model at line 1811
bool is(Model|null $model)

Determine if two models have the same ID and belong to the same table.

Parameters

Model|null $model

Return Value

bool

in Model at line 1825
bool isNot(Model|null $model)

Determine if two models are not the same.

Parameters

Model|null $model

Return Value

bool

in Model at line 1835
Connection getConnection()

Get the database connection for the model.

Return Value

Connection

in Model at line 1845
string|null getConnectionName()

Get the current connection name for the model.

Return Value

string|null

in Model at line 1856
$this setConnection(string|null $name)

Set the connection associated with the model.

Parameters

string|null $name

Return Value

$this

in Model at line 1869
static Connection resolveConnection(string|null $connection = null)

Resolve a connection instance.

Parameters

string|null $connection

Return Value

Connection

in Model at line 1879
static ConnectionResolverInterface|null getConnectionResolver()

Get the connection resolver instance.

Return Value

ConnectionResolverInterface|null

in Model at line 1890
static void setConnectionResolver(ConnectionResolverInterface $resolver)

Set the connection resolver instance.

Parameters

ConnectionResolverInterface $resolver

Return Value

void

in Model at line 1900
static void unsetConnectionResolver()

Unset the connection resolver for models.

Return Value

void

in Model at line 1910
string getTable()

Get the table associated with the model.

Return Value

string

in Model at line 1921
$this setTable(string $table)

Set the table associated with the model.

Parameters

string $table

Return Value

$this

in Model at line 1933
string getKeyName()

Get the primary key for the model.

Return Value

string

in Model at line 1944
$this setKeyName(string $key)

Set the primary key for the model.

Parameters

string $key

Return Value

$this

in Model at line 1956
string getQualifiedKeyName()

Get the table qualified key name.

Return Value

string

in Model at line 1966
string getKeyType()

Get the auto-incrementing key type.

Return Value

string

in Model at line 1977
$this setKeyType(string $type)

Set the data type for the primary key.

Parameters

string $type

Return Value

$this

in Model at line 1989
bool getIncrementing()

Get the value indicating whether the IDs are incrementing.

Return Value

bool

in Model at line 2000
$this setIncrementing(bool $value)

Set whether IDs are incrementing.

Parameters

bool $value

Return Value

$this

in Model at line 2012
mixed getKey()

Get the value of the model's primary key.

Return Value

mixed

in Model at line 2022
mixed getQueueableId()

Get the queueable identity for the entity.

Return Value

mixed

in Model at line 2032
array getQueueableRelations()

Get the queueable relationships for the entity.

Return Value

array

in Model at line 2066
string|null getQueueableConnection()

Get the queueable connection for the entity.

Return Value

string|null

in Model at line 2076
mixed getRouteKey()

Get the value of the model's route key.

Return Value

mixed

in Model at line 2086
string getRouteKeyName()

Get the route key for the model.

Return Value

string

in Model at line 2098
Model|null resolveRouteBinding(mixed $value, string|null $field = null)

Retrieve the model for a bound value.

Parameters

mixed $value
string|null $field

Return Value

Model|null

in Model at line 2110
Model|null resolveSoftDeletableRouteBinding(mixed $value, string|null $field = null)

Retrieve the model for a bound value.

Parameters

mixed $value
string|null $field

Return Value

Model|null

in Model at line 2123
Model|null resolveChildRouteBinding(string $childType, mixed $value, string|null $field)

Retrieve the child model for a bound value.

Parameters

string $childType
mixed $value
string|null $field

Return Value

Model|null

in Model at line 2136
Model|null resolveSoftDeletableChildRouteBinding(string $childType, mixed $value, string|null $field)

Retrieve the child model for a bound value.

Parameters

string $childType
mixed $value
string|null $field

Return Value

Model|null

in Model at line 2149
protected resolveChildRouteBindingQuery($childType, $value, $field)

No description

Parameters

$childType
$value
$field

in Model at line 2171
protected string childRouteBindingRelationshipName(string $childType)

Retrieve the child route model binding relationship name for the given child type.

Parameters

string $childType

Return Value

string

in Model at line 2184
Builder resolveRouteBindingQuery(Model|Builder|Relation $query, mixed $value, string|null $field = null)

Retrieve the model for a bound value.

Parameters

Model|Builder|Relation $query
mixed $value
string|null $field

Return Value

Builder

in Model at line 2194
string getForeignKey()

Get the default foreign key name for the model.

Return Value

string

in Model at line 2204
int getPerPage()

Get the number of models to return per page.

Return Value

int

in Model at line 2215
$this setPerPage(int $perPage)

Set the number of models to return per page.

Parameters

int $perPage

Return Value

$this

in Model at line 2227
static bool preventsLazyLoading()

Determine if lazy loading is disabled.

Return Value

bool

in Model at line 2237
static bool preventsSilentlyDiscardingAttributes()

Determine if discarding guarded attribute fills is disabled.

Return Value

bool

in Model at line 2247
static bool preventsAccessingMissingAttributes()

Determine if accessing missing attributes is disabled.

Return Value

bool

in Model at line 2257
string broadcastChannelRoute()

Get the broadcast channel route definition that is associated with the given entity.

Return Value

string

in Model at line 2267
string broadcastChannel()

Get the broadcast channel name that is associated with the given entity.

Return Value

string

in Model at line 2278
mixed __get(string $key)

Dynamically retrieve attributes on the model.

Parameters

string $key

Return Value

mixed

in Model at line 2290
void __set(string $key, mixed $value)

Dynamically set attributes on the model.

Parameters

string $key
mixed $value

Return Value

void

in Model at line 2301
bool offsetExists(mixed $offset)

Determine if the given attribute exists.

Parameters

mixed $offset

Return Value

bool

in Model at line 2320
mixed offsetGet(mixed $offset)

Get the value for a given offset.

Parameters

mixed $offset

Return Value

mixed

in Model at line 2332
void offsetSet(mixed $offset, mixed $value)

Set the value for a given offset.

Parameters

mixed $offset
mixed $value

Return Value

void

in Model at line 2343
void offsetUnset(mixed $offset)

Unset the value for a given offset.

Parameters

mixed $offset

Return Value

void

in Model at line 2354
bool __isset(string $key)

Determine if an attribute or relation exists on the model.

Parameters

string $key

Return Value

bool

in Model at line 2365
void __unset(string $key)

Unset an attribute on the model.

Parameters

string $key

Return Value

void

in Model at line 2377
mixed __call(string $method, array $parameters)

Handle dynamic method calls into the model.

Parameters

string $method
array $parameters

Return Value

mixed

in Model at line 2402
static mixed __callStatic(string $method, array $parameters)

Handle dynamic static method calls into the model.

Parameters

string $method
array $parameters

Return Value

mixed

in Model at line 2416
string __toString()

Convert the model to its string representation.

Return Value

string

in Model at line 2429
$this escapeWhenCastingToString(bool $escape = true)

Indicate that the object's string representation should be escaped when __toString is invoked.

Parameters

bool $escape

Return Value

$this

in Model at line 2441
array __sleep()

Prepare the object for serialization.

Return Value

array

in Model at line 2456
void __wakeup()

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

Return Value

void

in Authenticatable at line 26
string getAuthIdentifierName()

Get the name of the unique identifier for the user.

Return Value

string

in Authenticatable at line 36
mixed getAuthIdentifier()

Get the unique identifier for the user.

Return Value

mixed

in Authenticatable at line 46
mixed getAuthIdentifierForBroadcasting()

Get the unique broadcast identifier for the user.

Return Value

mixed

in Authenticatable at line 56
string getAuthPasswordName()

Get the name of the password attribute for the user.

Return Value

string

in Authenticatable at line 66
string getAuthPassword()

Get the password for the user.

Return Value

string

in Authenticatable at line 76
string|null getRememberToken()

Get the token value for the "remember me" session.

Return Value

string|null

in Authenticatable at line 89
void setRememberToken(string $value)

Set the token value for the "remember me" session.

Parameters

string $value

Return Value

void

in Authenticatable at line 101
string getRememberTokenName()

Get the column name for the "remember me" token.

Return Value

string

in Authorizable at line 16
bool can(iterable|BackedEnum|string $abilities, array|mixed $arguments = [])

Determine if the entity has the given abilities.

Parameters

iterable|BackedEnum|string $abilities
array|mixed $arguments

Return Value

bool

in Authorizable at line 28
bool canAny(iterable|BackedEnum|string $abilities, array|mixed $arguments = [])

Determine if the entity has any of the given abilities.

Parameters

iterable|BackedEnum|string $abilities
array|mixed $arguments

Return Value

bool

in Authorizable at line 40
bool cant(iterable|BackedEnum|string $abilities, array|mixed $arguments = [])

Determine if the entity does not have the given abilities.

Parameters

iterable|BackedEnum|string $abilities
array|mixed $arguments

Return Value

bool

in Authorizable at line 52
bool cannot(iterable|BackedEnum|string $abilities, array|mixed $arguments = [])

Determine if the entity does not have the given abilities.

Parameters

iterable|BackedEnum|string $abilities
array|mixed $arguments

Return Value

bool

in CanResetPassword at line 14
string getEmailForPasswordReset()

Get the e-mail address where password reset links are sent.

Return Value

string

in CanResetPassword at line 25
void sendPasswordResetNotification(string $token)

Send the password reset notification.

Parameters

string $token

Return Value

void

in MustVerifyEmail at line 14
bool hasVerifiedEmail()

Determine if the user has verified their email address.

Return Value

bool

in MustVerifyEmail at line 24
bool markEmailAsVerified()

Mark the given user's email as verified.

Return Value

bool

in MustVerifyEmail at line 36
void sendEmailVerificationNotification()

Send the email verification notification.

Return Value

void

in MustVerifyEmail at line 46
string getEmailForVerification()

Get the email address that should be used for verification.

Return Value

string