HasAttributes
trait HasAttributes (View source)
Свойства
| protected массив | $attributes | Атрибуты модели. | |
| protected массив | $original | Исходное состояние атрибутов модели. | |
| protected массив | $changes | Изменённые атрибуты модели. | |
| protected массив | $casts | Атрибуты, которые должны быть преобразованы в базовые типы. | |
| protected массив | $dates | Атрибуты, которые должны быть преобразованы в даты. | |
| protected строка | $dateFormat | Формат хранения столбцов с датами модели. | |
| protected массив | $appends | Методы доступа для добавления к массиву модели. | |
| static bool | $snakeAttributes | Указывает, преобразуются ли атрибуты в snake_case в массивах. | |
| static protected массив | $mutatorCache | Кэш изменённых атрибутов для каждого класса. |
Методы
| массив | attributesToArray()
Преобразовать атрибуты модели в массив. | |
| массив | addDateAttributesToArray(array $attributes)
Добавить атрибуты даты в массив атрибутов. | |
| массив | addMutatedAttributesToArray(array $attributes, array $mutatedAttributes)
Добавить изменённые атрибуты в массив атрибутов. | |
| массив | addCastAttributesToArray(array $attributes, array $mutatedAttributes)
Добавить преобразованные атрибуты в массив атрибутов. | |
| массив | getArrayableAttributes()
Получить массив всех преобразуемых в массив атрибутов. | |
| массив | getArrayableAppends()
Получить все значения, которые добавляются и преобразуются в массив. | |
| массив | relationsToArray()
Получить связи модели в виде массива. | |
| массив | getArrayableRelations()
Получить массив всех преобразуемых в массив связей. | |
| массив | getArrayableItems(array $values)
Получить массив всех преобразуемых в массив значений. | |
| смешанный | getAttribute(string $key)
Получить атрибут из модели. | |
| смешанный | getAttributeValue(string $key)
Получить обычный атрибут (не связь). | |
| смешанный | getAttributeFromArray(string $key)
Получить атрибут из массива $attributes. | |
| смешанный | getRelationValue(string $key)
Получить связь. | |
| смешанный | getRelationshipFromMethod(string $method)
Получить значение связи из метода. | |
| булево | hasGetMutator(string $key)
Определить, существует ли мутатор get для атрибута. | |
| смешанный | mutateAttribute(string $key, mixed $value)
Получить значение атрибута, используя его мутатор. | |
| смешанный | mutateAttributeForArray(string $key, mixed $value)
Получить значение атрибута, используя его мутатор для преобразования в массив. | |
| смешанный | castAttribute(string $key, mixed $value)
Преобразовать атрибут к собственному типу PHP. | |
| строка | getCastType(string $key)
Получить тип преобразования для атрибута модели. | |
| булево | isCustomDateTimeCast(string $cast)
Определить, является ли тип преобразования пользовательским преобразованием даты и времени. | |
| булево | isDecimalCast(string $cast)
Определить, является ли тип преобразования преобразованием десятичного числа. | |
| смешанный | setAttribute(string $key, mixed $value)
Установить заданный атрибут в модели. | |
| булево | hasSetMutator(string $key)
Определить, существует ли мутатор set для атрибута. | |
| смешанный | setMutatedAttributeValue(string $key, mixed $value)
Установить значение атрибута, используя его мутатор. | |
| булево | isDateAttribute(string $key)
Определить, является ли заданный атрибут датой или преобразуемым в дату. | |
| $this | fillJsonAttribute(string $key, mixed $value)
Установить заданный JSON атрибут в модели. | |
| $this | getArrayAttributeWithValue(string $path, string $key, mixed $value)
Получить атрибут массива с заданным ключом и установленным значением. | |
| массив | getArrayAttributeByKey(string $key)
Получить атрибут массива или вернуть пустой массив, если он не задан. | |
| строка | castAttributeAsJson(string $key, mixed $value)
Преобразовать заданный атрибут в JSON. | |
| строка | asJson(mixed $value)
Кодировать заданное значение в JSON. | |
| смешанный | fromJson(string $value, bool $asObject = false)
Декодировать заданный JSON в массив или объект. | |
| смешанный | fromFloat(mixed $value)
Декодировать заданное число с плавающей точкой. | |
| строка | asDecimal(float $value, int $decimals)
Возвратить десятичное число как строку. | |
| Carbon | asDate(mixed $value)
Возвратить отметку времени как объект DateTime с временем, установленным в 00:00:00. | |
| Carbon | asDateTime(mixed $value)
Возвратить отметку времени как объект DateTime. | |
| булево | isStandardDateFormat(string $value)
Определить, соответствует ли заданное значение стандартному формату даты. | |
| строка|null | fromDateTime(mixed $value)
Преобразовать DateTime в хранимую строку. | |
| целое число | asTimestamp(mixed $value)
Возвратить отметку времени как метку времени Unix. | |
| строка | serializeDate(DateTimeInterface $date)
Подготовить дату для сериализации в массив/JSON. | |
| массив | getDates()
Получить атрибуты, которые должны быть преобразованы в даты. | |
| строка | getDateFormat()
Получить формат для дат, хранящихся в базе данных. | |
| $this | setDateFormat(string $format)
Установить формат даты, используемый моделью. | |
| булево | hasCast(string $key, array|string|null $types = null)
Определить, должен ли атрибут быть преобразован в базовый тип. | |
| массив | getCasts()
Получить массив преобразований. | |
| булево | isDateCastable(string $key)
Определить, является ли значение преобразуемым в дату/DateTime для входных манипуляций. | |
| булево | isJsonCastable(string $key)
Определить, является ли значение преобразуемым в JSON для входных манипуляций. | |
| массив | getAttributes()
Получить все текущие атрибуты модели. |
| $this | setRawAttributes(array $attributes, bool $sync = false)
Установить массив атрибутов модели. Проверка не выполняется. | |
| mixed|array | getOriginal(string|null $key = null, mixed $default = null)
Получить исходные значения атрибутов модели. | |
| array | only(array|mixed $attributes)
Получить подмножество атрибутов модели. | |
| $this | syncOriginal()
Синхронизировать исходные атрибуты с текущими. | |
| $this | syncOriginalAttribute(string $attribute)
Синхронизировать один исходный атрибут со значением текущим. | |
| $this | syncOriginalAttributes(array|string $attributes)
Синхронизировать несколько исходных атрибутов со значениями текущими. | |
| $this | syncChanges()
Синхронизировать измененные атрибуты. | |
| bool | isDirty(array|string|null $attributes = null)
Определить, была ли модель или какой-либо из заданных атрибутов изменены. | |
| bool | isClean(array|string|null $attributes = null)
Определить, осталась ли модель и все заданные атрибуты неизменными. | |
| bool | wasChanged(array|string|null $attributes = null)
Определить, была ли модель или какой-либо из заданных атрибутов изменены. | |
| bool | hasChanges(array $changes, array|string|null $attributes = null)
Определить, были ли изменены какие-либо из заданных атрибутов. | |
| array | getDirty()
Получить атрибуты, которые были изменены с момента последней синхронизации. | |
| array | getChanges()
Получить атрибуты, которые были изменены. | |
| bool | originalIsEquivalent(string $key, mixed $current)
Определить, эквивалентны ли новые и старые значения для заданного ключа. | |
| $this | append(array|string $attributes)
Добавить атрибуты к запросу при построении запроса. | |
| $this | setAppends(array $appends)
Установить аксессоры для добавления к массивам моделей. | |
| array | getMutatedAttributes()
Получить измененные атрибуты для данного экземпляра. | |
| static void | cacheMutatedAttributes(string $class)
Извлечь и кэшировать все измененные атрибуты класса. | |
| static array | getMutatorMethods(mixed $class)
Получить все методы мутаторов атрибутов. |
Подробности
array attributesToArray()
Преобразовать атрибуты модели в массив.
protected array addDateAttributesToArray(array $attributes)
Добавить атрибуты даты в массив атрибутов.
protected array addMutatedAttributesToArray(array $attributes, array $mutatedAttributes)
Добавить измененные атрибуты в массив атрибутов.
protected array addCastAttributesToArray(array $attributes, array $mutatedAttributes)
Добавить атрибуты с преобразованием в массив атрибутов.
protected array getArrayableAttributes()
Получить массив атрибутов, которые можно преобразовать в массив.
protected array getArrayableAppends()
Получить все значения для добавления, которые можно преобразовать в массив.
array relationsToArray()
Получить отношения модели в формате массива.
protected array getArrayableRelations()
Получить массив атрибутов всех преобразуемых отношений.
protected array getArrayableItems(array $values)
Получить массив атрибутов всех преобразуемых значений.
mixed getAttribute(string $key)
Получить атрибут из модели.
mixed getAttributeValue(string $key)
Получить простой атрибут (не отношение).
protected mixed getAttributeFromArray(string $key)
Получить атрибут из массива $attributes.
mixed getRelationValue(string $key)
Получить отношение.
protected mixed getRelationshipFromMethod(string $method)
Получить значение отношения из метода.
bool hasGetMutator(string $key)
Определить, существует ли мутатор получения для атрибута.
protected mixed mutateAttribute(string $key, mixed $value)
Получить значение атрибута с помощью его мутатора.
protected mixed mutateAttributeForArray(string $key, mixed $value)
Получить значение атрибута с помощью его мутатора для преобразования в массив.
protected mixed castAttribute(string $key, mixed $value)
Преобразовать атрибут в базовый тип PHP.
protected string getCastType(string $key)
Получить тип преобразования для атрибута модели.
protected bool isCustomDateTimeCast(string $cast)
Определить, является ли тип преобразования пользовательским преобразованием даты и времени.
protected bool isDecimalCast(string $cast)
Определить, является ли тип преобразования десятичным преобразованием.
mixed setAttribute(string $key, mixed $value)
Установить заданный атрибут в модели.
bool hasSetMutator(string $key)
Определить, существует ли мутатор установки для атрибута.
protected mixed setMutatedAttributeValue(string $key, mixed $value)
Установить значение атрибута с помощью его мутатора.
protected bool isDateAttribute(string $key)
Определить, является ли заданный атрибут датой или допускает преобразование в дату.
$this fillJsonAttribute(string $key, mixed $value)
Установить заданный JSON атрибут в модели.
protected $this getArrayAttributeWithValue(string $path, string $key, mixed $value)
Получить атрибут массива с заданным ключом и установленным значением.
protected array getArrayAttributeByKey(string $key)
Получить атрибут массива или вернуть пустой массив, если он не задан.
protected string castAttributeAsJson(string $key, mixed $value)
Преобразовать заданный атрибут в JSON.
protected string asJson(mixed $value)
Кодировать заданное значение как JSON.
mixed fromJson(string $value, bool $asObject = false)
Декодировать заданный JSON обратно в массив или объект.
mixed fromFloat(mixed $value)
Декодировать заданное значение с плавающей точкой.
protected string asDecimal(float $value, int $decimals)
Вернуть десятичное значение в виде строки.
protected Carbon asDate(mixed $value)
Вернуть временную метку как объект DateTime с временем, установленным в 00:00:00.
protected Carbon asDateTime(mixed $value)
Вернуть временную метку как объект DateTime.
protected bool isStandardDateFormat(string $value)
Определить, соответствует ли заданное значение стандартному формату даты.
string|null fromDateTime(mixed $value)
Преобразовать DateTime в хранимую строку.
protected int asTimestamp(mixed $value)
Возвратить метку времени как Unix timestamp.
protected string serializeDate(DateTimeInterface $date)
Подготовить дату для сериализации в массив/JSON.
array getDates()
Получить атрибуты, которые должны быть преобразованы в даты.
string getDateFormat()
Получить формат дат, хранимых в базе данных.
$this setDateFormat(string $format)
Установить формат даты, используемый моделью.
bool hasCast(string $key, array|string|null $types = null)
Определить, должен ли атрибут быть преобразован в базовый тип.
array getCasts()
Получить массив преобразований.
protected bool isDateCastable(string $key)
Определить, можно ли преобразовать значение в Date / DateTime для входящих манипуляций.
protected bool isJsonCastable(string $key)
Определить, можно ли преобразовать значение в JSON для входящих манипуляций.
array getAttributes()
Получить все текущие атрибуты модели.
$this setRawAttributes(array $attributes, bool $sync = false)
Установить массив атрибутов модели. Проверка не выполняется.
mixed|array getOriginal(string|null $key = null, mixed $default = null)
Получить исходные значения атрибутов модели.
array only(array|mixed $attributes)
Получить подмножество атрибутов модели.
$this syncOriginal()
Синхронизировать исходные атрибуты с текущими.
$this syncOriginalAttribute(string $attribute)
Синхронизировать один исходный атрибут со своим текущим значением.
$this syncOriginalAttributes(array|string $attributes)
Синхронизировать несколько исходных атрибутов со своими текущими значениями.
$this syncChanges()
Синхронизировать измененные атрибуты.
bool isDirty(array|string|null $attributes = null)
Определить, была ли модель или какой-либо из заданных атрибутов изменен.
bool isClean(array|string|null $attributes = null)
Определить, осталась ли модель и все заданные атрибуты неизменными.
bool wasChanged(array|string|null $attributes = null)
Определить, была ли модель или какой-либо из заданных атрибутов изменен.
protected bool hasChanges(array $changes, array|string|null $attributes = null)
Определить, были ли изменены какие-либо из заданных атрибутов.
array getDirty()
Получить атрибуты, изменённые с момента последней синхронизации.
array getChanges()
Получить изменённые атрибуты.
bool originalIsEquivalent(string $key, mixed $current)
Определить, эквивалентны ли новые и старые значения для заданного ключа.
$this append(array|string $attributes)
Добавить атрибуты к запросу при построении запроса.
$this setAppends(array $appends)
Установить аксессоры для добавления в массивы моделей.
array getMutatedAttributes()
Получить изменённые атрибуты для данного экземпляра.
static void cacheMutatedAttributes(string $class)
Извлечь и кэшировать все изменённые атрибуты класса.
static protected array getMutatorMethods(mixed $class)
Получить все методы мутаторов атрибутов.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/6.x/Illuminate/Database/Eloquent/Concerns/HasAttributes.html
