Pivot
class Pivot extends Model (View source)
Трейты
| AsPivot | |
| HasAttributes | |
| HasEvents | |
| HasGlobalScopes | |
| HasRelationships | |
| HasTimestamps | |
| HidesAttributes | |
| GuardsAttributes | |
| ForwardsCalls |
Константы
| CREATED_AT | Имя столбца "created at". |
| UPDATED_AT | Имя столбца "updated at". |
Свойства
| protected массив | $attributes | Атрибуты модели. | из HasAttributes |
| protected массив | $original | Исходное состояние атрибутов модели. | из HasAttributes |
| protected массив | $changes | Изменённые атрибуты модели. | из HasAttributes |
| protected массив | $casts | Атрибуты, которые должны быть преобразованы в базовые типы. | из HasAttributes |
| protected массив | $dates | Атрибуты, которые должны быть преобразованы в даты. | из HasAttributes |
| protected строка | $dateFormat | Формат хранения столбцов даты модели. | из HasAttributes |
| protected массив | $appends | Аксессоры для добавления в массивную форму модели. | из HasAttributes |
| static bool | $snakeAttributes | Указывает, преобразуются ли атрибуты в змеиный регистр в массивах. | из HasAttributes |
| static protected массив | $mutatorCache | Кэш изменённых атрибутов для каждого класса. | из HasAttributes |
| protected массив | $dispatchesEvents | Карта событий для модели. | из HasEvents |
| protected массив | $observables | Опубликованные события observable. | из HasEvents |
| protected массив | $relations | Загруженные отношения модели. | из HasRelationships |
| protected массив | $touches | Отношения, которые должны быть обновлены при сохранении. | из HasRelationships |
| static массив | $manyMethods | Методы отношений "многие ко многим". | из HasRelationships |
| bool | $timestamps | Указывает, должна ли модель использовать отметки времени. | из HasTimestamps |
| $hidden | Атрибуты, которые должны быть скрыты при сериализации. | из HidesAttributes | |
| protected массив | $visible | Атрибуты, которые должны быть видны при сериализации. | из HidesAttributes |
| protected массив | $fillable | Атрибуты, которые допускают массовое назначение. | из GuardsAttributes |
| protected массив | $guarded | Атрибуты, которые не допускают массового назначения. | |
| static protected bool | $unguarded | Указывает, разрешено ли массовое назначение для всех атрибутов. | из GuardsAttributes |
| static protected массив | $guardableColumns | Фактические столбцы, которые существуют в базе данных и могут быть защищены. | из GuardsAttributes |
| protected string|null | $connection | Имя подключения для модели. | из Model |
| protected строка | $table | Таблица, связанная с моделью. | из Model |
| protected строка | $primaryKey | Первичный ключ модели. | из Model |
| protected строка | $keyType | Тип первичного ключа ID. | из Model |
| bool | $incrementing | Указывает, являются ли ID автоматически нарастающими. | |
| 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 string | $foreignKey | Имя столбца внешнего ключа. | из AsPivot |
| protected string | $relatedKey | Имя столбца «другого ключа». | из 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)
Определить, существует ли мутатор для получения атрибута. | из HasAttributes |
| смешанный | mutateAttribute(строка $key, смешанный $value)
Получить значение атрибута, используя его мутатор. | из HasAttributes |
| смешанный | mutateAttributeForArray(строка $key, смешанный $value)
Получить значение атрибута, используя его мутатор для преобразования в массив. | из HasAttributes |
| смешанный | castAttribute(строка $key, смешанный $value)
Преобразовать атрибут к собственному типу PHP. | из HasAttributes |
| строка | getCastType(строка $key)
Получить тип преобразования для атрибута модели. | из HasAttributes |
| логическое | isCustomDateTimeCast(строка $cast)
Определить, является ли тип преобразования пользовательским преобразованием даты и времени. | из HasAttributes |
| логическое | isDecimalCast(строка $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 |
| mixed | fromFloat(mixed $value)
Декодировать заданное число с плавающей точкой. | from HasAttributes |
| string | asDecimal(float $value, int $decimals)
Возвратить десятичное число в виде строки. | 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|null | fromDateTime(mixed $value)
Преобразовать DateTime в хранимую строку. | from HasAttributes |
| int | asTimestamp(mixed $value)
Возвратить метку времени как Unix-метку времени. | 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 | syncOriginalAttributes(array|string $attributes)
Синхронизировать несколько исходных атрибутов со значениями текущих. | 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 |
| массив | getDirty()
Получить атрибуты, которые были изменены с момента последней синхронизации. | из HasAttributes |
| массив | getChanges()
Получить изменённые атрибуты. | из HasAttributes |
| bool | originalIsEquivalent(string $key, mixed $current)
Определить, эквивалентны ли новые и старые значения для данного ключа. | из 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 | replicating(Closure|string $callback)
Зарегистрировать событие копирования модели у диспетчера. | из HasEvents |
| static void | deleting(Closure|string $callback)
Зарегистрировать событие удаления модели у диспетчера. | из HasEvents |
| static void | deleted(Closure|string $callback)
Зарегистрировать событие удаления модели у диспетчера. | из 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 | withoutEvents(callable $callback)
Выполнить обратный вызов без запуска событий модели для любого типа модели. | from HasEvents |
| static mixed | addGlobalScope(Scope|Closure|string $scope, Closure $implementation = null)
Зарегистрировать новую глобальную область видимости в модели. | from HasGlobalScopes |
| static bool | hasGlobalScope(Scope|string $scope)
Определить, имеет ли модель глобальную область видимости. | from HasGlobalScopes |
| static Scope|Closure|null | getGlobalScope(Scope|string $scope)
Получить глобальную область видимости, зарегистрированную в модели. | from HasGlobalScopes |
| array | getGlobalScopes()
Получить глобальные области видимости для этого экземпляра класса. | from HasGlobalScopes |
| HasOne | hasOne(string $related, string|null $foreignKey = null, string|null $localKey = null)
Определить отношение «один-к-одному». | from HasRelationships |
| HasOne | newHasOne(Builder $query, Model $parent, string $foreignKey, string $localKey)
Создать новое отношение HasOne. | from HasRelationships |
| HasOneThrough | hasOneThrough(string $related, string $through, string|null $firstKey = null, string|null $secondKey = null, string|null $localKey = null, string|null $secondLocalKey = null)
Определить отношение «один-через-один». | from HasRelationships |
| HasOneThrough | newHasOneThrough(Builder $query, Model $farParent, Model $throughParent, string $firstKey, string $secondKey, string $localKey, string $secondLocalKey)
Создать новое отношение HasOneThrough. | from HasRelationships |
| MorphOne | morphOne(string $related, string $name, string|null $type = null, string|null $id = null, string|null $localKey = null)
Определить полиморфное отношение «один-к-одному». | from HasRelationships |
| MorphOne | newMorphOne(Builder $query, Model $parent, string $type, string $id, string $localKey)
Создать новое отношение MorphOne. | from HasRelationships |
| BelongsTo | belongsTo(string $related, string|null $foreignKey = null, string|null $ownerKey = null, string|null $relation = null)
Определить обратное отношение «один-к-одному» или «многие-к-одному». | from HasRelationships |
| BelongsTo | newBelongsTo(Builder $query, Model $child, string $foreignKey, string $ownerKey, string $relation)
Создать новое отношение BelongsTo. | from HasRelationships |
| MorphTo | morphTo(string|null $name = null, string|null $type = null, string|null $id = null, string|null $ownerKey = null)
Определить полиморфное, обратное отношение «один-к-одному» или «многие-к-одному». | from HasRelationships |
| MorphTo | morphEagerTo(string $name, string $type, string $id, string $ownerKey)
Определить полиморфное, обратное отношение «один-к-одному» или «многие-к-одному». | from HasRelationships |
| MorphTo | morphInstanceTo(string $target, string $name, string $type, string $id, string $ownerKey)
Определить полиморфное, обратное отношение «один-к-одному» или «многие-к-одному». | from HasRelationships |
| MorphTo | newMorphTo(Builder $query, Model $parent, string $foreignKey, string $ownerKey, string $type, string $relation)
Создать новое отношение MorphTo. | from HasRelationships |
| статический строковый тип | getActualClassNameForMorph(строковый тип $class)
Получить фактическое имя класса для заданного морфизма класса. | из HasRelationships |
| строковый тип | guessBelongsToRelation()
Угадать имя отношения "belongs to". | из HasRelationships |
| HasMany | hasMany(строковый тип $related, строковый тип|null $foreignKey = null, строковый тип|null $localKey = null)
Определить отношение один-ко-многим. | из HasRelationships |
| HasMany | newHasMany(Builder $query, Model $parent, строковый тип $foreignKey, строковый тип $localKey)
Создать новое отношение HasMany. | из HasRelationships |
| HasManyThrough | hasManyThrough(строковый тип $related, строковый тип $through, строковый тип|null $firstKey = null, строковый тип|null $secondKey = null, строковый тип|null $localKey = null, строковый тип|null $secondLocalKey = null)
Определить отношение has-many-through. | из HasRelationships |
| HasManyThrough | newHasManyThrough(Builder $query, Model $farParent, Model $throughParent, строковый тип $firstKey, строковый тип $secondKey, строковый тип $localKey, строковый тип $secondLocalKey)
Создать новое отношение HasManyThrough. | из HasRelationships |
| MorphMany | morphMany(строковый тип $related, строковый тип $name, строковый тип|null $type = null, строковый тип|null $id = null, строковый тип|null $localKey = null)
Определить полиморфное отношение один-ко-многим. | из HasRelationships |
| MorphMany | newMorphMany(Builder $query, Model $parent, строковый тип $type, строковый тип $id, строковый тип $localKey)
Создать новое отношение MorphMany. | из HasRelationships |
| BelongsToMany | belongsToMany(строковый тип $related, строковый тип|null $table = null, строковый тип|null $foreignPivotKey = null, строковый тип|null $relatedPivotKey = null, строковый тип|null $parentKey = null, строковый тип|null $relatedKey = null, строковый тип|null $relation = null)
Определить отношение многие-ко-многим. | из HasRelationships |
| BelongsToMany | newBelongsToMany(Builder $query, Model $parent, строковый тип $table, строковый тип $foreignPivotKey, строковый тип $relatedPivotKey, строковый тип $parentKey, строковый тип $relatedKey, строковый тип $relationName = null)
Создать новое отношение BelongsToMany. | из HasRelationships |
| MorphToMany | morphToMany(строковый тип $related, строковый тип $name, строковый тип|null $table = null, строковый тип|null $foreignPivotKey = null, строковый тип|null $relatedPivotKey = null, строковый тип|null $parentKey = null, строковый тип|null $relatedKey = null, булевый тип $inverse = false)
Определить полиморфное отношение многие-ко-многим. | из HasRelationships |
| MorphToMany | newMorphToMany(Builder $query, Model $parent, строковый тип $name, строковый тип $table, строковый тип $foreignPivotKey, строковый тип $relatedPivotKey, строковый тип $parentKey, строковый тип $relatedKey, строковый тип|null $relationName = null, булевый тип $inverse = false)
Создать новое отношение MorphToMany. | из HasRelationships |
| MorphToMany | morphedByMany(строковый тип $related, строковый тип $name, строковый тип|null $table = null, строковый тип|null $foreignPivotKey = null, строковый тип|null $relatedPivotKey = null, строковый тип|null $parentKey = null, строковый тип|null $relatedKey = null)
Определить полиморфное обратное отношение многие-ко-многим. | из HasRelationships |
| строковый тип|null | guessBelongsToManyRelation()
Получить имя отношения belongsToMany. | из HasRelationships |
| строковый тип | joiningTable(строковый тип $related, Model|null $instance = null)
Получить имя таблицы соединения для отношения многие-ко-многим. | из HasRelationships |
| строковый тип | joiningTableSegment()
Получить часть имени промежуточной таблицы для отношений belongsToMany. | из HasRelationships |
| булевый тип | touches(строковый тип $relation)
Определить, касается ли модель заданного отношения. | из HasRelationships |
| void | touchOwners()
Обновить связанные отношения модели. | из HasRelationships |
| массив | getMorphs(строковый тип $name, строковый тип $type, строковый тип $id)
Получить столбцы полиморфного отношения. | из HasRelationships |
| строковый тип | getMorphClass()
Получить имя класса для полиморфных отношений. | из HasRelationships |
| смешанный тип | newRelatedInstance(строковый тип $class)
Создать новый экземпляр модели для связанной модели. | из 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 |
| $this | withoutRelations()
Создать дубликат экземпляра и удалить все загруженные отношения. | from HasRelationships |
| $this | unsetRelations()
Удалить все загруженные отношения для экземпляра. | from HasRelationships |
| array | getTouchedRelations()
Получить отношения, которые изменяются при сохранении. | from HasRelationships |
| $this | setTouchedRelations(array $touches)
Установить отношения, которые изменяются при сохранении. | from HasRelationships |
| bool | touch()
Обновить метку времени последнего обновления модели. | from HasTimestamps |
| void | updateTimestamps()
Обновить метки времени создания и обновления. | from HasTimestamps |
| $this | setCreatedAt(mixed $value)
Установить значение атрибута "created at". | from HasTimestamps |
| $this | setUpdatedAt(mixed $value)
Установить значение атрибута "updated at". | from HasTimestamps |
| Carbon | freshTimestamp()
Получить свежую метку времени для модели. | from HasTimestamps |
| string | freshTimestampString()
Получить свежую метку времени для модели. | from HasTimestamps |
| bool | usesTimestamps()
Определить, использует ли модель метки времени. | from HasTimestamps |
| string|null | getCreatedAtColumn()
Получить имя столбца "created at". | from HasTimestamps |
| string|null | getUpdatedAtColumn()
Получить имя столбца "updated at". | from HasTimestamps |
| string | getQualifiedCreatedAtColumn()
Получить полное имя столбца "created at". | from HasTimestamps |
| string | getQualifiedUpdatedAtColumn()
Получить полное имя столбца "updated at". | from HasTimestamps |
| array | getHidden()
Получить скрытые атрибуты модели. | from HidesAttributes |
| $this | setHidden(array $hidden)
Установить скрытые атрибуты модели. | from HidesAttributes |
| 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)
Установить атрибуты модели, которые можно заполнять. | из GuardsAttributes |
| массив | getGuarded()
Получить защищённые атрибуты модели. | из GuardsAttributes |
| $this | guard(array $guarded)
Установить защищённые атрибуты модели. | из GuardsAttributes |
| статический void | unguard(bool $state = true)
Отключить все ограничения массового назначения. | из GuardsAttributes |
| статический void | reguard()
Включить ограничения массового назначения. | из GuardsAttributes |
| статический bool | isUnguarded()
Определить, находится ли текущее состояние в режиме "без защиты". | из GuardsAttributes |
| статический mixed | unguarded(callable $callback)
Выполнить заданный вызов без защиты. | из GuardsAttributes |
| bool | isFillable(string $key)
Определить, может ли данный атрибут быть назначен массово. | из GuardsAttributes |
| bool | isGuarded(string $key)
Определить, является ли данный ключ защищённым. | из GuardsAttributes |
| bool | isGuardableColumn(string $key)
Определить, является ли данный столбец допустимым и защищённым столбцом. | из GuardsAttributes |
| bool | totallyGuarded()
Определить, является ли модель полностью защищённой. | из GuardsAttributes |
| массив | fillableFromArray(array $attributes)
Получить атрибуты, которые можно заполнять, из массива. | из GuardsAttributes |
| mixed | forwardCallTo(mixed $object, string $method, array $parameters)
Перенаправить вызов метода данному объекту. | из ForwardsCalls |
| статический void | throwBadMethodCallException(string $method)
Выбросить исключение для неверного вызова метода. | из ForwardsCalls |
| void | __construct(array $attributes = [])
Создать новый экземпляр модели Eloquent. | из Model |
| void | bootIfNotBooted()
Проверить, нуждается ли модель в запуске и, если нужно, запустить её. | из Model |
| статический void | boot()
Метод "запуска" модели. | из Model |
| статический void | bootTraits()
Запустить все загружаемые трейты модели. | из Model |
| void | initializeTraits()
Инициализировать все инициализируемые трейты модели. | из Model |
| статический void | clearBootedModels()
Очистить список загруженных моделей, чтобы они были перезапущены. | из Model |
| статический void | withoutTouching(callable $callback)
Отключает касание моделей отношений для текущего класса в рамках заданного вызова. | из Model |
| статический void | withoutTouchingOn(array $models, callable $callback)
Отключает касание моделей отношений для заданных классов моделей в рамках заданного вызова. | из Model |
| статический bool | isIgnoringTouch(string|null $class = null)
Определить, игнорирует ли данная модель касания. | из Model |
| $this | fill(array $attributes)
Заполнить модель массивом атрибутов. | из Model |
| $this | forceFill(array $attributes)
Заполнить модель массивом атрибутов. Принудительное массовое назначение. | из Model |
| string | qualifyColumn(string $column)
Квалифицировать имя столбца по таблице модели. | из Model |
| string | removeTableFromKey(string $key)
Удалить имя таблицы из заданного ключа. | из Model |
| Модель | newInstance(array $attributes = [], bool $exists = false)
Создать новый экземпляр заданной модели. | из Model |
| Модель | newFromBuilder(array $attributes = [], string|null $connection = null)
Создать новый экземпляр модели, которая уже существует. | из Model |
| статический Builder | on(string|null $connection = null)
Начать запросы к модели на заданном соединении. | из Model |
| static Builder | onWriteConnection()
Начать запросы к модели на записи соединения. | из Модели |
| static Collection|Model[] | all(array|mixed $columns = ['*'])
Получить все модели из базы данных. | из Модели |
| static Builder | with(array|string $relations)
Начать запросы к модели с ленивой загрузкой. | из Модели |
| $this | load(array|string $relations)
Загрузить отношения модели с ленивой загрузкой. | из Модели |
| $this | loadMissing(array|string $relations)
Загрузить отношения модели, если они еще не загружены. | из Модели |
| $this | loadCount(array|string $relations)
Загрузить счётчики отношений модели. | из Модели |
| int | increment(string $column, float|int $amount = 1, array $extra = [])
Увеличить значение столбца на заданную величину. | из Модели |
| int | decrement(string $column, float|int $amount = 1, array $extra = [])
Уменьшить значение столбца на заданную величину. | из Модели |
| int | incrementOrDecrement(string $column, float|int $amount, array $extra, string $method)
Выполнить метод увеличения или уменьшения значения для модели. | из Модели |
| void | incrementOrDecrementAttributeValue(string $column, float|int $amount, array $extra, string $method)
Увеличить/уменьшить значение внутреннего атрибута и синхронизировать его с оригиналом. | из Модели |
| bool | update(array $attributes = [], array $options = [])
Обновить модель в базе данных. | из Модели |
| bool | push()
Сохранить модель и все её отношения. | из Модели |
| bool | save(array $options = [])
Сохранить модель в базе данных. | из Модели |
| bool | saveOrFail(array $options = [])
Сохранить модель в базе данных с использованием транзакции. | из Модели |
| void | finishSave(array $options)
Выполнить необходимые действия после сохранения модели. | из Модели |
| bool | performUpdate(Builder $query)
Выполнить операцию обновления модели. | из Модели |
| Builder | setKeysForSaveQuery(Builder $query)
Установить ключи для запроса сохранения. | из AsPivot |
| mixed | getKeyForSaveQuery()
Получить значение первичного ключа для запроса сохранения. | из Модели |
| bool | performInsert(Builder $query)
Выполнить операцию вставки модели. | из Модели |
| void | insertAndSetId(Builder $query, array $attributes)
Вставить заданные атрибуты и установить ID модели. | из Модели |
| static int | destroy(Collection|array|int $ids)
Удалить модели для заданных идентификаторов. | из Модели |
| int | delete()
Удалить запись модели-связи из базы данных. | из AsPivot |
| bool|null | forceDelete()
Выполнить жесткое удаление мягко удаленной модели. | из Модели |
| void | performDeleteOnModel()
Выполнить фактический запрос удаления для этого экземпляра модели. | из Модели |
| static Builder | query()
Начать запросы к модели. | из Модели |
| Builder | newQuery()
Получить новый генератор запросов для таблицы модели. | из Модели |
| Builder|Model | newModelQuery()
Получить новый генератор запросов, не содержащий глобальных скопов или ленивой загрузки. | из Модели |
| Builder | newQueryWithoutRelationships()
Получить новый генератор запросов без загруженных отношений. | из Модели |
| Builder | registerGlobalScopes(Builder $builder)
Зарегистрировать глобальные скопы для этого экземпляра генератора запросов. | из Модели |
| Builder|Модель | newQueryWithoutScopes()
Получить новый конструктор запросов, не имеющий глобальных ограничений. | из Модели |
| Builder | newQueryWithoutScope(Ограничение|string $scope)
Получить новый экземпляр запроса без указанного ограничения. | из Модели |
| Builder | newQueryForRestoration(int[]|string[]|string $ids)
Получить новый запрос для восстановления одной или нескольких моделей по их идентификаторам в очереди. | из AsPivot |
| Builder|Модель | newEloquentBuilder(Builder $query)
Создать новый конструктор запросов Eloquent для модели. | из Модели |
| Builder | newBaseQueryBuilder()
Получить новый экземпляр конструктора запросов для подключения. | из Модели |
| Коллекция | newCollection(array $models = [])
Создать новый экземпляр коллекции Eloquent. | из Модели |
| Связь | newPivot(Модель $parent, array $attributes, string $table, bool $exists, string|null $using = null)
Создать новый экземпляр модели связи. | из Модели |
| массив | toArray()
Преобразовать экземпляр модели в массив. | из Модели |
| строка | toJson(int $options = 0)
Преобразовать экземпляр модели в JSON. | из Модели |
| массив | jsonSerialize()
Преобразовать объект в сериализуемый в JSON. | из Модели |
| Модель|null | fresh(array|string $with = [])
Перезагрузить свежий экземпляр модели из базы данных. | из Модели |
| $this | refresh()
Перезагрузить текущий экземпляр модели с новыми атрибутами из базы данных. | из Модели |
| Модель | replicate(array $except = null)
Создать копию модели в новом, не существующем экземпляре. | из Модели |
| bool | is(Модель|null $model)
Определить, имеют ли две модели одинаковый ID и относятся ли к одной таблице. | из Модели |
| bool | isNot(Модель|null $model)
Определить, не являются ли две модели одинаковыми. | из Модели |
| Подключение | getConnection()
Получить подключение к базе данных для модели. | из Модели |
| строка|null | getConnectionName()
Получить текущее имя подключения для модели. | из Модели |
| $this | setConnection(string|null $name)
Установить подключение, связанное с моделью. | из Модели |
| статический Подключение | resolveConnection(string|null $connection = null)
Разрешить экземпляр подключения. | из Модели |
| статический Интерфейс разрешения подключения | getConnectionResolver()
Получить экземпляр разрешителя подключений. | из Модели |
| статический void | setConnectionResolver(Интерфейс разрешения подключения $resolver)
Установить экземпляр разрешителя подключений. | из Модели |
| статический void | unsetConnectionResolver()
Удалить разрешитель подключений для моделей. | из Модели |
| строка | getTable()
Получить таблицу, связанную с моделью. | из AsPivot |
| $this | setTable(string $table)
Установить таблицу, связанную с моделью. | из Модели |
| строка | getKeyName()
Получить первичный ключ для модели. | из Модели |
| $this | setKeyName(string $key)
Установить первичный ключ для модели. | из Модели |
| строка | getQualifiedKeyName()
Получить имя ключа, квалифицированное по таблице. | из Модели |
| строка | getKeyType()
Получить тип автоинкрементного ключа. | из Модели |
| $this | setKeyType(string $type)
Установить тип данных для первичного ключа. | из Модели |
| bool | getIncrementing()
Получить значение, указывающее, являются ли ID инкрементными. | from Model |
| $this | setIncrementing(bool $value)
Установить, являются ли ID инкрементными. | from Model |
| mixed | getKey()
Получить значение первичного ключа модели. | from Model |
| mixed | getQueueableId()
Получить уникальный идентификатор для сущности. | from AsPivot |
| 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 AsPivot |
| 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 AsPivot | fromAttributes(Model $parent, array $attributes, string $table, bool $exists = false)
Создать новый экземпляр модели pivot. | from AsPivot |
| static AsPivot | fromRawAttributes(Model $parent, array $attributes, string $table, bool $exists = false)
Создать новую модель pivot из необработанных значений, возвращаемых запросом. | from AsPivot |
| Builder | getDeleteQuery()
Получить построитель запросов для операции удаления в pivot. | from AsPivot |
| string | getRelatedKey()
Получить имя столбца "связанного ключа". | from AsPivot |
| string | getOtherKey()
Получить имя столбца "связанного ключа". | from AsPivot |
| $this | setPivotKeys(string $foreignKey, string $relatedKey)
Установить имена ключей для экземпляра модели pivot. | from AsPivot |
| bool | hasTimestampAttributes(array|null $attributes = null)
Определить, имеет ли модель pivot или заданные атрибуты атрибуты временных меток. | from AsPivot |
| Билдер | newQueryForCollectionRestoration(array $ids)
Получить новый запрос для восстановления нескольких моделей по их очереди идентификаторов. | из AsPivot |
Подробности
array attributesToArray()
Преобразовать атрибуты модели в массив.
protected array addDateAttributesToArray(array $attributes)
Добавить атрибуты даты в массив атрибутов.
protected array addMutatedAttributesToArray(array $attributes, array $mutatedAttributes)
Добавить изменённые атрибуты в массив атрибутов.
protected array addCastAttributesToArray(array $attributes, array $mutatedAttributes)
Добавить атрибуты с приведённым типом в массив атрибутов.
protected array getArrayableAttributes()
Получить массив атрибутов, приводимых к массиву.
protected array getArrayableAppends()
Получить все приводимые к массиву значения с добавлением.
array relationsToArray()
Получить отношения модели в формате массива.
protected array getArrayableRelations()
Получить массив всех приводимых к массиву отношений.
protected array getArrayableItems(array $values)
Получить массив всех приводимых к массиву значений.
mixed getAttribute(string $key)
Получить атрибут из модели.
mixed getAttributeValue(string $key)
Получить простой атрибут (не отношение).
protected mixed getAttributeFromArray(string $key)
Получить атрибут из массива $attributes.
mixed getRelationValue(string $key)
Получить отношение.
protected mixed getRelationshipFromMethod(string $method)
Получить значение отношения из метода.
bool hasGetMutator(string $key)
Определить, существует ли мутатор получения для атрибута.
protected mixed mutateAttribute(string $key, mixed $value)
Получить значение атрибута, используя его мутатор.
protected mixed mutateAttributeForArray(string $key, mixed $value)
Получить значение атрибута, используя его мутатор для преобразования в массив.
protected mixed castAttribute(string $key, mixed $value)
Привести атрибут к типу PHP.
protected string getCastType(string $key)
Получить тип приведения для атрибута модели.
protected bool isCustomDateTimeCast(string $cast)
Определить, является ли тип приведения пользовательским типом приведения даты и времени.
protected bool isDecimalCast(string $cast)
Определить, является ли тип приведения типом приведения десятичных чисел.
mixed setAttribute(string $key, mixed $value)
Установить заданный атрибут в модели.
bool hasSetMutator(string $key)
Определить, существует ли мутатор set для атрибута.
protected mixed setMutatedAttributeValue(string $key, mixed $value)
Установить значение атрибута с помощью его мутатора.
protected bool isDateAttribute(string $key)
Определить, является ли заданный атрибут датой или может быть преобразован в дату.
$this fillJsonAttribute(string $key, mixed $value)
Установить заданный JSON атрибут в модели.
protected $this getArrayAttributeWithValue(string $path, string $key, mixed $value)
Получить атрибут-массив с заданным ключом и установленным значением.
protected array getArrayAttributeByKey(string $key)
Получить атрибут-массив или вернуть пустой массив, если он не задан.
protected string castAttributeAsJson(string $key, mixed $value)
Преобразовать заданный атрибут в JSON.
protected string asJson(mixed $value)
Кодировать заданное значение в JSON.
mixed fromJson(string $value, bool $asObject = false)
Декодировать заданный JSON обратно в массив или объект.
mixed fromFloat(mixed $value)
Декодировать заданное число с плавающей точкой.
protected string asDecimal(float $value, int $decimals)
Возвратить десятичное число как строку.
protected Carbon asDate(mixed $value)
Возвратить метку времени как объект DateTime с временем, установленным в 00:00:00.
protected Carbon asDateTime(mixed $value)
Возвратить метку времени как объект DateTime.
protected bool isStandardDateFormat(string $value)
Определить, является ли заданное значение стандартным форматом даты.
string|null fromDateTime(mixed $value)
Преобразовать DateTime в хранимую строку.
protected int asTimestamp(mixed $value)
Возвратить метку времени как unix-метку времени.
protected string serializeDate(DateTimeInterface $date)
Подготовить дату для сериализации в массив/JSON.
array getDates()
Получить атрибуты, которые должны быть преобразованы в даты.
string getDateFormat()
Получить формат для дат, хранящихся в базе данных.
$this setDateFormat(string $format)
Установить формат даты, используемый моделью.
bool hasCast(string $key, array|string|null $types = null)
Определить, следует ли преобразовать атрибут в базовый тип.
array getCasts()
Получить массив преобразуемых атрибутов.
protected bool isDateCastable(string $key)
Определить, может ли значение быть преобразовано в дату / DateTime для обработки входных данных.
protected bool isJsonCastable(string $key)
Определить, может ли значение быть преобразовано в JSON для обработки входных данных.
array getAttributes()
Получить все текущие атрибуты модели.
$this setRawAttributes(array $attributes, bool $sync = false)
Установить массив атрибутов модели. Проверка не выполняется.
mixed|array getOriginal(string|null $key = null, mixed $default = null)
Получить исходные значения атрибутов модели.
array only(array|mixed $attributes)
Получить подмножество атрибутов модели.
$this syncOriginal()
Синхронизировать исходные атрибуты с текущими.
$this syncOriginalAttribute(string $attribute)
Синхронизировать один исходный атрибут со значением.
$this syncOriginalAttributes(array|string $attributes)
Синхронизировать несколько исходных атрибутов со значениями.
$this syncChanges()
Синхронизировать изменённые атрибуты.
bool isDirty(array|string|null $attributes = null)
Определить, была ли модель или какие-либо заданные атрибуты изменены.
bool isClean(array|string|null $attributes = null)
Определить, оставались ли модель и все заданные атрибуты неизменными.
bool wasChanged(array|string|null $attributes = null)
Определить, была ли модель или какие-либо заданные атрибуты изменены.
protected bool hasChanges(array $changes, array|string|null $attributes = null)
Определить, были ли изменены какие-либо заданные атрибуты.
array getDirty()
Получить атрибуты, изменённые с момента последней синхронизации.
array getChanges()
Получить изменённые атрибуты.
bool originalIsEquivalent(string $key, mixed $current)
Определить, эквивалентны ли новые и старые значения для заданного ключа.
$this append(array|string $attributes)
Добавить атрибуты к запросу при построении запроса.
$this setAppends(array $appends)
Установить аксессоры для добавления в массивы модели.
array getMutatedAttributes()
Получить изменённые атрибуты для данного экземпляра.
static void cacheMutatedAttributes(string $class)
Извлечь и кэшировать все изменённые атрибуты класса.
static protected array getMutatorMethods(mixed $class)
Получить все методы модификаторов атрибутов.
static void observe(object|array|string $classes)
Зарегистрировать наблюдателей в модели.
protected void registerObserver(object|string $class)
Зарегистрировать единственного наблюдателя в модели.
array getObservableEvents()
Получить имена наблюдаемых событий.
$this setObservableEvents(array $observables)
Установить имена наблюдаемых событий.
void addObservableEvents(array|mixed $observables)
Добавить имя наблюдаемого события.
void removeObservableEvents(array|mixed $observables)
Удалить имя наблюдаемого события.
static protected void registerModelEvent(string $event, Closure|string $callback)
Зарегистрировать событие модели с диспетчером.
protected mixed fireModelEvent(string $event, bool $halt = true)
Сгенерировать заданное событие для модели.
protected mixed|null fireCustomModelEvent(string $event, string $method)
Сгенерировать пользовательское событие модели для заданного события.
protected mixed filterModelEventResults(mixed $result)
Отфильтровать результаты события модели.
static void retrieved(Closure|string $callback)
Зарегистрировать событие извлеченной модели с диспетчером.
static void saving(Closure|string $callback)
Зарегистрировать событие сохранения модели с диспетчером.
static void saved(Closure|string $callback)
Зарегистрировать событие сохраненной модели с диспетчером.
static void updating(Closure|string $callback)
Зарегистрировать событие обновления модели с диспетчером.
static void updated(Closure|string $callback)
Зарегистрировать событие обновленной модели с диспетчером.
static void creating(Closure|string $callback)
Зарегистрировать событие создания модели с диспетчером.
static void created(Closure|string $callback)
Зарегистрировать событие созданной модели с диспетчером.
static void replicating(Closure|string $callback)
Зарегистрировать событие дублирования модели с диспетчером.
static void deleting(Closure|string $callback)
Зарегистрировать событие удаления модели в диспетчере.
static void deleted(Closure|string $callback)
Зарегистрировать событие удалённой модели в диспетчере.
static void flushEventListeners()
Удалить все обработчики событий для модели.
static Dispatcher getEventDispatcher()
Получить экземпляр диспетчера событий.
static void setEventDispatcher(Dispatcher $dispatcher)
Установить экземпляр диспетчера событий.
static void unsetEventDispatcher()
Удалить диспетчер событий для моделей.
static mixed withoutEvents(callable $callback)
Выполнить обратный вызов без срабатывания событий модели для любого типа модели.
static mixed addGlobalScope(Scope|Closure|string $scope, Closure $implementation = null)
Зарегистрировать новый глобальный scope для модели.
static bool hasGlobalScope(Scope|string $scope)
Определить, имеет ли модель глобальный scope.
static Scope|Closure|null getGlobalScope(Scope|string $scope)
Получить зарегистрированный глобальный scope модели.
array getGlobalScopes()
Получить глобальные scopes для этого экземпляра класса.
HasOne hasOne(string $related, string|null $foreignKey = null, string|null $localKey = null)
Определить отношение один-к-одному.
protected HasOne newHasOne(Builder $query, Model $parent, string $foreignKey, string $localKey)
Инициализировать новое отношение один-к-одному.
HasOneThrough hasOneThrough(string $related, string $through, string|null $firstKey = null, string|null $secondKey = null, string|null $localKey = null, string|null $secondLocalKey = null)
Определить отношение has-one-through.
protected HasOneThrough newHasOneThrough(Builder $query, Model $farParent, Model $throughParent, string $firstKey, string $secondKey, string $localKey, string $secondLocalKey)
Инициализировать новое отношение HasOneThrough.
MorphOne morphOne(string $related, string $name, string|null $type = null, string|null $id = null, string|null $localKey = null)
Определить полиморфное отношение один-к-одному.
protected MorphOne newMorphOne(Builder $query, Model $parent, string $type, string $id, string $localKey)
Инициализировать новое отношение MorphOne.
BelongsTo belongsTo(string $related, string|null $foreignKey = null, string|null $ownerKey = null, string|null $relation = null)
Определить обратное отношение один-к-одному или многие-к-одному.
protected BelongsTo newBelongsTo(Builder $query, Model $child, string $foreignKey, string $ownerKey, string $relation)
Инициализировать новое отношение BelongsTo.
MorphTo morphTo(string|null $name = null, string|null $type = null, string|null $id = null, string|null $ownerKey = null)
Определить полиморфное обратное отношение один-к-одному или многие-к-одному.
protected MorphTo morphEagerTo(string $name, string $type, string $id, string $ownerKey)
Определить полиморфное обратное отношение один-к-одному или многие-к-одному.
protected MorphTo morphInstanceTo(string $target, string $name, string $type, string $id, string $ownerKey)
Определить полиморфное обратное отношение один-к-одному или многие-к-одному.
protected MorphTo newMorphTo(Builder $query, Model $parent, string $foreignKey, string $ownerKey, string $type, string $relation)
Инициализировать новое полиморфное отношение MorphTo.
static string getActualClassNameForMorph(string $class)
Получить фактическое имя класса для данного полиморфного класса.
protected string guessBelongsToRelation()
Угадать имя отношения "belongs to".
HasMany hasMany(string $related, string|null $foreignKey = null, string|null $localKey = null)
Определить отношение один-ко-многим.
protected HasMany newHasMany(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)
Определить отношение «многие ко многим через».
protected HasManyThrough newHasManyThrough(Builder $query, Model $farParent, Model $throughParent, string $firstKey, string $secondKey, string $localKey, string $secondLocalKey)
Инициализировать новое отношение «многие ко многим через».
MorphMany morphMany(string $related, string $name, string|null $type = null, string|null $id = null, string|null $localKey = null)
Определить полиморфное отношение «один ко многим».
protected MorphMany newMorphMany(Builder $query, Model $parent, string $type, string $id, string $localKey)
Инициализировать новое полиморфное отношение «один ко многим».
BelongsToMany belongsToMany(string $related, string|null $table = null, string|null $foreignPivotKey = null, string|null $relatedPivotKey = null, string|null $parentKey = null, string|null $relatedKey = null, string|null $relation = null)
Определить отношение «многие ко многим».
protected BelongsToMany newBelongsToMany(Builder $query, Model $parent, string $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string $relationName = null)
Инициализировать новое отношение «многие ко многим».
MorphToMany morphToMany(string $related, string $name, string|null $table = null, string|null $foreignPivotKey = null, string|null $relatedPivotKey = null, string|null $parentKey = null, string|null $relatedKey = null, bool $inverse = false)
Определить полиморфное отношение «многие ко многим».
protected MorphToMany newMorphToMany(Builder $query, Model $parent, string $name, string $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string|null $relationName = null, bool $inverse = false)
Инициализировать новое полиморфное отношение «многие ко многим».
MorphToMany morphedByMany(string $related, string $name, string|null $table = null, string|null $foreignPivotKey = null, string|null $relatedPivotKey = null, string|null $parentKey = null, string|null $relatedKey = null)
Определить полиморфное, обратное отношение «многие ко многим».
protected string|null guessBelongsToManyRelation()
Получить имя связи belongsToMany.
string joiningTable(string $related, Model|null $instance = null)
Получить имя таблицы соединения для связи many-to-many.
string joiningTableSegment()
Получить часть имени промежуточной таблицы для связи belongsToMany.
bool touches(string $relation)
Определить, касается ли модель заданную связь.
void touchOwners()
Обновить временные метки для владельческих связей модели.
protected array getMorphs(string $name, string $type, string $id)
Получить столбцы полиморфной связи.
string getMorphClass()
Получить имя класса для полиморфных связей.
protected mixed newRelatedInstance(string $class)
Создать новый экземпляр модели для связанной модели.
array getRelations()
Получить все загруженные связи для экземпляра.
mixed getRelation(string $relation)
Получить заданную связь.
bool relationLoaded(string $key)
Определить, загружена ли заданная связь.
$this setRelation(string $relation, mixed $value)
Установить заданную связь для модели.
$this unsetRelation(string $relation)
Удалить загруженную связь.
$this setRelations(array $relations)
Установить массив связей для модели.
$this withoutRelations()
Создать копию экземпляра и удалить все загруженные связи.
$this unsetRelations()
Удалить все загруженные связи для экземпляра.
array getTouchedRelations()
Получить связи, которые затрагиваются при сохранении.
$this setTouchedRelations(array $touches)
Установить связи, которые затрагиваются при сохранении.
bool touch()
Обновить временную метку последнего обновления модели.
protected void updateTimestamps()
Обновить временные метки создания и обновления.
$this setCreatedAt(mixed $value)
Установить значение атрибута "created at".
$this setUpdatedAt(mixed $value)
Установить значение атрибута "updated at".
Carbon freshTimestamp()
Получить свежую временную метку для модели.
string freshTimestampString()
Получить свежую строку временной метки для модели.
bool usesTimestamps()
Определить, использует ли модель временные метки.
string|null getCreatedAtColumn()
Получить имя столбца "создано".
string|null getUpdatedAtColumn()
Получить имя столбца "обновлено".
string getQualifiedCreatedAtColumn()
Получить полностью квалифицированный столбец "создано".
string getQualifiedUpdatedAtColumn()
Получить полностью квалифицированный столбец "обновлено".
array getHidden()
Получить скрытые атрибуты для модели.
$this setHidden(array $hidden)
Установить скрытые атрибуты для модели.
void addHidden(array|string|null $attributes = null)
Добавить скрытые атрибуты для модели.
array getVisible()
Получить видимые атрибуты для модели.
$this setVisible(array $visible)
Установить видимые атрибуты для модели.
void addVisible(array|string|null $attributes = null)
Добавить видимые атрибуты для модели.
$this makeVisible(array|string $attributes)
Сделать указанные, обычно скрытые, атрибуты видимыми.
$this makeHidden(array|string $attributes)
Сделать указанные, обычно видимые, атрибуты скрытыми.
array getFillable()
Получить заполняемые атрибуты для модели.
$this fillable(array $fillable)
Установить заполняемые атрибуты для модели.
array getGuarded()
Получить защищенные атрибуты для модели.
$this guard(array $guarded)
Установить защищенные атрибуты для модели.
static void unguard(bool $state = true)
Отключить все ограничения массового назначения.
static void reguard()
Включить ограничения массового назначения.
static bool isUnguarded()
Определить, находится ли текущее состояние в режиме "unguarded".
static mixed unguarded(callable $callback)
Выполнить заданный вызываемый объект в режиме "unguarded".
bool isFillable(string $key)
Определить, может ли указанный атрибут быть массово назначенным.
bool isGuarded(string $key)
Определить, защищен ли данный ключ.
protected bool isGuardableColumn(string $key)
Определить, является ли данный столбец допустимым, защищенным столбцом.
bool totallyGuarded()
Определить, является ли модель полностью защищенной.
protected array fillableFromArray(array $attributes)
Получить заполняемые атрибуты из заданного массива.
protected mixed forwardCallTo(mixed $object, string $method, array $parameters)
Перенаправить вызов метода заданному объекту.
static protected void throwBadMethodCallException(string $method)
Выбросить исключение ошибочного вызова метода для данного метода.
void __construct(array $attributes = [])
Создать новый экземпляр модели Eloquent.
protected void bootIfNotBooted()
Проверить, нужно ли загружать модель, и если нужно, сделать это.
static protected void boot()
Метод "загрузки" модели.
static protected void bootTraits()
Загрузить все загружаемые трейты модели.
protected void initializeTraits()
Инициализировать все инициализируемые трейты модели.
static void clearBootedModels()
Очистить список загруженных моделей, чтобы они были перезагружены.
static void withoutTouching(callable $callback)
Отключает касание модели отношений для текущего класса во время выполнения данного обратного вызова.
static void withoutTouchingOn(array $models, callable $callback)
Отключает касание модели отношений для заданных классов моделей во время выполнения данного обратного вызова.
static bool isIgnoringTouch(string|null $class = null)
Определить, игнорирует ли данная модель касания.
$this fill(array $attributes)
Заполнить модель массивом атрибутов.
$this forceFill(array $attributes)
Заполнить модель массивом атрибутов. Принудительно включить массовое присваивание.
string qualifyColumn(string $column)
Указать заданное имя столбца по таблице модели.
protected string removeTableFromKey(string $key)
Удалить имя таблицы из заданного ключа.
Модель newInstance(array $attributes = [], bool $exists = false)
Создать новый экземпляр заданной модели.
Модель newFromBuilder(array $attributes = [], string|null $connection = null)
Создать новый экземпляр модели, которая уже существует.
static Библиотека on(string|null $connection = null)
Начать запросы к модели на заданном соединении.
static Библиотека onWriteConnection()
Начать запросы к модели на соединении для записи.
static Builder with(array|string $relations)
Начать запросы модели с ленивой загрузкой.
$this load(array|string $relations)
Ленивая загрузка отношений модели.
$this loadMissing(array|string $relations)
Ленивая загрузка отношений модели, если они еще не загружены.
$this loadCount(array|string $relations)
Ленивая загрузка подсчета отношений модели.
protected int increment(string $column, float|int $amount = 1, array $extra = [])
Увеличение значения столбца на заданную величину.
protected int decrement(string $column, float|int $amount = 1, array $extra = [])
Уменьшение значения столбца на заданную величину.
protected int incrementOrDecrement(string $column, float|int $amount, array $extra, string $method)
Выполнение метода увеличения или уменьшения для модели.
protected void incrementOrDecrementAttributeValue(string $column, float|int $amount, array $extra, string $method)
Увеличение или уменьшение базового значения атрибута и синхронизация с оригиналом.
bool update(array $attributes = [], array $options = [])
Обновление модели в базе данных.
bool push()
Сохранение модели и всех ее взаимосвязей.
bool save(array $options = [])
Сохранение модели в базе данных.
bool saveOrFail(array $options = [])
Сохранение модели в базе данных с использованием транзакции.
protected void finishSave(array $options)
Выполнение необходимых действий после сохранения модели.
protected bool performUpdate(Builder $query)
Выполнение операции обновления модели.
protected mixed getKeyForSaveQuery()
Получить значение первичного ключа для запроса сохранения.
protected bool performInsert(Builder $query)
Выполнение операции вставки модели.
protected void insertAndSetId(Builder $query, array $attributes)
Вставить указанные атрибуты и установить ID в модели.
static int destroy(Collection|array|int $ids)
Удалить модели для заданных идентификаторов.
int delete()
Удалить запись модели-стержня из базы данных.
bool|null forceDelete()
Принудительно удалить мягко удалённую модель.
Этот метод защищает разработчиков от запуска forceDelete, когда отсутствует соответствующий трейт.
protected void performDeleteOnModel()
Выполнить фактическое удаление запроса для этого экземпляра модели.
static Builder query()
Начать запрос модели.
Builder newQuery()
Получить новый билдер запросов для таблицы модели.
Builder|Model newModelQuery()
Получить новый билдер запросов, который не имеет глобальных скопов или жадного загрузки.
Builder newQueryWithoutRelationships()
Получить новый билдер запросов без загруженных отношений.
Builder registerGlobalScopes(Builder $builder)
Зарегистрировать глобальные скопы для этого экземпляра билдера.
Builder newQueryWithoutScope(Scope|string $scope)
Получить новый экземпляр запроса без заданного скопа.
Builder newQueryForRestoration(int[]|string[]|string $ids)
Получить новый запрос для восстановления одной или нескольких моделей по их очередидам.
protected Builder newBaseQueryBuilder()
Получить новый экземпляр билдера запросов для соединения.
Collection newCollection(array $models = [])
Создать новый экземпляр коллекции Eloquent.
Pivot newPivot(Model $parent, array $attributes, string $table, bool $exists, string|null $using = null)
Создать новый экземпляр модели-стержня.
array toArray()
Преобразовать экземпляр модели в массив.
string toJson(int $options = 0)
Преобразовать экземпляр модели в JSON.
array jsonSerialize()
Преобразовать объект в что-то сериализуемое в JSON.
Model|null fresh(array|string $with = [])
Перезагрузить свежий экземпляр модели из базы данных.
$this refresh()
Перезагрузить текущую модель с новыми атрибутами из базы данных.
Модель replicate(array $except = null)
Клонировать модель в новую, несуществующую инстанцию.
bool is(Модель|null $model)
Определить, имеют ли две модели одинаковый ID и принадлежат ли одной и той же таблице.
bool isNot(Модель|null $model)
Определить, не являются ли две модели одинаковыми.
Соединение getConnection()
Получить соединение с базой данных для модели.
string|null getConnectionName()
Получить текущее имя соединения для модели.
$this setConnection(string|null $name)
Установить соединение, связанное с моделью.
static Соединение resolveConnection(string|null $connection = null)
Разрешить инстанцию соединения.
static Интерфейс разрешения соединения getConnectionResolver()
Получить инстанцию разрешения соединения.
static void setConnectionResolver(Интерфейс разрешения соединения $resolver)
Установить инстанцию разрешения соединения.
static void unsetConnectionResolver()
Удалить разрешение соединения для моделей.
string getTable()
Получить таблицу, связанную с моделью.
$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()
Получить идентификатор для очереди сущности.
array getQueueableRelations()
Получить отношения для очереди сущности.
string|null getQueueableConnection()
Получить соединение для очереди сущности.
mixed getRouteKey()
Получить значение ключа маршрута модели.
строка getRouteKeyName()
Получить ключ маршрута для модели.
Модель|null resolveRouteBinding(mixed $value)
Получить модель для привязанного значения.
строка getForeignKey()
Получить имя столбца внешнего ключа.
целое число getPerPage()
Получить количество моделей на страницу.
$this setPerPage(int $perPage)
Установить количество моделей на страницу.
смешанный тип __get(string $key)
Динамически получить атрибуты модели.
пусто __set(string $key, mixed $value)
Динамически установить атрибуты модели.
логическое значение offsetExists(mixed $offset)
Определить, существует ли данный атрибут.
смешанный тип offsetGet(mixed $offset)
Получить значение для данного смещения.
пусто offsetSet(mixed $offset, mixed $value)
Установить значение для данного смещения.
пусто offsetUnset(mixed $offset)
Удалить значение для данного смещения.
логическое значение __isset(string $key)
Определить, существует ли атрибут или отношение в модели.
пусто __unset(string $key)
Удалить атрибут модели.
смешанный тип __call(string $method, array $parameters)
Обработка динамических вызовов методов модели.
статический смешанный тип __callStatic(string $method, array $parameters)
Обработка динамических статических вызовов метода.
строка __toString()
Преобразовать модель в строковое представление.
пусто __wakeup()
При десериализации модели проверить, нужно ли ее загружать.
статический AsPivot fromAttributes(Модель $parent, array $attributes, string $table, bool $exists = false)
Создать новый экземпляр модели-связи.
статический AsPivot fromRawAttributes(Модель $parent, array $attributes, string $table, bool $exists = false)
Создать новую модель-связь из сырых значений, возвращенных запросом.
защищенное Билдер getDeleteQuery()
Получить билдер запроса для удаления связи.
строка getRelatedKey()
Получить имя столбца "связанный ключ".
строка getOtherKey()
Получить имя столбца "связанный ключ".
$this setPivotKeys(string $foreignKey, string $relatedKey)
Установить имена ключей для экземпляра модели моста.
bool hasTimestampAttributes(array|null $attributes = null)
Определить, содержит ли модель моста или заданные атрибуты атрибуты временной метки.
protected Builder newQueryForCollectionRestoration(array $ids)
Получить новый запрос для восстановления нескольких моделей по их идентификаторам очереди.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/6.x/Illuminate/Database/Eloquent/Relations/Pivot.html