Spec-Zone.ru › Laravel 8

BelongsTo

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

Трейты

ComparesRelatedModels
InteractsWithDictionary
SupportsDefaultModels
ForwardsCalls
Macroable

Свойства

статический защищенный массив $macros

Зарегистрированные строковые макросы.

 из Macroable
защищенный Builder $query

Экземпляр билдера Eloquent запросов.

 из Relation
защищенный Model $parent

Экземпляр родительской модели.

 из Relation
защищенный Model $related

Экземпляр связанной модели.

 из Relation
статический защищенный bool $constraints

Указывает, добавляет ли отношение ограничения.

 из Relation
статический массив $morphMap

Массив для сопоставления имен классов с их именами морф в базе данных.

 из Relation
статический защищенный bool $requireMorphMap

Препятствует морф отношениям без карты морф.

 из Relation
статический защищенный int $selfJoinCount

Количество самосоединений.

 из Relation
защищенный Closure|массив|bool $withDefault

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

 из SupportsDefaultModels
защищенный Model $child

Экземпляр дочерней модели отношения.
защищенный строка $foreignKey

Внешний ключ родительской модели.
защищенный строка $ownerKey

Связанный ключ в родительской модели.
защищенный строка $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)

Установить ограничения для ленивой загрузки отношения.
array initRelation(array $models, string $relation)

Инициализировать отношение для набора моделей.
array match(array $models, Collection $results, string $relation)

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

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

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

 из Relation
Model sole(array|string $columns = ['*'])

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

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

Добавить ограничения для запроса отношения.
string getRelationCountHash(bool $incrementJoinCount = true)

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

 из Relation
array getKeys(array $models, string|null $key = null)

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

 из Relation
Builder getRelationQuery()

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

 из Relation
Builder getQuery()

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

 из Relation
Builder getBaseQuery()

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

 из Relation
Model getParent()

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

 из Relation
string getQualifiedParentKeyName()

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

 из Relation
Модель getRelated()

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

 из Отношения
строка createdAt()

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

 из Отношения
строка updatedAt()

Получить имя столбца "обновлено в".

 из Отношения
строка relatedUpdatedAt()

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

 из Отношения
строка whereInMethod(Модель $model, string $key)

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

 из Отношения
статический void requireMorphMap(bool $requireMorphMap = true)

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

 из Отношения
статический bool requiresMorphMap()

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

 из Отношения
статический массив enforceMorphMap(array $map, bool $merge = true)

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

 из Отношения
статический массив morphMap(array $map = null, bool $merge = true)

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

 из Отношения
статический массив|null buildMorphMapFromModels(array $models = null)

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

 из Отношения
статический строка|null getMorphedModel(string $alias)

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

 из Отношения
void __clone()

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

 из Отношения
bool is(Модель|null $model)

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

 из ComparesRelatedModels
bool isNot(Модель|null $model)

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

 из ComparesRelatedModels
mixed getParentKey()

Получить значение ключа внешнего ключа дочернего элемента.
mixed getRelatedKeyFrom(Модель $model)

Получить значение связанного ключа модели.
bool compareKeys(mixed $parentKey, mixed $relatedKey)

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

 из ComparesRelatedModels
mixed getDictionaryKey(mixed $attribute)

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

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

Создать новый связанный экземпляр для данной модели.
$this withDefault(Closure|array|bool $callback = true)

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

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

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

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

Собрать ключи из массива связанных моделей.
Модель associate(Модель|int|string|null $model)

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

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

Псевдоним метода "dissociate".
Билдер getRelationExistenceQueryForSelfRelation(Билдер $query, Билдер $parentQuery, array|mixed $columns = ['*'])

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

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

Получить дочерний элемент отношения.
строка getForeignKeyName()

Получить внешний ключ отношения.
строка getQualifiedForeignKeyName()

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

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

Получить полностью квалифицированный связанный ключ отношения.
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, Model $child, string $foreignKey, string $ownerKey, string $relationName)

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

Параметры

Builder $query
Model $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

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

Модель sole(array|string $columns = ['*'])

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

Параметры

array|string $columns

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

Модель

Исключения

ИсключениеНеНайденнойМодели
ИсключениеНесколькоЗаписейНайдено

Коллекция get(array $columns = ['*'])

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

Параметры

array $columns

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

Коллекция

void touch()

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

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

void

int rawUpdate(array $attributes = [])

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

Параметры

array $attributes

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

int

Билдер getRelationExistenceCountQuery(Билдер $query, Билдер $parentQuery)

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

Параметры

Билдер $query
Билдер $parentQuery

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

Билдер

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

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

Параметры

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

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

Билдер

string getRelationCountHash(bool $incrementJoinCount = true)

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

Параметры

bool $incrementJoinCount

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

string

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

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

Параметры

array $models
string|null $key

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

array

protected Билдер getRelationQuery()

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

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

Билдер

Билдер getQuery()

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

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

Билдер

Билдер getBaseQuery()

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

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

Билдер

Модель getParent()

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

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

Модель

string getQualifiedParentKeyName()

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

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

string

Модель getRelated()

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

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

Модель

string createdAt()

Получить имя колонки «создано в».

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

string

string updatedAt()

Получить имя колонки «обновлено в».

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

string

string relatedUpdatedAt()

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

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

string

protected string whereInMethod(Модель $model, string $key)

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

Параметры

Модель $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)

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

Параметры

array $map
bool $merge

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

array

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

bool is(Model|null $model)

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

Параметры

Model|null $model

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

bool

bool isNot(Model|null $model)

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

Параметры

Model|null $model

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

bool

mixed getParentKey()

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

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

mixed

protected mixed getRelatedKeyFrom(Model $model)

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

Параметры

Model $model

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

mixed

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

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

Параметры

mixed $parentKey
mixed $relatedKey

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

bool

protected mixed getDictionaryKey(mixed $attribute)

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

Параметры

mixed $attribute

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

mixed

Исключения

InvalidArgumentException

protected Model newRelatedInstanceFor(Model $parent)

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

Параметры

Model $parent

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

Model

$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

Model associate(Model|int|string|null $model)

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

Параметры

Model|int|string|null $model

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

Model

Model dissociate()

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

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

Model

Model disassociate()

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

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

Model

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

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

Параметры

Builder $query
Builder $parentQuery
array|mixed $columns

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

Builder

protected bool relationHasIncrementingId()

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

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

bool

Модель getChild()

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

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

Модель

string getForeignKeyName()

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

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

string

string getQualifiedForeignKeyName()

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

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

string

string getOwnerKeyName()

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

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

string

string getQualifiedOwnerKeyName()

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

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

string

string getRelationName()

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

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

string

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

Spec-Zone.ru

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