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