1. class
  2. Hypervel
  3. \
  4. Database
  5. \
  6. Eloquent
  7. \
  8. Relations
  9. \
  10. Pivot

Pivot

class Pivot extends Model

Traits

AsPivot
HasAttributes
HasEvents
HasGlobalScopes
HasRelationships
HasTimestamps
HasUniqueIds
HidesAttributes
GuardsAttributes
PreventsCircularRecursion
TransformsToResource

Provides the ability to transform a model to a JSON resource.

ForwardsCalls
HasCollection

Constants

protected IGNORE_ON_TOUCH_CONTEXT_KEY

Context key for storing models that should ignore touch.
protected BROADCASTING_CONTEXT_KEY

Context key for storing whether broadcasting is enabled.
protected EVENTS_DISABLED_CONTEXT_KEY

Context key for storing whether events are disabled.
protected MISSING_ATTRIBUTE_ACCESS_SUPPRESSED_CONTEXT_KEY

Context key for suppressing missing attribute violations during existence checks.
UNGUARDED_CONTEXT_KEY

Context key for storing whether mass assignment is unguarded.
CREATED_AT

The name of the "created at" column.
UPDATED_AT

The name of the "updated at" column.

Properties

protected array<string, mixed> $attributes

The model's attributes.

 from  HasAttributes
protected array<string, mixed> $original

The model attribute's original state.

 from  HasAttributes
protected array<string, mixed> $changes

The changed model attributes.

 from  HasAttributes
protected array<string, mixed> $previous

The previous state of the changed model attributes.

 from  HasAttributes
protected array<string, string> $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
protected array|null $mergedCastsCache

The cached merged casts array for this instance.

 from  HasAttributes
protected array $castMetadataCache

The cached results of cast metadata predicate methods for this instance.

 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 $casterCache

The cache of the resolved custom caster class instances.

 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<string, class-string> $dispatchesEvents

The event map for the model.

 from  HasEvents
protected string[] $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
protected Closure|null $relationAutoloadCallback

The relationship autoloader callback.

 from  HasRelationships
protected mixed $relationAutoloadContext

The relationship autoloader callback context.

 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
bool $usesUniqueIds

Indicates if the model uses unique ids.

 from  HasUniqueIds
protected array<int, string> $hidden

The attributes that should be hidden for serialization.

 from  HidesAttributes
protected array<int, 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[] $guarded

The attributes that aren't mass assignable.
static protected array<class-string, list<string>> $guardableColumns

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

 from  GuardsAttributes
static protected array<class-string, array{guarded: null|array<int, string>, propertyDefault: array<int, string>}> $guardConfigurations

The resolved guard configuration for each model class.

 from  GuardsAttributes
static protected TCollection>> $resolvedCollectionClasses

The resolved collection class names by model.

 from  HasCollection
protected UnitEnum|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.
protected array<int, string> $with

The relations to eager load on every query.

 from  Model
protected array<int, string> $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
protected bool $modelClassAttributesInitialized

Indicates whether class attribute metadata has initialized this model.

 from  Model
static protected ConnectionResolverInterface|null $resolver

The connection resolver instance.

 from  Model
static protected Dispatcher|null $dispatcher

The event dispatcher instance.

 from  Model
static protected array<class-string<self>, int> $booting

The coroutine currently booting each model.

 from  Model
static protected array<class-string<self>, bool> $booted

The array of booted models.

 from  Model
static protected Closure>> $bootedCallbacks

The callbacks that should be executed after the model has booted.

 from  Model
static protected array<class-string<self>, array<int, string>> $traitInitializers

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

 from  Model
static protected array<class-string<self>, array<int|Closure|Scope>> $globalScopes

The array of global scopes on the model.

 from  Model
static protected bool $modelsShouldPreventLazyLoading

Indicates whether lazy loading should be restricted on all models.

 from  Model
static protected bool $modelsShouldAutomaticallyEagerLoadRelationships

Indicates whether relations should be automatically loaded on all models when they are accessed.

 from  Model
static protected null|LazyLoadingViolationException): mixed $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 null|MassAssignmentException): mixed $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 null|MissingAttributeException): mixed $missingAttributeViolationCallback

The callback that is responsible for handling missing attribute violations.

 from  Model
static protected bool $reportRouteModelBindingExceptions

Indicates if invalid value exceptions during implicit route model binding should be reported.

 from  Model
static protected Builder<mixed>> $builder

The Eloquent query builder class to use for the model.

 from  Model
static protected Collection<mixed, mixed>> $collectionClass

The Eloquent collection class to use for the model.

 from  Model
static protected Builder<static>>|false> $resolvedBuilderClasses

Cache of resolved custom builder classes per model.

 from  Model
static protected array<string, null|object> $classAttributes

Cache of resolved class attributes.

 from  Model
static protected array<string, bool> $classDeclaredAttributes

Cache of whether each class directly declares each class attribute.

 from  Model
static protected array<string, null|class-string> $classPropertyDeclarers

Cache of the nearest class declaring each property.

 from  Model
static protected array<string, bool> $scopeMethodAttributes

Cache of whether methods are attributed local scopes.

 from  Model
static protected array<string, bool> $legacyScopeMethods

Cache of whether methods are callable legacy local scopes.

 from  Model
static protected array<class-string<self>, bool> $isSoftDeletable

Cache of soft deletable models.

 from  Model
static protected array<class-string<self>, bool> $isPrunable

Cache of prunable models.

 from  Model
static protected array<class-string<self>, bool> $isMassPrunable

Cache of mass prunable models.

 from  Model
Model|null $pivotParent

The parent model of the relationship.

 from  AsPivot
Model|null $pivotRelated

The related model of the relationship.

 from  AsPivot
protected string $foreignKey

The name of the foreign key column.

 from  AsPivot
protected string $relatedKey

The name of the "other key" column.

 from  AsPivot
protected null|list<array{string, array<int, mixed>}> $pivotConstraints

The relation-owned predicates that identify this pivot row.

 from  AsPivot

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
mixed
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
HasAttributes
mergeCasts(array $casts)

Merge new casts with existing casts on the model.

from  HasAttributes
void
flushCastCaches()

Flush the per-instance cast metadata caches.

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
compareClassCastableAttribute(string $key, mixed $original, mixed $value)

Compare two values for 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
void
ensureValidDecimalScale(string $cast, string $attribute)

Ensure the decimal cast has a valid scale.

from  HasAttributes
mixed
setAttribute(string|int $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
HasAttributes
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, mixed $value)

Set the value of an enum castable attribute.

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

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

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

Get the storable value from the given enum.

from  HasAttributes
array
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|false
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|null
castAttributeAsHashedString(string $key, mixed $value)

Cast the given attribute to a hashed string.

from  HasAttributes
float
fromFloat(mixed $value)

Decode the given float.

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

Return a decimal as string.

from  HasAttributes
CarbonInterface
asDate(mixed $value)

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

from  HasAttributes
CarbonInterface
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
HasAttributes
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
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
bool
isClassComparable(string $key)

Determine if the key is comparable using a custom class.

from  HasAttributes
mixed
resolveCasterClass(string $key)

Resolve the custom caster class for a given key.

from  HasAttributes
static void
flushCasterCache()

Flush the caster cache for the model.

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
mergeAttributeFromCachedCasts(string $key)

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

from  HasAttributes
void
mergeAttributesFromClassCasts()

Merge the cast class attributes back into the model.

from  HasAttributes
void
mergeAttributeFromClassCasts(string $key)

Merge the cast class attribute back into the model.

from  HasAttributes
void
mergeAttributesFromAttributeCasts()

Merge the cast class attributes back into the model.

from  HasAttributes
void
mergeAttributeFromAttributeCasts(string $key)

Merge the cast class attribute back into the model.

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

Normalize the response from a custom class caster.

from  HasAttributes
array
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
array
prepareBinaryAttributesForDatabase(array $attributes)

Prepare binary-cast attributes for database binding.

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

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

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

Get the model's original attribute values.

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

Get the model's original attribute values.

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

Get the model's raw original attribute values.

from  HasAttributes
array
only(mixed $attributes)

Get a subset of the model's attributes.

from  HasAttributes
array
except(mixed $attributes)

Get all attributes except the given ones.

from  HasAttributes
HasAttributes
syncOriginal()

Sync the original attributes with the current.

from  HasAttributes
HasAttributes
syncOriginalAttribute(string $attribute)

Sync a single original attribute with its current value.

from  HasAttributes
HasAttributes
syncOriginalAttributes(array|string $attributes)

Sync multiple original attribute with their current values.

from  HasAttributes
HasAttributes
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
HasAttributes
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
array
getPrevious()

Get the attributes that were previously original before 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
HasAttributes
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
HasAttributes
setAppends(array $appends)

Set the accessors to append to model arrays.

from  HasAttributes
HasAttributes
mergeAppends(array $appends)

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

from  HasAttributes
bool
hasAppended(string $attribute)

Return whether the accessor attribute has been appended.

from  HasAttributes
HasAttributes
withoutAppends()

Remove all appended properties from the model.

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
HasEvents
setObservableEvents(array $observables)

Set the observable event names.

from  HasEvents
void
addObservableEvents(array|string $observables)

Add an observable event name.

from  HasEvents
void
removeObservableEvents(array|string $observables)

Remove an observable event name.

from  HasEvents
static void
registerModelEvent(string $event, mixed $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
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(mixed $callback)

Register a retrieved model event with the dispatcher.

from  HasEvents
static void
saving(mixed $callback)

Register a saving model event with the dispatcher.

from  HasEvents
static void
saved(mixed $callback)

Register a saved model event with the dispatcher.

from  HasEvents
static void
updating(mixed $callback)

Register an updating model event with the dispatcher.

from  HasEvents
static void
updated(mixed $callback)

Register an updated model event with the dispatcher.

from  HasEvents
static void
creating(mixed $callback)

Register a creating model event with the dispatcher.

from  HasEvents
static void
created(mixed $callback)

Register a created model event with the dispatcher.

from  HasEvents
static void
replicating(mixed $callback)

Register a replicating model event with the dispatcher.

from  HasEvents
static void
deleting(mixed $callback)

Register a deleting model event with the dispatcher.

from  HasEvents
static void
deleted(mixed $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 bool
eventsDisabled()

Determine if model events are currently disabled for this coroutine.

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|Closure|string $scope, Scope|Closure|null $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|int|string $scope)

Determine if a model has a global scope.

from  HasGlobalScopes
static Scope|Closure|null
getGlobalScope(Scope|int|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
void
initializeHasRelationships()

Initialize the HasRelationships trait.

from  HasRelationships
Closure|null
relationResolver(string $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
bool
hasRelationAutoloadCallback()

Determine if a relationship autoloader callback has been defined.

from  HasRelationships
HasRelationships
autoloadRelationsUsing(Closure $callback, mixed $context = null)

Define an automatic relationship autoloader callback for this model and its relations.

from  HasRelationships
bool
attemptToAutoloadRelation(string $key)

Attempt to autoload the given relationship using the autoload callback.

from  HasRelationships
void
invokeRelationAutoloadCallbackFor(string $key, array $tuples)

Invoke the relationship autoloader callback for the given relationships.

from  HasRelationships
void
propagateRelationAutoloadCallbackToRelation(string $key, mixed $models)

Propagate the relationship autoloader callback to the given related models.

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

Define a one-to-one relationship.

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

Instantiate a new HasOne relationship.

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

Define a has-one-through relationship.

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

Instantiate a new HasOneThrough relationship.

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

Define a polymorphic one-to-one relationship.

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

Instantiate a new MorphOne relationship.

from  HasRelationships
BelongsTo
belongsTo(string $related, string|null $foreignKey = null, string|null $ownerKey = null, string|null $relation = null)

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

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

Instantiate a new BelongsTo relationship.

from  HasRelationships
MorphTo
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
MorphTo
morphEagerTo(string $name, string $type, string $id, string|null $ownerKey)

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

from  HasRelationships
MorphTo
morphInstanceTo(string|int $target, string $name, string $type, string $id, string|null $ownerKey)

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

from  HasRelationships
MorphTo
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|int $class)

Retrieve the actual class name for a given morph class.

from  HasRelationships
string
guessBelongsToRelation()

Guess the "belongs to" relationship name.

from  HasRelationships
PendingHasThroughRelationship
through(string|HasOneOrMany $relationship)

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

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

Define a one-to-many relationship.

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

Instantiate a new HasMany relationship.

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

Define a has-many-through relationship.

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

Instantiate a new HasManyThrough relationship.

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

Define a polymorphic one-to-many relationship.

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

Instantiate a new MorphMany relationship.

from  HasRelationships
BelongsToMany
belongsToMany(string $related, 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 many-to-many relationship.

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

Instantiate a new BelongsToMany relationship.

from  HasRelationships
MorphToMany
morphToMany(string $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
MorphToMany
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
MorphToMany
morphedByMany(string $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|null $type, string|null $id)

Get the polymorphic relationship columns.

from  HasRelationships
string
getMorphClass()

Get the class name for polymorphic relations.

from  HasRelationships
Model
newRelatedInstance(string $class)

Create a new model instance for a related model.

from  HasRelationships
Model
newRelatedThroughInstance(string $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
HasRelationships
setRelation(string $relation, mixed $value)

Set the given relationship on the model.

from  HasRelationships
HasRelationships
unsetRelation(string $relation)

Unset a loaded relationship.

from  HasRelationships
HasRelationships
setRelations(array $relations)

Set the entire relations array on the model.

from  HasRelationships
HasRelationships
withRelationshipAutoloading()

Enable relationship autoloading for this model.

from  HasRelationships
HasRelationships
withoutRelations()

Duplicate the instance and unset all the loaded relations.

from  HasRelationships
HasRelationships
withoutRelation(array|string $relations)

Duplicate the instance and unset the given loaded relations.

from  HasRelationships
HasRelationships
unsetRelations()

Unset all the loaded relations for the instance.

from  HasRelationships
array
getTouchedRelations()

Get the relationships that are touched on save.

from  HasRelationships
HasRelationships
setTouchedRelations(array $touches)

Set the relationships that are touched on save.

from  HasRelationships
void
initializeHasTimestamps()

Initialize the HasTimestamps trait.

from  HasTimestamps
bool
touch(array|string|null $attribute = null)

Update the model's update timestamp.

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

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

from  HasTimestamps
HasTimestamps
updateTimestamps()

Update the creation and update timestamps.

from  HasTimestamps
HasTimestamps
setCreatedAt(mixed $value)

Set the value of the "created at" attribute.

from  HasTimestamps
HasTimestamps
setUpdatedAt(mixed $value)

Set the value of the "updated at" attribute.

from  HasTimestamps
CarbonInterface
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|null
newUniqueId()

Generate a new key for the model.

from  HasUniqueIds
array
uniqueIds()

Get the columns that should receive a unique identifier.

from  HasUniqueIds
void
initializeHidesAttributes()

Initialize the HidesAttributes trait.

from  HidesAttributes
array
getHidden()

Get the hidden attributes for the model.

from  HidesAttributes
HidesAttributes
setHidden(array $hidden)

Set the hidden attributes for the model.

from  HidesAttributes
HidesAttributes
mergeHidden(array $hidden)

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

from  HidesAttributes
array
getVisible()

Get the visible attributes for the model.

from  HidesAttributes
HidesAttributes
setVisible(array $visible)

Set the visible attributes for the model.

from  HidesAttributes
HidesAttributes
mergeVisible(array $visible)

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

from  HidesAttributes
HidesAttributes
makeVisible(array|string|null $attributes)

Make the given, typically hidden, attributes visible.

from  HidesAttributes
HidesAttributes
makeVisibleIf(bool|Closure $condition, array|string|null $attributes)

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

from  HidesAttributes
HidesAttributes
makeHidden(array|string|null $attributes)

Make the given, typically visible, attributes hidden.

from  HidesAttributes
HidesAttributes
makeHiddenIf(bool|Closure $condition, array|string|null $attributes)

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

from  HidesAttributes
void
initializeGuardsAttributes()

Initialize the GuardsAttributes trait.

from  GuardsAttributes
static array
guardConfiguration()

Resolve the nearest guard configuration for the model class.

from  GuardsAttributes
static array|null
guardConfigurationFromTraits(array $traits)

Resolve guard configuration declared by traits at one class level.

from  GuardsAttributes
array
getFillable()

Get the fillable attributes for the model.

from  GuardsAttributes
GuardsAttributes
fillable(array $fillable)

Set the fillable attributes for the model.

from  GuardsAttributes
GuardsAttributes
mergeFillable(array $fillable)

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

from  GuardsAttributes
array
getGuarded()

Get the guarded attributes for the model.

from  GuardsAttributes
GuardsAttributes
guard(array $guarded)

Set the guarded attributes for the model.

from  GuardsAttributes
GuardsAttributes
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 void
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
JsonResource
toResource(string|null $resourceClass = null)

Create a new resource object for the given resource.

from  TransformsToResource
JsonResource
guessResource()

Guess the resource class for the model.

from  TransformsToResource
static array
guessResourceName()

Guess the resource class name for the model.

from  TransformsToResource
string|null
resolveResourceFromAttribute(string $class)

Get the resource class from the UseResource attribute.

from  TransformsToResource
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
Collection
newCollection(array $models = [])

Create a new Eloquent Collection instance.

from  HasCollection
string|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
void
initializeModelAttributes()

Initialize the model attributes from class attributes.

from  Model
static void
booted()

Perform any actions required after the model boots.

from  Model
static void
whenBooted(Closure $callback)

Register a closure to be executed after the model has booted.

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
automaticallyEagerLoadRelationships(bool $value = true)

Determine if model relationships should be automatically eager loaded when accessed.

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 void
reportRouteModelBindingExceptions(bool $value = true)

Report invalid value exceptions during implicit route model binding.

from  Model
static mixed
withoutBroadcasting(callable $callback)

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

from  Model
static bool
isBroadcasting()

Determine if broadcasting is currently enabled.

from  Model
Model
fill(array $attributes)

Fill the model with an array of attributes.

from  Model
Model
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|object $attributes = [], UnitEnum|string|null $connection = null)

Create a new model instance that is existing.

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

Begin querying the model on a given connection.

from  Model
static Builder
onWriteConnection()

Begin querying the model on the write connection.

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

Get all of the models from the database.

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

Begin querying a model with eager loading.

from  Model
Model
load(array|string $relations)

Eager load relations on the model.

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

Eager load relationships on the polymorphic relation of a model.

from  Model
Model
loadMissing(array|string $relations)

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

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

Eager load relation's column aggregations on the model.

from  Model
Model
loadCount(array|string $relations)

Eager load relation counts on the model.

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

Eager load relation max column values on the model.

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

Eager load relation min column values on the model.

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

Eager load relation's column summations on the model.

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

Eager load relation average column values on the model.

from  Model
Model
loadExists(array|string $relations)

Eager load related model existence values on the model.

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

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

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

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

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

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

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

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

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

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

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

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

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

Increment a column's value by a given amount.

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

Decrement a column's value by a given amount.

from  Model
int|false
incrementOrDecrement(string $column, mixed $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|false
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|false
decrementQuietly(string $column, float|int $amount = 1, array $extra = [])

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

from  Model
int|false
incrementEach(array $columns, array $extra = [])

Increment each given column's value by the given amounts.

from  Model
int|false
decrementEach(array $columns, array $extra = [])

Decrement each given column's value by the given amounts.

from  Model
int|false
incrementEachQuietly(array $columns, array $extra = [])

Increment each given column's value by the given amounts without raising any events.

from  Model
int|false
decrementEachQuietly(array $columns, array $extra = [])

Decrement each given column's value by the given amounts without raising any events.

from  Model
int|false
incrementOrDecrementEach(array $columns, array $extra, string $method)

Run the incrementEach or decrementEach method on the model.

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
saveOrIgnore(array $options = [], array|string|null $uniqueBy = null)

Save the model to the database, ignoring specific unique constraint conflicts.

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
setKeysForSelectQuery(Builder $query)

Set the keys for a select query.

from  AsPivot
mixed
getKeyForSelectQuery()

Get the primary key value for a select query.

from  Model
Builder
setKeysForSaveQuery(Builder $query)

Set the keys for a save update query.

from  AsPivot
mixed
getKeyForSaveQuery()

Get the primary key value for a save query.

from  Model
bool
performInsert(Builder $query)

Perform a model insert operation.

from  Model
bool
performInsertOrIgnore(Builder $query, array|string|null $uniqueBy)

Perform a model insert operation, ignoring specific unique constraint conflicts.

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|Collection|array|int|string $ids)

Destroy the models for the given IDs.

from  Model
int
delete()

Delete the pivot model record from the database.

from  AsPivot
int|bool|null
deleteQuietly()

Delete the model from the database without raising any events.

from  Model
int|bool|null
deleteOrFail()

Delete the model from the database within a transaction.

from  Model
int|bool|null
forceDelete()

Force a hard delete on a soft deleted model.

from  Model
static int
forceDestroy(Collection|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
query()

Begin querying the model.

from  Model
Builder
newQuery()

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

from  Model
Builder
newModelQuery()

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

from  Model
Builder
newQueryWithoutRelationships()

Get a new query builder with no relationships loaded.

from  Model
Builder
registerGlobalScopes(Builder $builder)

Register the global scopes for this builder instance.

from  Model
Builder
newQueryWithoutScopes()

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

from  Model
Builder
newQueryWithoutScope(Scope|int|string $scope)

Get a new query instance without a given scope.

from  Model
Builder
newQueryForRestoration(array|int|string $ids)

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

from  AsPivot
Builder
newEloquentBuilder(Builder $query)

Create a new Eloquent query builder for the model.

from  Model
string|false
resolveCustomBuilderClass()

Resolve the custom Eloquent builder class from the model attributes.

from  Model
Builder
newBaseQueryBuilder()

Get a new query builder instance for the connection.

from  Model
Model
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
static bool
isLegacyScopeMethod(string $scope)

Determine if the given method is a callable legacy local scope.

from  Model
array
toArray()

Convert the model instance to an array.

from  Model
string
toJson(int $options = 0)

Convert the model instance to JSON.

from  Model
string
toPrettyJson(int $options = 0)

Convert the model instance to pretty print formatted 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
Model
refresh()

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

from  Model
Model
refreshForUpdate()

Reload the current model instance with fresh attributes from the database while locking it for updating.

from  Model
Model
refreshUsingQuery(Builder $query)

Reload the current model instance using the given query.

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
Model
setConnection(UnitEnum|string|null $name)

Set the connection associated with the model.

from  Model
static Connection
resolveConnection(UnitEnum|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
static mixed
resolveClassAttribute(string $attributeClass, string|null $property = null, string|null $class = null)

Resolve an attribute from the model class or its parents.

from  Model
static bool
classDeclaresAttribute(string $attributeClass)

Determine whether a class directly declares an attribute.

from  Model
static string|null
classPropertyDeclarer(string $property)

Resolve the nearest class that declares a property.

from  Model
string
getTable()

Get the table associated with the model.

from  AsPivot
Model
setTable(string $table)

Set the table associated with the model.

from  Model
string
getKeyName()

Get the primary key for the model.

from  Model
Model
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
Model
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
Model
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  AsPivot
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
mixed
resolveRouteBinding(mixed $value, string|null $field = null)

Retrieve the model for a bound value.

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

Retrieve the model for a bound value.

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

Retrieve the child model for a bound value.

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

Retrieve the child model for a bound value.

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

Retrieve the child model query for a bound value.

from  Model
string
childRouteBindingRelationshipName(string $childType)

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

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

Retrieve the model for a bound value.

from  Model
bool
isValidIntegerRouteKey(mixed $value)

Determine if the given value could address a row in an integer key column.

from  Model
never
handleInvalidRouteKey(mixed $value, string $field)

Throw an exception for the given invalid route key.

from  Model
string
getForeignKey()

Get the foreign key column name.

from  AsPivot
int
getPerPage()

Get the number of models to return per page.

from  Model
Model
setPerPage(int $perPage)

Set the number of models to return per page.

from  Model
static bool
isSoftDeletable()

Determine if the model is soft deletable.

from  Model
static bool
isPrunable()

Determine if the model is prunable.

from  Model
static bool
isMassPrunable()

Determine if the model is mass prunable.

from  Model
static bool
preventsLazyLoading()

Determine if lazy loading is disabled.

from  Model
static bool
isAutomaticallyEagerLoadingRelationships()

Determine if relationships are being automatically eager loaded when accessed.

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
static bool
reportsRouteModelBindingExceptions()

Determine if invalid value exceptions during implicit route model binding should be reported.

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
static void
flushGuardableColumns()

Flush cached guardable column metadata.

from  Model
static void
flushState()

Flush all static state.

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
CanBeEscapedWhenCastToString
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
static AsPivot
fromAttributes(Model $parent, array $attributes, string $table, bool $exists = false)

Create a new pivot model instance.

from  AsPivot
static AsPivot
fromRawAttributes(Model $parent, array $attributes, string $table, bool $exists = false)

Create a new pivot model from raw values returned from a query.

from  AsPivot
Builder
getDeleteQuery()

Get the query builder for a delete operation on the pivot.

from  AsPivot
Builder
applyPivotConstraints(Builder $query)

Apply the relation-owned predicates to a pivot identity query.

from  AsPivot
mixed
getPivotKeyForQuery(string $column)

Get a pivot key for a query.

from  AsPivot
string
getRelatedKey()

Get the "related key" column name.

from  AsPivot
string
getOtherKey()

Get the "related key" column name.

from  AsPivot
AsPivot
setPivotKeys(string $foreignKey, string $relatedKey)

Set the key names for the pivot model instance.

from  AsPivot
AsPivot
setPivotConstraints(array $constraints)

Set the relation-owned predicates for the pivot model.

from  AsPivot
AsPivot
setRelatedModel(Model|null $related = null)

Set the related model of the relationship.

from  AsPivot
bool
hasTimestampAttributes(array|null $attributes = null)

Determine if the pivot model or given attributes has timestamp attributes.

from  AsPivot
Builder
newQueryForCollectionRestoration(array $ids)

Get a new query to restore multiple models by their queueable IDs.

from  AsPivot

Details

in HasAttributes at line 213
protected void initializeHasAttributes()

Initialize the trait.

Return Value

void

in HasAttributes at line 242
array attributesToArray()

Convert the model's attributes to an array.

Return Value

array

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

Add the date attributes to the attributes array.

Parameters

array $attributes

Return Value

array

in HasAttributes at line 302
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 331
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 385
protected array getArrayableAttributes()

Get an attribute array of all arrayable attributes.

Return Value

array

in HasAttributes at line 393
protected array getArrayableAppends()

Get all of the appendable values that are arrayable.

Return Value

array

in HasAttributes at line 407
array relationsToArray()

Get the model's relationships in array form.

Return Value

array

in HasAttributes at line 449
protected array getArrayableRelations()

Get an attribute array of all arrayable relations.

Return Value

array

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

Get an attribute array of all arrayable values.

Parameters

array $values

Return Value

array

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

Determine whether an attribute exists on the model.

Parameters

string $key

Return Value

bool

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

Get an attribute from the model.

Parameters

string $key

Return Value

mixed

in HasAttributes at line 519
protected mixed throwMissingAttributeExceptionIfApplicable(string $key)

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

Parameters

string $key

Return Value

mixed

Exceptions

MissingAttributeException

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

Get a plain attribute (not a relationship).

Parameters

string $key

Return Value

mixed

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

Get an attribute from the $attributes array.

Parameters

string $key

Return Value

mixed

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

Get a relationship.

Parameters

string $key

Return Value

mixed

in HasAttributes at line 588
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 603
protected mixed handleLazyLoadingViolation(string $key)

Handle a lazy loading violation.

Parameters

string $key

Return Value

mixed

Exceptions

LazyLoadingViolationException

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

Get a relationship value from a method.

Parameters

string $method

Return Value

mixed

Exceptions

LogicException

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

Determine if a get mutator exists for an attribute.

Parameters

string $key

Return Value

bool

in HasAttributes at line 664
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 684
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 700
bool hasAnyGetMutator(string $key)

Determine if any get mutator exists for an attribute.

Parameters

string $key

Return Value

bool

in HasAttributes at line 708
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 718
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 744
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 765
HasAttributes mergeCasts(array $casts)

Merge new casts with existing casts on the model.

Parameters

array $casts

Return Value

HasAttributes

in HasAttributes at line 779
protected void flushCastCaches()

Flush the per-instance cast metadata caches.

Return Value

void

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

Ensure that the given casts are strings.

Parameters

array $casts

Return Value

array

Exceptions

InvalidArgumentException

in HasAttributes at line 822
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 890
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 917
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 935
protected string getCastType(string $key)

Get the type of cast for a model attribute.

Parameters

string $key

Return Value

string

in HasAttributes at line 969
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 982
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 995
protected bool compareClassCastableAttribute(string $key, mixed $original, mixed $value)

Compare two values for the given attribute using the custom cast class.

Parameters

string $key
mixed $original
mixed $value

Return Value

bool

in HasAttributes at line 1008
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 1017
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 1026
protected bool isDecimalCast(string $cast)

Determine if the cast type is a decimal cast.

Parameters

string $cast

Return Value

bool

in HasAttributes at line 1034
protected void ensureValidDecimalScale(string $cast, string $attribute)

Ensure the decimal cast has a valid scale.

Parameters

string $cast
string $attribute

Return Value

void

in HasAttributes at line 1048
mixed setAttribute(string|int $key, mixed $value)

Set a given attribute on the model.

Parameters

string|int $key
mixed $value

Return Value

mixed

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

Determine if a set mutator exists for an attribute.

Parameters

string $key

Return Value

bool

in HasAttributes at line 1125
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 1148
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 1158
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 1188
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 1197
HasAttributes fillJsonAttribute(string $key, mixed $value)

Set a given JSON attribute on the model.

Parameters

string $key
mixed $value

Return Value

HasAttributes

in HasAttributes at line 1221
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 1249
protected void setEnumCastableAttribute(string $key, mixed $value)

Set the value of an enum castable attribute.

Parameters

string $key
mixed $value

Return Value

void

in HasAttributes at line 1270
protected mixed 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

mixed

in HasAttributes at line 1284
protected string|int getStorableEnumValue(string $expectedEnum, mixed $value)

Get the storable value from the given enum.

Parameters

string $expectedEnum
mixed $value

Return Value

string|int

Exceptions

ValueError

in HasAttributes at line 1296
protected array 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

array

in HasAttributes at line 1306
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 1324
protected string castAttributeAsJson(string $key, mixed $value)

Cast the given attribute to JSON.

Parameters

string $key
mixed $value

Return Value

string

Exceptions

JsonEncodingException

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

Get the JSON casting flags for the given attribute.

Parameters

string $key

Return Value

int

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

Encode the given value as JSON.

Parameters

mixed $value
int $flags

Return Value

string|false

in HasAttributes at line 1364
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 1376
mixed fromEncryptedString(string $value)

Decrypt the given encrypted string.

Parameters

string $value

Return Value

mixed

in HasAttributes at line 1384
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 1395
static void encryptUsing(Encrypter|null $encrypter)

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

Boot-only. The encrypter persists in a static property for the worker lifetime and is used by every encrypted attribute across all coroutines.

Parameters

Encrypter|null $encrypter

Return Value

void

in HasAttributes at line 1403
static Encrypter currentEncrypter()

Get the current encrypter being used by the model.

Return Value

Encrypter

in HasAttributes at line 1413
protected string|null castAttributeAsHashedString(string $key, mixed $value)

Cast the given attribute to a hashed string.

Parameters

string $key
mixed $value

Return Value

string|null

Exceptions

RuntimeException

in HasAttributes at line 1434
float fromFloat(mixed $value)

Decode the given float.

Parameters

mixed $value

Return Value

float

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

Return a decimal as string.

Parameters

float|string $value
int $decimals

Return Value

string

Exceptions

MathException

in HasAttributes at line 1466
protected CarbonInterface asDate(mixed $value)

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

Parameters

mixed $value

Return Value

CarbonInterface

in HasAttributes at line 1474
protected CarbonInterface asDateTime(mixed $value)

Return a timestamp as DateTime object.

Parameters

mixed $value

Return Value

CarbonInterface

in HasAttributes at line 1525
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 1533
string|null fromDateTime(mixed $value)

Convert a DateTime to a storable string.

Parameters

mixed $value

Return Value

string|null

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

Return a timestamp as unix timestamp.

Parameters

mixed $value

Return Value

int

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

Prepare a date for array / JSON serialization.

Parameters

DateTimeInterface $date

Return Value

string

in HasAttributes at line 1563
array getDates()

Get the attributes that should be converted to dates.

Return Value

array

in HasAttributes at line 1574
string getDateFormat()

Get the format for database stored dates.

Return Value

string

in HasAttributes at line 1582
HasAttributes setDateFormat(string $format)

Set the date format used by the model.

Parameters

string $format

Return Value

HasAttributes

in HasAttributes at line 1592
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 1606
array getCasts()

Get the attributes that should be cast.

Return Value

array

in HasAttributes at line 1623
protected array casts()

Get the attributes that should be cast.

Return Value

array

in HasAttributes at line 1631
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 1639
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 1647
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 1655
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 1665
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 1693
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 1723
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 1743
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 1753
protected bool isClassComparable(string $key)

Determine if the key is comparable using a custom class.

Parameters

string $key

Return Value

bool

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

Resolve the custom caster class for a given key.

Parameters

string $key

Return Value

mixed

in HasAttributes at line 1799
static void flushCasterCache()

Flush the caster cache for the model.

Boot or tests only. Clears the worker-wide caster instance cache shared by every coroutine; next attribute access rebuilds the casters.

Return Value

void

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

Parse the given caster class, removing any arguments.

Parameters

string $class

Return Value

string

in HasAttributes at line 1817
protected void mergeAttributesFromCachedCasts()

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

Return Value

void

in HasAttributes at line 1826
protected void mergeAttributeFromCachedCasts(string $key)

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

Parameters

string $key

Return Value

void

in HasAttributes at line 1835
protected void mergeAttributesFromClassCasts()

Merge the cast class attributes back into the model.

Return Value

void

in HasAttributes at line 1845
protected void mergeAttributeFromClassCasts(string $key)

Merge the cast class attribute back into the model.

Parameters

string $key

Return Value

void

in HasAttributes at line 1865
protected void mergeAttributesFromAttributeCasts()

Merge the cast class attributes back into the model.

Return Value

void

in HasAttributes at line 1875
protected void mergeAttributeFromAttributeCasts(string $key)

Merge the cast class attribute back into the model.

Parameters

string $key

Return Value

void

in HasAttributes at line 1904
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 1914
array getAttributes()

Get all of the current attributes on the model.

Return Value

array

in HasAttributes at line 1924
protected array getAttributesForInsert()

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

Return Value

array

in HasAttributes at line 1944
array prepareBinaryAttributesForDatabase(array $attributes)

Prepare binary-cast attributes for database binding.

Parameters

array $attributes

Return Value

array

in HasAttributes at line 1970
HasAttributes setRawAttributes(array $attributes, bool $sync = false)

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

Parameters

array $attributes
bool $sync

Return Value

HasAttributes

in HasAttributes at line 1989
mixed getOriginal(string|null $key = null, mixed $default = null)

Get the model's original attribute values.

Parameters

string|null $key
mixed $default

Return Value

mixed

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

Get the model's original attribute values.

Parameters

string|null $key
mixed $default

Return Value

mixed

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

in HasAttributes at line 2032
array only(mixed $attributes)

Get a subset of the model's attributes.

Parameters

mixed $attributes

Return Value

array

in HasAttributes at line 2048
array except(mixed $attributes)

Get all attributes except the given ones.

Parameters

mixed $attributes

Return Value

array

in HasAttributes at line 2066
HasAttributes syncOriginal()

Sync the original attributes with the current.

Return Value

HasAttributes

in HasAttributes at line 2076
HasAttributes syncOriginalAttribute(string $attribute)

Sync a single original attribute with its current value.

Parameters

string $attribute

Return Value

HasAttributes

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

Sync multiple original attribute with their current values.

Parameters

array|string $attributes

Return Value

HasAttributes

in HasAttributes at line 2102
HasAttributes syncChanges()

Sync the changed attributes.

Return Value

HasAttributes

in HasAttributes at line 2125
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 2138
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 2146
HasAttributes discardChanges()

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

Return Value

HasAttributes

in HasAttributes at line 2161
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 2175
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 2201
array getDirty()

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

Return Value

array

in HasAttributes at line 2233
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 2243
array getChanges()

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

Return Value

array

in HasAttributes at line 2253
array getPrevious()

Get the attributes that were previously original before the model was last saved.

Return Value

array

in HasAttributes at line 2261
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 2352
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 2394
HasAttributes append(array|string $attributes)

Append attributes to query when building a query.

Parameters

array|string $attributes

Return Value

HasAttributes

in HasAttributes at line 2406
array getAppends()

Get the accessors that are being appended to model arrays.

Return Value

array

in HasAttributes at line 2414
HasAttributes setAppends(array $appends)

Set the accessors to append to model arrays.

Parameters

array $appends

Return Value

HasAttributes

in HasAttributes at line 2426
HasAttributes mergeAppends(array $appends)

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

Parameters

array $appends

Return Value

HasAttributes

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

Return whether the accessor attribute has been appended.

Parameters

string $attribute

Return Value

bool

in HasAttributes at line 2448
HasAttributes withoutAppends()

Remove all appended properties from the model.

Return Value

HasAttributes

in HasAttributes at line 2456
array getMutatedAttributes()

Get the mutated attributes for a given instance.

Return Value

array

in HasAttributes at line 2468
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 2487
static protected array getMutatorMethods(mixed $class)

Get all of the attribute mutator methods.

Parameters

mixed $class

Return Value

array

in HasAttributes at line 2497
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 41
static void bootHasEvents()

Boot the has event trait for a model.

Return Value

void

in HasEvents at line 57
static array resolveObserveAttributes()

Resolve the observe class names from the attributes.

Return Value

array

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

Register observers with the model.

Boot-only. Observer listeners are registered on the worker-wide event dispatcher and persist for the worker lifetime; runtime use leaks listeners across every subsequent request.

Parameters

object|array|string $classes

Return Value

void

Exceptions

InvalidArgumentException

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

Register a single observer with the model.

Parameters

object|string $class

Return Value

void

Exceptions

InvalidArgumentException

in HasEvents at line 144
array getObservableEvents()

Get the observable event names.

Return Value

array

in HasEvents at line 162
HasEvents setObservableEvents(array $observables)

Set the observable event names.

Parameters

array $observables

Return Value

HasEvents

in HasEvents at line 174
void addObservableEvents(array|string $observables)

Add an observable event name.

Parameters

array|string $observables

Return Value

void

in HasEvents at line 187
void removeObservableEvents(array|string $observables)

Remove an observable event name.

Parameters

array|string $observables

Return Value

void

in HasEvents at line 200
static protected void registerModelEvent(string $event, mixed $callback)

Register a model event with the dispatcher.

Parameters

string $event
mixed $callback

Return Value

void

in HasEvents at line 212
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 242
protected mixed fireCustomModelEvent(string $event, string $method)

Fire a custom model event for the given event.

Parameters

string $event
string $method

Return Value

mixed

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

Filter the model event results.

Parameters

mixed $result

Return Value

mixed

in HasEvents at line 278
static void retrieved(mixed $callback)

Register a retrieved model event with the dispatcher.

Boot-only. Listener persists on the worker-wide event dispatcher for the worker lifetime; runtime use leaks listeners across every subsequent request.

Parameters

mixed $callback

Return Value

void

in HasEvents at line 292
static void saving(mixed $callback)

Register a saving model event with the dispatcher.

Boot-only. Listener persists on the worker-wide event dispatcher for the worker lifetime; runtime use leaks listeners across every subsequent request.

Parameters

mixed $callback

Return Value

void

in HasEvents at line 306
static void saved(mixed $callback)

Register a saved model event with the dispatcher.

Boot-only. Listener persists on the worker-wide event dispatcher for the worker lifetime; runtime use leaks listeners across every subsequent request.

Parameters

mixed $callback

Return Value

void

in HasEvents at line 320
static void updating(mixed $callback)

Register an updating model event with the dispatcher.

Boot-only. Listener persists on the worker-wide event dispatcher for the worker lifetime; runtime use leaks listeners across every subsequent request.

Parameters

mixed $callback

Return Value

void

in HasEvents at line 334
static void updated(mixed $callback)

Register an updated model event with the dispatcher.

Boot-only. Listener persists on the worker-wide event dispatcher for the worker lifetime; runtime use leaks listeners across every subsequent request.

Parameters

mixed $callback

Return Value

void

in HasEvents at line 348
static void creating(mixed $callback)

Register a creating model event with the dispatcher.

Boot-only. Listener persists on the worker-wide event dispatcher for the worker lifetime; runtime use leaks listeners across every subsequent request.

Parameters

mixed $callback

Return Value

void

in HasEvents at line 362
static void created(mixed $callback)

Register a created model event with the dispatcher.

Boot-only. Listener persists on the worker-wide event dispatcher for the worker lifetime; runtime use leaks listeners across every subsequent request.

Parameters

mixed $callback

Return Value

void

in HasEvents at line 376
static void replicating(mixed $callback)

Register a replicating model event with the dispatcher.

Boot-only. Listener persists on the worker-wide event dispatcher for the worker lifetime; runtime use leaks listeners across every subsequent request.

Parameters

mixed $callback

Return Value

void

in HasEvents at line 390
static void deleting(mixed $callback)

Register a deleting model event with the dispatcher.

Boot-only. Listener persists on the worker-wide event dispatcher for the worker lifetime; runtime use leaks listeners across every subsequent request.

Parameters

mixed $callback

Return Value

void

in HasEvents at line 404
static void deleted(mixed $callback)

Register a deleted model event with the dispatcher.

Boot-only. Listener persists on the worker-wide event dispatcher for the worker lifetime; runtime use leaks listeners across every subsequent request.

Parameters

mixed $callback

Return Value

void

in HasEvents at line 415
static void flushEventListeners()

Remove all the event listeners for the model.

Boot or tests only. Removes listeners from the worker-wide event dispatcher; concurrent coroutines lose model events mid-request.

Return Value

void

in HasEvents at line 437
array dispatchesEvents()

Get the event map for the model.

Return Value

array

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

Get the event dispatcher instance.

Returns a NullDispatcher when events are disabled (inside withoutEvents()) to ensure manual dispatch() calls are also suppressed, matching Laravel behavior.

Return Value

Dispatcher|null

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

Set the event dispatcher instance.

Boot-only. The dispatcher persists in a static property for the worker lifetime and is used by every model event firing across all coroutines.

Parameters

Dispatcher $dispatcher

Return Value

void

in HasEvents at line 474
static void unsetEventDispatcher()

Unset the event dispatcher for models.

Tests only. Clears the worker-wide event dispatcher shared by every coroutine; concurrent model operations will not fire events.

Return Value

void

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

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

Uses Context for coroutine-safe event disabling, ensuring concurrent requests don't interfere with each other's event handling.

Parameters

callable $callback

Return Value

mixed

in HasEvents at line 505
static bool eventsDisabled()

Determine if model events are currently disabled for this coroutine.

Return Value

bool

in HasGlobalScopes at line 23
static void bootHasGlobalScopes()

Boot the has global scopes trait for a model.

Return Value

void

in HasGlobalScopes at line 31
static array resolveGlobalScopeAttributes()

Resolve the global scope class names from the attributes.

Return Value

array

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

Register a new global scope on the model.

Boot-only. The scope persists in a static property for the worker lifetime and applies to every query for this model class across all coroutines.

Parameters

Scope|Closure|string $scope
Scope|Closure|null $implementation

Return Value

mixed

Exceptions

InvalidArgumentException

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

Register multiple global scopes on the model.

Boot-only. Delegates to addGlobalScope() per entry; each scope persists in a static property for the worker lifetime.

Parameters

array $scopes

Return Value

void

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

Determine if a model has a global scope.

Parameters

Scope|int|string $scope

Return Value

bool

in HasGlobalScopes at line 116
static Scope|Closure|null getGlobalScope(Scope|int|string $scope)

Get a global scope registered with the model.

Parameters

Scope|int|string $scope

Return Value

Scope|Closure|null

in HasGlobalScopes at line 128
static array getAllGlobalScopes()

Get all of the global scopes that are currently registered.

Return Value

array

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

Set the current global scopes.

Boot or tests only. Replaces the worker-wide global scopes registry shared by every coroutine; per-request use changes scope behavior for every concurrent model query.

Parameters

array $scopes

Return Value

void

in HasGlobalScopes at line 148
array getGlobalScopes()

Get the global scopes for this class instance.

Return Value

array

in HasRelationships at line 70
void initializeHasRelationships()

Initialize the HasRelationships trait.

Return Value

void

in HasRelationships at line 89
Closure|null relationResolver(string $class, string $key)

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

Parameters

string $class
string $key

Return Value

Closure|null

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

Define a dynamic relation resolver.

Boot-only. The resolver persists in a static property for the worker lifetime and runs on every relation resolution for this model class across all coroutines.

Parameters

string $name
Closure $callback

Return Value

void

in HasRelationships at line 120
bool hasRelationAutoloadCallback()

Determine if a relationship autoloader callback has been defined.

Return Value

bool

in HasRelationships at line 128
HasRelationships autoloadRelationsUsing(Closure $callback, mixed $context = null)

Define an automatic relationship autoloader callback for this model and its relations.

Parameters

Closure $callback
mixed $context

Return Value

HasRelationships

in HasRelationships at line 148
protected bool attemptToAutoloadRelation(string $key)

Attempt to autoload the given relationship using the autoload callback.

Parameters

string $key

Return Value

bool

in HasRelationships at line 162
protected void invokeRelationAutoloadCallbackFor(string $key, array $tuples)

Invoke the relationship autoloader callback for the given relationships.

Parameters

string $key
array $tuples

Return Value

void

in HasRelationships at line 172
protected void propagateRelationAutoloadCallbackToRelation(string $key, mixed $models)

Propagate the relationship autoloader callback to the given related models.

Parameters

string $key
mixed $models

Return Value

void

in HasRelationships at line 201
HasOne hasOne(string $related, string|null $foreignKey = null, string|null $localKey = null)

Define a one-to-one relationship.

Parameters

string $related
string|null $foreignKey
string|null $localKey

Return Value

HasOne

in HasRelationships at line 222
protected HasOne 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

HasOne

in HasRelationships at line 237
HasOneThrough hasOneThrough(string $related, string $through, string|null $firstKey = null, string|null $secondKey = null, string|null $localKey = null, string|null $secondLocalKey = null)

Define a has-one-through relationship.

Parameters

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

Return Value

HasOneThrough

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

Instantiate a new HasOneThrough relationship.

Parameters

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

Return Value

HasOneThrough

in HasRelationships at line 281
MorphOne morphOne(string $related, string $name, string|null $type = null, string|null $id = null, string|null $localKey = null)

Define a polymorphic one-to-one relationship.

Parameters

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

Return Value

MorphOne

in HasRelationships at line 302
protected MorphOne 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

MorphOne

in HasRelationships at line 315
BelongsTo belongsTo(string $related, string|null $foreignKey = null, string|null $ownerKey = null, string|null $relation = null)

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

Parameters

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

Return Value

BelongsTo

in HasRelationships at line 357
protected BelongsTo 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

BelongsTo

in HasRelationships at line 367
MorphTo 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

MorphTo

in HasRelationships at line 393
protected MorphTo 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

MorphTo

in HasRelationships at line 411
protected MorphTo morphInstanceTo(string|int $target, string $name, string $type, string $id, string|null $ownerKey)

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

Parameters

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

Return Value

MorphTo

in HasRelationships at line 437
protected MorphTo 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

MorphTo

in HasRelationships at line 445
static string getActualClassNameForMorph(string|int $class)

Retrieve the actual class name for a given morph class.

Parameters

string|int $class

Return Value

string

in HasRelationships at line 453
protected string guessBelongsToRelation()

Guess the "belongs to" relationship name.

Return Value

string

in HasRelationships at line 477
PendingHasThroughRelationship through(string|HasOneOrMany $relationship)

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

Parameters

string|HasOneOrMany $relationship

Return Value

PendingHasThroughRelationship

in HasRelationships at line 495
HasMany hasMany(string $related, string|null $foreignKey = null, string|null $localKey = null)

Define a one-to-many relationship.

Parameters

string $related
string|null $foreignKey
string|null $localKey

Return Value

HasMany

in HasRelationships at line 521
protected HasMany 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

HasMany

in HasRelationships at line 536
HasManyThrough hasManyThrough(string $related, string $through, string|null $firstKey = null, string|null $secondKey = null, string|null $localKey = null, string|null $secondLocalKey = null)

Define a has-many-through relationship.

Parameters

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

Return Value

HasManyThrough

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

Instantiate a new HasManyThrough relationship.

Parameters

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

Return Value

HasManyThrough

in HasRelationships at line 580
MorphMany morphMany(string $related, string $name, string|null $type = null, string|null $id = null, string|null $localKey = null)

Define a polymorphic one-to-many relationship.

Parameters

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

Return Value

MorphMany

in HasRelationships at line 604
protected MorphMany 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

MorphMany

in HasRelationships at line 620
BelongsToMany belongsToMany(string $related, 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 many-to-many relationship.

Parameters

string $related
string|null $table
string|null $foreignPivotKey
string|null $relatedPivotKey
string|null $parentKey
string|null $relatedKey
string|null $relation

Return Value

BelongsToMany

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

Instantiate a new BelongsToMany relationship.

Parameters

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

Return Value

BelongsToMany

in HasRelationships at line 700
MorphToMany morphToMany(string $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

string $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

MorphToMany

in HasRelationships at line 757
protected MorphToMany 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

MorphToMany

in HasRelationships at line 791
MorphToMany morphedByMany(string $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

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

Return Value

MorphToMany

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

Get the relationship name of the belongsToMany relationship.

Return Value

string|null

in HasRelationships at line 840
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 863
string joiningTableSegment()

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

Return Value

string

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

Determine if the model touches a given relation.

Parameters

string $relation

Return Value

bool

in HasRelationships at line 879
void touchOwners()

Touch the owning relations of the model.

Return Value

void

in HasRelationships at line 901
protected array getMorphs(string $name, string|null $type, string|null $id)

Get the polymorphic relationship columns.

Parameters

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

Return Value

array

in HasRelationships at line 911
string getMorphClass()

Get the class name for polymorphic relations.

Return Value

string

Exceptions

ClassMorphViolationException

in HasRelationships at line 939
protected Model newRelatedInstance(string $class)

Create a new model instance for a related model.

Parameters

string $class

Return Value

Model

in HasRelationships at line 956
protected Model newRelatedThroughInstance(string $class)

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

Parameters

string $class

Return Value

Model

in HasRelationships at line 964
array getRelations()

Get all the loaded relations for the instance.

Return Value

array

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

Get a specified relationship.

Parameters

string $relation

Return Value

mixed

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

Determine if the given relation is loaded.

Parameters

string $key

Return Value

bool

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

Set the given relationship on the model.

Parameters

string $relation
mixed $value

Return Value

HasRelationships

in HasRelationships at line 1004
HasRelationships unsetRelation(string $relation)

Unset a loaded relationship.

Parameters

string $relation

Return Value

HasRelationships

in HasRelationships at line 1016
HasRelationships setRelations(array $relations)

Set the entire relations array on the model.

Parameters

array $relations

Return Value

HasRelationships

in HasRelationships at line 1028
HasRelationships withRelationshipAutoloading()

Enable relationship autoloading for this model.

Return Value

HasRelationships

in HasRelationships at line 1038
HasRelationships withoutRelations()

Duplicate the instance and unset all the loaded relations.

Return Value

HasRelationships

in HasRelationships at line 1048
HasRelationships withoutRelation(array|string $relations)

Duplicate the instance and unset the given loaded relations.

Parameters

array|string $relations

Return Value

HasRelationships

in HasRelationships at line 1064
HasRelationships unsetRelations()

Unset all the loaded relations for the instance.

Return Value

HasRelationships

in HasRelationships at line 1074
array getTouchedRelations()

Get the relationships that are touched on save.

Return Value

array

in HasRelationships at line 1084
HasRelationships setTouchedRelations(array $touches)

Set the relationships that are touched on save.

Parameters

array $touches

Return Value

HasRelationships

in HasTimestamps at line 30
void initializeHasTimestamps()

Initialize the HasTimestamps trait.

Return Value

void

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

Update the model's update timestamp.

Parameters

array|string|null $attribute

Return Value

bool

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

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

Parameters

array|string|null $attribute

Return Value

bool

in HasTimestamps at line 88
HasTimestamps updateTimestamps()

Update the creation and update timestamps.

Return Value

HasTimestamps

in HasTimestamps at line 112
HasTimestamps setCreatedAt(mixed $value)

Set the value of the "created at" attribute.

Parameters

mixed $value

Return Value

HasTimestamps

in HasTimestamps at line 124
HasTimestamps setUpdatedAt(mixed $value)

Set the value of the "updated at" attribute.

Parameters

mixed $value

Return Value

HasTimestamps

in HasTimestamps at line 134
CarbonInterface freshTimestamp()

Get a fresh timestamp for the model.

Return Value

CarbonInterface

in HasTimestamps at line 142
string freshTimestampString()

Get a fresh timestamp for the model.

Return Value

string

in HasTimestamps at line 150
bool usesTimestamps()

Determine if the model uses timestamps.

Return Value

bool

in HasTimestamps at line 158
string|null getCreatedAtColumn()

Get the name of the "created at" column.

Return Value

string|null

in HasTimestamps at line 166
string|null getUpdatedAtColumn()

Get the name of the "updated at" column.

Return Value

string|null

in HasTimestamps at line 174
string|null getQualifiedCreatedAtColumn()

Get the fully-qualified "created at" column.

Return Value

string|null

in HasTimestamps at line 184
string|null getQualifiedUpdatedAtColumn()

Get the fully-qualified "updated at" column.

Return Value

string|null

in HasTimestamps at line 199
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 213
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 231
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 17
bool usesUniqueIds()

Determine if the model uses unique ids.

Return Value

bool

in HasUniqueIds at line 25
void setUniqueIds()

Generate unique keys for the model.

Return Value

void

in HasUniqueIds at line 37
string|null newUniqueId()

Generate a new key for the model.

Return Value

string|null

in HasUniqueIds at line 47
array uniqueIds()

Get the columns that should receive a unique identifier.

Return Value

array

in HidesAttributes at line 31
void initializeHidesAttributes()

Initialize the HidesAttributes trait.

Return Value

void

in HidesAttributes at line 47
array getHidden()

Get the hidden attributes for the model.

Return Value

array

in HidesAttributes at line 58
HidesAttributes setHidden(array $hidden)

Set the hidden attributes for the model.

Parameters

array $hidden

Return Value

HidesAttributes

in HidesAttributes at line 71
HidesAttributes mergeHidden(array $hidden)

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

Parameters

array $hidden

Return Value

HidesAttributes

in HidesAttributes at line 87
array getVisible()

Get the visible attributes for the model.

Return Value

array

in HidesAttributes at line 98
HidesAttributes setVisible(array $visible)

Set the visible attributes for the model.

Parameters

array $visible

Return Value

HidesAttributes

in HidesAttributes at line 111
HidesAttributes mergeVisible(array $visible)

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

Parameters

array $visible

Return Value

HidesAttributes

in HidesAttributes at line 128
HidesAttributes makeVisible(array|string|null $attributes)

Make the given, typically hidden, attributes visible.

Parameters

array|string|null $attributes

Return Value

HidesAttributes

in HidesAttributes at line 147
HidesAttributes makeVisibleIf(bool|Closure $condition, array|string|null $attributes)

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

Parameters

bool|Closure $condition
array|string|null $attributes

Return Value

HidesAttributes

in HidesAttributes at line 158
HidesAttributes makeHidden(array|string|null $attributes)

Make the given, typically visible, attributes hidden.

Parameters

array|string|null $attributes

Return Value

HidesAttributes

in HidesAttributes at line 174
HidesAttributes makeHiddenIf(bool|Closure $condition, array|string|null $attributes)

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

Parameters

bool|Closure $condition
array|string|null $attributes

Return Value

HidesAttributes

in GuardsAttributes at line 48
void initializeGuardsAttributes()

Initialize the GuardsAttributes trait.

Return Value

void

in GuardsAttributes at line 72
static protected array guardConfiguration()

Resolve the nearest guard configuration for the model class.

Return Value

array

in GuardsAttributes at line 126
static protected array|null guardConfigurationFromTraits(array $traits)

Resolve guard configuration declared by traits at one class level.

Parameters

array $traits

Return Value

array|null

in GuardsAttributes at line 149
array getFillable()

Get the fillable attributes for the model.

Return Value

array

in GuardsAttributes at line 159
GuardsAttributes fillable(array $fillable)

Set the fillable attributes for the model.

Parameters

array $fillable

Return Value

GuardsAttributes

in GuardsAttributes at line 171
GuardsAttributes mergeFillable(array $fillable)

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

Parameters

array $fillable

Return Value

GuardsAttributes

in GuardsAttributes at line 187
array getGuarded()

Get the guarded attributes for the model.

Return Value

array

in GuardsAttributes at line 199
GuardsAttributes guard(array $guarded)

Set the guarded attributes for the model.

Parameters

array $guarded

Return Value

GuardsAttributes

in GuardsAttributes at line 211
GuardsAttributes mergeGuarded(array $guarded)

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

Parameters

array $guarded

Return Value

GuardsAttributes

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

Disable all mass assignable restrictions.

Uses Context for coroutine-safe state management.

Parameters

bool $state

Return Value

void

in GuardsAttributes at line 231
static void reguard()

Enable the mass assignment restrictions.

Return Value

void

in GuardsAttributes at line 239
static bool isUnguarded()

Determine if the current state is "unguarded".

Return Value

bool

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

Run the given callable while being unguarded.

Uses Context for coroutine-safe state management, ensuring concurrent requests don't interfere with each other's guarding state.

Parameters

callable $callback

Return Value

mixed

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

Determine if the given attribute may be mass assigned.

Parameters

string $key

Return Value

bool

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

Determine if the given key is guarded.

Parameters

string $key

Return Value

bool

in GuardsAttributes at line 316
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 340
bool totallyGuarded()

Determine if the model is totally guarded.

Return Value

bool

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

Get the fillable attributes of a given array.

Parameters

array $attributes

Return Value

array

in PreventsCircularRecursion at line 22
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 52
static protected void clearRecursiveCallValue(object $object, string $hash)

Remove an entry from the recursion cache for an object.

Parameters

object $object
string $hash

Return Value

void

in PreventsCircularRecursion at line 66
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 78
static protected WeakMap getRecursionCache()

Get the current recursion cache being used by the model.

Return Value

WeakMap

in PreventsCircularRecursion at line 86
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 TransformsToResource at line 23
JsonResource toResource(string|null $resourceClass = null)

Create a new resource object for the given resource.

Parameters

string|null $resourceClass

Return Value

JsonResource

in TransformsToResource at line 37
protected JsonResource guessResource()

Guess the resource class for the model.

Return Value

JsonResource

Exceptions

LogicException

in TransformsToResource at line 59
static array guessResourceName()

Guess the resource class name for the model.

Return Value

array

in TransformsToResource at line 89
protected string|null resolveResourceFromAttribute(string $class)

Get the resource class from the UseResource attribute.

Parameters

string $class

Return Value

string|null

in ForwardsCalls at line 22
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 52
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 66
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 28
Collection newCollection(array $models = [])

Create a new Eloquent Collection instance.

Parameters

array $models

Return Value

Collection

in HasCollection at line 48
string|null resolveCollectionFromAttribute()

Resolve the collection class name from the CollectedBy attribute.

Return Value

string|null

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

Create a new Eloquent model instance.

Parameters

array $attributes

in Model at line 380
protected void bootIfNotBooted()

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

Return Value

void

Exceptions

LogicException
RuntimeException

in Model at line 449
static protected void booting()

Perform any actions required before the model boots.

Return Value

void

in Model at line 456
static protected void boot()

Bootstrap the model and its traits.

Return Value

void

in Model at line 464
static protected void bootTraits()

Boot all of the bootable traits on the model.

Return Value

void

in Model at line 499
protected void initializeTraits()

Initialize any initializable traits on the model.

Return Value

void

in Model at line 509
void initializeModelAttributes()

Initialize the model attributes from class attributes.

Return Value

void

in Model at line 546
static protected void booted()

Perform any actions required after the model boots.

Return Value

void

in Model at line 553
static protected void whenBooted(Closure $callback)

Register a closure to be executed after the model has booted.

Parameters

Closure $callback

Return Value

void

in Model at line 567
static void clearBootedModels()

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

Boot or tests only. Clears worker-wide boot state, boot callbacks, and global scopes; concurrent coroutines mid-query may observe inconsistent model state.

Return Value

void

in Model at line 584
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 594
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 612
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 648
static void shouldBeStrict(bool $shouldBeStrict = true)

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

Boot-only. Toggles worker-wide strict-mode flags that apply to every model operation across all coroutines.

Parameters

bool $shouldBeStrict

Return Value

void

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

Prevent model relationships from being lazy loaded.

Boot-only. The flag persists in a static property for the worker lifetime and applies to every relationship access across all coroutines.

Parameters

bool $value

Return Value

void

in Model at line 672
static void automaticallyEagerLoadRelationships(bool $value = true)

Determine if model relationships should be automatically eager loaded when accessed.

Boot-only. The flag persists in a static property for the worker lifetime and applies to every relationship access across all coroutines.

Parameters

bool $value

Return Value

void

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

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

Boot-only. The callback persists in a static property for the worker lifetime and runs on every lazy-loading violation across all coroutines.

Parameters

callable|null $callback

Return Value

void

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

Prevent non-fillable attributes from being silently discarded.

Boot-only. The flag persists in a static property for the worker lifetime and applies to every mass assignment across all coroutines.

Parameters

bool $value

Return Value

void

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

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

Boot-only. The callback persists in a static property for the worker lifetime and runs on every discarded-attribute violation across all coroutines.

Parameters

callable|null $callback

Return Value

void

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

Prevent accessing missing attributes on retrieved models.

Boot-only. The flag persists in a static property for the worker lifetime and applies to every attribute access across all coroutines.

Parameters

bool $value

Return Value

void

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

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

Boot-only. The callback persists in a static property for the worker lifetime and runs on every missing-attribute violation across all coroutines.

Parameters

callable|null $callback

Return Value

void

in Model at line 746
static void reportRouteModelBindingExceptions(bool $value = true)

Report invalid value exceptions during implicit route model binding.

Boot-only. The flag persists in a static property for the worker lifetime and applies to every implicit route binding across all coroutines.

Parameters

bool $value

Return Value

void

in Model at line 759
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 775
static bool isBroadcasting()

Determine if broadcasting is currently enabled.

Return Value

bool

in Model at line 787
Model fill(array $attributes)

Fill the model with an array of attributes.

Parameters

array $attributes

Return Value

Model

Exceptions

MassAssignmentException

in Model at line 839
Model forceFill(array $attributes)

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

Parameters

array $attributes

Return Value

Model

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

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

Parameters

string $column

Return Value

string

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

Qualify the given columns with the model's table.

Parameters

array $columns

Return Value

array

in Model at line 874
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 901
Model newFromBuilder(array|object $attributes = [], UnitEnum|string|null $connection = null)

Create a new model instance that is existing.

Parameters

array|object $attributes
UnitEnum|string|null $connection

Return Value

Model

in Model at line 919
static Builder on(UnitEnum|string|null $connection = null)

Begin querying the model on a given connection.

Parameters

UnitEnum|string|null $connection

Return Value

Builder

in Model at line 932
static Builder onWriteConnection()

Begin querying the model on the write connection.

Return Value

Builder

in Model at line 943
static Collection all(array|string $columns = ['*'])

Get all of the models from the database.

Parameters

array|string $columns

Return Value

Collection

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

Begin querying a model with eager loading.

Parameters

array|string $relations

Return Value

Builder

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

Eager load relations on the model.

Parameters

array|string $relations

Return Value

Model

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

Eager load relationships on the polymorphic relation of a model.

Parameters

string $relation
array $relations

Return Value

Model

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

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

Parameters

array|string $relations

Return Value

Model

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

Eager load relation's column aggregations on the model.

Parameters

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

Return Value

Model

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

Eager load relation counts on the model.

Parameters

array|string $relations

Return Value

Model

in Model at line 1040
Model loadMax(array|string $relations, Expression|string $column)

Eager load relation max column values on the model.

Parameters

array|string $relations
Expression|string $column

Return Value

Model

in Model at line 1050
Model loadMin(array|string $relations, Expression|string $column)

Eager load relation min column values on the model.

Parameters

array|string $relations
Expression|string $column

Return Value

Model

in Model at line 1060
Model loadSum(array|string $relations, Expression|string $column)

Eager load relation's column summations on the model.

Parameters

array|string $relations
Expression|string $column

Return Value

Model

in Model at line 1070
Model loadAvg(array|string $relations, Expression|string $column)

Eager load relation average column values on the model.

Parameters

array|string $relations
Expression|string $column

Return Value

Model

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

Eager load related model existence values on the model.

Parameters

array|string $relations

Return Value

Model

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

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

Parameters

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

Return Value

Model

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

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

Parameters

string $relation
array $relations

Return Value

Model

in Model at line 1118
Model loadMorphMax(string $relation, array $relations, Expression|string $column)

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

Parameters

string $relation
array $relations
Expression|string $column

Return Value

Model

in Model at line 1128
Model loadMorphMin(string $relation, array $relations, Expression|string $column)

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

Parameters

string $relation
array $relations
Expression|string $column

Return Value

Model

in Model at line 1138
Model loadMorphSum(string $relation, array $relations, Expression|string $column)

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

Parameters

string $relation
array $relations
Expression|string $column

Return Value

Model

in Model at line 1148
Model loadMorphAvg(string $relation, array $relations, Expression|string $column)

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

Parameters

string $relation
array $relations
Expression|string $column

Return Value

Model

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

Increment a column's value by a given amount.

Parameters

string $column
mixed $amount
array $extra

Return Value

int|false

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

Decrement a column's value by a given amount.

Parameters

string $column
mixed $amount
array $extra

Return Value

int|false

in Model at line 1178
protected int|false incrementOrDecrement(string $column, mixed $amount, array $extra, string $method)

Run the increment or decrement method on the model.

Parameters

string $column
mixed $amount
array $extra
string $method

Return Value

int|false

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

Update the model in the database.

Parameters

array $attributes
array $options

Return Value

bool

in Model at line 1230
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 1245
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 1259
protected int|false 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|false

in Model at line 1271
protected int|false 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|false

in Model at line 1284
protected int|false incrementEach(array $columns, array $extra = [])

Increment each given column's value by the given amounts.

Parameters

array $columns
array $extra

Return Value

int|false

in Model at line 1295
protected int|false decrementEach(array $columns, array $extra = [])

Decrement each given column's value by the given amounts.

Parameters

array $columns
array $extra

Return Value

int|false

in Model at line 1306
protected int|false incrementEachQuietly(array $columns, array $extra = [])

Increment each given column's value by the given amounts without raising any events.

Parameters

array $columns
array $extra

Return Value

int|false

in Model at line 1319
protected int|false decrementEachQuietly(array $columns, array $extra = [])

Decrement each given column's value by the given amounts without raising any events.

Parameters

array $columns
array $extra

Return Value

int|false

in Model at line 1332
protected int|false incrementOrDecrementEach(array $columns, array $extra, string $method)

Run the incrementEach or decrementEach method on the model.

Parameters

array $columns
array $extra
string $method

Return Value

int|false

in Model at line 1379
bool push()

Save the model and all of its relationships.

Return Value

bool

in Model at line 1408
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 1418
bool saveQuietly(array $options = [])

Save the model to the database without raising any events.

Parameters

array $options

Return Value

bool

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

Save the model to the database.

Parameters

array $options

Return Value

bool

in Model at line 1477
bool saveOrIgnore(array $options = [], array|string|null $uniqueBy = null)

Save the model to the database, ignoring specific unique constraint conflicts.

Parameters

array $options
array|string|null $uniqueBy

Return Value

bool

Exceptions

LogicException

in Model at line 1511
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 1521
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 1537
protected bool performUpdate(Builder $query)

Perform a model update operation.

Parameters

Builder $query

Return Value

bool

in AsPivot at line 91
protected Builder setKeysForSelectQuery(Builder $query)

Set the keys for a select query.

Parameters

Builder $query

Return Value

Builder

in Model at line 1597
protected mixed getKeyForSelectQuery()

Get the primary key value for a select query.

Return Value

mixed

in AsPivot at line 110
protected Builder setKeysForSaveQuery(Builder $query)

Set the keys for a save update query.

Parameters

Builder $query

Return Value

Builder

in Model at line 1624
protected mixed getKeyForSaveQuery()

Get the primary key value for a save query.

Return Value

mixed

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

Perform a model insert operation.

Parameters

Builder $query

Return Value

bool

in Model at line 1716
protected bool performInsertOrIgnore(Builder $query, array|string|null $uniqueBy)

Perform a model insert operation, ignoring specific unique constraint conflicts.

Parameters

Builder $query
array|string|null $uniqueBy

Return Value

bool

Exceptions

LogicException

in Model at line 1770
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 1782
static int destroy(Collection|Collection|array|int|string $ids)

Destroy the models for the given IDs.

Parameters

Collection|Collection|array|int|string $ids

Return Value

int

in AsPivot at line 121
int delete()

Delete the pivot model record from the database.

Returns affected row count (int) rather than bool|null because pivots use query builder deletion with compound keys.

Return Value

int

in Model at line 1859
int|bool|null deleteQuietly()

Delete the model from the database without raising any events.

Return Value

int|bool|null

in Model at line 1869
int|bool|null deleteOrFail()

Delete the model from the database within a transaction.

Return Value

int|bool|null

Exceptions

Throwable

in Model at line 1883
int|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

int|bool|null

in Model at line 1895
static int forceDestroy(Collection|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|Collection|array|int|string $ids

Return Value

int

in Model at line 1903
protected void performDeleteOnModel()

Perform the actual delete query on this model instance.

Return Value

void

in Model at line 1915
static Builder query()

Begin querying the model.

Return Value

Builder

in Model at line 1925
Builder newQuery()

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

Return Value

Builder

in Model at line 1935
Builder newModelQuery()

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

Return Value

Builder

in Model at line 1948
Builder newQueryWithoutRelationships()

Get a new query builder with no relationships loaded.

Return Value

Builder

in Model at line 1959
Builder registerGlobalScopes(Builder $builder)

Register the global scopes for this builder instance.

Parameters

Builder $builder

Return Value

Builder

in Model at line 1973
Builder newQueryWithoutScopes()

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

Return Value

Builder

in Model at line 1985
Builder newQueryWithoutScope(Scope|int|string $scope)

Get a new query instance without a given scope.

Parameters

Scope|int|string $scope

Return Value

Builder

in AsPivot at line 323
Builder newQueryForRestoration(array|int|string $ids)

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

Parameters

array|int|string $ids

Return Value

Builder

in Model at line 2005
Builder newEloquentBuilder(Builder $query)

Create a new Eloquent query builder for the model.

Parameters

Builder $query

Return Value

Builder

in Model at line 2022
protected string|false resolveCustomBuilderClass()

Resolve the custom Eloquent builder class from the model attributes.

Return Value

string|false

in Model at line 2030
protected Builder newBaseQueryBuilder()

Get a new query builder instance for the connection.

Return Value

Builder

in Model at line 2041
Model 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

Model

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

Determine if the model has a given scope.

Parameters

string $scope

Return Value

bool

in Model at line 2061
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 2073
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 2096
static protected bool isLegacyScopeMethod(string $scope)

Determine if the given method is a callable legacy local scope.

Parameters

string $scope

Return Value

bool

in Model at line 2123
array toArray()

Convert the model instance to an array.

Return Value

array

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

Convert the model instance to JSON.

Parameters

int $options

Return Value

string

Exceptions

JsonEncodingException

in Model at line 2152
string toPrettyJson(int $options = 0)

Convert the model instance to pretty print formatted JSON.

Parameters

int $options

Return Value

string

Exceptions

JsonEncodingException

in Model at line 2160
mixed jsonSerialize()

Convert the object into something JSON serializable.

Return Value

mixed

in Model at line 2170
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 2187
Model refresh()

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

Return Value

Model

in Model at line 2201
Model refreshForUpdate()

Reload the current model instance with fresh attributes from the database while locking it for updating.

Return Value

Model

in Model at line 2218
protected Model refreshUsingQuery(Builder $query)

Reload the current model instance using the given query.

Parameters

Builder $query

Return Value

Model

in Model at line 2242
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 2271
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 2279
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 2296
bool isNot(Model|null $model)

Determine if two models are not the same.

Parameters

Model|null $model

Return Value

bool

in Model at line 2304
Connection getConnection()

Get the database connection for the model.

Return Value

Connection

in Model at line 2312
string|null getConnectionName()

Get the current connection name for the model.

Return Value

string|null

in Model at line 2322
Model setConnection(UnitEnum|string|null $name)

Set the connection associated with the model.

Parameters

UnitEnum|string|null $name

Return Value

Model

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

Resolve a connection instance.

Parameters

UnitEnum|string|null $connection

Return Value

Connection

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

Get the connection resolver instance.

Return Value

ConnectionResolverInterface|null

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

Set the connection resolver instance.

Boot-only. The resolver persists in a static property for the worker lifetime and is used by every model's connection resolution across all coroutines.

Parameters

ConnectionResolverInterface $resolver

Return Value

void

in Model at line 2364
static void unsetConnectionResolver()

Unset the connection resolver for models.

Tests only. Clears the worker-wide connection resolver shared by every coroutine; concurrent model queries will fail or rebuild.

Return Value

void

in Model at line 2376
static protected mixed resolveClassAttribute(string $attributeClass, string|null $property = null, string|null $class = null)

Resolve an attribute from the model class or its parents.

Parameters

string $attributeClass
string|null $property
string|null $class

Return Value

mixed

in Model at line 2417
static protected bool classDeclaresAttribute(string $attributeClass)

Determine whether a class directly declares an attribute.

Parameters

string $attributeClass

Return Value

bool

in Model at line 2432
static protected string|null classPropertyDeclarer(string $property)

Resolve the nearest class that declares a property.

Parameters

string $property

Return Value

string|null

in AsPivot at line 193
string getTable()

Get the table associated with the model.

Return Value

string

in Model at line 2459
Model setTable(string $table)

Set the table associated with the model.

Parameters

string $table

Return Value

Model

in Model at line 2469
string getKeyName()

Get the primary key for the model.

Return Value

string

in Model at line 2477
Model setKeyName(string $key)

Set the primary key for the model.

Parameters

string $key

Return Value

Model

in Model at line 2489
string getQualifiedKeyName()

Get the table qualified key name.

Return Value

string

in Model at line 2497
string getKeyType()

Get the auto-incrementing key type.

Return Value

string

in Model at line 2505
Model setKeyType(string $type)

Set the data type for the primary key.

Parameters

string $type

Return Value

Model

in Model at line 2517
bool getIncrementing()

Get the value indicating whether the IDs are incrementing.

Return Value

bool

in Model at line 2525
Model setIncrementing(bool $value)

Set whether IDs are incrementing.

Parameters

bool $value

Return Value

Model

in Model at line 2537
mixed getKey()

Get the value of the model's primary key.

Return Value

mixed

in AsPivot at line 303
mixed getQueueableId()

Get the queueable identity for the entity.

Return Value

mixed

Exceptions

MissingAttributeException

in Model at line 2553
array getQueueableRelations()

Get the queueable relationships for the entity.

Return Value

array

in Model at line 2585
string|null getQueueableConnection()

Get the queueable connection for the entity.

Return Value

string|null

in Model at line 2593
mixed getRouteKey()

Get the value of the model's route key.

Return Value

mixed

in Model at line 2601
string getRouteKeyName()

Get the route key for the model.

Return Value

string

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

Retrieve the model for a bound value.

Parameters

mixed $value
string|null $field

Return Value

mixed

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

Retrieve the model for a bound value.

Parameters

mixed $value
string|null $field

Return Value

mixed

in Model at line 2626
mixed 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

mixed

in Model at line 2634
mixed 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

mixed

in Model at line 2644
protected Relation resolveChildRouteBindingQuery(string $childType, mixed $value, string|null $field)

Retrieve the child model query for a bound value.

Parameters

string $childType
mixed $value
string|null $field

Return Value

Relation

in Model at line 2663
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 2676
Builder|Relation 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|Relation

Exceptions

ModelNotFoundException<static>

in Model at line 2692
protected bool isValidIntegerRouteKey(mixed $value)

Determine if the given value could address a row in an integer key column.

Parameters

mixed $value

Return Value

bool

in Model at line 2713
protected never handleInvalidRouteKey(mixed $value, string $field)

Throw an exception for the given invalid route key.

Parameters

mixed $value
string $field

Return Value

never

Exceptions

ModelNotFoundException<static>

in AsPivot at line 209
string getForeignKey()

Get the foreign key column name.

Return Value

string

in Model at line 2729
int getPerPage()

Get the number of models to return per page.

Return Value

int

in Model at line 2737
Model setPerPage(int $perPage)

Set the number of models to return per page.

Parameters

int $perPage

Return Value

Model

in Model at line 2747
static bool isSoftDeletable()

Determine if the model is soft deletable.

Return Value

bool

in Model at line 2755
static bool isPrunable()

Determine if the model is prunable.

Return Value

bool

in Model at line 2763
static bool isMassPrunable()

Determine if the model is mass prunable.

Return Value

bool

in Model at line 2771
static bool preventsLazyLoading()

Determine if lazy loading is disabled.

Return Value

bool

in Model at line 2779
static bool isAutomaticallyEagerLoadingRelationships()

Determine if relationships are being automatically eager loaded when accessed.

Return Value

bool

in Model at line 2787
static bool preventsSilentlyDiscardingAttributes()

Determine if discarding guarded attribute fills is disabled.

Return Value

bool

in Model at line 2795
static bool preventsAccessingMissingAttributes()

Determine if accessing missing attributes is disabled.

Return Value

bool

in Model at line 2803
static bool reportsRouteModelBindingExceptions()

Determine if invalid value exceptions during implicit route model binding should be reported.

Return Value

bool

in Model at line 2811
string broadcastChannelRoute()

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

Return Value

string

in Model at line 2819
string broadcastChannel()

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

Return Value

string

in Model at line 2827
static void flushGuardableColumns()

Flush cached guardable column metadata.

Return Value

void

in Model at line 2844
static void flushState()

Flush all static state.

Return Value

void

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

Dynamically retrieve attributes on the model.

Parameters

string $key

Return Value

mixed

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

Dynamically set attributes on the model.

Parameters

string $key
mixed $value

Return Value

void

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

Determine if the given attribute exists.

Parameters

mixed $offset

Return Value

bool

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

Get the value for a given offset.

Parameters

mixed $offset

Return Value

mixed

in Model at line 2939
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 2949
void offsetUnset(mixed $offset)

Unset the value for a given offset.

Parameters

mixed $offset

Return Value

void

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

Determine if an attribute or relation exists on the model.

Parameters

string $key

Return Value

bool

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

Unset an attribute on the model.

Parameters

string $key

Return Value

void

in Model at line 2980
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 3003
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 3015
string __toString()

Convert the model to its string representation.

Return Value

string

in Model at line 3025
CanBeEscapedWhenCastToString escapeWhenCastingToString(bool $escape = true)

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

Parameters

bool $escape

Return Value

CanBeEscapedWhenCastToString

in Model at line 3037
array __sleep()

Prepare the object for serialization.

Return Value

array

in Model at line 3061
void __wakeup()

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

Return Value

void

in AsPivot at line 44
static AsPivot fromAttributes(Model $parent, array $attributes, string $table, bool $exists = false)

Create a new pivot model instance.

Parameters

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

Return Value

AsPivot

in AsPivot at line 71
static AsPivot fromRawAttributes(Model $parent, array $attributes, string $table, bool $exists = false)

Create a new pivot model from raw values returned from a query.

Parameters

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

Return Value

AsPivot

in AsPivot at line 145
protected Builder getDeleteQuery()

Get the query builder for a delete operation on the pivot.

Return Value

Builder

in AsPivot at line 161
protected Builder applyPivotConstraints(Builder $query)

Apply the relation-owned predicates to a pivot identity query.

Parameters

Builder $query

Return Value

Builder

in AsPivot at line 179
protected mixed getPivotKeyForQuery(string $column)

Get a pivot key for a query.

Parameters

string $column

Return Value

mixed

Exceptions

MissingAttributeException

in AsPivot at line 217
string getRelatedKey()

Get the "related key" column name.

Return Value

string

in AsPivot at line 225
string getOtherKey()

Get the "related key" column name.

Return Value

string

in AsPivot at line 235
AsPivot setPivotKeys(string $foreignKey, string $relatedKey)

Set the key names for the pivot model instance.

Parameters

string $foreignKey
string $relatedKey

Return Value

AsPivot

in AsPivot at line 250
AsPivot setPivotConstraints(array $constraints)

Set the relation-owned predicates for the pivot model.

Parameters

array $constraints

Return Value

AsPivot

in AsPivot at line 262
AsPivot setRelatedModel(Model|null $related = null)

Set the related model of the relationship.

Parameters

Model|null $related

Return Value

AsPivot

in AsPivot at line 272
bool hasTimestampAttributes(array|null $attributes = null)

Determine if the pivot model or given attributes has timestamp attributes.

Parameters

array|null $attributes

Return Value

bool

in AsPivot at line 346
protected Builder newQueryForCollectionRestoration(array $ids)

Get a new query to restore multiple models by their queueable IDs.

Parameters

array $ids

Return Value

Builder