Trait Illuminate\Database\Eloquent\Concerns\HasAttributes


					
	protected

initializeHasAttributes(): void

Initialize the trait.

#


					
	public

attributesToArray(): array

Convert the model's attributes to an array.

#


					
	protected

addDateAttributesToArray(array $attributes): array

Add the date attributes to the attributes array.

#


					
	protected

addMutatedAttributesToArray(array $attributes, array $mutatedAttributes): array

Add the mutated attributes to the attributes array.

#


					
	protected

addCastAttributesToArray(array $attributes, array $mutatedAttributes): array

Add the casted attributes to the attributes array.

#


					
	protected

getArrayableAttributes(): array

Get an attribute array of all arrayable attributes.

#


					
	protected

getArrayableAppends(): array

Get all of the appendable values that are arrayable.

#


					
	public

relationsToArray(): array

Get the model's relationships in array form.

#


					
	protected

getArrayableRelations(): array

Get an attribute array of all arrayable relations.

#


					
	protected

getArrayableItems(array $values): array

Get an attribute array of all arrayable values.

#


					
	public

hasAttribute(string $key): bool

Determine whether an attribute exists on the model.

#


					
	public

getAttribute(string $key): mixed

Get an attribute from the model.

#


					
	protected

throwMissingAttributeExceptionIfApplicable(string $key): null

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

Throws

Illuminate\Database\Eloquent\MissingAttributeException

#


					
	public

getAttributeValue(string $key): mixed

Get a plain attribute (not a relationship).

#


					
	protected

getAttributeFromArray(string $key): mixed

Get an attribute from the $attributes array.

#


					
	public

getRelationValue(string $key): mixed

Get a relationship.

#


					
	public

isRelation(string $key): bool

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

#


					
	protected

handleLazyLoadingViolation(string $key): mixed

Handle a lazy loading violation.

#


					
	protected

getRelationshipFromMethod(string $method): mixed

Get a relationship value from a method.

Throws

LogicException

#


					
	public

hasGetMutator(string $key): bool

Determine if a get mutator exists for an attribute.

#


					
	public

hasAttributeMutator(string $key): bool

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

#


					
	public

hasAttributeGetMutator(string $key): bool

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

#


					
	public

hasAnyGetMutator(string $key): bool

Determine if any get mutator exists for an attribute.

#


					
	protected

mutateAttribute(string $key, mixed $value): mixed

Get the value of an attribute using its mutator.

#


					
	protected

mutateAttributeMarkedAttribute(string $key, mixed $value): mixed

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

#


					
	protected

mutateAttributeForArray(string $key, mixed $value): mixed

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

#


					
	public

mergeCasts(array $casts): $this

Merge new casts with existing casts on the model.

#


					
	protected

ensureCastsAreStringValues(array $casts): array

Ensure that the given casts are strings.

#


					
	protected

castAttribute(string $key, mixed $value): mixed

Cast an attribute to a native PHP type.

#


					
	protected

getClassCastableAttributeValue(string $key, mixed $value): mixed

Cast the given attribute using a custom cast class.

#


					
	protected

getEnumCastableAttributeValue(string $key, mixed $value): mixed

Cast the given attribute to an enum.

#


					
	protected

getCastType(string $key): string

Get the type of cast for a model attribute.

#


					
	protected

deviateClassCastableAttribute(string $method, string $key, mixed $value): mixed

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

#


					
	protected

serializeClassCastableAttribute(string $key, mixed $value): mixed

Serialize the given attribute using the custom cast class.

#


					
	protected

isCustomDateTimeCast(string $cast): bool

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

#


					
	protected

isImmutableCustomDateTimeCast(string $cast): bool

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

#


					
	protected

isDecimalCast(string $cast): bool

Determine if the cast type is a decimal cast.

#


					
	public

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

Set a given attribute on the model.

#


					
	public

hasSetMutator(string $key): bool

Determine if a set mutator exists for an attribute.

#


					
	public

hasAttributeSetMutator(string $key): bool

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

#


					
	protected

setMutatedAttributeValue(string $key, mixed $value): mixed

Set the value of an attribute using its mutator.

#


					
	protected

setAttributeMarkedMutatedAttributeValue(string $key, mixed $value): mixed

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

#


					
	protected

isDateAttribute(string $key): bool

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

#


					
	public

fillJsonAttribute(string $key, mixed $value): $this

Set a given JSON attribute on the model.

#


					
	protected

setClassCastableAttribute(string $key, mixed $value): void

Set the value of a class castable attribute.

#


					
	protected

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

Set the value of an enum castable attribute.

#


					
	protected

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

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

#


					
	protected

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

Get the storable value from the given enum.

#


					
	protected

getArrayAttributeWithValue(string $path, string $key, mixed $value): $this

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

#


					
	protected

getArrayAttributeByKey(string $key): array

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

#


					
	protected

castAttributeAsJson(string $key, mixed $value): string

Cast the given attribute to JSON.

#


					
	protected

getJsonCastFlags(string $key): int

Get the JSON casting flags for the given attribute.

#


					
	protected

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

Encode the given value as JSON.

#


					
	public

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

Decode the given JSON back into an array or object.

#


					
	public

fromEncryptedString(string $value): mixed

Decrypt the given encrypted string.

#


					
	protected

castAttributeAsEncryptedString(string $key, mixed $value): string

Cast the given attribute to an encrypted string.

#


					
	public
					static

encryptUsing(Encrypter|null $encrypter): void

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

#


					
	protected
					static

currentEncrypter(): Encrypter

Get the current encrypter being used by the model.

#


					
	protected

castAttributeAsHashedString(string $key, mixed $value): string

Cast the given attribute to a hashed string.

#


					
	public

fromFloat(mixed $value): mixed

Decode the given float.

#


					
	protected

asDecimal(float|string $value, int $decimals): string

Return a decimal as string.

#


					
	protected

asDate(mixed $value): Carbon

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

#


					
	protected

asDateTime(mixed $value): Carbon

Return a timestamp as DateTime object.

#


					
	protected

isStandardDateFormat(string $value): bool

Determine if the given value is a standard date format.

#


					
	public

fromDateTime(mixed $value): string|null

Convert a DateTime to a storable string.

#


					
	protected

asTimestamp(mixed $value): int

Return a timestamp as unix timestamp.

#


					
	protected

serializeDate(DateTimeInterface $date): string

Prepare a date for array / JSON serialization.

#


					
	public

getDates(): array

Get the attributes that should be converted to dates.

#


					
	public

getDateFormat(): string

Get the format for database stored dates.

#


					
	public

setDateFormat(string $format): $this

Set the date format used by the model.

#


					
	public

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

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

#


					
	public

getCasts(): array

Get the attributes that should be cast.

#


					
	protected

casts(): array<string, string>

Get the attributes that should be cast.

#


					
	protected

isDateCastable(string $key): bool

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

#


					
	protected

isDateCastableWithCustomFormat(string $key): bool

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

#


					
	protected

isJsonCastable(string $key): bool

Determine whether a value is JSON castable for inbound manipulation.

#


					
	protected

isEncryptedCastable(string $key): bool

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

#


					
	protected

isClassCastable(string $key): bool

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

Throws

Illuminate\Database\Eloquent\InvalidCastException

#


					
	protected

isEnumCastable(string $key): bool

Determine if the given key is cast using an enum.

#


					
	protected

isClassDeviable(string $key): bool

Determine if the key is deviable using a custom class.

Throws

Illuminate\Database\Eloquent\InvalidCastException

#


					
	protected

isClassSerializable(string $key): bool

Determine if the key is serializable using a custom class.

Throws

Illuminate\Database\Eloquent\InvalidCastException

#


					
	protected

resolveCasterClass(string $key): mixed

Resolve the custom caster class for a given key.

#


					
	protected

parseCasterClass(string $class): string

Parse the given caster class, removing any arguments.

#


					
	protected

mergeAttributesFromCachedCasts(): void

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

#


					
	protected

mergeAttributesFromClassCasts(): void

Merge the cast class attributes back into the model.

#


					
	protected

mergeAttributesFromAttributeCasts(): void

Merge the cast class attributes back into the model.

#


					
	protected

normalizeCastClassResponse(string $key, mixed $value): array

Normalize the response from a custom class caster.

#


					
	public

getAttributes(): array<string, mixed>

Get all of the current attributes on the model.

#


					
	protected

getAttributesForInsert(): array

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

#


					
	public

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

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

#


					
	public

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

Get the model's original attribute values.

#


					
	protected

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

Get the model's original attribute values.

#


					
	public

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

Get the model's raw original attribute values.

#


					
	public

only(array|mixed $attributes): array

Get a subset of the model's attributes.

#


					
	public

syncOriginal(): $this

Sync the original attributes with the current.

#


					
	public

syncOriginalAttribute(string $attribute): $this

Sync a single original attribute with its current value.

#


					
	public

syncOriginalAttributes(array|string $attributes): $this

Sync multiple original attribute with their current values.

#


					
	public

syncChanges(): $this

Sync the changed attributes.

#


					
	public

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

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

#


					
	public

isClean(array|string|null $attributes = null): bool

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

#


					
	public

discardChanges(): $this

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

#


					
	public

wasChanged(array|string|null $attributes = null): bool

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

#


					
	protected

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

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

#


					
	public

getDirty(): array

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

#


					
	protected

getDirtyForUpdate(): array

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

#


					
	public

getChanges(): array

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

#


					
	public

originalIsEquivalent(string $key): bool

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

#


					
	protected

transformModelValue(string $key, mixed $value): mixed

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

#


					
	public

append(array|string $attributes): $this

Append attributes to query when building a query.

#


					
	public

getAppends(): array

Get the accessors that are being appended to model arrays.

#


					
	public

setAppends(array $appends): $this

Set the accessors to append to model arrays.

#


					
	public

hasAppended(string $attribute): bool

Return whether the accessor attribute has been appended.

#


					
	public

getMutatedAttributes(): array

Get the mutated attributes for a given instance.

#


					
	public
					static

cacheMutatedAttributes(object|string $classOrInstance): void

Extract and cache all the mutated attributes of a class.

#


					
	protected
					static

getMutatorMethods(mixed $class): array

Get all of the attribute mutator methods.

#


					
	protected
					static

getAttributeMarkedMutatorMethods(mixed $class): array

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

#

Properties
`protected`	`array`	`$attributes = []`	#
`protected`	`array`	`$original = []`	#
`protected`	`array`	`$changes = []`	#
`protected`	`array`	`$casts = []`	#
`protected`	`array`	`$classCastCache = []`	#
`protected`	`array`	`$attributeCastCache = []`	#
`protected static`	`string[]`	`$primitiveCastTypes = [ 'array', 'bool', 'boolean', 'collection', 'custom_datetime', 'date', 'datetime', 'decimal', 'double', 'encrypted', 'encrypted:array', 'encrypted:collection', 'encrypted:json', 'encrypted:object', 'float', 'hashed', 'immutable_date', 'immutable_datetime', 'immutable_custom_datetime', 'int', 'integer', 'json', 'json:unicode', 'object', 'real', 'string', 'timestamp', ]`	#
`protected`	`string\|null`	`$dateFormat`	#
`protected`	`array`	`$appends = []`	#
`public static`	`bool`	`$snakeAttributes = true`	#
`protected static`	`array`	`$mutatorCache = []`	#
`protected static`	`array`	`$attributeMutatorCache = []`	#
`protected static`	`array`	`$getAttributeMutatorCache = []`	#
`protected static`	`array`	`$setAttributeMutatorCache = []`	#
`protected static`	`array`	`$castTypeCache = []`	#
`public static`	`Encrypter\|null`	`$encrypter`	#

Namespaces

Traits

Trait Illuminate\Database\Eloquent\Concerns\HasAttributes

Throws

Throws

Throws

Throws

Throws