Spec-Zone.ru › Laravel 7

Модель

абстрактный класс Модель реализует 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 массив $classCastCache

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

из HasAttributes
static protected массив $primitiveCastTypes

Встроенные, примитивные типы преобразования, поддерживаемые Eloquent.

из 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
static protected массив $relationResolvers

Обработчики разрешения отношений.

из HasRelationships
bool $timestamps

Указывает, должна ли модель иметь метки времени.

из HasTimestamps
protected массив $hidden

Атрибуты, которые должны быть скрыты при сериализации.

из HidesAttributes
protected массив $visible

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

из HidesAttributes
protected массив $fillable

Атрибуты, которые можно массово назначать.

из GuardsAttributes
protected массив $guarded

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

из GuardsAttributes
static protected bool $unguarded

Указывает, разрешено ли массовое назначение всех атрибутов.

из GuardsAttributes
static protected массив $guardableColumns

Фактические столбцы, существующие в базе данных и которые можно защищать.

из GuardsAttributes
protected string|null $connection

Имя подключения для модели.

protected строка $table

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

protected строка $primaryKey

Первичный ключ модели.

protected строка $keyType

Тип первичного ключа ID.

bool $incrementing

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

protected массив $with

Отношения, которые следует загрузить с помощью eager loading для каждого запроса.

protected массив $withCount

Счётчики отношений, которые следует загрузить с помощью eager loading для каждого запроса.

protected целое $perPage

Количество моделей, возвращаемых для пагинации.

bool $exists

Указывает, существует ли модель.

bool $wasRecentlyCreated

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

static protected ConnectionResolverInterface $resolver

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

static protected Dispatcher $dispatcher

Экземпляр диспетчера событий.

static protected массив $booted

Массив запущенных моделей.

static protected массив $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
пусто 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
пусто 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 timestamp.

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

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

из HasEvents
static void retrieved(Closure|string $callback)

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

из HasEvents
static void saving(Closure|string $callback)

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

из HasEvents
static void saved(Closure|string $callback)

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

из HasEvents
static void updating(Closure|string $callback)

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

из HasEvents
static void updated(Closure|string $callback)

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

из HasEvents
static void creating(Closure|string $callback)

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

из HasEvents
static void created(Closure|string $callback)

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

из HasEvents
static void replicating(Closure|string $callback)

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

из HasEvents
static void deleting(Closure|string $callback)

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

из HasEvents
static void deleted(Closure|string $callback)

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

из HasEvents
static void flushEventListeners()

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

из HasEvents
static Dispatcher getEventDispatcher()

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

из HasEvents
static void setEventDispatcher(Dispatcher $dispatcher)

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

из HasEvents
static void unsetEventDispatcher()

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

из HasEvents
static mixed withoutEvents(callable $callback)

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

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

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

из HasGlobalScopes
static bool hasGlobalScope(Scope|string $scope)

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

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

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

из HasGlobalScopes
array getGlobalScopes()

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

из HasGlobalScopes
static void resolveRelationUsing(string $name, Closure $callback)

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

из HasRelationships
HasOne hasOne(string $related, string|null $foreignKey = null, string|null $localKey = null)

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

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

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

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

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

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

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)

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

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

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

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

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

from HasRelationships
MorphMany morphMany(string $related, string $name, string|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)

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

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.

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

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

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

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

из HasTimestamps
$this setUpdatedAt(mixed $value)

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

из HasTimestamps
Carbon freshTimestamp()

Получить новый timestamp для модели.

из HasTimestamps
string freshTimestampString()

Получить новый timestamp для модели.

из HasTimestamps
bool usesTimestamps()

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

из HasTimestamps
string|null getCreatedAtColumn()

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

из HasTimestamps
string|null getUpdatedAtColumn()

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

из HasTimestamps
string getQualifiedCreatedAtColumn()

Получить полностью квалифицированный столбец "создано в".

из HasTimestamps
string getQualifiedUpdatedAtColumn()

Получить полностью квалифицированный столбец "обновлено в".

из HasTimestamps
array getHidden()

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

из HidesAttributes
$this setHidden(array $hidden)

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

из HidesAttributes
array getVisible()

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

из HidesAttributes
$this setVisible(array $visible)

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

из HidesAttributes
$this makeVisible(array|string|null $attributes)

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

из HidesAttributes
$this makeVisibleIf(bool|Closure $condition, array|string|null $attributes)

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

из HidesAttributes
$this makeHidden(array|string|null $attributes)

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

из HidesAttributes
$this makeHiddenIf(bool|Closure $condition, array|string|null $attributes)

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

из HidesAttributes
array getFillable()

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

из GuardsAttributes
$this fillable(array $fillable)

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

из GuardsAttributes
$this mergeFillable(array $fillable)

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

из GuardsAttributes
array getGuarded()

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

из GuardsAttributes
$this guard(array $guarded)

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

из GuardsAttributes
$this mergeGuarded(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)

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

from GuardsAttributes
mixed forwardCallTo(mixed $object, string $method, array $parameters)

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

from ForwardsCalls
static void throwBadMethodCallException(string $method)

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

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

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

void bootIfNotBooted()

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

static void booting()

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

static void boot()

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

static void bootTraits()

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

void initializeTraits()

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

static void booted()

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

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

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

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

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

bool|null delete()

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

bool|null forceDelete()

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

void performDeleteOnModel()

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

static Builder query()

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

Builder newQuery()

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

Builder|Model newModelQuery()

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

Builder newQueryWithoutRelationships()

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

Builder registerGlobalScopes(Builder $builder)

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

Builder|Model newQueryWithoutScopes()

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

Builder newQueryWithoutScope(Scope|string $scope)

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

Builder newQueryForRestoration(array|int $ids)

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

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)

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

bool hasNamedScope(string $scope)

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

mixed callNamedScope(string $scope, array $parameters = [])

Применить заданный именованный scope, если это возможно.

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 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|null $field = null)

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

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

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

Подробности

array attributesToArray()

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

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

array

protected array addDateAttributesToArray(array $attributes)

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

Параметры

array $attributes

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

array

protected array addMutatedAttributesToArray(array $attributes, array $mutatedAttributes)

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

Параметры

array $attributes
array $mutatedAttributes

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

array

protected array addCastAttributesToArray(array $attributes, array $mutatedAttributes)

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

Параметры

array $attributes
array $mutatedAttributes

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

array

protected array getArrayableAttributes()

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

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

array

protected array getArrayableAppends()

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

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

array

array relationsToArray()

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

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

array

protected array getArrayableRelations()

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

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

array

protected array getArrayableItems(array $values)

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

Параметры

array $values

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

array

mixed getAttribute(string $key)

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

Параметры

string $key

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

mixed

mixed getAttributeValue(string $key)

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

Параметры

string $key

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

mixed
END_OF_DOCUMENT_MARKER

protected mixed getAttributeFromArray(string $key)

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

Параметры

string $key

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

mixed

mixed getRelationValue(string $key)

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

Параметры

string $key

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

mixed

protected mixed getRelationshipFromMethod(string $method)

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

Параметры

string $method

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

mixed

Исключения

LogicException

bool hasGetMutator(string $key)

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

Параметры

string $key

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

bool

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

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

Параметры

string $key
mixed $value

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

mixed

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

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

Параметры

string $key
mixed $value

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

mixed

void mergeCasts(array $casts)

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

Параметры

array $casts

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

void

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

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

Параметры

string $key
mixed $value

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

mixed

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

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

Параметры

string $key
mixed $value

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

mixed

protected string getCastType(string $key)

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

Параметры

string $key

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

string

protected bool isCustomDateTimeCast(string $cast)

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

Параметры

string $cast

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

bool

protected bool isDecimalCast(string $cast)

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

Параметры

string $cast

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

bool

mixed setAttribute(string $key, mixed $value)

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

Параметры

string $key
mixed $value

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

mixed

bool hasSetMutator(string $key)

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

Параметры

string $key

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

bool

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

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

Параметры

string $key
mixed $value

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

mixed

protected bool isDateAttribute(string $key)

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

Параметры

string $key

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

bool

$this fillJsonAttribute(string $key, mixed $value)

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

Параметры

string $key
mixed $value

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

$this

protected void setClassCastableAttribute(string $key, mixed $value)

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

Параметры

string $key
mixed $value

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

void

protected $this getArrayAttributeWithValue(string $path, string $key, mixed $value)

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

Параметры

string $path
string $key
mixed $value

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

$this

protected array getArrayAttributeByKey(string $key)

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

Параметры

string $key

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

array

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

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

Параметры

string $key
mixed $value

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

string

protected string asJson(mixed $value)

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

Параметры

mixed $value

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

string

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

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

Параметры

string $value
bool $asObject

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

mixed

mixed fromFloat(mixed $value)

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

Параметры

mixed $value

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

mixed

protected string asDecimal(float $value, int $decimals)

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

Параметры

float $value
int $decimals

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

string

protected Carbon asDate(mixed $value)

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

Параметры

mixed $value

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

Carbon

protected Carbon asDateTime(mixed $value)

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

Параметры

mixed $value

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

Carbon

protected bool isStandardDateFormat(string $value)

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

Параметры

string $value

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

bool

string|null fromDateTime(mixed $value)

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

Параметры

mixed $value

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

string|null

protected int asTimestamp(mixed $value)

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

Параметры

mixed $value

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

int

protected string serializeDate(DateTimeInterface $date)

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

Параметры

DateTimeInterface $date

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

string

array getDates()

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

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

array

string getDateFormat()

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

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

string

$this setDateFormat(string $format)

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

Параметры

string $format

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

$this

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

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

Параметры

string $key
array|string|null $types

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

bool

array getCasts()

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

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

array

protected bool isDateCastable(string $key)

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

Параметры

string $key

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

bool

protected bool isJsonCastable(string $key)

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

Параметры

string $key

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

bool

protected bool isClassCastable(string $key)

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

Параметры

string $key

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

bool

protected mixed resolveCasterClass(string $key)

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

Параметры

string $key

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

mixed

protected string parseCasterClass(string $class)

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

Параметры

string $class

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

string

protected void mergeAttributesFromClassCasts()

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

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

void

protected array normalizeCastClassResponse(string $key, mixed $value)

Нормализовать ответ от пользовательского преобразователя класса.

Параметры

string $key
mixed $value

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

array

массив getAttributes()

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

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

массив

$this setRawAttributes(массив $attributes, bool $sync = false)

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

Параметры

массив $attributes
bool $sync

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

$this

смешанный|массив getOriginal(строка|null $key = null, смешанный $default = null)

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

Параметры

строка|null $key
смешанный $default

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

смешанный|массив

protected смешанный|массив getOriginalWithoutRewindingModel(строка|null $key = null, смешанный $default = null)

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

Параметры

строка|null $key
смешанный $default

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

смешанный|массив

смешанный|массив getRawOriginal(строка|null $key = null, смешанный $default = null)

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

Параметры

строка|null $key
смешанный $default

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

смешанный|массив

массив only(массив|смешанный $attributes)

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

Параметры

массив|смешанный $attributes

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

массив

$this syncOriginal()

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

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

$this

$this syncOriginalAttribute(строка $attribute)

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

Параметры

строка $attribute

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

$this

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

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

Параметры

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

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

$this

$this syncChanges()

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

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

$this

bool isDirty(массив|строка|null $attributes = null)

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

Параметры

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

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

bool

bool isClean(массив|строка|null $attributes = null)

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

Параметры

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

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

bool

bool wasChanged(массив|строка|null $attributes = null)

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

Параметры

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

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

bool

protected bool hasChanges(массив $changes, массив|строка|null $attributes = null)

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

Параметры

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

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

bool

массив getDirty()

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

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

массив

массив getChanges()

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

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

массив

bool originalIsEquivalent(строка $key)

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

Параметры

строка $key

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

bool

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

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

Параметры

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

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

смешанный

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

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

Параметры

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

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

$this

$this setAppends(массив $appends)

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

Параметры

массив $appends

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

$this

bool hasAppended(строка $attribute)

Возвращает, был ли атрибут аксессора добавлен.

Параметры

строка $attribute

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

bool

массив getMutatedAttributes()

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

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

массив

static void cacheMutatedAttributes(строка $class)

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

Параметры

строка $class

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

void

static protected array getMutatorMethods(mixed $class)

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

Parameters

mixed $class

Return Value

array

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

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

Parameters

object|array|string $classes

Return Value

void

Exceptions

RuntimeException

protected void registerObserver(object|string $class)

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

Parameters

object|string $class

Return Value

void

Exceptions

RuntimeException

array getObservableEvents()

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

Return Value

array

$this setObservableEvents(array $observables)

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

Parameters

array $observables

Return Value

$this

void addObservableEvents(array|mixed $observables)

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

Parameters

array|mixed $observables

Return Value

void

void removeObservableEvents(array|mixed $observables)

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

Parameters

array|mixed $observables

Return Value

void

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

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

Parameters

string $event
Closure|string $callback

Return Value

void

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

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

Parameters

string $event
bool $halt

Return Value

mixed

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

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

Parameters

string $event
string $method

Return Value

mixed|null

protected mixed filterModelEventResults(mixed $result)

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

Parameters

mixed $result

Return Value

mixed

static void retrieved(Closure|string $callback)

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

Parameters

Closure|string $callback

Return Value

void

static void saving(Closure|string $callback)

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

Parameters

Closure|string $callback

Return Value

void

static void saved(Closure|string $callback)

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

Parameters

Closure|string $callback

Return Value

void

static void updating(Closure|string $callback)

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

Parameters

Closure|string $callback

Return Value

void

static void updated(Closure|string $callback)

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

Parameters

Closure|string $callback

Return Value

void

static void creating(Closure|string $callback)

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

Parameters

Closure|string $callback

Return Value

void

static void created(Closure|string $callback)

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

Parameters

Closure|string $callback

Return Value

void

static void replicating(Closure|string $callback)

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

Parameters

Closure|string $callback

Return Value

void
END_OF_DOCUMENT_MARKER

static void deleting(Closure|string $callback)

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

Parameters

Closure|string $callback

Return Value

void

static void deleted(Closure|string $callback)

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

Parameters

Closure|string $callback

Return Value

void

static void flushEventListeners()

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

Return Value

void

static Dispatcher getEventDispatcher()

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

Return Value

Dispatcher

static void setEventDispatcher(Dispatcher $dispatcher)

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

Parameters

Dispatcher $dispatcher

Return Value

void

static void unsetEventDispatcher()

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

Return Value

void

static mixed withoutEvents(callable $callback)

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

Parameters

callable $callback

Return Value

mixed

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

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

Parameters

Scope|Closure|string $scope
Closure $implementation

Return Value

mixed

Exceptions

InvalidArgumentException

static bool hasGlobalScope(Scope|string $scope)

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

Parameters

Scope|string $scope

Return Value

bool

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

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

Parameters

Scope|string $scope

Return Value

Scope|Closure|null

array getGlobalScopes()

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

Return Value

array

static void resolveRelationUsing(string $name, Closure $callback)

Определить решатель динамических отношений.

Parameters

string $name
Closure $callback

Return Value

void

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

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

Parameters

string $related
string|null $foreignKey
string|null $localKey

Return Value

HasOne

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

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

Parameters

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

Return Value

HasOne

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.

Parameters

string $related
string $through
string|null $firstKey
string|null $secondKey
string|null $localKey
string|null $secondLocalKey

Return Value

HasOneThrough
END_OF_DOCUMENT_MARKER

protected HasOneThrough newHasOneThrough(Builder $query, Model $farParent, Model $throughParent, string $firstKey, string $secondKey, string $localKey, string $secondLocalKey)

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

Параметры

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)

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

Параметры

string $related
string $name
string|null $type
string|null $id
string|null $localKey

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

MorphOne

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

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

Параметры

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

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

MorphOne

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

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

Параметры

string $related
string|null $foreignKey
string|null $ownerKey
string|null $relation

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

BelongsTo

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

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

Параметры

Builder $query
Model $child
string $foreignKey
string $ownerKey
string $relation

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

BelongsTo

MorphTo morphTo(string|null $name = null, string|null $type = null, string|null $id = null, string|null $ownerKey = null)

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

Параметры

string|null $name
string|null $type
string|null $id
string|null $ownerKey

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

MorphTo

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

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

Параметры

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

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

MorphTo

protected MorphTo morphInstanceTo(string $target, string $name, string $type, string $id, string $ownerKey)

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

Параметры

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

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

MorphTo

protected MorphTo newMorphTo(Builder $query, Model $parent, string $foreignKey, string $ownerKey, string $type, string $relation)

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

Параметры

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

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

MorphTo

static string getActualClassNameForMorph(string $class)

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

Параметры

string $class

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

string

protected string guessBelongsToRelation()

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

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

string

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

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

Параметры

string $related
string|null $foreignKey
string|null $localKey

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

HasMany

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

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

Параметры

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

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

HasMany

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

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

Параметры

string $related
string $through
string|null $firstKey
string|null $secondKey
string|null $localKey
string|null $secondLocalKey

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

HasManyThrough

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

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

Параметры

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

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

HasManyThrough

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

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

Параметры

string $related
string $name
string|null $type
string|null $id
string|null $localKey

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

MorphMany

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

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

Параметры

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

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

MorphMany

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

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

Параметры

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

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

BelongsToMany

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

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

Параметры

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

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

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)

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

Параметры

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

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

MorphToMany

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.

Параметры

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

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

MorphToMany

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)

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

Параметры

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

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

MorphToMany

protected string|null guessBelongsToManyRelation()

Получить имя связи belongsToMany.

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

string|null

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

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

Параметры

string $related
Model|null $instance

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

string

string joiningTableSegment()

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

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

string

bool touches(string $relation)

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

Параметры

string $relation

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

bool

void touchOwners()

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

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

void

protected array getMorphs(string $name, string $type, string $id)

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

Параметры

string $name
string $type
string $id

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

array

string getMorphClass()

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

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

string

protected mixed newRelatedInstance(string $class)

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

Параметры

string $class

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

mixed

array getRelations()

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

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

array

mixed getRelation(string $relation)

Получить указанную связь.

Параметры

string $relation

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

mixed

bool relationLoaded(string $key)

Определить, загружена ли данная связь.

Параметры

string $key

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

bool

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

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

Параметры

string $relation
mixed $value

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

$this

$this unsetRelation(string $relation)

Удалить загруженную связь.

Параметры

string $relation

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

$this

$this setRelations(array $relations)

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

Параметры

array $relations

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

$this

$this withoutRelations()

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

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

$this

$this unsetRelations()

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

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

$this

array getTouchedRelations()

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

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

array

$this setTouchedRelations(array $touches)

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

Параметры

array $touches

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

$this

bool touch()

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

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

bool

protected void updateTimestamps()

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

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

void

$this setCreatedAt(mixed $value)

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

Параметры

mixed $value

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

$this

$this setUpdatedAt(mixed $value)

Установить значение атрибута «обновлено в».

Параметры

mixed $value

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

$this

Carbon freshTimestamp()

Получить свежую отметку времени для модели.

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

Carbon

string freshTimestampString()

Получить свежую отметку времени для модели.

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

string

bool usesTimestamps()

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

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

bool

string|null getCreatedAtColumn()

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

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

string|null

string|null getUpdatedAtColumn()

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

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

string|null

string getQualifiedCreatedAtColumn()

Получить полностью квалифицированный столбец «создано в».

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

string

string getQualifiedUpdatedAtColumn()

Получить полностью квалифицированный столбец «обновлено в».

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

string

array getHidden()

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

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

array

$this setHidden(array $hidden)

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

Параметры

array $hidden

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

$this

array getVisible()

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

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

array

$this setVisible(array $visible)

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

Параметры

array $visible

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

$this

$this makeVisible(array|string|null $attributes)

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

Параметры

array|string|null $attributes

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

$this

$this makeVisibleIf(bool|Closure $condition, array|string|null $attributes)

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

Параметры

bool|Closure $condition
array|string|null $attributes

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

$this

$this makeHidden(array|string|null $attributes)

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

Параметры

array|string|null $attributes

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

$this

$this makeHiddenIf(bool|Closure $condition, array|string|null $attributes)

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

Параметры

bool|Closure $condition
array|string|null $attributes

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

$this

array getFillable()

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

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

array

$this fillable(array $fillable)

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

Параметры

array $fillable

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

$this

$this mergeFillable(array $fillable)

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

Параметры

array $fillable

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

$this

array getGuarded()

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

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

array

$this guard(array $guarded)

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

Параметры

array $guarded

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

$this

$this mergeGuarded(array $guarded)

Объединить новые защищённые атрибуты с существующими защищёнными атрибутами модели.

Параметры

array $guarded

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

$this

static void unguard(bool $state = true)

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

Параметры

bool $state

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

void

static void reguard()

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

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

void

static bool isUnguarded()

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

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

bool

static mixed unguarded(callable $callback)

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

Параметры

callable $callback

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

mixed

bool isFillable(string $key)

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

Параметры

string $key

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

bool

bool isGuarded(string $key)

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

Параметры

string $key

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

bool

protected bool isGuardableColumn(string $key)

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

Параметры

string $key

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

bool

bool totallyGuarded()

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

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

bool

protected array fillableFromArray(array $attributes)

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

Параметры

array $attributes

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

array

protected mixed forwardCallTo(mixed $object, string $method, array $parameters)

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

Параметры

mixed $object
string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

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

Параметры

string $method

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

void

Исключения

BadMethodCallException

void __construct(array $attributes = [])

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

Параметры

array $attributes

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

void

protected void bootIfNotBooted()

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

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

void

static protected void booting()

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

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

void

static protected void boot()

Настроить модель и ее трейты.

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

void

static protected void bootTraits()

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

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

void

protected void initializeTraits()

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

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

void

static protected void booted()

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

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

void

static void clearBootedModels()

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

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

void

static void withoutTouching(callable $callback)

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

Параметры

callable $callback

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

void

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

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

Параметры

array $models
callable $callback

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

void

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

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

Параметры

string|null $class

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

bool

$this fill(array $attributes)

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

Параметры

array $attributes

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

$this

Исключения

MassAssignmentException

$this forceFill(array $attributes)

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

Параметры

массив $attributes

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

$this

string qualifyColumn(string $column)

Квалифицировать заданное имя столбца по таблице модели.

Параметры

строка $column

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

строка

protected string removeTableFromKey(string $key) устаревший

устаревший

Этот метод устарел и будет удален в будущей версии Laravel.

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

Параметры

строка $key

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

строка

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

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

Параметры

массив $attributes
bool $exists

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

Модель

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

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

Параметры

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

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

Модель

static Библиотека on(string|null $connection = null)

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

Параметры

строка|null $connection

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

Библиотека

static Библиотека onWriteConnection()

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

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

Библиотека

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

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

Параметры

массив|смешанный $columns

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

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

static Библиотека with(array|string $relations)

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

Параметры

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

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

Библиотека

$this load(array|string $relations)

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

Параметры

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

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

$this

$this loadMorph(string $relation, array $relations)

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

Параметры

строка $relation
массив $relations

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

$this

$this loadMissing(array|string $relations)

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

Параметры

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

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

$this

$this loadCount(array|string $relations)

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

Параметры

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

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

$this

$this loadMorphCount(string $relation, array $relations)

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

Параметры

строка $relation
массив $relations

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

$this

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

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

Параметры

строка $column
float|int $amount
массив $extra

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

int

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

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

Параметры

строка $column
float|int $amount
массив $extra

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

int

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

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

Параметры

строка $column
float|int $amount
массив $extra
строка $method

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

int

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

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

Параметры

строка $column
float|int $amount
массив $extra
строка $method

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

void

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

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

Параметры

array $attributes
array $options

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

bool

bool push()

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

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

bool

bool save(array $options = [])

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

Параметры

array $options

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

bool

bool saveOrFail(array $options = [])

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

Параметры

array $options

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

bool

Исключения

Throwable

protected void finishSave(array $options)

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

Параметры

array $options

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

void

protected bool performUpdate(Builder $query)

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

Параметры

Builder $query

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

bool

protected Builder setKeysForSaveQuery(Builder $query)

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

Параметры

Builder $query

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

Builder

protected mixed getKeyForSaveQuery()

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

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

mixed

protected bool performInsert(Builder $query)

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

Параметры

Builder $query

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

bool

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

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

Параметры

Builder $query
array $attributes

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

void

static int destroy(Collection|array|int|string $ids)

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

Параметры

Collection|array|int|string $ids

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

int

bool|null delete()

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

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

bool|null

Исключения

Exception

bool|null forceDelete()

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

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

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

bool|null

protected void performDeleteOnModel()

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

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

void

static Builder query()

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

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

Builder

Builder newQuery()

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

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

Builder

Builder|Model newModelQuery()

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

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

Builder|Model

Builder newQueryWithoutRelationships()

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

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

Builder

Builder registerGlobalScopes(Builder $builder)

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

Параметры

Builder $builder

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

Builder

Builder|Model newQueryWithoutScopes()

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

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

Builder|Model

Builder newQueryWithoutScope(Scope|string $scope)

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

Parameters

Scope|string $scope

Return Value

Builder

Builder newQueryForRestoration(array|int $ids)

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

Parameters

array|int $ids

Return Value

Builder

Builder|Model newEloquentBuilder(Builder $query)

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

Parameters

Builder $query

Return Value

Builder|Model

protected Builder newBaseQueryBuilder()

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

Return Value

Builder

Collection newCollection(array $models = [])

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

Parameters

array $models

Return Value

Collection

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

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

Parameters

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

Return Value

Pivot

bool hasNamedScope(string $scope)

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

Parameters

string $scope

Return Value

bool

mixed callNamedScope(string $scope, array $parameters = [])

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

Parameters

string $scope
array $parameters

Return Value

mixed

array toArray()

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

Return Value

array

string toJson(int $options = 0)

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

Parameters

int $options

Return Value

string

Exceptions

JsonEncodingException

array jsonSerialize()

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

Return Value

array

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

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

Parameters

array|string $with

Return Value

Model|null

$this refresh()

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

Return Value

$this

Model replicate(array $except = null)

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

Parameters

array $except

Return Value

Model

bool is(Model|null $model)

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

Parameters

Model|null $model

Return Value

bool

bool isNot(Model|null $model)

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

Parameters

Model|null $model

Return Value

bool

Connection getConnection()

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

Return Value

Connection

string|null getConnectionName()

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

Return Value

string|null

$this setConnection(string|null $name)

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

Parameters

string|null $name

Return Value

$this

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

Разрешить подключение к базе данных.

Параметры

string|null $connection

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

Подключение

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

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

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

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

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

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

Параметры

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

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

void

static void unsetConnectionResolver()

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

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

void

string getTable()

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

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

string

$this setTable(string $table)

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

Параметры

string $table

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

$this

string getKeyName()

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

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

string

$this setKeyName(string $key)

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

Параметры

string $key

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

$this

string getQualifiedKeyName()

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

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

string

string getKeyType()

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

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

string

$this setKeyType(string $type)

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

Параметры

string $type

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

$this

bool getIncrementing()

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

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

bool

$this setIncrementing(bool $value)

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

Параметры

bool $value

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

$this

mixed getKey()

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

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

mixed

mixed getQueueableId()

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

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

mixed

array getQueueableRelations()

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

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

array

string|null getQueueableConnection()

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

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

string|null

mixed getRouteKey()

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

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

mixed

string getRouteKeyName()

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

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

string

Модель|null resolveRouteBinding(mixed $value, string|null $field = null)

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

Параметры

mixed $value
string|null $field

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

Модель|null

Модель|null resolveChildRouteBinding(string $childType, mixed $value, string|null $field)

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

Параметры

string $childType
mixed $value
string|null $field

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

Модель|null

string getForeignKey()

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

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

string

int getPerPage()

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

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

int

$this setPerPage(int $perPage)

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

Параметры

int $perPage

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

$this

mixed __get(string $key)

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

Параметры

string $key

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

mixed

void __set(string $key, mixed $value)

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

Параметры

string $key
mixed $value

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

void

bool offsetExists(mixed $offset)

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

Параметры

mixed $offset

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

bool

mixed offsetGet(mixed $offset)

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

Параметры

mixed $offset

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

mixed

void offsetSet(mixed $offset, mixed $value)

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

Параметры

mixed $offset
mixed $value

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

void

void offsetUnset(mixed $offset)

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

Параметры

mixed $offset

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

void

bool __isset(string $key)

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

Параметры

string $key

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

bool

void __unset(string $key)

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

Параметры

string $key

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

void

mixed __call(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

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

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

Параметры

string $method
array $parameters

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

mixed

string __toString()

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

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

string

array __sleep()

Подготавливает объект к сериализации.

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

array

void __wakeup()

При десериализации модели проверяется, требуется ли её загрузка.

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

void

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

Spec-Zone.ru

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