Pivot
класс Pivot расширяет 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 массив | $classCastCache | Атрибуты, преобразованные с использованием пользовательских классов. | из HasAttributes |
| static protected массив | $primitiveCastTypes | Встроенные, примитивные типы преобразования, поддерживаемые Eloquent. | из 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 |
| static protected массив | $relationResolvers | Обработчики решения отношений. | из 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 | Указывает, являются ли идентификаторы автоматически инкрементируемыми. | |
| protected массив | $with | Отношения, которые необходимо загрузить с помощью eager loading для каждого запроса. | из Model |
| protected массив | $withCount | Счётчики отношений, которые необходимо загрузить с помощью eager loading для каждого запроса. | из Model |
| protected целое число | $perPage | Количество моделей, возвращаемых для пагинации. | из Model |
| bool | $exists | Указывает, существует ли модель. | из Model |
| bool | $wasRecentlyCreated | Указывает, была ли модель вставлена во время текущего жизненного цикла запроса. | из Model |
| static protected ConnectionResolverInterface | $resolver | Экземпляр обработчика соединения. | из Model |
| static protected Dispatcher | $dispatcher | Экземпляр диспетчера событий. | из Model |
| static protected массив | $booted | Массив запущенных моделей. | из Model |
| статический защищённый массив | $traitInitializers | Массив инициализаторов трейтов, которые будут вызываться при каждом новом экземпляре. | из Модели |
| статический защищённый массив | $globalScopes | Массив глобальных обработчиков модели. | из Модели |
| статический защищённый массив | $ignoreOnTouch | Список классов моделей, которые не должны обрабатываться при изменении. | из Модели |
| Модель | $pivotParent | Родительская модель отношения. | из AsPivot |
| защищённый строка | $foreignKey | Имя столбца внешнего ключа. | из AsPivot |
| защищённый строка | $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 |
| void | mergeCasts(массив $casts)
Объединить новые преобразования с существующими преобразованиями модели. | из HasAttributes |
| смешанный | castAttribute(строка $key, смешанный $value)
Преобразовать атрибут в базовый тип PHP. | из HasAttributes |
| смешанный | getClassCastableAttributeValue(строка $key, смешанный $value)
Преобразовать заданный атрибут с помощью пользовательского класса преобразования. | из HasAttributes |
| строка | getCastType(строка $key)
Получить тип преобразования для атрибута модели. | из HasAttributes |
| логическое | isCustomDateTimeCast(строка $cast)
Определить, является ли тип преобразования пользовательским преобразованием даты и времени. | из HasAttributes |
| логическое | isDecimalCast(строка $cast)
Определить, является ли тип преобразования десятичным преобразованием. | из HasAttributes |
| смешанный | setAttribute(строка $key, смешанный $value)
Установить заданный атрибут в модели. | из HasAttributes |
| логическое | hasSetMutator(строка $key)
Определить, существует ли мутатор для установки атрибута. | из HasAttributes |
| смешанный | setMutatedAttributeValue(строка $key, смешанный $value)
Установить значение атрибута с использованием его мутатора. | из HasAttributes |
| логическое | isDateAttribute(строка $key)
Определить, является ли заданный атрибут датой или преобразуемым в дату. | из HasAttributes |
| $this | fillJsonAttribute(строка $key, смешанный $value)
Установить заданный JSON атрибут в модели. | из HasAttributes |
| void | setClassCastableAttribute(строка $key, смешанный $value)
Установить значение атрибута с преобразованием в класс. | из HasAttributes |
| $this | getArrayAttributeWithValue(string $path, string $key, mixed $value)
Получить массив атрибутов с заданным ключом и установленным значением. | из HasAttributes |
| массив | getArrayAttributeByKey(string $key)
Получить массив атрибутов по ключу или вернуть пустой массив, если он не задан. | из HasAttributes |
| строка | castAttributeAsJson(string $key, mixed $value)
Преобразовать заданный атрибут в JSON. | из HasAttributes |
| строка | asJson(mixed $value)
Кодировать заданное значение в JSON. | из HasAttributes |
| смешанное | fromJson(string $value, bool $asObject = false)
Декодировать заданный JSON в массив или объект. | из HasAttributes |
| смешанное | fromFloat(mixed $value)
Декодировать заданное число с плавающей точкой. | из HasAttributes |
| строка | asDecimal(float $value, int $decimals)
Вернуть десятичное значение как строку. | из HasAttributes |
| Carbon | asDate(mixed $value)
Вернуть отметку времени как объект DateTime с временем, установленным в 00:00:00. | из HasAttributes |
| Carbon | asDateTime(mixed $value)
Вернуть отметку времени как объект DateTime. | из HasAttributes |
| булево | isStandardDateFormat(string $value)
Определить, является ли заданное значение стандартным форматом даты. | из HasAttributes |
| строка|null | fromDateTime(mixed $value)
Преобразовать DateTime в сохраняемую строку. | из HasAttributes |
| целое число | asTimestamp(mixed $value)
Вернуть отметку времени как метку времени Unix. | из HasAttributes |
| строка | serializeDate(DateTimeInterface $date)
Подготовить дату для сериализации в массив/JSON. | из HasAttributes |
| массив | getDates()
Получить атрибуты, которые должны быть преобразованы в даты. | из HasAttributes |
| строка | getDateFormat()
Получить формат для даты, хранящейся в базе данных. | из HasAttributes |
| $this | setDateFormat(string $format)
Установить формат даты, используемый моделью. | из HasAttributes |
| булево | hasCast(string $key, array|string|null $types = null)
Определить, должен ли атрибут преобразовываться в собственный тип. | из HasAttributes |
| массив | getCasts()
Получить массив преобразований. | из HasAttributes |
| булево | isDateCastable(string $key)
Определить, может ли значение преобразовываться в дату/DateTime для входных манипуляций. | из HasAttributes |
| булево | isJsonCastable(string $key)
Определить, может ли значение преобразовываться в JSON для входных манипуляций. | из HasAttributes |
| булево | isClassCastable(string $key)
Определить, использует ли заданный ключ преобразование с помощью пользовательского класса. | из HasAttributes |
| смешанное | resolveCasterClass(string $key)
Разрешить пользовательский класс-преобразователь для заданного ключа. | из HasAttributes |
| строка | parseCasterClass(string $class)
Разбирать заданный класс преобразователя, удаляя любые аргументы. | из HasAttributes |
| void | mergeAttributesFromClassCasts()
Объединить атрибуты класса преобразователя обратно в модель. | из HasAttributes |
| массив | normalizeCastClassResponse(string $key, mixed $value)
Нормализовать ответ от пользовательского класса-преобразователя. | из HasAttributes |
| массив | getAttributes()
Получить все текущие атрибуты модели. | из HasAttributes |
| $this | setRawAttributes(array $attributes, bool $sync = false)
Установить массив атрибутов модели. Проверка не выполняется. | из HasAttributes |
| смешанное|массив | getOriginal(string|null $key = null, mixed $default = null)
Получить исходные значения атрибутов модели. | из HasAttributes |
| смешанное|массив | getOriginalWithoutRewindingModel(string|null $key = null, mixed $default = null)
Получить исходные значения атрибутов модели. | из HasAttributes |
| mixed|array | getRawOriginal(string|null $key = null, mixed $default = null)
Получить исходные значения атрибутов модели в сыром виде. | из HasAttributes |
| array | only(array|mixed $attributes)
Получить подмножество атрибутов модели. | из HasAttributes |
| $this | syncOriginal()
Синхронизировать исходные атрибуты с текущими. | из HasAttributes |
| $this | syncOriginalAttribute(string $attribute)
Синхронизировать один исходный атрибут со значением текущим. | из HasAttributes |
| $this | syncOriginalAttributes(array|string $attributes)
Синхронизировать несколько исходных атрибутов с их текущими значениями. | из HasAttributes |
| $this | syncChanges()
Синхронизировать измененные атрибуты. | из HasAttributes |
| bool | isDirty(array|string|null $attributes = null)
Определить, была ли изменена модель или какой-либо из переданных атрибутов. | из HasAttributes |
| bool | isClean(array|string|null $attributes = null)
Определить, остались ли модель и все переданные атрибуты неизменными. | из HasAttributes |
| bool | wasChanged(array|string|null $attributes = null)
Определить, была ли изменена модель или какой-либо из переданных атрибутов. | из HasAttributes |
| bool | hasChanges(array $changes, array|string|null $attributes = null)
Определить, были ли изменены какие-либо из переданных атрибутов. | из HasAttributes |
| array | getDirty()
Получить атрибуты, которые были изменены с момента последней синхронизации. | из HasAttributes |
| array | getChanges()
Получить атрибуты, которые были изменены. | из HasAttributes |
| bool | originalIsEquivalent(string $key)
Определить, эквивалентны ли новые и старые значения для заданного ключа. | из HasAttributes |
| mixed | transformModelValue(string $key, mixed $value)
Преобразовать значение модели в сыром виде с помощью мутаторов, преобразователей и т. д. | из HasAttributes |
| $this | append(array|string $attributes)
Добавить атрибуты к запросу при построении запроса. | из HasAttributes |
| $this | setAppends(array $appends)
Установить аксессоры для добавления в массивы модели. | из HasAttributes |
| bool | hasAppended(string $attribute)
Возвращает, был ли атрибут аксессора добавлен. | из HasAttributes |
| array | getMutatedAttributes()
Получить измененные атрибуты для данного экземпляра. | из HasAttributes |
| static void | cacheMutatedAttributes(string $class)
Извлечь и кэшировать все измененные атрибуты класса. | из HasAttributes |
| static array | getMutatorMethods(mixed $class)
Получить все методы мутаторов атрибутов. | из HasAttributes |
| static void | observe(object|array|string $classes)
Зарегистрировать наблюдатели с моделью. | из HasEvents |
| void | registerObserver(object|string $class)
Зарегистрировать отдельный наблюдатель с моделью. | из HasEvents |
| array | getObservableEvents()
Получить имена наблюдаемых событий. | из HasEvents |
| $this | setObservableEvents(array $observables)
Установить имена наблюдаемых событий. | из HasEvents |
| void | addObservableEvents(array|mixed $observables)
Добавить имя наблюдаемого события. | из HasEvents |
| void | removeObservableEvents(array|mixed $observables)
Удалить имя наблюдаемого события. | из HasEvents |
| static void | registerModelEvent(string $event, Closure|string $callback)
Зарегистрировать событие модели в диспетчере. | из HasEvents |
| mixed | fireModelEvent(string $event, bool $halt = true)
Вызвать данное событие для модели. | из HasEvents |
| mixed|null | fireCustomModelEvent(string $event, string $method)
Вызвать пользовательское событие модели для заданного события. | из HasEvents |
| mixed | filterModelEventResults(mixed $result)
Отфильтровать результаты событий модели. | 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 | replicating(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 | withoutEvents(callable $callback)
Выполнить обратный вызов без срабатывания событий модели для любого типа модели. | 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 |
| static void | resolveRelationUsing(string $name, Closure $callback)
Определить решатель динамических отношений. | from HasRelationships |
| HasOne | hasOne(string $related, string|null $foreignKey = null, string|null $localKey = null)
Определить отношение один-к-одному. | from HasRelationships |
| HasOne | newHasOne(Builder $query, Model $parent, string $foreignKey, string $localKey)
Инициализировать новое отношение один-к-одному. | from HasRelationships |
| HasOneThrough | hasOneThrough(string $related, string $through, string|null $firstKey = null, string|null $secondKey = null, string|null $localKey = null, string|null $secondLocalKey = null)
Определить отношение has-one-through. | 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) Инициализировать новое полиморфное отношение один-к-одному. | from HasRelationships |
| BelongsTo | belongsTo(string $related, string|null $foreignKey = null, string|null $ownerKey = null, string|null $relation = null) Определить обратное отношение один-к-одному или один-ко-многим. | from HasRelationships |
| BelongsTo | newBelongsTo(Builder $query, Model $child, string $foreignKey, string $ownerKey, string $relation) Инициализировать новое отношение BelongsTo. | from HasRelationships |
| MorphTo | morphTo(string|null $name = null, string|null $type = null, string|null $id = null, string|null $ownerKey = null) Определить полиморфное обратное отношение один-к-одному или один-ко-многим. | from HasRelationships |
| MorphTo | morphEagerTo(string $name, string $type, string $id, string $ownerKey) Определить полиморфное обратное отношение один-к-одному или один-ко-многим. | from HasRelationships |
| MorphTo | morphInstanceTo(string $target, string $name, string $type, string $id, string $ownerKey) Определить полиморфное обратное отношение один-к-одному или один-ко-многим. | from HasRelationships |
| MorphTo | newMorphTo(Builder $query, Model $parent, string $foreignKey, string $ownerKey, string $type, string $relation) Инициализировать новое полиморфное отношение MorphTo. | from HasRelationships |
| static string | getActualClassNameForMorph(string $class) Получить фактическое имя класса для заданного полиморфного класса. | from HasRelationships |
| string | guessBelongsToRelation() Предположить имя отношения "belongs to". | from HasRelationships |
| HasMany | hasMany(string $related, string|null $foreignKey = null, string|null $localKey = null) Определить отношение один-ко-многим. | from HasRelationships |
| HasMany | newHasMany(Builder $query, Model $parent, string $foreignKey, string $localKey) Инициализировать новое отношение HasMany. | from HasRelationships |
| HasManyThrough | hasManyThrough(string $related, string $through, string|null $firstKey = null, string|null $secondKey = null, string|null $localKey = null, string|null $secondLocalKey = null) Определить отношение has-many-through. | from HasRelationships |
| HasManyThrough | newHasManyThrough(Builder $query, Model $farParent, Model $throughParent, string $firstKey, string $secondKey, string $localKey, string $secondLocalKey) Инициализировать новое отношение HasManyThrough. | from HasRelationships |
| MorphMany | morphMany(string $related, string $name, string|null $type = null, string|null $id = null, string|null $localKey = null) Определить полиморфное отношение один-ко-многим. | from HasRelationships |
| MorphMany | newMorphMany(Builder $query, Model $parent, string $type, string $id, string $localKey) Инициализировать новое полиморфное отношение MorphMany. | from HasRelationships |
| BelongsToMany | belongsToMany(string $related, string|null $table = null, string|null $foreignPivotKey = null, string|null $relatedPivotKey = null, string|null $parentKey = null, string|null $relatedKey = null, string|null $relation = null) Определить отношение многие-ко-многим. | from HasRelationships |
| BelongsToMany | newBelongsToMany(Builder $query, Model $parent, string $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string|null $relationName = null) Инициализировать новое отношение BelongsToMany. | from HasRelationships |
| MorphToMany | morphToMany(string $related, string $name, string|null $table = null, string|null $foreignPivotKey = null, string|null $relatedPivotKey = null, string|null $parentKey = null, string|null $relatedKey = null, bool $inverse = false)
Определить полиморфное отношение «многие ко многим». | из HasRelationships |
| MorphToMany | newMorphToMany(Builder $query, Model $parent, string $name, string $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string|null $relationName = null, bool $inverse = false)
Создать новое отношение MorphToMany. | из HasRelationships |
| MorphToMany | morphedByMany(string $related, string $name, string|null $table = null, string|null $foreignPivotKey = null, string|null $relatedPivotKey = null, string|null $parentKey = null, string|null $relatedKey = null)
Определить полиморфное обратное отношение «многие ко многим». | из HasRelationships |
| string|null | guessBelongsToManyRelation()
Получить имя отношения belongsToMany. | из HasRelationships |
| string | joiningTable(string $related, Model|null $instance = null)
Получить имя объединяющей таблицы для отношения «многие ко многим». | из HasRelationships |
| string | joiningTableSegment()
Получить часть имени промежуточной таблицы для отношений belongsToMany для этой модели. | из HasRelationships |
| bool | touches(string $relation)
Определить, затрагивает ли модель данное отношение. | из HasRelationships |
| void | touchOwners()
Затронуть дочерние отношения модели. | из HasRelationships |
| array | getMorphs(string $name, string $type, string $id)
Получить столбцы полиморфных отношений. | из HasRelationships |
| string | getMorphClass()
Получить имя класса для полиморфных отношений. | из HasRelationships |
| mixed | newRelatedInstance(string $class)
Создать новый экземпляр модели для связанной модели. | из HasRelationships |
| array | getRelations()
Получить все загруженные отношения для экземпляра. | из HasRelationships |
| mixed | getRelation(string $relation)
Получить указанное отношение. | из HasRelationships |
| bool | relationLoaded(string $key)
Определить, загружено ли данное отношение. | из HasRelationships |
| $this | setRelation(string $relation, mixed $value)
Установить данное отношение в модели. | из HasRelationships |
| $this | unsetRelation(string $relation)
Сбросить загруженное отношение. | из HasRelationships |
| $this | setRelations(array $relations)
Установить весь массив отношений в модели. | из HasRelationships |
| $this | withoutRelations()
Дублировать экземпляр и сбросить все загруженные отношения. | из HasRelationships |
| $this | unsetRelations()
Сбросить все загруженные отношения для экземпляра. | из HasRelationships |
| array | getTouchedRelations()
Получить отношения, которые затрагиваются при сохранении. | из HasRelationships |
| $this | setTouchedRelations(array $touches)
Установить отношения, которые затрагиваются при сохранении. | из HasRelationships |
| bool | touch()
Обновить временную метку обновления модели. | из HasTimestamps |
| void | updateTimestamps()
Обновить метки времени создания и обновления. | из HasTimestamps |
| $this | setCreatedAt(mixed $value)
Установить значение атрибута "created at". | из HasTimestamps |
| $this | setUpdatedAt(mixed $value)
Установить значение атрибута "updated at". | из HasTimestamps |
| Carbon | freshTimestamp()
Получить свежую метку времени для модели. | из HasTimestamps |
| string | freshTimestampString()
Получить свежую метку времени для модели. | из HasTimestamps |
| bool | usesTimestamps()
Определяет, использует ли модель метки времени. | from HasTimestamps |
| string|null | getCreatedAtColumn()
Получить имя столбца "created at". | from HasTimestamps |
| string|null | getUpdatedAtColumn()
Получить имя столбца "updated at". | from HasTimestamps |
| string | getQualifiedCreatedAtColumn()
Получить полностью квалифицированный столбец "created at". | from HasTimestamps |
| string | getQualifiedUpdatedAtColumn()
Получить полностью квалифицированный столбец "updated at". | from HasTimestamps |
| array | getHidden()
Получить скрытые атрибуты для модели. | from HidesAttributes |
| $this | setHidden(array $hidden)
Установить скрытые атрибуты для модели. | from HidesAttributes |
| array | getVisible()
Получить видимые атрибуты для модели. | from HidesAttributes |
| $this | setVisible(array $visible)
Установить видимые атрибуты для модели. | from HidesAttributes |
| $this | makeVisible(array|string|null $attributes)
Сделать заданные, обычно скрытые, атрибуты видимыми. | from HidesAttributes |
| $this | makeVisibleIf(bool|Closure $condition, array|string|null $attributes)
Сделать заданные, обычно скрытые, атрибуты видимыми, если пройден заданный тест истинности. | from HidesAttributes |
| $this | makeHidden(array|string|null $attributes)
Сделать заданные, обычно видимые, атрибуты скрытыми. | from HidesAttributes |
| $this | makeHiddenIf(bool|Closure $condition, array|string|null $attributes)
Сделать заданные, обычно видимые, атрибуты скрытыми, если пройден заданный тест истинности. | from HidesAttributes |
| array | getFillable()
Получить заполняемые атрибуты для модели. | from GuardsAttributes |
| $this | fillable(array $fillable)
Установить заполняемые атрибуты для модели. | from GuardsAttributes |
| $this | mergeFillable(array $fillable)
Объединить новые заполняемые атрибуты с существующими заполняемыми атрибутами в модели. | from GuardsAttributes |
| array | getGuarded()
Получить защищенные атрибуты для модели. | from GuardsAttributes |
| $this | guard(array $guarded)
Установить защищенные атрибуты для модели. | from GuardsAttributes |
| $this | mergeGuarded(array $guarded)
Объединить новые защищенные атрибуты с существующими защищенными атрибутами в модели. | from GuardsAttributes |
| static void | unguard(bool $state = true)
Отключить все ограничения массового присваивания. | from GuardsAttributes |
| static void | reguard()
Включить ограничения массового присваивания. | from GuardsAttributes |
| static bool | isUnguarded()
Определить, является ли текущее состояние "незащищенным". | from GuardsAttributes |
| static mixed | unguarded(callable $callback)
Выполнить заданный обратный вызов, будучи незащищенным. | from GuardsAttributes |
| bool | isFillable(string $key)
Определить, может ли данный атрибут быть массово назначен. | from GuardsAttributes |
| bool | isGuarded(string $key)
Определить, защищен ли данный ключ. | from GuardsAttributes |
| bool | isGuardableColumn(string $key)
Определить, является ли данный столбец допустимым, защищаемым столбцом. | from GuardsAttributes |
| bool | totallyGuarded()
Определить, полностью ли защищена модель. | from GuardsAttributes |
| array | fillableFromArray(array $attributes)
Получить заполняемые атрибуты данного массива. | from GuardsAttributes |
| mixed | forwardCallTo(mixed $object, string $method, array $parameters)
Перенаправить вызов метода на заданный объект. | from ForwardsCalls |
| static void | throwBadMethodCallException(string $method)
Выбросить исключение вызова недопустимого метода для заданного метода. | from ForwardsCalls |
| void | __construct(array $attributes = [])
Создать новый экземпляр модели Eloquent. | from Модель |
| void | bootIfNotBooted()
Проверить, нужно ли инициализировать модель, и если нужно, сделать это. | from Модель |
| static void | booting()
Выполнить необходимые действия перед инициализацией модели. | from Модель |
| static void | boot()
Инициализировать модель и ее трейты. | from Модель |
| static void | bootTraits()
Инициализировать все инициализируемые трейты модели. | from Модель |
| void | initializeTraits()
Инициализировать все инициализируемые трейты модели. | from Модель |
| static void | booted()
Выполнить необходимые действия после инициализации модели. | from Модель |
| static void | clearBootedModels()
Очистить список инициализированных моделей, чтобы они были повторно инициализированы. | from Модель |
| static void | withoutTouching(callable $callback)
Отключает изменение связанных моделей для текущего класса во время выполнения заданного обратного вызова. | from Модель |
| static void | withoutTouchingOn(array $models, callable $callback)
Отключает изменение связанных моделей для заданных классов моделей во время выполнения заданного обратного вызова. | from Модель |
| static bool | isIgnoringTouch(string|null $class = null)
Определить, игнорирует ли заданная модель изменения. | from Модель |
| $this | fill(array $attributes)
Заполнить модель массивом атрибутов. | from Модель |
| $this | forceFill(array $attributes)
Заполнить модель массивом атрибутов. Выполнить принудительное массовое назначение. | from Модель |
| string | qualifyColumn(string $column)
Квалифицировать заданное имя столбца по таблице модели. | from Модель |
| string | removeTableFromKey(string $key) устаревший
Удалить имя таблицы из заданного ключа. | from Модель |
| Модель | newInstance(array $attributes = [], bool $exists = false)
Создать новый экземпляр заданной модели. | from Модель |
| Модель | newFromBuilder(array $attributes = [], string|null $connection = null)
Создать новый экземпляр модели, которая уже существует. | from Модель |
| static Библиотека | on(string|null $connection = null)
Начать запросы к модели на заданном соединении. | from Модель |
| static Библиотека | onWriteConnection()
Начать запросы к модели на соединении записи. | from Модель |
| static Коллекция|Модель[] | all(array|mixed $columns = ['*'])
Получить все модели из базы данных. | from Модель |
| static Библиотека | with(array|string $relations)
Начать запросы к модели с ленивой загрузкой. | from Модель |
| $this | load(array|string $relations)
Загрузить отношения модели с ленивой загрузкой. | from Модель |
| $this | loadMorph(string $relation, array $relations)
Загрузить отношения по полиморфному отношению модели. | from Модель |
| $this | loadMissing(array|string $relations)
Загрузить отношения модели, если они еще не загружены. | from Модель |
| $this | loadCount(array|string $relations)
Загрузить счетчики отношений модели. | from Модель |
| $this | loadMorphCount(string $relation, array $relations)
Загрузить счетчики отношений по полиморфному отношению модели. | from Модель |
| int | increment(string $column, float|int $amount = 1, array $extra = [])
Увеличить значение столбца на заданное значение. | from Модель |
| int | decrement(string $column, float|int $amount = 1, array $extra = [])
Уменьшить значение столбца на заданное значение. | from Модель |
| int | incrementOrDecrement(string $column, float|int $amount, array $extra, string $method)
Выполнить метод увеличения или уменьшения значения столбца модели. | from Модель |
| void | incrementOrDecrementAttributeValue(string $column, float|int $amount, array $extra, string $method)
Увеличьте значение базового атрибута и синхронизируйте его с оригинальным. | from Модель |
| bool | update(array $attributes = [], array $options = [])
Обновить модель в базе данных. | from Модель |
| bool | push()
Сохранить модель и все её отношения. | from Модель |
| bool | save(array $options = [])
Сохранить модель в базе данных. | from Модель |
| bool | saveOrFail(array $options = [])
Сохранить модель в базе данных с использованием транзакции. | from Модель |
| void | finishSave(array $options)
Выполнить необходимые действия после сохранения модели. | from Модель |
| bool | performUpdate(Builder $query)
Выполнить операцию обновления модели. | from Модель |
| Builder | setKeysForSaveQuery(Builder $query)
Установить ключи для запроса сохранения. | from AsPivot |
| mixed | getKeyForSaveQuery()
Получить значение первичного ключа для запроса сохранения. | from Модель |
| bool | performInsert(Builder $query)
Выполнить операцию вставки модели. | from Модель |
| void | insertAndSetId(Builder $query, array $attributes)
Вставить заданные атрибуты и установить ID модели. | from Модель |
| static int | destroy(Collection|array|int|string $ids)
Удалить модели для заданных ID. | from Модель |
| int | delete()
Удалить запись модели-связи из базы данных. | from AsPivot |
| bool|null | forceDelete()
Выполнить жесткое удаление мягко удаленной модели. | from Модель |
| void | performDeleteOnModel()
Выполнить фактический запрос удаления для этого экземпляра модели. | from Модель |
| static Builder | query()
Начать запросы к модели. | from Модель |
| Builder | newQuery()
Получить новый создатель запросов для таблицы модели. | from Модель |
| Builder|Модель | newModelQuery()
Получить новый создатель запросов без глобальных областей видимости и неявной загрузки. | from Модель |
| Builder | newQueryWithoutRelationships()
Получить новый создатель запросов без загруженных отношений. | from Модель |
| Builder | registerGlobalScopes(Builder $builder)
Регистрация глобальных областей видимости для этого экземпляра создателя запросов. | from Модель |
| Builder|Модель | newQueryWithoutScopes()
Получить новый создатель запросов без глобальных областей видимости. | from Модель |
| Builder | newQueryWithoutScope(Scope|string $scope)
Получить новый экземпляр запроса без заданной области видимости. | from Модель |
| Builder | newQueryForRestoration(int[]|string[]|string $ids)
Получить новый запрос для восстановления одной или нескольких моделей по их идентификаторам очереди. | from AsPivot |
| Builder|Модель | newEloquentBuilder(Builder $query)
Создать новый создатель запросов Eloquent для модели. | from Модель |
| Builder | newBaseQueryBuilder()
Получить новый экземпляр создателя запросов для подключения. | from Модель |
| Collection | newCollection(array $models = [])
Создать новый экземпляр коллекции Eloquent. | from Модель |
| Pivot | newPivot(Модель $parent, array $attributes, string $table, bool $exists, string|null $using = null)
Создать новый экземпляр модели-связи. | from Модель |
| bool | hasNamedScope(string $scope)
Определить, есть ли у модели заданная область видимости. | from Модель |
| mixed | callNamedScope(string $scope, array $parameters = [])
Применить заданный именованный scope, если возможно. | из Модели |
| массив | toArray()
Преобразовать экземпляр модели в массив. | из Модели |
| строка | toJson(int $options = 0)
Преобразовать экземпляр модели в JSON. | из Модели |
| массив | jsonSerialize()
Преобразовать объект в формат, сериализуемый в JSON. | из Модели |
| Модель|null | fresh(array|string $with = [])
Перезагрузить свежий экземпляр модели из базы данных. | из Модели |
| $this | refresh()
Перезагрузить текущий экземпляр модели с новыми атрибутами из базы данных. | из Модели |
| Модель | replicate(array $except = null)
Создать копию модели в новый, не существующий экземпляр. | из Модели |
| логическое значение | is(Модель|null $model)
Определить, имеют ли две модели одинаковый ID и принадлежат ли одной таблице. | из Модели |
| логическое значение | isNot(Модель|null $model)
Определить, не являются ли две модели одинаковыми. | из Модели |
| Подключение | getConnection()
Получить подключение к базе данных для модели. | из Модели |
| строка|null | getConnectionName()
Получить текущее имя подключения для модели. | из Модели |
| $this | setConnection(string|null $name)
Установить подключение, связанное с моделью. | из Модели |
| статический Подключение | resolveConnection(string|null $connection = null)
Разрешить экземпляр подключения. | из Модели |
| статический Интерфейс разрешения подключения | getConnectionResolver()
Получить экземпляр разрешителя подключения. | из Модели |
| статический void | setConnectionResolver(Интерфейс разрешения подключения $resolver)
Установить экземпляр разрешителя подключения. | из Модели |
| статический void | unsetConnectionResolver()
Удалить разрешитель подключения для моделей. | из Модели |
| строка | getTable()
Получить таблицу, связанную с моделью. | из AsPivot |
| $this | setTable(string $table)
Установить таблицу, связанную с моделью. | из Модели |
| строка | getKeyName()
Получить первичный ключ для модели. | из Модели |
| $this | setKeyName(string $key)
Установить первичный ключ для модели. | из Модели |
| строка | getQualifiedKeyName()
Получить имя квалифицированного первичного ключа. | из Модели |
| строка | getKeyType()
Получить тип автоинкрементируемого ключа. | из Модели |
| $this | setKeyType(string $type)
Установить тип данных для первичного ключа. | из Модели |
| логическое значение | getIncrementing()
Получить значение, указывающее, являются ли ID инкрементируемыми. | из Модели |
| $this | setIncrementing(bool $value)
Установить, являются ли ID инкрементируемыми. | из Модели |
| mixed | getKey()
Получить значение первичного ключа модели. | из Модели |
| mixed | getQueueableId()
Получить идентификатор для очереди сущности. | из AsPivot |
| массив | getQueueableRelations()
Получить отношения для очереди сущности. | из Модели |
| строка|null | getQueueableConnection()
Получить подключение для очереди сущности. | из Модели |
| mixed | getRouteKey()
Получить значение маршрутного ключа модели. | из Модели |
| строка | getRouteKeyName()
Получить маршрутный ключ для модели. | из Модели |
| Модель|null | resolveRouteBinding(mixed $value, string|null $field = null)
Получить модель по связанному значению. | из Модели |
| Модель|null | resolveChildRouteBinding(string $childType, mixed $value, string|null $field)
Получить дочернюю модель для привязанного значения. | из Модели |
| строка | getForeignKey()
Получить имя столбца внешнего ключа. | из AsPivot |
| целое число | getPerPage()
Получить количество моделей на страницу. | из Модели |
| $this | setPerPage(int $perPage)
Установить количество моделей на страницу. | из Модели |
| смешанное | __get(string $key)
Динамически получить атрибуты модели. | из Модели |
| void | __set(string $key, mixed $value)
Динамически установить атрибуты модели. | из Модели |
| логическое значение | offsetExists(mixed $offset)
Определить, существует ли данный атрибут. | из Модели |
| смешанное | offsetGet(mixed $offset)
Получить значение для заданного смещения. | из Модели |
| void | offsetSet(mixed $offset, mixed $value)
Установить значение для заданного смещения. | из Модели |
| void | offsetUnset(mixed $offset)
Удалить значение для заданного смещения. | из Модели |
| логическое значение | __isset(string $key)
Определить, существует ли атрибут или отношение в модели. | из Модели |
| void | __unset(string $key)
Удалить атрибут из модели. | из Модели |
| смешанное | __call(string $method, array $parameters)
Обработка вызовов динамических методов модели. | из Модели |
| статическая смешанная | __callStatic(string $method, array $parameters)
Обработка вызовов динамических статических методов модели. | из Модели |
| строка | __toString()
Преобразовать модель в строковое представление. | из Модели |
| массив | __sleep()
Подготовить объект для сериализации. | из Модели |
| void | __wakeup()
При десериализации модели проверить, нужно ли её загружать. | из Модели |
| статическая AsPivot | fromAttributes(Модель $parent, array $attributes, string $table, bool $exists = false)
Создать новый экземпляр модели сводки. | из AsPivot |
| статическая AsPivot | fromRawAttributes(Модель $parent, array $attributes, string $table, bool $exists = false)
Создать новую модель сводки из сырых значений, возвращенных запросом. | из AsPivot |
| Строитель | getDeleteQuery()
Получить строитель запроса для удаления сводки. | из AsPivot |
| строка | getRelatedKey()
Получить имя столбца "связанного ключа". | из AsPivot |
| строка | getOtherKey()
Получить имя столбца "связанного ключа". | из AsPivot |
| $this | setPivotKeys(string $foreignKey, string $relatedKey)
Установить имена ключей для экземпляра модели сводки. | из AsPivot |
| логическое значение | hasTimestampAttributes(array|null $attributes = null)
Определить, имеет ли модель сводки или заданные атрибуты атрибуты времени. | из AsPivot |
| Строитель | newQueryForCollectionRestoration(array $ids)
Получить новый запрос для восстановления нескольких моделей по их идентификаторам очереди. | из AsPivot |
Подробности
массив attributesToArray()
Преобразовать атрибуты модели в массив.
protected массив addDateAttributesToArray(array $attributes)
Добавить атрибуты даты в массив атрибутов.
protected массив addMutatedAttributesToArray(array $attributes, array $mutatedAttributes)
Добавить изменённые атрибуты в массив атрибутов.
protected массив 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)
Определить, существует ли мутатор get для атрибута.
protected mixed mutateAttribute(string $key, mixed $value)
Получить значение атрибута с использованием мутатора.
protected mixed mutateAttributeForArray(string $key, mixed $value)
Получить значение атрибута с использованием мутатора для преобразования в массив.
void mergeCasts(array $casts)
Объединить новые преобразования с существующими преобразованиями модели.
protected mixed castAttribute(string $key, mixed $value)
Преобразовать атрибут к исходному типу PHP.
protected mixed getClassCastableAttributeValue(string $key, mixed $value)
Преобразовать указанный атрибут с использованием пользовательского класса преобразования.
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 void setClassCastableAttribute(string $key, mixed $value)
Установить значение атрибута, преобразуемого в класс.
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 для обработки входных данных.
protected bool isClassCastable(string $key)
Определить, можно ли преобразовать данный ключ с помощью пользовательского класса.
protected mixed resolveCasterClass(string $key)
Получить пользовательский класс-преобразователь для заданного ключа.
protected string parseCasterClass(string $class)
Обработать заданный класс-преобразователь, удалив любые аргументы.
protected void mergeAttributesFromClassCasts()
Объединить атрибуты класса-преобразователя обратно в модель.
protected array normalizeCastClassResponse(string $key, mixed $value)
Нормализовать ответ от пользовательского класса-преобразователя.
array getAttributes()
Получить все текущие атрибуты модели.
$this setRawAttributes(array $attributes, bool $sync = false)
Установить массив атрибутов модели. Проверка не выполняется.
mixed|array getOriginal(string|null $key = null, mixed $default = null)
Получить исходные значения атрибутов модели.
protected mixed|array getOriginalWithoutRewindingModel(string|null $key = null, mixed $default = null)
Получить исходные значения атрибутов модели.
mixed|array getRawOriginal(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)
Определить, эквивалентны ли новые и старые значения для заданного ключа.
protected mixed transformModelValue(string $key, mixed $value)
Преобразовать сырое значение модели с помощью мутаторов, преобразований и т. д.
$this append(array|string $attributes)
Добавить атрибуты к запросу при построении запроса.
$this setAppends(array $appends)
Установить аксессоры для добавления в массивы моделей.
bool hasAppended(string $attribute)
Возвращает, был ли атрибут аксессора добавлен.
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 для этого экземпляра класса.
static void resolveRelationUsing(string $name, Closure $callback)
Определить динамический решатель отношений.
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)
Инициализировать новое полиморфное отношение один-к-одному.
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)
Получить фактическое имя класса для заданного класса morph.
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)
Определите отношение has-many-through.
protected HasManyThrough newHasManyThrough(Builder $query, Model $farParent, Model $throughParent, string $firstKey, string $secondKey, string $localKey, string $secondLocalKey)
Инициализируйте новое отношение HasManyThrough.
MorphMany morphMany(string $related, string $name, string|null $type = null, string|null $id = null, string|null $localKey = null)
Определите полиморфное отношение один-ко-многим.
protected MorphMany newMorphMany(Builder $query, Model $parent, string $type, string $id, string $localKey)
Инициализируйте новое отношение MorphMany.
BelongsToMany belongsToMany(string $related, string|null $table = null, string|null $foreignPivotKey = null, string|null $relatedPivotKey = null, string|null $parentKey = null, string|null $relatedKey = null, string|null $relation = null)
Определите отношение многие-ко-многим.
protected BelongsToMany newBelongsToMany(Builder $query, Model $parent, string $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string|null $relationName = null)
Создать новую связь BelongsToMany.
MorphToMany morphToMany(string $related, string $name, string|null $table = null, string|null $foreignPivotKey = null, string|null $relatedPivotKey = null, string|null $parentKey = null, string|null $relatedKey = null, bool $inverse = false)
Определить полиморфную связь many-to-many.
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)
Создать новую полиморфную связь many-to-many.
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)
Определить полиморфную обратную связь many-to-many.
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()
Получить имя столбца "created at".
string|null getUpdatedAtColumn()
Получить имя столбца "updated at".
string getQualifiedCreatedAtColumn()
Получить полностью квалифицированный столбец "created at".
string getQualifiedUpdatedAtColumn()
Получить полностью квалифицированный столбец "updated at".
array getHidden()
Получить скрытые атрибуты модели.
$this setHidden(array $hidden)
Установить скрытые атрибуты модели.
array getVisible()
Получить видимые атрибуты модели.
$this setVisible(array $visible)
Установить видимые атрибуты модели.
$this makeVisible(array|string|null $attributes)
Сделать указанные, обычно скрытые, атрибуты видимыми.
$this makeVisibleIf(bool|Closure $condition, array|string|null $attributes)
Сделать указанные, обычно скрытые, атрибуты видимыми, если заданное условие истинно.
$this makeHidden(array|string|null $attributes)
Сделать указанные, обычно видимые, атрибуты скрытыми.
$this makeHiddenIf(bool|Closure $condition, array|string|null $attributes)
Сделать указанные, обычно видимые, атрибуты скрытыми, если заданное условие истинно.
массив getFillable()
Получить атрибуты, которые можно заполнить для модели.
$this fillable(массив $fillable)
Установить атрибуты, которые можно заполнить для модели.
$this mergeFillable(массив $fillable)
Объединить новые атрибуты, которые можно заполнить, с существующими атрибутами, которые можно заполнить, в модели.
массив getGuarded()
Получить атрибуты, которые защищены от массового присваивания для модели.
$this guard(массив $guarded)
Установить атрибуты, которые защищены от массового присваивания для модели.
$this mergeGuarded(массив $guarded)
Объединить новые защищенные атрибуты с существующими защищенными атрибутами в модели.
статический пустое значение unguard(bool $state = true)
Отключить все ограничения массового присваивания.
статический пустое значение reguard()
Включить ограничения массового присваивания.
статический логическое значение isUnguarded()
Определить, находится ли текущее состояние в режиме "unguarded".
статический смешанное unguarded(вызываемый $callback)
Выполнить заданный вызываемый объект, находясь в режиме "unguarded".
логическое значение isFillable(строка $key)
Определить, может ли данный атрибут быть присвоен массово.
логическое значение isGuarded(строка $key)
Определить, защищен ли данный ключ.
защищенное логическое значение isGuardableColumn(строка $key)
Определить, является ли данный столбец допустимым и защищенным столбцом.
логическое значение totallyGuarded()
Определить, защищена ли модель полностью.
защищенное массив fillableFromArray(массив $attributes)
Получить атрибуты, которые можно заполнить, из заданного массива.
защищенное смешанное forwardCallTo(смешанное $object, строка $method, массив $parameters)
Перенаправить вызов метода к заданному объекту.
статический защищенное пустое значение throwBadMethodCallException(строка $method)
Выбросить исключение BadMethodCallException для заданного метода.
пустое значение __construct(массив $attributes = [])
Создать новый экземпляр модели Eloquent.
защищенное пустое значение bootIfNotBooted()
Проверить, нужна ли загрузка модели, и если нужно, загрузить ее.
статический защищенное пустое значение booting()
Выполнить все необходимые действия перед началом работы модели.
статический защищенное пустое значение boot()
Инициализировать модель и ее трейты.
статический защищенное пустое значение bootTraits()
Инициализировать все загружаемые трейты модели.
защищенное пустое значение initializeTraits()
Инициализировать все инициализируемые трейты модели.
статический защищенное пустое значение booted()
Выполнить все необходимые действия после начала работы модели.
статический пустое значение 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) deprecated
deprecated
Удаляет имя таблицы из заданного ключа.
Model newInstance(array $attributes = [], bool $exists = false)
Создает новый экземпляр заданной модели.
Model newFromBuilder(array $attributes = [], string|null $connection = null)
Создает новый экземпляр модели, которая уже существует.
static Builder on(string|null $connection = null)
Начинает запросы к модели на заданном соединении.
static Builder onWriteConnection()
Начинает запросы к модели на соединении для записи.
static Collection|Model[] all(array|mixed $columns = ['*'])
Получить все модели из базы данных.
static Builder with(array|string $relations)
Начинает запросы к модели с леничной загрузкой.
$this load(array|string $relations)
Загружает отношения модели с леничной загрузкой.
$this loadMorph(string $relation, array $relations)
Загружает отношения модели с леничной загрузкой на полиморфном отношении.
$this loadMissing(array|string $relations)
Загружает отношения модели с леничной загрузкой, если они ещё не загружены.
$this loadCount(array|string $relations)
Загружает подсчет отношений модели с леничной загрузкой.
$this loadMorphCount(string $relation, array $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|string $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)
Получить новый запрос для восстановления одного или нескольких моделей по их идентификаторам очереди.
Builder|Model newEloquentBuilder(Builder $query)
Создать новый конструктор запроса Eloquent для модели.
protected Builder newBaseQueryBuilder()
Получить новый экземпляр конструктора запроса для подключения.
Collection newCollection(array $models = [])
Создать новый экземпляр коллекции Eloquent.
Pivot newPivot(Model $parent, array $attributes, string $table, bool $exists, string|null $using = null)
Создать новый экземпляр модели Pivot.
bool hasNamedScope(string $scope)
Определить, имеет ли модель заданную область.
mixed callNamedScope(string $scope, array $parameters = [])
Применить заданную именованную область, если это возможно.
array toArray()
Преобразовать экземпляр модели в массив.
string toJson(int $options = 0)
Преобразовать экземпляр модели в JSON.
array jsonSerialize()
Преобразовать объект в что-то сериализуемое в JSON.
Model|null fresh(array|string $with = [])
Перезагрузить свежий экземпляр модели из базы данных.
$this refresh()
Перезагрузить текущий экземпляр модели с новыми атрибутами из базы данных.
Model replicate(array $except = null)
Клонировать модель в новый, не существующий экземпляр.
bool is(Model|null $model)
Определить, имеют ли две модели одинаковый ID и принадлежат ли одной таблице.
bool isNot(Модель|null $model)
Определить, не являются ли две модели одинаковыми.
Подключение getConnection()
Получить подключение к базе данных для модели.
строка|null getConnectionName()
Получить текущее имя подключения для модели.
$this setConnection(строка|null $name)
Установить подключение, связанное с моделью.
static Подключение resolveConnection(строка|null $connection = null)
Разрешить экземпляр подключения.
static Интерфейс разрешения подключений getConnectionResolver()
Получить экземпляр разрешителя подключений.
static void setConnectionResolver(Интерфейс разрешения подключений $resolver)
Установить экземпляр разрешителя подключений.
static void unsetConnectionResolver()
Удалить разрешитель подключений для моделей.
строка getTable()
Получить таблицу, связанную с моделью.
$this setTable(строка $table)
Установить таблицу, связанную с моделью.
строка getKeyName()
Получить первичный ключ для модели.
$this setKeyName(строка $key)
Установить первичный ключ для модели.
строка getQualifiedKeyName()
Получить имя квалифицированного ключа таблицы.
строка getKeyType()
Получить тип автоинкрементируемого ключа.
$this setKeyType(строка $type)
Установить тип данных для первичного ключа.
bool getIncrementing()
Получить значение, указывающее, являются ли идентификаторы инкрементируемыми.
$this setIncrementing(bool $value)
Установить, являются ли идентификаторы инкрементируемыми.
смешанный getKey()
Получить значение первичного ключа модели.
смешанный getQueueableId()
Получить идентификатор очереди для сущности.
массив getQueueableRelations()
Получить отношения очереди для сущности.
строка|null getQueueableConnection()
Получить подключение очереди для сущности.
смешанный getRouteKey()
Получить значение ключа маршрута модели.
строка getRouteKeyName()
Получить ключ маршрута для модели.
Модель|null resolveRouteBinding(смешанный $value, строка|null $field = null)
Получить модель для связанного значения.
Модель|null resolveChildRouteBinding(string $childType, mixed $value, string|null $field)
Получить дочернюю модель для связанного значения.
string getForeignKey()
Получить имя внешнего ключа столбца.
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()
Преобразовать модель в строковое представление.
array __sleep()
Подготовить объект для сериализации.
void __wakeup()
При десериализации модели, проверить, нужно ли ее загрузить.
static AsPivot fromAttributes(Модель $parent, array $attributes, string $table, bool $exists = false)
Создать новый экземпляр модели-связи.
static AsPivot fromRawAttributes(Модель $parent, array $attributes, string $table, bool $exists = false)
Создать новую модель-связь из сырых значений, полученных из запроса.
protected Билдер getDeleteQuery()
Получить билдер запроса для удаления связи.
string getRelatedKey()
Получить имя столбца "связанного ключа".
string 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/7.x/Illuminate/Database/Eloquent/Relations/Pivot.html