Spec-Zone.ru › Laravel 7

MorphPivot

class MorphPivot extends Pivot (View source)

Трейты

AsPivot
HasAttributes
HasEvents
HasGlobalScopes
HasRelationships
HasTimestamps
HidesAttributes
GuardsAttributes
ForwardsCalls

Константы

CREATED_AT

Имя столбца "created at".

UPDATED_AT

Имя столбца "updated at".

Свойства

protected массив $attributes

Атрибуты модели.

из HasAttributes
protected массив $original

Исходное состояние атрибутов модели.

из HasAttributes
protected массив $changes

Изменённые атрибуты модели.

из HasAttributes
protected массив $casts

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

из HasAttributes
protected массив $classCastCache

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

из HasAttributes
static protected массив $primitiveCastTypes

Встроенные, примитивные типы преобразования, поддерживаемые Eloquent.

из HasAttributes
protected массив $dates

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

из HasAttributes
protected строка $dateFormat

Формат хранения столбцов даты модели.

из HasAttributes
protected массив $appends

Обработчики для добавления к массиву формы модели.

из HasAttributes
static bool $snakeAttributes

Указывает, используются ли змеиный регистр для атрибутов в массивах.

из HasAttributes
static protected массив $mutatorCache

Кэш мутированных атрибутов для каждого класса.

из HasAttributes
protected массив $dispatchesEvents

Карта событий для модели.

из HasEvents
protected массив $observables

Доступные пользователю наблюдаемые события.

из HasEvents
protected массив $relations

Загруженные отношения для модели.

из HasRelationships
protected массив $touches

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

из HasRelationships
static массив $manyMethods

Методы отношений "многие ко многим".

из HasRelationships
static protected массив $relationResolvers

Обратные вызовы разрешения отношений.

из HasRelationships
bool $timestamps

Указывает, должна ли модель иметь метки времени.

из HasTimestamps
protected массив $hidden

Атрибуты, которые должны быть скрыты для сериализации.

из HidesAttributes
protected массив $visible

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

из HidesAttributes
protected массив $fillable

Атрибуты, которые можно массово назначать.

из GuardsAttributes
protected массив $guarded

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

из GuardsAttributes
static protected bool $unguarded

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

из GuardsAttributes
static protected массив $guardableColumns

Фактические столбцы, существующие в базе данных и которые можно защищать.

из GuardsAttributes
protected string|null $connection

Имя подключения для модели.

из Model
protected строка $table

Таблица, связанная с моделью.

из Model
protected строка $primaryKey

Основной ключ модели.

из Model
protected строка $keyType

Тип основного ключа ID.

из Model
bool $incrementing

Указывает, являются ли идентификаторы автоматически увеличиваемыми.

из Pivot
protected массив $with

Отношения для ленивой загрузки при каждом запросе.

из Model
protected массив $withCount

Счетчики отношений, которые должны быть лениво загружены при каждом запросе.

из Model
protected целое число $perPage

Количество моделей, возвращаемых для пагинации.

из Model
bool $exists

Указывает, существует ли модель.

из Model
bool $wasRecentlyCreated

Указывает, была ли модель вставлена ​​во время текущего жизненного цикла запроса.

из Model
static protected ConnectionResolverInterface $resolver

Экземпляр разрешителя подключений.

из Model
static protected Dispatcher $dispatcher

Экземпляр диспетчера событий.

из Model
static protected array $booted

Массив загруженных моделей.

from Model
static protected array $traitInitializers

Массив инициализаторов трейтов, которые будут вызываться для каждого нового экземпляра.

from Model
static protected array $globalScopes

Массив глобальных скопов модели.

from Model
static protected array $ignoreOnTouch

Список классов моделей, которые не должны затрагиваться методом touch.

from Model
Model $pivotParent

Родительская модель отношения.

from AsPivot
protected string $foreignKey

Имя столбца внешнего ключа.

from AsPivot
protected string $relatedKey

Имя столбца "другого ключа".

from AsPivot
protected string $morphType

Тип полиморфного отношения.

protected string $morphClass

Значение полиморфного отношения.

Методы

массив attributesToArray()

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

из HasAttributes
массив addDateAttributesToArray(массив $attributes)

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

из HasAttributes
массив addMutatedAttributesToArray(массив $attributes, массив $mutatedAttributes)

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

из HasAttributes
массив addCastAttributesToArray(массив $attributes, массив $mutatedAttributes)

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

из HasAttributes
массив getArrayableAttributes()

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

из HasAttributes
массив getArrayableAppends()

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

из HasAttributes
массив relationsToArray()

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

из HasAttributes
массив getArrayableRelations()

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

из HasAttributes
массив getArrayableItems(массив $values)

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

из HasAttributes
смешанное getAttribute(строка $key)

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

из HasAttributes
смешанное getAttributeValue(строка $key)

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

из HasAttributes
смешанное getAttributeFromArray(строка $key)

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

из HasAttributes
смешанное getRelationValue(строка $key)

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

из HasAttributes
смешанное getRelationshipFromMethod(строка $method)

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

из HasAttributes
логическое hasGetMutator(строка $key)

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

из HasAttributes
смешанное mutateAttribute(строка $key, смешанное $value)

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

из HasAttributes
смешанное mutateAttributeForArray(строка $key, смешанное $value)

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

из HasAttributes
пусто mergeCasts(массив $casts)

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

из HasAttributes
смешанное castAttribute(строка $key, смешанное $value)

Преобразовать атрибут в базовый тип PHP.

из HasAttributes
смешанное getClassCastableAttributeValue(строка $key, смешанное $value)

Преобразовать указанный атрибут с помощью пользовательского класса преобразования.

из HasAttributes
строка getCastType(строка $key)

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

из HasAttributes
логическое isCustomDateTimeCast(строка $cast)

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

из HasAttributes
логическое isDecimalCast(строка $cast)

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

из HasAttributes
смешанное setAttribute(строка $key, смешанное $value)

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

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

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

из HasAttributes
смешанное setMutatedAttributeValue(строка $key, смешанное $value)

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

из HasAttributes
логическое isDateAttribute(строка $key)

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

из HasAttributes
$this fillJsonAttribute(строка $key, смешанное $value)

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

из HasAttributes
пусто setClassCastableAttribute(строка $key, смешанное $value)

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

из HasAttributes
$this getArrayAttributeWithValue(string $path, string $key, mixed $value)

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

из HasAttributes
массив getArrayAttributeByKey(string $key)

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

из HasAttributes
строка castAttributeAsJson(string $key, mixed $value)

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

из HasAttributes
строка asJson(mixed $value)

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

из HasAttributes
смешанный тип fromJson(string $value, bool $asObject = false)

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

из HasAttributes
смешанный тип fromFloat(mixed $value)

Декодировать заданное значение с плавающей точкой.

из HasAttributes
строка asDecimal(float $value, int $decimals)

Возвратить десятичное число в виде строки.

из HasAttributes
Carbon asDate(mixed $value)

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

из HasAttributes
Carbon asDateTime(mixed $value)

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

из HasAttributes
логическое значение isStandardDateFormat(string $value)

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

из HasAttributes
строка|null fromDateTime(mixed $value)

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

из HasAttributes
целое число asTimestamp(mixed $value)

Возвратить отметку времени как unix timestamp.

из HasAttributes
строка serializeDate(DateTimeInterface $date)

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

из HasAttributes
массив getDates()

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

из HasAttributes
строка getDateFormat()

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

из HasAttributes
$this setDateFormat(string $format)

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

из HasAttributes
логическое значение hasCast(string $key, array|string|null $types = null)

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

из HasAttributes
массив getCasts()

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

из HasAttributes
логическое значение isDateCastable(string $key)

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

из HasAttributes
логическое значение isJsonCastable(string $key)

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

из HasAttributes
логическое значение isClassCastable(string $key)

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

из HasAttributes
смешанный тип resolveCasterClass(string $key)

Разрешить пользовательский класс преобразователя для данного ключа.

из HasAttributes
строка parseCasterClass(string $class)

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

из HasAttributes
void mergeAttributesFromClassCasts()

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

из HasAttributes
массив normalizeCastClassResponse(string $key, mixed $value)

Нормализовать ответ от пользовательского класса преобразователя.

из HasAttributes
массив getAttributes()

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

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

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

из HasAttributes
смешанный тип|массив getOriginal(string|null $key = null, mixed $default = null)

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

из HasAttributes
смешанный тип|массив getOriginalWithoutRewindingModel(string|null $key = null, mixed $default = null)

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

из HasAttributes
mixed|array getRawOriginal(string|null $key = null, mixed $default = null)

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

из HasAttributes
array only(array|mixed $attributes)

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

из HasAttributes
$this syncOriginal()

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

из HasAttributes
$this syncOriginalAttribute(string $attribute)

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

из HasAttributes
$this syncOriginalAttributes(array|string $attributes)

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

из HasAttributes
$this syncChanges()

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

из HasAttributes
bool isDirty(array|string|null $attributes = null)

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

из HasAttributes
bool isClean(array|string|null $attributes = null)

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

из HasAttributes
bool wasChanged(array|string|null $attributes = null)

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

из HasAttributes
bool hasChanges(array $changes, array|string|null $attributes = null)

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

из HasAttributes
array getDirty()

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

из HasAttributes
array getChanges()

Получить атрибуты, которые были изменены.

из HasAttributes
bool originalIsEquivalent(string $key)

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

из HasAttributes
mixed transformModelValue(string $key, mixed $value)

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

из HasAttributes
$this append(array|string $attributes)

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

из HasAttributes
$this setAppends(array $appends)

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

из HasAttributes
bool hasAppended(string $attribute)

Возвращает, был ли аксессор атрибута добавлен.

из HasAttributes
array getMutatedAttributes()

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

из HasAttributes
static void cacheMutatedAttributes(string $class)

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

из HasAttributes
static array getMutatorMethods(mixed $class)

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

из HasAttributes
static void observe(object|array|string $classes)

Зарегистрировать наблюдателей с моделью.

из HasEvents
void registerObserver(object|string $class)

Зарегистрировать одного наблюдателя с моделью.

из HasEvents
array getObservableEvents()

Получить имена наблюдаемых событий.

из HasEvents
$this setObservableEvents(array $observables)

Установить имена наблюдаемых событий.

из HasEvents
void addObservableEvents(array|mixed $observables)

Добавить имя наблюдаемого события.

из HasEvents
void removeObservableEvents(array|mixed $observables)

Удалить имя наблюдаемого события.

из HasEvents
static void registerModelEvent(string $event, Closure|string $callback)

Зарегистрировать событие модели с диспетчером.

из HasEvents
mixed fireModelEvent(string $event, bool $halt = true)

Вызвать заданное событие для модели.

из HasEvents
mixed|null fireCustomModelEvent(string $event, string $method)

Вызвать пользовательское событие модели для данного события.

из HasEvents
mixed filterModelEventResults(mixed $result)

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

из HasEvents
static void retrieved(Closure|string $callback)

Зарегистрировать событие модели «извлечено» в диспетчере.

из HasEvents
static void saving(Closure|string $callback)

Зарегистрировать событие модели «сохранение» в диспетчере.

из HasEvents
static void saved(Closure|string $callback)

Зарегистрировать событие модели «сохранено» в диспетчере.

из HasEvents
static void updating(Closure|string $callback)

Зарегистрировать событие модели «обновление» в диспетчере.

из HasEvents
static void updated(Closure|string $callback)

Зарегистрировать событие модели «обновлено» в диспетчере.

из HasEvents
static void creating(Closure|string $callback)

Зарегистрировать событие модели «создание» в диспетчере.

из HasEvents
static void created(Closure|string $callback)

Зарегистрировать событие модели «создано» в диспетчере.

из HasEvents
static void replicating(Closure|string $callback)

Зарегистрировать событие модели «копирование» в диспетчере.

из HasEvents
static void deleting(Closure|string $callback)

Зарегистрировать событие модели «удаление» в диспетчере.

из HasEvents
static void deleted(Closure|string $callback)

Зарегистрировать событие модели «удалено» в диспетчере.

из HasEvents
static void flushEventListeners()

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

из HasEvents
static Dispatcher getEventDispatcher()

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

из HasEvents
static void setEventDispatcher(Dispatcher $dispatcher)

Установить экземпляр диспетчера событий.

из HasEvents
static void unsetEventDispatcher()

Сбросить диспетчер событий для моделей.

из HasEvents
static mixed withoutEvents(callable $callback)

Выполнить обратный вызов без запуска событий модели для любого типа модели.

из HasEvents
static mixed addGlobalScope(Scope|Closure|string $scope, Closure $implementation = null)

Зарегистрировать новый глобальный область для модели.

из HasGlobalScopes
static bool hasGlobalScope(Scope|string $scope)

Определить, имеет ли модель глобальную область.

из HasGlobalScopes
static Scope|Closure|null getGlobalScope(Scope|string $scope)

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

из HasGlobalScopes
array getGlobalScopes()

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

из HasGlobalScopes
static void resolveRelationUsing(string $name, Closure $callback)

Определить динамический решатель отношений.

из HasRelationships
HasOne hasOne(string $related, string|null $foreignKey = null, string|null $localKey = null)

Определить отношение один-к-одному.

из HasRelationships
HasOne newHasOne(Builder $query, Model $parent, string $foreignKey, string $localKey)

Создать новое отношение один-к-одному.

из HasRelationships
HasOneThrough hasOneThrough(string $related, string $through, string|null $firstKey = null, string|null $secondKey = null, string|null $localKey = null, string|null $secondLocalKey = null)

Определить отношение has-one-through.

из HasRelationships
HasOneThrough newHasOneThrough(Builder $query, Model $farParent, Model $throughParent, string $firstKey, string $secondKey, string $localKey, string $secondLocalKey)

Инициализировать новое отношение HasOneThrough.

from HasRelationships
MorphOne morphOne(string $related, string $name, string|null $type = null, string|null $id = null, string|null $localKey = null)

Определить полиморфное отношение один-к-одному.

from HasRelationships
MorphOne newMorphOne(Builder $query, Model $parent, string $type, string $id, string $localKey)

Инициализировать новое полиморфное отношение один-к-одному.

from HasRelationships
BelongsTo belongsTo(string $related, string|null $foreignKey = null, string|null $ownerKey = null, string|null $relation = null)

Определить обратное отношение один-к-одному или один-ко-многим.

from HasRelationships
BelongsTo newBelongsTo(Builder $query, Model $child, string $foreignKey, string $ownerKey, string $relation)

Инициализировать новое отношение BelongsTo.

from HasRelationships
MorphTo morphTo(string|null $name = null, string|null $type = null, string|null $id = null, string|null $ownerKey = null)

Определить полиморфное обратное отношение один-к-одному или один-ко-многим.

from HasRelationships
MorphTo morphEagerTo(string $name, string $type, string $id, string $ownerKey)

Определить полиморфное обратное отношение один-к-одному или один-ко-многим.

from HasRelationships
MorphTo morphInstanceTo(string $target, string $name, string $type, string $id, string $ownerKey)

Определить полиморфное обратное отношение один-к-одному или один-ко-многим.

from HasRelationships
MorphTo newMorphTo(Builder $query, Model $parent, string $foreignKey, string $ownerKey, string $type, string $relation)

Инициализировать новое полиморфное отношение MorphTo.

from HasRelationships
static string getActualClassNameForMorph(string $class)

Получить фактическое имя класса для данного полиморфного класса.

from HasRelationships
string guessBelongsToRelation()

Предположить имя отношения "belongs to".

from HasRelationships
HasMany hasMany(string $related, string|null $foreignKey = null, string|null $localKey = null)

Определить отношение один-ко-многим.

from HasRelationships
HasMany newHasMany(Builder $query, Model $parent, string $foreignKey, string $localKey)

Инициализировать новое отношение HasMany.

from HasRelationships
HasManyThrough hasManyThrough(string $related, string $through, string|null $firstKey = null, string|null $secondKey = null, string|null $localKey = null, string|null $secondLocalKey = null)

Определить отношение has-many-through.

from HasRelationships
HasManyThrough newHasManyThrough(Builder $query, Model $farParent, Model $throughParent, string $firstKey, string $secondKey, string $localKey, string $secondLocalKey)

Инициализировать новое отношение HasManyThrough.

from HasRelationships
MorphMany morphMany(string $related, string $name, string|null $type = null, string|null $id = null, string|null $localKey = null)

Определить полиморфное отношение один-ко-многим.

from HasRelationships
MorphMany newMorphMany(Builder $query, Model $parent, string $type, string $id, string $localKey)

Инициализировать новое полиморфное отношение MorphMany.

from HasRelationships
BelongsToMany belongsToMany(string $related, string|null $table = null, string|null $foreignPivotKey = null, string|null $relatedPivotKey = null, string|null $parentKey = null, string|null $relatedKey = null, string|null $relation = null)

Определить отношение многие-ко-многим.

from HasRelationships
BelongsToMany newBelongsToMany(Builder $query, Model $parent, string $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string|null $relationName = null)

Инициализировать новое отношение BelongsToMany.

from HasRelationships
MorphToMany morphToMany(string $related, string $name, string|null $table = null, string|null $foreignPivotKey = null, string|null $relatedPivotKey = null, string|null $parentKey = null, string|null $relatedKey = null, bool $inverse = false)

Определите полиморфное множество-ко-множеству отношение.

из HasRelationships
MorphToMany newMorphToMany(Builder $query, Model $parent, string $name, string $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string|null $relationName = null, bool $inverse = false)

Инициализируйте новое отношение MorphToMany.

из HasRelationships
MorphToMany morphedByMany(string $related, string $name, string|null $table = null, string|null $foreignPivotKey = null, string|null $relatedPivotKey = null, string|null $parentKey = null, string|null $relatedKey = null)

Определите полиморфное, обратное множество-ко-множеству отношение.

из HasRelationships
string|null guessBelongsToManyRelation()

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

из HasRelationships
string joiningTable(string $related, Model|null $instance = null)

Получить имя таблицы соединения для отношения множество-ко-множеству.

из HasRelationships
string joiningTableSegment()

Получить часть имени промежуточной таблицы для отношений belongsToMany.

из HasRelationships
bool touches(string $relation)

Определить, затрагивает ли модель заданное отношение.

из HasRelationships
void touchOwners()

Обновить связанные отношения модели.

из HasRelationships
array getMorphs(string $name, string $type, string $id)

Получить столбцы полиморфного отношения.

из HasRelationships
string getMorphClass()

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

из HasRelationships
mixed newRelatedInstance(string $class)

Создать новый экземпляр модели для связанной модели.

из HasRelationships
array getRelations()

Получить все загруженные отношения для экземпляра.

из HasRelationships
mixed getRelation(string $relation)

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

из HasRelationships
bool relationLoaded(string $key)

Определить, загружено ли заданное отношение.

из HasRelationships
$this setRelation(string $relation, mixed $value)

Установить заданное отношение в модели.

из HasRelationships
$this unsetRelation(string $relation)

Удалить загруженное отношение.

из HasRelationships
$this setRelations(array $relations)

Установить массив отношений в модели.

из HasRelationships
$this withoutRelations()

Создать дубликат экземпляра и удалить все загруженные отношения.

из HasRelationships
$this unsetRelations()

Удалить все загруженные отношения для экземпляра.

из HasRelationships
array getTouchedRelations()

Получить отношения, которые затрагиваются при сохранении.

из HasRelationships
$this setTouchedRelations(array $touches)

Установить отношения, которые затрагиваются при сохранении.

из HasRelationships
bool touch()

Обновить отметку времени обновления модели.

из HasTimestamps
void updateTimestamps()

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

из HasTimestamps
$this setCreatedAt(mixed $value)

Установить значение атрибута "created at".

из HasTimestamps
$this setUpdatedAt(mixed $value)

Установить значение атрибута "updated at".

из HasTimestamps
Carbon freshTimestamp()

Получить свежую отметку времени для модели.

из HasTimestamps
string freshTimestampString()

Получить свежую отметку времени для модели.

из HasTimestamps
bool usesTimestamps()

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

from HasTimestamps
string|null getCreatedAtColumn()

Получить имя столбца "created at".

from HasTimestamps
string|null getUpdatedAtColumn()

Получить имя столбца "updated at".

from HasTimestamps
string getQualifiedCreatedAtColumn()

Получить полностью квалифицированный столбец "created at".

from HasTimestamps
string getQualifiedUpdatedAtColumn()

Получить полностью квалифицированный столбец "updated at".

from HasTimestamps
array getHidden()

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

from HidesAttributes
$this setHidden(array $hidden)

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

from HidesAttributes
array getVisible()

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

from HidesAttributes
$this setVisible(array $visible)

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

from HidesAttributes
$this makeVisible(array|string|null $attributes)

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

from HidesAttributes
$this makeVisibleIf(bool|Closure $condition, array|string|null $attributes)

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

from HidesAttributes
$this makeHidden(array|string|null $attributes)

Скрыть заданные, обычно видимые, атрибуты.

from HidesAttributes
$this makeHiddenIf(bool|Closure $condition, array|string|null $attributes)

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

from HidesAttributes
array getFillable()

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

from GuardsAttributes
$this fillable(array $fillable)

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

from GuardsAttributes
$this mergeFillable(array $fillable)

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

from GuardsAttributes
array getGuarded()

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

from GuardsAttributes
$this guard(array $guarded)

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

from GuardsAttributes
$this mergeGuarded(array $guarded)

Объединить новые защищённые атрибуты с существующими защищёнными атрибутами модели.

from GuardsAttributes
static void unguard(bool $state = true)

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

from GuardsAttributes
static void reguard()

Включить ограничения массового присваивания.

from GuardsAttributes
static bool isUnguarded()

Определить, находится ли текущее состояние в "разоружённом" режиме.

from GuardsAttributes
static mixed unguarded(callable $callback)

Выполнить заданный вызов, находясь в "разоружённом" режиме.

from GuardsAttributes
bool isFillable(string $key)

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

from GuardsAttributes
bool isGuarded(string $key)

Определить, защищён ли данный ключ.

from GuardsAttributes
bool isGuardableColumn(string $key)

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

from GuardsAttributes
bool totallyGuarded()

Определить, является ли модель полностью защищённой.

from GuardsAttributes
array fillableFromArray(array $attributes)

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

from GuardsAttributes
mixed forwardCallTo(mixed $object, string $method, array $parameters)

Перенаправить вызов метода заданному объекту.

from ForwardsCalls
static void throwBadMethodCallException(string $method)

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

from ForwardsCalls
void __construct(array $attributes = [])

Создать новый экземпляр модели Eloquent.

from Модель
void bootIfNotBooted()

Проверить, нужно ли запустить загрузку модели, и если нужно, сделать это.

from Модель
static void booting()

Выполнить необходимые действия перед запуском загрузки модели.

from Модель
static void boot()

Инициализировать модель и её трейты.

from Модель
static void bootTraits()

Запустить все загрузчики трейтов модели.

from Модель
void initializeTraits()

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

from Модель
static void booted()

Выполнить необходимые действия после запуска загрузки модели.

from Модель
static void clearBootedModels()

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

from Модель
static void withoutTouching(callable $callback)

Отключает привязку моделей отношений для текущего класса во время выполнения заданного обратного вызова.

from Модель
static void withoutTouchingOn(array $models, callable $callback)

Отключает привязку моделей отношений для заданных классов моделей во время выполнения заданного обратного вызова.

from Модель
static bool isIgnoringTouch(string|null $class = null)

Определить, игнорирует ли данная модель изменения.

from Модель
$this fill(array $attributes)

Заполнить модель массивом атрибутов.

from Модель
$this forceFill(array $attributes)

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

from Модель
string qualifyColumn(string $column)

Указать имя заданного столбца с помощью таблицы модели.

from Модель
string removeTableFromKey(string $key) устаревший

Удалить имя таблицы из заданного ключа.

from Модель
Модель newInstance(array $attributes = [], bool $exists = false)

Создать новый экземпляр заданной модели.

from Модель
Модель newFromBuilder(array $attributes = [], string|null $connection = null)

Создать новый экземпляр модели, которая уже существует.

from Модель
static Builder on(string|null $connection = null)

Начать запросы к модели на заданном соединении.

from Модель
static Builder onWriteConnection()

Начать запросы к модели на соединении для записи.

from Модель
static Collection|Модель[] all(array|mixed $columns = ['*'])

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

from Модель
static Builder with(array|string $relations)

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

from Модель
$this load(array|string $relations)

Загрузить отношения модели с ленивой загрузкой.

from Модель
$this loadMorph(string $relation, array $relations)

Загрузить отношения по полиморфному свойству модели с ленивой загрузкой.

from Модель
$this loadMissing(array|string $relations)

Загрузить отношения модели, если они еще не загружены.

from Модель
$this loadCount(array|string $relations)

Загрузить количество отношений модели.

from Модель
$this loadMorphCount(string $relation, array $relations)

Загрузить количество отношений по полиморфному свойству модели.

from Модель
int increment(string $column, float|int $amount = 1, array $extra = [])

Увеличить значение столбца на заданное количество.

from Модель
int decrement(string $column, float|int $amount = 1, array $extra = [])

Уменьшить значение столбца на заданное количество.

from Модель
int incrementOrDecrement(string $column, float|int $amount, array $extra, string $method)

Выполнить метод увеличения или уменьшения значения столбца модели.

from Модель
void incrementOrDecrementAttributeValue(string $column, float|int $amount, array $extra, string $method)

Увеличьте значение базового атрибута и синхронизируйте его с оригиналом.

from Model
bool update(array $attributes = [], array $options = [])

Обновить модель в базе данных.

from Model
bool push()

Сохранить модель и все её отношения.

from Model
bool save(array $options = [])

Сохранить модель в базе данных.

from Model
bool saveOrFail(array $options = [])

Сохранить модель в базе данных с использованием транзакции.

from Model
void finishSave(array $options)

Выполнить необходимые действия после сохранения модели.

from Model
bool performUpdate(Builder $query)

Выполнить операцию обновления модели.

from Model
Builder setKeysForSaveQuery(Builder $query)

Установить ключи для запроса сохранения.

mixed getKeyForSaveQuery()

Получить значение первичного ключа для запроса сохранения.

from Model
bool performInsert(Builder $query)

Выполнить операцию вставки модели.

from Model
void insertAndSetId(Builder $query, array $attributes)

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

from Model
static int destroy(Collection|array|int|string $ids)

Удалить модели для заданных идентификаторов.

from Model
int delete()

Удалить запись модели-связи из базы данных.

bool|null forceDelete()

Выполнить жёсткое удаление мягко удалённой модели.

from Model
void performDeleteOnModel()

Выполнить фактический запрос удаления для этого экземпляра модели.

from Model
static Builder query()

Начать запрос модели.

from Model
Builder newQuery()

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

from Model
Builder|Model newModelQuery()

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

from Model
Builder newQueryWithoutRelationships()

Получить новый билдер запросов без загрузок отношений.

from Model
Builder registerGlobalScopes(Builder $builder)

Зарегистрировать глобальные скоупы для этого билдера.

from Model
Builder|Model newQueryWithoutScopes()

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

from Model
Builder newQueryWithoutScope(Scope|string $scope)

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

from Model
Builder newQueryForRestoration(int[]|string[]|string $ids)

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

Builder|Model newEloquentBuilder(Builder $query)

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

from Model
Builder newBaseQueryBuilder()

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

from Model
Collection newCollection(array $models = [])

Создать новый экземпляр коллекции Eloquent.

from Model
Pivot newPivot(Model $parent, array $attributes, string $table, bool $exists, string|null $using = null)

Создать новый экземпляр модели-связи.

from Model
bool hasNamedScope(string $scope)

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

from Model
mixed callNamedScope(string $scope, array $parameters = [])

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

from Model
массив toArray()

Преобразовать экземпляр модели в массив.

из модели
строка toJson(int $options = 0)

Преобразовать экземпляр модели в JSON.

из модели
массив jsonSerialize()

Преобразовать объект в сериализуемый в JSON.

из модели
модель|null fresh(array|string $with = [])

Перезагрузить свежий экземпляр модели из базы данных.

из модели
$this refresh()

Перезагрузить текущий экземпляр модели с новыми атрибутами из базы данных.

из модели
модель replicate(array $except = null)

Клонировать модель в новый, не существующий экземпляр.

из модели
логическое значение is(модель|null $model)

Определить, имеют ли две модели одинаковый идентификатор и принадлежат ли одной и той же таблице.

из модели
логическое значение isNot(модель|null $model)

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

из модели
соединение getConnection()

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

из модели
строка|null getConnectionName()

Получить текущее имя соединения для модели.

из модели
$this setConnection(string|null $name)

Установить соединение, связанное с моделью.

из модели
статический соединение resolveConnection(string|null $connection = null)

Разрешить экземпляр соединения.

из модели
статический интерфейс разрешения соединения getConnectionResolver()

Получить экземпляр разрешителя соединений.

из модели
статический void setConnectionResolver(интерфейс разрешения соединения $resolver)

Установить экземпляр разрешителя соединений.

из модели
статический void unsetConnectionResolver()

Удалить разрешитель соединений для моделей.

из модели
строка getTable()

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

из AsPivot
$this setTable(string $table)

Установить таблицу, связанную с моделью.

из модели
строка getKeyName()

Получить первичный ключ для модели.

из модели
$this setKeyName(string $key)

Установить первичный ключ для модели.

из модели
строка getQualifiedKeyName()

Получить имя квалифицированного первичного ключа.

из модели
строка getKeyType()

Получить тип автоинкрементного ключа.

из модели
$this setKeyType(string $type)

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

из модели
логическое значение getIncrementing()

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

из модели
$this setIncrementing(bool $value)

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

из модели
смешанный тип getKey()

Получить значение первичного ключа модели.

из модели
смешанный тип getQueueableId()

Получить идентификатор очереди для сущности.

массив getQueueableRelations()

Получить отношения очереди для сущности.

из модели
строка|null getQueueableConnection()

Получить соединение очереди для сущности.

из модели
смешанный тип getRouteKey()

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

из модели
строка getRouteKeyName()

Получить ключ маршрута для модели.

из модели
модель|null resolveRouteBinding(mixed $value, string|null $field = null)

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

из модели
модель|null resolveChildRouteBinding(string $childType, mixed $value, string|null $field)

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

из модели
string getForeignKey()

Получить имя столбца внешнего ключа.

из AsPivot
int getPerPage()

Получить количество моделей на страницу.

из Model
$this setPerPage(int $perPage)

Установить количество моделей на страницу.

из Model
mixed __get(string $key)

Динамически получить атрибуты модели.

из Model
void __set(string $key, mixed $value)

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

из Model
bool offsetExists(mixed $offset)

Определить, существует ли данный атрибут.

из Model
mixed offsetGet(mixed $offset)

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

из Model
void offsetSet(mixed $offset, mixed $value)

Установить значение для данного смещения.

из Model
void offsetUnset(mixed $offset)

Удалить значение для данного смещения.

из Model
bool __isset(string $key)

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

из Model
void __unset(string $key)

Удалить атрибут модели.

из Model
mixed __call(string $method, array $parameters)

Обработать вызов динамического метода модели.

из Model
static mixed __callStatic(string $method, array $parameters)

Обработать вызов статического динамического метода модели.

из Model
string __toString()

Преобразовать модель в строковое представление.

из Model
array __sleep()

Подготовить объект к сериализации.

из Model
void __wakeup()

Когда модель сериализуется, проверить, нужно ли её загружать.

из Model
static AsPivot fromAttributes(Model $parent, array $attributes, string $table, bool $exists = false)

Создать новый экземпляр модели-связи.

из AsPivot
static AsPivot fromRawAttributes(Model $parent, array $attributes, string $table, bool $exists = false)

Создать новую модель-связь из сырых значений, полученных из запроса.

из AsPivot
Builder getDeleteQuery()

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

из AsPivot
string getRelatedKey()

Получить имя столбца «связанного ключа».

из AsPivot
string getOtherKey()

Получить имя столбца «связанного ключа».

из AsPivot
$this setPivotKeys(string $foreignKey, string $relatedKey)

Установить имена ключей для экземпляра модели-связи.

из AsPivot
bool hasTimestampAttributes(array|null $attributes = null)

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

из AsPivot
Builder newQueryForCollectionRestoration(array $ids)

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

$this setMorphType(string $morphType)

Установить тип морфирования для связи.

MorphPivot setMorphClass(string $morphClass)

Установить класс морфирования для связи.

Подробности

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)

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

Параметры

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

void mergeCasts(array $casts)

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

Параметры

array $casts

Значение возврата

void

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

Преобразовать атрибут в базовый тип PHP.

Параметры

string $key
mixed $value

Значение возврата

mixed

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

Преобразовать данный атрибут с помощью пользовательского класса преобразования.

Параметры

string $key
mixed $value

Значение возврата

mixed

protected string getCastType(string $key)

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

Параметры

string $key

Значение возврата

string

protected bool isCustomDateTimeCast(string $cast)

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

Параметры

string $cast

Значение возврата

bool

protected bool isDecimalCast(string $cast)

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

Параметры

string $cast

Значение возврата

bool

mixed setAttribute(string $key, mixed $value)

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

Параметры

string $key
mixed $value

Значение возврата

mixed

bool hasSetMutator(string $key)

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

Параметры

string $key

Значение возврата

bool

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

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

Параметры

string $key
mixed $value

Значение возврата

mixed

protected bool isDateAttribute(string $key)

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

Parameters

string $key

Return Value

bool

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

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

Parameters

string $key
mixed $value

Return Value

$this

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

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

Parameters

string $key
mixed $value

Return Value

void

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

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

Parameters

string $path
string $key
mixed $value

Return Value

$this

protected array getArrayAttributeByKey(string $key)

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

Parameters

string $key

Return Value

array

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

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

Parameters

string $key
mixed $value

Return Value

string

protected string asJson(mixed $value)

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

Parameters

mixed $value

Return Value

string

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

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

Parameters

string $value
bool $asObject

Return Value

mixed

mixed fromFloat(mixed $value)

Декодировать заданное число с плавающей точкой.

Parameters

mixed $value

Return Value

mixed

protected string asDecimal(float $value, int $decimals)

Возвратить десятичное число как строку.

Parameters

float $value
int $decimals

Return Value

string

protected Carbon asDate(mixed $value)

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

Parameters

mixed $value

Return Value

Carbon

protected Carbon asDateTime(mixed $value)

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

Parameters

mixed $value

Return Value

Carbon

protected bool isStandardDateFormat(string $value)

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

Parameters

string $value

Return Value

bool

string|null fromDateTime(mixed $value)

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

Parameters

mixed $value

Return Value

string|null

protected int asTimestamp(mixed $value)

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

Parameters

mixed $value

Return Value

int

protected string serializeDate(DateTimeInterface $date)

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

Parameters

DateTimeInterface $date

Return Value

string

array getDates()

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

Return Value

array

string getDateFormat()

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

Return Value

string

$this setDateFormat(string $format)

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

Parameters

string $format

Return Value

$this

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

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

Parameters

string $key
array|string|null $types

Return Value

bool

array getCasts()

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

Return Value

array

protected bool isDateCastable(string $key)

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

Parameters

string $key

Return Value

bool

protected bool isJsonCastable(string $key)

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

Parameters

string $key

Return Value

bool

protected bool isClassCastable(string $key)

Определить, может ли данный ключ быть преобразован с помощью пользовательского класса.

Parameters

string $key

Return Value

bool

protected mixed resolveCasterClass(string $key)

Получить пользовательский класс-преобразователь для данного ключа.

Parameters

string $key

Return Value

mixed

protected string parseCasterClass(string $class)

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

Parameters

string $class

Return Value

string

protected void mergeAttributesFromClassCasts()

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

Return Value

void

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

Нормализовать ответ от пользовательского класса преобразователя.

Parameters

string $key
mixed $value

Return Value

array

array getAttributes()

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

Return Value

array

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

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

Parameters

array $attributes
bool $sync

Return Value

$this

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

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

Parameters

string|null $key
mixed $default

Return Value

mixed|array

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

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

Parameters

string|null $key
mixed $default

Return Value

mixed|array

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

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

Parameters

string|null $key
mixed $default

Return Value

mixed|array

array only(array|mixed $attributes)

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

Parameters

array|mixed $attributes

Return Value

array

$this syncOriginal()

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

Return Value

$this

$this syncOriginalAttribute(string $attribute)

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

Parameters

string $attribute

Return Value

$this

$this syncOriginalAttributes(array|string $attributes)

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

Parameters

array|string $attributes

Return Value

$this

$this syncChanges()

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

Return Value

$this

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

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

Parameters

array|string|null $attributes

Return Value

bool

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

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

Parameters

array|string|null $attributes

Return Value

bool

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

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

Parameters

array|string|null $attributes

Return Value

bool

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

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

Parameters

array $changes
array|string|null $attributes

Return Value

bool

array getDirty()

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

Return Value

array

array getChanges()

Получить атрибуты, которые были изменены.

Return Value

array

bool originalIsEquivalent(string $key)

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

Параметры

string $key

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

bool

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

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

Параметры

string $key
mixed $value

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

mixed

$this append(array|string $attributes)

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

Параметры

array|string $attributes

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

$this

$this setAppends(array $appends)

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

Параметры

array $appends

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

$this

bool hasAppended(string $attribute)

Возвращает, был ли атрибут аксессора добавлен.

Параметры

string $attribute

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

bool

array getMutatedAttributes()

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

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

array

static void cacheMutatedAttributes(string $class)

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

Параметры

string $class

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

void

static protected array getMutatorMethods(mixed $class)

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

Параметры

mixed $class

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

array

static void observe(object|array|string $classes)

Зарегистрировать наблюдателей с моделью.

Параметры

object|array|string $classes

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

void

Исключения

RuntimeException

protected void registerObserver(object|string $class)

Зарегистрировать одиночного наблюдателя с моделью.

Параметры

object|string $class

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

void

Исключения

RuntimeException

array getObservableEvents()

Получить имена наблюдаемых событий.

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

array

$this setObservableEvents(array $observables)

Установить имена наблюдаемых событий.

Параметры

array $observables

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

$this

void addObservableEvents(array|mixed $observables)

Добавить имя наблюдаемого события.

Параметры

array|mixed $observables

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

void

void removeObservableEvents(array|mixed $observables)

Удалить имя наблюдаемого события.

Параметры

array|mixed $observables

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

void

static protected void registerModelEvent(string $event, Closure|string $callback)

Зарегистрировать событие модели с диспетчером.

Параметры

string $event
Closure|string $callback

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

void

protected mixed fireModelEvent(string $event, bool $halt = true)

Вызвать данное событие для модели.

Параметры

string $event
bool $halt

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

mixed

protected mixed|null fireCustomModelEvent(string $event, string $method)

Вызвать пользовательское событие модели для данного события.

Параметры

string $event
string $method

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

mixed|null

protected mixed filterModelEventResults(mixed $result)

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

Параметры

mixed $result

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

mixed

static void retrieved(Closure|string $callback)

Зарегистрировать событие извлеченной модели с диспетчером.

Параметры

Closure|string $callback

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

void

static void saving(Closure|string $callback)

Зарегистрировать событие сохранения модели с диспетчером.

Параметры

Closure|string $callback

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

void

static void saved(Closure|string $callback)

Зарегистрировать событие сохранённой модели с диспетчером.

Параметры

Closure|string $callback

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

void

static void updating(Closure|string $callback)

Зарегистрировать событие обновления модели с диспетчером.

Параметры

Closure|string $callback

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

void

static void updated(Closure|string $callback)

Зарегистрировать событие обновления модели с диспетчером.

Параметры

Closure|string $callback

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

void

static void creating(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void created(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void replicating(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void deleting(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void deleted(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void flushEventListeners()

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

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

void

static Dispatcher getEventDispatcher()

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

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

Dispatcher

static void setEventDispatcher(Dispatcher $dispatcher)

Установить экземпляр диспетчера событий.

Параметры

Dispatcher $dispatcher

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

void

static void unsetEventDispatcher()

Сбросить диспетчер событий для моделей.

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

void

static mixed withoutEvents(callable $callback)

Выполнить обратный вызов без запуска событий модели для любого типа модели.

Параметры

callable $callback

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

mixed

static mixed addGlobalScope(Scope|Closure|string $scope, Closure $implementation = null)

Зарегистрировать новый глобальный scope для модели.

Параметры

Scope|Closure|string $scope
Closure $implementation

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

mixed

Исключения

InvalidArgumentException

static bool hasGlobalScope(Scope|string $scope)

Определить, имеет ли модель глобальный scope.

Параметры

Scope|string $scope

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

bool

static Scope|Closure|null getGlobalScope(Scope|string $scope)

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

Параметры

Scope|string $scope

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

Scope|Closure|null

array getGlobalScopes()

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

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

array

static void resolveRelationUsing(string $name, Closure $callback)

Определите решатель динамических отношений.

Параметры

string $name
Closure $callback

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

void

HasOne hasOne(string $related, string|null $foreignKey = null, string|null $localKey = null)

Определите отношение один-к-одному.

Параметры

string $related
string|null $foreignKey
string|null $localKey

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

HasOne

protected HasOne newHasOne(Builder $query, Model $parent, string $foreignKey, string $localKey)

Инициализируйте новое отношение один-к-одному.

Параметры

Builder $query
Model $parent
string $foreignKey
string $localKey

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

HasOne

HasOneThrough hasOneThrough(string $related, string $through, string|null $firstKey = null, string|null $secondKey = null, string|null $localKey = null, string|null $secondLocalKey = null)

Определите отношение имеет-один-через.

Параметры

string $related
string $through
string|null $firstKey
string|null $secondKey
string|null $localKey
string|null $secondLocalKey

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

HasOneThrough

protected HasOneThrough newHasOneThrough(Builder $query, Model $farParent, Model $throughParent, string $firstKey, string $secondKey, string $localKey, string $secondLocalKey)

Инициализируйте новое отношение имеет-один-через.

Параметры

Builder $query
Model $farParent
Model $throughParent
string $firstKey
string $secondKey
string $localKey
string $secondLocalKey

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

HasOneThrough

MorphOne morphOne(string $related, string $name, string|null $type = null, string|null $id = null, string|null $localKey = null)

Определите полиморфное отношение один-к-одному.

Параметры

string $related
string $name
string|null $type
string|null $id
string|null $localKey

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

MorphOne

protected MorphOne newMorphOne(Builder $query, Model $parent, string $type, string $id, string $localKey)

Инициализируйте новое полиморфное отношение один-к-одному.

Параметры

Builder $query
Model $parent
string $type
string $id
string $localKey

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

MorphOne

BelongsTo belongsTo(string $related, string|null $foreignKey = null, string|null $ownerKey = null, string|null $relation = null)

Определите обратное отношение один-к-одному или многие-к-одному.

Параметры

string $related
string|null $foreignKey
string|null $ownerKey
string|null $relation

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

BelongsTo

protected BelongsTo newBelongsTo(Builder $query, Model $child, string $foreignKey, string $ownerKey, string $relation)

Инициализируйте новое отношение BelongsTo.

Параметры

Builder $query
Model $child
string $foreignKey
string $ownerKey
string $relation

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

BelongsTo

MorphTo morphTo(string|null $name = null, string|null $type = null, string|null $id = null, string|null $ownerKey = null)

Определите полиморфное обратное отношение один-к-одному или многие-к-одному.

Параметры

string|null $name
string|null $type
string|null $id
string|null $ownerKey

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

MorphTo

protected MorphTo morphEagerTo(string $name, string $type, string $id, string $ownerKey)

Определите полиморфное обратное отношение один-к-одному или многие-к-одному.

Параметры

string $name
string $type
string $id
string $ownerKey

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

MorphTo
END_OF_DOCUMENT_MARKER

protected MorphTo morphInstanceTo(string $target, string $name, string $type, string $id, string $ownerKey)

Определите полиморфное, обратное одно-к-одному или многие-ко-многим отношение.

Параметры

string $target
string $name
string $type
string $id
string $ownerKey

Значение возврата

MorphTo

protected MorphTo newMorphTo(Builder $query, Model $parent, string $foreignKey, string $ownerKey, string $type, string $relation)

Инициализируйте новое полиморфное отношение "многие ко одному".

Параметры

Builder $query
Model $parent
string $foreignKey
string $ownerKey
string $type
string $relation

Значение возврата

MorphTo

static string getActualClassNameForMorph(string $class)

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

Параметры

string $class

Значение возврата

string

protected string guessBelongsToRelation()

Предположите имя отношения "принадлежит".

Значение возврата

string

HasMany hasMany(string $related, string|null $foreignKey = null, string|null $localKey = null)

Определите отношение один-ко-многим.

Параметры

string $related
string|null $foreignKey
string|null $localKey

Значение возврата

HasMany

protected HasMany newHasMany(Builder $query, Model $parent, string $foreignKey, string $localKey)

Инициализируйте новое отношение один-ко-многим.

Параметры

Builder $query
Model $parent
string $foreignKey
string $localKey

Значение возврата

HasMany

HasManyThrough hasManyThrough(string $related, string $through, string|null $firstKey = null, string|null $secondKey = null, string|null $localKey = null, string|null $secondLocalKey = null)

Определите отношение "многие-ко-многим через".

Параметры

string $related
string $through
string|null $firstKey
string|null $secondKey
string|null $localKey
string|null $secondLocalKey

Значение возврата

HasManyThrough

protected HasManyThrough newHasManyThrough(Builder $query, Model $farParent, Model $throughParent, string $firstKey, string $secondKey, string $localKey, string $secondLocalKey)

Инициализируйте новое отношение "многие-ко-многим через".

Параметры

Builder $query
Model $farParent
Model $throughParent
string $firstKey
string $secondKey
string $localKey
string $secondLocalKey

Значение возврата

HasManyThrough

MorphMany morphMany(string $related, string $name, string|null $type = null, string|null $id = null, string|null $localKey = null)

Определите полиморфное отношение один-ко-многим.

Параметры

string $related
string $name
string|null $type
string|null $id
string|null $localKey

Значение возврата

MorphMany

protected MorphMany newMorphMany(Builder $query, Model $parent, string $type, string $id, string $localKey)

Инициализируйте новое полиморфное отношение "многие ко одному".

Параметры

Builder $query
Model $parent
string $type
string $id
string $localKey

Значение возврата

MorphMany

BelongsToMany belongsToMany(string $related, string|null $table = null, string|null $foreignPivotKey = null, string|null $relatedPivotKey = null, string|null $parentKey = null, string|null $relatedKey = null, string|null $relation = null)

Определите отношение многие-ко-многим.

Параметры

string $related
string|null $table
string|null $foreignPivotKey
string|null $relatedPivotKey
string|null $parentKey
string|null $relatedKey
string|null $relation

Значение возврата

BelongsToMany
END_OF_DOCUMENT_MARKER

protected BelongsToMany newBelongsToMany(Builder $query, Model $parent, string $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string|null $relationName = null)

Инициализировать новое отношение BelongsToMany.

Параметры

Builder $query
Model $parent
string $table
string $foreignPivotKey
string $relatedPivotKey
string $parentKey
string $relatedKey
string|null $relationName

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

BelongsToMany

MorphToMany morphToMany(string $related, string $name, string|null $table = null, string|null $foreignPivotKey = null, string|null $relatedPivotKey = null, string|null $parentKey = null, string|null $relatedKey = null, bool $inverse = false)

Определить полиморфное отношение многие-ко-многим.

Параметры

string $related
string $name
string|null $table
string|null $foreignPivotKey
string|null $relatedPivotKey
string|null $parentKey
string|null $relatedKey
bool $inverse

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

MorphToMany

protected MorphToMany newMorphToMany(Builder $query, Model $parent, string $name, string $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string|null $relationName = null, bool $inverse = false)

Инициализировать новое полиморфное отношение многие-ко-многим.

Параметры

Builder $query
Model $parent
string $name
string $table
string $foreignPivotKey
string $relatedPivotKey
string $parentKey
string $relatedKey
string|null $relationName
bool $inverse

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

MorphToMany

MorphToMany morphedByMany(string $related, string $name, string|null $table = null, string|null $foreignPivotKey = null, string|null $relatedPivotKey = null, string|null $parentKey = null, string|null $relatedKey = null)

Определить полиморфное обратное отношение многие-ко-многим.

Параметры

string $related
string $name
string|null $table
string|null $foreignPivotKey
string|null $relatedPivotKey
string|null $parentKey
string|null $relatedKey

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

MorphToMany

protected string|null guessBelongsToManyRelation()

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

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

string|null

string joiningTable(string $related, Model|null $instance = null)

Получить имя таблицы соединения для отношения многие-ко-многим.

Параметры

string $related
Model|null $instance

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

string

string joiningTableSegment()

Получить часть имени промежуточной таблицы для отношений belongsToMany.

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

string

bool touches(string $relation)

Определить, касается ли модель заданное отношение.

Параметры

string $relation

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

bool

void touchOwners()

Обновить связанные модели.

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

void

protected array getMorphs(string $name, string $type, string $id)

Получить столбцы полиморфного отношения.

Параметры

string $name
string $type
string $id

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

array

string getMorphClass()

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

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

string

protected mixed newRelatedInstance(string $class)

Создать новый экземпляр модели для связанной модели.

Параметры

string $class

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

mixed

array getRelations()

Получить все загруженные отношения для экземпляра.

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

array

mixed getRelation(string $relation)

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

Параметры

string $relation

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

mixed

bool relationLoaded(string $key)

Определить, загружено ли заданное отношение.

Параметры

string $key

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

bool

$this setRelation(string $relation, mixed $value)

Установить указанное отношение для модели.

Параметры

string $relation
mixed $value

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

$this

$this unsetRelation(string $relation)

Удалить загруженное отношение.

Параметры

string $relation

Значение возврата

$this

$this setRelations(array $relations)

Установить массив отношений модели.

Параметры

array $relations

Значение возврата

$this

$this withoutRelations()

Создать дубликат экземпляра и удалить все загруженные отношения.

Значение возврата

$this

$this unsetRelations()

Удалить все загруженные отношения для экземпляра.

Значение возврата

$this

array getTouchedRelations()

Получить отношения, которые затрагиваются при сохранении.

Значение возврата

array

$this setTouchedRelations(array $touches)

Установить отношения, которые затрагиваются при сохранении.

Параметры

array $touches

Значение возврата

$this

bool touch()

Обновить временную метку обновления модели.

Значение возврата

bool

protected void updateTimestamps()

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

Значение возврата

void

$this setCreatedAt(mixed $value)

Установить значение атрибута "created at".

Параметры

mixed $value

Значение возврата

$this

$this setUpdatedAt(mixed $value)

Установить значение атрибута "updated at".

Параметры

mixed $value

Значение возврата

$this

Carbon freshTimestamp()

Получить свежую временную метку для модели.

Значение возврата

Carbon

string freshTimestampString()

Получить свежую временную метку для модели.

Значение возврата

string

bool usesTimestamps()

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

Значение возврата

bool

string|null getCreatedAtColumn()

Получить имя столбца "created at".

Значение возврата

string|null

string|null getUpdatedAtColumn()

Получить имя столбца "updated at".

Значение возврата

string|null

string getQualifiedCreatedAtColumn()

Получить полностью квалифицированный столбец "created at".

Значение возврата

string

string getQualifiedUpdatedAtColumn()

Получить полностью квалифицированный столбец "updated at".

Значение возврата

string

array getHidden()

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

Значение возврата

array

$this setHidden(array $hidden)

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

Параметры

array $hidden

Значение возврата

$this

array getVisible()

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

Значение возврата

array

$this setVisible(array $visible)

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

Параметры

array $visible

Значение возврата

$this

$this makeVisible(array|string|null $attributes)

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

Параметры

array|string|null $attributes

Значение возврата

$this

$this makeVisibleIf(bool|Closure $condition, array|string|null $attributes)

Сделать указанные атрибуты (обычно скрытые) видимыми, если заданное условие истинно.

Параметры

bool|Closure $condition
array|string|null $attributes

Значение возврата

$this

$this makeHidden(array|string|null $attributes)

Скрыть указанные атрибуты (обычно видимые).

Параметры

array|string|null $attributes

Значение возврата

$this

$this makeHiddenIf(bool|Closure $condition, array|string|null $attributes)

Скрыть указанные атрибуты (обычно видимые), если заданное условие истинно.

Параметры

bool|Closure $condition
array|string|null $attributes

Значение возврата

$this

массив getFillable()

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

Значение результата

массив

$this fillable(массив $fillable)

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

Параметры

массив $fillable

Значение результата

$this

$this mergeFillable(массив $fillable)

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

Параметры

массив $fillable

Значение результата

$this

массив getGuarded()

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

Значение результата

массив

$this guard(массив $guarded)

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

Параметры

массив $guarded

Значение результата

$this

$this mergeGuarded(массив $guarded)

Объединить новые защищенные атрибуты с существующими защищенными атрибутами модели.

Параметры

массив $guarded

Значение результата

$this

static void unguard(bool $state = true)

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

Параметры

bool $state

Значение результата

void

static void reguard()

Включить ограничения массового назначения.

Значение результата

void

static bool isUnguarded()

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

Значение результата

bool

static mixed unguarded(callable $callback)

Выполнить заданный вызов в режиме unguarded.

Параметры

callable $callback

Значение результата

mixed

bool isFillable(string $key)

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

Параметры

string $key

Значение результата

bool

bool isGuarded(string $key)

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

Параметры

string $key

Значение результата

bool

protected bool isGuardableColumn(string $key)

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

Параметры

string $key

Значение результата

bool

bool totallyGuarded()

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

Значение результата

bool

protected массив fillableFromArray(массив $attributes)

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

Параметры

массив $attributes

Значение результата

массив

protected mixed forwardCallTo(mixed $object, string $method, массив $parameters)

Переадресовать вызов метода заданному объекту.

Параметры

mixed $object
string $method
массив $parameters

Значение результата

mixed

Исключения

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

Выбросить исключение BadMethodCallException для данного метода.

Параметры

string $method

Значение результата

void

Исключения

BadMethodCallException

void __construct(массив $attributes = [])

Создать новый экземпляр модели Eloquent.

Параметры

массив $attributes

Значение результата

void

protected void bootIfNotBooted()

Проверить, нужно ли запустить инициализацию модели, и если нужно, то сделать это.

Значение результата

void

static protected void booting()

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

Значение результата

void

static protected void boot()

Инициализировать модель и ее трейты.

Значение результата

void

static protected void bootTraits()

Запустить все запустимые трейты модели.

Значение результата

void

protected void initializeTraits()

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

Значение результата

void

static protected void booted()

Выполнить все действия, необходимые после запуска инициализации модели.

Значение результата

void

static void clearBootedModels()

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

Значение результата

void

static void withoutTouching(callable $callback)

Отключает касание модели отношений для текущего класса в рамках заданного блока обратного вызова.

Параметры

callable $callback

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

void

static void withoutTouchingOn(array $models, callable $callback)

Отключает касание модели отношений для указанных классов моделей в рамках заданного блока обратного вызова.

Параметры

array $models
callable $callback

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

void

static bool isIgnoringTouch(string|null $class = null)

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

Параметры

string|null $class

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

bool

$this fill(array $attributes)

Заполняет модель массивом атрибутов.

Параметры

array $attributes

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

$this

Исключения

MassAssignmentException

$this forceFill(array $attributes)

Заполняет модель массивом атрибутов. Вынужденное присвоение значений.

Параметры

array $attributes

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

$this

string qualifyColumn(string $column)

Квалифицирует заданное имя столбца по таблице модели.

Параметры

string $column

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

string

protected string removeTableFromKey(string $key) deprecated

deprecated

Этот метод устарел и будет удален в будущей версии Laravel.

Удаляет имя таблицы из заданного ключа.

Параметры

string $key

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

string

Model newInstance(array $attributes = [], bool $exists = false)

Создает новый экземпляр заданной модели.

Параметры

array $attributes
bool $exists

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

Model

Model newFromBuilder(array $attributes = [], string|null $connection = null)

Создает новый экземпляр модели, которая уже существует.

Параметры

array $attributes
string|null $connection

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

Model

static Builder on(string|null $connection = null)

Начать запросы модели на заданном соединении.

Параметры

string|null $connection

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

Builder

static Builder onWriteConnection()

Начать запросы модели на соединении записи.

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

Builder

static Collection|Model[] all(array|mixed $columns = ['*'])

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

Параметры

array|mixed $columns

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

Collection|Model[]

static Builder with(array|string $relations)

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

Параметры

array|string $relations

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

Builder

$this load(array|string $relations)

Загрузить отношения модели с ленивой загрузкой.

Параметры

array|string $relations

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

$this

$this loadMorph(string $relation, array $relations)

Загрузить отношения на полиморфном отношении модели.

Параметры

string $relation
array $relations

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

$this

$this loadMissing(array|string $relations)

Загрузить отношения модели, если они еще не загружены.

Параметры

array|string $relations

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

$this

$this loadCount(array|string $relations)

Загрузить количество отношений модели.

Параметры

array|string $relations

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

$this

$this loadMorphCount(string $relation, array $relations)

Загрузить количество отношений на полиморфном отношении модели.

Параметры

string $relation
array $relations

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

$this

protected int increment(string $column, float|int $amount = 1, array $extra = [])

Увеличить значение столбца на заданную величину.

Параметры

string $column
float|int $amount
array $extra

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

int

protected int decrement(string $column, float|int $amount = 1, array $extra = [])

Уменьшить значение столбца на заданную величину.

Parameters

string $column
float|int $amount
array $extra

Return Value

int

protected int incrementOrDecrement(string $column, float|int $amount, array $extra, string $method)

Выполнить метод увеличения или уменьшения значения для модели.

Parameters

string $column
float|int $amount
array $extra
string $method

Return Value

int

protected void incrementOrDecrementAttributeValue(string $column, float|int $amount, array $extra, string $method)

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

Parameters

string $column
float|int $amount
array $extra
string $method

Return Value

void

bool update(array $attributes = [], array $options = [])

Обновить модель в базе данных.

Parameters

array $attributes
array $options

Return Value

bool

bool push()

Сохранить модель и все её отношения.

Return Value

bool

bool save(array $options = [])

Сохранить модель в базе данных.

Parameters

array $options

Return Value

bool

bool saveOrFail(array $options = [])

Сохранить модель в базе данных с использованием транзакции.

Parameters

array $options

Return Value

bool

Exceptions

Throwable

protected void finishSave(array $options)

Выполнить необходимые действия после сохранения модели.

Parameters

array $options

Return Value

void

protected bool performUpdate(Builder $query)

Выполнить операцию обновления модели.

Parameters

Builder $query

Return Value

bool

protected Builder setKeysForSaveQuery(Builder $query)

Установить ключи для запроса сохранения.

Parameters

Builder $query

Return Value

Builder

protected mixed getKeyForSaveQuery()

Получить значение первичного ключа для запроса сохранения.

Return Value

mixed

protected bool performInsert(Builder $query)

Выполнить операцию вставки модели.

Parameters

Builder $query

Return Value

bool

protected void insertAndSetId(Builder $query, array $attributes)

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

Parameters

Builder $query
array $attributes

Return Value

void

static int destroy(Collection|array|int|string $ids)

Удалить модели по заданным ID.

Parameters

Collection|array|int|string $ids

Return Value

int

int delete()

Удалить запись пивот-модели из базы данных.

Return Value

int

bool|null forceDelete()

Выполнить полное удаление мягко удалённой модели.

Этот метод защищает разработчиков от выполнения forceDelete, когда трейт отсутствует.

Return Value

bool|null

protected void performDeleteOnModel()

Выполнить фактический запрос удаления для этого экземпляра модели.

Return Value

void

static Builder query()

Начать запросы к модели.

Return Value

Builder

Builder newQuery()

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

Return Value

Builder

Builder|Model newModelQuery()

Получить новый объект построения запроса без глобальных областей или жадного загрузки.

Return Value

Builder|Model
END_OF_DOCUMENT_MARKER

Builder newQueryWithoutRelationships()

Получить новый билдер запроса без загруженных отношений.

Значение возврата

Builder

Builder registerGlobalScopes(Builder $builder)

Зарегистрировать глобальные области видимости для этого экземпляра билдера.

Параметры

Builder $builder

Значение возврата

Builder

Builder|Model newQueryWithoutScopes()

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

Значение возврата

Builder|Model

Builder newQueryWithoutScope(Scope|string $scope)

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

Параметры

Scope|string $scope

Значение возврата

Builder

Builder newQueryForRestoration(int[]|string[]|string $ids)

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

Параметры

int[]|string[]|string $ids

Значение возврата

Builder

Builder|Model newEloquentBuilder(Builder $query)

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

Параметры

Builder $query

Значение возврата

Builder|Model

protected Builder newBaseQueryBuilder()

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

Значение возврата

Builder

Collection newCollection(array $models = [])

Создать новый экземпляр коллекции Eloquent.

Параметры

array $models

Значение возврата

Collection

Pivot newPivot(Model $parent, array $attributes, string $table, bool $exists, string|null $using = null)

Создать новый экземпляр модели pivot.

Параметры

Model $parent
array $attributes
string $table
bool $exists
string|null $using

Значение возврата

Pivot

bool hasNamedScope(string $scope)

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

Параметры

string $scope

Значение возврата

bool

mixed callNamedScope(string $scope, array $parameters = [])

Применить заданную именованную область видимости, если это возможно.

Параметры

string $scope
array $parameters

Значение возврата

mixed

array toArray()

Преобразовать экземпляр модели в массив.

Значение возврата

array

string toJson(int $options = 0)

Преобразовать экземпляр модели в JSON.

Параметры

int $options

Значение возврата

string

Исключения

JsonEncodingException

array jsonSerialize()

Преобразовать объект в сериализуемый в JSON.

Значение возврата

array

Model|null fresh(array|string $with = [])

Перезагрузить свежий экземпляр модели из базы данных.

Параметры

array|string $with

Значение возврата

Model|null

$this refresh()

Перезагрузить текущий экземпляр модели с свежими атрибутами из базы данных.

Значение возврата

$this

Model replicate(array $except = null)

Создать клон модели в новый, не существующий экземпляр.

Параметры

array $except

Значение возврата

Model

bool is(Model|null $model)

Определить, имеют ли две модели одинаковый идентификатор и принадлежат ли одной и той же таблице.

Параметры

Model|null $model

Значение возврата

bool
END_OF_DOCUMENT_MARKER

bool isNot(Model|null $model)

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

Parameters

Model|null $model

Return Value

bool

Подключение getConnection()

Получить подключение к базе данных для модели.

Return Value

Подключение

string|null getConnectionName()

Получить текущее имя подключения для модели.

Return Value

string|null

$this setConnection(string|null $name)

Установить подключение, связанное с моделью.

Parameters

string|null $name

Return Value

$this

static Подключение resolveConnection(string|null $connection = null)

Разрешить экземпляр подключения.

Parameters

string|null $connection

Return Value

Подключение

static Интерфейс разрешения подключений getConnectionResolver()

Получить экземпляр разрешителя подключений.

Return Value

Интерфейс разрешения подключений

static void setConnectionResolver(Интерфейс разрешения подключений $resolver)

Установить экземпляр разрешителя подключений.

Parameters

Интерфейс разрешения подключений $resolver

Return Value

void

static void unsetConnectionResolver()

Удалить разрешитель подключений для моделей.

Return Value

void

string getTable()

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

Return Value

string

$this setTable(string $table)

Установить таблицу, связанную с моделью.

Parameters

string $table

Return Value

$this

string getKeyName()

Получить первичный ключ для модели.

Return Value

string

$this setKeyName(string $key)

Установить первичный ключ для модели.

Parameters

string $key

Return Value

$this

string getQualifiedKeyName()

Получить имя квалифицированного ключа таблицы.

Return Value

string

string getKeyType()

Получить тип автоинкрементного ключа.

Return Value

string

$this setKeyType(string $type)

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

Parameters

string $type

Return Value

$this

bool getIncrementing()

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

Return Value

bool

$this setIncrementing(bool $value)

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

Parameters

bool $value

Return Value

$this

mixed getKey()

Получить значение первичного ключа модели.

Return Value

mixed

mixed getQueueableId()

Получить идентификатор задачи для сущности.

Return Value

mixed

array getQueueableRelations()

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

Return Value

array

string|null getQueueableConnection()

Получить подключение к очереди для сущности.

Return Value

string|null

mixed getRouteKey()

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

Return Value

mixed

string getRouteKeyName()

Получить ключ маршрута для модели.

Return Value

string

Модель|null resolveRouteBinding(mixed $value, string|null $field = null)

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

Parameters

mixed $value
string|null $field

Return Value

Модель|null

Модель|null resolveChildRouteBinding(string $childType, mixed $value, string|null $field)

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

Параметры

string $childType
mixed $value
string|null $field

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

Модель|null

string getForeignKey()

Получить имя внешнего ключа столбца.

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

string

int getPerPage()

Получить количество моделей на страницу.

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

int

$this setPerPage(int $perPage)

Установить количество моделей на страницу.

Параметры

int $perPage

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

$this

mixed __get(string $key)

Динамически получить атрибуты модели.

Параметры

string $key

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

mixed

void __set(string $key, mixed $value)

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

Параметры

string $key
mixed $value

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

void

bool offsetExists(mixed $offset)

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

Параметры

mixed $offset

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

bool

mixed offsetGet(mixed $offset)

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

Параметры

mixed $offset

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

mixed

void offsetSet(mixed $offset, mixed $value)

Установить значение для заданного смещения.

Параметры

mixed $offset
mixed $value

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

void

void offsetUnset(mixed $offset)

Удалить значение для заданного смещения.

Параметры

mixed $offset

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

void

bool __isset(string $key)

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

Параметры

string $key

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

bool

void __unset(string $key)

Удалить атрибут модели.

Параметры

string $key

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

void

mixed __call(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

static mixed __callStatic(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

string __toString()

Преобразовать модель в строковое представление.

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

string

array __sleep()

Подготовить объект к сериализации.

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

array

void __wakeup()

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

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

void

static AsPivot fromAttributes(Модель $parent, array $attributes, string $table, bool $exists = false)

Создать новый экземпляр модели связующей таблицы.

Параметры

Модель $parent
array $attributes
string $table
bool $exists

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

AsPivot

static AsPivot fromRawAttributes(Модель $parent, array $attributes, string $table, bool $exists = false)

Создать новую модель связующей таблицы из сырых значений, возвращаемых запросом.

Параметры

Модель $parent
array $attributes
string $table
bool $exists

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

AsPivot

protected Билдер getDeleteQuery()

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

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

Билдер

string getRelatedKey()

Получить имя столбца "связанного ключа".

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

string

string getOtherKey()

Получить имя столбца "связанного ключа".

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

string

$this setPivotKeys(string $foreignKey, string $relatedKey)

Установить имена ключей для экземпляра модели pivot.

Параметры

string $foreignKey
string $relatedKey

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

$this

bool hasTimestampAttributes(array|null $attributes = null)

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

Параметры

array|null $attributes

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

bool

protected Builder newQueryForCollectionRestoration(array $ids)

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

Параметры

array $ids

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

Builder

$this setMorphType(string $morphType)

Установить тип морфинга для pivot.

Параметры

string $morphType

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

$this

MorphPivot setMorphClass(string $morphClass)

Установить класс морфинга для pivot.

Параметры

string $morphClass

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

MorphPivot

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/7.x/Illuminate/Database/Eloquent/Relations/MorphPivot.html

Spec-Zone.ru

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