Spec-Zone.ru › Laravel 5.5

Pivot

class Pivot extends Model (View source)

Особенности

HasAttributes
HasEvents
HasGlobalScopes
HasRelationships
HasTimestamps
HidesAttributes
GuardsAttributes

Константы

CREATED_AT

Имя столбца "created at".

UPDATED_AT

Имя столбца "updated at".

Свойства

protected массив $attributes Атрибуты модели. из HasAttributes
protected массив $original Исходное состояние атрибутов модели. из HasAttributes
protected массив $changes Изменённые атрибуты модели. из HasAttributes
protected массив $casts Атрибуты, которые следует преобразовать в базовые типы. из HasAttributes
protected массив $dates Атрибуты, которые следует преобразовать в даты. из HasAttributes
protected строка $dateFormat Формат хранения столбцов даты модели. из HasAttributes
protected массив $appends Обработчики для добавления к массиву модели. из HasAttributes
static bool $snakeAttributes Указывает, являются ли атрибуты в массивах в формате snake_case. из HasAttributes
static protected массив $mutatorCache Кэш изменённых атрибутов для каждого класса. из HasAttributes
protected массив $dispatchesEvents Карта событий для модели. из HasEvents
protected массив $observables Экспонируемые пользователем наблюдаемые события. из HasEvents
protected массив $relations Загруженные отношения для модели. из HasRelationships
protected массив $touches Отношения, которые следует обновлять при сохранении. из HasRelationships
static массив $manyMethods Методы отношений many-to-many. из HasRelationships
bool $timestamps Указывает, должна ли модель иметь временные метки. из HasTimestamps
protected массив $hidden Атрибуты, которые следует скрывать при сериализации. из HidesAttributes
protected массив $visible Атрибуты, которые должны быть видимы при сериализации. из HidesAttributes
protected массив $fillable Атрибуты, которые можно массово назначать. из GuardsAttributes
protected массив $guarded Атрибуты, которые нельзя массово назначать.
static protected bool $unguarded Указывает, разрешены ли все массовые назначения. из GuardsAttributes
protected строка $connection Имя подключения для модели. из Model
protected строка $table Таблица, связанная с моделью. из Model
protected строка $primaryKey Первичный ключ для модели. из Model
protected строка $keyType Тип автоинкрементируемого идентификатора. из Model
bool $incrementing Указывает, являются ли идентификаторы автоинкрементируемыми. из Model
protected массив $with Отношения, которые следует загрузить жадно при каждом запросе. из Model
protected массив $withCount Счетчики отношений, которые следует загрузить жадно при каждом запросе. из Model
protected целое число $perPage Количество моделей, возвращаемых для пагинации. из Model
bool $exists Указывает, существует ли модель. из Model
bool $wasRecentlyCreated Указывает, была ли модель вставлена во время текущего цикла запроса. из Model
static protected ConnectionResolverInterface $resolver Экземпляр резолвера подключений. из Model
static protected Dispatcher $dispatcher Экземпляр диспетчера событий. из Model
static protected массив $booted Массив запущенных моделей. из Model
static protected массив $globalScopes Массив глобальных скопов модели. из Model
Модель $pivotParent Родительская модель отношения.
protected строка $foreignKey Имя столбца внешнего ключа.
protected строка $relatedKey Имя столбца «другого» ключа.

Методы

array attributesToArray()

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

from HasAttributes
array addDateAttributesToArray(array $attributes)

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

from HasAttributes
array addMutatedAttributesToArray(array $attributes, array $mutatedAttributes)

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

from HasAttributes
array addCastAttributesToArray(array $attributes, array $mutatedAttributes)

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

from HasAttributes
array getArrayableAttributes()

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

from HasAttributes
array getArrayableAppends()

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

from HasAttributes
array relationsToArray()

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

from HasAttributes
array getArrayableRelations()

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

from HasAttributes
array getArrayableItems(array $values)

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

from HasAttributes
mixed getAttribute(string $key)

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

from HasAttributes
mixed getAttributeValue(string $key)

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

from HasAttributes
mixed getAttributeFromArray(string $key)

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

from HasAttributes
mixed getRelationValue(string $key)

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

from HasAttributes
mixed getRelationshipFromMethod(string $method)

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

from HasAttributes
bool hasGetMutator(string $key)

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

from HasAttributes
mixed mutateAttribute(string $key, mixed $value)

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

from HasAttributes
mixed mutateAttributeForArray(string $key, mixed $value)

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

from HasAttributes
mixed castAttribute(string $key, mixed $value)

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

from HasAttributes
string getCastType(string $key)

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

from HasAttributes
$this setAttribute(string $key, mixed $value)

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

from HasAttributes
bool hasSetMutator(string $key)

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

from HasAttributes
bool isDateAttribute(string $key)

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

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

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

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

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

from HasAttributes
array getArrayAttributeByKey(string $key)

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

from HasAttributes
string castAttributeAsJson(string $key, mixed $value)

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

from HasAttributes
string asJson(mixed $value)

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

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

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

from HasAttributes
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
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
array getAttributes()

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

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

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

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

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

из HasAttributes
array 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
array getDirty()

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

из HasAttributes
array getChanges()

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

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

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

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

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

из HasAttributes
$this setAppends(array $appends)

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

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

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

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

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

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

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

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

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

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

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

из HasEvents
$this setObservableEvents(array $observables)

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

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

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

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

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

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

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

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

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

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

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

из HasEvents
mixed filterModelEventResults(mixed $result)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

из HasEvents
статический mixed addGlobalScope(Scope|Closure|string $scope, Closure $implementation = null)

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

из HasGlobalScopes
статический bool hasGlobalScope(Scope|string $scope)

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

из 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
MorphOne morphOne(string $related, string $name, string $type = null, string $id = null, string $localKey = null)

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

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

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

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

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

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

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

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

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

from HasRelationships
static string getActualClassNameForMorph(string $class)

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

from HasRelationships
string guessBelongsToRelation()

Предположение имени связи «принадлежит к».

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

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

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

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

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

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

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
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 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 setRelations(array $relations)

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

from HasRelationships
array getTouchedRelations()

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

from HasRelationships
$this setTouchedRelations(array $touches)

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

from HasRelationships
bool touch()

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

from HasTimestamps
void updateTimestamps()

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

from HasTimestamps
$this setCreatedAt(mixed $value)

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

from HasTimestamps
$this setUpdatedAt(mixed $value)

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

from HasTimestamps
Carbon freshTimestamp()

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

from HasTimestamps
string freshTimestampString()

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

from HasTimestamps
bool usesTimestamps()

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

from HasTimestamps
string getCreatedAtColumn()

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

string getUpdatedAtColumn()

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

array getHidden()

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

from HidesAttributes
$this setHidden(array $hidden)

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

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

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

from HidesAttributes
array getVisible()

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

from HidesAttributes
$this setVisible(array $visible)

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

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

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

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

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

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

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

from HidesAttributes
array getFillable()

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

from GuardsAttributes
$this fillable(array $fillable)

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

from GuardsAttributes
array getGuarded()

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

from GuardsAttributes
$this guard(array $guarded)

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

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

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

from GuardsAttributes
static void reguard()

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

from GuardsAttributes
static bool isUnguarded()

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

from GuardsAttributes
static mixed unguarded(callable $callback)

Выполнить заданный вызов, не используя защиту.

from GuardsAttributes
bool isFillable(string $key)

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

from GuardsAttributes
bool isGuarded(string $key)

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

from GuardsAttributes
bool totallyGuarded()

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

from GuardsAttributes
array fillableFromArray(array $attributes)

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

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

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

from Model
void bootIfNotBooted()

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

from Model
static void boot()

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

from Model
static void bootTraits()

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

from Model
static void clearBootedModels()

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

from Model
$this fill(array $attributes)

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

from Model
$this forceFill(array $attributes)

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

from Model
string removeTableFromKey(string $key)

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

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

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

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

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

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

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

from Model
static Builder onWriteConnection()

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

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

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

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

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

from Model
$this load(array|string $relations)

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

from Model
$this loadMissing(array|string $relations)

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

from Model
int increment(string $column, int $amount = 1, array $extra = [])

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

from Model
int decrement(string $column, int $amount = 1, array $extra = [])

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

from Model
int incrementOrDecrement(string $column, int $amount, array $extra, string $method)

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

from Model
void incrementOrDecrementAttributeValue(string $column, int $amount, array $extra, string $method)

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

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

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

from Model
bool push()

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

from Model
bool save(array $options = [])

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

from Model
bool saveOrFail(array $options = [])

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

from Model
void finishSave(array $options)

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

from Model
bool performUpdate(Builder $query)

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

from Model
Builder setKeysForSaveQuery(Builder $query)

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

mixed getKeyForSaveQuery()

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

из Модель
bool performInsert(Builder $query)

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

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

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

из Модель
static int destroy(array|int $ids)

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

из Модель
bool|null delete()

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

bool|null forceDelete()

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

из Модель
void performDeleteOnModel()

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

из Модель
static Builder query()

Начать получение данных модели.

из Модель
Builder newQuery()

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

из Модель
Builder|Модель newQueryWithoutScopes()

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

из Модель
Builder newQueryWithoutScope(Scope|string $scope)

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

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

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

из Модель
Builder newBaseQueryBuilder()

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

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

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

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

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

из Модель
array toArray()

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

из Модель
string toJson(int $options)

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

из Модель
array jsonSerialize()

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

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

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

из Модель
$this refresh()

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

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

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

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

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

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

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

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

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

из Модель
string getConnectionName()

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

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

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

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

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

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

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

из Модель
static void setConnectionResolver(ConnectionResolverInterface $resolver)

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

from Model
static void unsetConnectionResolver()

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

from Model
string getTable()

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

$this setTable(string $table)

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

from Model
string getKeyName()

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

from Model
$this setKeyName(string $key)

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

from Model
string getQualifiedKeyName()

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

from Model
string getKeyType()

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

from Model
$this setKeyType(string $type)

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

from Model
bool getIncrementing()

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

from Model
$this setIncrementing(bool $value)

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

from Model
mixed getKey()

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

from Model
mixed getQueueableId()

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

from Model
string|null getQueueableConnection()

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

from Model
mixed getRouteKey()

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

from Model
string getRouteKeyName()

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

from Model
Model|null resolveRouteBinding(mixed $value)

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

from Model
string getForeignKey()

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

int getPerPage()

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

from Model
$this setPerPage(int $perPage)

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

from Model
mixed __get(string $key)

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

from Model
void __set(string $key, mixed $value)

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

from Model
bool offsetExists(mixed $offset)

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

from Model
mixed offsetGet(mixed $offset)

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

from Model
void offsetSet(mixed $offset, mixed $value)

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

from Model
void offsetUnset(mixed $offset)

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

from Model
bool __isset(string $key)

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

from Model
void __unset(string $key)

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

from Model
mixed __call(string $method, array $parameters)

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

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

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

from Model
string __toString()

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

from Model
void __wakeup()

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

from Model
static Pivot fromAttributes(Model $parent, array $attributes, string $table, bool $exists = false)

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

static Pivot fromRawAttributes(Model $parent, array $attributes, string $table, bool $exists = false)

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

Builder getDeleteQuery()

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

строка getRelatedKey()

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

строка getOtherKey()

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

$this setPivotKeys(строка $foreignKey, строка $relatedKey)

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

булево hasTimestampAttributes()

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

Подробности

массив attributesToArray()

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

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

массив

protected массив addDateAttributesToArray(массив $attributes)

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

Параметры

массив $attributes

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

массив

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

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

Параметры

массив $attributes
массив $mutatedAttributes

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

массив

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

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

Параметры

массив $attributes
массив $mutatedAttributes

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

массив

protected массив getArrayableAttributes()

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

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

массив

protected массив getArrayableAppends()

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

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

массив

массив relationsToArray()

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

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

массив

protected массив getArrayableRelations()

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

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

массив

protected массив getArrayableItems(массив $values)

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

Параметры

массив $values

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

массив

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

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

Параметры

строка $key

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

смешанное

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

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

Параметры

строка $key

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

смешанное

protected смешанное getAttributeFromArray(строка $key)

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

Параметры

строка $key

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

смешанное

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

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

Параметры

строка $key

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

смешанное

protected смешанное getRelationshipFromMethod(строка $method)

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

Параметры

строка $method

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

смешанное

Исключения

LogicException

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

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

Параметры

строка $key

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

логическое

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

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

Параметры

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

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

смешанное

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

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

Параметры

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

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

смешанное

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

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

Параметры

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

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

смешанное

protected строка getCastType(строка $key)

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

Параметры

строка $key

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

строка

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

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

Параметры

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

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

$this

bool hasSetMutator(string $key)

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

Параметры

string $key

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

bool

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

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

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

Параметры

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

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

$this

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

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

Параметры

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

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

mixed|array

array only(array|mixed $attributes)

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

Параметры

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

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

Массив

$this syncOriginal()

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

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

$this

$this syncOriginalAttribute(string $attribute)

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

Параметры

Строка $attribute

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

$this

$this syncChanges()

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

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

$this

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

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

Параметры

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

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

bool

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

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

Параметры

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

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

bool

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

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

Параметры

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

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

bool

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

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

Параметры

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

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

bool

array getDirty()

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

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

Массив

array getChanges()

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

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

Массив

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

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

Параметры

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

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

bool

$this append(array|string $attributes)

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

Параметры

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

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

$this

$this setAppends(array $appends)

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

Параметры

Массив $appends

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

$this

array getMutatedAttributes()

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

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

Массив

static void cacheMutatedAttributes(string $class)

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

Параметры

Строка $class

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

void

static protected array getMutatorMethods(mixed $class)

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

Параметры

Смешанное $class

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

Массив

static void observe(object|string $class)

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

Параметры

Объект|Строка $class

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

void

array getObservableEvents()

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

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

Массив

$this setObservableEvents(array $observables)

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

Параметры

Массив $observables

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

$this

void addObservableEvents(array|mixed $observables)

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

Параметры

Массив|Смешанное $observables

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

void

void removeObservableEvents(array|mixed $observables)

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

Параметры

Массив|Смешанное $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|Closure|string $scope
Closure $implementation

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

mixed

Исключения

InvalidArgumentException

статический bool hasGlobalScope(Scope|string $scope)

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

Параметры

Scope|string $scope

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

bool

статический Scope|Closure|null getGlobalScope(Scope|string $scope)

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

Параметры

Scope|string $scope

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

Scope|Closure|null

массив getGlobalScopes()

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

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

массив

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

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

Параметры

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

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

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

Параметры

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

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

BelongsTo

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

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

Параметры

string $name
string $type
string $id

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

MorphTo

защищенное MorphTo morphEagerTo(string $name, string $type, string $id)

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

Параметры

string $name
string $type
string $id

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

MorphTo

защищенное MorphTo morphInstanceTo(string $target, string $name, string $type, string $id)

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

Параметры

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

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

MorphTo

статический string getActualClassNameForMorph(string $class)

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

Параметры

string $class

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

string

защищенное string guessBelongsToRelation()

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

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

string

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

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

Параметры

string $related
string $foreignKey
string $localKey

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

HasMany

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

Определение связи has-many-through.

Параметры

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

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

HasManyThrough

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

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

Параметры

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

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

MorphMany
END_OF_DOCUMENT_MARKER

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

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

Параметры

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

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

BelongsToMany

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

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

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

Параметры

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

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

MorphToMany

protected string guessBelongsToManyRelation()

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

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

string

string joiningTable(string $related)

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

Параметры

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

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

Параметры

mixed $value

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

$this

Carbon freshTimestamp()

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

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

Carbon

string freshTimestampString()

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

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

string

bool usesTimestamps()

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

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

bool

string getCreatedAtColumn()

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

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

string

string getUpdatedAtColumn()

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

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

string

array getHidden()

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

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

array

$this setHidden(array $hidden)

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

Параметры

array $hidden

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

$this

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

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

Параметры

array|string|null $attributes

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

void

array getVisible()

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

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

array

$this setVisible(array $visible)

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

Параметры

array $visible

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

$this

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

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

Параметры

array|string|null $attributes

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

void

$this makeVisible(array|string $attributes)

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

Параметры

array|string $attributes

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

$this

$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

$this fill(array $attributes)

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

Параметры

array $attributes

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

$this

Исключения

MassAssignmentException

$this forceFill(array $attributes)

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

Параметры

array $attributes

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

$this

protected string removeTableFromKey(string $key)

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

Параметры

string $key

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

string

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

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

Параметры

array $attributes
bool $exists

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

Model

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

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

Параметры

array $attributes
string|null $connection

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

Model

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

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

Параметры

string|null $connection

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

Builder

static Builder onWriteConnection()

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

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

Builder

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

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

Параметры

array|mixed $columns

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

Collection|Model[]

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

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

Параметры

array|string $relations

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

Builder|Model

$this load(array|string $relations)

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

Параметры

array|string $relations

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

$this

$this loadMissing(array|string $relations)

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

Параметры

array|string $relations

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

$this

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

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

Параметры

string $column
int $amount
array $extra

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

int

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

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

Параметры

string $column
int $amount
array $extra

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

int

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

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

Параметры

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

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

int

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

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

Параметры

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

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

void
END_OF_DOCUMENT_MARKER

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

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

Параметры

array $attributes
array $options

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

bool

bool push()

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

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

bool

bool save(array $options = [])

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

Параметры

array $options

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

bool

bool saveOrFail(array $options = [])

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

Параметры

array $options

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

bool

Исключения

Throwable

protected void finishSave(array $options)

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

Параметры

array $options

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

void

protected bool performUpdate(Builder $query)

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

Параметры

Builder $query

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

bool

protected Builder setKeysForSaveQuery(Builder $query)

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

Параметры

Builder $query

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

Builder

protected mixed getKeyForSaveQuery()

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

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

mixed

protected bool performInsert(Builder $query)

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

Параметры

Builder $query

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

bool

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

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

Параметры

Builder $query
array $attributes

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

void

static int destroy(array|int $ids)

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

Параметры

array|int $ids

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

int

bool|null delete()

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

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

bool|null

bool|null forceDelete()

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

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

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

bool|null

protected void performDeleteOnModel()

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

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

void

static Builder query()

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

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

Builder

Builder newQuery()

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

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

Builder

Builder|Model newQueryWithoutScopes()

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

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

Builder|Model

Builder newQueryWithoutScope(Scope|string $scope)

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

Параметры

Scope|string $scope

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

Builder

Builder|Model newEloquentBuilder(Builder $query)

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

Параметры

Builder $query

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

Builder|Model

protected Builder newBaseQueryBuilder()

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

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

Builder

Collection newCollection(array $models = [])

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

Параметры

массив $models

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

Collection

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

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

Параметры

Модель $parent
массив $attributes
строка $table
булево $exists
строка|null $using

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

Pivot

массив toArray()

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

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

массив

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

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

Параметры

int $options

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

строка

Исключения

JsonEncodingException

массив jsonSerialize()

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

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

массив

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

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

Параметры

массив|строка $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()

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

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

Подключение

строка getConnectionName()

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

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

строка

$this setConnection(string $name)

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

Параметры

строка $name

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

$this

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

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

Параметры

строка|null $connection

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

Подключение

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

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

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

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

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

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

Параметры

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

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

void

static void unsetConnectionResolver()

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

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

void

строка getTable()

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

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

строка

$this setTable(string $table)

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

Параметры

строка $table

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

$this

строка getKeyName()

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

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

строка

$this setKeyName(string $key)

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

Параметры

строка $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

string|null getQueueableConnection()

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

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

string|null

mixed getRouteKey()

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

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

mixed

string getRouteKeyName()

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

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

string

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

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

Параметры

mixed $value

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

Модель|null

string getForeignKey()

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

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

string

int getPerPage()

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

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

int

$this setPerPage(int $perPage)

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

Параметры

int $perPage

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

$this

mixed __get(string $key)

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

Параметры

string $key

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

mixed

void __set(string $key, mixed $value)

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

Параметры

string $key
mixed $value

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

void

bool offsetExists(mixed $offset)

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

Параметры

mixed $offset

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

bool

mixed offsetGet(mixed $offset)

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

Параметры

mixed $offset

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

mixed

void offsetSet(mixed $offset, mixed $value)

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

Параметры

mixed $offset
mixed $value

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

void

void offsetUnset(mixed $offset)

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

Параметры

mixed $offset

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

void

bool __isset(string $key)

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

Параметры

string $key

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

bool

void __unset(string $key)

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

Параметры

string $key

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

void

mixed __call(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

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

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

Параметры

string $method
array $parameters

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

mixed

string __toString()

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

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

string

void __wakeup()

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

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

void

статический Pivot fromAttributes(Модель $parent, array $attributes, string $table, bool $exists = false)

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

Параметры

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

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

Pivot

статический Pivot fromRawAttributes(Модель $parent, array $attributes, string $table, bool $exists = false)

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

Параметры

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

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

Pivot

защищённый Билдер getDeleteQuery()

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

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

Билдер

строка getRelatedKey()

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

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

строка

строка getOtherKey()

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

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

строка

$this setPivotKeys(string $foreignKey, string $relatedKey)

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

Параметры

строка $foreignKey
строка $relatedKey

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

$this

логический тип hasTimestampAttributes()

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

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

логический тип

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

Spec-Zone.ru

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