BelongsTo

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

Трейты

Свойства

статический защищённый массив	$macros	Зарегистрированные строковые макросы.	из Macroable
защищённый TRelatedModel>	$query	Экземпляр Eloquent билдера запросов.	из Relation
защищённый TDeclaringModel	$parent	Экземпляр родительской модели.	из Relation
защищённый TRelatedModel	$related	Экземпляр связанной модели.	из Relation
защищённый bool	$eagerKeysWereEmpty	Указывает, должна ли загруженная с жадностью связь неявно возвращать пустой коллекцию.	из Relation
статический защищённый bool	$constraints	Указывает, добавляет ли связь ограничения.	из Relation
статический массив	$morphMap	Массив для сопоставления имён классов с их именами морфинг в базе данных.	из Relation
статический защищённый bool	$requireMorphMap	Предотвращает связи морфинг без карты морфинг.	из Relation
статический защищённый int	$selfJoinCount	Количество самосвязей.	из Relation
защищённый Closure\|массив\|bool	$withDefault	Указывает, используется ли экземпляр модели по умолчанию.	из SupportsDefaultModels
защищённый TDeclaringModel	$child	Экземпляр дочерней модели связи.
защищённый string	$foreignKey	Внешний ключ родительской модели.
защищённый string	$ownerKey	Соответствующий ключ родительской модели.
защищённый string	$relationName	Имя связи.

Методы

mixed	forwardCallTo(mixed $object, string $method, array $parameters) Передать вызов метода заданному объекту.	из ForwardsCalls
mixed	forwardDecoratedCallTo(mixed $object, string $method, array $parameters) Передать вызов метода заданному объекту, вернув $this, если переданный вызов вернул себя.	из ForwardsCalls
static void	throwBadMethodCallException(string $method) Выбросить исключение плохого вызова метода для данного метода.	из ForwardsCalls
static void	macro(string $name, object\|callable $macro) Зарегистрировать пользовательское макро.	из Macroable
static void	mixin(object $mixin, bool $replace = true) Смешать другой объект в класс.	из Macroable
static bool	hasMacro(string $name) Проверяет, зарегистрировано ли макро.	из Macroable
static void	flushMacros() Очистить существующие макросы.	из 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 $relationName) Создать новый экземпляр отношения belongs to.
static mixed	noConstraints(Closure $callback) Выполнить обратный вызов с отключенными ограничениями для отношения.	из Relation
void	addConstraints() Установить базовые ограничения для запроса отношения.
void	addEagerConstraints(array $models) Без описания
TDeclaringModel>	initRelation(array $models, string $relation) Без описания
TDeclaringModel>	match(array $models, Collection $results, string $relation) Без описания
TResult	getResults() Без описания
TRelatedModel>	getEager() Получить отношение для ленивой загрузки.	из Relation
TRelatedModel	sole(array\|string $columns = ['*']) Выполнить запрос и получить первый результат, если это единственная совпадающая запись.	из Relation
TRelatedModel>	get(array $columns = ['*']) Выполнить запрос как оператор «select».	из Relation
void	touch() Обновить все связанные модели для отношения.	из Relation
int	rawUpdate(array $attributes = []) Выполнить сырое обновление по базовому запросу.	из Relation
TRelatedModel>	getRelationExistenceCountQuery(Builder $query, Builder $parentQuery) Добавить ограничения для запроса подсчета существования отношения.	из Relation
TRelatedModel>	getRelationExistenceQuery(Builder $query, Builder $parentQuery, array\|mixed $columns = ['*']) Без описания
string	getRelationCountHash(bool $incrementJoinCount = true) Получить хеш таблицы соединения отношения.	из Relation
array<int,int\|string>	getKeys(array $models, string\|null $key = null) Получить все первичные ключи для массива моделей.	из Relation
TRelatedModel>	getRelationQuery() Получить конструктор запроса, который будет содержать ограничения отношения.	из Relation
TRelatedModel>	getQuery() Получить базовый запрос для отношения.	из Relation
Builder	getBaseQuery() Получить базовый конструктор запроса, управляющий Eloquent-конструктором запроса.	из Relation
Builder	toBase() Получить экземпляр базового конструктора запроса.	из Relation
TDeclaringModel	getParent() Получить родительскую модель отношения.	из Relation
string	getQualifiedParentKeyName() Получить полностью квалифицированное имя родительского ключа.	из Relation

TRelatedModel	getRelated() Получить связанную модель отношения.	from Relation
string	createdAt() Получить имя столбца "created at".	from Relation
string	updatedAt() Получить имя столбца "updated at".	from Relation
string	relatedUpdatedAt() Получить имя столбца "updated at" связанной модели.	from Relation
void	whereInEager(string $whereIn, string $key, array $modelKeys, Builder\|null $query = null) Добавить ограничение whereIn для eager загрузки заданного набора ключей моделей.	from Relation
string	whereInMethod(Model $model, string $key) Получить имя метода "where in" для eager загрузки.	from Relation
static void	requireMorphMap(bool $requireMorphMap = true) Запретить использование полиморфных отношений без сопоставления моделей.	from Relation
static bool	requiresMorphMap() Определить, требуют ли полиморфные отношения явного сопоставления моделей.	from Relation
static array	enforceMorphMap(array $map, bool $merge = true) Определить morph-map для полиморфных отношений и потребовать, чтобы все модели с морфизмом были явно сопоставлены.	from Relation
static array	morphMap(array\|null $map = null, bool $merge = true) Установить или получить morph-map для полиморфных отношений.	from Relation
static array\|null	buildMorphMapFromModels(array\|null $models = null) Строит массив с ключами таблиц из имён классов моделей.	from Relation
static string\|null	getMorphedModel(string $alias) Получить модель, связанную с пользовательским полиморфным типом.	from Relation
static int\|string	getMorphAlias(string $className) Получить псевдоним, связанный с пользовательским полиморфным классом.	from Relation
void	__clone() Вынудительное клонирование базового билдера запроса при клонировании.	from Relation
bool	is(Model\|null $model) Определить, является ли модель связанным экземпляром отношения.	from ComparesRelatedModels
bool	isNot(Model\|null $model) Определить, не является ли модель связанным экземпляром отношения.	from ComparesRelatedModels
mixed	getParentKey() Получить значение ключа внешнего ключа потомка.
int\|string	getRelatedKeyFrom(Model $model) Получить значение внешнего ключа модели.
bool	compareKeys(mixed $parentKey, mixed $relatedKey) Сравнить ключ родительской с ключом связанной модели.	from ComparesRelatedModels
mixed	getDictionaryKey(mixed $attribute) Получить атрибут ключа словаря, при необходимости преобразовав его в строку.	from InteractsWithDictionary
TRelatedModel	newRelatedInstanceFor(Model $parent) Создать новый экземпляр связанной модели для данной модели.
$this	withDefault(Closure\|array\|bool $callback = true) Возвратить новый экземпляр модели в случае, если отношение не существует.	from SupportsDefaultModels
Model\|null	getDefaultFor(Model $parent) Получить значение по умолчанию для этого отношения.	from SupportsDefaultModels
array	getEagerModelKeys(array $models) Собрать ключи из массива связанных моделей.
TDeclaringModel	associate(TRelatedModel\|int\|string\|null $model) Связать экземпляр модели с данным родителем.
TDeclaringModel	dissociate() Отвязать ранее связанную модель от данного родителя.
TDeclaringModel	disassociate() Псевдоним метода "dissociate".
TRelatedModel>	getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, array\|mixed $columns = ['*']) Добавить ограничения для запроса отношения на той же таблице.
bool	relationHasIncrementingId() Определить, имеет ли связанная модель автоинкрементируемый ID.
TDeclaringModel	getChild() Получить потомка отношения.
string	getForeignKeyName() Получить внешний ключ отношения.
string	getQualifiedForeignKeyName() Получить полностью квалифицированный внешний ключ отношения.

string	getOwnerKeyName() Получить связанный ключ отношения.
string	getQualifiedOwnerKeyName() Получить полностью квалифицированный связанный ключ отношения.
mixed	getForeignKeyFrom(Модель $model) Получить значение внешнего ключа модели.
string	getRelationName() Получить имя отношения.

Подробности

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

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

Параметры

mixed	$object
string	$method
array	$parameters

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

mixed

Исключения

BadMethodCallException

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

Перенаправить вызов метода к заданному объекту, возвращая $this, если перенаправленный вызов вернул себя.

Параметры

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

Очистить существующие макросы.

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

void

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, Модель $child, string $foreignKey, string $ownerKey, string $relationName)

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

Параметры

Builder	$query
Модель	$child
string	$foreignKey
string	$ownerKey
string	$relationName

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

void

static mixed noConstraints(Closure $callback)

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

Параметры

Closure

$callback

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

mixed

void addConstraints()

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

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

void

void addEagerConstraints(array $models)

Нет описания

Параметры

array

$models

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

void

TDeclaringModel> initRelation(array $models, string $relation)

Нет описания

Параметры

array	$models
string	$relation

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

TDeclaringModel>

TDeclaringModel> match(array $models, Коллекция $results, string $relation)

Нет описания

Параметры

array	$models
Коллекция	$results
string	$relation

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

TDeclaringModel>

TResult getResults()

Нет описания

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

TResult

END_OF_DOCUMENT_MARKER

TRelatedModel> getEager()

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

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

TRelatedModel>

TRelatedModel sole(array|string $columns = ['*'])

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

Параметры

array|string

$columns

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

TRelatedModel

Исключения

TRelatedModel>
MultipleRecordsFoundException

TRelatedModel> get(array $columns = ['*'])

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

Параметры

array

$columns

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

TRelatedModel>

void touch()

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

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

void

int rawUpdate(array $attributes = [])

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

Параметры

array

$attributes

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

int

TRelatedModel> getRelationExistenceCountQuery(Builder $query, Builder $parentQuery)

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

Параметры

Builder	$query
Builder	$parentQuery

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

TRelatedModel>

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

Нет описания

Параметры

Builder	$query
Builder	$parentQuery
array\|mixed	$columns

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

TRelatedModel>

string getRelationCountHash(bool $incrementJoinCount = true)

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

Параметры

bool

$incrementJoinCount

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

string

protected array<int,int|string> getKeys(array $models, string|null $key = null)

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

Параметры

array	$models
string\|null	$key

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

array<int,int|string>

protected TRelatedModel> getRelationQuery()

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

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

TRelatedModel>

TRelatedModel> getQuery()

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

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

TRelatedModel>

Builder getBaseQuery()

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

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

Builder

Builder toBase()

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

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

Builder

TDeclaringModel getParent()

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

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

TDeclaringModel

string getQualifiedParentKeyName()

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

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

string

TRelatedModel getRelated()

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

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

TRelatedModel

string createdAt()

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

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

string

string updatedAt()

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

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

string

string relatedUpdatedAt()

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

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

string

protected void whereInEager(string $whereIn, string $key, array $modelKeys, Builder|null $query = null)

Добавить ограничение whereIn для загрузки заданного набора ключей моделей.

Параметры

string	$whereIn
string	$key
array	$modelKeys
Builder\|null	$query

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

void

protected string whereInMethod(Model $model, string $key)

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

Параметры

Model	$model
string	$key

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

string

static void requireMorphMap(bool $requireMorphMap = true)

Запретить использование полиморфных отношений без сопоставлений моделей.

Параметры

bool

$requireMorphMap

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

void

static bool requiresMorphMap()

Определить, требуют ли полиморфные отношения явное отображение модели.

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

bool

static array enforceMorphMap(array $map, bool $merge = true)

Определить отображение морф для полиморфных отношений и потребовать, чтобы все модели morph были явно отображены.

Параметры

array	$map
bool	$merge

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

array

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

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

Параметры

array\|null	$map
bool	$merge

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

array

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

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

Параметры

array|null

$models

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

array|null

static string|null getMorphedModel(string $alias)

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

Параметры

string

$alias

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

string|null

static int|string getMorphAlias(string $className)

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

Параметры

string

$className

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

int|string

void __clone()

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

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

void

bool is(Model|null $model)

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

Параметры

Model|null

$model

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

bool

bool isNot(Model|null $model)

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

Параметры

Model|null

$model

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

bool

mixed getParentKey()

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

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

mixed

protected int|string getRelatedKeyFrom(Model $model)

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

Параметры

Model

$model

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

int|string

protected bool compareKeys(mixed $parentKey, mixed $relatedKey)

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

Параметры

mixed	$parentKey
mixed	$relatedKey

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

bool

protected mixed getDictionaryKey(mixed $attribute)

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

Параметры

mixed

$attribute

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

mixed

Исключения

InvalidArgumentException

protected TRelatedModel newRelatedInstanceFor(Model $parent)

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

Параметры

Model

$parent

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

TRelatedModel

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

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

Параметры

Closure|array|bool

$callback

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

$this

protected Model|null getDefaultFor(Model $parent)

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

Параметры

Model

$parent

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

Model|null

protected array getEagerModelKeys(array $models)

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

Параметры

array

$models

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

array

TDeclaringModel associate(TRelatedModel|int|string|null $model)

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

Параметры

TRelatedModel|int|string|null

$model

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

TDeclaringModel

TDeclaringModel dissociate()

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

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

TDeclaringModel

TDeclaringModel disassociate()

Псевдоним метода «отвязать».

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

TDeclaringModel

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

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

Параметры

Builder	$query
Builder	$parentQuery
array\|mixed	$columns

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

TRelatedModel>

protected bool relationHasIncrementingId()

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

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

bool

TDeclaringModel getChild()

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

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

TDeclaringModel

string getForeignKeyName()

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

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

string

string getQualifiedForeignKeyName()

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

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

string

string getOwnerKeyName()

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

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

string

string getQualifiedOwnerKeyName()

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

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

string

protected mixed getForeignKeyFrom(Model $model)

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

Параметры

Model

$model

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

mixed

string getRelationName()

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

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

string

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