Spec-Zone.ru › Laravel 5.6

BelongsToMany

класс BelongsToMany расширяет Relation (View source)

Трейты

InteractsWithPivotTable
Macroable

Свойства

статический защищенный массив $macros Зарегистрированные строковые макросы. из Macroable
защищенный Builder $query Экземпляр Eloquent-строителя запросов. из Relation
защищенный Model $parent Экземпляр родительской модели. из Relation
защищенный Model $related Экземпляр связанной модели. из Relation
статический защищенный булево значение $constraints Указывает, добавляет ли отношение ограничения. из Relation
статический массив $morphMap Массив для сопоставления имен классов с их именами морфизма в базе данных. из Relation
защищенный строка $table Промежуточная таблица для отношения.
защищенный строка $foreignPivotKey Внешний ключ родительской модели.
защищенный строка $relatedPivotKey Связанный ключ отношения.
защищенный строка $parentKey Имя ключа родительской модели.
защищенный строка $relatedKey Имя ключа связанной модели.
защищенный строка $relationName Имя отношения.
защищенный массив $pivotColumns Столбцы промежуточной таблицы для извлечения.
защищенный массив $pivotWheres Любые ограничения промежуточной таблицы для условий where.
защищенный массив $pivotWhereIns Любые ограничения промежуточной таблицы для условий whereIn.
защищенный массив $pivotValues Значения по умолчанию для столбцов промежуточной таблицы.
булево значение $withTimestamps Указывает, доступны ли отметки времени в промежуточной таблице.
защищенный строка $pivotCreatedAt Пользовательский столбец промежуточной таблицы для метки времени created_at.
защищенный строка $pivotUpdatedAt Пользовательский столбец промежуточной таблицы для метки времени updated_at.
защищенный строка $using Имя класса пользовательской модели pivot для использования в отношении.
защищенный строка $accessor Имя аксессора для использования для отношения «pivot».
статический защищенный целое число $selfJoinCount Количество самосоединений.

Методы

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательское макро.

from Macroable
static void mixin(object $mixin)

Смешать другой объект в класс.

from Macroable
static bool hasMacro(string $name)

Проверяет, зарегистрировано ли макро.

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

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

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

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

from Macroable
void __construct(Builder $query, Model $parent, string $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string $relationName = null)

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

static mixed noConstraints(Closure $callback)

Выполнить обратный вызов без ограничений в связи.

from Relation
void addConstraints()

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

void addEagerConstraints(array $models)

Установить ограничения для жадного загрузки связи.

array initRelation(array $models, string $relation)

Инициализировать связь на наборе моделей.

array match(array $models, Collection $results, string $relation)

Сопоставить загруженные результаты с их родителями.

mixed getResults()

Получить результаты связи.

Collection getEager()

Получить связь для жадной загрузки.

from Relation
Collection get(array $columns = ['*'])

Выполнить запрос как «выбрать» оператор.

void touch()

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

int rawUpdate(array $attributes = [])

Выполнить сырое обновление базового запроса.

from Relation
Builder getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)

Добавить ограничения для запроса подсчёта связи.

from Relation
Builder getRelationExistenceQuery(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])

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

array getKeys(array $models, string $key = null)

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

from Relation
Builder getQuery()

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

from Relation
Builder getBaseQuery()

Получить базовый билдер запроса, управляющий билдером Eloquent.

from Relation
Model getParent()

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

from Relation
string getQualifiedParentKeyName()

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

Model getRelated()

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

from Relation
string createdAt()

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

string updatedAt()

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

string relatedUpdatedAt()

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

from Relation
static array morphMap(array $map = null, bool $merge = true)

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

from Relation
static array|null buildMorphMapFromModels(array $models = null)

Создаёт таблично-ключевой массив из имён классов моделей.

from Relation
static string|null getMorphedModel(string $alias)

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

from Relation
void __clone()

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

from Relation
array toggle(mixed $ids, bool $touch = true)

Переключает модель (или модели) из родительской.

from InteractsWithPivotTable
array syncWithoutDetaching(Collection|Collection|array $ids)

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

from InteractsWithPivotTable
array sync(Collection|Collection|array $ids, bool $detaching = true)

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

from InteractsWithPivotTable
array formatRecordsList(array $records)

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

from InteractsWithPivotTable
array attachNew(array $records, array $current, bool $touch = true)

Прикрепить все записи, которых нет в заданных текущих записях.

from InteractsWithPivotTable
int updateExistingPivot(mixed $id, array $attributes, bool $touch = true)

Обновить существующую запись pivot в таблице.

from InteractsWithPivotTable
void attach(mixed $id, array $attributes = [], bool $touch = true)

Прикрепить модель к родительской.

from InteractsWithPivotTable
array formatAttachRecords(array $ids, array $attributes)

Создать массив записей для вставки в таблицу pivot.

from InteractsWithPivotTable
array formatAttachRecord(int $key, mixed $value, array $attributes, bool $hasTimestamps)

Создать полную загрузку записи прикрепления.

from InteractsWithPivotTable
array extractAttachIdAndAttributes(mixed $key, mixed $value, array $attributes)

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

from InteractsWithPivotTable
array baseAttachRecord(int $id, bool $timed)

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

from InteractsWithPivotTable
array addTimestampsToAttachment(array $record, bool $exists = false)

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

from InteractsWithPivotTable
bool hasPivotColumn(string $column)

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

from InteractsWithPivotTable
int detach(mixed $ids = null, bool $touch = true)

Отсоединить модели от отношения.

from InteractsWithPivotTable
Pivot newPivot(array $attributes = [], bool $exists = false)

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

from InteractsWithPivotTable
Pivot newExistingPivot(array $attributes = [])

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

from InteractsWithPivotTable
Builder newPivotStatement()

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

from InteractsWithPivotTable
Builder newPivotStatementForId(mixed $id)

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

from InteractsWithPivotTable
Builder newPivotQuery()

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

from InteractsWithPivotTable
$this withPivot(array|mixed $columns)

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

from InteractsWithPivotTable
array parseIds(mixed $value)

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

from InteractsWithPivotTable
mixed parseId(mixed $value)

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

from InteractsWithPivotTable
array castKeys(array $keys)

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

from InteractsWithPivotTable
mixed castKey(mixed $key)

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

from InteractsWithPivotTable
array castAttributes(array $attributes)

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

from InteractsWithPivotTable
$this performJoin(Builder|null $query = null)

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

$this addWhereConstraints()

Установить условие where для запроса отношения.

array buildDictionary(Collection $results)

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

string getPivotClass()

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

BelongsToMany using(string $class)

Указать пользовательскую модель pivot для использования в отношении.

BelongsToMany as(string $accessor)

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

BelongsToMany wherePivot(string $column, string $operator = null, mixed $value = null, string $boolean = 'and')

Установить условие where для столбца таблицы pivot.

BelongsToMany wherePivotIn(string $column, mixed $values, string $boolean = 'and', bool $not = false)

Установить условие "where in" для столбца таблицы pivot.

BelongsToMany orWherePivot(string $column, string $operator = null, mixed $value = null)

Установить условие "or where" для столбца таблицы pivot.

BelongsToMany withPivotValue(string $column, mixed $value = null)

Установить условие where для столбца таблицы pivot.

BelongsToMany orWherePivotIn(string $column, mixed $values)

Установить условие "or where in" для столбца таблицы pivot.

Collection|Model findOrNew(mixed $id, array $columns = ['*'])

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

Model firstOrNew(array $attributes)

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

Model firstOrCreate(array $attributes, array $joining = [], bool $touch = true)

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

Model updateOrCreate(array $attributes, array $values = [], array $joining = [], bool $touch = true)

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

Model|Collection|null find(mixed $id, array $columns = ['*'])

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

Collection findMany(mixed $ids, array $columns = ['*'])

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

Model|Collection findOrFail(mixed $id, array $columns = ['*'])

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

mixed first(array $columns = ['*'])

Выполнить запрос и получить первый результат.

Model|BelongsToMany firstOrFail(array $columns = ['*'])

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

BelongsToMany shouldSelect(array $columns = ['*'])

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

array aliasedPivotColumns()

Получить столбцы pivot для отношения.

LengthAwarePaginator paginate(int $perPage = null, array $columns = ['*'], string $pageName = 'page', int|null $page = null)

Получить пагинатор для оператора "select".

Paginator simplePaginate(int $perPage = null, array $columns = ['*'], string $pageName = 'page', int|null $page = null)

Разбить данные данного запроса на страницы с помощью простого пагинатора.

bool chunk(int $count, callable $callback)

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

void hydratePivotRelation(array $models)

Заполнить отношение pivot таблицы для моделей.

array migratePivotAttributes(Model $model)

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

void touchIfTouching()

Если требуется обновление родительской модели, обновить.

bool touchingParent()

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

string guessInverseRelation()

Попытка угадать имя обратного отношения.

Collection allRelatedIds()

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

Model save(Model $model, array $pivotAttributes = [], bool $touch = true)

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

array saveMany(Collection|array $models, array $pivotAttributes = [])

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

Model create(array $attributes = [], array $joining = [], bool $touch = true)

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

array createMany(array $records, array $joinings = [])

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

Builder getRelationExistenceQueryForSelfJoin(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])

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

строка getExistenceCompareKey()

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

строка getRelationCountHash()

Получить хеш таблицы соединения отношения.

BelongsToMany withTimestamps(mixed $createdAt = null, mixed $updatedAt = null)

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

строка getForeignPivotKeyName()

Получить внешний ключ для отношения.

строка getQualifiedForeignPivotKeyName()

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

строка getRelatedPivotKeyName()

Получить "связанный ключ" для отношения.

строка getQualifiedRelatedPivotKeyName()

Получить полностью квалифицированный "связанный ключ" для отношения.

строка getTable()

Получить промежуточную таблицу для отношения.

строка getRelationName()

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

строка getPivotAccessor()

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

Подробности

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательский макрос.

Parameters

строка $name
object|callable $macro

Return Value

void

static void mixin(object $mixin)

Смешать другой объект в класс.

Parameters

object $mixin

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Проверяет, зарегистрирован ли макрос.

Parameters

строка $name

Return Value

bool

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

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

Parameters

строка $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Parameters

строка $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

void __construct(Builder $query, Model $parent, string $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string $relationName = null)

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

Parameters

Builder $query
Model $parent
строка $table
строка $foreignPivotKey
строка $relatedPivotKey
строка $parentKey
строка $relatedKey
строка $relationName

Return Value

void

static mixed noConstraints(Closure $callback)

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

Parameters

Closure $callback

Return Value

mixed

void addConstraints()

Установить основные ограничения для запроса отношения.

Return Value

void

void addEagerConstraints(array $models)

Установить ограничения для жадного загрузки отношения.

Parameters

array $models

Return Value

void

array initRelation(array $models, string $relation)

Инициализировать отношение для набора моделей.

Parameters

array $models
строка $relation

Return Value

array

array match(array $models, Collection $results, string $relation)

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

Parameters

array $models
Collection $results
строка $relation

Return Value

array

mixed getResults()

Получить результаты отношения.

Return Value

mixed

Collection getEager()

Получить отношение для жадной загрузки.

Return Value

Collection

Коллекция get(array $columns = ['*'])

Выполнить запрос как операцию «выбор».

Параметры

массив $columns

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

Коллекция

void touch()

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

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

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

void

int rawUpdate(array $attributes = [])

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

Параметры

массив $attributes

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

int

Билдер getRelationExistenceCountQuery(Билдер $query, Билдер $parentQuery)

Добавить ограничения для запроса подсчета отношения.

Параметры

Билдер $query
Билдер $parentQuery

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

Билдер

Билдер getRelationExistenceQuery(Билдер $query, Билдер $parentQuery, array|mixed $columns = ['*'])

Добавить ограничения для запроса отношения.

Параметры

Билдер $query
Билдер $parentQuery
массив|смешанный $columns

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

Билдер

protected массив getKeys(array $models, string $key = null)

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

Параметры

массив $models
строка $key

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

массив

Билдер getQuery()

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

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

Билдер

Билдер getBaseQuery()

Получить базовый билдер запросов, управляющий билдером Eloquent.

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

Билдер

Модель getParent()

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

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

Модель

строка getQualifiedParentKeyName()

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

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

строка

Модель getRelated()

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

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

Модель

строка createdAt()

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

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

строка

строка updatedAt()

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

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

строка

строка relatedUpdatedAt()

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

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

строка

static массив morphMap(array $map = null, bool $merge = true)

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

Параметры

массив $map
булево $merge

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

массив

static protected массив|null buildMorphMapFromModels(array $models = null)

Создает таблично-ключевой массив из имён классов моделей.

Параметры

массив $models

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

массив|null

static строка|null getMorphedModel(string $alias)

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

Параметры

строка $alias

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

строка|null

void __clone()

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

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

void

массив toggle(mixed $ids, bool $touch = true)

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

Каждая существующая модель отсоединяется, а несуществующие — присоединяются.

Параметры

смешанный $ids
булево $touch

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

массив

массив syncWithoutDetaching(Коллекция|Коллекция|массив $ids)

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

Параметры

Коллекция|Коллекция|массив $ids

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

массив
END_OF_DOCUMENT_MARKER

array sync(Collection|Collection|array $ids, bool $detaching = true)

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

Параметры

Collection|Collection|array $ids
bool $detaching

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

array

protected array formatRecordsList(array $records)

Форматировать список записей sync/toggle так, чтобы он индексировался по ID.

Параметры

array $records

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

array

protected array attachNew(array $records, array $current, bool $touch = true)

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

Параметры

array $records
array $current
bool $touch

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

array

int updateExistingPivot(mixed $id, array $attributes, bool $touch = true)

Обновить существующую запись pivot в таблице.

Параметры

mixed $id
array $attributes
bool $touch

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

int

void attach(mixed $id, array $attributes = [], bool $touch = true)

Присоединить модель к родительской.

Параметры

mixed $id
array $attributes
bool $touch

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

void

protected array formatAttachRecords(array $ids, array $attributes)

Создать массив записей для вставки в таблицу pivot.

Параметры

array $ids
array $attributes

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

array

protected array formatAttachRecord(int $key, mixed $value, array $attributes, bool $hasTimestamps)

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

Параметры

int $key
mixed $value
array $attributes
bool $hasTimestamps

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

array

protected array extractAttachIdAndAttributes(mixed $key, mixed $value, array $attributes)

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

Параметры

mixed $key
mixed $value
array $attributes

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

array

protected array baseAttachRecord(int $id, bool $timed)

Создать новую запись присоединения pivot.

Параметры

int $id
bool $timed

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

array

protected array addTimestampsToAttachment(array $record, bool $exists = false)

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

Параметры

array $record
bool $exists

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

array

protected bool hasPivotColumn(string $column)

Определить, определен ли данный столбец как столбец pivot.

Параметры

string $column

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

bool

int detach(mixed $ids = null, bool $touch = true)

Отсоединить модели от отношения.

Параметры

mixed $ids
bool $touch

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

int

Pivot newPivot(array $attributes = [], bool $exists = false)

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

Параметры

array $attributes
bool $exists

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

Pivot

Pivot newExistingPivot(array $attributes = [])

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

Параметры

array $attributes

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

Pivot

Builder newPivotStatement()

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

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

Builder

Builder newPivotStatementForId(mixed $id)

Получить новый запрос pivot для заданного идентификатора «другого».

Параметры

mixed $id

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

Builder

protected Builder newPivotQuery()

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

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

Builder

$this withPivot(array|mixed $columns)

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

Параметры

array|mixed $columns

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

$this

protected array parseIds(mixed $value)

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

Параметры

mixed $value

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

array

protected mixed parseId(mixed $value)

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

Параметры

mixed $value

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

mixed

protected array castKeys(array $keys)

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

Параметры

array $keys

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

array

protected mixed castKey(mixed $key)

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

Параметры

mixed $key

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

mixed

protected array castAttributes(array $attributes)

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

Параметры

array $attributes

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

array

protected $this performJoin(Builder|null $query = null)

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

Параметры

Builder|null $query

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

$this

protected $this addWhereConstraints()

Установить условие where для запроса отношения.

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

$this

protected array buildDictionary(Collection $results)

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

Параметры

Collection $results

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

array

string getPivotClass()

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

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

string

BelongsToMany using(string $class)

Указать пользовательскую модель связывающей таблицы для использования в отношении.

Параметры

string $class

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

BelongsToMany

BelongsToMany as(string $accessor)

Указать пользовательский аксессор связывающей таблицы для использования в отношении.

Параметры

string $accessor

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

BelongsToMany

BelongsToMany wherePivot(string $column, string $operator = null, mixed $value = null, string $boolean = 'and')

Установить условие where для столбца связывающей таблицы.

Параметры

string $column
string $operator
mixed $value
string $boolean

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

BelongsToMany

BelongsToMany wherePivotIn(string $column, mixed $values, string $boolean = 'and', bool $not = false)

Установить условие "where in" для столбца связывающей таблицы.

Параметры

string $column
mixed $values
string $boolean
bool $not

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

BelongsToMany

BelongsToMany orWherePivot(string $column, string $operator = null, mixed $value = null)

Установить условие "or where" для столбца связывающей таблицы.

Параметры

string $column
string $operator
mixed $value

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

BelongsToMany

BelongsToMany withPivotValue(string $column, mixed $value = null)

Установить условие where для столбца связывающей таблицы.

Кроме того, новые записи связывающей таблицы получат это значение.

Параметры

string $column
mixed $value

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

BelongsToMany

BelongsToMany orWherePivotIn(string $column, mixed $values)

Установить условие "or where in" для столбца связывающей таблицы.

Параметры

string $column
mixed $values

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

BelongsToMany

Collection|Model findOrNew(mixed $id, array $columns = ['*'])

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

Параметры

mixed $id
array $columns

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

Collection|Model

Model firstOrNew(array $attributes)

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

Параметры

array $attributes

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

Model

Модель firstOrCreate(array $attributes, array $joining = [], bool $touch = true)

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

Параметры

array $attributes
array $joining
bool $touch

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

Модель

Модель updateOrCreate(array $attributes, array $values = [], array $joining = [], bool $touch = true)

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

Параметры

array $attributes
array $values
array $joining
bool $touch

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

Модель

Модель|Коллекция|null find(mixed $id, array $columns = ['*'])

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

Параметры

mixed $id
array $columns

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

Модель|Коллекция|null

Коллекция findMany(mixed $ids, array $columns = ['*'])

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

Параметры

mixed $ids
array $columns

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

Коллекция

Модель|Коллекция findOrFail(mixed $id, array $columns = ['*'])

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

Параметры

mixed $id
array $columns

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

Модель|Коллекция

Исключения

ModelNotFoundException

mixed first(array $columns = ['*'])

Выполнить запрос и получить первый результат.

Параметры

array $columns

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

mixed

Модель|BelongsToMany firstOrFail(array $columns = ['*'])

Выполнить запрос и получить первый результат или выбросить исключение.

Параметры

array $columns

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

Модель|BelongsToMany

Исключения

ModelNotFoundException

protected BelongsToMany shouldSelect(array $columns = ['*'])

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

Параметры

array $columns

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

BelongsToMany

protected array aliasedPivotColumns()

Получить столбцы оси отношения.

"pivot_" добавляется как префикс к каждому столбцу для удобства удаления позже.

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

array

LengthAwarePaginator paginate(int $perPage = null, array $columns = ['*'], string $pageName = 'page', int|null $page = null)

Получить пагинатор для оператора "select".

Параметры

int $perPage
array $columns
string $pageName
int|null $page

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

LengthAwarePaginator

Paginator simplePaginate(int $perPage = null, array $columns = ['*'], string $pageName = 'page', int|null $page = null)

Разбить данный запрос на страницы с помощью простого пагинатора.

Параметры

int $perPage
array $columns
string $pageName
int|null $page

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

Paginator

bool chunk(int $count, callable $callback)

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

Параметры

int $count
callable $callback

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

bool

protected void hydratePivotRelation(array $models)

Заполнить отношение к таблице оси для моделей.

Параметры

array $models

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

void

protected array migratePivotAttributes(Модель $model)

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

Параметры

Модель $model

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

array

void touchIfTouching()

Если необходимо обновить родительскую модель, обновить её.

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

void

protected bool touchingParent()

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

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

bool
END_OF_DOCUMENT_MARKER

protected string guessInverseRelation()

Попытка определить имя обратного отношения.

Значение возвращаемого значения

string

Collection allRelatedIds()

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

Значение возвращаемого значения

Collection

Model save(Model $model, array $pivotAttributes = [], bool $touch = true)

Сохранить новую модель и прикрепить её к родительской модели.

Параметры

Model $model
array $pivotAttributes
bool $touch

Значение возвращаемого значения

Model

array saveMany(Collection|array $models, array $pivotAttributes = [])

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

Параметры

Collection|array $models
array $pivotAttributes

Значение возвращаемого значения

array

Model create(array $attributes = [], array $joining = [], bool $touch = true)

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

Параметры

array $attributes
array $joining
bool $touch

Значение возвращаемого значения

Model

array createMany(array $records, array $joinings = [])

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

Параметры

array $records
array $joinings

Значение возвращаемого значения

array

Builder getRelationExistenceQueryForSelfJoin(Builder $query, Builder $parentQuery, array|mixed $columns = ['*'])

Добавить ограничения для запроса отношения на одном и том же таблице.

Параметры

Builder $query
Builder $parentQuery
array|mixed $columns

Значение возвращаемого значения

Builder

string getExistenceCompareKey()

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

Значение возвращаемого значения

string

string getRelationCountHash()

Получить хэш таблицы соединения для отношения.

Значение возвращаемого значения

string

BelongsToMany withTimestamps(mixed $createdAt = null, mixed $updatedAt = null)

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

Параметры

mixed $createdAt
mixed $updatedAt

Значение возвращаемого значения

BelongsToMany

string getForeignPivotKeyName()

Получить внешний ключ для отношения.

Значение возвращаемого значения

string

string getQualifiedForeignPivotKeyName()

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

Значение возвращаемого значения

string

string getRelatedPivotKeyName()

Получить "связанный ключ" для отношения.

Значение возвращаемого значения

string

string getQualifiedRelatedPivotKeyName()

Получить полностью квалифицированный "связанный ключ" для отношения.

Значение возвращаемого значения

string

string getTable()

Получить промежуточную таблицу для отношения.

Значение возвращаемого значения

string

string getRelationName()

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

Значение возвращаемого значения

string

string getPivotAccessor()

Получить имя аксессора для поля pivot для данного отношения.

Значение возвращаемого значения

string

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

Spec-Zone.ru

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