Spec-Zone.ru › Laravel 5.8

MorphToMany

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

Трейты

InteractsWithPivotTable
ForwardsCalls
Macroable

Свойства

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

Методы

mixed forwardCallTo(mixed $object, string $method, array $parameters)

Передать вызов метода заданному объекту.

from ForwardsCalls
static void throwBadMethodCallException(string $method)

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

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

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

from Macroable
static void mixin(object $mixin, bool $replace = true)

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

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 $name, string $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string $relationName = null, bool $inverse = false)

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

static mixed noConstraints(Closure $callback)

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

from Relation
void addConstraints()

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

from BelongsToMany
void addEagerConstraints(array $models)

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

array initRelation(array $models, string $relation)

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

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

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

from BelongsToMany
mixed getResults()

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

from BelongsToMany
Коллекция getEager()

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

из Отношения
Коллекция get(array $columns = ['*'])

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

из Связи многие ко многим
void touch()

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

из Связи многие ко многим
int rawUpdate(array $attributes = [])

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

из Отношения
Билдер getRelationExistenceCountQuery(Билдер $query, Билдер $parentQuery)

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

из Отношения
Билдер getRelationExistenceQuery(Билдер $query, Билдер $parentQuery, array|mixed $columns = ['*'])

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

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

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

из Отношения
Билдер getQuery()

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

из Отношения
Билдер getBaseQuery()

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

из Отношения
Модель getParent()

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

из Отношения
строка getQualifiedParentKeyName()

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

из Связи многие ко многим
Модель getRelated()

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

из Отношения
строка createdAt()

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

из Связи многие ко многим
строка updatedAt()

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

из Связи многие ко многим
строка relatedUpdatedAt()

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

из Relation
строка whereInMethod(Модель $model, строка $key)

Получить имя метода "where in" для леничной загрузки.

из Relation
массив morphMap(массив $map = null, булево $merge = true)

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

из Relation
массив|null buildMorphMapFromModels(массив $models = null)

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

из Relation
строка|null getMorphedModel(строка $alias)

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

из Relation
void __clone()

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

из Relation
массив toggle(смешанный $ids, булево $touch = true)

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

из InteractsWithPivotTable
массив syncWithoutDetaching(Коллекция|Модель|массив $ids)

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

из InteractsWithPivotTable
массив sync(Коллекция|Модель|массив $ids, булево $detaching = true)

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

из InteractsWithPivotTable
массив formatRecordsList(массив $records)

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

из InteractsWithPivotTable
массив attachNew(массив $records, массив $current, булево $touch = true)

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

из InteractsWithPivotTable
целое число updateExistingPivot(смешанный $id, массив $attributes, булево $touch = true)

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

из InteractsWithPivotTable
int updateExistingPivotUsingCustomClass(mixed $id, array $attributes, bool $touch)

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

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

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

from InteractsWithPivotTable
void attachUsingCustomClass(mixed $id, array $attributes)

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

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)

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

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
int detachUsingCustomClass(mixed $ids)

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

from InteractsWithPivotTable
Collection getCurrentlyAttachedPivots()

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

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

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

Связь newExistingPivot(array $attributes = [])

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

from InteractsWithPivotTable
Построитель запроса newPivotStatement()

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

from InteractsWithPivotTable
Построитель запроса newPivotStatementForId(mixed $id)

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

from InteractsWithPivotTable
Построитель запроса newPivotQuery()

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

$this withPivot(array|mixed $columns)

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

from InteractsWithPivotTable
массив parseIds(mixed $value)

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

from InteractsWithPivotTable
смешанный тип parseId(mixed $value)

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

from InteractsWithPivotTable
массив castKeys(array $keys)

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

from InteractsWithPivotTable
смешанный тип castKey(mixed $key)

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

from InteractsWithPivotTable
массив castAttributes(array $attributes)

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

from InteractsWithPivotTable
смешанный тип getTypeSwapValue(string $type, mixed $value)

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

from InteractsWithPivotTable
строка resolveTableName(string $table)

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

from BelongsToMany
$this performJoin(Построитель запроса|null $query = null)

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

from BelongsToMany
$this addWhereConstraints()

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

массив buildDictionary(Collection $results)

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

из BelongsToMany
строка getPivotClass()

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

из BelongsToMany
$this using(string $class)

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

из BelongsToMany
$this as(string $accessor)

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

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

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

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

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

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

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

из BelongsToMany
$this withPivotValue(string|array $column, mixed $value = null)

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

из BelongsToMany
$this orWherePivotIn(string $column, mixed $values)

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

из BelongsToMany
Collection|Модель findOrNew(mixed $id, array $columns = ['*'])

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

из BelongsToMany
Модель firstOrNew(array $attributes)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

от BelongsToMany
array aliasedPivotColumns()

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

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

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

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

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

от BelongsToMany
bool chunk(int $count, callable $callback)

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

от BelongsToMany
bool chunkById(int $count, callable $callback, string|null $column = null, string|null $alias = null)

Разбить результаты запроса на части по сравниванию числовых идентификаторов.

от BelongsToMany
bool each(callable $callback, int $count = 1000)

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

from BelongsToMany
void hydratePivotRelation(array $models)

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

from BelongsToMany
array migratePivotAttributes(Model $model)

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

from BelongsToMany
void touchIfTouching()

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

from BelongsToMany
bool touchingParent()

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

from BelongsToMany
string guessInverseRelation()

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

from BelongsToMany
Collection allRelatedIds()

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

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

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

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

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

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

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

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

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

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

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

from BelongsToMany
строка getExistenceCompareKey()

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

из BelongsToMany
строка getRelationCountHash()

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

из BelongsToMany
$this withTimestamps(mixed $createdAt = null, mixed $updatedAt = null)

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

из BelongsToMany
строка getForeignPivotKeyName()

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

из BelongsToMany
строка getQualifiedForeignPivotKeyName()

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

из BelongsToMany
строка getRelatedPivotKeyName()

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

из BelongsToMany
строка getQualifiedRelatedPivotKeyName()

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

из BelongsToMany
строка getParentKeyName()

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

из BelongsToMany
строка getRelatedKeyName()

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

из BelongsToMany
строка getTable()

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

из BelongsToMany
строка getRelationName()

Получить имя связи для связи.

из BelongsToMany
строка getPivotAccessor()

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

из BelongsToMany
строка getMorphType()

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

строка getMorphClass()

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

логическое getInverse()

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

Подробности

protected mixed forwardCallTo(mixed $object, string $method, array $parameters)

Передать вызов метода заданному объекту.

Параметры

mixed $object
string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

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

Параметры

string $method

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

void

Исключения

BadMethodCallException

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

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

Параметры

string $name
object|callable $macro

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

void

static void mixin(object $mixin, bool $replace = true)

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

Параметры

object $mixin
bool $replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

string $name

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

bool

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

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

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

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

Параметры

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

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

void

static mixed noConstraints(Closure $callback)

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

Параметры

Closure $callback

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

mixed

void addConstraints()

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

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

void

void addEagerConstraints(array $models)

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

Параметры

array $models

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

void

array initRelation(array $models, string $relation)

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

Параметры

array $models
string $relation

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

array

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

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

Параметры

array $models
Collection $results
string $relation

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

array

mixed getResults()

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

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

mixed

Collection getEager()

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

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

Collection

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

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

Параметры

array $columns

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

Collection

void touch()

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

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

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

void

int rawUpdate(array $attributes = [])

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

Параметры

array $attributes

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

int

Builder getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)

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

Параметры

Builder $query
Builder $parentQuery

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

Builder

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

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

Параметры

Builder $query
Builder $parentQuery
array|mixed $columns

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

Builder

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

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

Параметры

array $models
string $key

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

array

Builder getQuery()

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

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

Builder

Builder getBaseQuery()

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

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

Builder

Model getParent()

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

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

Model

string getQualifiedParentKeyName()

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

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

string

Модель getRelated()

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

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

Модель

string createdAt()

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

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

string

string updatedAt()

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

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

string

string relatedUpdatedAt()

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

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

string

protected string whereInMethod(Модель $model, string $key)

Получить имя метода «where in» для леничной загрузки.

Параметры

Модель $model
string $key

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

string

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

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

Параметры

array $map
bool $merge

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

array

static protected array|null buildMorphMapFromModels(array $models = null)

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

Параметры

array $models

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

array|null

static string|null getMorphedModel(string $alias)

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

Параметры

string $alias

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

string|null

void __clone()

Вынуждает клонирование базового генератора запросов при клонировании.

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

void

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

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

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

Параметры

mixed $ids
bool $touch

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

array

array syncWithoutDetaching(Коллекция|Модель|array $ids)

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

Параметры

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

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

array

array sync(Collection|Модель|array $ids, bool $detaching = true)

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

Параметры

Collection|Модель|array $ids
bool $detaching

Значение результата

array

protected array formatRecordsList(array $records)

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

Параметры

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

protected int updateExistingPivotUsingCustomClass(mixed $id, array $attributes, bool $touch)

Обновить существующую запись 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 void attachUsingCustomClass(mixed $id, array $attributes)

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

Параметры

mixed $id
array $attributes

Значение результата

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)

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

Параметры

int $id
bool $timed

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

array

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

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

Параметры

array $record
bool $exists

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

array

bool hasPivotColumn(string $column)

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

Параметры

string $column

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

bool

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

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

Параметры

mixed $ids
bool $touch

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

int

protected int detachUsingCustomClass(mixed $ids)

Отвязать модели от взаимоотношений с помощью пользовательского класса.

Параметры

mixed $ids

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

int

protected Collection getCurrentlyAttachedPivots()

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

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

Collection

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

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

Параметры

array $attributes
bool $exists

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

Pivot

Pivot newExistingPivot(array $attributes = [])

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

Параметры

array $attributes

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

Pivot

Builder newPivotStatement()

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

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

Builder

Builder newPivotStatementForId(mixed $id)

Получить новое утверждение pivot для заданного ID «другого».

Параметры

mixed $id

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

Builder

protected Builder newPivotQuery()

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

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

Builder

$this withPivot(array|mixed $columns)

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

Параметры

array|mixed $columns

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

$this

protected array parseIds(mixed $value)

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

Параметры

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)

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

Параметры

array $attributes

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

array

protected mixed getTypeSwapValue(string $type, mixed $value)

Преобразует заданное значение в значение заданного типа.

Parameters

string $type
mixed $value

Return Value

mixed

protected string resolveTableName(string $table)

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

Parameters

string $table

Return Value

string

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

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

Parameters

Builder|null $query

Return Value

$this

protected $this addWhereConstraints()

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

Return Value

$this

protected array buildDictionary(Collection $results)

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

Parameters

Collection $results

Return Value

array

string getPivotClass()

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

Return Value

string

$this using(string $class)

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

Parameters

string $class

Return Value

$this

$this as(string $accessor)

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

Parameters

string $accessor

Return Value

$this

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

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

Parameters

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

Return Value

$this

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

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

Parameters

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

Return Value

$this

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

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

Параметры

string $column
string $operator
mixed $value

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

$this

$this withPivotValue(string|array $column, mixed $value = null)

Установить условие «где» для столбца таблицы связей.

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

Параметры

string|array $column
mixed $value

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

$this

$this orWherePivotIn(string $column, mixed $values)

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

Параметры

string $column
mixed $values

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

$this

Collection|Модель findOrNew(mixed $id, array $columns = ['*'])

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

Параметры

mixed $id
array $columns

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

Collection|Модель

Модель firstOrNew(array $attributes)

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

Параметры

array $attributes

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

Модель

Модель 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

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

Модель
END_OF_DOCUMENT_MARKER

Модель|Коллекция|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 array shouldSelect(array $columns = ['*'])

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

Параметры

array $columns

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

array

protected array aliasedPivotColumns()

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

"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

bool chunkById(int $count, callable $callback, string|null $column = null, string|null $alias = null)

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

Параметры

int $count
callable $callback
string|null $column
string|null $alias

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

bool

bool each(callable $callback, int $count = 1000)

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

Параметры

callable $callback
int $count

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

bool

protected void hydratePivotRelation(array $models)

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

Параметры

array $models

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

void

protected array migratePivotAttributes(Model $model)

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

Параметры

Model $model

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

array

void touchIfTouching()

Если мы касаемся родительской модели, коснитесь ее.

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

void

protected bool touchingParent()

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

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

bool

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

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

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

Параметры

mixed $createdAt
mixed $updatedAt

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

$this

string getForeignPivotKeyName()

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

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

string

string getQualifiedForeignPivotKeyName()

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

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

string

string getRelatedPivotKeyName()

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

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

string

string getQualifiedRelatedPivotKeyName()

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

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

string

string getParentKeyName()

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

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

string

string getRelatedKeyName()

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

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

string

string getTable()

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

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

string

string getRelationName()

Получить имя связи для связи.

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

string

string getPivotAccessor()

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

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

string

string getMorphType()

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

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

string

string getMorphClass()

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

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

string

bool getInverse()

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

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

bool

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

Spec-Zone.ru

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