Spec-Zone.ru › Laravel 5.6

Pivot

class Pivot extends Model (View source)

Трейты

HasAttributes
HasEvents
HasGlobalScopes
HasRelationships
HasTimestamps
HidesAttributes
GuardsAttributes

Константы

CREATED_AT

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

UPDATED_AT

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

Свойства

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

Методы

массив attributesToArray()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

из HasAttributes
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.

from HasAttributes
Carbon asDateTime(mixed $value)

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

from HasAttributes
bool isStandardDateFormat(string $value)

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

from HasAttributes
string fromDateTime(DateTime|int $value)

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

from HasAttributes
int asTimestamp(mixed $value)

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

from HasAttributes
string serializeDate(DateTimeInterface $date)

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

from HasAttributes
array getDates()

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

from HasAttributes
string getDateFormat()

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

from HasAttributes
$this setDateFormat(string $format)

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

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

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

from HasAttributes
array getCasts()

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

from HasAttributes
bool isDateCastable(string $key)

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

from HasAttributes
bool isJsonCastable(string $key)

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

from HasAttributes
array getAttributes()

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

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

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

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

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

from HasAttributes
array only(array|mixed $attributes)

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

from HasAttributes
$this syncOriginal()

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

from HasAttributes
$this syncOriginalAttribute(string $attribute)

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

from HasAttributes
$this syncChanges()

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

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

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

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

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

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

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

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

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

from HasAttributes
array getDirty()

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

from HasAttributes
array getChanges()

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

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

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

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

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

from HasAttributes
$this setAppends(array $appends)

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

from HasAttributes
array getMutatedAttributes()

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

from HasAttributes
static void cacheMutatedAttributes(string $class)

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

from HasAttributes
static array getMutatorMethods(mixed $class)

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

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

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

from HasEvents
void registerObserver(object|string $class)

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

from HasEvents
array getObservableEvents()

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

from HasEvents
$this setObservableEvents(array $observables)

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

from HasEvents
void addObservableEvents(array|mixed $observables)

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

from HasEvents
void removeObservableEvents(array|mixed $observables)

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

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

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

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

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

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

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

from HasEvents
mixed filterModelEventResults(mixed $result)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

from HasEvents
static void 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)

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

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)

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

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)

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

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

Определение связи через промежуточную таблицу.

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

Создание новой связи через промежуточную таблицу.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

из HasRelationships
string guessBelongsToManyRelation()

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

из HasRelationships
string joiningTable(string $related)

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

из HasRelationships
bool touches(string $relation)

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

из HasRelationships
void touchOwners()

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

из HasRelationships
array getMorphs(string $name, string $type, string $id)

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

из HasRelationships
string getMorphClass()

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

из HasRelationships
mixed newRelatedInstance(string $class)

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

из HasRelationships
array getRelations()

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

из HasRelationships
mixed getRelation(string $relation)

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

из HasRelationships
bool relationLoaded(string $key)

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

из HasRelationships
$this setRelation(string $relation, mixed $value)

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

из HasRelationships
$this unsetRelation(string $relation)

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

из HasRelationships
$this setRelations(array $relations)

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

из HasRelationships
array getTouchedRelations()

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

из HasRelationships
$this setTouchedRelations(array $touches)

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

из HasRelationships
bool touch()

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

из HasTimestamps
void updateTimestamps()

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

из HasTimestamps
$this setCreatedAt(mixed $value)

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

из HasTimestamps
$this setUpdatedAt(mixed $value)

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

из HasTimestamps
Carbon freshTimestamp()

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

из HasTimestamps
string freshTimestampString()

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

из HasTimestamps
bool usesTimestamps()

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

из HasTimestamps
string getCreatedAtColumn()

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

string getUpdatedAtColumn()

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

array getHidden()

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

из HidesAttributes
$this setHidden(array $hidden)

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

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

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

из HidesAttributes
array 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
array getFillable()

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

из GuardsAttributes
$this fillable(array $fillable)

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

из GuardsAttributes
array getGuarded()

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

из GuardsAttributes
$this guard(array $guarded)

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

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

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

из GuardsAttributes
static void reguard()

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

из GuardsAttributes
static bool isUnguarded()

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

из GuardsAttributes
static mixed unguarded(callable $callback)

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

из GuardsAttributes
bool isFillable(string $key)

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

из GuardsAttributes
bool isGuarded(string $key)

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

из GuardsAttributes
bool totallyGuarded()

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

из GuardsAttributes
array fillableFromArray(array $attributes)

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

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

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

из Model
void bootIfNotBooted()

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

из Model
static void boot()

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

из Model
static void bootTraits()

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

из Model
static void clearBootedModels()

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

from Model
static void withoutTouching(callable $callback)

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

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

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

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

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

from Model
$this fill(array $attributes)

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

from Model
$this forceFill(array $attributes)

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

from Model
string qualifyColumn(string $column)

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

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, float|int $amount = 1, array $extra = [])

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

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

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

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

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

from Model
void incrementOrDecrementAttributeValue(string $column, float|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()

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

from Model
bool performInsert(Builder $query)

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

from Model
void insertAndSetId(Builder $query, array $attributes)

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

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

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

from Model
bool|null delete()

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

bool|null forceDelete()

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

from Model
void performDeleteOnModel()

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

from Model
static Builder query()

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

from Model
Builder newQuery()

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

from Model
Builder|Model newModelQuery()

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

from Model
Builder newQueryWithoutRelationships()

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

from Model
Builder registerGlobalScopes(Builder $builder)

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

from Model
Builder|Model newQueryWithoutScopes()

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

from Model
Builder newQueryWithoutScope(Scope|string $scope)

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

from Model
Builder newQueryForRestoration(array|int $ids)

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

Builder|Model newEloquentBuilder(Builder $query)

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

from Model
Builder newBaseQueryBuilder()

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

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

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

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

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

from Model
array toArray()

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

from Model
string toJson(int $options)

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

from Model
array jsonSerialize()

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

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

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

from Model
$this refresh()

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

from Model
Model replicate(array $except = null)

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

from Model
bool is(Model|null $model)

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

from Model
bool isNot(Model|null $model)

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

from Model
Connection getConnection()

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

from Model
string getConnectionName()

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

from Model
$this setConnection(string $name)

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

from Model
static Connection resolveConnection(string|null $connection = null)

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

from Model
static ConnectionResolverInterface getConnectionResolver()

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

из Model
static void setConnectionResolver(ConnectionResolverInterface $resolver)

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

из Model
static void unsetConnectionResolver()

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

из Model
string getTable()

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

$this setTable(string $table)

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

из Model
string getKeyName()

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

из Model
$this setKeyName(string $key)

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

из Model
string getQualifiedKeyName()

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

из Model
string getKeyType()

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

из Model
$this setKeyType(string $type)

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

из Model
bool getIncrementing()

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

из Model
$this setIncrementing(bool $value)

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

из Model
mixed getKey()

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

из Model
mixed getQueueableId()

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

array getQueueableRelations()

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

из Model
string|null getQueueableConnection()

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

из Model
mixed getRouteKey()

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

из Model
string getRouteKeyName()

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

из Model
Model|null resolveRouteBinding(mixed $value)

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

из Model
string getForeignKey()

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

int getPerPage()

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

из Model
$this setPerPage(int $perPage)

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

из Model
mixed __get(string $key)

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

из Model
void __set(string $key, mixed $value)

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

из Model
bool offsetExists(mixed $offset)

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

из Model
mixed offsetGet(mixed $offset)

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

из Model
void offsetSet(mixed $offset, mixed $value)

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

из Model
void offsetUnset(mixed $offset)

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

из Model
bool __isset(string $key)

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

из Model
void __unset(string $key)

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

из Model
mixed __call(string $method, array $parameters)

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

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

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

из Model
string __toString()

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

из Model
void __wakeup()

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

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

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

string getRelatedKey()

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

string getOtherKey()

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

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

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

bool hasTimestampAttributes()

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

Builder newQueryForCollectionRestoration(array $ids)

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

Подробности

array attributesToArray()

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

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

array

protected array addDateAttributesToArray(array $attributes)

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

Параметры

array $attributes

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

array

protected array addMutatedAttributesToArray(array $attributes, array $mutatedAttributes)

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

Параметры

array $attributes
array $mutatedAttributes

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

array

protected array addCastAttributesToArray(array $attributes, array $mutatedAttributes)

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

Параметры

array $attributes
array $mutatedAttributes

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

array

protected array getArrayableAttributes()

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

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

array

protected array getArrayableAppends()

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

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

array

array relationsToArray()

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

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

array

protected array getArrayableRelations()

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

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

array

protected array getArrayableItems(array $values)

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

Параметры

array $values

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

array

mixed getAttribute(string $key)

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

Параметры

string $key

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

mixed

mixed getAttributeValue(string $key)

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

Параметры

string $key

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

mixed

protected mixed getAttributeFromArray(string $key)

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

Параметры

string $key

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

mixed

mixed getRelationValue(string $key)

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

Параметры

string $key

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

mixed

protected mixed getRelationshipFromMethod(string $method)

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

Параметры

string $method

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

mixed

Исключения

LogicException

bool hasGetMutator(string $key)

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

Параметры

string $key

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

bool

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

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

Параметры

string $key
mixed $value

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

mixed

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

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

Параметры

string $key
mixed $value

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

mixed

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

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

Parameters

string $key
mixed $value

Return Value

mixed

protected string getCastType(string $key)

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

Parameters

string $key

Return Value

string

protected bool isCustomDateTimeCast(string $cast)

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

Parameters

string $cast

Return Value

bool

mixed setAttribute(string $key, mixed $value)

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

Parameters

string $key
mixed $value

Return Value

mixed

bool hasSetMutator(string $key)

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

Parameters

string $key

Return Value

bool

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

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

Parameters

string $key
mixed $value

Return Value

mixed

protected bool isDateAttribute(string $key)

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

Parameters

string $key

Return Value

bool

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

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

Parameters

string $key
mixed $value

Return Value

$this

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

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

Parameters

string $path
string $key
mixed $value

Return Value

$this

protected array getArrayAttributeByKey(string $key)

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

Parameters

string $key

Return Value

array

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

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

Parameters

string $key
mixed $value

Return Value

string

protected string asJson(mixed $value)

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

Parameters

mixed $value

Return Value

string

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

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

Parameters

string $value
bool $asObject

Return Value

mixed

protected Carbon asDate(mixed $value)

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

Parameters

mixed $value

Return Value

Carbon

protected Carbon asDateTime(mixed $value)

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

Parameters

mixed $value

Return Value

Carbon

protected bool isStandardDateFormat(string $value)

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

Parameters

string $value

Return Value

bool

string fromDateTime(DateTime|int $value)

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

Parameters

DateTime|int $value

Return Value

string

protected int asTimestamp(mixed $value)

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

Parameters

mixed $value

Return Value

int

protected string serializeDate(DateTimeInterface $date)

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

Parameters

DateTimeInterface $date

Return Value

string

array getDates()

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

Return Value

array

string getDateFormat()

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

Return Value

string

$this setDateFormat(string $format)

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

Параметры

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)

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

Параметры

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

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

BelongsTo
END_OF_DOCUMENT_MARKER

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

Определите полиморфное, обратное взаимно-однозначное или многозначное отношение.

Параметры

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

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

MorphTo

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

Определите полиморфное, обратное взаимно-однозначное или многозначное отношение.

Параметры

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

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

MorphTo

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

Определите полиморфное, обратное взаимно-однозначное или многозначное отношение.

Параметры

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

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

MorphTo

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

Инициализируйте новое отношение MorphTo.

Параметры

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

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

MorphTo

static string getActualClassNameForMorph(string $class)

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

Параметры

string $class

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

string

protected string guessBelongsToRelation()

Предсказать имя отношения «belongs to».

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

string

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

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

Параметры

string $related
string $foreignKey
string $localKey

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

HasMany

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

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

Параметры

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

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

HasMany

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

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

Параметры

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

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

HasManyThrough

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

Инициализируйте новое отношение «многие через многие».

Параметры

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

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

HasManyThrough

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

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

Параметры

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

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

MorphMany

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

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

Параметры

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

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

MorphMany
END_OF_DOCUMENT_MARKER

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

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

Параметры

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

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

BelongsToMany

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

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

Параметры

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

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

BelongsToMany

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

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

Параметры

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

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

MorphToMany

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

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

Параметры

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

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

MorphToMany

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

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

Параметры

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

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

MorphToMany

protected string 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 unsetRelation(string $relation)

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

Параметры

string $relation

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

$this

$this setRelations(array $relations)

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

Параметры

array $relations

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

$this

array getTouchedRelations()

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

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

array

$this setTouchedRelations(array $touches)

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

Параметры

array $touches

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

$this

bool touch()

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

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

bool

protected void updateTimestamps()

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

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

void

$this setCreatedAt(mixed $value)

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

Параметры

mixed $value

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

$this

$this setUpdatedAt(mixed $value)

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

Параметры

mixed $value

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

$this

Carbon freshTimestamp()

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

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

Carbon

string freshTimestampString()

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

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

string

bool usesTimestamps()

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

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

bool

string getCreatedAtColumn()

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

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

string

string getUpdatedAtColumn()

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

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

string

array getHidden()

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

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

array

$this setHidden(array $hidden)

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

Параметры

array $hidden

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

$this

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

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

Параметры

array|string|null $attributes

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

void

array getVisible()

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

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

array

$this setVisible(array $visible)

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

Параметры

array $visible

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

$this

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

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

Параметры

array|string|null $attributes

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

void

$this makeVisible(array|string $attributes)

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

Параметры

array|string $attributes

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

$this

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

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

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

Builder

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

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

Параметры

array|mixed $columns

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

Collection|Модель[]

static Builder|Модель with(array|string $relations)

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

Параметры

array|string $relations

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

Builder|Модель

$this load(array|string $relations)

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

Параметры

array|string $relations

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

$this

$this loadMissing(array|string $relations)

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

Параметры

array|string $relations

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

$this

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

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

Параметры

string $column
float|int $amount
array $extra

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

int

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

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

Параметры

string $column
float|int $amount
array $extra

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

int

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

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

Параметры

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

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

int

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

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

Параметры

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

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

void

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

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

Параметры

array $attributes
array $options

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

bool

bool push()

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

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

bool

bool save(array $options = [])

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

Параметры

array $options

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

bool

bool saveOrFail(array $options = [])

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

Параметры

array $options

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

bool

Исключения

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)

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

Параметры

array|int $ids

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

int

bool|null delete()

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

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

bool|null

bool|null forceDelete()

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

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

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

bool|null

protected void performDeleteOnModel()

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

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

void

static Builder query()

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

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

Builder

Builder newQuery()

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

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

Builder

Builder|Model newModelQuery()

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

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

Builder|Model

Builder newQueryWithoutRelationships()

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

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

Builder

Builder registerGlobalScopes(Builder $builder)

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

Параметры

Builder $builder

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

Builder

Builder|Model newQueryWithoutScopes()

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

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

Builder|Model

Builder newQueryWithoutScope(Scope|string $scope)

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

Параметры

Scope|string $scope

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

Builder

Builder newQueryForRestoration(array|int $ids)

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

Параметры

array|int $ids

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

Builder

Builder|Model newEloquentBuilder(Builder $query)

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

Параметры

Builder $query

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

Builder|Model

protected Builder newBaseQueryBuilder()

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

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

Builder

Collection newCollection(array $models = [])

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

Параметры

array $models

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

Collection

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

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

Параметры

Model $parent
array $attributes
string $table
bool $exists
string|null $using

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

Pivot

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)

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

Параметры

array $except

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

Модель

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

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

Параметры

Модель|null $model

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

bool

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

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

Параметры

Модель|null $model

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

bool

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

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

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

Подключение

string getConnectionName()

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

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

string

$this setConnection(string $name)

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

Параметры

string $name

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

$this

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

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

Параметры

string|null $connection

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

Подключение

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

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

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

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

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

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

Параметры

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

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

void

static void unsetConnectionResolver()

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

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

void

string getTable()

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

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

string

$this setTable(string $table)

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

Параметры

string $table

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

$this

string getKeyName()

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

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

string

$this setKeyName(string $key)

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

Параметры

string $key

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

$this

string getQualifiedKeyName()

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

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

string

string getKeyType()

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

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

string

$this setKeyType(string $type)

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

Параметры

string $type

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

$this

bool getIncrementing()

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

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

bool

$this setIncrementing(bool $value)

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

Параметры

bool $value

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

$this

mixed getKey()

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

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

mixed

mixed getQueueableId()

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

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

mixed

array getQueueableRelations()

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

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

array

строка|null getQueueableConnection()

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

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

строка|null

смешанный тип getRouteKey()

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

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

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

строка getRouteKeyName()

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

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

строка

Модель|null resolveRouteBinding(смешанный тип $value)

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

Параметры

смешанный тип $value

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

Модель|null

строка getForeignKey()

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

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

строка

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

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

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

целое число

$this setPerPage(целое число $perPage)

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

Параметры

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

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

$this

смешанный тип __get(строка $key)

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

Параметры

строка $key

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

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

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

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

Параметры

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

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

void

логическое значение offsetExists(смешанный тип $offset)

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

Параметры

смешанный тип $offset

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

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

смешанный тип offsetGet(смешанный тип $offset)

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

Параметры

смешанный тип $offset

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

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

void offsetSet(смешанный тип $offset, смешанный тип $value)

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

Параметры

смешанный тип $offset
смешанный тип $value

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

void

void offsetUnset(смешанный тип $offset)

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

Параметры

смешанный тип $offset

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

void

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

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

Параметры

строка $key

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

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

void __unset(строка $key)

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

Параметры

строка $key

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

void

смешанный тип __call(строка $method, массив $parameters)

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

Параметры

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

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

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

статический смешанный тип __callStatic(строка $method, массив $parameters)

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

Параметры

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

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

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

строка __toString()

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

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

строка

void __wakeup()

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

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

void

статический Связь fromAttributes(Модель $parent, массив $attributes, строка $table, логическое значение $exists = false)

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

Параметры

Модель $parent
массив $attributes
строка $table
логическое значение $exists

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

Связь

статический Связь fromRawAttributes(Модель $parent, массив $attributes, строка $table, логическое значение $exists = false)

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

Параметры

Модель $parent
массив $attributes
строка $table
логическое значение $exists

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

Связь

защищенный Построитель getDeleteQuery()

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

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

Построитель

строка getRelatedKey()

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

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

строка
END_OF_DOCUMENT_MARKER

string getOtherKey()

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

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

string

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

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

Параметры

string $foreignKey
string $relatedKey

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

$this

bool hasTimestampAttributes()

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

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

bool

protected Builder newQueryForCollectionRestoration(array $ids)

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

Параметры

array $ids

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

Builder

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

Spec-Zone.ru

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