Spec-Zone.ru › Laravel 5.4

HasAttributes

trait HasAttributes (View source)

Свойства

protected array $attributes Атрибуты модели.
protected array $original Исходное состояние атрибутов модели.
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)

Получить тип преобразования для атрибута модели.

$this setAttribute(строка $key, смешанный $value)

Установить заданный атрибут модели.

логическое hasSetMutator(строка $key)

Определить, существует ли мутатор для установки атрибута.

логическое 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)

Получить исходные значения атрибутов модели.

$this syncOriginal()

Синхронизировать исходные атрибуты с текущими.

$this syncOriginalAttribute(строка $attribute)

Синхронизировать отдельный исходный атрибут со своим текущим значением.

логическое isDirty(массив|строка|null $attributes = null)

Определить, была ли изменена модель или заданный(ые) атрибут(ы).

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

Определить, остались ли модель или указанные атрибуты неизменными.

array getDirty()

Получить атрибуты, изменённые с момента последней синхронизации.

bool originalIsNumericallyEquivalent(string $key)

Определить, равны ли новые и старые значения для данного ключа численно.

$this append(array|string $attributes)

Добавить атрибуты к запросу при построении запроса.

$this setAppends(array $appends)

Установить аксессоры для добавления в массивы модели.

array getMutatedAttributes()

Получить изменённые атрибуты для данного экземпляра.

static void cacheMutatedAttributes(string $class)

Извлечь и кэшировать все изменённые атрибуты класса.

static array getMutatorMethods(mixed $class)

Получить все методы мутаторов атрибутов.

Подробности

array attributesToArray()

Преобразовать атрибуты модели в массив.

Возвращаемое значение

array

protected array addDateAttributesToArray(array $attributes)

Добавить атрибуты даты в массив атрибутов.

Параметры

array $attributes

Возвращаемое значение

array

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

Добавить изменённые атрибуты в массив атрибутов.

Параметры

array $attributes
array $mutatedAttributes

Возвращаемое значение

array

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

Добавить атрибуты, преобразованные к типу, в массив атрибутов.

Параметры

array $attributes
array $mutatedAttributes

Возвращаемое значение

array

protected array getArrayableAttributes()

Получить массив атрибутов, приводимых к массиву.

Возвращаемое значение

array

protected array getArrayableAppends()

Получить все значения для добавления, приводимые к массиву.

Возвращаемое значение

array

array relationsToArray()

Получить отношения модели в виде массива.

Возвращаемое значение

array

protected array getArrayableRelations()

Получить массив всех отношений, приводимых к массиву.

Возвращаемое значение

array

protected array getArrayableItems(array $values)

Получить массив всех значений, приводимых к массиву.

Параметры

array $values

Возвращаемое значение

array

mixed getAttribute(string $key)

Получить атрибут из модели.

Параметры

string $key

Возвращаемое значение

mixed

mixed getAttributeValue(string $key)

Получить простой атрибут (не отношение).

Параметры

string $key

Возвращаемое значение

mixed

protected mixed getAttributeFromArray(string $key)

Получить атрибут из массива $attributes.

Параметры

string $key

Возвращаемое значение

mixed

mixed getRelationValue(string $key)

Получить отношение.

Параметры

string $key

Возвращаемое значение

mixed

protected mixed getRelationshipFromMethod(string $method)

Получить значение отношения из метода.

Параметры

string $method

Возвращаемое значение

mixed

Исключения

LogicException

bool hasGetMutator(string $key)

Определить, существует ли мутатор get для атрибута.

Параметры

string $key

Возвращаемое значение

bool

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

Получить значение атрибута, используя его мутатор.

Параметры

string $key
mixed $value

Возвращаемое значение

mixed

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

Получить значение атрибута, используя его мутатор для преобразования в массив.

Параметры

string $key
mixed $value

Возвращаемое значение

mixed

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

Преобразовать атрибут к базовому типу PHP.

Параметры

string $key
mixed $value

Возвращаемое значение

mixed
END_OF_DOCUMENT_MARKER

protected string getCastType(string $key)

Получить тип преобразования для атрибута модели.

Параметры

string $key

Возвращаемое значение

string

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

Установить заданный атрибут модели.

Параметры

string $key
mixed $value

Возвращаемое значение

$this

bool hasSetMutator(string $key)

Определить, существует ли мутатор set для атрибута.

Параметры

string $key

Возвращаемое значение

bool

protected bool isDateAttribute(string $key)

Определить, является ли заданный атрибут датой или преобразуемым в дату.

Параметры

string $key

Возвращаемое значение

bool

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

Установить заданный атрибут JSON в модели.

Параметры

string $key
mixed $value

Возвращаемое значение

$this

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

Получить атрибут массива с заданным ключом и установленным значением.

Параметры

string $path
string $key
mixed $value

Возвращаемое значение

$this

protected array getArrayAttributeByKey(string $key)

Получить атрибут массива или вернуть пустой массив, если он не задан.

Параметры

string $key

Возвращаемое значение

array

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

Преобразовать заданный атрибут в JSON.

Параметры

string $key
mixed $value

Возвращаемое значение

string

protected string asJson(mixed $value)

Кодировать заданное значение в JSON.

Параметры

mixed $value

Возвращаемое значение

string

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

Декодировать заданный JSON в массив или объект.

Параметры

string $value
bool $asObject

Возвращаемое значение

mixed

protected Carbon asDate(mixed $value)

Возвратить временную метку как объект DateTime с временем, установленным в 00:00:00.

Параметры

mixed $value

Возвращаемое значение

Carbon

protected Carbon asDateTime(mixed $value)

Возвратить временную метку как объект DateTime.

Параметры

mixed $value

Возвращаемое значение

Carbon

protected bool isStandardDateFormat(string $value)

Определить, соответствует ли заданное значение стандартному формату даты.

Параметры

string $value

Возвращаемое значение

bool

string fromDateTime(DateTime|int $value)

Преобразовать DateTime в хранимую строку.

Параметры

DateTime|int $value

Возвращаемое значение

string

protected int asTimestamp(mixed $value)

Возвратить временную метку как метку Unix.

Параметры

mixed $value

Возвращаемое значение

int

protected string serializeDate(DateTimeInterface $date)

Подготовить дату для сериализации в массив/JSON.

Параметры

DateTimeInterface $date

Возвращаемое значение

string

array getDates()

Получить атрибуты, которые должны быть преобразованы в даты.

Возвращаемое значение

array

protected string getDateFormat()

Получить формат для дат, хранящихся в базе данных.

Возвращаемое значение

string

$this setDateFormat(string $format)

Установить формат даты, используемый моделью.

Параметры

string $format

Возвращаемое значение

$this

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

Определить, должен ли атрибут преобразовываться в родной тип.

Параметры

string $key
array|string|null $types

Возвращаемое значение

bool

array getCasts()

Получить массив преобразований.

Возвращаемое значение

array

protected bool isDateCastable(string $key)

Определить, может ли значение преобразовываться в дату/DateTime для входных манипуляций.

Параметры

string $key

Возвращаемое значение

bool

protected bool isJsonCastable(string $key)

Определить, может ли значение быть преобразовано в JSON для обработки на входе.

Параметры

string $key

Возвращаемое значение

bool

array getAttributes()

Получить все текущие атрибуты модели.

Возвращаемое значение

array

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

Установить массив атрибутов модели. Проверка не выполняется.

Параметры

array $attributes
bool $sync

Возвращаемое значение

$this

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

Получить исходные значения атрибутов модели.

Параметры

string|null $key
mixed $default

Возвращаемое значение

mixed|array

$this syncOriginal()

Синхронизировать исходные атрибуты с текущими.

Возвращаемое значение

$this

$this syncOriginalAttribute(string $attribute)

Синхронизировать один исходный атрибут со своим текущим значением.

Параметры

string $attribute

Возвращаемое значение

$this

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

Определить, была ли изменена модель или указанный(ые) атрибут(ы).

Параметры

array|string|null $attributes

Возвращаемое значение

bool

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

Определить, осталась ли модель или заданный(ые) атрибут(ы) неизменным(ыми).

Параметры

array|string|null $attributes

Возвращаемое значение

bool

array getDirty()

Получить атрибуты, которые были изменены с момента последней синхронизации.

Возвращаемое значение

array

protected bool originalIsNumericallyEquivalent(string $key)

Определить, являются ли новые и старые значения для заданного ключа численно эквивалентными.

Параметры

string $key

Возвращаемое значение

bool

$this append(array|string $attributes)

Добавить атрибуты к запросу при построении запроса.

Параметры

array|string $attributes

Возвращаемое значение

$this

$this setAppends(array $appends)

Установить аксессоры для добавления в массивы модели.

Параметры

array $appends

Возвращаемое значение

$this

array getMutatedAttributes()

Получить изменённые атрибуты для данного экземпляра.

Возвращаемое значение

array

static void cacheMutatedAttributes(string $class)

Извлечь и кэшировать все изменённые атрибуты класса.

Параметры

string $class

Возвращаемое значение

void

static protected array getMutatorMethods(mixed $class)

Получить все методы мутатора атрибутов.

Параметры

mixed $class

Возвращаемое значение

array

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.4/Illuminate/Database/Eloquent/Concerns/HasAttributes.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API