Spec-Zone.ru › Laravel 5.7

Pivot

class Pivot extends Model (View source)

Особенности

AsPivot
HasAttributes
HasEvents
HasGlobalScopes
HasRelationships
HasTimestamps
HidesAttributes
GuardsAttributes
ForwardsCalls

Константы

CREATED_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 Указывает, преобразуются ли атрибуты в snake_case в массивах. из 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 Атрибуты, которые нельзя массово назначать.
static protected bool $unguarded Указывает, разрешена ли массовая присваивание для всех атрибутов. из GuardsAttributes
protected строка $connection Имя подключения для модели. из Model
protected строка $table Таблица, связанная с моделью. из Model
protected строка $primaryKey Первичный ключ модели. из Model
protected строка $keyType Тип автоинкрементирующего ID. из Model
bool $incrementing Указывает, являются ли ID автоинкрементирующими. из Model
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 массив $booted Массив загруженных моделей. из Model
static protected массив $traitInitializers Массив инициализаторов трейтов, которые будут вызваны при каждом новом экземпляре. из Model
static protected массив $globalScopes Массив глобальных скопов модели. из Model
static protected массив $ignoreOnTouch Список классов моделей, которые не должны быть затронуты методом touch. из Model
Модель $pivotParent Родительская модель отношения. из AsPivot
protected строка $foreignKey Имя столбца внешнего ключа. из AsPivot
protected string $relatedKey Имя столбца "другого ключа". from AsPivot

Методы

массив 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
смешанный castAttribute(строка $key, смешанный $value)

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

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

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

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

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

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

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

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

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

из 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.

из HasAttributes
mixed fromFloat(mixed $value)

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

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

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

из HasAttributes
Carbon asDate(mixed $value)

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

из HasAttributes
Carbon asDateTime(mixed $value)

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

из HasAttributes
bool isStandardDateFormat(string $value)

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

из HasAttributes
string fromDateTime(DateTime|int $value)

Преобразовать DateTime в строку, подходящую для хранения.

из HasAttributes
int asTimestamp(mixed $value)

Возвращает метку времени как Unix-метку.

из HasAttributes
string serializeDate(DateTimeInterface $date)

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

из HasAttributes
array getDates()

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

из HasAttributes
string getDateFormat()

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

из HasAttributes
$this setDateFormat(string $format)

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

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

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

из HasAttributes
array getCasts()

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

из HasAttributes
bool isDateCastable(string $key)

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

из HasAttributes
bool isJsonCastable(string $key)

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

из HasAttributes
array getAttributes()

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

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

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

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

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

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

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

из HasAttributes
$this syncOriginal()

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

из HasAttributes
$this syncOriginalAttribute(string $attribute)

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

из 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, mixed $current)

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

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

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

from HasAttributes
$this setAppends(array $appends)

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

from HasAttributes
array getMutatedAttributes()

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

from HasAttributes
static void cacheMutatedAttributes(string $class)

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

from HasAttributes
static array getMutatorMethods(mixed $class)

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

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

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

from HasEvents
void registerObserver(object|string $class)

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

from HasEvents
array getObservableEvents()

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

from HasEvents
$this setObservableEvents(array $observables)

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

from HasEvents
void addObservableEvents(array|mixed $observables)

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

from HasEvents
void removeObservableEvents(array|mixed $observables)

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

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

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

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

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

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

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

from HasEvents
mixed filterModelEventResults(mixed $result)

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

from HasEvents
static void retrieved(Closure|string $callback)

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

from HasEvents
static void saving(Closure|string $callback)

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

from HasEvents
static void saved(Closure|string $callback)

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

from HasEvents
static void updating(Closure|string $callback)

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

from HasEvents
static void updated(Closure|string $callback)

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

from HasEvents
static void creating(Closure|string $callback)

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

from HasEvents
static void created(Closure|string $callback)

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

from HasEvents
static void deleting(Closure|string $callback)

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

from HasEvents
static void deleted(Closure|string $callback)

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

from HasEvents
static void flushEventListeners()

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

from HasEvents
static Dispatcher getEventDispatcher()

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

from HasEvents
static void setEventDispatcher(Dispatcher $dispatcher)

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

from HasEvents
static void unsetEventDispatcher()

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

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

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

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)

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

from HasRelationships
static string getActualClassNameForMorph(string $class)

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

from HasRelationships
string guessBelongsToRelation()

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

from HasRelationships
HasMany hasMany(string $related, string $foreignKey = null, string $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 $type = null, string $id = null, string $localKey = null)

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

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

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

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)

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

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)

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

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

Получить имя отношения belongs to many.

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

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

from HasRelationships
string joiningTableSegment()

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

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

Метод "инициализации" модели.

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

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

from Модель
void initializeTraits()

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

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 loadMissing(array|string $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 Модель
bool update(array $attributes = [], array $options = [])

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

from Модель
bool push()

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

from Модель
bool save(array $options = [])

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

from Модель
bool saveOrFail(array $options = [])

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

from Model
void finishSave(array $options)

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

from Model
bool performUpdate(Builder $query)

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

from Model
Builder setKeysForSaveQuery(Builder $query)

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

from AsPivot
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 $ids)

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

from Model
int delete()

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

from AsPivot
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)

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

from AsPivot
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)

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

from Model
array toArray()

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

from Model
string toJson(int $options = 0)

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

from Model
array jsonSerialize()

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

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

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

from Model
$this refresh()

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

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

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

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

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

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

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

из Модель
Соединение getConnection()

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

из Модель
string getConnectionName()

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

из Модель
$this setConnection(string $name)

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

из Модель
static Соединение resolveConnection(string|null $connection = null)

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

из Модель
static Интерфейс разрешения соединения getConnectionResolver()

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

из Модель
static void setConnectionResolver(Интерфейс разрешения соединения $resolver)

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

из Модель
static void unsetConnectionResolver()

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

из Модель
string getTable()

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

из AsPivot
$this setTable(string $table)

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

из Модель
string getKeyName()

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

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

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

из Модель
string getQualifiedKeyName()

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

из Модель
string getKeyType()

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

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

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

из Модель
bool getIncrementing()

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

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

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

из Модель
mixed getKey()

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

из Модель
mixed getQueueableId()

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

из AsPivot
array getQueueableRelations()

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

из Модель
string|null getQueueableConnection()

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

из Модель
mixed getRouteKey()

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

из Модель
string getRouteKeyName()

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

из Модель
Модель|null resolveRouteBinding(mixed $value)

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

из Модель
string getForeignKey()

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

из AsPivot
int getPerPage()

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

из Модель
$this setPerPage(int $perPage)

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

из Модель
mixed __get(string $key)

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

из Модель
void __set(string $key, mixed $value)

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

из Модель
bool offsetExists(mixed $offset)

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

из Модель
mixed offsetGet(mixed $offset)

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

из Модель
void offsetSet(mixed $offset, mixed $value)

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

из Модель
void offsetUnset(mixed $offset)

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

из Модель
bool __isset(string $key)

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

из Модель
void __unset(string $key)

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

из Модель
mixed __call(string $method, array $parameters)

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

из Модель
static mixed __callStatic(string $method, array $parameters)

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

из Модель
string __toString()

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

из Модель
void __wakeup()

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

из Модель
static AsPivot fromAttributes(Модель $parent, array $attributes, string $table, bool $exists = false)

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

из AsPivot
static AsPivot fromRawAttributes(Модель $parent, array $attributes, string $table, bool $exists = false)

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

из AsPivot
Builder getDeleteQuery()

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

из AsPivot
string getRelatedKey()

Получить имя колонки "related key".

из AsPivot
string getOtherKey()

Получить имя колонки "related key".

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

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

из AsPivot
bool hasTimestampAttributes()

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

из AsPivot
Builder newQueryForCollectionRestoration(array $ids)

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

из AsPivot

Подробности

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

смешанный getAttributeValue(строка $key)

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

Параметры

строка $key

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

смешанный

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

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

Параметры

строка $key

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

смешанный

смешанный getRelationValue(строка $key)

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

Параметры

строка $key

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

смешанный

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

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

Параметры

строка $method

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

смешанный

Исключения

LogicException

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

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

Параметры

строка $key

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

логический

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

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

Параметры

строка $key
смешанный $value

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

смешанный

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

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

Параметры

строка $key
смешанный $value

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

смешанный

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

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

Параметры

строка $key
смешанный $value

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

смешанный

защищенное строка getCastType(строка $key)

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

Параметры

строка $key

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

строка

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

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

Параметры

строка $cast

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

логический

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

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

Параметры

строка $key
смешанный $value

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

смешанный

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

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

Параметры

строка $key

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

логический

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

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

Параметры

строка $key
смешанный $value

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

смешанный

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

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

Параметры

строка $key

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

логический

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

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

Параметры

строка $key
смешанный $value

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

$this

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

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

Параметры

строка $path
строка $key
смешанный $value

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

$this

защищенное массив getArrayAttributeByKey(строка $key)

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

Параметры

строка $key

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

массив

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

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

Параметры

строка $key
смешанный $value

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

строка

защищенное строка asJson(смешанный $value)

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

Параметры

смешанный $value

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

строка

смешанный fromFloat(смешанный $value)

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

Параметры

смешанный $value

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

смешанный

смешанный fromJson(строка $value, логический $asObject = ложь)

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

Параметры

строка $value
логический $asObject

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

смешанный
END_OF_DOCUMENT_MARKER

protected Carbon asDate(mixed $value)

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

Параметры

mixed $value

Значение результата

Carbon

protected Carbon asDateTime(mixed $value)

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

Параметры

mixed $value

Значение результата

Carbon

protected bool isStandardDateFormat(string $value)

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

Параметры

string $value

Значение результата

bool

string fromDateTime(DateTime|int $value)

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

Параметры

DateTime|int $value

Значение результата

string

protected int asTimestamp(mixed $value)

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

Параметры

mixed $value

Значение результата

int

protected string serializeDate(DateTimeInterface $date)

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

Параметры

DateTimeInterface $date

Значение результата

string

array getDates()

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

Значение результата

array

string getDateFormat()

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

Значение результата

string

$this setDateFormat(string $format)

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

Параметры

string $format

Значение результата

$this

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

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

Параметры

string $key
array|string|null $types

Значение результата

bool

array getCasts()

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

Значение результата

array

protected bool isDateCastable(string $key)

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

Параметры

string $key

Значение результата

bool

protected bool isJsonCastable(string $key)

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

Параметры

string $key

Значение результата

bool

array getAttributes()

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

Значение результата

array

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

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

Параметры

array $attributes
bool $sync

Значение результата

$this

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

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

Параметры

string|null $key
mixed $default

Значение результата

mixed|array

array only(array|mixed $attributes)

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

Параметры

array|mixed $attributes

Значение результата

array

$this syncOriginal()

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

Значение результата

$this

$this syncOriginalAttribute(string $attribute)

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

Параметры

string $attribute

Значение результата

$this

$this syncChanges()

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

Значение результата

$this

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

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

Параметры

array|string|null $attributes

Значение результата

bool

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

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

Параметры

array|string|null $attributes

Значение результата

bool

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

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

Параметры

array|string|null $attributes

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

bool

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

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

Параметры

array $changes
array|string|null $attributes

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

bool

array getDirty()

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

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

array

array getChanges()

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

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

array

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

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

Параметры

string $key
mixed $current

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

bool

$this append(array|string $attributes)

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

Параметры

array|string $attributes

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

$this

$this setAppends(array $appends)

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

Параметры

array $appends

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

$this

array getMutatedAttributes()

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

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

array

static void cacheMutatedAttributes(string $class)

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

Параметры

string $class

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

void

static protected array getMutatorMethods(mixed $class)

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

Параметры

mixed $class

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

array

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

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

Параметры

object|array|string $classes

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

void

protected void registerObserver(object|string $class)

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

Параметры

object|string $class

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

void

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)

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

Parameters

Closure|string $callback

Return Value

void

static void updating(Closure|string $callback)

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

Parameters

Closure|string $callback

Return Value

void

static void updated(Closure|string $callback)

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

Parameters

Closure|string $callback

Return Value

void

static void creating(Closure|string $callback)

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

Parameters

Closure|string $callback

Return Value

void

static void created(Closure|string $callback)

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

Parameters

Closure|string $callback

Return Value

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)

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

Parameters

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

Return Value

HasOne
END_OF_DOCUMENT_MARKER

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

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

Параметры

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

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

MorphOne

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

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

Параметры

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

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

MorphOne

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

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

Параметры

string $related
string $foreignKey
string $ownerKey
string $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 $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
END_OF_DOCUMENT_MARKER

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

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

Параметры

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)

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

Параметры

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

Получить имя связи belongs to many.

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

string

string joiningTable(string $related, Модель|null $instance = null)

Получить имя таблицы соединения для связи many-to-many.

Параметры

string $related
Модель|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

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

массив getHidden()

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

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

массив

$this setHidden(массив $hidden)

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

Параметры

массив $hidden

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

$this

пустое значение addHidden(массив|строка|null $attributes = null)

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

Параметры

массив|строка|null $attributes

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

пустое значение

массив getVisible()

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

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

массив

$this setVisible(массив $visible)

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

Параметры

массив $visible

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

$this

пустое значение addVisible(массив|строка|null $attributes = null)

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

Параметры

массив|строка|null $attributes

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

пустое значение

$this makeVisible(массив|строка $attributes)

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

Параметры

массив|строка $attributes

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

$this

$this makeHidden(массив|строка $attributes)

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

Параметры

массив|строка $attributes

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

$this

массив getFillable()

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

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

массив

$this fillable(массив $fillable)

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

Параметры

массив $fillable

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

$this

массив getGuarded()

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

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

массив

$this guard(массив $guarded)

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

Параметры

массив $guarded

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

$this

статический пустое значение unguard(bool $state = true)

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

Параметры

bool $state

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

пустое значение

статический пустое значение reguard()

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

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

пустое значение

статический логическое значение isUnguarded()

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

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

логическое значение

статический смешанный тип unguarded(вызываемый объект $callback)

Выполнить заданный вызываемый объект в режиме "без защиты".

Параметры

вызываемый объект $callback

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

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

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

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

Параметры

строка $key

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

логическое значение

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

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

Параметры

строка $key

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

логическое значение

логическое значение totallyGuarded()

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

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

логическое значение

защищенный массив fillableFromArray(массив $attributes)

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

Параметры

массив $attributes

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

массив

защищенный смешанный тип forwardCallTo(смешанный тип $object, строка $method, массив $parameters)

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

Параметры

смешанный тип $object
строка $method
массив $parameters

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

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

Исключения

BadMethodCallException

статический защищенный пустое значение throwBadMethodCallException(строка $method)

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

Параметры

строка $method

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

пустое значение

Исключения

BadMethodCallException

пустое значение __construct(массив $attributes = [])

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

Параметры

массив $attributes

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

пустое значение

защищенный пустое значение bootIfNotBooted()

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

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

пустое значение

static protected void boot()

Метод "запуска" модели.

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

void

static protected void bootTraits()

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

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

void

protected void initializeTraits()

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

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

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)

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

Параметры

string $key

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

string

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

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

Параметры

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

Исключения

Throwable

protected void finishSave(array $options)

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

Параметры

array $options

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

void

protected bool performUpdate(Builder $query)

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

Параметры

Builder $query

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

bool

protected Builder setKeysForSaveQuery(Builder $query)

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

Параметры

Builder $query

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

Builder

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

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

Параметры

Collection|array|int $ids

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

int

int delete()

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

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

int

bool|null forceDelete()

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

Этот метод защищает разработчиков от выполнения forceDelete, если трейт отсутствует.

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

bool|null

protected void performDeleteOnModel()

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

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

void

static Builder query()

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

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

Builder

Builder newQuery()

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

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

Builder

Builder|Model newModelQuery()

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

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

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)

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

Параметры

array|int $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

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)

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

Параметры

Model|null $model

Значение результата

bool

bool isNot(Model|null $model)

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

Параметры

Model|null $model

Значение результата

bool

Connection getConnection()

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

Значение результата

Connection

string getConnectionName()

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

Значение результата

string

$this setConnection(string $name)

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

Параметры

string $name

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

$this

static Соединение resolveConnection(string|null $connection = null)

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

Параметры

string|null $connection

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

Соединение

static Интерфейс разрешения соединения getConnectionResolver()

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

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

Интерфейс разрешения соединения

static void setConnectionResolver(Интерфейс разрешения соединения $resolver)

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

Параметры

Интерфейс разрешения соединения $resolver

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

void

static void unsetConnectionResolver()

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

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

void

string getTable()

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

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

string

$this setTable(string $table)

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

Параметры

string $table

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

$this

string getKeyName()

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

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

string

$this setKeyName(string $key)

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

Параметры

string $key

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

$this

string getQualifiedKeyName()

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

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

string

string getKeyType()

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

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

string

$this setKeyType(string $type)

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

Параметры

string $type

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

$this

bool getIncrementing()

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

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

bool

$this setIncrementing(bool $value)

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

Параметры

bool $value

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

$this

mixed getKey()

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

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

mixed

mixed getQueueableId()

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

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

mixed

array getQueueableRelations()

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

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

array

string|null getQueueableConnection()

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

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

string|null

mixed getRouteKey()

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

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

mixed

string getRouteKeyName()

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

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

string

Модель|null resolveRouteBinding(mixed $value)

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

Параметры

mixed $value

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

Модель|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 AsPivot fromAttributes(Model $parent, array $attributes, string $table, bool $exists = false)

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

Параметры

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

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

AsPivot

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

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

Параметры

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

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

AsPivot

protected Builder getDeleteQuery()

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

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

Builder

string getRelatedKey()

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

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

string

string getOtherKey()

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

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

string

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

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

Параметры

string $foreignKey
string $relatedKey

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

$this

bool hasTimestampAttributes()

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

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

bool

protected Builder newQueryForCollectionRestoration(array $ids)

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

Параметры

array $ids

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

Builder

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

Spec-Zone.ru

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