Pivot
class Pivot extends Model (View source)
Константы
| CREATED_AT | Имя столбца «создано в». |
| UPDATED_AT | Имя столбца «обновлено в». |
Свойства
| protected string | $connection | Имя подключения для модели. | из Model |
| protected string | $table | Таблица, связанная с моделью. | из Model |
| protected string | $primaryKey | Первичный ключ для модели. | из Model |
| protected string | $keyType | Тип автоинкрементируемого ID. | из Model |
| protected int | $perPage | Количество моделей для возврата при пагинации. | из Model |
| bool | $incrementing | Указывает, являются ли ID автоинкрементируемыми. | из Model |
| bool | $timestamps | Указывает, должна ли модель иметь временные метки. | из Model |
| protected array | $attributes | Атрибуты модели. | из Model |
| protected array | $original | Исходное состояние атрибутов модели. | из Model |
| protected array | $relations | Загруженные отношения для модели. | из Model |
| $hidden | Атрибуты, которые должны быть скрыты в массивах. | из Model | |
| protected array | $visible | Атрибуты, которые должны быть видимы в массивах. | из Model |
| protected array | $appends | Доступные методы для добавления к представлению модели в виде массива. | из Model |
| protected array | $fillable | Атрибуты, которые можно массово назначать. | из Model |
| protected array | $guarded | Атрибуты, которые нельзя массово назначать. | |
| protected array | $dates | Атрибуты, которые следует преобразовывать в даты. | из Model |
| protected string | $dateFormat | Формат хранения столбцов даты модели. | из Model |
| protected array | $casts | Атрибуты, которые следует преобразовывать в базовые типы. | из Model |
| protected array | $touches | Отношения, которые следует обновлять при сохранении. | из Model |
| protected array | $observables | Доступные события observable. | из Model |
| protected array | $with | Отношения, которые необходимо загрузить при каждом запросе. | из Model |
| protected string | $morphClass | Имя класса, которое следует использовать в полиморфных отношениях. | из Model |
| bool | $exists | Указывает, существует ли модель. | из Model |
| bool | $wasRecentlyCreated | Указывает, была ли модель вставлена в течение текущего цикла запроса. | из Model |
| static bool | $snakeAttributes | Указывает, следует ли преобразовывать атрибуты в змеиный регистр в массивах. | из Model |
| static protected ConnectionResolverInterface | $resolver | Экземпляр решателя подключений. | из Model |
| static protected Dispatcher | $dispatcher | Экземпляр диспетчера событий. | из Model |
| static protected array | $booted | Массив запущенных моделей. | из Model |
| static protected array | $globalScopes | Массив глобальных скопов модели. | из Model |
| static protected bool | $unguarded | Указывает, включено ли массовое назначение всех атрибутов. | из Model |
| static protected array | $mutatorCache | Кэш мутированных атрибутов для каждого класса. | из Model |
| static array | $manyMethods | Методы многих-ко-многим отношений. | из Model |
| protected Model | $parent | Родительская модель отношения. | |
| protected string | $foreignKey | Имя столбца внешнего ключа. | |
| protected string | $otherKey | Имя столбца «другого ключа». |
Методы
| 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 |
| static mixed | addGlobalScope(Scope|Closure|string $scope, Closure $implementation = null) Зарегистрировать новую глобальную область видимости в модели. | from Model |
| static bool | hasGlobalScope(Scope|string $scope) Определить, имеет ли модель глобальную область видимости. | from Model |
| static Scope|Closure|null | getGlobalScope(Scope|string $scope) Получить глобальную область видимости, зарегистрированную в модели. | from Model |
| array | getGlobalScopes() Получить глобальные области видимости для этого экземпляра класса. | from Model |
| static void | observe(object|string $class, int $priority) Зарегистрировать наблюдателя в модели. | from Model |
| $this | fill(array $attributes) Заполнить модель массивом атрибутов. | from Model |
| $this | forceFill(array $attributes) Заполнить модель массивом атрибутов. Принудительное массовое присваивание. | from Model |
| array | fillableFromArray(array $attributes) Получить заполняемые атрибуты данного массива. | from Model |
| Model | newInstance(array $attributes = [], bool $exists = false) Создать новый экземпляр данной модели. | from Model |
| Model | newFromBuilder(array $attributes = [], string|null $connection = null) Создать новый экземпляр модели, который существует. | from Model |
| static Collection | hydrate(array $items, string|null $connection = null) Создать коллекцию моделей из простых массивов. | from Model |
| static Collection | hydrateRaw(string $query, array $bindings = [], string|null $connection = null) Создать коллекцию моделей из необработанного запроса. | from Model |
| static Model | create(array $attributes = []) Сохранить новую модель и вернуть экземпляр. | from Model |
| static Model | forceCreate(array $attributes) Сохранить новую модель и вернуть экземпляр. Разрешить массовое присваивание. | from Model |
| static Builder | query() Начать запрос модели. | 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 |
| $this|null | fresh(array|string $with = []) Перезагрузить свежий экземпляр модели из базы данных. | from Model |
| $this | load(array|string $relations) Жадная загрузка отношений в модели. | from Model |
| static Builder|Model | with(array|string $relations) Начать запрос модели с жадной загрузкой. | from Model |
| $this | append(array|string $attributes) Добавить атрибуты к запросу при построении запроса. | from Model |
| HasOne | hasOne(string $related, string $foreignKey = null, string $localKey = null) Определить отношение один-к-одному. | from Model |
| MorphOne | morphOne(string $related, string $name, string $type = null, string $id = null, string $localKey = null) Определить полиморфное отношение один-к-одному. | from Model |
| BelongsTo | belongsTo(string $related, string $foreignKey = null, string $otherKey = null, string $relation = null) Определить обратное одно-к-одному или множественному отношению. | from Модель |
| MorphTo | morphTo(string $name = null, string $type = null, string $id = null) Определить полиморфное, обратное одно-к-одному или множественному отношению. | from Модель |
| string | getActualClassNameForMorph(string $class) Получить полное имя класса по псевдониму. | from Модель |
| HasMany | hasMany(string $related, string $foreignKey = null, string $localKey = null) Определить отношение один-ко-многим. | from Модель |
| HasManyThrough | hasManyThrough(string $related, string $through, string|null $firstKey = null, string|null $secondKey = null, string|null $localKey = null) Определить отношение has-many-through. | from Модель |
| MorphMany | morphMany(string $related, string $name, string $type = null, string $id = null, string $localKey = null) Определить полиморфное отношение один-ко-многим. | from Модель |
| BelongsToMany | belongsToMany(string $related, string $table = null, string $foreignKey = null, string $otherKey = null, string $relation = null) Определить отношение многие-ко-многим. | from Модель |
| MorphToMany | morphToMany(string $related, string $name, string $table = null, string $foreignKey = null, string $otherKey = null, bool $inverse = false) Определить полиморфное отношение многие-ко-многим. | from Модель |
| MorphToMany | morphedByMany(string $related, string $name, string $table = null, string $foreignKey = null, string $otherKey = null) Определить полиморфное, обратное отношение многие-ко-многим. | from Модель |
| string | getBelongsToManyCaller() Получить имя связи belongs to many. | from Модель |
| string | joiningTable(string $related) Получить имя таблицы соединения для связи многие-ко-многим. | from Модель |
| static int | destroy(array|int $ids) Удалить модели по заданным идентификаторам. | from Модель |
| bool|null | delete() Удалить запись модели pivot из базы данных. | |
| bool|null | forceDelete() Выполнить жесткое удаление мягко удалённой модели. | from Модель |
| void | performDeleteOnModel() Выполнить фактическое удаление запроса на эту модель. | from Модель |
| static void | saving(Closure|string $callback, int $priority) Зарегистрировать событие сохранения модели с диспетчером. | from Модель |
| static void | saved(Closure|string $callback, int $priority) Зарегистрировать событие сохранения модели с диспетчером. | from Модель |
| static void | updating(Closure|string $callback, int $priority) Зарегистрировать событие обновления модели с диспетчером. | from Модель |
| static void | updated(Closure|string $callback, int $priority) Зарегистрировать событие обновления модели с диспетчером. | from Модель |
| static void | creating(Closure|string $callback, int $priority) Зарегистрировать событие создания модели с диспетчером. | from Модель |
| static void | created(Closure|string $callback, int $priority) Зарегистрировать событие создания модели с диспетчером. | from Модель |
| static void | deleting(Closure|string $callback, int $priority) Зарегистрировать событие удаления модели с диспетчером. | from Модель |
| static void | deleted(Closure|string $callback, int $priority) Зарегистрировать событие удаления модели с диспетчером. | from Модель |
| static void | flushEventListeners() Удалить все обработчики событий для модели. | from Модель |
| static void | registerModelEvent(string $event, Closure|string $callback, int $priority) Зарегистрировать событие модели с диспетчером. | from Модель |
| array | getObservableEvents() Получить имена наблюдаемых событий. | from Модель |
| $this | setObservableEvents(array $observables) Установить имена наблюдаемых событий. | from Модель |
| void | addObservableEvents(array|mixed $observables) Добавить имя наблюдаемого события. | from Модель |
| void | removeObservableEvents(array|mixed $observables) Удалить имя наблюдаемого события. | 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, string $method) Увеличить базовое значение атрибута и синхронизировать с оригиналом. | from Model |
| bool|int | 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, array $options = []) Выполнить операцию обновления модели. | from Model |
| bool | performInsert(Builder $query, array $options = []) Выполнить операцию вставки модели. | from Model |
| void | insertAndSetId(Builder $query, array $attributes) Вставить заданные атрибуты и установить ID в модели. | from Model |
| void | touchOwners() Обновить время изменения связанных моделей. | from Model |
| bool | touches(string $relation) Определить, затрагивает ли модель данное отношение. | from Model |
| mixed | fireModelEvent(string $event, bool $halt = true) Вызвать заданное событие для модели. | from Model |
| Builder | setKeysForSaveQuery(Builder $query) Установить ключи для запроса обновления при сохранении. | |
| mixed | getKeyForSaveQuery() Получить значение первичного ключа для запроса сохранения. | from Model |
| bool | touch() Обновить временную метку обновления модели. | from Model |
| void | updateTimestamps() Обновить метки времени создания и обновления. | from Model |
| $this | setCreatedAt(mixed $value) Установить значение атрибута "created at". | from Model |
| $this | setUpdatedAt(mixed $value) Установить значение атрибута "updated at". | from Model |
| string | getCreatedAtColumn() Получить имя столбца "created at". | |
| string | getUpdatedAtColumn() Получить имя столбца "updated at". | |
| Carbon | freshTimestamp() Получить свежую временную метку для модели. | from Model |
| string | freshTimestampString() Получить свежую временную метку для модели. | from Model |
| Builder | newQuery() Получить новый построитель запросов для таблицы модели. | from Model |
| Builder | newQueryWithoutScope(Scope|string $scope) Получить новый экземпляр запроса без заданной области видимости. | from Model |
| Builder|Model | newQueryWithoutScopes() Получить новый построитель запросов, который не имеет глобальных областей видимости. | from Model |
| Builder|Model | newEloquentBuilder(Builder $query) Создать новый построитель запросов Eloquent для модели. | from Model |
| Builder | newBaseQueryBuilder() Получить новый экземпляр построителя запросов для соединения. | from Model |
| Коллекция | newCollection(array $models = []) Создать новый экземпляр коллекции Eloquent. | от Модель |
| Связь | newPivot(Модель $parent, array $attributes, string $table, bool $exists) Создать новый экземпляр модели связи. | от Модель |
| string | getTable() Получить таблицу, связанную с моделью. | от Модель |
| $this | setTable(string $table) Установить таблицу, связанную с моделью. | от Модель |
| mixed | getKey() Получить значение первичного ключа модели. | от Модель |
| mixed | getQueueableId() Получить идентификатор очереди для сущности. | от Модель |
| string | getKeyName() Получить первичный ключ модели. | от Модель |
| $this | setKeyName(string $key) Установить первичный ключ модели. | от Модель |
| string | getQualifiedKeyName() Получить имя квалифицированного первичного ключа. | от Модель |
| mixed | getRouteKey() Получить значение ключа маршрута модели. | от Модель |
| string | getRouteKeyName() Получить ключ маршрута для модели. | от Модель |
| bool | usesTimestamps() Определить, использует ли модель метки времени. | от Модель |
| array | getMorphs(string $name, string $type, string $id) Получить столбцы полиморфных отношений. | от Модель |
| string | getMorphClass() Получить имя класса для полиморфных отношений. | от Модель |
| int | getPerPage() Получить количество моделей на страницу. | от Модель |
| $this | setPerPage(int $perPage) Установить количество моделей на страницу. | от Модель |
| string | getForeignKey() Получить имя столбца внешнего ключа. | |
| array | getHidden() Получить скрытые атрибуты модели. | от Модель |
| $this | setHidden(array $hidden) Установить скрытые атрибуты модели. | от Модель |
| void | addHidden(array|string|null $attributes = null) Добавить скрытые атрибуты модели. | от Модель |
| $this | makeVisible(array|string $attributes) Сделать указанные атрибуты, обычно скрытые, видимыми. | от Модель |
| $this | makeHidden(array|string $attributes) Скрыть указанные атрибуты, обычно видимые. | от Модель |
| $this | withHidden(array|string $attributes) устарел Сделать указанные атрибуты, обычно скрытые, видимыми. | от Модель |
| array | getVisible() Получить видимые атрибуты модели. | от Модель |
| $this | setVisible(array $visible) Установить видимые атрибуты модели. | от Модель |
| void | addVisible(array|string|null $attributes = null) Добавить видимые атрибуты модели. | от Модель |
| $this | setAppends(array $appends) Установить аксессоры для добавления в массивы модели. | от Модель |
| array | getFillable() Получить заполняемые атрибуты модели. | от Модель |
| $this | fillable(array $fillable) Установить заполняемые атрибуты модели. | от Модель |
| array | getGuarded() Получить защищенные атрибуты модели. | от Модель |
| $this | guard(array $guarded) Установить защищенные атрибуты модели. | от Модель |
| static void | unguard(bool $state = true) Отключить все ограничения массового присвоения. | от Модель |
| static void | reguard() Включить ограничения массового присвоения. | от Модель |
| static bool | isUnguarded() Определить, находится ли текущее состояние в режиме "unguarded". | от Модель |
| static mixed | unguarded(callable $callback) Выполнить предоставленный вызов, будучи без защиты. | from Model |
| bool | isFillable(string $key) Определить, может ли заданный атрибут быть назначенным массово. | from Model |
| bool | isGuarded(string $key) Определить, является ли заданный ключ защищённым. | from Model |
| bool | totallyGuarded() Определить, является ли модель полностью защищённой. | from Model |
| string | removeTableFromKey(string $key) Удалить имя таблицы из заданного ключа. | from Model |
| array | getTouchedRelations() Получить отношения, которые затрагиваются при сохранении. | from Model |
| $this | setTouchedRelations(array $touches) Установить отношения, которые затрагиваются при сохранении. | from Model |
| bool | getIncrementing() Получить значение, указывающее, являются ли идентификаторы нарастающими. | from Model |
| $this | setIncrementing(bool $value) Установить, являются ли идентификаторы нарастающими. | from Model |
| string | toJson(int $options) Преобразовать экземпляр модели в JSON. | from Model |
| array | jsonSerialize() Преобразовать объект в сериализуемый JSON. | from Model |
| array | toArray() Преобразовать экземпляр модели в массив. | from Model |
| array | attributesToArray() Преобразовать атрибуты модели в массив. | from Model |
| array | getArrayableAttributes() Получить массив атрибутов всех массивообразуемых атрибутов. | from Model |
| array | getArrayableAppends() Получить все значения добавления, которые являются массивообразуемыми. | from Model |
| array | relationsToArray() Получить отношения модели в виде массива. | from Model |
| array | getArrayableRelations() Получить массив атрибутов всех массивообразуемых отношений. | from Model |
| array | getArrayableItems(array $values) Получить массив атрибутов всех массивообразуемых значений. | from Model |
| mixed | getAttribute(string $key) Получить атрибут из модели. | from Model |
| mixed | getAttributeValue(string $key) Получить простой атрибут (не отношение). | from Model |
| mixed | getRelationValue(string $key) Получить отношение. | from Model |
| mixed | getAttributeFromArray(string $key) Получить атрибут из массива $attributes. | from Model |
| mixed | getRelationshipFromMethod(string $method) Получить значение отношения из метода. | from Model |
| bool | hasGetMutator(string $key) Определить, существует ли мутатор получения для атрибута. | from Model |
| mixed | mutateAttribute(string $key, mixed $value) Получить значение атрибута, используя его мутатор. | from Model |
| mixed | mutateAttributeForArray(string $key, mixed $value) Получить значение атрибута, используя его мутатор для преобразования в массив. | from Model |
| bool | hasCast(string $key, array|string|null $types = null) Определить, должен ли атрибут быть преобразован к собственному типу. | from Model |
| array | getCasts() Получить массив преобразований. | from Model |
| bool | isDateCastable(string $key) Определить, является ли значение приводимым к дате/времени для обработки входных данных. | from Model |
| bool | isJsonCastable(string $key) Определить, является ли значение приводимым к JSON для обработки входных данных. | from Model |
| string | getCastType(string $key) Получить тип преобразования для атрибута модели. | from Model |
| mixed | castAttribute(string $key, mixed $value) Преобразовать атрибут к собственному типу PHP. | from Model |
| $this | setAttribute(string $key, mixed $value) Установить заданный атрибут модели. | from Model |
| bool | hasSetMutator(string $key) Определить, существует ли мутатор для установки атрибута. | from Model |
| array | getDates() Получить атрибуты, которые должны быть преобразованы в даты. | from Model |
| string | fromDateTime(DateTime|int $value) Преобразовать DateTime в хранимую строку. | from Model |
| Carbon | asDateTime(mixed $value) Возвратить метку времени как объект DateTime. | from Model |
| int | asTimeStamp(mixed $value) Возвратить метку времени как отметку Unix-времени. | from Model |
| string | serializeDate(DateTime $date) Подготовить дату для сериализации в массив/JSON. | from Model |
| string | getDateFormat() Получить формат дат, хранимых в базе данных. | from Model |
| $this | setDateFormat(string $format) Установить формат даты, используемый моделью. | from Model |
| string | asJson(mixed $value) Кодировать значение в JSON. | from Model |
| mixed | fromJson(string $value, bool $asObject = false) Декодировать полученный JSON в массив или объект. | from Model |
| Model | replicate(array $except = null) Создать клон модели в новом, не существующем экземпляре. | from Model |
| array | getAttributes() Получить все текущие атрибуты модели. | from Model |
| $this | setRawAttributes(array $attributes, bool $sync = false) Установить массив атрибутов модели. Проверка не выполняется. | from Model |
| mixed|array | getOriginal(string|null $key = null, mixed $default = null) Получить исходные значения атрибутов модели. | from Model |
| $this | syncOriginal() Синхронизировать исходные атрибуты с текущими. | from Model |
| $this | syncOriginalAttribute(string $attribute) Синхронизировать отдельный исходный атрибут со своим текущим значением. | from Model |
| bool | isDirty(array|string|null $attributes = null) Определить, была ли модель или заданный атрибут(ы) изменены. | from Model |
| array | getDirty() Получить атрибуты, которые были изменены с момента последней синхронизации. | from Model |
| bool | originalIsNumericallyEquivalent(string $key) Определить, численно ли новые и старые значения для данного ключа эквивалентны. | from Model |
| array | getRelations() Получить все загруженные отношения для экземпляра. | from Model |
| mixed | getRelation(string $relation) Получить указанное отношение. | from Model |
| bool | relationLoaded(string $key) Определить, загружено ли указанное отношение. | from Model |
| $this | setRelation(string $relation, mixed $value) Установить конкретное отношение в модели. | from Model |
| $this | setRelations(array $relations) Установить весь массив отношений в модели. | from Model |
| Connection | getConnection() Получить подключение к базе данных для модели. | from Model |
| string | getConnectionName() Получить текущее имя подключения для модели. | from Model |
| $this | setConnection(string $name) Установить подключение, связанное с моделью. | from Model |
| static Connection | resolveConnection(string|null $connection = null) Разрешить экземпляр подключения. | from Model |
| static ConnectionResolverInterface | getConnectionResolver() Получить экземпляр обработчика подключений. | from Model |
| static void | setConnectionResolver(ConnectionResolverInterface $resolver) Установить экземпляр обработчика подключений. | from Model |
| static void | unsetConnectionResolver() Удалить обработчик подключений для моделей. | from Model |
| static Dispatcher | getEventDispatcher() Получить экземпляр диспетчера событий. | из Model |
| static void | setEventDispatcher(Dispatcher $dispatcher) Установить экземпляр диспетчера событий. | из Model |
| static void | unsetEventDispatcher() Удалить диспетчер событий для моделей. | из Model |
| array | getMutatedAttributes() Получить изменённые атрибуты для данного экземпляра. | из Model |
| static void | cacheMutatedAttributes(string $class) Извлечь и кэшировать все изменённые атрибуты класса. | из 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) Создать новую модель связующего элемента из значений, возвращённых запросом. | |
| Builder | getDeleteQuery() Получить конструктор запроса для удаления связующего элемента. | |
| string | getOtherKey() Получить имя столбца "другого ключа". | |
| $this | setPivotKeys(string $foreignKey, string $otherKey) Установить имена ключей для экземпляра модели связующего элемента. | |
| bool | hasTimestampAttributes() Определить, имеет ли модель связующего элемента атрибуты времени. |
Подробности
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()
Очистить список загруженных моделей, чтобы они были перезагружены.
static mixed addGlobalScope(Scope|Closure|string $scope, Closure $implementation = null)
Зарегистрировать новый глобальный scope модели.
static bool hasGlobalScope(Scope|string $scope)
Определить, имеет ли модель глобальный scope.
static Область|Closure|null getGlobalScope(Область|string $scope)
Получить глобальную область, зарегистрированную с моделью.
array getGlobalScopes()
Получить глобальные области для этого экземпляра класса.
static void observe(object|string $class, int $priority)
Зарегистрировать наблюдателя с моделью.
$this fill(array $attributes)
Заполнить модель массивом атрибутов.
$this forceFill(array $attributes)
Заполнить модель массивом атрибутов. Принудительно разрешить массовое присваивание.
protected array fillableFromArray(array $attributes)
Получить заполняемые атрибуты из заданного массива.
Модель newInstance(array $attributes = [], bool $exists = false)
Создать новый экземпляр заданной модели.
Модель newFromBuilder(array $attributes = [], string|null $connection = null)
Создать новый экземпляр модели, которая уже существует.
static Коллекция hydrate(array $items, string|null $connection = null)
Создать коллекцию моделей из обычных массивов.
static Коллекция hydrateRaw(string $query, array $bindings = [], string|null $connection = null)
Создать коллекцию моделей из запроса в сыром формате.
static Модель create(array $attributes = [])
Сохранить новую модель и вернуть экземпляр.
static Модель forceCreate(array $attributes)
Сохранить новую модель и вернуть экземпляр. Разрешить массовое присваивание.
static Построитель query()
Начать формирование запроса к модели.
static Построитель on(string|null $connection = null)
Начать формирование запроса к модели на заданном соединении.
static Построитель onWriteConnection()
Начать формирование запроса к модели на соединении для записи.
$this|null fresh(array|string $with = [])
Перезагрузить свежий экземпляр модели из базы данных.
$this load(array|string $relations)
Загрузить отношения модели с жадной загрузкой.
$this append(array|string $attributes)
Добавить атрибуты к запросу при построении запроса.
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 $otherKey = null, string $relation = null)
Определить обратное отношение один-к-одному или многие-к-одному.
MorphTo morphTo(string $name = null, string $type = null, string $id = null)
Определить полиморфное обратное отношение один-к-одному или многие-к-одному.
string getActualClassNameForMorph(string $class)
Получить полное имя класса по псевдониму.
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 $otherKey = null, string $relation = null)
Определить отношение многие ко многим.
MorphToMany morphToMany(string $related, string $name, string $table = null, string $foreignKey = null, string $otherKey = null, bool $inverse = false)
Определить полиморфное отношение многие ко многим.
MorphToMany morphedByMany(string $related, string $name, string $table = null, string $foreignKey = null, string $otherKey = null)
Определить полиморфное, обратное отношение многие ко многим.
protected string getBelongsToManyCaller()
Получить имя отношения belongs to many.
строка joiningTable(строка $related)
Получить имя таблицы соединения для связи многие ко многим.
статический целое число destroy(массив|целое число $ids)
Удалить модели для заданных идентификаторов.
логическое значение|null delete()
Удалить запись модели соединения из базы данных.
логическое значение|null forceDelete()
Принудительно удалить мягко удалённую модель.
Этот метод защищает разработчиков от запуска forceDelete, когда отсутствует trait.
защищённый пустое значение performDeleteOnModel()
Выполнить фактический запрос удаления на этом экземпляре модели.
статический пустое значение saving(Closure|строка $callback, целое число $priority)
Зарегистрировать событие сохранения модели в диспетчере.
статический пустое значение saved(Closure|строка $callback, целое число $priority)
Зарегистрировать событие сохранения модели в диспетчере.
статический пустое значение updating(Closure|строка $callback, целое число $priority)
Зарегистрировать событие обновления модели в диспетчере.
статический пустое значение updated(Closure|строка $callback, целое число $priority)
Зарегистрировать событие обновления модели в диспетчере.
статический пустое значение creating(Closure|строка $callback, целое число $priority)
Зарегистрировать событие создания модели в диспетчере.
статический пустое значение created(Closure|строка $callback, целое число $priority)
Зарегистрировать событие создания модели в диспетчере.
статический пустое значение deleting(Closure|строка $callback, целое число $priority)
Зарегистрировать событие удаления модели в диспетчере.
статический пустое значение deleted(Closure|строка $callback, целое число $priority)
Зарегистрировать событие удаления модели в диспетчере.
статический пустое значение flushEventListeners()
Удалить все слушатели событий для модели.
статический защищённый пустое значение registerModelEvent(строка $event, Closure|строка $callback, целое число $priority)
Зарегистрировать событие модели в диспетчере.
массив getObservableEvents()
Получить имена наблюдаемых событий.
$this setObservableEvents(массив $observables)
Установить имена наблюдаемых событий.
пустое значение addObservableEvents(массив|смешанный $observables)
Добавить имя наблюдаемого события.
пустое значение removeObservableEvents(массив|смешанный $observables)
Удалить имя наблюдаемого события.
защищённый целое число increment(строка $column, целое число $amount = 1, массив $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, string $method)
Увеличить или уменьшить значение базового атрибута и синхронизировать его с исходным.
bool|int 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, array $options = [])
Выполнить операцию обновления модели.
protected bool performInsert(Builder $query, array $options = [])
Выполнить операцию вставки модели.
protected void insertAndSetId(Builder $query, array $attributes)
Вставить заданные атрибуты и установить ID модели.
void touchOwners()
Обновить метки времени для владеющих отношений модели.
bool touches(string $relation)
Определить, обновляет ли модель указанное отношение.
protected mixed fireModelEvent(string $event, bool $halt = true)
Сгенерировать заданное событие для модели.
protected mixed getKeyForSaveQuery()
Получить значение первичного ключа для запроса сохранения.
bool touch()
Обновить отметку времени последнего обновления модели.
protected void updateTimestamps()
Обновить отметки времени создания и обновления.
$this setCreatedAt(mixed $value)
Установить значение атрибута "created at".
$this setUpdatedAt(mixed $value)
Установить значение атрибута "updated at".
string getCreatedAtColumn()
Получить имя столбца "created at".
строка getUpdatedAtColumn()
Получить имя столбца «обновлено».
Carbon freshTimestamp()
Получить свежий отметку времени для модели.
строка freshTimestampString()
Получить свежую отметку времени для модели.
Билдер newQuery()
Получить новый билдер запроса для таблицы модели.
Билдер newQueryWithoutScope(Сcope|строка $scope)
Получить новый экземпляр запроса без указанного scope.
Билдер|Модель newQueryWithoutScopes()
Получить новый билдер запросов, не содержащий глобальных scope.
protected Билдер newBaseQueryBuilder()
Получить новый экземпляр билдера запросов для подключения.
Коллекция newCollection(array $models = [])
Создать новый экземпляр коллекции Eloquent.
Пивот newPivot(Модель $parent, array $attributes, string $table, bool $exists)
Создать новый экземпляр модели пивот.
строка getTable()
Получить таблицу, связанную с моделью.
$this setTable(строка $table)
Установить таблицу, связанную с моделью.
смешанный тип getKey()
Получить значение первичного ключа модели.
смешанный тип getQueueableId()
Получить идентификатор queueable для сущности.
строка getKeyName()
Получить первичный ключ для модели.
$this setKeyName(строка $key)
Установить первичный ключ для модели.
строка getQualifiedKeyName()
Получить имя ключа, квалифицированное таблицей.
смешанный тип getRouteKey()
Получить значение ключа маршрута модели.
строка getRouteKeyName()
Получить ключ маршрута для модели.
логическое usesTimestamps()
Определить, использует ли модель отметки времени.
protected массив getMorphs(строка $name, строка $type, строка $id)
Получить столбцы полиморфных отношений.
строка getMorphClass()
Получить имя класса для полиморфных отношений.
целое число getPerPage()
Получить количество моделей, возвращаемых на страницу.
$this setPerPage(int $perPage)
Установить количество моделей, возвращаемых за страницу.
string getForeignKey()
Получить имя столбца внешнего ключа.
array getHidden()
Получить скрытые атрибуты для модели.
$this setHidden(array $hidden)
Установить скрытые атрибуты для модели.
void addHidden(array|string|null $attributes = null)
Добавить скрытые атрибуты для модели.
$this makeVisible(array|string $attributes)
Сделать заданные, обычно скрытые, атрибуты видимыми.
$this makeHidden(array|string $attributes)
Сделать заданные, обычно видимые, атрибуты скрытыми.
$this withHidden(array|string $attributes) deprecated
deprecated
Сделать заданные, обычно скрытые, атрибуты видимыми.
array getVisible()
Получить видимые атрибуты для модели.
$this setVisible(array $visible)
Установить видимые атрибуты для модели.
void addVisible(array|string|null $attributes = null)
Добавить видимые атрибуты для модели.
$this setAppends(array $appends)
Установить аксессоры для добавления в массивы модели.
array getFillable()
Получить заполняемые атрибуты для модели.
$this fillable(array $fillable)
Установить заполняемые атрибуты для модели.
array getGuarded()
Получить защищённые атрибуты для модели.
$this guard(array $guarded)
Установить защищённые атрибуты для модели.
static void unguard(bool $state = true)
Отключить все ограничения массового присваивания.
static void reguard()
Включить ограничения массового присваивания.
static bool isUnguarded()
Определить, находится ли текущее состояние в режиме "unguarded".
static mixed unguarded(callable $callback)
Выполнить заданный вызываемый объект в режиме "unguarded".
bool isFillable(string $key)
Определить, может ли заданный атрибут быть присвоен массово.
bool isGuarded(string $key)
Определить, является ли заданный ключ защищённым.
bool totallyGuarded()
Определить, является ли модель полностью защищённой.
protected string removeTableFromKey(string $key)
Удалить имя таблицы из заданного ключа.
array getTouchedRelations()
Получить отношения, которые затрагиваются при сохранении.
$this setTouchedRelations(array $touches)
Установить взаимосвязи, которые затрагиваются при сохранении.
bool getIncrementing()
Получить значение, указывающее, увеличиваются ли идентификаторы.
$this setIncrementing(bool $value)
Установить, увеличиваются ли идентификаторы.
string toJson(int $options)
Преобразовать экземпляр модели в JSON.
array jsonSerialize()
Преобразовать объект в сериализуемый в JSON.
array toArray()
Преобразовать экземпляр модели в массив.
array attributesToArray()
Преобразовать атрибуты модели в массив.
protected array getArrayableAttributes()
Получить массив атрибутов, которые можно преобразовать в массив.
protected array getArrayableAppends()
Получить все добавляемые значения, которые можно преобразовать в массив.
array relationsToArray()
Получить отношения модели в формате массива.
protected array getArrayableRelations()
Получить массив всех отношений, которые можно преобразовать в массив.
protected array getArrayableItems(array $values)
Получить массив всех значений, которые можно преобразовать в массив.
mixed getAttribute(string $key)
Получить атрибут из модели.
mixed getAttributeValue(string $key)
Получить простой атрибут (не отношение).
mixed getRelationValue(string $key)
Получить отношение.
protected mixed getAttributeFromArray(string $key)
Получить атрибут из массива $attributes.
protected mixed getRelationshipFromMethod(string $method)
Получить значение отношения из метода.
bool hasGetMutator(string $key)
Определить, существует ли мутатор get для атрибута.
protected mixed mutateAttribute(string $key, mixed $value)
Получить значение атрибута с помощью его мутатора.
protected mixed mutateAttributeForArray(string $key, mixed $value)
Получить значение атрибута с помощью его мутатора для преобразования в массив.
bool hasCast(string $key, array|string|null $types = null)
Определить, должен ли атрибут быть преобразован в базовый тип.
array getCasts()
Получить массив преобразуемых типов.
protected bool isDateCastable(string $key)
Определить, можно ли преобразовать значение в дату/время для входящей обработки.
protected bool isJsonCastable(string $key)
Определить, можно ли преобразовать значение в JSON для входящей обработки.
protected string getCastType(string $key)
Получить тип преобразования для атрибута модели.
protected mixed castAttribute(string $key, mixed $value)
Преобразовать атрибут в базовый тип PHP.
$this setAttribute(string $key, mixed $value)
Установить заданный атрибут в модели.
bool hasSetMutator(string $key)
Определить, существует ли мутатор set для атрибута.
array getDates()
Получить атрибуты, которые должны быть преобразованы в даты.
string fromDateTime(DateTime|int $value)
Преобразовать DateTime в строку, подходящую для хранения.
protected Carbon asDateTime(mixed $value)
Возвратить временную метку как объект DateTime.
protected int asTimeStamp(mixed $value)
Возвратить временную метку как unix timestamp.
protected string serializeDate(DateTime $date)
Подготовить дату для сериализации в массив/JSON.
protected string getDateFormat()
Получить формат дат для базы данных.
$this setDateFormat(string $format)
Установить формат даты, используемый моделью.
protected string asJson(mixed $value)
Кодировать заданное значение в JSON.
mixed fromJson(string $value, bool $asObject = false)
Декодировать заданный JSON в массив или объект.
Модель replicate(array $except = null)
Создать клон модели в новый, незадействованный экземпляр.
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)
Определить, была ли изменена модель или заданный атрибут(ы).
array getDirty()
Получить атрибуты, измененные с момента последней синхронизации.
protected bool originalIsNumericallyEquivalent(string $key)
Определить, являются ли новые и старые значения для данного ключа численно эквивалентными.
array getRelations()
Получить все загруженные отношения для экземпляра.
mixed getRelation(string $relation)
Получить указанное отношение.
bool relationLoaded(string $key)
Определить, загружено ли данное отношение.
$this setRelation(string $relation, mixed $value)
Установить конкретное отношение в модели.
$this setRelations(array $relations)
Установить весь массив отношений в модели.
Connection getConnection()
Получить подключение к базе данных для модели.
string getConnectionName()
Получить текущее имя подключения для модели.
$this setConnection(string $name)
Установить подключение, связанное с моделью.
static Connection resolveConnection(string|null $connection = null)
Разрешить экземпляр подключения.
static ConnectionResolverInterface getConnectionResolver()
Получить экземпляр обработчика подключений.
static void setConnectionResolver(ConnectionResolverInterface $resolver)
Установить экземпляр обработчика подключений.
static void unsetConnectionResolver()
Удалить обработчик подключений для моделей.
static Dispatcher getEventDispatcher()
Получить экземпляр диспетчера событий.
static void setEventDispatcher(Dispatcher $dispatcher)
Установить экземпляр диспетчера событий.
static void unsetEventDispatcher()
Удалить диспетчер событий для моделей.
array getMutatedAttributes()
Получить изменённые атрибуты для данного экземпляра.
static void cacheMutatedAttributes(string $class)
Извлечь и кэшировать все изменённые атрибуты класса.
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(Model $parent, array $attributes, string $table, bool $exists = false)
Создание новой модели pivot из сырых значений, возвращенных запросом.
protected Builder getDeleteQuery()
Получение объекта запроса для удаления pivot.
string getOtherKey()
Получение имени столбца «другого ключа».
$this setPivotKeys(string $foreignKey, string $otherKey)
Установка имён ключей для экземпляра модели pivot.
bool hasTimestampAttributes()
Определение наличия атрибутов отметки времени в модели pivot.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Database/Eloquent/Relations/Pivot.html