Spec-Zone.ru › Laravel 5.6

MorphPivot

class MorphPivot extends Pivot (View source)

Трейты

HasAttributes
HasEvents
HasGlobalScopes
HasRelationships
HasTimestamps
HidesAttributes
GuardsAttributes

Константы

CREATED_AT

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

UPDATED_AT

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

Свойства

protected массив $attributes Атрибуты модели. из HasAttributes
protected массив $original Исходное состояние атрибутов модели. из HasAttributes
protected массив $changes Измененные атрибуты модели. из HasAttributes
protected массив $casts Атрибуты, которые должны быть преобразованы в базовые типы. из 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
bool $timestamps Указывает, должна ли модель содержать метки времени. из HasTimestamps
protected массив $hidden Атрибуты, которые должны быть скрыты при сериализации. из HidesAttributes
protected массив $visible Атрибуты, которые должны быть видны при сериализации. из HidesAttributes
protected массив $fillable Атрибуты, которые можно массово присваивать. из GuardsAttributes
protected массив $guarded Атрибуты, которые нельзя массово присваивать. из GuardsAttributes
static protected bool $unguarded Указывает, разрешены ли все массовые присвоения. из GuardsAttributes
protected строка $connection Имя подключения для модели. из Модель
protected строка $table Таблица, связанная с моделью. из Модель
protected строка $primaryKey Первичный ключ для модели. из Модель
protected строка $keyType Тип автоинкрементирующегося ID. из Модель
bool $incrementing Указывает, являются ли идентификаторы автоинкрементирующимися. из Модель
protected массив $with Связи, которые нужно загрузить с помощью eager loading. из Модель
protected массив $withCount Подсчеты связей, которые нужно загрузить с помощью eager loading. из Модель
protected целое число $perPage Количество моделей для возвращения при пагинации. из Модель
bool $exists Указывает, существует ли модель. из Модель
bool $wasRecentlyCreated Указывает, была ли модель вставлена во время текущего жизненного цикла запроса. из Модель
static protected ConnectionResolverInterface $resolver Экземпляр решателя подключения. из Модель
static protected Dispatcher $dispatcher Экземпляр диспетчера событий. из Модель
static protected массив $booted Массив запущенных моделей. из Модель
static protected массив $globalScopes Массив глобальных scope модели. из Модель
static protected массив $ignoreOnTouch Список классов моделей, которые не должны затрагиваться методом touch. из Модель
Модель $pivotParent Родительская модель связи. из Pivot
protected строка $foreignKey Имя столбца внешнего ключа. из Pivot
protected строка $relatedKey Имя столбца "другого ключа". из Pivot
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)

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

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

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

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

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

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

Привести атрибут к типу PHP.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

из HasAttributes
массив getArrayAttributeByKey(строка $key)

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

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

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

из HasAttributes
string asJson(mixed $value)

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

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

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

from HasAttributes
Carbon asDate(mixed $value)

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

from HasAttributes
Carbon asDateTime(mixed $value)

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

from HasAttributes
bool isStandardDateFormat(string $value)

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

from HasAttributes
string fromDateTime(DateTime|int $value)

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

from HasAttributes
int asTimestamp(mixed $value)

Возвращает временную метку как Unix timestamp.

from HasAttributes
string serializeDate(DateTimeInterface $date)

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

from HasAttributes
array getDates()

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

from HasAttributes
string getDateFormat()

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

from HasAttributes
$this setDateFormat(string $format)

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

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

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

from HasAttributes
array getCasts()

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

from HasAttributes
bool isDateCastable(string $key)

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

from HasAttributes
bool isJsonCastable(string $key)

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

from HasAttributes
array getAttributes()

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

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

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

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

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

from HasAttributes
array only(array|mixed $attributes)

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

from HasAttributes
$this syncOriginal()

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

from HasAttributes
$this syncOriginalAttribute(string $attribute)

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

from HasAttributes
$this syncChanges()

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

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

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

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

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

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

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

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

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

from HasAttributes
array getDirty()

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

from HasAttributes
array getChanges()

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

from HasAttributes
bool originalIsEquivalent(string $key, mixed $current)

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

from HasAttributes
$this append(array|string $attributes)

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

из HasAttributes
$this setAppends(array $appends)

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

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

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

из HasAttributes
static void cacheMutatedAttributes(string $class)

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

из HasAttributes
static массив getMutatorMethods(mixed $class)

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

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

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

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

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

из HasEvents
массив 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 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 addGlobalScope(Scope|Closure|string $scope, Closure $implementation = null)

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

from HasGlobalScopes
static bool hasGlobalScope(Scope|string $scope)

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

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

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

from HasGlobalScopes
array getGlobalScopes()

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

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

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

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

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

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

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

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

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

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

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

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

Инициализировать новое отношение "принадлежит".

from HasRelationships
MorphTo morphTo(string $name = null, string $type = null, string $id = null, string $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)

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

from HasRelationships
static string getActualClassNameForMorph(string $class)

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

from HasRelationships
string guessBelongsToRelation()

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

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

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

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

Инициализировать новое отношение "один ко многим".

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

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

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

Инициализировать новое отношение "один ко многим через".

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

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

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

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

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

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

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

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

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

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

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

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

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

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

from HasRelationships
string guessBelongsToManyRelation()

Получить имя отношения «многие ко многим».

from HasRelationships
string joiningTable(string $related)

Получить имя таблицы соединения для отношения «многие ко многим».

from HasRelationships
bool touches(string $relation)

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

from HasRelationships
void touchOwners()

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

from HasRelationships
array getMorphs(string $name, string $type, string $id)

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

from HasRelationships
string getMorphClass()

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

from HasRelationships
mixed newRelatedInstance(string $class)

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

from HasRelationships
array getRelations()

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

from HasRelationships
mixed getRelation(string $relation)

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

from HasRelationships
bool relationLoaded(string $key)

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

from HasRelationships
$this setRelation(string $relation, mixed $value)

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

from HasRelationships
$this unsetRelation(string $relation)

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

from HasRelationships
$this setRelations(array $relations)

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

from HasRelationships
array getTouchedRelations()

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

from HasRelationships
$this setTouchedRelations(array $touches)

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

from HasRelationships
bool touch()

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

from HasTimestamps
void updateTimestamps()

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

from HasTimestamps
$this setCreatedAt(mixed $value)

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

from HasTimestamps
$this setUpdatedAt(mixed $value)

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

from HasTimestamps
Carbon freshTimestamp()

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

from HasTimestamps
string freshTimestampString()

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

from HasTimestamps
bool usesTimestamps()

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

from HasTimestamps
string getCreatedAtColumn()

Получить имя столбца "дата создания".

from HasTimestamps
string getUpdatedAtColumn()

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

from HasTimestamps
array getHidden()

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

from HidesAttributes
$this setHidden(array $hidden)

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

from HidesAttributes
void addHidden(array|string|null $attributes = null)

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

from HidesAttributes
array getVisible()

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

from HidesAttributes
$this setVisible(array $visible)

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

from HidesAttributes
void addVisible(array|string|null $attributes = null)

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

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

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

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

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

from HidesAttributes
array getFillable()

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

from GuardsAttributes
$this fillable(array $fillable)

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

from GuardsAttributes
array getGuarded()

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

from GuardsAttributes
$this guard(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 totallyGuarded()

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

from GuardsAttributes
array fillableFromArray(array $attributes)

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

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

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

from Model
void bootIfNotBooted()

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

from Model
static void boot()

Метод "загрузки" модели.

from Model
static void bootTraits()

Загрузить все загружаемые черты в модели.

from Model
static void clearBootedModels()

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

from Model
static void withoutTouching(callable $callback)

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

from Model
static void withoutTouchingOn(array $models, callable $callback)

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

from Model
static bool isIgnoringTouch(string|null $class = null)

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

from Model
$this fill(array $attributes)

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

from Model
$this forceFill(array $attributes)

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

from Model
string qualifyColumn(string $column)

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

from Model
string removeTableFromKey(string $key)

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

from Model
Model newInstance(array $attributes = [], bool $exists = false)

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

from Model
Model newFromBuilder(array $attributes = [], string|null $connection = null)

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

from Model
static Builder on(string|null $connection = null)

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

from Model
static Builder onWriteConnection()

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

from Model
static Collection|Model[] all(array|mixed $columns = ['*'])

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

from Model
static Builder|Model with(array|string $relations)

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

from Model
$this load(array|string $relations)

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

from Model
$this loadMissing(array|string $relations)

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

from Model
int increment(string $column, float|int $amount = 1, array $extra = [])

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

from Model
int decrement(string $column, float|int $amount = 1, array $extra = [])

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

from Model
int incrementOrDecrement(string $column, float|int $amount, array $extra, string $method)

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

from Model
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(array|int $ids)

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

from Model
bool|null 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(array|int $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
array toArray()

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

from Model
string toJson(int $options)

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

from Model
array jsonSerialize()

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

from Model
Model|null fresh(array|string $with = [])

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

from Model
$this refresh()

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

from Model
Model replicate(array $except = null)

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

from Model
bool is(Model|null $model)

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

from Model
bool isNot(Model|null $model)

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

from Model
Connection getConnection()

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

from Model
string getConnectionName()

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

from Model
$this setConnection(string $name)

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

from Model
static Connection resolveConnection(string|null $connection = null)

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

from Model
static ConnectionResolverInterface getConnectionResolver()

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

from Model
static void setConnectionResolver(ConnectionResolverInterface $resolver)

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

from Model
static void unsetConnectionResolver()

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

from Model
string getTable()

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

from Pivot
$this setTable(string $table)

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

from Model
string getKeyName()

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

from Model
$this setKeyName(string $key)

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

from Model
string getQualifiedKeyName()

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

from Model
string getKeyType()

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

from Model
$this setKeyType(string $type)

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

from Model
bool getIncrementing()

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

from Model
$this setIncrementing(bool $value)

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

from Model
mixed getKey()

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

from Model
mixed getQueueableId()

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

array getQueueableRelations()

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

from Model
string|null getQueueableConnection()

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

from Model
mixed getRouteKey()

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

from Model
string getRouteKeyName()

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

from Model
Model|null resolveRouteBinding(mixed $value)

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

from Model
string getForeignKey()

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

from Pivot
int getPerPage()

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

from Model
$this setPerPage(int $perPage)

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

from Model
mixed __get(string $key)

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

from Model
void __set(string $key, mixed $value)

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

from Model
bool offsetExists(mixed $offset)

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

from Model
mixed offsetGet(mixed $offset)

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

from Model
void offsetSet(mixed $offset, mixed $value)

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

from Model
void offsetUnset(mixed $offset)

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

from Model
bool __isset(string $key)

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

from Model
void __unset(string $key)

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

from Model
mixed __call(string $method, array $parameters)

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

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

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

from Model
string __toString()

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

from Model
void __wakeup()

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

from Model
static Pivot fromAttributes(Model $parent, array $attributes, string $table, bool $exists = false)

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

from Pivot
static Pivot fromRawAttributes(Model $parent, array $attributes, string $table, bool $exists = false)

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

from Pivot
Builder getDeleteQuery()

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

from Pivot
string getRelatedKey()

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

from Pivot
string getOtherKey()

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

from Pivot
$this setPivotKeys(string $foreignKey, string $relatedKey)

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

from Pivot
bool hasTimestampAttributes()

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

from Pivot
Builder newQueryForCollectionRestoration(array $ids)

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

$this setMorphType(string $morphType)

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

MorphPivot setMorphClass(string $morphClass)

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

Подробности

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)

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

Parameters

string $key
mixed $value

Return Value

mixed

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

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

Parameters

string $key
mixed $value

Return Value

mixed

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

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

Parameters

string $key
mixed $value

Return Value

mixed

protected string getCastType(string $key)

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

Parameters

string $key

Return Value

string

protected bool isCustomDateTimeCast(string $cast)

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

Parameters

string $cast

Return Value

bool

mixed setAttribute(string $key, mixed $value)

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

Parameters

string $key
mixed $value

Return Value

mixed

bool hasSetMutator(string $key)

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

Parameters

string $key

Return Value

bool

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

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

Parameters

string $key
mixed $value

Return 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 $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

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 fromDateTime(DateTime|int $value)

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

Parameters

DateTime|int $value

Return Value

string

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

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

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 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

protected bool originalIsEquivalent(string $key, mixed $current)

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

Parameters

string $key
mixed $current

Return Value

bool

$this append(array|string $attributes)

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

Parameters

array|string $attributes

Return Value

$this

$this setAppends(array $appends)

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

Параметры

массив $appends

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

$this

array getMutatedAttributes()

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

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

массив

static void cacheMutatedAttributes(string $class)

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

Параметры

строка $class

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

void

static protected array getMutatorMethods(mixed $class)

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

Параметры

смешанный тип $class

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

массив

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

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

Параметры

объект|массив|строка $classes

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

void

protected void registerObserver(object|string $class)

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

Параметры

объект|строка $class

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

void

array getObservableEvents()

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

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

массив

$this setObservableEvents(array $observables)

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

Параметры

массив $observables

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

$this

void addObservableEvents(array|mixed $observables)

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

Параметры

массив|смешанный тип $observables

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

void

void removeObservableEvents(array|mixed $observables)

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

Параметры

массив|смешанный тип $observables

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

void

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

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

Параметры

строка $event
Closure|строка $callback

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

void

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

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

Параметры

строка $event
булево $halt

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

смешанный тип

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

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

Параметры

строка $event
строка $method

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

смешанный тип|null

protected mixed filterModelEventResults(mixed $result)

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

Параметры

смешанный тип $result

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

смешанный тип

static void retrieved(Closure|string $callback)

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

Параметры

Closure|строка $callback

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

void

static void saving(Closure|string $callback)

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

Параметры

Closure|строка $callback

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

void

static void saved(Closure|string $callback)

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

Параметры

Closure|строка $callback

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

void

static void updating(Closure|string $callback)

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

Параметры

Closure|строка $callback

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

void

static void updated(Closure|string $callback)

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

Параметры

Closure|строка $callback

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

void

static void creating(Closure|string $callback)

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

Параметры

Closure|строка $callback

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

void

static void created(Closure|string $callback)

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

Параметры

Closure|строка $callback

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

void

static void deleting(Closure|string $callback)

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

Parameters

Closure|string $callback

Return Value

void

static void deleted(Closure|string $callback)

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

Parameters

Closure|string $callback

Return Value

void

static void flushEventListeners()

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

Return Value

void

static Dispatcher getEventDispatcher()

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

Return Value

Dispatcher

static void setEventDispatcher(Dispatcher $dispatcher)

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

Parameters

Dispatcher $dispatcher

Return Value

void

static void unsetEventDispatcher()

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

Return Value

void

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

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

Parameters

Scope|Closure|string $scope
Closure $implementation

Return Value

mixed

Exceptions

InvalidArgumentException

static bool hasGlobalScope(Scope|string $scope)

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

Parameters

Scope|string $scope

Return Value

bool

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

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

Parameters

Scope|string $scope

Return Value

Scope|Closure|null

array getGlobalScopes()

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

Return Value

array

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

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

Parameters

string $related
string $foreignKey
string $localKey

Return Value

HasOne

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

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

Parameters

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

Return Value

HasOne

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

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

Parameters

string $related
string $name
string $type
string $id
string $localKey

Return Value

MorphOne

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

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

Parameters

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

Return Value

MorphOne

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

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

Parameters

string $related
string $foreignKey
string $ownerKey
string $relation

Return Value

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 $name = null, string $type = null, string $id = null, string $ownerKey = null)

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

Параметры

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

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

MorphTo

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

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

Параметры

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

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

MorphTo

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)

Создать новую полиморфную связь MorphTo.

Параметры

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

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

MorphTo

static string getActualClassNameForMorph(string $class)

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

Параметры

string $class

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

string

protected string guessBelongsToRelation()

Угадать имя отношения "belongs to".

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

string

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

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

Параметры

string $related
string $foreignKey
string $localKey

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

HasMany

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

Создать новую связь HasMany.

Параметры

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)

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

Параметры

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)

Создать новую связь HasManyThrough.

Параметры

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

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

HasManyThrough

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

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

Параметры

string $related
string $name
string $type
string $id
string $localKey

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

MorphMany

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

Создать новое отношение MorphMany.

Параметры

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

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

MorphMany

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

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

Параметры

string $related
string $table
string $foreignPivotKey
string $relatedPivotKey
string $parentKey
string $relatedKey
string $relation

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

BelongsToMany

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

Создать новое отношение BelongsToMany.

Параметры

Builder $query
Model $parent
string $table
string $foreignPivotKey
string $relatedPivotKey
string $parentKey
string $relatedKey
string $relationName

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

BelongsToMany

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

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

Параметры

string $related
string $name
string $table
string $foreignPivotKey
string $relatedPivotKey
string $parentKey
string $relatedKey
bool $inverse

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

MorphToMany

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

Создать новое полиморфное отношение многие-ко-многим.

Параметры

Builder $query
Model $parent
string $name
string $table
string $foreignPivotKey
string $relatedPivotKey
string $parentKey
string $relatedKey
string $relationName
bool $inverse

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

MorphToMany

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

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

Параметры

string $related
string $name
string $table
string $foreignPivotKey
string $relatedPivotKey
string $parentKey
string $relatedKey

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

MorphToMany

protected string guessBelongsToManyRelation()

Получить имя отношения многие-ко-многим.

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

string

string joiningTable(string $related)

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

Параметры

string $related

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

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

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 getCreatedAtColumn()

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

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

string

string getUpdatedAtColumn()

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

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

string

array getHidden()

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

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

array

$this setHidden(array $hidden)

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

Параметры

array $hidden

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

$this

void addHidden(array|string|null $attributes = null)

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

Параметры

array|string|null $attributes

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

void

array getVisible()

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

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

array

$this setVisible(array $visible)

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

Параметры

array $visible

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

$this

void addVisible(array|string|null $attributes = null)

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

Параметры

array|string|null $attributes

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

void

$this makeVisible(array|string $attributes)

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

Параметры

array|string $attributes

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

$this

$this makeHidden(array|string $attributes)

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

Параметры

array|string $attributes

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

$this

array getFillable()

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

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

array

$this fillable(array $fillable)

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

Параметры

массив $fillable

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

$this

array getGuarded()

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

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

массив

$this guard(array $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)

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

Параметры

строка $key

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

bool

bool isGuarded(string $key)

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

Параметры

строка $key

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

bool

bool totallyGuarded()

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

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

bool

protected array fillableFromArray(array $attributes)

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

Параметры

массив $attributes

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

массив

void __construct(array $attributes = [])

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

Параметры

массив $attributes

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

void

protected void bootIfNotBooted()

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

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

void

static protected void boot()

Метод «загрузки» модели.

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

void

static protected void bootTraits()

Загрузить все загружаемые трейты модели.

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

void

static void clearBootedModels()

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

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

void

static void withoutTouching(callable $callback)

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

Параметры

callable $callback

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

void

static void withoutTouchingOn(array $models, callable $callback)

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

Параметры

массив $models
callable $callback

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

void

static bool isIgnoringTouch(string|null $class = null)

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

Параметры

строка|null $class

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

bool

$this fill(array $attributes)

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

Параметры

массив $attributes

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

$this

Исключения

MassAssignmentException

$this forceFill(array $attributes)

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

Параметры

массив $attributes

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

$this

string qualifyColumn(string $column)

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

Параметры

строка $column

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

строка

protected string removeTableFromKey(string $key)

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

Параметры

строка $key

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

строка

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

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

Параметры

массив $attributes
bool $exists

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

Модель

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

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

Параметры

array $attributes
string|null $connection

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

Модель

static Построитель on(string|null $connection = null)

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

Параметры

string|null $connection

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

Построитель

static Построитель onWriteConnection()

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

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

Построитель

static Коллекция|Модель[] all(array|mixed $columns = ['*'])

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

Параметры

array|mixed $columns

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

Коллекция|Модель[]

static Построитель|Модель with(array|string $relations)

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

Параметры

array|string $relations

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

Построитель|Модель

$this load(array|string $relations)

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

Параметры

array|string $relations

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

$this

$this loadMissing(array|string $relations)

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

Параметры

array|string $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 = [])

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

Параметры

string $column
float|int $amount
array $extra

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

int

protected int incrementOrDecrement(string $column, float|int $amount, array $extra, string $method)

Выполнить метод увеличения или уменьшения для модели.

Параметры

string $column
float|int $amount
array $extra
string $method

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

int

protected void incrementOrDecrementAttributeValue(string $column, float|int $amount, array $extra, string $method)

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

Параметры

string $column
float|int $amount
array $extra
string $method

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

void

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

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

Параметры

array $attributes
array $options

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

bool

bool push()

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

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

bool

bool save(array $options = [])

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

Параметры

array $options

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

bool

bool saveOrFail(array $options = [])

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

Параметры

array $options

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

bool

Исключения

Исключение

protected void finishSave(array $options)

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

Параметры

array $options

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

void

protected bool performUpdate(Построитель $query)

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

Параметры

Построитель $query

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

bool

protected Построитель setKeysForSaveQuery(Построитель $query)

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

Параметры

Построитель $query

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

Построитель

protected mixed getKeyForSaveQuery()

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

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

mixed

protected bool performInsert(Builder $query)

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

Параметры

Builder $query

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

bool

protected void insertAndSetId(Builder $query, array $attributes)

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

Параметры

Builder $query
array $attributes

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

void

static int destroy(array|int $ids)

Удалить модели для заданных ID.

Параметры

array|int $ids

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

int

bool|null delete()

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

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

bool|null

bool|null forceDelete()

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

Этот метод защищает разработчиков от запуска forceDelete, когда отсутствует trait.

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

bool|null

protected void performDeleteOnModel()

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

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

void

static Builder query()

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

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

Builder

Builder newQuery()

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

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

Builder

Builder|Model newModelQuery()

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

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

Builder|Model

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(array|int $ids)

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

Параметры

array|int $ids

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

Builder

Builder|Model newEloquentBuilder(Builder $query)

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

Параметры

Builder $query

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

Builder|Model

protected Builder newBaseQueryBuilder()

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

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

Builder

Collection newCollection(array $models = [])

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

Параметры

array $models

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

Collection

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

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

Параметры

Model $parent
array $attributes
string $table
bool $exists
string|null $using

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

Pivot

array toArray()

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

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

array

строка toJson(int $options)

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

Параметры

int $options

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

строка

Исключения

JsonEncodingException

массив jsonSerialize()

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

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

массив

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

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

Параметры

array|string $with

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

Модель|null

$this refresh()

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

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

$this

Модель replicate(array $except = null)

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

Параметры

массив $except

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

Модель

bool is(Модель|null $model)

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

Параметры

Модель|null $model

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

bool

bool isNot(Модель|null $model)

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

Параметры

Модель|null $model

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

bool

Подключение getConnection()

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

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

Подключение

строка getConnectionName()

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

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

строка

$this setConnection(string $name)

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

Параметры

строка $name

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

$this

static Подключение resolveConnection(string|null $connection = null)

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

Параметры

строка|null $connection

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

Подключение

static Интерфейс разрёшения подключений getConnectionResolver()

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

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

Интерфейс разрёшения подключений

static void setConnectionResolver(Интерфейс разрёшения подключений $resolver)

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

Параметры

Интерфейс разрёшения подключений $resolver

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

void

static void unsetConnectionResolver()

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

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

void

строка getTable()

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

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

строка

$this setTable(string $table)

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

Параметры

строка $table

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

$this

строка getKeyName()

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

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

строка

$this setKeyName(string $key)

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

Параметры

строка $key

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

$this

строка getQualifiedKeyName()

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

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

строка

строка getKeyType()

Получить тип автоматически увеличивающегося ключа.

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

строка

$this setKeyType(string $type)

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

Параметры

строка $type

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

$this

bool getIncrementing()

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

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

bool

$this setIncrementing(bool $value)

Указать, увеличиваются ли ID.

Параметры

bool $value

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

$this

mixed getKey()

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

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

mixed

mixed getQueueableId()

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

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

mixed

array getQueueableRelations()

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

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

array

string|null getQueueableConnection()

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

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

string|null

mixed getRouteKey()

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

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

mixed

string getRouteKeyName()

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

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

string

Model|null resolveRouteBinding(mixed $value)

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

Параметры

mixed $value

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

Model|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

void __wakeup()

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

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

void

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

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

Параметры

Model $parent
array $attributes
string $table
bool $exists

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

Pivot

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

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

Параметры

Model $parent
массив $attributes
строка $table
булево $exists

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

Pivot

protected Builder getDeleteQuery()

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

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

Builder

строка getRelatedKey()

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

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

строка

строка getOtherKey()

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

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

строка

$this setPivotKeys(string $foreignKey, string $relatedKey)

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

Параметры

строка $foreignKey
строка $relatedKey

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

$this

bool hasTimestampAttributes()

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

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

bool

protected Builder newQueryForCollectionRestoration(array $ids)

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

Параметры

массив $ids

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

Builder

$this setMorphType(string $morphType)

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

Параметры

строка $morphType

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

$this

MorphPivot setMorphClass(string $morphClass)

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

Параметры

строка $morphClass

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

MorphPivot

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

Spec-Zone.ru

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