Spec-Zone.ru › Laravel 7

Пользователь

класс Пользователь расширяет Модель и реализует Authenticatable, Authorizable, CanResetPassword (Просмотреть исходный код)

Трейты

Authenticatable
Authorizable
CanResetPassword
MustVerifyEmail
HasAttributes
HasEvents
HasGlobalScopes
HasRelationships
HasTimestamps
HidesAttributes
GuardsAttributes
ForwardsCalls

Константы

CREATED_AT

Имя столбца "создано в".

UPDATED_AT

Имя столбца "обновлено в".

Свойства

protected массив $attributes

Атрибуты модели.

из HasAttributes
protected массив $original

Исходное состояние атрибутов модели.

из HasAttributes
protected массив $changes

Измененные атрибуты модели.

из HasAttributes
protected массив $casts

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

из HasAttributes
protected массив $classCastCache

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

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

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

из HasAttributes
protected массив $dates

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

из HasAttributes
protected строка $dateFormat

Формат хранения столбцов даты модели.

из HasAttributes
protected массив $appends

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

из HasAttributes
static bool $snakeAttributes

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

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

Кэш измененных атрибутов для каждого класса.

из HasAttributes
protected массив $dispatchesEvents

Карта событий для модели.

из HasEvents
protected массив $observables

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

из HasEvents
protected массив $relations

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

из HasRelationships
protected массив $touches

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

из HasRelationships
static массив $manyMethods

Методы отношений "многие ко многим".

из HasRelationships
static protected массив $relationResolvers

Обратные вызовы разрешителя отношений.

из HasRelationships
bool $timestamps

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

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

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

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

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

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

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

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

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

из GuardsAttributes
static protected bool $unguarded

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

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

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

из GuardsAttributes
protected string|null $connection

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

из Model
protected строка $table

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

из Model
protected строка $primaryKey

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

из Model
protected строка $keyType

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

из Model
bool $incrementing

Указывает, являются ли ID автоматически увеличивающимися.

из Model
protected массив $with

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

из Model
protected массив $withCount

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

из Model
protected целое $perPage

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

из Model
bool $exists

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

из Model
bool $wasRecentlyCreated

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

из Model
static protected ConnectionResolverInterface $resolver

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

from Модель
static protected Dispatcher $dispatcher

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

from Модель
static protected array $booted

Массив загруженных моделей.

from Модель
static protected array $traitInitializers

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

from Модель
static protected array $globalScopes

Массив глобальных скопов модели.

from Модель
static protected array $ignoreOnTouch

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

from Модель
protected string $rememberTokenName

Имя столбца токена «запомнить меня».

from Аутентифицируемый

Методы

массив attributesToArray()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

из HasAttributes
булево hasGetMutator(строка $key)

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

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

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

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

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

из HasAttributes
void mergeCasts(массив $casts)

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

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

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

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

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

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

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

из HasAttributes
булево isCustomDateTimeCast(строка $cast)

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

из HasAttributes
булево isDecimalCast(строка $cast)

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

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

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

из HasAttributes
булево hasSetMutator(строка $key)

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

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

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

из HasAttributes
булево isDateAttribute(строка $key)

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

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

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

из HasAttributes
void setClassCastableAttribute(string $key, mixed $value)

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

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

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

из HasAttributes
array getArrayAttributeByKey(string $key)

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

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

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

из HasAttributes
string asJson(mixed $value)

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

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

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

из HasAttributes
mixed fromFloat(mixed $value)

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

из HasAttributes
string asDecimal(float $value, int $decimals)

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

из HasAttributes
Carbon asDate(mixed $value)

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

из HasAttributes
Carbon asDateTime(mixed $value)

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

из HasAttributes
bool isStandardDateFormat(string $value)

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

из HasAttributes
string|null fromDateTime(mixed $value)

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

из HasAttributes
int asTimestamp(mixed $value)

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

из HasAttributes
string serializeDate(DateTimeInterface $date)

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

из HasAttributes
array getDates()

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

из HasAttributes
string getDateFormat()

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

из HasAttributes
$this setDateFormat(string $format)

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

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

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

из HasAttributes
array getCasts()

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

из HasAttributes
bool isDateCastable(string $key)

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

из HasAttributes
bool isJsonCastable(string $key)

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

из HasAttributes
bool isClassCastable(string $key)

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

из HasAttributes
mixed resolveCasterClass(string $key)

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

из HasAttributes
string parseCasterClass(string $class)

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

из HasAttributes
void mergeAttributesFromClassCasts()

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

из HasAttributes
array normalizeCastClassResponse(string $key, mixed $value)

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

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

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

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

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

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

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

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

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

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

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

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

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

из HasAttributes
$this syncOriginal()

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

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

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

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

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

из HasAttributes
$this syncChanges()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

из HasAttributes
static массив getMutatorMethods(смешанный $class)

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

из HasAttributes
static void observe(объект|массив|строка $classes)

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

из HasEvents
void registerObserver(объект|строка $class)

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

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

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

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

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

from HasEvents
static void flushEventListeners()

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

from HasEvents
static Dispatcher getEventDispatcher()

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

from HasEvents
static void setEventDispatcher(Dispatcher $dispatcher)

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

from HasEvents
static void unsetEventDispatcher()

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

from HasEvents
static mixed withoutEvents(callable $callback)

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

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

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

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

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

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

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

из HasGlobalScopes
array getGlobalScopes()

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

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

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

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

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

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

Создание нового отношения 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|null $type = null, string|null $id = null, string|null $localKey = null)

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

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

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

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

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

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

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

из HasRelationships
MorphTo morphTo(string|null $name = null, string|null $type = null, string|null $id = null, string|null $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|null $foreignKey = null, string|null $localKey = null)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

from HasRelationships
string|null guessBelongsToManyRelation()

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

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

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

from HasRelationships
$this unsetRelations()

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

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

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

from HasTimestamps
string|null getUpdatedAtColumn()

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

from HasTimestamps
string getQualifiedCreatedAtColumn()

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

from HasTimestamps
string getQualifiedUpdatedAtColumn()

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

from HasTimestamps
array getHidden()

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

from HidesAttributes
$this setHidden(array $hidden)

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

from HidesAttributes
array getVisible()

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

from HidesAttributes
$this setVisible(array $visible)

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

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

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

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

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

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

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

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

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

из HidesAttributes
массив getFillable()

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

из GuardsAttributes
$this fillable(array $fillable)

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

из GuardsAttributes
$this mergeFillable(array $fillable)

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

из GuardsAttributes
массив getGuarded()

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

из GuardsAttributes
$this guard(array $guarded)

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

из GuardsAttributes
$this mergeGuarded(array $guarded)

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

из GuardsAttributes
static void unguard(bool $state = true)

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

из GuardsAttributes
static void reguard()

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

из GuardsAttributes
static bool isUnguarded()

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

из GuardsAttributes
static mixed unguarded(callable $callback)

Выполнить заданный вызов, находясь в режиме "unguarded".

из GuardsAttributes
bool isFillable(string $key)

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

из GuardsAttributes
bool isGuarded(string $key)

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

из GuardsAttributes
bool isGuardableColumn(string $key)

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

из GuardsAttributes
bool totallyGuarded()

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

из GuardsAttributes
массив fillableFromArray(array $attributes)

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

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

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

из ForwardsCalls
static void throwBadMethodCallException(string $method)

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

из ForwardsCalls
void __construct(array $attributes = [])

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

из Model
void bootIfNotBooted()

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

из Model
static void booting()

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

из Model
static void boot()

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

из Model
static void bootTraits()

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

из Model
void initializeTraits()

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

из Model
static void booted()

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

из Model
static void clearBootedModels()

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

из Model
static void withoutTouching(callable $callback)

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

из Model
static void withoutTouchingOn(array $models, callable $callback)

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

из Model
static bool isIgnoringTouch(string|null $class = null)

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

из Model
$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 loadMorph(string $relation, array $relations)

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

из Модели
$this loadMissing(array|string $relations)

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

из Модели
$this loadCount(array|string $relations)

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

из Модели
$this loadMorphCount(string $relation, array $relations)

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

из Модели
int increment(string $column, float|int $amount = 1, array $extra = [])

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

из Модели
int decrement(string $column, float|int $amount = 1, array $extra = [])

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

из Модели
int incrementOrDecrement(string $column, float|int $amount, array $extra, string $method)

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

из Модели
void incrementOrDecrementAttributeValue(string $column, float|int $amount, array $extra, string $method)

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

из Модели
bool update(array $attributes = [], array $options = [])

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

из Модели
bool push()

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

из Модели
bool save(array $options = [])

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

из Модели
bool saveOrFail(array $options = [])

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

из Модели
void finishSave(array $options)

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

из Модели
bool performUpdate(Билдер $query)

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

из Модели
Билдер setKeysForSaveQuery(Билдер $query)

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

из Модели
mixed getKeyForSaveQuery()

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

из Модели
bool performInsert(Билдер $query)

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

из Модели
void insertAndSetId(Builder $query, array $attributes)

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

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

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

from Model
bool|null delete()

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

from Model
bool|null forceDelete()

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

from Model
void performDeleteOnModel()

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

from Model
static Builder query()

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

from Model
Builder newQuery()

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

from Model
Builder|Model newModelQuery()

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

from Model
Builder newQueryWithoutRelationships()

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

from Model
Builder registerGlobalScopes(Builder $builder)

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

from Model
Builder|Model newQueryWithoutScopes()

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

from Model
Builder newQueryWithoutScope(Scope|string $scope)

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

from Model
Builder newQueryForRestoration(array|int $ids)

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

from Model
Builder|Model newEloquentBuilder(Builder $query)

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

from Model
Builder newBaseQueryBuilder()

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

from Model
Collection newCollection(array $models = [])

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

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

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

from Model
bool hasNamedScope(string $scope)

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

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

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

from Model
array toArray()

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

from Model
string toJson(int $options = 0)

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

from Model
array jsonSerialize()

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

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

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

from Model
$this refresh()

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

from Model
Model replicate(array $except = null)

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

from Model
bool is(Model|null $model)

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

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

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

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

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

из Модели
string|null getConnectionName()

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

из Модели
$this setConnection(string|null $name)

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

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

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

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

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

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

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

из Модели
static void unsetConnectionResolver()

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

из Модели
string getTable()

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

из Модели
$this setTable(string $table)

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

из Модели
string getKeyName()

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

из Модели
$this setKeyName(string $key)

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

из Модели
string getQualifiedKeyName()

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

из Модели
string getKeyType()

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

из Модели
$this setKeyType(string $type)

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

из Модели
bool getIncrementing()

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

из Модели
$this setIncrementing(bool $value)

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

из Модели
mixed getKey()

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

из Модели
mixed getQueueableId()

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

из Модели
array getQueueableRelations()

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

из Модели
string|null getQueueableConnection()

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

из Модели
mixed getRouteKey()

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

из Модели
string getRouteKeyName()

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

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

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

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

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

из Модели
string getForeignKey()

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

из Модели
int getPerPage()

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

из Модели
$this setPerPage(int $perPage)

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

из Модели
mixed __get(string $key)

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

из Модели
void __set(string $key, mixed $value)

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

из Модели
bool offsetExists(mixed $offset)

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

из Модели
mixed offsetGet(mixed $offset)

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

из Модели
void offsetSet(mixed $offset, mixed $value)

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

из Модели
void offsetUnset(mixed $offset)

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

из Модели
bool __isset(string $key)

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

из Модели
void __unset(string $key)

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

из Модели
mixed __call(string $method, array $parameters)

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

из Модели
static mixed __callStatic(string $method, array $parameters)

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

из Модели
string __toString()

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

из Модели
array __sleep()

Подготовить объект к сериализации.

из Модели
void __wakeup()

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

из Модели
string getAuthIdentifierName()

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

из Authenticatable
mixed getAuthIdentifier()

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

из Authenticatable
string getAuthPassword()

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

из Authenticatable
string|null getRememberToken()

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

из Authenticatable
void setRememberToken(string $value)

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

из Authenticatable
string getRememberTokenName()

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

из Authenticatable
bool can(iterable|string $abilities, array|mixed $arguments = [])

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

из Authorizable
bool cant(iterable|string $abilities, array|mixed $arguments = [])

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

из Authorizable
bool cannot(iterable|string $abilities, array|mixed $arguments = [])

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

из Authorizable
string getEmailForPasswordReset()

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

из CanResetPassword
void sendPasswordResetNotification(string $token)

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

из CanResetPassword
bool hasVerifiedEmail()

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

из MustVerifyEmail
bool markEmailAsVerified()

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

из MustVerifyEmail
void sendEmailVerificationNotification()

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

из MustVerifyEmail
string getEmailForVerification()

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

из MustVerifyEmail

Подробности

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)

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

Parameters

array $attributes
array $mutatedAttributes

Return Value

array

protected array getArrayableAttributes()

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

Return Value

array

protected array getArrayableAppends()

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

Return Value

array

array relationsToArray()

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

Return Value

array

protected array getArrayableRelations()

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

Return Value

array

protected array getArrayableItems(array $values)

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

Parameters

array $values

Return Value

array

mixed getAttribute(string $key)

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

Parameters

string $key

Return Value

mixed

mixed getAttributeValue(string $key)

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

Parameters

string $key

Return Value

mixed

protected mixed getAttributeFromArray(string $key)

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

Parameters

string $key

Return Value

mixed

mixed getRelationValue(string $key)

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

Parameters

string $key

Return Value

mixed

protected mixed getRelationshipFromMethod(string $method)

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

Parameters

string $method

Return Value

mixed

Exceptions

LogicException

bool hasGetMutator(string $key)

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

Parameters

string $key

Return Value

bool

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

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

Parameters

string $key
mixed $value

Return Value

mixed

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

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

Parameters

string $key
mixed $value

Return Value

mixed

void mergeCasts(array $casts)

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

Parameters

array $casts

Return Value

void

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

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

Parameters

string $key
mixed $value

Return Value

mixed

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

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

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

protected bool isDecimalCast(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 void setClassCastableAttribute(string $key, mixed $value)

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

Parameters

string $key
mixed $value

Return Value

void

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 fromJson(string $value, bool $asObject = false)

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

Parameters

string $value
bool $asObject

Return Value

mixed

mixed fromFloat(mixed $value)

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

Parameters

mixed $value

Return Value

mixed

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

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

Parameters

float $value
int $decimals

Return Value

string

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|null fromDateTime(mixed $value)

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

Parameters

mixed $value

Return Value

string|null

protected int asTimestamp(mixed $value)

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

Parameters

mixed $value

Return Value

int

protected string serializeDate(DateTimeInterface $date)

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

Parameters

DateTimeInterface $date

Return Value

string

array getDates()

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

Return Value

array

string getDateFormat()

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

Return Value

string

$this setDateFormat(string $format)

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

Parameters

string $format

Return Value

$this

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

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

Parameters

string $key
array|string|null $types

Return Value

bool

Массив getCasts()

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

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

Массив

protected Булево isDateCastable(string $key)

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

Параметры

Строка $key

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

Булево

protected Булево isJsonCastable(string $key)

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

Параметры

Строка $key

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

Булево

protected Булево isClassCastable(string $key)

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

Параметры

Строка $key

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

Булево

protected Смешанный тип resolveCasterClass(string $key)

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

Параметры

Строка $key

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

Смешанный тип

protected Строка parseCasterClass(string $class)

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

Параметры

Строка $class

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

Строка

protected Пустое значение mergeAttributesFromClassCasts()

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

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

Пустое значение

protected Массив normalizeCastClassResponse(string $key, mixed $value)

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

Параметры

Строка $key
Смешанный тип $value

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

Массив

Массив getAttributes()

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

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

Массив

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

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

Параметры

Массив $attributes
Булево $sync

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

$this

Смешанный тип|Массив getOriginal(string|null $key = null, mixed $default = null)

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

Параметры

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

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

Смешанный тип|Массив

protected Смешанный тип|Массив getOriginalWithoutRewindingModel(string|null $key = null, mixed $default = null)

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

Параметры

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

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

Смешанный тип|Массив

Смешанный тип|Массив getRawOriginal(string|null $key = null, mixed $default = null)

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

Параметры

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

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

Смешанный тип|Массив

Массив only(array|mixed $attributes)

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

Параметры

Массив|Смешанный тип $attributes

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

Массив

$this syncOriginal()

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

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

$this

$this syncOriginalAttribute(string $attribute)

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

Параметры

Строка $attribute

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

$this

$this syncOriginalAttributes(array|string $attributes)

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

Параметры

Массив|Строка $attributes

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

$this

$this syncChanges()

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

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

$this

Булево isDirty(array|string|null $attributes = null)

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

Параметры

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

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

Булево

Булево isClean(array|string|null $attributes = null)

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

Параметры

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

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

Булево

Булево wasChanged(array|string|null $attributes = null)

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

Параметры

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

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

Булево

protected Булево hasChanges(array $changes, array|string|null $attributes = null)

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

Параметры

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

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

Булево

Массив getDirty()

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

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

Массив

array getChanges()

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

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

array

bool originalIsEquivalent(string $key)

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

Параметры

string $key

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

bool

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

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

Параметры

string $key
mixed $value

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

mixed

$this append(array|string $attributes)

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

Параметры

array|string $attributes

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

$this

$this setAppends(array $appends)

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

Параметры

array $appends

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

$this

bool hasAppended(string $attribute)

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

Параметры

string $attribute

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

bool

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)

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

Параметры

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)

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

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)

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

Parameters

Scope|Closure|string $scope
Closure $implementation

Return Value

mixed

Exceptions

InvalidArgumentException

static bool hasGlobalScope(Scope|string $scope)

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

Parameters

Scope|string $scope

Return Value

bool

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

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

Parameters

Scope|string $scope

Return Value

Scope|Closure|null

array getGlobalScopes()

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

Return Value

array

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

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

Параметры

string $name
Closure $callback

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

void

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

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

Параметры

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

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

HasOne

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

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

Параметры

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

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

HasOne

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

Определить отношение один-к-одному через промежуточную таблицу.

Параметры

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

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

HasOneThrough

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

Создать новое отношение один-к-одному через промежуточную таблицу.

Параметры

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

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

HasOneThrough

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

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

Параметры

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

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

MorphOne

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

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

Параметры

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

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

MorphOne

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

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

Параметры

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

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

BelongsTo

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

Создать новое отношение принадлежности.

Параметры

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

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

BelongsTo

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

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

Параметры

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

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

MorphTo
END_OF_DOCUMENT_MARKER

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

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

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

string

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

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

Параметры

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

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

HasMany

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

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

Параметры

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)

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

Параметры

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)

Создайте новое отношение «имеет многие через».

Параметры

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

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

HasManyThrough

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

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

Параметры

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

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

MorphMany

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

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

Параметры

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

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

MorphMany

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

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

Параметры

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

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

BelongsToMany

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

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

Параметры

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

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

BelongsToMany

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

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

Параметры

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

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

MorphToMany

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

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

Параметры

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

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

MorphToMany

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

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

Параметры

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

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

MorphToMany

protected string|null guessBelongsToManyRelation()

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

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

string|null

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

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

Параметры

string $related
Model|null $instance

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

string

string joiningTableSegment()

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

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

string

bool touches(string $relation)

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

Параметры

string $relation

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

bool

void touchOwners()

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

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

void

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

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

Параметры

string $name
string $type
string $id

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

array

string getMorphClass()

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

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

string

protected mixed newRelatedInstance(string $class)

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

Параметры

string $class

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

mixed

array getRelations()

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

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

array

mixed getRelation(string $relation)

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

Параметры

string $relation

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

mixed

bool relationLoaded(string $key)

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

Параметры

string $key

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

bool

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

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

Параметры

string $relation
mixed $value

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

$this

$this unsetRelation(string $relation)

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

Параметры

string $relation

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

$this

$this setRelations(array $relations)

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

Параметры

array $relations

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

$this

$this withoutRelations()

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

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

$this

$this unsetRelations()

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

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

$this

array getTouchedRelations()

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

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

array

$this setTouchedRelations(array $touches)

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

Параметры

array $touches

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

$this

bool touch()

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

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

bool

protected void updateTimestamps()

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

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

void

$this setCreatedAt(mixed $value)

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

Параметры

mixed $value

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

$this

$this setUpdatedAt(mixed $value)

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

Параметры

mixed $value

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

$this

Carbon freshTimestamp()

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

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

Carbon

string freshTimestampString()

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

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

string

bool usesTimestamps()

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

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

bool

string|null getCreatedAtColumn()

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

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

string|null

string|null getUpdatedAtColumn()

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

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

string|null

string getQualifiedCreatedAtColumn()

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

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

string

string getQualifiedUpdatedAtColumn()

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

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

string

array getHidden()

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

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

array

$this setHidden(array $hidden)

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

Параметры

array $hidden

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

$this

array getVisible()

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

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

array

$this setVisible(array $visible)

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

Параметры

array $visible

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

$this

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

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

Параметры

array|string|null $attributes

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

$this

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

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

Параметры

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

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

$this

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

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

Параметры

array|string|null $attributes

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

$this

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

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

Параметры

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

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

$this

array getFillable()

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

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

array

$this fillable(array $fillable)

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

Параметры

array $fillable

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

$this

$this mergeFillable(array $fillable)

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

Параметры

array $fillable

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

$this

array getGuarded()

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

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

array

$this guard(array $guarded)

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

Параметры

array $guarded

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

$this

$this mergeGuarded(array $guarded)

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

Параметры

array $guarded

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

$this

static void unguard(bool $state = true)

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

Параметры

bool $state

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

void

static void reguard()

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

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

void

static bool isUnguarded()

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

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

bool

static mixed unguarded(callable $callback)

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

Параметры

callable $callback

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

mixed

bool isFillable(string $key)

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

Параметры

string $key

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

bool

bool isGuarded(string $key)

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

Параметры

string $key

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

bool

protected bool isGuardableColumn(string $key)

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

Параметры

string $key

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

bool

bool totallyGuarded()

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

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

bool

protected array fillableFromArray(array $attributes)

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

Параметры

array $attributes

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

array

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

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

Параметры

mixed $object
string $method
array $parameters

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

mixed

Исключения

BadMethodCallException
END_OF_DOCUMENT_MARKER

static protected void throwBadMethodCallException(string $method)

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

Parameters

string $method

Return Value

void

Exceptions

BadMethodCallException

void __construct(array $attributes = [])

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

Parameters

array $attributes

Return Value

void

protected void bootIfNotBooted()

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

Return Value

void

static protected void booting()

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

Return Value

void

static protected void boot()

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

Return Value

void

static protected void bootTraits()

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

Return Value

void

protected void initializeTraits()

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

Return Value

void

static protected void booted()

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

Return Value

void

static void clearBootedModels()

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

Return Value

void

static void withoutTouching(callable $callback)

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

Parameters

callable $callback

Return Value

void

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

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

Parameters

array $models
callable $callback

Return Value

void

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

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

Parameters

string|null $class

Return Value

bool

$this fill(array $attributes)

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

Parameters

array $attributes

Return Value

$this

Exceptions

MassAssignmentException

$this forceFill(array $attributes)

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

Parameters

array $attributes

Return Value

$this

string qualifyColumn(string $column)

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

Parameters

string $column

Return Value

string

protected string removeTableFromKey(string $key) deprecated

deprecated

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

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

Parameters

string $key

Return Value

string

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

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

Parameters

array $attributes
bool $exists

Return Value

Модель

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

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

Parameters

array $attributes
string|null $connection

Return Value

Модель

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

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

Parameters

string|null $connection

Return Value

Библиотека

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

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

Return Value

Библиотека

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

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

Parameters

array|mixed $columns

Return Value

Collection|Model[]

static Builder with(array|string $relations)

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

Parameters

array|string $relations

Return Value

Builder

$this load(array|string $relations)

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

Parameters

array|string $relations

Return Value

$this

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

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

Parameters

string $relation
array $relations

Return Value

$this

$this loadMissing(array|string $relations)

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

Parameters

array|string $relations

Return Value

$this

$this loadCount(array|string $relations)

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

Parameters

array|string $relations

Return Value

$this

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

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

Parameters

string $relation
array $relations

Return Value

$this

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

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

Parameters

string $column
float|int $amount
array $extra

Return Value

int

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

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

Parameters

string $column
float|int $amount
array $extra

Return Value

int

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

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

Parameters

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

Return Value

int

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

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

Parameters

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

Return Value

void

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

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

Parameters

array $attributes
array $options

Return Value

bool

bool push()

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

Return Value

bool

bool save(array $options = [])

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

Parameters

array $options

Return Value

bool

bool saveOrFail(array $options = [])

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

Parameters

array $options

Return Value

bool

Exceptions

Throwable

protected void finishSave(array $options)

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

Parameters

array $options

Return Value

void

protected bool performUpdate(Builder $query)

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

Parameters

Builder $query

Return Value

bool

protected Builder setKeysForSaveQuery(Builder $query)

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

Parameters

Builder $query

Return Value

Builder

protected mixed getKeyForSaveQuery()

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

Return Value

mixed

protected bool performInsert(Builder $query)

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

Параметры

Builder $query

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

bool

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

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

Параметры

Builder $query
array $attributes

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

void

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

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

Параметры

Collection|array|int|string $ids

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

int

bool|null delete()

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

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

bool|null

Исключения

Exception

bool|null forceDelete()

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

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

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

bool|null

protected void performDeleteOnModel()

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

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

void

static Builder query()

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

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

Builder

Builder newQuery()

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

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

Builder

Builder|Model newModelQuery()

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

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

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

Collection newCollection(array $models = [])

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

Параметры

array $models

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

Collection
END_OF_DOCUMENT_MARKER

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

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

Параметры

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

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

Pivot

bool hasNamedScope(string $scope)

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

Параметры

string $scope

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

bool

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

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

Параметры

string $scope
array $parameters

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

mixed

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

строка getKeyName()

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

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

строка

$this setKeyName(string $key)

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

Параметры

строка $key

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

$this

строка getQualifiedKeyName()

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

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

строка

строка getKeyType()

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

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

строка

$this setKeyType(string $type)

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

Параметры

строка $type

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

$this

bool getIncrementing()

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

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

bool

$this setIncrementing(bool $value)

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

Параметры

bool $value

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

$this

mixed getKey()

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

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

mixed

mixed getQueueableId()

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

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

mixed

массив getQueueableRelations()

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

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

массив

строка|null getQueueableConnection()

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

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

строка|null

mixed getRouteKey()

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

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

mixed

строка getRouteKeyName()

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

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

строка

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

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

Параметры

mixed $value
строка|null $field

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

Модель|null

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

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

Параметры

строка $childType
mixed $value
строка|null $field

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

Модель|null

строка getForeignKey()

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

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

строка

целое число getPerPage()

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

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

целое число

$this setPerPage(int $perPage)

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

Параметры

целое число $perPage

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

$this

mixed __get(string $key)

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

Параметры

строка $key

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

mixed

void __set(string $key, mixed $value)

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

Параметры

строка $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)

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

Параметры

строка $key

Значение возврата

bool

void __unset(string $key)

Удалить атрибут в модели.

Parameters

string $key

Return Value

void

mixed __call(string $method, array $parameters)

Обработать динамические вызовы методов в модели.

Parameters

string $method
array $parameters

Return Value

mixed

static mixed __callStatic(string $method, array $parameters)

Обработать динамические статические вызовы методов в модели.

Parameters

string $method
array $parameters

Return Value

mixed

string __toString()

Преобразовать модель в строковое представление.

Return Value

string

array __sleep()

Подготовить объект к сериализации.

Return Value

array

void __wakeup()

При десериализации модели, проверить, требуется ли её загрузка.

Return Value

void

string getAuthIdentifierName()

Получить имя уникального идентификатора пользователя.

Return Value

string

mixed getAuthIdentifier()

Получить уникальный идентификатор пользователя.

Return Value

mixed

string getAuthPassword()

Получить пароль пользователя.

Return Value

string

string|null getRememberToken()

Получить значение токена для сессии «запомнить меня».

Return Value

string|null

void setRememberToken(string $value)

Установить значение токена для сессии «запомнить меня».

Parameters

string $value

Return Value

void

string getRememberTokenName()

Получить имя столбца для токена «запомнить меня».

Return Value

string

bool can(iterable|string $abilities, array|mixed $arguments = [])

Определить, обладает ли сущность заданными возможностями.

Parameters

iterable|string $abilities
array|mixed $arguments

Return Value

bool

bool cant(iterable|string $abilities, array|mixed $arguments = [])

Определить, не обладает ли сущность заданными возможностями.

Parameters

iterable|string $abilities
array|mixed $arguments

Return Value

bool

bool cannot(iterable|string $abilities, array|mixed $arguments = [])

Определить, не обладает ли сущность заданными возможностями.

Parameters

iterable|string $abilities
array|mixed $arguments

Return Value

bool

string getEmailForPasswordReset()

Получить адрес электронной почты для отправки ссылок на сброс пароля.

Return Value

string

void sendPasswordResetNotification(string $token)

Отправить уведомление о сбросе пароля.

Parameters

string $token

Return Value

void

bool hasVerifiedEmail()

Определить, подтвержден ли адрес электронной почты пользователя.

Return Value

bool

bool markEmailAsVerified()

Пометить адрес электронной почты пользователя как подтвержденный.

Return Value

bool

void sendEmailVerificationNotification()

Отправить уведомление о подтверждении адреса электронной почты.

Return Value

void

string getEmailForVerification()

Получить адрес электронной почты, который следует использовать для проверки.

Return Value

string

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/7.x/Illuminate/Foundation/Auth/User.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API