BelongsTo

class BelongsTo extends Relation (View source)

Свойства

static protected array	$macros	Зарегистрированные строковые макросы.	из Macroable
protected Builder	$query	Экземпляр билдера запросов Eloquent.	из Relation
protected Model	$parent	Экземпляр родительской модели.	из Relation
protected Model	$related	Экземпляр связанной модели.	из Relation
static protected bool	$constraints	Указывает, добавляет ли отношение ограничения.	из Relation
static protected 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, callable $macro) Зарегистрировать пользовательское макро.	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
void	touch() Обновить все связанные модели для отношения.	from Relation
int	rawUpdate(array $attributes = []) Выполнить обновление с помощью SQL запроса к базовому запросу.	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
Model	newRelatedInstanceFor(Model $parent) Создать новый связанный экземпляр для заданной модели.
$this	withDefault(Closure\|array\|bool $callback = true) Возвратить новый экземпляр модели в случае отсутствия отношения.	from SupportsDefaultModels

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

Подробности

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

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

Параметры

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

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

void

static логическое значение hasMacro(string $name)

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

Параметры

строка

$name

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

логическое значение

static смешанный тип __callStatic(string $method, array $parameters)

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

Параметры

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

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

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

Исключения

BadMethodCallException

смешанный тип __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 смешанный тип noConstraints(Closure $callback)

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

Параметры

Closure

$callback

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

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

void addConstraints()

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

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

void

void addEagerConstraints(массив $models)

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

Параметры

массив

$models

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

void

массив initRelation(массив $models, строка $relation)

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

Параметры

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

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

массив

массив match(массив $models, Коллекция $results, строка $relation)

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

Параметры

массив	$models
Коллекция	$results
строка	$relation

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

массив

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

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

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

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

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

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

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

Коллекция

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

Модель getParent()

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

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

Модель

string getQualifiedParentKeyName()

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

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

string

Модель getRelated()

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

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

Модель

string createdAt()

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

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

string

string updatedAt()

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

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

string

string relatedUpdatedAt()

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

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

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

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

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

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

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.4/Illuminate/Database/Eloquent/Relations/BelongsTo.html