Spec-Zone.ru › Laravel 5.7

BelongsTo

class BelongsTo extends Relation (View source)

Свойства

SupportsDefaultModels
ForwardsCalls
Macroable

Свойства

static protected array $macros Зарегистрированные строковые макросы. from Macroable
protected Builder $query Экземпляр Eloquent-билдера запросов. from Relation
protected Model $parent Экземпляр родительской модели. from Relation
protected Model $related Экземпляр связанной модели. from Relation
static protected bool $constraints Указывает, добавляет ли отношение ограничения. from Relation
static array $morphMap Массив для сопоставления имен классов с их именами морфинг в базе данных. from Relation
protected Closure|array|bool $withDefault Указывает, должен ли использоваться экземпляр модели по умолчанию. from SupportsDefaultModels
protected $child Экземпляр дочерней модели отношения.
protected string $foreignKey Внешний ключ родительской модели.
protected string $ownerKey Связанный ключ в родительской модели.
protected string $relation Название отношения.
static protected int $selfJoinCount Количество самосоединений.

Методы

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

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

из ForwardsCalls
static void throwBadMethodCallException(string $method)

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

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

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

из Macroable
static void mixin(object $mixin)

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

из Macroable
static bool hasMacro(string $name)

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

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

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

из Macroable
mixed __call(string $method, array $parameters)

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

из Macroable
void __construct(Builder $query, Model $child, string $foreignKey, string $ownerKey, string $relation)

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

static mixed noConstraints(Closure $callback)

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

из 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()

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

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

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

из Relation
void touch()

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

из Relation
int rawUpdate(array $attributes = [])

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

из Relation
Builder getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)

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

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

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

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

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

из Relation
Builder getQuery()

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

из Relation
Builder getBaseQuery()

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

из Relation
Model getParent()

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

из Relation
string getQualifiedParentKeyName()

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

из Relation
Model getRelated()

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

из Relation
string createdAt()

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

из Relation
string updatedAt()

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

из Relation
string relatedUpdatedAt()

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

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

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

из Relation
static array|null buildMorphMapFromModels(array $models = null)

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

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

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

из Relation
void __clone()

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

из Relation
Модель newRelatedInstanceFor(Модель $parent)

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

$this withDefault(Closure|массив|булево $callback = true)

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

из SupportsDefaultModels
Модель|null getDefaultFor(Модель $parent)

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

из SupportsDefaultModels
массив getEagerModelKeys(массив $models)

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

смешанный тип update(массив $attributes)

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

Модель associate(Модель|целое число|строка $model)

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

Модель dissociate()

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

Строитель getRelationExistenceQueryForSelfRelation(Строитель $query, Строитель $parentQuery, массив|смешанный тип $columns = ['*'])

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

строка getRelationCountHash()

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

булево relationHasIncrementingId()

Определить, имеет ли связанная модель идентификатор с автоинкрементом.

строка getForeignKey()

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

строка getQualifiedForeignKey()

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

строка getOwnerKey()

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

строка getQualifiedOwnerKeyName()

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

строка getRelation()

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

Подробности

protected смешанный тип forwardCallTo(смешанный тип $object, строка $method, массив $parameters)

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

Параметры

смешанный тип $object
строка $method
массив $parameters

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

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

Исключения

BadMethodCallException

static protected void throwBadMethodCallException(строка $method)

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

Параметры

строка $method

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

void

Исключения

BadMethodCallException

static void macro(строка $name, объект|вызываемый $macro)

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

Параметры

строка $name
объект|вызываемый $macro

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

void

static void mixin(объект $mixin)

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

Параметры

объект $mixin

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

void

Исключения

ReflectionException

static булево hasMacro(строка $name)

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

Параметры

строка $name

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

булево

static смешанный тип __callStatic(строка $method, массив $parameters)

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

Параметры

строка $method
массив $parameters

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

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

Исключения

BadMethodCallException

смешанный тип __call(строка $method, массив $parameters)

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

Параметры

строка $method
массив $parameters

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

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

Исключения

BadMethodCallException

void __construct(Строитель $query, Модель $child, строка $foreignKey, строка $ownerKey, строка $relation)

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

Параметры

Строитель $query
Модель $child
строка $foreignKey
строка $ownerKey
строка $relation

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

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 = ['*'])

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

Параметры

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

Model getRelated()

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

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

Model

string createdAt()

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

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

string

string updatedAt()

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

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

string

string relatedUpdatedAt()

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

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

string

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

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

Параметры

Массив $map
Булево $merge

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

Массив

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

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

Параметры

Массив $models

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

array|null

static string|null getMorphedModel(string $alias)

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

Параметры

Строка $alias

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

string|null

void __clone()

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

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

void

protected Модель newRelatedInstanceFor(Модель $parent)

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

Параметры

Модель $parent

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

Модель

$this withDefault(Closure|array|bool $callback = true)

Возвращает новый экземпляр модели в случае, если отношение не существует.

Параметры

Closure|Массив|Булево $callback

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

$this

protected Модель|null getDefaultFor(Модель $parent)

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

Параметры

Модель $parent

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

Модель|null

protected Массив getEagerModelKeys(Массив $models)

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

Параметры

Массив $models

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

Массив

смешанный тип update(Массив $attributes)

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

Параметры

Массив $attributes

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

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

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

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

Параметры

Модель|int|string $model

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

Модель

Модель dissociate()

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

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

Модель

Билдер getRelationExistenceQueryForSelfRelation(Билдер $query, Билдер $parentQuery, Массив|смешанный тип $columns = ['*'])

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

Параметры

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

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

Билдер

Строка getRelationCountHash()

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

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

Строка

protected Булево relationHasIncrementingId()

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

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

Булево

Строка getForeignKey()

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

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

Строка

Строка getQualifiedForeignKey()

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

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

Строка

Строка getOwnerKey()

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

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

Строка

Строка getQualifiedOwnerKeyName()

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

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

Строка

Строка getRelation()

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

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

Строка

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

Spec-Zone.ru

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