Модель
абстрактный класс Модель реализует Arrayable, ArrayAccess, Jsonable, JsonSerializable, QueueableEntity, UrlRoutable (Просмотреть исходный код)
Трейты
| HasAttributes | |
| HasEvents | |
| HasGlobalScopes | |
| HasRelationships | |
| HasTimestamps | |
| HidesAttributes | |
| GuardsAttributes | |
| ForwardsCalls |
Константы
| CREATED_AT | Имя колонки "создано в". |
| UPDATED_AT | Имя колонки "обновлено в". |
Свойства
| protected массив | $attributes | Атрибуты модели. | из HasAttributes |
| protected массив | $original | Исходное состояние атрибутов модели. | из HasAttributes |
| protected массив | $changes | Измененные атрибуты модели. | из HasAttributes |
| protected массив | $casts | Атрибуты, которые должны быть преобразованы в базовые типы. | из HasAttributes |
| protected массив | $dates | Атрибуты, которые должны быть преобразованы в даты. | из HasAttributes |
| protected строка | $dateFormat | Формат хранения столбцов даты модели. | из HasAttributes |
| protected массив | $appends | Аксессоры для добавления к массивному представлению модели. | из HasAttributes |
| static bool | $snakeAttributes | Указывает, преобразуются ли атрибуты в нижний регистр с дефисами в массивах. | из HasAttributes |
| static protected массив | $mutatorCache | Кэш мутированных атрибутов для каждого класса. | из HasAttributes |
| protected массив | $dispatchesEvents | Карта событий для модели. | из HasEvents |
| protected массив | $observables | Доступные пользователю наблюдаемые события. | из HasEvents |
| protected массив | $relations | Загруженные отношения для модели. | из HasRelationships |
| protected массив | $touches | Отношения, которые должны быть изменены при сохранении. | из HasRelationships |
| static массив | $manyMethods | Методы отношений «многие ко многим». | из HasRelationships |
| bool | $timestamps | Указывает, должна ли модель иметь метки времени. | из HasTimestamps |
| $hidden | Атрибуты, которые должны быть скрыты при сериализации. | из HidesAttributes | |
| protected массив | $visible | Атрибуты, которые должны быть видны при сериализации. | из HidesAttributes |
| protected массив | $fillable | Атрибуты, которые можно массово назначать. | из GuardsAttributes |
| protected массив | $guarded | Атрибуты, которые нельзя массово назначать. | из GuardsAttributes |
| static protected bool | $unguarded | Указывает, включена ли массовая привязка всех атрибутов. | из GuardsAttributes |
| static protected массив | $guardableColumns | Фактические столбцы, существующие в базе данных и которые могут быть защищены. | из GuardsAttributes |
| protected строка|null | $connection | Имя подключения для модели. | |
| protected строка | $table | Таблица, связанная с моделью. | |
| protected строка | $primaryKey | Первичный ключ модели. | |
| protected строка | $keyType | «Тип» первичного ключа ID. | |
| bool | $incrementing | Указывает, являются ли идентификаторы автоматически инкрементируемыми. | |
| protected массив | $with | Отношения, которые следует загрузить с жадной загрузкой при каждом запросе. | |
| protected массив | $withCount | Подсчет отношений, которые следует загрузить с жадной загрузкой при каждом запросе. | |
| protected целое число | $perPage | Количество моделей, возвращаемых для пагинации. | |
| bool | $exists | Указывает, существует ли модель. | |
| bool | $wasRecentlyCreated | Указывает, была ли модель вставлена во время текущего цикла обработки запроса. | |
| static protected ConnectionResolverInterface | $resolver | Экземпляр решателя соединений. | |
| static protected Dispatcher | $dispatcher | Экземпляр диспетчера событий. | |
| static protected массив | $booted | Массив загруженных моделей. | |
| static protected массив | $traitInitializers | Массив инициализаторов трейтов, которые будут вызываться при каждом новом экземпляре. | |
| static protected массив | $globalScopes | Массив глобальных областей действия модели. | |
| static protected массив | $ignoreOnTouch | Список классов моделей, которые не должны затрагиваться при использовании touch. |
Методы
| массив | 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. | из HasAttributes |
| mixed | fromJson(string $value, bool $asObject = false)
Декодировать заданное значение JSON в массив или объект. | из HasAttributes |
| mixed | fromFloat(mixed $value)
Декодировать заданное значение с плавающей точкой. | из HasAttributes |
| string | asDecimal(float $value, int $decimals)
Возвращает десятичное значение в виде строки. | из HasAttributes |
| Carbon | asDate(mixed $value)
Возвращает метку времени как объект DateTime с временем, установленным в 00:00:00. | из HasAttributes |
| Carbon | asDateTime(mixed $value)
Возвращает метку времени как объект DateTime. | из HasAttributes |
| bool | isStandardDateFormat(string $value)
Определяет, соответствует ли заданное значение стандартному формату даты. | из HasAttributes |
| string|null | fromDateTime(mixed $value)
Преобразовать DateTime в сохраняемую строку. | из HasAttributes |
| int | asTimestamp(mixed $value)
Возвращает метку времени как unix timestamp. | из HasAttributes |
| string | serializeDate(DateTimeInterface $date)
Подготовить дату для сериализации в массив/JSON. | из HasAttributes |
| array | getDates()
Получить атрибуты, которые должны быть преобразованы в даты. | из HasAttributes |
| string | getDateFormat()
Получить формат для даты, хранящейся в базе данных. | из HasAttributes |
| $this | setDateFormat(string $format)
Установить формат даты, используемый моделью. | из HasAttributes |
| bool | hasCast(string $key, array|string|null $types = null)
Определить, должен ли атрибут быть преобразован в базовый тип. | из HasAttributes |
| array | getCasts()
Получить массив преобразований. | из HasAttributes |
| bool | isDateCastable(string $key)
Определить, может ли значение быть преобразовано в дату/DateTime для обработки на входе. | из HasAttributes |
| bool | isJsonCastable(string $key)
Определить, может ли значение быть преобразовано в JSON для обработки на входе. | из HasAttributes |
| array | getAttributes()
Получить все текущие атрибуты модели. | из HasAttributes |
| $this | setRawAttributes(array $attributes, bool $sync = false)
Установить массив атрибутов модели. Проверка не выполняется. | из HasAttributes |
| mixed|array | getOriginal(string|null $key = null, mixed $default = null)
Получить исходные значения атрибутов модели. | из HasAttributes |
| array | only(array|mixed $attributes)
Получить подмножество атрибутов модели. | из HasAttributes |
| $this | syncOriginal()
Синхронизировать исходные атрибуты с текущими. | из HasAttributes |
| $this | syncOriginalAttribute(string $attribute)
Синхронизировать один исходный атрибут со своим текущим значением. | из HasAttributes |
| $this | 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 |
| массив | getDirty()
Получить атрибуты, которые были изменены с момента последней синхронизации. | из HasAttributes |
| массив | getChanges()
Получить атрибуты, которые были изменены. | из HasAttributes |
| булево | originalIsEquivalent(string $key, mixed $current)
Определить, эквивалентны ли новые и старые значения для данного ключа. | из HasAttributes |
| $this | append(array|string $attributes)
Добавить атрибуты к запросу при построении запроса. | из HasAttributes |
| $this | setAppends(array $appends)
Установить аксессоры для добавления в массивы модели. | из HasAttributes |
| массив | getMutatedAttributes()
Получить измененные атрибуты для данного экземпляра. | из HasAttributes |
| статический void | cacheMutatedAttributes(string $class)
Извлечь и кэшировать все измененные атрибуты класса. | из HasAttributes |
| статический массив | getMutatorMethods(mixed $class)
Получить все методы мутаторов атрибутов. | из HasAttributes |
| статический 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 |
| статический 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 |
| статический void | retrieved(Closure|string $callback)
Зарегистрировать событие извлеченной модели с диспетчером. | из HasEvents |
| статический void | saving(Closure|string $callback)
Зарегистрировать событие сохранения модели с диспетчером. | из HasEvents |
| статический void | saved(Closure|string $callback)
Зарегистрировать событие сохраненной модели с диспетчером. | из HasEvents |
| статический void | updating(Closure|string $callback)
Зарегистрировать событие обновления модели с диспетчером. | из HasEvents |
| статический void | updated(Closure|string $callback)
Зарегистрировать событие обновленной модели с диспетчером. | из HasEvents |
| статический void | creating(Closure|string $callback)
Зарегистрировать событие создания модели с диспетчером. | из HasEvents |
| статический void | created(Closure|string $callback)
Зарегистрировать событие созданной модели с диспетчером. | из HasEvents |
| статический void | replicating(Closure|string $callback)
Зарегистрировать событие копирования модели с диспетчером. | из HasEvents |
| статический void | deleting(Closure|string $callback)
Зарегистрировать событие удаления модели с диспетчером. | из HasEvents |
| статический 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()
Угадать имя отношения «принадлежит к». | из 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 |
| массив | getRelations()
Получить все загруженные отношения для экземпляра. | из HasRelationships |
| смешанный | getRelation(строка $relation)
Получить указанное отношение. | из HasRelationships |
| логическое | relationLoaded(строка $key)
Определить, загружено ли заданное отношение. | из HasRelationships |
| $this | setRelation(строка $relation, смешанный $value)
Установить заданное отношение для модели. | из HasRelationships |
| $this | unsetRelation(строка $relation)
Удалить загруженное отношение. | из HasRelationships |
| $this | setRelations(массив $relations)
Установить весь массив отношений для модели. | из HasRelationships |
| $this | withoutRelations()
Создать дубликат экземпляра и удалить все загруженные отношения. | из HasRelationships |
| $this | unsetRelations()
Удалить все загруженные отношения для экземпляра. | из HasRelationships |
| массив | getTouchedRelations()
Получить отношения, которые затрагиваются при сохранении. | из HasRelationships |
| $this | setTouchedRelations(массив $touches)
Установить отношения, которые затрагиваются при сохранении. | из HasRelationships |
| логическое | touch()
Обновить отметку времени изменения модели. | из HasTimestamps |
| пусто | updateTimestamps()
Обновить отметки времени создания и изменения. | из HasTimestamps |
| $this | setCreatedAt(смешанный $value)
Установить значение атрибута "created at". | из HasTimestamps |
| $this | setUpdatedAt(смешанный $value)
Установить значение атрибута "updated at". | из HasTimestamps |
| Carbon | freshTimestamp()
Получить свежую отметку времени для модели. | из HasTimestamps |
| строка | freshTimestampString()
Получить свежую отметку времени для модели. | из HasTimestamps |
| логическое | usesTimestamps()
Определить, использует ли модель отметки времени. | из HasTimestamps |
| строка|null | getCreatedAtColumn()
Получить имя столбца "created at". | из HasTimestamps |
| строка|null | getUpdatedAtColumn()
Получить имя столбца "updated at". | из HasTimestamps |
| строка | getQualifiedCreatedAtColumn()
Получить полное квалифицированное имя столбца "created at". | из HasTimestamps |
| строка | getQualifiedUpdatedAtColumn()
Получить полное квалифицированное имя столбца "updated at". | из HasTimestamps |
| массив | getHidden()
Получить скрытые атрибуты модели. | из HidesAttributes |
| $this | setHidden(массив $hidden)
Установить скрытые атрибуты модели. | из HidesAttributes |
| пусто | addHidden(массив|строка|null $attributes = null)
Добавить скрытые атрибуты модели. | из HidesAttributes |
| массив | getVisible()
Получить видимые атрибуты модели. | из HidesAttributes |
| $this | setVisible(массив $visible)
Установить видимые атрибуты модели. | из HidesAttributes |
| пусто | addVisible(массив|строка|null $attributes = null)
Добавить видимые атрибуты модели. | из HidesAttributes |
| $this | makeVisible(массив|строка $attributes)
Сделать заданные, обычно скрытые, атрибуты видимыми. | из HidesAttributes |
| $this | makeHidden(массив|строка $attributes)
Сделать заданные, обычно видимые, атрибуты скрытыми. | из HidesAttributes |
| массив | getFillable()
Получить заполняемые атрибуты модели. | из GuardsAttributes |
| $this | fillable(array $fillable)
Установите атрибуты, которые можно заполнять для модели. | из GuardsAttributes |
| array | getGuarded()
Получить защищенные атрибуты для модели. | из GuardsAttributes |
| $this | guard(array $guarded)
Установить защищенные атрибуты для модели. | из GuardsAttributes |
| static void | unguard(bool $state = true)
Отключить все ограничения массового назначения. | из GuardsAttributes |
| static void | reguard()
Включить ограничения массового назначения. | из GuardsAttributes |
| static bool | isUnguarded()
Определить, является ли текущее состояние "без защиты". | из GuardsAttributes |
| static mixed | unguarded(callable $callback)
Выполнить заданный вызов без защиты. | из GuardsAttributes |
| bool | isFillable(string $key)
Определить, может ли заданный атрибут быть назначен массово. | из GuardsAttributes |
| bool | isGuarded(string $key)
Определить, является ли заданный ключ защищенным. | из GuardsAttributes |
| bool | isGuardableColumn(string $key)
Определить, является ли заданный столбец допустимым, защищаемым столбцом. | из GuardsAttributes |
| bool | totallyGuarded()
Определить, является ли модель полностью защищенной. | из GuardsAttributes |
| array | fillableFromArray(array $attributes)
Получить атрибуты, которые можно заполнять, из заданного массива. | из GuardsAttributes |
| mixed | forwardCallTo(mixed $object, string $method, array $parameters)
Перенаправить вызов метода данному объекту. | из ForwardsCalls |
| static void | throwBadMethodCallException(string $method)
Выбросить исключение неправильного вызова метода для данного метода. | из ForwardsCalls |
| void | __construct(array $attributes = [])
Создать новый экземпляр модели Eloquent. | |
| void | bootIfNotBooted()
Проверить, нужно ли загружать модель, и если нужно, сделать это. | |
| static void | boot()
Метод "загрузки" модели. | |
| static void | bootTraits()
Загрузить все загружаемые трейты в модели. | |
| 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)
Квалифицировать заданное имя столбца по таблице модели. | |
| string | removeTableFromKey(string $key)
Удалить имя таблицы из заданного ключа. | |
| 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 | 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)
Установить ключи для запроса сохранения. | |
| mixed | getKeyForSaveQuery()
Получить значение первичного ключа для запроса сохранения. | |
| bool | performInsert(Builder $query)
Выполнить операцию вставки модели. | |
| void | insertAndSetId(Builder $query, array $attributes)
Вставить указанные атрибуты и установить ID модели. | |
| static int | destroy(Collection|array|int $ids)
Удалить модели по заданным ID. | |
| bool|null | delete()
Удалить модель из базы данных. | |
| bool|null | forceDelete()
Выполнить жесткое удаление мягко удалённой модели. | |
| void | performDeleteOnModel()
Выполнить фактический запрос удаления для данного экземпляра модели. | |
| static Builder | query()
Начать запрос к модели. | |
| Builder | newQuery()
Получить новый объект-билдер запроса для таблицы модели. | |
| Builder|Model | newModelQuery()
Получить новый билдер запроса, не имеющий глобальных скопов или загрузки с жадной загрузкой. | |
| Builder | newQueryWithoutRelationships()
Получить новый билдер запроса без загрузки отношений. | |
| Builder | registerGlobalScopes(Builder $builder)
Зарегистрировать глобальные скопы для данного экземпляра билдера. | |
| Builder|Model | newQueryWithoutScopes()
Получить новый билдер запроса без глобальных скопов. | |
| Builder | newQueryWithoutScope(Scope|string $scope)
Получить новый экземпляр запроса без заданного скопа. | |
| Builder | newQueryForRestoration(array|int $ids)
Получить новый запрос для восстановления одной или нескольких моделей по их очереди ID. | |
| Builder|Model | newEloquentBuilder(Builder $query)
Создать новый билдер запроса Eloquent для модели. | |
| 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()
Перезагрузить текущий экземпляр модели с актуальными атрибутами из базы данных. | |
| Model | replicate(array $except = null)
Создать копию модели в новом, не существующем экземпляре. | |
| bool | is(Model|null $model)
Определить, имеют ли две модели одинаковый ID и относятся ли к одной таблице. | |
| bool | isNot(Model|null $model)
Определить, не являются ли две модели одинаковыми. | |
| Connection | getConnection()
Получить соединение с базой данных для модели. | |
| string|null | getConnectionName()
Получить текущее имя соединения для модели. | |
| $this | setConnection(string|null $name)
Установить соединение, связанное с моделью. | |
| static Connection | resolveConnection(string|null $connection = null)
Разрешить экземпляр соединения. |
| static ConnectionResolverInterface | getConnectionResolver()
Получить экземпляр разрешителя подключений. | |
| static void | setConnectionResolver(ConnectionResolverInterface $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()
Получить значение, указывающее, являются ли идентификаторы инкрементируемыми. | |
| $this | setIncrementing(bool $value)
Установить, являются ли идентификаторы инкрементируемыми. | |
| mixed | getKey()
Получить значение первичного ключа модели. | |
| mixed | getQueueableId()
Получить идентификатор для очереди сущности. | |
| array | getQueueableRelations()
Получить отношения для очереди сущности. | |
| string|null | getQueueableConnection()
Получить подключение для очереди сущности. | |
| mixed | getRouteKey()
Получить значение маршрутного ключа модели. | |
| string | getRouteKeyName()
Получить маршрутный ключ для модели. | |
| Model|null | resolveRouteBinding(mixed $value)
Получить модель по связанному значению. | |
| 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()
Преобразовать модель в строковое представление. | |
| void | __wakeup()
При десериализации модели проверить, требуется ли ее загрузка. |
Подробности
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)
Определить, существует ли мутатор get для атрибута.
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)
Определить, можно ли преобразовать значение в Date / 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)
Зарегистрировать новый глобальный вызов для модели.
static bool hasGlobalScope(Scope|string $scope)
Определить, имеет ли модель глобальный вызов.
static Scope|Closure|null getGlobalScope(Scope|string $scope)
Получить зарегистрированный глобальный вызов модели.
array getGlobalScopes()
Получить глобальные вызовы для этого экземпляра класса.
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)
Инициализировать новое полиморфное отношение один ко многим.
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()
Получить имя отношения многие ко многим.
string joiningTable(string $related, Model|null $instance = null)
Получить имя таблицы соединения для отношения многие ко многим.
string joiningTableSegment()
Получить часть имени промежуточной таблицы для отношений многие ко многим, принадлежащую этому модели.
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)
Установить скрытые атрибуты модели.
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)
Выбросить исключение BadMethodCallException для данного метода.
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 Билдер 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)
Удалить модели для заданных идентификаторов.
bool|null 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(array|int $ids)
Получить новый запрос для восстановления одного или нескольких моделей по их идентификаторам в очереди.
protected Builder newBaseQueryBuilder()
Получить новый экземпляр билдера запроса для соединения.
Collection newCollection(array $models = [])
Создать новый экземпляр Eloquent Collection.
Pivot newPivot(Model $parent, array $attributes, string $table, bool $exists, string|null $using = null)
Создать новый экземпляр модели pivot.
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)
Определить, имеют ли две модели одинаковый идентификатор и принадлежат одной и той же таблице.
bool isNot(Model|null $model)
Определить, не являются ли две модели одинаковыми.
Connection 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()
Получить значение, указывающее, являются ли идентификаторы инкрементными.
$this setIncrementing(bool $value)
Установить, являются ли идентификаторы инкрементными.
mixed getKey()
Получить значение первичного ключа модели.
mixed getQueueableId()
Получить идентификатор очереди для сущности.
array getQueueableRelations()
Получить зависимые отношения для очереди сущности.
string|null getQueueableConnection()
Получить подключение очереди для сущности.
mixed getRouteKey()
Получить значение маршрутного ключа модели.
string getRouteKeyName()
Получить маршрутный ключ для модели.
Модель|null resolveRouteBinding(mixed $value)
Получить модель для связанного значения.
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()
Преобразует модель в строковое представление.
void __wakeup()
При десериализации модели проверяет, нужно ли ее загружать.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/6.x/Illuminate/Database/Eloquent/Model.html