Pivot
class Pivot extends Model (View source)
Свойства
| AsPivot | |
| HasAttributes | |
| HasEvents | |
| HasGlobalScopes | |
| HasRelationships | |
| HasTimestamps | |
| HidesAttributes | |
| GuardsAttributes | |
| ForwardsCalls |
Константы
| 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 | Методы для многих-ко-многим отношений. | из HasRelationships |
| bool | $timestamps | Указывает, должна ли модель использовать метки времени. | из HasTimestamps |
| $hidden | Атрибуты, которые должны быть скрыты при сериализации. | из HidesAttributes | |
| protected массив | $visible | Атрибуты, которые должны быть видны при сериализации. | из HidesAttributes |
| protected массив | $fillable | Атрибуты, которые допускают массовое назначение. | из GuardsAttributes |
| protected массив | $guarded | Атрибуты, которые не допускают массового назначения. | |
| static protected bool | $unguarded | Указывает, разрешено ли все массовое назначение. | из GuardsAttributes |
| protected строка|null | $connection | Имя подключения для модели. | из Model |
| protected строка | $table | Таблица, связанная с моделью. | из Model |
| protected строка | $primaryKey | Первичный ключ для модели. | из Model |
| protected строка | $keyType | Тип первичного ключа ID. | из Model |
| bool | $incrementing | Указывает, являются ли ID автоматически инкрементируемыми. | |
| 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 массив | $traitInitializers | Массив инициализаторов трейтов, которые будут вызываться при каждом новом экземпляре. | из Model |
| static protected массив | $globalScopes | Массив глобальных скопов модели. | из Model |
| static protected массив | $ignoreOnTouch | Список классов моделей, которые не должны затрагиваться функцией touch. | из Model |
| Модель | $pivotParent | Родительская модель отношения. | из AsPivot |
| protected строка | $foreignKey | Имя столбца внешнего ключа. | из AsPivot |
| protected string | $relatedKey | Название столбца "другого ключа". | from AsPivot |
Методы
| массив | 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 |
| логическое значение | isDecimalCast(строка $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 |
| string | castAttributeAsJson(string $key, mixed $value) Преобразовать заданный атрибут в JSON. | из HasAttributes |
| string | asJson(mixed $value) Кодировать заданное значение в JSON. | из HasAttributes |
| mixed | fromJson(string $value, bool $asObject = false) Декодировать заданный JSON в массив или объект. | из HasAttributes |
| mixed | fromFloat(mixed $value) Декодировать заданное число с плавающей запятой. | из HasAttributes |
| string | asDecimal(float $value, int $decimals) Возвратить десятичное число в виде строки. | из HasAttributes |
| Carbon | asDate(mixed $value) Возвратить метку времени как объект DateTime с временем, установленным в 00:00:00. | из HasAttributes |
| Carbon | asDateTime(mixed $value) Возвратить метку времени как объект DateTime. | из HasAttributes |
| bool | isStandardDateFormat(string $value) Определить, соответствует ли заданное значение стандартному формату даты. | из HasAttributes |
| string|null | fromDateTime(mixed $value) Преобразовать DateTime в сохраняемую строку. | из HasAttributes |
| int | asTimestamp(mixed $value) Возвратить метку времени как unix-метку времени. | из HasAttributes |
| string | serializeDate(DateTimeInterface $date) Подготовить дату для сериализации в массив/JSON. | из HasAttributes |
| array | getDates() Получить атрибуты, которые должны быть преобразованы в даты. | из HasAttributes |
| string | getDateFormat() Получить формат для дат, хранящихся в базе данных. | из HasAttributes |
| $this | setDateFormat(string $format) Установить формат даты, используемый моделью. | из HasAttributes |
| bool | hasCast(string $key, array|string|null $types = null) Определить, должен ли атрибут быть преобразован в родной тип. | из HasAttributes |
| array | getCasts() Получить массив преобразований. | из HasAttributes |
| bool | isDateCastable(string $key) Определить, можно ли преобразовать значение в дату/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 | syncOriginalAttributes(array|string $attributes) Синхронизировать несколько исходных атрибутов с их текущими значениями. | из 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) Определить, были ли изменены какие-либо из указанных атрибутов. | 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 | replicating(Closure|string $callback) Зарегистрировать событие дублирования модели в диспетчере. | from HasEvents |
| static void | deleting(Closure|string $callback) Зарегистрировать событие удаления модели в диспетчере. | from HasEvents |
| static void | deleted(Closure|string $callback) Зарегистрировать событие удаления модели с помощью диспетчера. | из HasEvents |
| static void | flushEventListeners() Удалить все обработчики событий для модели. | из HasEvents |
| static Dispatcher | getEventDispatcher() Получить экземпляр диспетчера событий. | из HasEvents |
| static void | setEventDispatcher(Dispatcher $dispatcher) Установить экземпляр диспетчера событий. | из HasEvents |
| static void | unsetEventDispatcher() Сбросить диспетчер событий для моделей. | из HasEvents |
| static mixed | withoutEvents(callable $callback) Выполнить обратный вызов без запуска каких-либо событий модели для любого типа модели. | из HasEvents |
| static mixed | addGlobalScope(Scope|Closure|string $scope, Closure $implementation = null) Зарегистрировать новый глобальный scope в модели. | из HasGlobalScopes |
| static bool | hasGlobalScope(Scope|string $scope) Определить, имеет ли модель глобальный scope. | из HasGlobalScopes |
| static Scope|Closure|null | getGlobalScope(Scope|string $scope) Получить глобальный scope, зарегистрированный в модели. | из HasGlobalScopes |
| array | getGlobalScopes() Получить глобальные scopes для этого экземпляра класса. | из HasGlobalScopes |
| HasOne | hasOne(string $related, string $foreignKey = null, string $localKey = null) Определить отношение «один-к-одному». | из HasRelationships |
| HasOne | newHasOne(Builder $query, Model $parent, string $foreignKey, string $localKey) Создать новое отношение HasOne. | из HasRelationships |
| HasOneThrough | hasOneThrough(string $related, string $through, string|null $firstKey = null, string|null $secondKey = null, string|null $localKey = null, string|null $secondLocalKey = null) Определить отношение «один-через-один». | из HasRelationships |
| HasOneThrough | newHasOneThrough(Builder $query, Model $farParent, Model $throughParent, string $firstKey, string $secondKey, string $localKey, string $secondLocalKey) Создать новое отношение HasOneThrough. | из HasRelationships |
| MorphOne | morphOne(string $related, string $name, string $type = null, string $id = null, string $localKey = null) Определить полиморфное отношение «один-к-одному». | из HasRelationships |
| MorphOne | newMorphOne(Builder $query, Model $parent, string $type, string $id, string $localKey) Создать новое отношение MorphOne. | из HasRelationships |
| BelongsTo | belongsTo(string $related, string $foreignKey = null, string $ownerKey = null, string $relation = null) Определить обратное отношение «один-к-одному» или «многие-к-одному». | из HasRelationships |
| BelongsTo | newBelongsTo(Builder $query, Model $child, string $foreignKey, string $ownerKey, string $relation) Создать новое отношение BelongsTo. | из HasRelationships |
| MorphTo | morphTo(string $name = null, string $type = null, string $id = null, string $ownerKey = null) Определить полиморфное, обратное отношение «один-к-одному» или «многие-к-одному». | из HasRelationships |
| MorphTo | morphEagerTo(string $name, string $type, string $id, string $ownerKey) Определить полиморфное, обратное отношение «один-к-одному» или «многие-к-одному». | из HasRelationships |
| MorphTo | morphInstanceTo(string $target, string $name, string $type, string $id, string $ownerKey) Определить полиморфное, обратное отношение «один-к-одному» или «многие-к-одному». | из HasRelationships |
| MorphTo | newMorphTo(Builder $query, Model $parent, string $foreignKey, string $ownerKey, string $type, string $relation) Инициализировать новое отношение MorphTo. | from HasRelationships |
| static string | getActualClassNameForMorph(string $class) Получить фактическое имя класса для данного класса morph. | from HasRelationships |
| string | guessBelongsToRelation() Угадать имя отношения «belongs to». | from HasRelationships |
| HasMany | hasMany(string $related, string $foreignKey = null, string $localKey = null) Определить отношение один-ко-многим. | from HasRelationships |
| HasMany | newHasMany(Builder $query, Model $parent, string $foreignKey, string $localKey) Инициализировать новое отношение HasMany. | from HasRelationships |
| HasManyThrough | hasManyThrough(string $related, string $through, string|null $firstKey = null, string|null $secondKey = null, string|null $localKey = null, string|null $secondLocalKey = null) Определить отношение has-many-through. | from HasRelationships |
| HasManyThrough | newHasManyThrough(Builder $query, Model $farParent, Model $throughParent, string $firstKey, string $secondKey, string $localKey, string $secondLocalKey) Инициализировать новое отношение HasManyThrough. | from HasRelationships |
| MorphMany | morphMany(string $related, string $name, string $type = null, string $id = null, string $localKey = null) Определить полиморфное отношение один-ко-многим. | from HasRelationships |
| MorphMany | newMorphMany(Builder $query, Model $parent, string $type, string $id, string $localKey) Инициализировать новое отношение MorphMany. | from HasRelationships |
| BelongsToMany | belongsToMany(string $related, string $table = null, string $foreignPivotKey = null, string $relatedPivotKey = null, string $parentKey = null, string $relatedKey = null, string $relation = null) Определить отношение многие-ко-многим. | from HasRelationships |
| BelongsToMany | newBelongsToMany(Builder $query, Model $parent, string $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string $relationName = null) Инициализировать новое отношение BelongsToMany. | from HasRelationships |
| MorphToMany | morphToMany(string $related, string $name, string $table = null, string $foreignPivotKey = null, string $relatedPivotKey = null, string $parentKey = null, string $relatedKey = null, bool $inverse = false) Определить полиморфное отношение многие-ко-многим. | from HasRelationships |
| MorphToMany | newMorphToMany(Builder $query, Model $parent, string $name, string $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string $relationName = null, bool $inverse = false) Инициализировать новое отношение MorphToMany. | from HasRelationships |
| MorphToMany | morphedByMany(string $related, string $name, string $table = null, string $foreignPivotKey = null, string $relatedPivotKey = null, string $parentKey = null, string $relatedKey = null) Определить полиморфное обратное отношение многие-ко-многим. | from HasRelationships |
| string|null | guessBelongsToManyRelation() Получить имя отношения belongsToMany. | from HasRelationships |
| string | joiningTable(string $related, Model|null $instance = null) Получить имя таблицы соединения для отношения многие-ко-многим. | from HasRelationships |
| string | joiningTableSegment() Получить часть имени промежуточной таблицы для модели belongsToMany. | from HasRelationships |
| bool | touches(string $relation) Определить, касается ли модель данное отношение. | from HasRelationships |
| void | touchOwners() Обновить связанные отношения модели. | from HasRelationships |
| array | getMorphs(string $name, string $type, string $id) Получить столбцы полиморфного отношения. | from HasRelationships |
| string | getMorphClass() Получить имя класса для полиморфных отношений. | from HasRelationships |
| mixed | newRelatedInstance(string $class) Создать новый экземпляр модели для связанной модели. | from HasRelationships |
| array | getRelations() Получить все загруженные отношения для экземпляра. | from HasRelationships |
| mixed | getRelation(string $relation) Получить указанное отношение. | from HasRelationships |
| bool | relationLoaded(string $key) Определить, загружено ли данное отношение. | from HasRelationships |
| $this | setRelation(string $relation, mixed $value) Установить указанное отношение в модели. | from HasRelationships |
| $this | unsetRelation(string $relation) Удалить загруженное отношение. | from HasRelationships |
| $this | setRelations(array $relations) Установить массив всех отношений в модели. | from HasRelationships |
| array | getTouchedRelations() Получить отношения, которые затрагиваются при сохранении. | from HasRelationships |
| $this | setTouchedRelations(array $touches) Установить отношения, которые затрагиваются при сохранении. | from HasRelationships |
| bool | touch() Обновить отметку времени последнего обновления модели. | from HasTimestamps |
| void | updateTimestamps() Обновить отметки времени создания и обновления. | from HasTimestamps |
| $this | setCreatedAt(mixed $value) Установить значение атрибута "created at". | from HasTimestamps |
| $this | setUpdatedAt(mixed $value) Установить значение атрибута "updated at". | from HasTimestamps |
| Carbon | freshTimestamp() Получить свежую отметку времени для модели. | from HasTimestamps |
| string | freshTimestampString() Получить свежую отметку времени для модели. | from HasTimestamps |
| bool | usesTimestamps() Определить, использует ли модель отметки времени. | from HasTimestamps |
| string | getCreatedAtColumn() Получить имя столбца "created at". | from HasTimestamps |
| string | getUpdatedAtColumn() Получить имя столбца "updated at". | from HasTimestamps |
| array | getHidden() Получить скрытые атрибуты модели. | from HidesAttributes |
| $this | setHidden(array $hidden) Установить скрытые атрибуты модели. | from HidesAttributes |
| void | addHidden(array|string|null $attributes = null) Добавить скрытые атрибуты для модели. | from HidesAttributes |
| array | getVisible() Получить видимые атрибуты модели. | from HidesAttributes |
| $this | setVisible(array $visible) Установить видимые атрибуты модели. | from HidesAttributes |
| void | addVisible(array|string|null $attributes = null) Добавить видимые атрибуты для модели. | from HidesAttributes |
| $this | makeVisible(array|string $attributes) Сделать заданные, обычно скрытые, атрибуты видимыми. | from HidesAttributes |
| $this | makeHidden(array|string $attributes) Скрыть заданные, обычно видимые, атрибуты. | from HidesAttributes |
| array | getFillable() Получить атрибуты, которые можно заполнять. | from GuardsAttributes |
| $this | fillable(array $fillable) Установить атрибуты, которые можно заполнять. | from GuardsAttributes |
| array | getGuarded() Получить защищенные атрибуты модели. | from GuardsAttributes |
| $this | guard(array $guarded) Задать защищённые атрибуты для модели. | from GuardsAttributes |
| static void | unguard(bool $state = true) Отключить все ограничения массового присваивания. | from GuardsAttributes |
| static void | reguard() Включить ограничения массового присваивания. | from GuardsAttributes |
| static bool | isUnguarded() Определить, находится ли текущее состояние в режиме "без защиты". | 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 |
| mixed | forwardCallTo(mixed $object, string $method, array $parameters) Переслать вызов метода заданному объекту. | from ForwardsCalls |
| static void | throwBadMethodCallException(string $method) Выбросить исключение о неправильном вызове метода для данного метода. | from ForwardsCalls |
| void | __construct(array $attributes = []) Создать новый экземпляр модели Eloquent. | from Model |
| void | bootIfNotBooted() Проверить, нужно ли загрузить модель, и если да, то сделать это. | from Model |
| static void | boot() Метод "загрузки" модели. | from Model |
| static void | bootTraits() Загрузить все загружаемые черты модели. | from Model |
| void | initializeTraits() Инициализировать любые инициализируемые черты модели. | from 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) Загрузка связанных данных модели. | из Модели |
| $this | loadMissing(array|string $relations) Загрузка связанных данных модели, если они ещё не загружены. | из Модели |
| $this | loadCount(array|string $relations) Загрузка количества связанных данных модели. | из Модели |
| int | increment(string $column, float|int $amount = 1, array $extra = []) Увеличение значения столбца на заданную величину. | из Модели |
| int | decrement(string $column, float|int $amount = 1, array $extra = []) Уменьшение значения столбца на заданную величину. | из Модели |
| int | incrementOrDecrement(string $column, float|int $amount, array $extra, string $method) Выполнение увеличения или уменьшения значения столбца модели. | из Модели |
| void | incrementOrDecrementAttributeValue(string $column, float|int $amount, array $extra, string $method) Увеличение или уменьшение значения атрибута и синхронизация с исходным значением. | из Модели |
| bool | update(array $attributes = [], array $options = []) Обновление модели в базе данных. | из Модели |
| bool | push() Сохранение модели и всех ее отношений. | из Модели |
| bool | save(array $options = []) Сохранение модели в базе данных. | из Модели |
| bool | saveOrFail(array $options = []) Сохранение модели в базе данных с использованием транзакции. | из Модели |
| void | finishSave(array $options) Выполнение действий, необходимых после сохранения модели. | из Модели |
| bool | performUpdate(Builder $query) Выполнение операции обновления модели. | из Модели |
| Builder | setKeysForSaveQuery(Builder $query) Установка ключей для запроса сохранения. | из AsPivot |
| mixed | getKeyForSaveQuery() Получение значения первичного ключа для запроса сохранения. | из Модели |
| bool | performInsert(Builder $query) Выполнение операции вставки модели. | из Модели |
| void | insertAndSetId(Builder $query, array $attributes) Вставка заданных атрибутов и установка ID модели. | из Модели |
| static int | destroy(Collection|array|int $ids) Удаление моделей по заданным ID. | из Модели |
| int | delete() Удаление записи промежуточной модели из базы данных. | из AsPivot |
| bool|null | forceDelete() Выполнение жесткого удаления мягко удаленной модели. | из Модели |
| void | performDeleteOnModel() Выполнение фактического запроса удаления для экземпляра модели. | из Модели |
| static Builder | query() Начать запрос к модели. | из Модели |
| Builder | newQuery() Получение нового билдера запроса для таблицы модели. | из Модели |
| Builder|Model | newModelQuery() Получение нового билдера запроса без глобальных обработчиков или предварительной загрузки. | из Модели |
| Builder | newQueryWithoutRelationships() Получение нового билдера запроса без предварительной загрузки отношений. | из Модели |
| Builder | registerGlobalScopes(Builder $builder) Регистрация глобальных обработчиков для этого экземпляра билдера. | из Модели |
| Builder|Model | newQueryWithoutScopes() Получение нового билдера запроса без глобальных обработчиков. | из Модели |
| Builder | newQueryWithoutScope(Scope|string $scope) Получение нового экземпляра билдера запроса без указанного обработчика. | из Модели |
| Builder | newQueryForRestoration(int[]|string[]|string $ids) Получение нового запроса для восстановления одной или нескольких моделей по их идентификаторам очереди. | из AsPivot |
| Builder|Модель | newEloquentBuilder(Builder $query) Создать новый билдер запросов Eloquent для модели. | из Модели |
| Builder | newBaseQueryBuilder() Получить новый экземпляр билдера запросов для подключения. | из Модели |
| Коллекция | newCollection(array $models = []) Создать новый экземпляр коллекции Eloquent. | из Модели |
| Связь | newPivot(Модель $parent, array $attributes, string $table, bool $exists, string|null $using = null) Создать новый экземпляр модели связи. | из Модели |
| массив | toArray() Преобразовать экземпляр модели в массив. | из Модели |
| строка | toJson(int $options = 0) Преобразовать экземпляр модели в JSON. | из Модели |
| массив | jsonSerialize() Преобразовать объект в сериализуемый в JSON формат. | из Модели |
| Модель|null | fresh(array|string $with = []) Перезагрузить свежий экземпляр модели из базы данных. | из Модели |
| $this | refresh() Перезагрузить текущий экземпляр модели свежими атрибутами из базы данных. | из Модели |
| Модель | replicate(array $except = null) Клонировать модель в новый, не существующий экземпляр. | из Модели |
| boolean | is(Модель|null $model) Определить, имеют ли две модели одинаковый идентификатор и относятся ли к одной и той же таблице. | из Модели |
| boolean | isNot(Модель|null $model) Определить, не являются ли две модели одинаковыми. | из Модели |
| Подключение | getConnection() Получить подключение к базе данных для модели. | из Модели |
| строка|null | getConnectionName() Получить текущее имя подключения для модели. | из Модели |
| $this | setConnection(string|null $name) Установить подключение, связанное с моделью. | из Модели |
| статический Подключение | resolveConnection(string|null $connection = null) Разрешить экземпляр подключения. | из Модели |
| статический Интерфейс разрешения подключений | getConnectionResolver() Получить экземпляр разрешения подключения. | из Модели |
| статический void | setConnectionResolver(Интерфейс разрешения подключений $resolver) Установить экземпляр разрешения подключения. | из Модели |
| статический void | unsetConnectionResolver() Удалить разрешение подключения для моделей. | из Модели |
| строка | getTable() Получить таблицу, связанную с моделью. | из AsPivot |
| $this | setTable(string $table) Установить таблицу, связанную с моделью. | из Модели |
| строка | getKeyName() Получить первичный ключ для модели. | из Модели |
| $this | setKeyName(string $key) Установить первичный ключ для модели. | из Модели |
| строка | getQualifiedKeyName() Получить имя квалифицированного ключа таблицы. | из Модели |
| строка | getKeyType() Получить тип автоматически увеличиваемого ключа. | из Модели |
| $this | setKeyType(string $type) Установить тип данных для первичного ключа. | из Модели |
| boolean | getIncrementing() Получить значение, указывающее, являются ли идентификаторы нарастающими. | из Модели |
| $this | setIncrementing(bool $value) Установить, являются ли идентификаторы нарастающими. | из Модели |
| mixed | getKey() Получить значение первичного ключа модели. | из Модели |
| mixed | getQueueableId() Получить идентификатор очереди для сущности. | из AsPivot |
| array | getQueueableRelations() Получить очередимые отношения для сущности. | from Model |
| string|null | getQueueableConnection() Получить очередимое соединение для сущности. | from Model |
| mixed | getRouteKey() Получить значение ключа маршрута модели. | from Model |
| string | getRouteKeyName() Получить ключ маршрута для модели. | from Model |
| Model|null | resolveRouteBinding(mixed $value) Получить модель для связанного значения. | from Model |
| string | getForeignKey() Получить имя столбца внешнего ключа. | from AsPivot |
| 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 AsPivot | fromAttributes(Model $parent, array $attributes, string $table, bool $exists = false) Создать новый экземпляр модели связующей таблицы. | from AsPivot |
| static AsPivot | fromRawAttributes(Model $parent, array $attributes, string $table, bool $exists = false) Создать новую модель связующей таблицы из сырых значений, возвращённых запросом. | from AsPivot |
| Builder | getDeleteQuery() Получить конструктор запроса для удаления связующей таблицы. | from AsPivot |
| string | getRelatedKey() Получить имя столбца "связанного ключа". | from AsPivot |
| string | getOtherKey() Получить имя столбца "связанного ключа". | from AsPivot |
| $this | setPivotKeys(string $foreignKey, string $relatedKey) Установить имена ключей для экземпляра модели связующей таблицы. | from AsPivot |
| bool | hasTimestampAttributes(array|null $attributes = null) Определить, имеет ли модель связующей таблицы или заданные атрибуты атрибуты времени. | from AsPivot |
| Builder | newQueryForCollectionRestoration(array $ids) Получить новый запрос для восстановления нескольких моделей по их очередимым идентификаторам. | from AsPivot |
Подробности
массив attributesToArray()
Преобразовать атрибуты модели в массив.
защищен массив addDateAttributesToArray(массив $attributes)
Добавить атрибуты даты в массив атрибутов.
protected array addMutatedAttributesToArray(array $attributes, array $mutatedAttributes)
Добавить изменённые атрибуты в массив атрибутов.
protected array addCastAttributesToArray(array $attributes, array $mutatedAttributes)
Добавить преобразованные атрибуты в массив атрибутов.
protected array getArrayableAttributes()
Получить массив атрибутов, которые можно преобразовать в массив.
protected array getArrayableAppends()
Получить все значения, которые можно добавить и преобразовать в массив.
array relationsToArray()
Получить отношения модели в виде массива.
protected array getArrayableRelations()
Получить массив отношений, которые можно преобразовать в массив.
protected array getArrayableItems(array $values)
Получить массив значений, которые можно преобразовать в массив.
mixed getAttribute(string $key)
Получить атрибут из модели.
mixed getAttributeValue(string $key)
Получить простой атрибут (не отношение).
protected mixed getAttributeFromArray(string $key)
Получить атрибут из массива $attributes.
mixed getRelationValue(string $key)
Получить отношение.
protected mixed getRelationshipFromMethod(string $method)
Получить значение отношения из метода.
bool hasGetMutator(string $key)
Определить, существует ли мутатор для получения атрибута.
protected mixed mutateAttribute(string $key, mixed $value)
Получить значение атрибута с использованием его мутатора.
protected mixed mutateAttributeForArray(string $key, mixed $value)
Получить значение атрибута с использованием его мутатора для преобразования в массив.
protected mixed castAttribute(string $key, mixed $value)
Преобразовать атрибут в базовый тип PHP.
protected string getCastType(string $key)
Получить тип преобразования для атрибута модели.
protected bool isCustomDateTimeCast(string $cast)
Определить, является ли тип преобразования пользовательским типом преобразования даты и времени.
protected bool isDecimalCast(string $cast)
Определить, является ли тип преобразования типом преобразования десятичных чисел.
mixed setAttribute(string $key, mixed $value)
Установить заданный атрибут в модели.
bool hasSetMutator(string $key)
Определить, существует ли мутатор для установки атрибута.
protected mixed setMutatedAttributeValue(string $key, mixed $value)
Установить значение атрибута с помощью его мутатора.
protected bool isDateAttribute(string $key)
Определить, является ли заданный атрибут датой или допускающим преобразование в дату.
$this fillJsonAttribute(string $key, mixed $value)
Установить заданный JSON-атрибут в модели.
protected $this getArrayAttributeWithValue(string $path, string $key, mixed $value)
Получить атрибут массива с заданным ключом и установленным значением.
protected array getArrayAttributeByKey(string $key)
Получить атрибут массива или вернуть пустой массив, если он не задан.
protected string castAttributeAsJson(string $key, mixed $value)
Преобразовать заданный атрибут в JSON.
protected string asJson(mixed $value)
Кодировать заданное значение в JSON.
mixed fromJson(string $value, bool $asObject = false)
Декодировать заданный JSON обратно в массив или объект.
mixed fromFloat(mixed $value)
Декодировать заданное значение с плавающей точкой.
protected string asDecimal(float $value, int $decimals)
Возвращает десятичное значение в виде строки.
protected Carbon asDate(mixed $value)
Возвращает отметку времени как объект DateTime с временем, установленным в 00:00:00.
protected Carbon asDateTime(mixed $value)
Возвращает отметку времени как объект DateTime.
protected bool isStandardDateFormat(string $value)
Определить, соответствует ли заданное значение стандартному формату даты.
string|null fromDateTime(mixed $value)
Преобразовать DateTime в хранимую строку.
protected int asTimestamp(mixed $value)
Возвращает отметку времени как метку времени Unix.
protected string serializeDate(DateTimeInterface $date)
Подготовить дату для сериализации в массив/JSON.
array getDates()
Получить атрибуты, которые должны быть преобразованы в даты.
string getDateFormat()
Получить формат для даты, хранящейся в базе данных.
$this setDateFormat(string $format)
Установить формат даты, используемый моделью.
bool hasCast(string $key, array|string|null $types = null)
Определить, должен ли атрибут быть преобразован в родной тип.
array getCasts()
Получить массив преобразований.
protected bool isDateCastable(string $key)
Определить, допускает ли значение преобразование в Date/DateTime для обработки входных данных.
protected bool isJsonCastable(string $key)
Определить, допускает ли значение преобразование в JSON для обработки входных данных.
массив getAttributes()
Получить все текущие атрибуты модели.
$this setRawAttributes(массив $attributes, bool $sync = false)
Установить массив атрибутов модели. Проверка не выполняется.
смешанное|массив getOriginal(строка|null $key = null, смешанное $default = null)
Получить исходные значения атрибутов модели.
массив only(массив|смешанное $attributes)
Получить подмножество атрибутов модели.
$this syncOriginal()
Синхронизировать исходные атрибуты с текущими.
$this syncOriginalAttribute(строка $attribute)
Синхронизировать один исходный атрибут со значением текущего значения.
$this syncOriginalAttributes(массив|строка $attributes)
Синхронизировать несколько исходных атрибутов со своими текущими значениями.
$this syncChanges()
Синхронизировать измененные атрибуты.
bool isDirty(массив|строка|null $attributes = null)
Определить, была ли модель или какие-либо из заданных атрибутов изменены.
bool isClean(массив|строка|null $attributes = null)
Определить, осталась ли модель и все заданные атрибуты неизменными.
bool wasChanged(массив|строка|null $attributes = null)
Определить, была ли модель или какие-либо из заданных атрибутов изменены.
protected bool hasChanges(массив $changes, массив|строка|null $attributes = null)
Определить, были ли изменены какие-либо из заданных атрибутов.
массив getDirty()
Получить атрибуты, которые были изменены с момента последней синхронизации.
массив getChanges()
Получить атрибуты, которые были изменены.
bool originalIsEquivalent(строка $key, смешанное $current)
Определить, эквивалентны ли новые и старые значения для данного ключа.
$this append(массив|строка $attributes)
Добавить атрибуты к запросу при построении запроса.
$this setAppends(массив $appends)
Установить аксессоры для добавления в массивы модели.
массив getMutatedAttributes()
Получить измененные атрибуты для данного экземпляра.
статический пусто cacheMutatedAttributes(строка $class)
Извлечь и кэшировать все измененные атрибуты класса.
статический защищенный массив getMutatorMethods(смешанное $class)
Получить все методы мутатора атрибутов.
статический пусто observe(объект|массив|строка $classes)
Зарегистрировать наблюдателей с моделью.
защищенный пусто registerObserver(объект|строка $class)
Зарегистрировать одного наблюдателя с моделью.
массив getObservableEvents()
Получить имена наблюдаемых событий.
$this setObservableEvents(array $observables)
Установить имена наблюдаемых событий.
void addObservableEvents(array|mixed $observables)
Добавить имя наблюдаемого события.
void removeObservableEvents(array|mixed $observables)
Удалить имя наблюдаемого события.
static protected void registerModelEvent(string $event, Closure|string $callback)
Зарегистрировать событие модели у диспетчера.
protected mixed fireModelEvent(string $event, bool $halt = true)
Вызвать заданное событие для модели.
protected mixed|null fireCustomModelEvent(string $event, string $method)
Вызвать пользовательское событие модели для данного события.
protected mixed filterModelEventResults(mixed $result)
Отфильтровать результаты события модели.
static void retrieved(Closure|string $callback)
Зарегистрировать событие извлечения модели у диспетчера.
static void saving(Closure|string $callback)
Зарегистрировать событие сохранения модели у диспетчера.
static void saved(Closure|string $callback)
Зарегистрировать событие сохранения модели у диспетчера.
static void updating(Closure|string $callback)
Зарегистрировать событие обновления модели у диспетчера.
static void updated(Closure|string $callback)
Зарегистрировать событие обновления модели у диспетчера.
static void creating(Closure|string $callback)
Зарегистрировать событие создания модели у диспетчера.
static void created(Closure|string $callback)
Зарегистрировать событие создания модели у диспетчера.
static void replicating(Closure|string $callback)
Зарегистрировать событие дублирования модели у диспетчера.
static void deleting(Closure|string $callback)
Зарегистрировать событие удаления модели у диспетчера.
static void deleted(Closure|string $callback)
Зарегистрировать событие удаления модели у диспетчера.
static void flushEventListeners()
Удалить все слушатели событий для модели.
static Dispatcher getEventDispatcher()
Получить экземпляр диспетчера событий.
static void setEventDispatcher(Dispatcher $dispatcher)
Установить экземпляр диспетчера событий.
static void unsetEventDispatcher()
Удалить диспетчера событий для моделей.
static mixed withoutEvents(callable $callback)
Выполнить обратный вызов без срабатывания событий модели для любого типа модели.
static mixed addGlobalScope(Scope|Closure|string $scope, Closure $implementation = null)
Зарегистрировать новый глобальный скоуп для модели.
static bool hasGlobalScope(Scope|string $scope)
Определить, имеет ли модель глобальный скоуп.
static Scope|Closure|null getGlobalScope(Scope|string $scope)
Получить зарегистрированный с моделью глобальный скоуп.
array getGlobalScopes()
Получить глобальные скоупы для этого экземпляра класса.
HasOne hasOne(string $related, string $foreignKey = null, string $localKey = null)
Определить отношение один-к-одному.
protected HasOne newHasOne(Builder $query, Model $parent, string $foreignKey, string $localKey)
Инициализировать новое отношение один-к-одному.
HasOneThrough hasOneThrough(string $related, string $through, string|null $firstKey = null, string|null $secondKey = null, string|null $localKey = null, string|null $secondLocalKey = null)
Определить отношение has-one-through.
protected HasOneThrough newHasOneThrough(Builder $query, Model $farParent, Model $throughParent, string $firstKey, string $secondKey, string $localKey, string $secondLocalKey)
Инициализировать новое отношение HasOneThrough.
MorphOne morphOne(string $related, string $name, string $type = null, string $id = null, string $localKey = null)
Определить полиморфное отношение один-к-одному.
protected MorphOne newMorphOne(Builder $query, Model $parent, string $type, string $id, string $localKey)
Инициализировать новое полиморфное отношение один-к-одному.
BelongsTo belongsTo(string $related, string $foreignKey = null, string $ownerKey = null, string $relation = null)
Определите обратное отношение один-к-одному или многие-к-одному.
protected BelongsTo newBelongsTo(Builder $query, Model $child, string $foreignKey, string $ownerKey, string $relation)
Инициализируйте новое отношение BelongsTo.
MorphTo morphTo(string $name = null, string $type = null, string $id = null, string $ownerKey = null)
Определите полиморфное обратное отношение один-к-одному или многие-к-одному.
protected MorphTo morphEagerTo(string $name, string $type, string $id, string $ownerKey)
Определите полиморфное обратное отношение один-к-одному или многие-к-одному.
protected MorphTo morphInstanceTo(string $target, string $name, string $type, string $id, string $ownerKey)
Определите полиморфное обратное отношение один-к-одному или многие-к-одному.
protected MorphTo newMorphTo(Builder $query, Model $parent, string $foreignKey, string $ownerKey, string $type, string $relation)
Инициализируйте новое полиморфное отношение MorphTo.
static string getActualClassNameForMorph(string $class)
Получить фактическое имя класса для заданного класса morph.
protected string guessBelongsToRelation()
Угадать имя отношения "belongs to".
HasMany hasMany(string $related, string $foreignKey = null, string $localKey = null)
Определите отношение один-ко-многим.
protected HasMany newHasMany(Builder $query, Model $parent, string $foreignKey, string $localKey)
Инициализируйте новое отношение HasMany.
HasManyThrough hasManyThrough(string $related, string $through, string|null $firstKey = null, string|null $secondKey = null, string|null $localKey = null, string|null $secondLocalKey = null)
Определите отношение has-many-through.
protected HasManyThrough newHasManyThrough(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)
Определите полиморфное отношение «один ко многим».
protected MorphMany newMorphMany(Builder $query, Model $parent, string $type, string $id, string $localKey)
Инициализируйте новое отношение MorphMany.
BelongsToMany belongsToMany(string $related, string $table = null, string $foreignPivotKey = null, string $relatedPivotKey = null, string $parentKey = null, string $relatedKey = null, string $relation = null)
Определите отношение «многие ко многим».
protected BelongsToMany newBelongsToMany(Builder $query, Model $parent, string $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string $relationName = null)
Инициализируйте новое отношение 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)
Определите полиморфное отношение «многие ко многим».
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)
Инициализируйте новое отношение MorphToMany.
MorphToMany morphedByMany(string $related, string $name, string $table = null, string $foreignPivotKey = null, string $relatedPivotKey = null, string $parentKey = null, string $relatedKey = null)
Определите полиморфное обратное отношение «многие ко многим».
protected string|null guessBelongsToManyRelation()
Получить имя отношения belongsToMany.
string joiningTable(string $related, Model|null $instance = null)
Получить имя таблицы соединения для отношения «многие ко многим».
string joiningTableSegment()
Получить часть имени промежуточной таблицы для отношений «многие ко многим».
bool touches(string $relation)
Определить, касается ли модель заданное отношение.
void touchOwners()
Обновить связанные отношения модели.
protected array getMorphs(string $name, string $type, string $id)
Получить столбцы полиморфных отношений.
string getMorphClass()
Получить имя класса для полиморфных отношений.
protected mixed newRelatedInstance(string $class)
Создать новый экземпляр модели для связанной модели.
array getRelations()
Получить все загруженные отношения для экземпляра.
mixed getRelation(string $relation)
Получить указанное отношение.
bool relationLoaded(string $key)
Определить, загружено ли данное отношение.
$this setRelation(string $relation, mixed $value)
Установить данное отношение в модели.
$this unsetRelation(string $relation)
Удалить загруженное отношение.
$this setRelations(array $relations)
Установить массив всех отношений в модели.
array getTouchedRelations()
Получить отношения, которые изменяются при сохранении.
$this setTouchedRelations(array $touches)
Установить отношения, которые изменяются при сохранении.
bool touch()
Обновить метку последнего изменения модели.
protected void updateTimestamps()
Обновить метки создания и последнего изменения.
$this setCreatedAt(mixed $value)
Установить значение атрибута "создано в".
$this setUpdatedAt(mixed $value)
Установить значение атрибута "обновлено в".
Carbon freshTimestamp()
Получить свежую метку времени для модели.
string freshTimestampString()
Получить свежую строковую метку времени для модели.
bool usesTimestamps()
Определить, использует ли модель метки времени.
string getCreatedAtColumn()
Получить имя столбца "создано в".
string getUpdatedAtColumn()
Получить имя столбца "обновлено в".
array getHidden()
Получить скрытые атрибуты модели.
$this setHidden(array $hidden)
Установить скрытые атрибуты модели.
void addHidden(array|string|null $attributes = null)
Добавить скрытые атрибуты модели.
array getVisible()
Получить видимые атрибуты модели.
$this setVisible(array $visible)
Установить видимые атрибуты модели.
void addVisible(array|string|null $attributes = null)
Добавить видимые атрибуты для модели.
$this makeVisible(array|string $attributes)
Сделать указанные, как правило, скрытые атрибуты видимыми.
$this makeHidden(array|string $attributes)
Сделать указанные, как правило, видимые атрибуты скрытыми.
array getFillable()
Получить атрибуты, которые можно заполнять для модели.
$this fillable(array $fillable)
Установить атрибуты, которые можно заполнять для модели.
array getGuarded()
Получить защищенные атрибуты для модели.
$this guard(array $guarded)
Установить защищенные атрибуты для модели.
static void unguard(bool $state = true)
Отключить все ограничения массового назначения.
static void reguard()
Включить ограничения массового назначения.
static bool isUnguarded()
Определить, находится ли текущее состояние в режиме "без защиты".
static mixed unguarded(callable $callback)
Выполнить заданный вызов, отключив ограничения массового назначения.
bool isFillable(string $key)
Определить, может ли указанный атрибут быть массово назначенным.
bool isGuarded(string $key)
Определить, является ли данный ключ защищенным.
bool totallyGuarded()
Определить, полностью ли защищена модель.
protected array fillableFromArray(array $attributes)
Получить атрибуты, которые можно заполнять из заданного массива.
protected mixed forwardCallTo(mixed $object, string $method, array $parameters)
Перенаправить вызов метода данному объекту.
static protected void throwBadMethodCallException(string $method)
Выбросить исключение для вызова несуществующего метода.
void __construct(array $attributes = [])
Создать новый экземпляр модели Eloquent.
protected void bootIfNotBooted()
Проверить, нужна ли загрузка модели, и если да, то загрузить ее.
static protected void boot()
Метод "загрузки" модели.
static protected void bootTraits()
Загрузить все загружаемые черты модели.
protected void initializeTraits()
Инициализировать все инициализируемые черты модели.
static void clearBootedModels()
Очистить список загруженных моделей, чтобы они были перезагружены.
static void withoutTouching(callable $callback)
Отключает касание связанной модели для текущего класса в области заданного обратного вызова.
static void withoutTouchingOn(array $models, callable $callback)
Отключает касание модели отношений для заданных классов моделей во время выполнения заданного обратного вызова.
static bool isIgnoringTouch(string|null $class = null)
Определяет, игнорирует ли данная модель касания.
$this fill(array $attributes)
Заполняет модель массивом атрибутов.
$this forceFill(array $attributes)
Заполняет модель массивом атрибутов. Принудительно производит привязку данных.
string qualifyColumn(string $column)
Квалифицирует заданное имя столбца с помощью таблицы модели.
protected string removeTableFromKey(string $key)
Удаляет имя таблицы из заданного ключа.
Model newInstance(array $attributes = [], bool $exists = false)
Создаёт новый экземпляр заданной модели.
Model newFromBuilder(array $attributes = [], string|null $connection = null)
Создаёт новый экземпляр модели, которая уже существует.
static Builder on(string|null $connection = null)
Начинает запросы к модели на заданном соединении.
static Builder onWriteConnection()
Начинает запросы к модели на соединении записи.
static Collection|Model[] all(array|mixed $columns = ['*'])
Получить все модели из базы данных.
static Builder|Model with(array|string $relations)
Начинает запросы к модели с отложенной загрузкой.
$this load(array|string $relations)
Загрузить отношения модели с отложенной загрузкой.
$this loadMissing(array|string $relations)
Загрузить отношения модели с отложенной загрузкой, если они ещё не загружены.
$this loadCount(array|string $relations)
Загрузить счётчики отношений модели с отложенной загрузкой.
protected int increment(string $column, float|int $amount = 1, array $extra = [])
Увеличить значение столбца на заданную величину.
protected int decrement(string $column, float|int $amount = 1, array $extra = [])
Уменьшить значение столбца на заданную величину.
protected int incrementOrDecrement(string $column, float|int $amount, array $extra, string $method)
Выполнить метод увеличения или уменьшения значения столбца модели.
protected void incrementOrDecrementAttributeValue(string $column, float|int $amount, array $extra, string $method)
Увеличить или уменьшить значение атрибута и синхронизировать его с оригиналом.
bool update(array $attributes = [], array $options = [])
Обновить модель в базе данных.
bool push()
Сохранить модель и все её отношения.
bool save(array $options = [])
Сохранить модель в базе данных.
bool saveOrFail(array $options = [])
Сохранить модель в базе данных с использованием транзакции.
protected void finishSave(array $options)
Выполнить необходимые действия после сохранения модели.
protected bool performUpdate(Builder $query)
Выполнить операцию обновления модели.
protected mixed getKeyForSaveQuery()
Получить значение первичного ключа для запроса сохранения.
protected bool performInsert(Builder $query)
Выполнить операцию вставки модели.
protected void insertAndSetId(Builder $query, array $attributes)
Вставить заданные атрибуты и установить ID модели.
static int destroy(Collection|array|int $ids)
Удалить модели для заданных ID.
int delete()
Удалить запись пивот-модели из базы данных.
bool|null forceDelete()
Выполнить жесткое удаление мягко удалённой модели.
Этот метод защищает разработчиков от выполнения forceDelete, когда трейт отсутствует.
protected void performDeleteOnModel()
Выполнить фактический запрос удаления для этого экземпляра модели.
static Builder query()
Начать запрос к модели.
Builder newQuery()
Получить новый конструктор запроса для таблицы модели.
Builder|Model newModelQuery()
Получить новый конструктор запроса, в котором нет глобальных скопов или агрессивной загрузки.
Builder newQueryWithoutRelationships()
Получить новый конструктор запроса без загруженных отношений.
Builder registerGlobalScopes(Builder $builder)
Зарегистрировать глобальные скопы для этого экземпляра конструктора запроса.
Builder|Модель newQueryWithoutScopes()
Получить новый билдер запроса, который не содержит глобальных скопов.
Builder newQueryWithoutScope(Scope|string $scope)
Получить новый экземпляр запроса без указанного скопа.
Builder newQueryForRestoration(int[]|string[]|string $ids)
Получить новый запрос для восстановления одной или нескольких моделей по их очереди IDs.
protected Builder newBaseQueryBuilder()
Получить новый экземпляр билдера запроса для подключения.
Коллекция newCollection(array $models = [])
Создать новый экземпляр коллекции Eloquent.
Pivot newPivot(Модель $parent, array $attributes, string $table, bool $exists, string|null $using = null)
Создать новый экземпляр модели pivot.
array toArray()
Преобразовать экземпляр модели в массив.
string toJson(int $options = 0)
Преобразовать экземпляр модели в 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|null getConnectionName()
Получить имя текущего подключения для модели.
$this setConnection(string|null $name)
Установить подключение, связанное с моделью.
static Подключение resolveConnection(string|null $connection = null)
Разрешить экземпляр подключения.
статический Интерфейс разрешения соединения getConnectionResolver()
Получить экземпляр разрешителя соединения.
статический void setConnectionResolver(Интерфейс разрешения соединения $resolver)
Установить экземпляр разрешителя соединения.
статический void unsetConnectionResolver()
Удалить разрешитель соединения для моделей.
строка getTable()
Получить таблицу, связанную с моделью.
$this setTable(строка $table)
Установить таблицу, связанную с моделью.
строка getKeyName()
Получить первичный ключ для модели.
$this setKeyName(строка $key)
Установить первичный ключ для модели.
строка getQualifiedKeyName()
Получить квалифицированное имя первичного ключа таблицы.
строка getKeyType()
Получить тип автоинкрементного ключа.
$this setKeyType(строка $type)
Установить тип данных для первичного ключа.
логическое значение getIncrementing()
Получить значение, указывающее, являются ли идентификаторы инкрементируемыми.
$this setIncrementing(логическое значение $value)
Установить, являются ли идентификаторы инкрементируемыми.
смешанный тип getKey()
Получить значение первичного ключа модели.
смешанный тип getQueueableId()
Получить идентификатор очереди для сущности.
массив getQueueableRelations()
Получить отношения очереди для сущности.
строка|null getQueueableConnection()
Получить соединение очереди для сущности.
смешанный тип getRouteKey()
Получить значение маршрутного ключа модели.
строка getRouteKeyName()
Получить маршрутный ключ для модели.
Модель|null resolveRouteBinding(смешанный тип $value)
Получить модель для связанного значения.
строка getForeignKey()
Получить имя внешнего ключа столбца.
целое число getPerPage()
Получить количество моделей, возвращаемых на страницу.
$this setPerPage(целое число $perPage)
Установить количество моделей, возвращаемых на страницу.
смешанный тип __get(строка $key)
Динамически получить атрибуты модели.
void __set(строка $key, смешанный тип $value)
Динамически установить атрибуты модели.
логическое значение offsetExists(смешанный тип $offset)
Определить, существует ли данный атрибут.
смешанный тип offsetGet(смешанный тип $offset)
Получить значение для заданного смещения.
void offsetSet(mixed $offset, mixed $value)
Установить значение для заданного смещения.
void offsetUnset(mixed $offset)
Удалить значение для заданного смещения.
bool __isset(string $key)
Определить, существует ли атрибут или отношение в модели.
void __unset(string $key)
Удалить атрибут в модели.
mixed __call(string $method, array $parameters)
Обработка динамических вызовов методов в модели.
static mixed __callStatic(string $method, array $parameters)
Обработка динамических статических вызовов методов в методе.
string __toString()
Преобразовать модель в строковое представление.
void __wakeup()
При десериализации модели проверить, нужно ли её инициализировать.
static AsPivot fromAttributes(Model $parent, array $attributes, string $table, bool $exists = false)
Создать новый экземпляр модели-связи.
static AsPivot fromRawAttributes(Model $parent, array $attributes, string $table, bool $exists = false)
Создать новую модель-связь из необработанных значений, возвращенных запросом.
protected Builder getDeleteQuery()
Получить обработчик запросов для удаления связующей модели.
string getRelatedKey()
Получить имя столбца "связанного ключа".
string getOtherKey()
Получить имя столбца "связанного ключа".
$this setPivotKeys(string $foreignKey, string $relatedKey)
Установить имена ключей для экземпляра связующей модели.
bool hasTimestampAttributes(array|null $attributes = null)
Определить, имеет ли связующая модель или заданные атрибуты атрибуты времени.
protected Builder newQueryForCollectionRestoration(array $ids)
Получить новый запрос для восстановления нескольких моделей по их очередным идентификаторам.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.8/Illuminate/Database/Eloquent/Relations/Pivot.html