Spec-Zone.ru › Laravel 5.8

BelongsTo

class BelongsTo extends Relation (View source)

Свойства

SupportsDefaultModels
ForwardsCalls
Macroable

Свойства

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

Методы

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

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

from ForwardsCalls
static void throwBadMethodCallException(string $method)

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

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

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

from Macroable
static void mixin(object $mixin, bool $replace = true)

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

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 $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
Коллекция get(array $columns = ['*'])

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

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

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

из Отношения
int rawUpdate(array $attributes = [])

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

из Отношения
Билдер getRelationExistenceCountQuery(Билдер $query, Билдер $parentQuery)

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

из Отношения
Билдер getRelationExistenceQuery(Билдер $query, Билдер $parentQuery, array|mixed $columns = ['*'])

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

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

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

из Отношения
Построитель getQuery()

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

из Связь
Построитель getBaseQuery()

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

из Связь
Модель getParent()

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

из Связь
строка getQualifiedParentKeyName()

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

из Связь
Модель getRelated()

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

из Связь
строка createdAt()

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

из Связь
строка updatedAt()

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

из Связь
string relatedUpdatedAt()

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

из Relation
string whereInMethod(Model $model, string $key)

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

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

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

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

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

из Relation
static string|null getMorphedModel(string $alias)

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

из Relation
void __clone()

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

из Relation
Model newRelatedInstanceFor(Model $parent)

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

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

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

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

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

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

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

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

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

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

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

Модель dissociate()

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

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

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

string getRelationCountHash()

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

bool relationHasIncrementingId()

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

Model getChild()

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

string getForeignKeyName()

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

string getQualifiedForeignKeyName()

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

string getOwnerKeyName()

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

string getQualifiedOwnerKeyName()

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

string getRelationName()

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

string getRelation() deprecated

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

Details

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

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

Параметры

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

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

Параметры

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

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

Параметры

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

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

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

string

string updatedAt()

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

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

string

string relatedUpdatedAt()

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

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

string

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

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

Параметры

Model $model
string $key

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

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)

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

Параметры

Массив $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

Модель getChild()

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

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

Модель

string getForeignKeyName()

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

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

string

string getQualifiedForeignKeyName()

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

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

string

string getOwnerKeyName()

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

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

string

string getQualifiedOwnerKeyName()

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

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

string

string getRelationName()

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

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

string

string getRelation() устаревшее

устаревшее

Вместо этого следует использовать метод getRelationName(). Будет удалено в Laravel 6.0.

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

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

string

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

Spec-Zone.ru

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