Spec-Zone.ru › Laravel 7

Builder

class Builder mixin Builder (View source)

Свойства

BuildsQueries
QueriesRelationships
ForwardsCalls

Свойства

protected Builder $query

Базовый экземпляр билдера запросов.
protected Model $model

Модель, к которой применяется запрос.
protected array $eagerLoad

Связи, которые должны быть загружены с помощью eager loading.
static protected array $macros

Все глобально зарегистрированные макросы билдера.
protected array $localMacros

Все локально зарегистрированные макросы билдера.
protected Closure $onDelete

Замена типичной функции удаления.
protected array $passthru

Методы, которые должны быть возвращены из билдера запросов.
protected array $scopes

Примененные глобальные области.
protected array $removedScopes

Удаленные глобальные области.
HigherOrderBuilderProxy только для чтения $orWhere

Методы

bool chunk(int $count, callable $callback)

Разбить результаты запроса на части.

 from BuildsQueries
bool each(callable $callback, int $count = 1000)

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

 from BuildsQueries
bool chunkById(int $count, callable $callback, string|null $column = null, string|null $alias = null)

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

 from BuildsQueries
bool eachById(callable $callback, int $count = 1000, string|null $column = null, string|null $alias = null)

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

 from BuildsQueries
Model|object|BuildsQueries|null first(array|string $columns = ['*'])

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

 from BuildsQueries
mixed|$this when(mixed $value, callable $callback, callable|null $default = null)

Применить изменения запроса обратного вызова, если заданное "значение" истинно.

 from BuildsQueries
$this tap(callable $callback)

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

 from BuildsQueries
mixed|$this unless(mixed $value, callable $callback, callable|null $default = null)

Применить изменения запроса обратного вызова, если заданное "значение" ложно.

 from BuildsQueries
LengthAwarePaginator paginator(Collection $items, int $total, int $perPage, int $currentPage, array $options)

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

 from BuildsQueries
Paginator simplePaginator(Collection $items, int $perPage, int $currentPage, array $options)

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

 from BuildsQueries
Builder|QueriesRelationships has(Relation|string $relation, string $operator = '>=', int $count = 1, string $boolean = 'and', Closure $callback = null)

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

 from QueriesRelationships
Builder|QueriesRelationships hasNested(string $relations, string $operator = '>=', int $count = 1, string $boolean = 'and', Closure|null $callback = null)

Добавить вложенные условия подсчёта/существования отношений к запросу.

 from QueriesRelationships
Builder|QueriesRelationships orHas(string $relation, string $operator = '>=', int $count = 1)

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

 from QueriesRelationships
Builder|QueriesRelationships doesntHave(string $relation, string $boolean = 'and', Closure $callback = null)

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

 from QueriesRelationships
Builder|QueriesRelationships orDoesntHave(string $relation)

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

 from QueriesRelationships
Builder|QueriesRelationships whereHas(string $relation, Closure $callback = null, string $operator = '>=', int $count = 1)

Добавить условие подсчёта/существования отношения к запросу с условиями where.

 from QueriesRelationships
Builder|QueriesRelationships orWhereHas(string $relation, Closure $callback = null, string $operator = '>=', int $count = 1)

Добавить условие подсчёта/существования отношения к запросу с условиями where и "или".

 from QueriesRelationships
Builder|QueriesRelationships whereDoesntHave(string $relation, Closure $callback = null)

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

 from QueriesRelationships
Builder|QueriesRelationships orWhereDoesntHave(string $relation, Closure $callback = null)

Добавить условие подсчёта/отсутствия отношения к запросу с условиями where и "или".

 from QueriesRelationships
Builder|QueriesRelationships hasMorph(string $relation, string|array $types, string $operator = '>=', int $count = 1, string $boolean = 'and', Closure $callback = null)

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

 from QueriesRelationships
BelongsTo getBelongsToRelation(MorphTo $relation, string $type)

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

 from QueriesRelationships
Builder|QueriesRelationships orHasMorph(string $relation, string|array $types, string $operator = '>=', int $count = 1)

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

 from QueriesRelationships
Builder|QueriesRelationships doesntHaveMorph(string $relation, string|array $types, string $boolean = 'and', Closure $callback = null)

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

 from QueriesRelationships
Builder|QueriesRelationships orDoesntHaveMorph(string $relation, string|array $types)

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

 from QueriesRelationships
Builder|QueriesRelationships whereHasMorph(string $relation, string|array $types, Closure $callback = null, string $operator = '>=', int $count = 1)

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

 from QueriesRelationships
Builder|QueriesRelationships orWhereHasMorph(string $relation, string|array $types, Closure $callback = null, string $operator = '>=', int $count = 1)

Добавить условие подсчёта/существования полиморфного отношения к запросу с условиями where и "или".

 from QueriesRelationships
Builder|QueriesRelationships whereDoesntHaveMorph(string $relation, string|array $types, Closure $callback = null)

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

 from QueriesRelationships
Builder|QueriesRelationships orWhereDoesntHaveMorph(string $relation, string|array $types, Closure $callback = null)

Добавить условие подсчёта/существования полиморфного отношения к запросу с условиями where и "или".

 from QueriesRelationships
$this withCount(mixed $relations)

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

 from QueriesRelationships
Builder|QueriesRelationships addHasWhere(Builder $hasQuery, Relation $relation, string $operator, int $count, string $boolean)

Добавить условие "has" в запрос.

 from QueriesRelationships
Builder|QueriesRelationships mergeConstraintsFrom(Builder $from)

Объединить условия where из другого запроса в текущий запрос.

 from QueriesRelationships
$this addWhereCountQuery(Builder $query, string $operator = '>=', int $count = 1, string $boolean = 'and')

Добавить условие подсчёта подзапроса к этому запросу.

 from QueriesRelationships
Relation getRelationWithoutConstraints(string $relation)

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

 from QueriesRelationships
bool canUseExistsForExistenceCheck(string $operator, int $count)

Проверить, можно ли использовать запрос "exists" для оптимизации производительности.

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

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

 from ForwardsCalls
static void throwBadMethodCallException(string $method)

Выбросить исключение bad method call для данного метода.

 from ForwardsCalls
void __construct(Builder $query)

Создать новый экземпляр Eloquent query builder.
Модель|Библиотека make(array $attributes = [])

Создать и вернуть экземпляр модели, не сохранённой в базе данных.
$this withGlobalScope(string $identifier, Scope|Closure $scope)

Зарегистрировать новый глобальный scope.
$this withoutGlobalScope(Scope|string $scope)

Удалить зарегистрированный глобальный scope.
$this withoutGlobalScopes(array $scopes = null)

Удалить все или переданные зарегистрированные глобальные scopes.
массив removedScopes()

Получить массив глобальных scopes, которые были удалены из запроса.
$this whereKey(mixed $id)

Добавить условие where по первичному ключу в запрос.
$this whereKeyNot(mixed $id)

Добавить условие where по первичному ключу в запрос.
$this where(Closure|string|array|Expression $column, mixed $operator = null, mixed $value = null, string $boolean = 'and')

Добавить базовое условие where в запрос.
Модель|Библиотека firstWhere(Closure|string|array|Expression $column, mixed $operator = null, mixed $value = null, string $boolean = 'and')

Добавить базовое условие where в запрос и вернуть первый результат.
$this orWhere(Closure|array|string|Expression $column, mixed $operator = null, mixed $value = null)

Добавить условие "или где" в запрос.
$this latest(string|Expression $column = null)

Добавить условие "сортировать по" для отметки времени в запрос.
$this oldest(string|Expression $column = null)

Добавить условие "сортировать по" для отметки времени в запрос.
Коллекция hydrate(array $items)

Создать коллекцию моделей из обычных массивов.
Коллекция fromQuery(string $query, array $bindings = [])

Создать коллекцию моделей из сырого запроса.
Модель|Коллекция|Библиотека[]|Библиотека|null find(mixed $id, array $columns = ['*'])

Найти модель по её первичному ключу.
Коллекция findMany(Arrayable|array $ids, array $columns = ['*'])

Найти несколько моделей по их первичным ключам.
Модель|Коллекция|Библиотека|Библиотека[] findOrFail(mixed $id, array $columns = ['*'])

Найти модель по первичному ключу или выбросить исключение.
Модель|Библиотека findOrNew(mixed $id, array $columns = ['*'])

Найти модель по первичному ключу или вернуть новый экземпляр модели.
Модель|Библиотека firstOrNew(array $attributes = [], array $values = [])

Получить первую запись, соответствующую атрибутам, или создать её.
Модель|Библиотека firstOrCreate(array $attributes, array $values = [])

Получить первую запись, соответствующую атрибутам, или создать её.
Модель|Библиотека updateOrCreate(array $attributes, array $values = [])

Создать или обновить запись, соответствующую атрибутам, и заполнить её значениями.
Модель|Библиотека firstOrFail(array $columns = ['*'])

Выполнить запрос и получить первый результат или выбросить исключение.
Модель|Библиотека|смешанный тип firstOr(Closure|array $columns = ['*'], Closure $callback = null)

Выполнить запрос и получить первый результат или вызвать обратный вызов.
смешанный тип value(string|Expression $column)

Получить значение одного столбца из первого результата запроса.
Коллекция|Библиотека[] get(array|string $columns = ['*'])

Выполнить запрос как операцию "select".
Модель[]|Библиотека[] getModels(array|string $columns = ['*'])

Получить модели, гидратированные без eager loading.
массив eagerLoadRelations(array $models)

Загрузить отношения eager для моделей.
массив eagerLoadRelation(array $models, string $name, Closure $constraints)

Загрузить отношение eager для набора моделей.
Отношение getRelation(string $name)

Получить экземпляр отношения для данного имени отношения.
массив relationsNestedUnder(string $relation)

Получить глубоко вложенные отношения для данного отношения верхнего уровня.
boolean isNestedUnder(string $relation, string $name)

Определить, является ли отношение вложенным.
LazyCollection cursor()

Получить ленивую коллекцию для данного запроса.
void enforceOrderBy()

Добавить общий оператор «order by», если в запросе его ещё нет.
Collection pluck(string|Expression $column, string|null $key = null)

Получить массив значений заданного столбца.
LengthAwarePaginator paginate(int|null $perPage = null, array $columns = ['*'], string $pageName = 'page', int|null $page = null)

Разбить заданный запрос на страницы.
Paginator simplePaginate(int|null $perPage = null, array $columns = ['*'], string $pageName = 'page', int|null $page = null)

Разбить заданный запрос на страницы с помощью простого пагинатора.
Model|$this create(array $attributes = [])

Сохранить новую модель и вернуть экземпляр.
Model|$this forceCreate(array $attributes)

Сохранить новую модель и вернуть экземпляр. Разрешить массовое назначение.
int update(array $values)

Обновить запись в базе данных.
int increment(string|Expression $column, float|int $amount = 1, array $extra = [])

Увеличить значение столбца на заданное количество.
int decrement(string|Expression $column, float|int $amount = 1, array $extra = [])

Уменьшить значение столбца на заданное количество.
array addUpdatedAtColumn(array $values)

Добавить столбец «updated at» в массив значений.
mixed delete()

Удалить запись из базы данных.
mixed forceDelete()

Выполнить функцию удаления по умолчанию для билдера.
void onDelete(Closure $callback)

Зарегистрировать замену для функции удаления по умолчанию.
bool hasNamedScope(string $scope)

Определить, есть ли у данной модели заданный scope.
Builder|mixed scopes(array|string $scopes)

Вызвать заданные локальные scopes модели.
Builder applyScopes()

Применить scopes к экземпляру Eloquent builder и вернуть его.
mixed callScope(callable $scope, array $parameters = [])

Применить заданный scope к текущему экземпляру builder.
mixed callNamedScope(string $scope, array $parameters = [])

Применить заданный именованный scope к текущему экземпляру builder.
void addNewWheresWithinGroup(Builder $query, int $originalWhereCount)

Вложить условия where, разделив их по заданному количеству.
void groupWhereSliceForScope(Builder $query, array $whereSlice)

Разбить условия where по заданному смещению и добавить их к запросу как вложенное условие.
array createNestedWhere(array $whereSlice, string $boolean = 'and')

Создать массив where с вложенными условиями where.
$this with(mixed $relations)

Установить отношения, которые должны быть загружены с помощью eager loading.
$this without(mixed $relations)

Запретить загрузку указанных отношений с помощью eager loading.
Model|Builder newModelInstance(array $attributes = [])

Создать новый экземпляр модели, по которой выполняется запрос.
array parseWithRelations(array $relations)

Разбить список отношений на отдельные.
array createSelectWithConstraint(string $name)

Создать ограничение для выбора заданных столбцов для отношения.
array addNestedWiths(string $name, array $results)

Обработать вложенные отношения в отношении.
$this withCasts(array $casts)

Применить преобразования к экземпляру модели во время запроса.
Builder getQuery()

Получить базовый экземпляр query builder.
$this setQuery(Builder $query)

Установить базовый экземпляр query builder.
Builder toBase()

Получить базовый экземпляр query builder.
array getEagerLoads()

Получить отношения, которые загружаются с помощью eager loading.
$this setEagerLoads(array $eagerLoad)

Установить отношения, которые загружаются с помощью eager loading.
string defaultKeyName()

Получить имя ключа по умолчанию для таблицы.
Model|Builder getModel()

Получить экземпляр модели, по которой выполняется запрос.
$this setModel(Model $model)

Установить экземпляр модели для модели, по которой выполняется запрос.
string qualifyColumn(string|Expression $column)

Указать имя столбца с учётом таблицы модели.
Closure getMacro(string $name)

Получить заданный макрос по имени.
bool hasMacro(string $name)

Проверить, зарегистрирован ли макрос.
static Closure getGlobalMacro(string $name)

Получить заданный глобальный макрос по имени.
static bool hasGlobalMacro(string $name)

Проверить, зарегистрирован ли глобальный макрос.
mixed __get(string $key)

Динамический доступ к прокси-объектам билдера.
mixed __call(string $method, array $parameters)

Динамическая обработка вызовов в экземпляр запроса.
static mixed __callStatic(string $method, array $parameters)

Динамическая обработка вызовов в экземпляр запроса.
static void registerMixin(string $mixin, bool $replace)

Регистрация заданного миксина в билдере.
void __clone()

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

Подробности

bool chunk(int $count, callable $callback)

Разбиение результатов запроса на куски.

Параметры

int $count
callable $callback

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

bool

bool each(callable $callback, int $count = 1000)

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

Параметры

callable $callback
int $count

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

bool

bool chunkById(int $count, callable $callback, string|null $column = null, string|null $alias = null)

Разбиение результатов запроса на куски по сравнениям ID.

Параметры

int $count
callable $callback
string|null $column
string|null $alias

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

bool

bool eachById(callable $callback, int $count = 1000, string|null $column = null, string|null $alias = null)

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

Параметры

callable $callback
int $count
string|null $column
string|null $alias

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

bool

Модель|object|BuildsQueries|null first(array|string $columns = ['*'])

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

Параметры

array|string $columns

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

Модель|object|BuildsQueries|null

mixed|$this when(mixed $value, callable $callback, callable|null $default = null)

Применение изменений запроса в обратном вызове, если заданное "значение" истинно.

Параметры

mixed $value
callable $callback
callable|null $default

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

mixed|$this

$this tap(callable $callback)

Передача запроса в заданный обратный вызов.

Параметры

callable $callback

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

$this

mixed|$this unless(mixed $value, callable $callback, callable|null $default = null)

Применение изменений запроса в обратном вызове, если заданное "значение" ложно.

Параметры

mixed $value
callable $callback
callable|null $default

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

mixed|$this

protected LengthAwarePaginator paginator(Collection $items, int $total, int $perPage, int $currentPage, array $options)

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

Параметры

Collection $items
int $total
int $perPage
int $currentPage
array $options

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

LengthAwarePaginator

protected Paginator simplePaginator(Collection $items, int $perPage, int $currentPage, array $options)

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

Параметры

Collection $items
int $perPage
int $currentPage
array $options

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

Paginator

Builder|QueriesRelationships has(Relation|string $relation, string $operator = '>=', int $count = 1, string $boolean = 'and', Closure $callback = null)

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

Параметры

Relation|string $relation
string $operator
int $count
string $boolean
Closure $callback

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

Builder|QueriesRelationships

Исключения

RuntimeException

protected Builder|QueriesRelationships hasNested(string $relations, string $operator = '>=', int $count = 1, string $boolean = 'and', Closure|null $callback = null)

Добавить условия подсчёта / существования вложенных отношений к запросу.

Настраивает рекурсивный вызов whereHas до тех пор, пока не завершится вложенное отношение.

Параметры

string $relations
string $operator
int $count
string $boolean
Closure|null $callback

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

Builder|QueriesRelationships

Builder|QueriesRelationships orHas(string $relation, string $operator = '>=', int $count = 1)

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

Параметры

string $relation
string $operator
int $count

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

Builder|QueriesRelationships

Builder|QueriesRelationships doesntHave(string $relation, string $boolean = 'and', Closure $callback = null)

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

Параметры

string $relation
string $boolean
Closure $callback

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

Builder|QueriesRelationships

Builder|QueriesRelationships orDoesntHave(string $relation)

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

Параметры

string $relation

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

Builder|QueriesRelationships

Builder|QueriesRelationships whereHas(string $relation, Closure $callback = null, string $operator = '>=', int $count = 1)

Добавить условие подсчёта / существования отношения к запросу с условиями where.

Параметры

string $relation
Closure $callback
string $operator
int $count

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

Builder|QueriesRelationships

Builder|QueriesRelationships orWhereHas(string $relation, Closure $callback = null, string $operator = '>=', int $count = 1)

Добавить условие подсчёта / существования отношения к запросу с условиями where и "или".

Параметры

string $relation
Closure $callback
string $operator
int $count

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

Builder|QueriesRelationships

Builder|QueriesRelationships whereDoesntHave(string $relation, Closure $callback = null)

Добавить условие подсчёта / существования отношения к запросу с условиями where.

Параметры

string $relation
Closure $callback

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

Builder|QueriesRelationships

Builder|QueriesRelationships orWhereDoesntHave(string $relation, Closure $callback = null)

Добавить условие подсчёта / существования отношения к запросу с условиями where и "или".

Параметры

string $relation
Closure $callback

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

Builder|QueriesRelationships

Builder|QueriesRelationships hasMorph(string $relation, string|array $types, string $operator = '>=', int $count = 1, string $boolean = 'and', Closure $callback = null)

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

Параметры

string $relation
string|array $types
string $operator
int $count
string $boolean
Closure $callback

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

Builder|QueriesRelationships

protected BelongsTo getBelongsToRelation(MorphTo $relation, string $type)

Получить отношение BelongsTo для одного полиморфного типа.

Параметры

MorphTo $relation
string $type

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

BelongsTo

Builder|QueriesRelationships orHasMorph(string $relation, string|array $types, string $operator = '>=', int $count = 1)

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

Параметры

string $relation
string|array $types
string $operator
int $count

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

Builder|QueriesRelationships

Builder|QueriesRelationships doesntHaveMorph(string $relation, string|array $types, string $boolean = 'and', Closure $callback = null)

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

Параметры

string $relation
string|array $types
string $boolean
Closure $callback

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

Builder|QueriesRelationships

Builder|QueriesRelationships orDoesntHaveMorph(string $relation, string|array $types)

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

Параметры

string $relation
string|array $types

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

Builder|QueriesRelationships

Builder|QueriesRelationships whereHasMorph(string $relation, string|array $types, Closure $callback = null, string $operator = '>=', int $count = 1)

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

Параметры

string $relation
string|array $types
Closure $callback
string $operator
int $count

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

Builder|QueriesRelationships

Builder|QueriesRelationships orWhereHasMorph(string $relation, string|array $types, Closure $callback = null, string $operator = '>=', int $count = 1)

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

Параметры

string $relation
string|array $types
Closure $callback
string $operator
int $count

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

Builder|QueriesRelationships

Builder|QueriesRelationships whereDoesntHaveMorph(string $relation, string|array $types, Closure $callback = null)

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

Параметры

string $relation
string|array $types
Closure $callback

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

Builder|QueriesRelationships

Builder|QueriesRelationships orWhereDoesntHaveMorph(string $relation, string|array $types, Closure $callback = null)

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

Параметры

string $relation
string|array $types
Closure $callback

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

Builder|QueriesRelationships

$this withCount(mixed $relations)

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

Параметры

mixed $relations

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

$this

protected Builder|QueriesRelationships addHasWhere(Builder $hasQuery, Relation $relation, string $operator, int $count, string $boolean)

Добавить условие "has" в запрос.

Параметры

Builder $hasQuery
Relation $relation
string $operator
int $count
string $boolean

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

Builder|QueriesRelationships
END_OF_DOCUMENT_MARKER

Builder|QueriesRelationships mergeConstraintsFrom(Builder $from)

Объединить условия where из другого запроса в текущий запрос.

Parameters

Builder $from

Return Value

Builder|QueriesRelationships

protected $this addWhereCountQuery(Builder $query, string $operator = '>=', int $count = 1, string $boolean = 'and')

Добавить подзапрос count в это условие.

Parameters

Builder $query
string $operator
int $count
string $boolean

Return Value

$this

protected Relation getRelationWithoutConstraints(string $relation)

Получить базовый экземпляр запроса для "связи has".

Parameters

string $relation

Return Value

Relation

protected bool canUseExistsForExistenceCheck(string $operator, int $count)

Проверить, можем ли мы использовать запрос "exists" для оптимизации производительности.

Parameters

string $operator
int $count

Return Value

bool

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

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

Parameters

mixed $object
string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

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

Parameters

string $method

Return Value

void

Exceptions

BadMethodCallException

void __construct(Builder $query)

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

Parameters

Builder $query

Return Value

void

Model|Builder make(array $attributes = [])

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

Parameters

array $attributes

Return Value

Model|Builder

$this withGlobalScope(string $identifier, Scope|Closure $scope)

Зарегистрировать новый глобальный scope.

Parameters

string $identifier
Scope|Closure $scope

Return Value

$this

$this withoutGlobalScope(Scope|string $scope)

Удалить зарегистрированный глобальный scope.

Parameters

Scope|string $scope

Return Value

$this

$this withoutGlobalScopes(array $scopes = null)

Удалить все или переданные зарегистрированные глобальные scopes.

Parameters

array $scopes

Return Value

$this

array removedScopes()

Получить массив глобальных scopes, которые были удалены из запроса.

Return Value

array

$this whereKey(mixed $id)

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

Parameters

mixed $id

Return Value

$this

$this whereKeyNot(mixed $id)

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

Parameters

mixed $id

Return Value

$this

$this where(Closure|string|array|Expression $column, mixed $operator = null, mixed $value = null, string $boolean = 'and')

Добавить основное условие where в запрос.

Parameters

Closure|string|array|Expression $column
mixed $operator
mixed $value
string $boolean

Return Value

$this
END_OF_DOCUMENT_MARKER

Модель|Построитель firstWhere(Closure|string|array|Выражение $column, mixed $operator = null, mixed $value = null, string $boolean = 'and')

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

Параметры

Closure|string|array|Выражение $column
mixed $operator
mixed $value
string $boolean

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

Модель|Построитель

$this orWhere(Closure|array|string|Выражение $column, mixed $operator = null, mixed $value = null)

Добавить условие "или где" к запросу.

Параметры

Closure|array|string|Выражение $column
mixed $operator
mixed $value

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

$this

$this latest(string|Выражение $column = null)

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

Параметры

string|Выражение $column

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

$this

$this oldest(string|Выражение $column = null)

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

Параметры

string|Выражение $column

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

$this

Коллекция hydrate(array $items)

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

Параметры

array $items

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

Коллекция

Коллекция fromQuery(string $query, array $bindings = [])

Создать коллекцию моделей из сырого запроса.

Параметры

string $query
array $bindings

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

Коллекция

Модель|Коллекция|Построитель[]|Построитель|null find(mixed $id, array $columns = ['*'])

Найти модель по её первичному ключу.

Параметры

mixed $id
array $columns

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

Модель|Коллекция|Построитель[]|Построитель|null

Коллекция findMany(Массив|array $ids, array $columns = ['*'])

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

Параметры

Массив|array $ids
array $columns

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

Коллекция

Модель|Коллекция|Построитель|Построитель[] findOrFail(mixed $id, array $columns = ['*'])

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

Параметры

mixed $id
array $columns

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

Модель|Коллекция|Построитель|Построитель[]

Исключения

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

Модель|Построитель findOrNew(mixed $id, array $columns = ['*'])

Найти модель по её первичному ключу или вернуть новый экземпляр модели.

Параметры

mixed $id
array $columns

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

Модель|Построитель

Модель|Построитель firstOrNew(array $attributes = [], array $values = [])

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

Параметры

array $attributes
array $values

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

Модель|Построитель

Модель|Построитель firstOrCreate(array $attributes, array $values = [])

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

Параметры

array $attributes
array $values

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

Модель|Построитель
END_OF_DOCUMENT_MARKER

Модель|Билдер updateOrCreate(array $attributes, array $values = [])

Создать или обновить запись, соответствующую атрибутам, и заполнить её значениями.

Параметры

array $attributes
array $values

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

Модель|Билдер

Модель|Билдер firstOrFail(array $columns = ['*'])

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

Параметры

array $columns

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

Модель|Билдер

Исключения

ИсключениеModelNotFoundException

Модель|Билдер|смешанный firstOr(Closure|array $columns = ['*'], Closure $callback = null)

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

Параметры

Closure|array $columns
Closure $callback

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

Модель|Билдер|смешанный

смешанный value(string|Expression $column)

Получить значение единственного столбца из первого результата запроса.

Параметры

string|Expression $column

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

смешанный

Коллекция|Билдер[] get(array|string $columns = ['*'])

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

Параметры

array|string $columns

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

Коллекция|Билдер[]

Модель[]|Билдер[] getModels(array|string $columns = ['*'])

Получить гидратированные модели без леничной загрузки.

Параметры

array|string $columns

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

Модель[]|Билдер[]

array eagerLoadRelations(array $models)

Загрузить отношения для моделей.

Параметры

array $models

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

array

protected array eagerLoadRelation(array $models, string $name, Closure $constraints)

Загрузить отношение для набора моделей.

Параметры

array $models
string $name
Closure $constraints

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

array

Отношение getRelation(string $name)

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

Параметры

string $name

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

Отношение

protected array relationsNestedUnder(string $relation)

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

Параметры

string $relation

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

array

protected bool isNestedUnder(string $relation, string $name)

Определить, является ли отношение вложенным.

Параметры

string $relation
string $name

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

bool

ЛениваяКоллекция cursor()

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

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

ЛениваяКоллекция

protected void enforceOrderBy()

Добавить общий оператор «сортировать по» если запрос ещё не содержит его.

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

void

Коллекция pluck(string|Expression $column, string|null $key = null)

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

Параметры

string|Expression $column
string|null $key

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

Коллекция

PaginatorСПодсчетомЭлементов paginate(int|null $perPage = null, array $columns = ['*'], string $pageName = 'page', int|null $page = null)

Вывести заданный запрос с разбивкой на страницы.

Параметры

int|null $perPage
array $columns
string $pageName
int|null $page

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

PaginatorСПодсчетомЭлементов

Исключения

ИсключениеInvalidArgumentException
END_OF_DOCUMENT_MARKER

Paginator simplePaginate(int|null $perPage = null, array $columns = ['*'], string $pageName = 'page', int|null $page = null)

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

Параметры

int|null $perPage
array $columns
string $pageName
int|null $page

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

Paginator

Модель|$this create(array $attributes = [])

Сохранить новую модель и вернуть экземпляр.

Параметры

array $attributes

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

Модель|$this

Модель|$this forceCreate(array $attributes)

Сохранить новую модель и вернуть экземпляр. Разрешить массовое присваивание.

Параметры

array $attributes

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

Модель|$this

int update(array $values)

Обновить запись в базе данных.

Параметры

array $values

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

int

int increment(string|Выражение $column, float|int $amount = 1, array $extra = [])

Увеличить значение столбца на заданное количество.

Параметры

string|Выражение $column
float|int $amount
array $extra

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

int

int decrement(string|Выражение $column, float|int $amount = 1, array $extra = [])

Уменьшить значение столбца на заданное количество.

Параметры

string|Выражение $column
float|int $amount
array $extra

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

int

protected array addUpdatedAtColumn(array $values)

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

Параметры

array $values

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

array

mixed delete()

Удалить запись из базы данных.

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

mixed

mixed forceDelete()

Выполнить функцию удаления по умолчанию для билдера.

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

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

mixed

void onDelete(Закрытие $callback)

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

Параметры

Закрытие $callback

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

void

bool hasNamedScope(string $scope)

Определить, имеет ли данная модель область видимости.

Параметры

string $scope

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

bool

Билдер|mixed scopes(array|string $scopes)

Вызвать заданные локальные области видимости модели.

Параметры

array|string $scopes

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

Билдер|mixed

Билдер applyScopes()

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

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

Билдер

protected mixed callScope(callable $scope, array $parameters = [])

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

Параметры

callable $scope
array $parameters

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

mixed

protected mixed callNamedScope(string $scope, array $parameters = [])

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

Параметры

string $scope
array $parameters

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

mixed

protected void addNewWheresWithinGroup(Билдер $query, int $originalWhereCount)

Вложить условия where, разделив их по заданному количеству условий.

Параметры

Билдер $query
int $originalWhereCount

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

void

protected void groupWhereSliceForScope(Билдер $query, array $whereSlice)

Разделить условия where по заданному смещению и добавить их в запрос как вложенное условие.

Параметры

Билдер $query
array $whereSlice

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

void

protected array createNestedWhere(array $whereSlice, string $boolean = 'and')

Создать массив where с вложенными условиями where.

Параметры

array $whereSlice
string $boolean

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

array

$this with(mixed $relations)

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

Параметры

mixed $relations

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

$this
END_OF_DOCUMENT_MARKER

$this without(mixed $relations)

Предотвратить указанные отношения от жадного загрузки.

Параметры

mixed $relations

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

$this

Модель|Построитель newModelInstance(array $attributes = [])

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

Параметры

array $attributes

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

Модель|Построитель

protected array parseWithRelations(array $relations)

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

Параметры

array $relations

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

array

protected array createSelectWithConstraint(string $name)

Создать ограничение для выбора указанных столбцов для отношения.

Параметры

string $name

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

array

protected array addNestedWiths(string $name, array $results)

Разбирать вложенные отношения в отношении.

Параметры

string $name
array $results

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

array

$this withCasts(array $casts)

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

Параметры

array $casts

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

$this

Построитель getQuery()

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

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

Построитель

$this setQuery(Построитель $query)

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

Параметры

Построитель $query

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

$this

Построитель toBase()

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

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

Построитель

array getEagerLoads()

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

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

array

$this setEagerLoads(array $eagerLoad)

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

Параметры

array $eagerLoad

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

$this

protected string defaultKeyName()

Получить имя ключа по умолчанию для таблицы.

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

string

Модель|Построитель getModel()

Получить экземпляр модели, которая запрашивается.

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

Модель|Построитель

$this setModel(Модель $model)

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

Параметры

Модель $model

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

$this

string qualifyColumn(string|Выражение $column)

Указать имя столбца по модели таблицы.

Параметры

string|Выражение $column

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

string

Закрытие getMacro(string $name)

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

Параметры

string $name

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

Закрытие

bool hasMacro(string $name)

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

Параметры

string $name

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

bool

static Закрытие getGlobalMacro(string $name)

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

Параметры

string $name

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

Закрытие

static bool hasGlobalMacro(string $name)

Проверяет, зарегистрирован ли глобальный макрос.

Параметры

string $name

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

bool

mixed __get(string $key)

Динамический доступ к прокси-серверам построителей.

Параметры

string $key

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

mixed

Исключения

Исключение

mixed __call(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

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

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

static protected void registerMixin(string $mixin, bool $replace)

Регистрирует заданный миксин в билдере.

Параметры

string $mixin
bool $replace

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

void

void __clone()

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

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

void

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

Spec-Zone.ru

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