Spec-Zone.ru › Laravel 5.7

Модель

абстрактный класс Модель реализует 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
статический bool $snakeAttributes Указывает, преобразуются ли атрибуты в нижний регистр с дефисами в массивах. из HasAttributes
статический protected массив $mutatorCache Кэш измененных атрибутов для каждого класса. из HasAttributes
protected массив $dispatchesEvents Карта событий для модели. из HasEvents
protected массив $observables Доступные для пользователя события observable. из HasEvents
protected массив $relations Загруженные отношения для модели. из HasRelationships
protected массив $touches Отношения, которые должны быть изменены при сохранении. из HasRelationships
статический массив $manyMethods Методы для отношений many-to-many. из HasRelationships
bool $timestamps Указывает, нужно ли добавлять временные метки в модель. из HasTimestamps
protected массив $hidden Атрибуты, которые должны быть скрыты при сериализации. из HidesAttributes
protected массив $visible Атрибуты, которые должны быть видны при сериализации. из HidesAttributes
protected массив $fillable Атрибуты, которые можно массово присваивать. из GuardsAttributes
protected массив $guarded Атрибуты, которые нельзя массово присваивать. из GuardsAttributes
статический protected bool $unguarded Указывает, разрешено ли все массовое присваивание. из GuardsAttributes
protected строка $connection Имя подключения для модели.
protected строка $table Таблица, связанная с моделью.
protected строка $primaryKey Первичный ключ модели.
protected строка $keyType Тип инкрементируемого идентификатора.
bool $incrementing Указывает, являются ли идентификаторы автоматическими инкрементируемыми.
protected массив $with Отношения, которые нужно загрузить с помощью eager loading для каждого запроса.
protected массив $withCount Счетчики отношений, которые нужно загрузить с помощью eager loading для каждого запроса.
protected целое число $perPage Количество моделей, возвращаемых при постраничном отображении.
bool $exists Указывает, существует ли модель.
bool $wasRecentlyCreated Указывает, была ли модель добавлена во время текущего цикла запроса.
статический protected ConnectionResolverInterface $resolver Экземпляр решателя подключения.
статический protected Dispatcher $dispatcher Экземпляр диспетчера событий.
статический protected массив $booted Массив запущенных моделей.
статический protected массив $traitInitializers Массив инициализаторов трейтов, которые будут вызваны при каждом новом экземпляре.
статический protected массив $globalScopes Массив глобальных скоупов модели.
статический protected массив $ignoreOnTouch Список классов моделей, которые не должны затрагиваться при использовании touch.

Методы

массив attributesToArray()

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

из HasAttributes
массив addDateAttributesToArray(массив $attributes)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

из HasAttributes
смешанное getAttribute(строка $key)

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

из HasAttributes
смешанное getAttributeValue(строка $key)

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

из HasAttributes
смешанное getAttributeFromArray(строка $key)

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

из HasAttributes
смешанное getRelationValue(строка $key)

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

из HasAttributes
смешанное getRelationshipFromMethod(строка $method)

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

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

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

из HasAttributes
смешанное mutateAttribute(строка $key, смешанное $value)

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

из HasAttributes
смешанное mutateAttributeForArray(строка $key, смешанное $value)

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

из HasAttributes
смешанное castAttribute(строка $key, смешанное $value)

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

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

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

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

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

из HasAttributes
смешанное setAttribute(строка $key, смешанное $value)

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

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

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

из HasAttributes
смешанное setMutatedAttributeValue(строка $key, смешанное $value)

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

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

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

из HasAttributes
$this fillJsonAttribute(строка $key, смешанное $value)

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

из HasAttributes
$this getArrayAttributeWithValue(строка $path, строка $key, смешанное $value)

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

из HasAttributes
массив getArrayAttributeByKey(строка $key)

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

из HasAttributes
строка castAttributeAsJson(строка $key, смешанное $value)

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

из HasAttributes
строка asJson(смешанное $value)

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

из HasAttributes
mixed fromFloat(mixed $value)

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

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

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

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 fromDateTime(DateTime|int $value)

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

from HasAttributes
int asTimestamp(mixed $value)

Возвращает временную метку как Unix-временную метку.

from HasAttributes
string serializeDate(DateTimeInterface $date)

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

from HasAttributes
array getDates()

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

from HasAttributes
string getDateFormat()

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

from HasAttributes
$this setDateFormat(string $format)

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

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

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

from HasAttributes
array getCasts()

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

from HasAttributes
bool isDateCastable(string $key)

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

from HasAttributes
bool isJsonCastable(string $key)

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

from HasAttributes
array getAttributes()

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

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

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

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

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

from HasAttributes
array only(array|mixed $attributes)

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

from HasAttributes
$this syncOriginal()

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

from HasAttributes
$this syncOriginalAttribute(string $attribute)

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

from HasAttributes
$this 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)

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

из HasAttributes
$this setAppends(array $appends)

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

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

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

из HasAttributes
статический void cacheMutatedAttributes(string $class)

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

из HasAttributes
статический массив getMutatorMethods(mixed $class)

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

из HasAttributes
статический void observe(object|array|string $classes)

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

из HasEvents
void registerObserver(object|string $class)

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

из HasEvents
массив getObservableEvents()

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

из HasEvents
$this setObservableEvents(array $observables)

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

из HasEvents
void addObservableEvents(array|mixed $observables)

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

из HasEvents
void removeObservableEvents(array|mixed $observables)

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

из HasEvents
статический void registerModelEvent(string $event, Closure|string $callback)

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

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

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

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

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

из HasEvents
mixed filterModelEventResults(mixed $result)

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

из HasEvents
статический void retrieved(Closure|string $callback)

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

из HasEvents
статический void saving(Closure|string $callback)

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

из HasEvents
статический void saved(Closure|string $callback)

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

из HasEvents
статический void updating(Closure|string $callback)

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

из HasEvents
статический void updated(Closure|string $callback)

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

из HasEvents
статический void creating(Closure|string $callback)

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

из HasEvents
статический void created(Closure|string $callback)

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

из HasEvents
статический void deleting(Closure|string $callback)

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

из HasEvents
статический void deleted(Closure|string $callback)

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

из HasEvents
статический void flushEventListeners()

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

из HasEvents
статический Dispatcher getEventDispatcher()

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

из HasEvents
статический void setEventDispatcher(Dispatcher $dispatcher)

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

из HasEvents
статический void unsetEventDispatcher()

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

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

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

from HasGlobalScopes
static bool hasGlobalScope(Scope|string $scope)

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

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

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

from HasGlobalScopes
array getGlobalScopes()

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

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

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

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

Создать новый объект отношения HasOne.

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

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

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

Создать новый объект отношения MorphOne.

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

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

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

Создать новый объект отношения BelongsTo.

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

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

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

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

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

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

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

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

from HasRelationships
static string getActualClassNameForMorph(string $class)

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

from HasRelationships
string guessBelongsToRelation()

Предположить имя отношения «принадлежит к».

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

from 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.

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

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

from HasRelationships
string guessBelongsToManyRelation()

Получить имя отношения "многие ко многим".

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

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

from HasRelationships
string joiningTableSegment()

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

from HasRelationships
bool touches(string $relation)

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

from HasRelationships
void touchOwners()

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

from HasRelationships
array getMorphs(string $name, string $type, string $id)

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

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

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

from GuardsAttributes
static mixed unguarded(callable $callback)

Выполнить заданный вызов функции в режиме "unguarded".

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)

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

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

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

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

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

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

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

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

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

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

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

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

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

$this load(array|string $relations)

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

$this loadMissing(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(Библиотека $query)

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

Библиотека setKeysForSaveQuery(Библиотека $query)

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

mixed getKeyForSaveQuery()

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

bool performInsert(Библиотека $query)

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

void insertAndSetId(Библиотека $query, array $attributes)

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

static int destroy(Коллекция|array|int $ids)

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

bool|null delete()

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

bool|null forceDelete()

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

void performDeleteOnModel()

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

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

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

Библиотека newQuery()

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

Библиотека|Модель 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)

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

bool isNot(Model|null $model)

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

Connection getConnection()

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

string getConnectionName()

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

$this setConnection(string $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

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)

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

Параметры

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.

Parameters

string $key
mixed $value

Return Value

mixed

protected string getCastType(string $key)

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

Parameters

string $key

Return Value

string

protected bool isCustomDateTimeCast(string $cast)

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

Parameters

string $cast

Return Value

bool

mixed setAttribute(string $key, mixed $value)

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

Parameters

string $key
mixed $value

Return Value

mixed

bool hasSetMutator(string $key)

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

Parameters

string $key

Return Value

bool

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

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

Parameters

string $key
mixed $value

Return Value

mixed

protected bool isDateAttribute(string $key)

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

Parameters

string $key

Return Value

bool

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

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

Parameters

string $key
mixed $value

Return Value

$this

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

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

Parameters

string $path
string $key
mixed $value

Return Value

$this

protected array getArrayAttributeByKey(string $key)

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

Parameters

string $key

Return Value

array

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

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

Parameters

string $key
mixed $value

Return Value

string

protected string asJson(mixed $value)

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

Parameters

mixed $value

Return Value

string

mixed fromFloat(mixed $value)

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

Parameters

mixed $value

Return Value

mixed

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

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

Parameters

string $value
bool $asObject

Return Value

mixed

protected Carbon asDate(mixed $value)

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

Parameters

mixed $value

Return Value

Carbon

protected Carbon asDateTime(mixed $value)

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

Parameters

mixed $value

Return Value

Carbon

protected bool isStandardDateFormat(string $value)

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

Parameters

string $value

Return Value

bool

string fromDateTime(DateTime|int $value)

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

Parameters

DateTime|int $value

Return Value

string

protected int asTimestamp(mixed $value)

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

Parameters

mixed $value

Return Value

int

protected string serializeDate(DateTimeInterface $date)

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

Parameters

DateTimeInterface $date

Return Value

string

array getDates()

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

Return Value

array

строка getDateFormat()

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

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

строка

$this setDateFormat(строка $format)

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

Параметры

строка $format

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

$this

bool hasCast(строка $key, массив|строка|null $types = null)

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

Параметры

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

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

bool

массив getCasts()

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

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

массив

protected bool isDateCastable(строка $key)

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

Параметры

строка $key

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

bool

protected bool isJsonCastable(строка $key)

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

Параметры

строка $key

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

bool

массив getAttributes()

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

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

массив

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

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

Параметры

массив $attributes
bool $sync

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

$this

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

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

Параметры

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

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

смешанное|массив

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

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

Параметры

массив|смешанное $attributes

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

массив

$this syncOriginal()

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

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

$this

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

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

Параметры

строка $attribute

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

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

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

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

массив

protected bool originalIsEquivalent(строка $key, смешанное $current)

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

Параметры

строка $key
смешанное $current

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

bool

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

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

Параметры

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

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

$this

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

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

Параметры

массив $appends

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

$this

массив getMutatedAttributes()

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

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

массив

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

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

Параметры

строка $class

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

void

static protected array getMutatorMethods(mixed $class)

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

Параметры

mixed $class

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

array

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

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

Параметры

object|array|string $classes

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

void

protected void registerObserver(object|string $class)

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

Параметры

object|string $class

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

void

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)

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

Параметры

string $event
string $method

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

mixed|null

protected mixed filterModelEventResults(mixed $result)

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

Параметры

mixed $result

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

mixed

static void retrieved(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void saving(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void saved(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void updating(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void updated(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void creating(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void created(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void deleting(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void deleted(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void flushEventListeners()

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

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

void

static Dispatcher getEventDispatcher()

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

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

Dispatcher

static void setEventDispatcher(Dispatcher $dispatcher)

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

Параметры

Dispatcher $dispatcher

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

void

static void unsetEventDispatcher()

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

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

void

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

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

Параметры

Scope|Closure|string $scope
Closure $implementation

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

mixed

Исключения

InvalidArgumentException

static bool hasGlobalScope(Scope|string $scope)

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

Параметры

Scope|string $scope

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

bool

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

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

Параметры

Scope|string $scope

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

Scope|Closure|null

array getGlobalScopes()

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

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

array

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

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

Параметры

string $related
string $foreignKey
string $localKey

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

HasOne

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

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

Параметры

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

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

HasOne

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

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

Параметры

string $related
string $name
string $type
string $id
string $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 $foreignKey = null, string $ownerKey = null, string $relation = null)

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

Параметры

string $related
string $foreignKey
string $ownerKey
string $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
END_OF_DOCUMENT_MARKER

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

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

Параметры

string $name
string $type
string $id
string $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)

Получить фактическое имя класса для заданного класса 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

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)

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

Параметры

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

Получить имя отношения "многие ко многим".

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

string

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)

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

Параметры

mixed $value

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

$this

$this setUpdatedAt(mixed $value)

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

Параметры

mixed $value

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

$this

Carbon freshTimestamp()

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

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

Carbon

string freshTimestampString()

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

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

string

bool usesTimestamps()

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

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

bool

string getCreatedAtColumn()

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

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

string

string getUpdatedAtColumn()

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

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

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
END_OF_DOCUMENT_MARKER

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

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

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

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)

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

Параметры

массив $attributes

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

$this

Исключения

MassAssignmentException

$this forceFill(array $attributes)

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

Параметры

массив $attributes

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

$this

string qualifyColumn(string $column)

Указать имя столбца, используя таблицу модели.

Параметры

строка $column

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

строка

protected string removeTableFromKey(string $key)

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

Параметры

строка $key

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

строка

Model newInstance(array $attributes = [], bool $exists = false)

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

Параметры

массив $attributes
логическое значение $exists

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

Model

Model newFromBuilder(array $attributes = [], string|null $connection = null)

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

Параметры

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

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

Model

static Builder on(string|null $connection = null)

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

Параметры

строка|null $connection

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

Builder

static Builder onWriteConnection()

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

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

Builder

static Collection|Model[] all(array|mixed $columns = ['*'])

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

Параметры

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

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

Collection|Model[]

static Builder|Model with(array|string $relations)

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

Параметры

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

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

Builder|Model

$this load(array|string $relations)

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

Параметры

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

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

$this

$this loadMissing(array|string $relations)

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

Параметры

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

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

$this

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

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

Параметры

строка $column
число с плавающей точкой|целое $amount
массив $extra

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

целое

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

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

Параметры

строка $column
число с плавающей точкой|целое $amount
массив $extra

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

целое

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

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

Параметры

строка $column
число с плавающей точкой|целое $amount
массив $extra
строка $method

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

целое

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

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

Параметры

строка $column
число с плавающей точкой|целое $amount
массив $extra
строка $method

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

void

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

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

Параметры

массив $attributes
массив $options

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

логическое значение

bool push()

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

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

логическое значение

bool save(array $options = [])

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

Параметры

массив $options

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

логическое значение

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

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

Параметры

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)

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

Параметры

array|int $ids

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

Builder
END_OF_DOCUMENT_MARKER

Builder|Модель newEloquentBuilder(Builder $query)

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

Параметры

Builder $query

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

Builder|Модель

protected Builder newBaseQueryBuilder()

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

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

Builder

Коллекция 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

Исключения

JsonEncodingException

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)

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

Параметры

Модель|null $model

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

bool

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

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

Параметры

Модель|null $model

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

bool

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

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

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

Подключение

string getConnectionName()

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

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

string

$this setConnection(string $name)

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

Параметры

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

Модель|null resolveRouteBinding(mixed $value)

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

Параметры

mixed $value

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

Модель|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
END_OF_DOCUMENT_MARKER

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.7/Illuminate/Database/Eloquent/Model.html

Spec-Zone.ru

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