Spec-Zone.ru › Laravel 5.8

Модель

абстрактный класс Модель реализует ArrayAccess, Arrayable, 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 логическое значение $snakeAttributes Указывает, преобразуются ли атрибуты в змеиный регистр в массивах. из HasAttributes
static protected массив $mutatorCache Кэш изменённых атрибутов для каждого класса. из HasAttributes
protected массив $dispatchesEvents Карта событий для модели. из HasEvents
protected массив $observables Экспонированные пользователем наблюдаемые события. из HasEvents
protected массив $relations Загруженные отношения модели. из HasRelationships
protected массив $touches Отношения, которые должны быть изменены при сохранении. из HasRelationships
static массив $manyMethods Методы для многих-ко-многим отношений. из HasRelationships
логическое значение $timestamps Указывает, нужно ли добавлять метки времени к модели. из HasTimestamps
protected массив $hidden Атрибуты, которые нужно скрыть при сериализации. из HidesAttributes
protected массив $visible Атрибуты, которые должны быть видны при сериализации. из HidesAttributes
protected массив $fillable Атрибуты, которые могут быть присвоены массивным способом. из GuardsAttributes
protected массив $guarded Атрибуты, которые не могут быть присвоены массивным способом. из GuardsAttributes
static protected логическое значение $unguarded Указывает, разрешено ли присвоение всех атрибутов массивом. из GuardsAttributes
protected строка|null $connection Имя подключения для модели.
protected строка $table Таблица, связанная с моделью.
protected строка $primaryKey Первичный ключ для модели.
protected строка $keyType Тип первичного ключа ID.
логическое значение $incrementing Указывает, являются ли идентификаторы автоинкрементируемыми.
protected массив $with Отношения для ленивой загрузки при каждом запросе.
protected массив $withCount Счётчики отношений, которые следует лениво загрузить при каждом запросе.
protected целое число $perPage Количество моделей, возвращаемых для постраничной навигации.
логическое значение $exists Указывает, существует ли модель.
логическое значение $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(array $attributes)

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

из HasAttributes
массив addMutatedAttributesToArray(array $attributes, array $mutatedAttributes)

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

из HasAttributes
массив addCastAttributesToArray(array $attributes, array $mutatedAttributes)

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

из HasAttributes
массив getArrayableAttributes()

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

из HasAttributes
массив getArrayableAppends()

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

из HasAttributes
массив relationsToArray()

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

из HasAttributes
массив getArrayableRelations()

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

из HasAttributes
массив getArrayableItems(array $values)

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

из HasAttributes
смешанный тип getAttribute(string $key)

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

из HasAttributes
смешанный тип getAttributeValue(string $key)

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

из HasAttributes
смешанный тип getAttributeFromArray(string $key)

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

из HasAttributes
смешанный тип getRelationValue(string $key)

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

из HasAttributes
смешанный тип getRelationshipFromMethod(string $method)

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

из HasAttributes
логическое значение hasGetMutator(string $key)

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

из HasAttributes
смешанный тип mutateAttribute(string $key, mixed $value)

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

из HasAttributes
смешанный тип mutateAttributeForArray(string $key, mixed $value)

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

из HasAttributes
смешанный тип castAttribute(string $key, mixed $value)

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

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

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

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

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

из HasAttributes
логическое значение isDecimalCast(string $cast)

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

из HasAttributes
смешанный тип setAttribute(string $key, mixed $value)

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

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

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

из HasAttributes
смешанный тип setMutatedAttributeValue(string $key, mixed $value)

Установить значение атрибута с помощью его мутатора.

из HasAttributes
логическое значение isDateAttribute(string $key)

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

из HasAttributes
$this fillJsonAttribute(string $key, mixed $value)

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

из HasAttributes
$this getArrayAttributeWithValue(string $path, string $key, mixed $value)

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

из HasAttributes
массив getArrayAttributeByKey(string $key)

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

из HasAttributes
string castAttributeAsJson(string $key, mixed $value)

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

from HasAttributes
string asJson(mixed $value)

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

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

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

from HasAttributes
mixed fromFloat(mixed $value)

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

from HasAttributes
string asDecimal(float $value, int $decimals)

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

from HasAttributes
Carbon asDate(mixed $value)

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

from HasAttributes
Carbon asDateTime(mixed $value)

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

from HasAttributes
bool isStandardDateFormat(string $value)

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

from HasAttributes
string|null fromDateTime(mixed $value)

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

from HasAttributes
int asTimestamp(mixed $value)

Возвратить метку времени как unix timestamp.

from HasAttributes
string serializeDate(DateTimeInterface $date)

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

from HasAttributes
array getDates()

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

from HasAttributes
string getDateFormat()

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

from HasAttributes
$this setDateFormat(string $format)

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

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

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

from HasAttributes
array getCasts()

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

from HasAttributes
bool isDateCastable(string $key)

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

from HasAttributes
bool isJsonCastable(string $key)

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

from HasAttributes
array getAttributes()

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

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

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

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

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

from HasAttributes
array only(array|mixed $attributes)

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

from HasAttributes
$this syncOriginal()

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

from HasAttributes
$this syncOriginalAttribute(string $attribute)

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

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

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

from HasAttributes
$this syncChanges()

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

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

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

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

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

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

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

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

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

from HasAttributes
array getDirty()

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

from HasAttributes
array getChanges()

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

from HasAttributes
bool originalIsEquivalent(string $key, mixed $current)

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

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

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

from HasAttributes
$this setAppends(array $appends)

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

from HasAttributes
array getMutatedAttributes()

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

from HasAttributes
static void cacheMutatedAttributes(string $class)

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

from HasAttributes
static array getMutatorMethods(mixed $class)

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

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

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

from HasEvents
void registerObserver(object|string $class)

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

from HasEvents
array getObservableEvents()

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

from HasEvents
$this setObservableEvents(array $observables)

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

from HasEvents
void addObservableEvents(array|mixed $observables)

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

from HasEvents
void removeObservableEvents(array|mixed $observables)

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

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

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

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

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

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

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

from HasEvents
mixed filterModelEventResults(mixed $result)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

from 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
HasOne hasOne(string $related, string $foreignKey = null, string $localKey = null)

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

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

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

из HasRelationships
HasOneThrough hasOneThrough(string $related, string $through, string|null $firstKey = null, string|null $secondKey = null, string|null $localKey = null, string|null $secondLocalKey = null)

Определить отношение «один-через-один».

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

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

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

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

из HasRelationships
MorphOne newMorphOne(Builder $query, Model $parent, string $type, string $id, string $localKey)

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

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

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

из HasRelationships
BelongsTo newBelongsTo(Builder $query, Model $child, string $foreignKey, string $ownerKey, string $relation)

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

из HasRelationships
MorphTo morphTo(string $name = null, string $type = null, string $id = null, string $ownerKey = null)

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

из HasRelationships
MorphTo morphEagerTo(string $name, string $type, string $id, string $ownerKey)

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

из HasRelationships
MorphTo morphInstanceTo(string $target, string $name, string $type, string $id, string $ownerKey)

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

из HasRelationships
MorphTo newMorphTo(Builder $query, Model $parent, string $foreignKey, string $ownerKey, string $type, string $relation)

Создать новые отношения MorphTo.

из HasRelationships
static string getActualClassNameForMorph(string $class)

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

из HasRelationships
string guessBelongsToRelation()

Угадать имя отношения "принадлежит к".

из HasRelationships
HasMany hasMany(string $related, string $foreignKey = null, string $localKey = null)

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

из HasRelationships
HasMany newHasMany(Builder $query, Model $parent, string $foreignKey, string $localKey)

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

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

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

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

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

из HasRelationships
MorphMany morphMany(string $related, string $name, string $type = null, string $id = null, string $localKey = null)

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

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

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

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

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

из HasRelationships
BelongsToMany newBelongsToMany(Builder $query, Model $parent, string $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string $relationName = null)

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

из HasRelationships
MorphToMany morphToMany(string $related, string $name, string $table = null, string $foreignPivotKey = null, string $relatedPivotKey = null, string $parentKey = null, string $relatedKey = null, bool $inverse = false)

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

из HasRelationships
MorphToMany newMorphToMany(Builder $query, Model $parent, string $name, string $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string $relationName = null, bool $inverse = false)

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

из HasRelationships
MorphToMany morphedByMany(string $related, string $name, string $table = null, string $foreignPivotKey = null, string $relatedPivotKey = null, string $parentKey = null, string $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()

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

from HasRelationships
mixed newRelatedInstance(string $class)

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

from HasRelationships
array getRelations()

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

from HasRelationships
mixed getRelation(string $relation)

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

from HasRelationships
bool relationLoaded(string $key)

Определить, загружено ли данное отношение.

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

Установить данное отношение в модели.

from HasRelationships
$this unsetRelation(string $relation)

Удалить загруженное отношение.

from HasRelationships
$this setRelations(array $relations)

Установить весь массив отношений в модели.

from HasRelationships
array getTouchedRelations()

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

from HasRelationships
$this setTouchedRelations(array $touches)

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

from HasRelationships
bool touch()

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

from HasTimestamps
void updateTimestamps()

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

from HasTimestamps
$this setCreatedAt(mixed $value)

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

from HasTimestamps
$this setUpdatedAt(mixed $value)

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

from HasTimestamps
Carbon freshTimestamp()

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

from HasTimestamps
string freshTimestampString()

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

from HasTimestamps
bool usesTimestamps()

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

from HasTimestamps
string getCreatedAtColumn()

Получить имя колонки "created at".

from HasTimestamps
string getUpdatedAtColumn()

Получить имя колонки "updated at".

from HasTimestamps
array getHidden()

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

from HidesAttributes
$this setHidden(array $hidden)

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

from HidesAttributes
void addHidden(array|string|null $attributes = null)

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

from HidesAttributes
array getVisible()

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

from HidesAttributes
$this setVisible(array $visible)

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

from HidesAttributes
void addVisible(array|string|null $attributes = null)

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

from HidesAttributes
$this makeVisible(array|string $attributes)

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

from HidesAttributes
$this makeHidden(array|string $attributes)

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

from HidesAttributes
array getFillable()

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

from GuardsAttributes
$this fillable(array $fillable)

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

from GuardsAttributes
array getGuarded()

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

from GuardsAttributes
$this guard(array $guarded)

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

from GuardsAttributes
static void unguard(bool $state = true)

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

from GuardsAttributes
static void reguard()

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

from GuardsAttributes
static bool isUnguarded()

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

from GuardsAttributes
static mixed unguarded(callable $callback)

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

from GuardsAttributes
bool isFillable(string $key)

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

from GuardsAttributes
bool isGuarded(string $key)

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

from GuardsAttributes
bool totallyGuarded()

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

from GuardsAttributes
array fillableFromArray(array $attributes)

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

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

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

from ForwardsCalls
static void throwBadMethodCallException(string $method)

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

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

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

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

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

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)

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

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.

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

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

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

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
END_OF_DOCUMENT_MARKER

mixed getAttribute(string $key)

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

Параметры

string $key

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

mixed

mixed getAttributeValue(string $key)

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

Параметры

string $key

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

mixed

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

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

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

Параметры

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

array getAttributes()

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

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

array

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

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

Параметры

array $attributes
bool $sync

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

$this

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

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

Параметры

string|null $key
mixed $default

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

mixed|array

array only(array|mixed $attributes)

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

Параметры

array|mixed $attributes

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

array

$this syncOriginal()

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

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

$this

$this syncOriginalAttribute(string $attribute)

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

Параметры

string $attribute

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

$this

$this syncOriginalAttributes(array|string $attributes)

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

Параметры

array|string $attributes

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

$this

$this syncChanges()

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

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

$this

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

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

Параметры

array|string|null $attributes

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

bool

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

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

Параметры

array|string|null $attributes

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

bool

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

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

Параметры

array|string|null $attributes

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

bool

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

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

Параметры

array $changes
array|string|null $attributes

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

bool

array getDirty()

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

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

array

array getChanges()

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

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

array

bool originalIsEquivalent(string $key, mixed $current)

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

Параметры

string $key
mixed $current

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

bool

$this append(array|string $attributes)

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

Параметры

array|string $attributes

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

$this

$this setAppends(array $appends)

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

Параметры

array $appends

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

$this

array getMutatedAttributes()

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

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

array

static void cacheMutatedAttributes(string $class)

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

Параметры

string $class

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

void

static protected array getMutatorMethods(mixed $class)

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

Параметры

mixed $class

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

array

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

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

Параметры

object|array|string $classes

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

void

Исключения

RuntimeException

protected void registerObserver(object|string $class)

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

Параметры

object|string $class

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

void

Исключения

RuntimeException

array getObservableEvents()

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

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

array

$this setObservableEvents(array $observables)

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

Параметры

array $observables

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

$this

void addObservableEvents(array|mixed $observables)

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

Параметры

array|mixed $observables

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

void

void removeObservableEvents(array|mixed $observables)

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

Параметры

array|mixed $observables

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

void

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

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

Параметры

string $event
Closure|string $callback

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

void

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

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

Параметры

string $event
bool $halt

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

mixed

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

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

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

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)

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

Parameters

Scope|Closure|string $scope
Closure $implementation

Return Value

mixed

Exceptions

InvalidArgumentException

static bool hasGlobalScope(Scope|string $scope)

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

Parameters

Scope|string $scope

Return Value

bool

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

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

Parameters

Scope|string $scope

Return Value

Scope|Closure|null

array getGlobalScopes()

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

Return Value

array

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

Определение связи один-к-одному.

Parameters

string $related
string $foreignKey
string $localKey

Return Value

HasOne

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

Создание новой связи один-к-одному.

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

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

Создание новой связи HasOneThrough.

Parameters

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

Return Value

HasOneThrough

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

Определение полиморфной связи один-к-одному.

Parameters

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

Return Value

MorphOne

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

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

Parameters

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

Return Value

MorphOne

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

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

Parameters

string $related
string $foreignKey
string $ownerKey
string $relation

Return Value

BelongsTo

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

Создание новой связи BelongsTo.

Parameters

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

Return Value

BelongsTo

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

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

Parameters

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

Return Value

MorphTo

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

Определите полиморфное, обратное отношение «один к одному» или «многие к одному».

Параметры

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

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

MorphTo

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

Определите полиморфное, обратное отношение «один к одному» или «многие к одному».

Параметры

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

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

MorphTo

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

Создайте новое отношение MorphTo.

Параметры

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

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

MorphTo

static string getActualClassNameForMorph(string $class)

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

Параметры

string $class

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

string

protected string guessBelongsToRelation()

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

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

string

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

Определите отношение «один ко многим».

Параметры

string $related
string $foreignKey
string $localKey

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

HasMany

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

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

Параметры

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

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

HasMany

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 $type = null, string $id = null, string $localKey = null)

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

Параметры

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

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

MorphMany

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

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

Параметры

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

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

MorphMany
END_OF_DOCUMENT_MARKER

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

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

Параметры

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

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

BelongsToMany

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

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

Параметры

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

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

BelongsToMany

MorphToMany morphToMany(string $related, string $name, string $table = null, string $foreignPivotKey = null, string $relatedPivotKey = null, string $parentKey = null, string $relatedKey = null, bool $inverse = false)

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

Параметры

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

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

MorphToMany

protected MorphToMany newMorphToMany(Builder $query, Model $parent, string $name, string $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string $relationName = null, bool $inverse = false)

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

Параметры

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

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

MorphToMany

MorphToMany morphedByMany(string $related, string $name, string $table = null, string $foreignPivotKey = null, string $relatedPivotKey = null, string $parentKey = null, string $relatedKey = null)

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

Параметры

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

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

MorphToMany

protected string|null guessBelongsToManyRelation()

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

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

string|null

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

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

Параметры

string $related
Model|null $instance

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

string

string joiningTableSegment()

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

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

string

bool touches(string $relation)

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

Параметры

string $relation

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

bool

void touchOwners()

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

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

void

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

Получить столбцы полиморфного отношения.

Параметры

string $name
string $type
string $id

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

array

string getMorphClass()

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

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

string

protected mixed newRelatedInstance(string $class)

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

Параметры

string $class

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

mixed

array getRelations()

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

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

array

mixed getRelation(string $relation)

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

Параметры

string $relation

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

mixed

bool relationLoaded(string $key)

Определить, загружено ли заданное отношение.

Параметры

string $key

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

bool

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

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

Параметры

string $relation
mixed $value

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

$this

$this unsetRelation(string $relation)

Удалить загруженное отношение.

Параметры

string $relation

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

$this

$this setRelations(array $relations)

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

Параметры

array $relations

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

$this

array getTouchedRelations()

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

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

array

$this setTouchedRelations(array $touches)

Установить отношения, которые затронуты при сохранении.

Параметры

array $touches

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

$this

bool touch()

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

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

bool

protected void updateTimestamps()

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

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

void

$this setCreatedAt(mixed $value)

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

Параметры

mixed $value

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

$this

$this setUpdatedAt(mixed $value)

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

Параметры

mixed $value

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

$this

Carbon freshTimestamp()

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

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

Carbon

string freshTimestampString()

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

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

string

bool usesTimestamps()

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

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

bool

string getCreatedAtColumn()

Получить имя столбца "created at".

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

string

string getUpdatedAtColumn()

Получить имя столбца "updated at".

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

string

array getHidden()

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

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

array

$this setHidden(array $hidden)

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

Параметры

array $hidden

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

$this

void addHidden(array|string|null $attributes = null)

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

Параметры

array|string|null $attributes

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

void

array getVisible()

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

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

array

$this setVisible(array $visible)

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

Параметры

array $visible

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

$this

void addVisible(array|string|null $attributes = null)

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

Параметры

array|string|null $attributes

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

void

$this makeVisible(array|string $attributes)

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

Параметры

array|string $attributes

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

$this

$this makeHidden(array|string $attributes)

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

Параметры

array|string $attributes

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

$this

array getFillable()

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

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

array

$this fillable(array $fillable)

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

Параметры

array $fillable

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

$this

array getGuarded()

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

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

array

$this guard(array $guarded)

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

Параметры

array $guarded

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

$this

static void unguard(bool $state = true)

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

Параметры

bool $state

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

void

static void reguard()

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

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

void

static bool isUnguarded()

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

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

bool

static mixed unguarded(callable $callback)

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

Параметры

callable $callback

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

mixed

bool isFillable(string $key)

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

Параметры

string $key

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

bool

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

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

Параметры

string $method

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

void

Исключения

BadMethodCallException

void __construct(array $attributes = [])

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

Параметры

array $attributes

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

void

protected void bootIfNotBooted()

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

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

void

static protected void boot()

Метод «загрузки» модели.

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

void

static protected void bootTraits()

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

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

void

protected void initializeTraits()

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

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

void

static void clearBootedModels()

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

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

void

static void withoutTouching(callable $callback)

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

Параметры

callable $callback

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

void

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

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

Параметры

array $models
callable $callback

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

void

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

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

Параметры

string|null $class

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

bool

$this fill(array $attributes)

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

Параметры

array $attributes

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

$this

Исключения

MassAssignmentException

$this forceFill(array $attributes)

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

Параметры

array $attributes

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

$this

string qualifyColumn(string $column)

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

Параметры

string $column

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

string

protected string removeTableFromKey(string $key)

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

Параметры

string $key

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

string

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

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

Параметры

array $attributes
bool $exists

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

Модель

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

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

Параметры

array $attributes
string|null $connection

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

Модель

static Построитель on(string|null $connection = null)

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

Параметры

string|null $connection

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

Построитель

static Построитель onWriteConnection()

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

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

Построитель

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

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

Параметры

array|mixed $columns

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

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

static Построитель|Модель with(array|string $relations)

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

Параметры

array|string $relations

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

Построитель|Модель

$this load(array|string $relations)

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

Параметры

array|string $relations

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

$this

$this loadMissing(array|string $relations)

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

Параметры

array|string $relations

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

$this

$this loadCount(array|string $relations)

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

Параметры

array|string $relations

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

$this

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

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

Параметры

string $column
float|int $amount
array $extra

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

int

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

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

Параметры

string $column
float|int $amount
array $extra

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

int

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

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

Параметры

string $column
float|int $amount
array $extra
string $method

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

int

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

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

Параметры

string $column
float|int $amount
array $extra
string $method

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

void

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

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

Параметры

array $attributes
array $options

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

bool

bool push()

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

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

bool

bool save(array $options = [])

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

Параметры

array $options

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

bool

bool saveOrFail(array $options = [])

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

Параметры

array $options

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

bool

Исключения

Исключение

protected void finishSave(array $options)

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

Параметры

array $options

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

void

protected bool performUpdate(Builder $query)

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

Параметры

Builder $query

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

bool

protected Builder setKeysForSaveQuery(Builder $query)

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

Параметры

Builder $query

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

Builder

protected mixed getKeyForSaveQuery()

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

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

mixed

protected bool performInsert(Builder $query)

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

Параметры

Builder $query

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

bool

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

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

Параметры

Builder $query
array $attributes

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

void

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

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

Параметры

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

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

Параметры

Scope|string $scope

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

Builder

Builder newQueryForRestoration(array|int $ids)

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

Параметры

array|int $ids

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

Builder

Builder|Model newEloquentBuilder(Builder $query)

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

Параметры

Builder $query

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

Builder|Model

protected Builder newBaseQueryBuilder()

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

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

Builder
END_OF_DOCUMENT_MARKER

Коллекция newCollection(array $models = [])

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

Параметры

array $models

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

Коллекция

Связь newPivot(Модель $parent, array $attributes, string $table, bool $exists, string|null $using = null)

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

Параметры

Модель $parent
array $attributes
string $table
bool $exists
string|null $using

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

Связь

array toArray()

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

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

array

string toJson(int $options = 0)

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

Параметры

int $options

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

string

Исключения

ИсключениеJsonEncoding

array jsonSerialize()

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

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

array

Модель|null fresh(array|string $with = [])

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

Параметры

array|string $with

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

Модель|null

$this refresh()

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

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

$this

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

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

Параметры

array $except

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

Модель

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

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

Параметры

Модель|null $model

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

bool

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

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

Параметры

Модель|null $model

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

bool

Подключение getConnection()

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

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

Подключение

string|null getConnectionName()

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

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

string|null

$this setConnection(string|null $name)

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

Параметры

string|null $name

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

$this

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

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

Параметры

string|null $connection

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

Подключение

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

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

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

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

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

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

Параметры

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

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

void

static void unsetConnectionResolver()

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

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

void

string getTable()

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

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

string

$this setTable(string $table)

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

Параметры

string $table

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

$this

string getKeyName()

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

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

string

$this setKeyName(string $key)

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

Параметры

string $key

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

$this

string getQualifiedKeyName()

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

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

string

string getKeyType()

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

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

string

$this setKeyType(string $type)

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

Параметры

string $type

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

$this

bool getIncrementing()

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

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

bool

$this setIncrementing(bool $value)

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

Параметры

bool $value

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

$this

mixed getKey()

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

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

mixed

mixed getQueueableId()

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

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

mixed

array getQueueableRelations()

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

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

array

string|null getQueueableConnection()

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

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

string|null

mixed getRouteKey()

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

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

mixed

string getRouteKeyName()

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

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

string

Model|null resolveRouteBinding(mixed $value)

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

Параметры

mixed $value

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

Model|null

string getForeignKey()

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

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

string

int getPerPage()

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

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

int

$this setPerPage(int $perPage)

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

Параметры

int $perPage

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

$this

mixed __get(string $key)

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

Параметры

string $key

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

mixed

void __set(string $key, mixed $value)

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

Параметры

string $key
mixed $value

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

void

bool offsetExists(mixed $offset)

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

Параметры

mixed $offset

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

bool

mixed offsetGet(mixed $offset)

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

Параметры

mixed $offset

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

mixed

void offsetSet(mixed $offset, mixed $value)

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

Параметры

mixed $offset
mixed $value

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

void

void offsetUnset(mixed $offset)

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

Параметры

mixed $offset

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

void

bool __isset(string $key)

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

Параметры

string $key

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

bool

void __unset(string $key)

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

Параметры

string $key

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

void

mixed __call(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

static mixed __callStatic(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

string __toString()

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

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

string

void __wakeup()

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

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

void

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

Spec-Zone.ru

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