Spec-Zone.ru › Laravel 5.6

Модель

класс Модель реализует ArrayAccess, Arrayable, Jsonable, JsonSerializable, QueueableEntity, UrlRoutable (Просмотреть исходный код)

Трейты

HasAttributes
HasEvents
HasGlobalScopes
HasRelationships
HasTimestamps
HidesAttributes
GuardsAttributes

Константы

CREATED_AT

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

UPDATED_AT

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

Свойства

protected array $attributes Атрибуты модели. из HasAttributes
protected array $original Исходное состояние атрибутов модели. из HasAttributes
protected array $changes Изменённые атрибуты модели. из HasAttributes
protected array $casts Атрибуты, которые должны быть преобразованы к собственным типам. из HasAttributes
protected array $dates Атрибуты, которые должны быть преобразованы в даты. из HasAttributes
protected string $dateFormat Формат хранения столбцов даты модели. из HasAttributes
protected array $appends Доступные методы для добавления к массивной форме модели. из HasAttributes
static bool $snakeAttributes Указывает, преобразуются ли атрибуты в snake_case в массивах. из HasAttributes
static protected array $mutatorCache Кэш мутированных атрибутов для каждого класса. из HasAttributes
protected array $dispatchesEvents Схема событий для модели. из HasEvents
protected array $observables Экспонируемые пользователем наблюдаемые события. из HasEvents
protected array $relations Загруженные отношения для модели. из HasRelationships
protected array $touches Отношения, которые должны быть изменены при сохранении. из HasRelationships
static array $manyMethods Методы для многих-ко-многим отношений. из HasRelationships
bool $timestamps Указывает, должна ли модель иметь метки времени. из HasTimestamps
protected array $hidden Атрибуты, которые должны быть скрыты при сериализации. из HidesAttributes
protected array $visible Атрибуты, которые должны быть видны при сериализации. из HidesAttributes
protected array $fillable Атрибуты, которые можно массово назначать. из GuardsAttributes
protected array $guarded Атрибуты, которые нельзя массово назначать. из GuardsAttributes
static protected bool $unguarded Указывает, разрешена ли вся массовая привязка. из GuardsAttributes
protected string $connection Имя подключения для модели.
protected string $table Таблица, связанная с моделью.
protected string $primaryKey Первичный ключ для модели.
protected string $keyType Тип автоинкрементируемого ID.
bool $incrementing Указывает, являются ли ID автоинкрементируемыми.
protected array $with Отношения, которые нужно загружать при каждом запросе.
protected array $withCount Счетчики отношений, которые нужно загружать при каждом запросе.
protected int $perPage Количество моделей для возврата при постраничном отображении.
bool $exists Указывает, существует ли модель.
bool $wasRecentlyCreated Указывает, была ли модель вставлена во время текущего цикла запроса.
static protected ConnectionResolverInterface $resolver Экземпляр разрешителя подключений.
static protected Dispatcher $dispatcher Экземпляр диспетчера событий.
static protected array $booted Массив запущенных моделей.
static protected array $globalScopes Массив глобальных областей видимости модели.
static protected array $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
boolean hasGetMutator(строка $key)

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

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

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

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

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

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

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

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

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

из HasAttributes
boolean isCustomDateTimeCast(строка $cast)

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

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

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

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

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

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

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

из HasAttributes
boolean 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
смешанный fromJson(string $value, bool $asObject = false)

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

из HasAttributes
Carbon asDate(mixed $value)

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

из HasAttributes
Carbon asDateTime(mixed $value)

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

из HasAttributes
bool isStandardDateFormat(string $value)

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

из HasAttributes
string fromDateTime(DateTime|int $value)

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

из HasAttributes
int asTimestamp(mixed $value)

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

из HasAttributes
string serializeDate(DateTimeInterface $date)

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

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

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

из HasAttributes
строка getDateFormat()

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

из HasAttributes
$this setDateFormat(string $format)

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

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

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

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

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

из HasAttributes
bool isDateCastable(string $key)

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

из HasAttributes
bool isJsonCastable(string $key)

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

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

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

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

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

из HasAttributes
смешанный|массив getOriginal(string|null $key = null, mixed $default = null)

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

из HasAttributes
массив only(array|mixed $attributes)

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

из HasAttributes
$this syncOriginal()

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

из HasAttributes
$this syncOriginalAttribute(string $attribute)

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

из HasAttributes
$this syncChanges()

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

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

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

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

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

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

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

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

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

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

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

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

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

из HasAttributes
bool originalIsEquivalent(string $key, mixed $current)

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

из HasAttributes
$this append(array|string $attributes)

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

из HasAttributes
$this setAppends(array $appends)

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

from HasAttributes
array getMutatedAttributes()

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

from HasAttributes
static void cacheMutatedAttributes(string $class)

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

from HasAttributes
static array getMutatorMethods(mixed $class)

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

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

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

from HasEvents
void registerObserver(object|string $class)

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

from HasEvents
array getObservableEvents()

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

from HasEvents
$this setObservableEvents(array $observables)

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

from HasEvents
void addObservableEvents(array|mixed $observables)

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

from HasEvents
void removeObservableEvents(array|mixed $observables)

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

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

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

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

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

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

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

from HasEvents
mixed filterModelEventResults(mixed $result)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

from HasEvents
static void 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 addGlobalScope(Scope|Closure|string $scope, Closure $implementation = null)

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

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

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

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

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

from HasGlobalScopes
array getGlobalScopes()

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

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

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

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

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

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)

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

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

Угадать имя отношения "belongs to".

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

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

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

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

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

Определить отношение 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 $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)

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

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

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

из HasTimestamps
строка freshTimestampString()

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

из HasTimestamps
логическое значение usesTimestamps()

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

из HasTimestamps
строка getCreatedAtColumn()

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

из HasTimestamps
строка getUpdatedAtColumn()

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

из HasTimestamps
массив getHidden()

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

из HidesAttributes
$this setHidden(array $hidden)

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

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

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

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

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

из HidesAttributes
$this setVisible(array $visible)

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

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

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

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

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

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

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

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

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

из GuardsAttributes
$this fillable(array $fillable)

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

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

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

из GuardsAttributes
$this guard(array $guarded)

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

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

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

из GuardsAttributes
static void reguard()

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

из GuardsAttributes
static логическое значение isUnguarded()

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

из GuardsAttributes
static mixed unguarded(callable $callback)

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

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

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

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

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

из GuardsAttributes
логическое значение totallyGuarded()

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

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

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

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

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

void bootIfNotBooted()

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

static void boot()

Метод "booting" модели.

static void bootTraits()

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

static void clearBootedModels()

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

static void withoutTouching(callable $callback)

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

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

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

static логическое значение 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()

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

Билдер newQueryWithoutRelationships()

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

Билдер registerGlobalScopes(Билдер $builder)

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

Билдер|Модель newQueryWithoutScopes()

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

Билдер newQueryWithoutScope(Scope|string $scope)

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

Билдер newQueryForRestoration(array|int $ids)

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

Билдер|Модель newEloquentBuilder(Билдер $query)

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

Билдер newBaseQueryBuilder()

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

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

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

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

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

массив toArray()

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

строка toJson(int $options)

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

массив jsonSerialize()

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

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

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

$this refresh()

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

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

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

булево is(Модель|null $model)

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

булево isNot(Модель|null $model)

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

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

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

строка getConnectionName()

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

$this setConnection(string $name)

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

статический Подключение resolveConnection(string|null $connection = null)

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

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

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

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

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

статический void unsetConnectionResolver()

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

строка getTable()

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

$this setTable(string $table)

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

строка getKeyName()

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

$this setKeyName(string $key)

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

строка getQualifiedKeyName()

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

строка getKeyType()

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

$this setKeyType(string $type)

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

булево getIncrementing()

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

$this setIncrementing(bool $value)

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

смешанный getKey()

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

смешанный getQueueableId()

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

массив getQueueableRelations()

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

строка|null getQueueableConnection()

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

смешанный getRouteKey()

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

строка getRouteKeyName()

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

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

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

строка getForeignKey()

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

целое getPerPage()

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

$this setPerPage(int $perPage)

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

смешанный __get(string $key)

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

void __set(string $key, mixed $value)

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

булево offsetExists(mixed $offset)

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

смешанный offsetGet(mixed $offset)

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

void offsetSet(mixed $offset, mixed $value)

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

void offsetUnset(mixed $offset)

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

булево __isset(string $key)

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

void __unset(string $key)

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

смешанный __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)

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

Параметры

string $key

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

bool

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

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

Параметры

string $key
mixed $value

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

mixed

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

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

Параметры

string $key
mixed $value

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

mixed

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

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

Параметры

string $key
mixed $value

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

mixed

protected string getCastType(string $key)

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

Параметры

string $key

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

string

protected bool isCustomDateTimeCast(string $cast)

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

Параметры

string $cast

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

bool

mixed setAttribute(string $key, mixed $value)

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

Параметры

string $key
mixed $value

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

mixed

bool hasSetMutator(string $key)

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

Параметры

string $key

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

bool

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

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

Параметры

string $key
mixed $value

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

mixed

protected bool isDateAttribute(string $key)

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

Параметры

string $key

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

bool

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

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

Параметры

string $key
mixed $value

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

$this

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

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

Параметры

string $path
string $key
mixed $value

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

$this

protected array getArrayAttributeByKey(string $key)

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

Параметры

string $key

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

array

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

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

Параметры

string $key
mixed $value

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

string

protected string asJson(mixed $value)

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

Параметры

mixed $value

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

string

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

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

Параметры

string $value
bool $asObject

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

mixed

protected Carbon asDate(mixed $value)

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

Параметры

mixed $value

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

Carbon

protected Carbon asDateTime(mixed $value)

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

Параметры

mixed $value

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

Carbon

protected bool isStandardDateFormat(string $value)

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

Параметры

string $value

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

bool

string fromDateTime(DateTime|int $value)

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

Параметры

DateTime|int $value

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

string

protected int asTimestamp(mixed $value)

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

Параметры

mixed $value

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

int

protected string serializeDate(DateTimeInterface $date)

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

Параметры

DateTimeInterface $date

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

string

array getDates()

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

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

array

string getDateFormat()

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

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

string

$this setDateFormat(string $format)

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

Параметры

string $format

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

$this

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

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

Параметры

string $key
array|string|null $types

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

bool

array getCasts()

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

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

array

protected bool isDateCastable(string $key)

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

Параметры

string $key

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

bool

protected bool isJsonCastable(string $key)

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

Параметры

string $key

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

bool

array getAttributes()

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

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

array

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

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

Параметры

array $attributes
bool $sync

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

$this

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

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

Параметры

string|null $key
mixed $default

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

mixed|array

array only(array|mixed $attributes)

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

Параметры

array|mixed $attributes

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

array

$this syncOriginal()

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

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

$this

$this syncOriginalAttribute(string $attribute)

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

Параметры

string $attribute

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

$this

$this syncChanges()

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

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

$this

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

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

Параметры

array|string|null $attributes

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

bool

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

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

Параметры

array|string|null $attributes

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

bool

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

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

Параметры

array|string|null $attributes

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

bool

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

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

Параметры

array $changes
array|string|null $attributes

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

bool

array getDirty()

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

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

array

array getChanges()

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

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

array

protected bool originalIsEquivalent(string $key, mixed $current)

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

Параметры

string $key
mixed $current

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

bool

$this append(array|string $attributes)

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

Параметры

array|string $attributes

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

$this

$this setAppends(array $appends)

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

Параметры

array $appends

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

$this

array getMutatedAttributes()

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

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

array

static void cacheMutatedAttributes(string $class)

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

Параметры

string $class

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

void

static protected array getMutatorMethods(mixed $class)

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

Параметры

mixed $class

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

array

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

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

Параметры

object|array|string $classes

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

void

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)

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

Параметры

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

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

BelongsTo

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
END_OF_DOCUMENT_MARKER

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

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

Parameters

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

Return Value

MorphTo

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

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

Parameters

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

Return Value

MorphTo

static string getActualClassNameForMorph(string $class)

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

Parameters

string $class

Return Value

string

protected string guessBelongsToRelation()

Угадать имя отношения "belongs to".

Return Value

string

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

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

Parameters

string $related
string $foreignKey
string $localKey

Return Value

HasMany

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

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

Parameters

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

Return Value

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.

Parameters

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

Return Value

HasManyThrough

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

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

Parameters

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

Return Value

HasManyThrough

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

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

Parameters

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

Return Value

MorphMany

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

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

Parameters

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

Return Value

MorphMany

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

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

Parameters

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

Return Value

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

Получить имя отношения belongs to many.

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

string

string joiningTable(string $related)

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

Параметры

string $related

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

string

bool touches(string $relation)

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

Параметры

string $relation

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

bool

void touchOwners()

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

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

void

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

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

Параметры

string $name
string $type
string $id

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

array

string getMorphClass()

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

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

string

protected mixed newRelatedInstance(string $class)

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

Параметры

string $class

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

mixed

array getRelations()

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

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

array

mixed getRelation(string $relation)

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

Параметры

string $relation

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

mixed

bool relationLoaded(string $key)

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

Параметры

string $key

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

bool

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

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

Параметры

string $relation
mixed $value

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

$this

$this unsetRelation(string $relation)

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

Параметры

string $relation

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

$this

$this setRelations(array $relations)

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

Параметры

array $relations

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

$this

array getTouchedRelations()

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

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

array

$this setTouchedRelations(array $touches)

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

Параметры

array $touches

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

$this

bool touch()

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

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

bool

protected void updateTimestamps()

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

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

void

$this setCreatedAt(mixed $value)

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

Параметры

mixed $value

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

$this

$this setUpdatedAt(mixed $value)

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

Параметры

mixed $value

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

$this

Carbon freshTimestamp()

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

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

Carbon

string freshTimestampString()

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

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

string

bool usesTimestamps()

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

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

bool

string getCreatedAtColumn()

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

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

string

string getUpdatedAtColumn()

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

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

string

array getHidden()

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

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

array

$this setHidden(array $hidden)

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

Параметры

array $hidden

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

$this

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

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

Параметры

array|string|null $attributes

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

void

array getVisible()

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

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

array

$this setVisible(array $visible)

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

Параметры

array $visible

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

$this

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

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

Параметры

array|string|null $attributes

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

void

$this makeVisible(array|string $attributes)

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

Параметры

array|string $attributes

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

$this

$this makeHidden(array|string $attributes)

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

Параметры

array|string $attributes

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

$this

array getFillable()

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

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

array

$this fillable(array $fillable)

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

Параметры

array $fillable

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

$this

array getGuarded()

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

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

array

$this guard(array $guarded)

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

Параметры

array $guarded

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

$this

static void unguard(bool $state = true)

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

Параметры

bool $state

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

void

static void reguard()

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

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

void

static bool isUnguarded()

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

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

bool

static mixed unguarded(callable $callback)

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

Параметры

callable $callback

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

mixed

bool isFillable(string $key)

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

Параметры

string $key

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

bool

bool isGuarded(string $key)

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

Параметры

string $key

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

bool

bool totallyGuarded()

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

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

bool

protected array fillableFromArray(array $attributes)

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

Параметры

array $attributes

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

array

void __construct(array $attributes = [])

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

Параметры

array $attributes

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

void

protected void bootIfNotBooted()

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

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

void

static protected void boot()

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

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

void

static protected void bootTraits()

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

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

void

static void clearBootedModels()

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

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

void

static void withoutTouching(callable $callback)

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

Параметры

callable $callback

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

void

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

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

Параметры

array $models
callable $callback

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

void

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

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

Параметры

string|null $class

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

bool

$this fill(array $attributes)

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

Параметры

array $attributes

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

$this

Исключения

MassAssignmentException

$this forceFill(array $attributes)

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

Параметры

array $attributes

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

$this

string qualifyColumn(string $column)

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

Параметры

string $column

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

string

protected string removeTableFromKey(string $key)

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

Параметры

string $key

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

string

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

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

Параметры

array $attributes
bool $exists

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

Модель

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

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

Параметры

array $attributes
string|null $connection

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

Модель

static Билдер on(string|null $connection = null)

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

Параметры

string|null $connection

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

Билдер

static Билдер onWriteConnection()

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

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

Билдер
END_OF_DOCUMENT_MARKER

static Collection|Модель[] all(array|mixed $columns = ['*'])

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

Parameters

array|mixed $columns

Return Value

Collection|Модель[]

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

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

Parameters

array|string $relations

Return Value

Билдер|Модель

$this load(array|string $relations)

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

Parameters

array|string $relations

Return Value

$this

$this loadMissing(array|string $relations)

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

Parameters

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

Исключение

protected void finishSave(array $options)

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

Parameters

array $options

Return Value

void

protected bool performUpdate(Билдер $query)

Выполнить обновление модели.

Parameters

Билдер $query

Return Value

bool

protected Билдер setKeysForSaveQuery(Билдер $query)

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

Parameters

Билдер $query

Return Value

Билдер

protected mixed getKeyForSaveQuery()

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

Return Value

mixed

protected bool performInsert(Билдер $query)

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

Parameters

Билдер $query

Return Value

bool

protected void insertAndSetId(Билдер $query, array $attributes)

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

Parameters

Билдер $query
array $attributes

Return Value

void

static int destroy(array|int $ids)

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

Parameters

array|int $ids

Return Value

int
END_OF_DOCUMENT_MARKER

bool|null delete()

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

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

bool|null

Исключения

Исключение

bool|null forceDelete()

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

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

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

bool|null

protected void performDeleteOnModel()

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

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

void

static Builder query()

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

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

Builder

Builder newQuery()

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

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

Builder

Builder|Модель newModelQuery()

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

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

Builder|Модель

Builder newQueryWithoutRelationships()

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

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

Builder

Builder registerGlobalScopes(Builder $builder)

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

Параметры

Builder $builder

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

Builder

Builder|Модель newQueryWithoutScopes()

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

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

Builder|Модель

Builder newQueryWithoutScope(Область|string $scope)

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

Параметры

Область|string $scope

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

Builder

Builder newQueryForRestoration(array|int $ids)

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

Параметры

array|int $ids

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

Builder

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)

Преобразовать экземпляр модели в 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)

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

Параметры

массив $except

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

Модель

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

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

Параметры

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

строка getRouteKeyName()

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

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

строка

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

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

Параметры

mixed $value

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

Модель|null

строка getForeignKey()

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

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

строка

целое число getPerPage()

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

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

целое число

$this setPerPage(int $perPage)

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

Параметры

целое число $perPage

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

$this

смешанное __get(string $key)

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

Параметры

строка $key

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

смешанное

пусто __set(string $key, mixed $value)

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

Параметры

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

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

пусто

логическое значение offsetExists(mixed $offset)

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

Параметры

смешанное $offset

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

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

смешанное offsetGet(mixed $offset)

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

Параметры

смешанное $offset

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

смешанное

пусто offsetSet(mixed $offset, mixed $value)

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

Параметры

смешанное $offset
смешанное $value

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

пусто

пусто offsetUnset(mixed $offset)

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

Параметры

смешанное $offset

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

пусто

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

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

Параметры

строка $key

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

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

пусто __unset(string $key)

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

Параметры

строка $key

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

пусто

смешанное __call(string $method, array $parameters)

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

Параметры

строка $method
массив $parameters

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

смешанное

статический смешанное __callStatic(string $method, array $parameters)

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

Параметры

строка $method
массив $parameters

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

смешанное

строка __toString()

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

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

строка

пусто __wakeup()

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

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

пусто

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

Spec-Zone.ru

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