HasAttributes
trait HasAttributes (View source)
Свойства
| protected array | $attributes | Атрибуты модели. | |
| protected array | $original | Исходное состояние атрибутов модели. | |
| protected array | $changes | Измененные атрибуты модели. | |
| protected array | $casts | Атрибуты, которые должны быть преобразованы к собственным типам. | |
| protected array | $dates | Атрибуты, которые должны быть преобразованы в даты. | |
| protected string | $dateFormat | Формат хранения столбцов дат модели. | |
| protected array | $appends | Доступ к атрибутам для добавления в массив модели. | |
| static bool | $snakeAttributes | Указывает, преобразуются ли атрибуты в нижний регистр с дефисами в массивах. | |
| static protected array | $mutatorCache | Кэш мутированных атрибутов для каждого класса. |
Методы
| массив | attributesToArray() Преобразовать атрибуты модели в массив. | |
| массив | addDateAttributesToArray(массив $attributes) Добавить атрибуты даты в массив атрибутов. | |
| массив | addMutatedAttributesToArray(массив $attributes, массив $mutatedAttributes) Добавить измененные атрибуты в массив атрибутов. | |
| массив | addCastAttributesToArray(массив $attributes, массив $mutatedAttributes) Добавить атрибуты с преобразованием в массив атрибутов. | |
| массив | getArrayableAttributes() Получить массив атрибутов, пригодных для преобразования в массив. | |
| массив | getArrayableAppends() Получить все добавляемые значения, пригодные для преобразования в массив. | |
| массив | relationsToArray() Получить отношения модели в виде массива. | |
| массив | getArrayableRelations() Получить массив отношений, пригодных для преобразования в массив. | |
| массив | getArrayableItems(массив $values) Получить массив значений, пригодных для преобразования в массив. | |
| смешанное | getAttribute(строка $key) Получить атрибут из модели. | |
| смешанное | getAttributeValue(строка $key) Получить простой атрибут (не отношение). | |
| смешанное | getAttributeFromArray(строка $key) Получить атрибут из массива $attributes. | |
| смешанное | getRelationValue(строка $key) Получить отношение. | |
| смешанное | getRelationshipFromMethod(строка $method) Получить значение отношения из метода. | |
| булево | hasGetMutator(строка $key) Определить, существует ли мутатор для получения атрибута. | |
| смешанное | mutateAttribute(строка $key, смешанное $value) Получить значение атрибута с использованием его мутатора. | |
| смешанное | mutateAttributeForArray(строка $key, смешанное $value) Получить значение атрибута с использованием его мутатора для преобразования в массив. | |
| смешанное | castAttribute(строка $key, смешанное $value) Преобразовать атрибут к базовому типу PHP. | |
| строка | getCastType(строка $key) Получить тип преобразования для атрибута модели. | |
| булево | isCustomDateTimeCast(строка $cast) Определить, является ли тип преобразования пользовательским преобразованием даты и времени. | |
| смешанное | setAttribute(строка $key, смешанное $value) Установить заданный атрибут в модели. | |
| булево | hasSetMutator(строка $key) Определить, существует ли мутатор для установки атрибута. | |
| смешанное | setMutatedAttributeValue(строка $key, смешанное $value) Установить значение атрибута с использованием его мутатора. | |
| булево | isDateAttribute(строка $key) Определить, является ли заданный атрибут датой или датой, подлежащей преобразованию. | |
| $this | fillJsonAttribute(строка $key, смешанное $value) Установить заданный JSON-атрибут в модели. | |
| $this | getArrayAttributeWithValue(строка $path, строка $key, смешанное $value) Получить атрибут-массив с заданным ключом и установленным значением. | |
| массив | getArrayAttributeByKey(строка $key) Получить атрибут-массив или вернуть пустой массив, если он не задан. | |
| строка | castAttributeAsJson(строка $key, смешанное $value) Преобразовать заданный атрибут в JSON. | |
| строка | asJson(смешанное $value) Кодировать данное значение как JSON. | |
| смешанное | fromJson(строка $value, булево $asObject = false) Декодировать заданный JSON в массив или объект. | |
| Carbon | asDate(смешанное $value) Возвратить отметку времени как объект DateTime с временем, установленным в 00:00:00. | |
| Carbon | asDateTime(смешанное $value) Возвратить отметку времени как объект DateTime. | |
| булево | isStandardDateFormat(строка $value) Определить, соответствует ли данное значение стандартному формату даты. | |
| строка | fromDateTime(DateTime|целое $value) Преобразовать DateTime в хранимую строку. | |
| целое | asTimestamp(смешанное $value) Возвратить отметку времени как Unix-метку времени. | |
| строка | serializeDate(DateTimeInterface $date) Подготовить дату для сериализации в массив / JSON. | |
| массив | getDates() Получить атрибуты, которые должны быть преобразованы в даты. | |
| строка | getDateFormat() Получить формат для дат, хранящихся в базе данных. | |
| $this | setDateFormat(строка $format) Установить формат даты, используемый моделью. | |
| булево | hasCast(строка $key, массив|строка|null $types = null) Определить, должен ли атрибут быть преобразован в базовый тип. | |
| массив | getCasts() Получить массив преобразований. | |
| булево | isDateCastable(строка $key) Определить, может ли значение быть преобразовано в дату/DateTime для входной обработки. | |
| булево | isJsonCastable(строка $key) Определить, может ли значение быть преобразовано в JSON для входной обработки. | |
| массив | getAttributes() Получить все текущие атрибуты модели. | |
| $this | setRawAttributes(массив $attributes, булево $sync = false) Установить массив атрибутов модели. Проверка не выполняется. | |
| смешанное|массив | getOriginal(строка|null $key = null, смешанное $default = null) Получить исходные значения атрибутов модели. |
| array | только(array|mixed $attributes) Получить подмножество атрибутов модели. | |
| $this | syncOriginal() Синхронизировать исходные атрибуты с текущими. | |
| $this | syncOriginalAttribute(string $attribute) Синхронизировать один исходный атрибут со значением текущего. | |
| $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)
Определить, существует ли мутатор get для атрибута.
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)
Определить, является ли тип преобразования пользовательским преобразованием даты и времени.
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 обратно в массив или объект.
protected Carbon asDate(mixed $value)
Возвращает временную метку как объект DateTime с временем, установленным в 00:00:00.
protected Carbon asDateTime(mixed $value)
Возвращает временную метку как объект DateTime.
protected bool isStandardDateFormat(string $value)
Определить, соответствует ли заданное значение стандартному формату даты.
string fromDateTime(DateTime|int $value)
Преобразовать DateTime в хранимую строку.
protected int asTimestamp(mixed $value)
Возвращает временную метку как Unix-временную метку.
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 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()
Получить атрибуты, которые были изменены.
protected 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/5.6/Illuminate/Database/Eloquent/Concerns/HasAttributes.html
