BelongsTo

class BelongsTo extends Relation (View source)

Свойства

static protected array	$macros	Зарегистрированные строковые макросы.	из Macroable
protected Builder	$query	Экземпляр Eloquent query builder.	из Relation
protected Model	$parent	Экземпляр родительской модели.	из Relation
protected Model	$related	Экземпляр связанной модели.	из Relation
static protected bool	$constraints	Указывает, добавляет ли отношение ограничения.	из Relation
static array	$morphMap	Массив для сопоставления имён классов с их именами морфирования в базе данных.	из Relation
protected Closure\|array\|bool	$withDefault	Указывает, следует ли использовать экземпляр модели по умолчанию.	из SupportsDefaultModels
protected	$child	Экземпляр дочерней модели отношения.
protected string	$foreignKey	Внешний ключ родительской модели.
protected string	$ownerKey	Связанный ключ родительской модели.
protected string	$relation	Имя отношения.
static protected int	$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 $child, string $foreignKey, string $ownerKey, string $relation) Создать новый экземпляр отношения «belongs to».
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 = ['*']) Выполнить запрос как операцию «select».	from Relation
void	touch() Обновить все связанные модели для отношения.	from Relation
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() Получить полностью квалифицированное имя родительского ключа.	from Relation
Model	getRelated() Получить связанную модель отношения.	from Relation
string	createdAt() Получить имя столбца «created at».	from Relation
string	updatedAt() Получить имя столбца «updated at».	from Relation
string	relatedUpdatedAt() Получить имя столбца «updated at» связанной модели.	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

Модель	newRelatedInstanceFor(Модель $parent) Создать новый связанный экземпляр для заданной модели.
$this	withDefault(Closure\|array\|bool $callback = true) Возвратить новый экземпляр модели в случае, если отношение не существует.	из SupportsDefaultModels
Модель\|null	getDefaultFor(Модель $parent) Получить значение по умолчанию для этого отношения.	из SupportsDefaultModels
массив	getEagerModelKeys(array $models) Собрать ключи из массива связанных моделей.
смешанный	update(array $attributes) Обновить родительскую модель в отношении.
Модель	associate(Модель\|int\|string $model) Связать экземпляр модели с заданным родителем.
Модель	dissociate() Отсоединить ранее связанную модель от заданного родителя.
Билдер	getRelationExistenceQueryForSelfRelation(Билдер $query, Билдер $parentQuery, array\|mixed $columns = ['*']) Добавить ограничения для запроса отношения на той же таблице.
строка	getRelationCountHash() Получить хэш таблицы соединения отношения.
логическое значение	relationHasIncrementingId() Определить, имеет ли связанная модель идентификатор с автоматическим инкрементом.
строка	getForeignKey() Получить внешний ключ отношения.
строка	getQualifiedForeignKey() Получить полностью квалифицированный внешний ключ отношения.
строка	getOwnerKey() Получить связанный ключ отношения.
строка	getQualifiedOwnerKeyName() Получить полностью квалифицированный связанный ключ отношения.
строка	getRelation() Получить имя отношения.

Подробности

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

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

Параметры

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

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

void

static void mixin(object $mixin)

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

Параметры

объект

$mixin

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

void

static bool hasMacro(string $name)

Проверка регистрации макроса.

Параметры

строка

$name

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

bool

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

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

Параметры

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

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

смешанный

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Параметры

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

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

смешанный

Исключения

BadMethodCallException

void __construct(Билдер $query, Модель $child, string $foreignKey, string $ownerKey, string $relation)

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

Параметры

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

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

void

static mixed noConstraints(Closure $callback)

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

Параметры

Closure

$callback

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

смешанный

void addConstraints()

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

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

void

void addEagerConstraints(array $models)

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

Параметры

массив

$models

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

void

array initRelation(array $models, string $relation)

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

Параметры

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

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

массив

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

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

Параметры

array	$models
Collection	$results
string	$relation

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

array

mixed getResults()

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

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

mixed

Collection getEager()

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

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

Collection

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

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

Параметры

array

$columns

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

Collection

void touch()

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

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

void

int rawUpdate(array $attributes = [])

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

Параметры

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)

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

Параметры

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

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

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

Параметры

Модель

$parent

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

Модель

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

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

Параметры

Closure|array|bool

$callback

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

$this

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

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

Параметры

Модель

$parent

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

Модель|null

protected array getEagerModelKeys(array $models)

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

Параметры

array

$models

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

array

mixed update(array $attributes)

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

Параметры

array

$attributes

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

mixed

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

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

Параметры

Модель|int|string

$model

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

Модель

Модель dissociate()

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

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

Модель

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

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

Параметры

Билдер	$query
Билдер	$parentQuery
array\|mixed	$columns

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

Билдер

string getRelationCountHash()

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

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

string

protected bool relationHasIncrementingId()

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

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

bool

string getForeignKey()

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

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

string

string getQualifiedForeignKey()

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

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

string

string getOwnerKey()

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

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

string

string getQualifiedOwnerKeyName()

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

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

string

string getRelation()

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

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

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/BelongsTo.html