HasAttributes
trait HasAttributes (View source)
Свойства
| protected массив | $attributes | Атрибуты модели. | |
| protected массив | $original | Исходное состояние атрибутов модели. | |
| protected массив | $changes | Измененные атрибуты модели. | |
| protected массив | $casts | Атрибуты, которые должны быть преобразованы в базовые типы. | |
| protected массив | $dates | Атрибуты, которые должны быть преобразованны в даты. | |
| protected строка | $dateFormat | Формат хранения столбцов дат модели. | |
| protected массив | $appends | Методы доступа для добавления в массив модели. | |
| static bool | $snakeAttributes | Указывает, преобразуются ли атрибуты в нижний регистр с дефисами в массивах. | |
| static protected массив | $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) Определить, является ли тип преобразования пользовательским типом преобразования даты и времени. | |
| логическое значение | isDecimalCast(строка $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 обратно в массив или объект. | |
| смешанный тип | fromFloat(смешанный тип $value) Декодировать заданное число с плавающей запятой. | |
| строка | asDecimal(число с плавающей запятой $value, целое число $decimals) Вернуть десятичное число как строку. | |
| Carbon | asDate(смешанный тип $value) Вернуть отметку времени как объект DateTime с временем, установленным в 00:00:00. | |
| Carbon | asDateTime(смешанный тип $value) Вернуть отметку времени как объект DateTime. | |
| логическое значение | isStandardDateFormat(строка $value) Определить, является ли заданное значение стандартным форматом даты. | |
| строка|null | fromDateTime(смешанный тип $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(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.
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)
Определить, можно ли преобразовать значение в дату/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/5.8/Illuminate/Database/Eloquent/Concerns/HasAttributes.html
