Spec-Zone.ru › Laravel 5.2

BelongsTo

class BelongsTo extends Relation (View source)

Свойства

protected Builder $query Экземпляр билдера запросов Eloquent. из Relation
protected Model $parent Экземпляр родительской модели. из Relation
protected Model $related Экземпляр связанной модели. из Relation
static protected bool $constraints Указывает, добавляет ли отношение ограничения. из Relation
static protected array $morphMap Массив для сопоставления имен классов с их именами морфинг в базе данных. из Relation
protected string $foreignKey Внешний ключ родительской модели.
protected string $otherKey Связанный ключ в родительской модели.
protected string $relation Имя отношения.
static protected int $selfJoinCount Количество самосоединений.

Методы

void __construct(Builder $query, Model $parent, string $foreignKey, string $otherKey, string $relation)

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

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
void touch()

Обновить метку времени для всех связанных моделей отношения.

from Relation
int rawUpdate(array $attributes = [])

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

from Relation
Builder getRelationCountQuery(Builder $query, Builder $parent)

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

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

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

static mixed noConstraints(Closure $callback)

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

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

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

from Relation
Builder getQuery()

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

from Relation
Builder getBaseQuery()

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

from Relation
Model getParent()

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

from Relation
string getQualifiedParentKeyName()

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

from Relation
Model getRelated()

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

from Relation
string createdAt()

Получить имя столбца "created at".

from Relation
string updatedAt()

Получить имя столбца "updated at".

from Relation
string relatedUpdatedAt()

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

from Relation
string wrap(string $value)

Оборачивает заданное значение с помощью грамматики родительского запроса.

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

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

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

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

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

Обработка динамических вызовов методов отношения.

from Relation
void __clone()

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

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

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

string getRelationCountHash()

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

array getEagerModelKeys(array $models)

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

Model associate(Model|int $model)

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

Model dissociate()

Отвязать ранее связанную модель от заданного родителя.

mixed update(array $attributes)

Обновить родительскую модель в отношении.

строка getForeignKey()

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

строка getQualifiedForeignKey()

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

строка getOtherKey()

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

строка getQualifiedOtherKeyName()

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

Подробности

void __construct(Builder $query, Model $parent, string $foreignKey, string $otherKey, string $relation)

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

Параметры

Builder $query
Model $parent
строка $foreignKey
строка $otherKey
строка $relation

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

void

void addConstraints()

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

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

void

void addEagerConstraints(array $models)

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

Параметры

массив $models

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

void

массив initRelation(array $models, string $relation)

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

Параметры

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

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

массив

массив match(array $models, Collection $results, string $relation)

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

Параметры

массив $models
Collection $results
строка $relation

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

массив

смешанный тип getResults()

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

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

смешанный тип

Collection getEager()

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

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

Collection

void touch()

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

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

void

целое число rawUpdate(array $attributes = [])

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

Параметры

массив $attributes

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

целое число

Builder getRelationCountQuery(Builder $query, Builder $parent)

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

Параметры

Builder $query
Builder $parent

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

Builder

Builder getRelationQuery(Builder $query, Builder $parent, array|mixed $columns = ['*'])

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

Параметры

Builder $query
Builder $parent
массив|смешанный тип $columns

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

Builder

static смешанный тип noConstraints(Closure $callback)

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

Параметры

Closure $callback

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

смешанный тип

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

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

Параметры

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

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

массив

Builder getQuery()

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

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

Builder

Builder getBaseQuery()

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

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

Builder

Model getParent()

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

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

Model

строка getQualifiedParentKeyName()

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

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

строка

Model getRelated()

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

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

Model

string createdAt()

Получить имя столбца "created at".

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

string

string updatedAt()

Получить имя столбца "updated at".

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

string

string relatedUpdatedAt()

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

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

string

string wrap(string $value)

Оборачивает заданное значение синтаксисом родительского запроса.

Параметры

string $value

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

string

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

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

Параметры

array $map
bool $merge

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

array

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

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

Параметры

array $models

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

array|null

mixed __call(string $method, array $parameters)

Обработка вызовов динамических методов отношения.

Параметры

string $method
array $parameters

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

mixed

void __clone()

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

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

void

Builder getRelationQueryForSelfRelation(Builder $query, Builder $parent, array|mixed $columns = ['*'])

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

Параметры

Builder $query
Builder $parent
array|mixed $columns

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

Builder

string getRelationCountHash()

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

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

string

protected array getEagerModelKeys(array $models)

Сбор ключей из массива связанных моделей.

Параметры

array $models

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

array

Модель associate(Модель|int $model)

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

Параметры

Модель|int $model

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

Модель

Модель dissociate()

Отключение ранее связанной модели от заданного родителя.

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

Модель

mixed update(array $attributes)

Обновление родительской модели в отношении.

Параметры

array $attributes

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

mixed

string getForeignKey()

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

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

string

string getQualifiedForeignKey()

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

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

string

string getOtherKey()

Получение связанного ключа отношения.

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

string

string getQualifiedOtherKeyName()

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

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

string

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

Spec-Zone.ru

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