Builder
class Builder (View source)
Свойства
| protected Builder | $query | Базовый экземпляр билдера запросов. | |
| protected Model | $model | Запрашиваемая модель. | |
| protected array | $eagerLoad | Связи, которые должны быть загружены с помощью eager loading. | |
| protected array | $macros | Все зарегистрированные макросы билдера. | |
| protected Closure | $onDelete | Замена для стандартной функции удаления. | |
| protected array | $passthru | Методы, которые должны быть возвращены из билдера запросов. | |
| protected array | $scopes | Применённые глобальные скоупы. | |
| protected array | $removedScopes | Удаленные глобальные скоупы. |
Методы
| void | __construct(Builder $query) Создать новый экземпляр Eloquent query builder. | |
| $this | withGlobalScope(string $identifier, Scope|Closure $scope) Зарегистрировать новый глобальный scope. | |
| $this | withoutGlobalScope(Scope|string $scope) Удалить зарегистрированный глобальный scope. | |
| $this | withoutGlobalScopes(array $scopes = null) Удалить все или указанные зарегистрированные глобальные scopes. | |
| array | removedScopes() Получить массив глобальных scopes, удаленных из запроса. | |
| Model|Collection|Builder[]|Builder|null | find(mixed $id, array $columns = ['*']) Найти модель по первичному ключу. | |
| Collection | findMany(array $ids, array $columns = ['*']) Найти несколько моделей по их первичным ключам. | |
| Model|Collection | findOrFail(mixed $id, array $columns = ['*']) Найти модель по первичному ключу или выбросить исключение. | |
| Model | findOrNew(mixed $id, array $columns = ['*']) Найти модель по первичному ключу или вернуть новый экземпляр модели. | |
| Model | firstOrNew(array $attributes) Получить первую запись, соответствующую атрибутам, или создать её. | |
| Model | firstOrCreate(array $attributes, array $values = []) Получить первую запись, соответствующую атрибутам, или создать её. | |
| Model | updateOrCreate(array $attributes, array $values = []) Создать или обновить запись, соответствующую атрибутам, и заполнить её значениями. | |
| Model|Builder|null | first(array $columns = ['*']) Выполнить запрос и получить первый результат. | |
| Model|Builder | firstOrFail(array $columns = ['*']) Выполнить запрос и получить первый результат или выбросить исключение. | |
| Collection|Builder[] | get(array $columns = ['*']) Выполнить запрос как операцию "select". | |
| mixed | value(string $column) Получить значение одного столбца из первого результата запроса. | |
| Generator | cursor() Получить генератор для заданного запроса. | |
| bool | chunk(int $count, callable $callback) Разбить результаты запроса на куски. | |
| bool | chunkById(int $count, callable $callback, string $column = 'id') Разбить результаты запроса на куски по сравниванию числовых ID. | |
| bool | each(callable $callback, int $count = 1000) Выполнить обратный вызов над каждым элементом, разбивая на куски. | |
| Collection | pluck(string $column, string|null $key = null) Получить массив со значениями заданного столбца. | |
| LengthAwarePaginator | paginate(int $perPage = null, array $columns = ['*'], string $pageName = 'page', int|null $page = null) Разбить запрос на страницы. | |
| Paginator | simplePaginate(int $perPage = null, array $columns = ['*'], string $pageName = 'page', int|null $page = null) Разбить запрос на простые страницы. | |
| int | update(array $values) Обновить запись в базе данных. | |
| int | increment(string $column, int $amount = 1, array $extra = []) Увеличить значение столбца на заданное количество. | |
| int | decrement(string $column, int $amount = 1, array $extra = []) Уменьшить значение столбца на заданное количество. | |
| array | addUpdatedAtColumn(array $values) Добавить столбец "updated at" в массив значений. | |
| mixed | delete() Удалить запись из базы данных. | |
| mixed | forceDelete() Выполнить стандартную функцию удаления для билдера. | |
| void | onDelete(Closure $callback) Зарегистрировать замену для стандартной функции удаления. | |
| Model[] | getModels(array $columns = ['*']) Получить загруженные модели без eager loading. | |
| array | eagerLoadRelations(array $models) Загрузить отношения для моделей с eager loading. | |
| array | loadRelation(array $models, string $name, Closure $constraints) Загрузить отношение для набора моделей с eager loading. | |
| Relation | getRelation(string $name) Получить экземпляр отношения для данного имени отношения. | |
| array | nestedRelations(string $relation) Получить глубоко вложенные отношения для заданного отношения верхнего уровня. | |
| bool | isNested(string $name, string $relation) Определить, является ли отношение вложенным. | |
| $this | when(bool $value, Closure $callback, Closure $default = null) Применить изменения запроса от обратного вызова, если заданное "значение" истинно. | |
| $this | where(string|Closure $column, string $operator = null, mixed $value = null, string $boolean = 'and') Добавить условие where в запрос. |
| Builder|Builder | orWhere(string|Closure $column, string $operator = null, mixed $value = null) Добавить условие «или где» к запросу. | |
| Builder|Builder | has(string $relation, string $operator = '>=', int $count = 1, string $boolean = 'and', Closure $callback = null) Добавить условие подсчёта/существования связи к запросу. | |
| Builder|Builder | hasNested(string $relations, string $operator = '>=', int $count = 1, string $boolean = 'and', Closure|null $callback = null) Добавить условия подсчёта/существования вложенных связей к запросу. | |
| Builder|Builder | doesntHave(string $relation, string $boolean = 'and', Closure $callback = null) Добавить условие подсчёта/существования связи к запросу. | |
| Builder|Builder | whereHas(string $relation, Closure $callback = null, string $operator = '>=', int $count = 1) Добавить условие подсчёта/существования связи к запросу с условиями «где». | |
| Builder|Builder | whereDoesntHave(string $relation, Closure $callback = null) Добавить условие подсчёта/существования связи к запросу с условиями «где». | |
| Builder|Builder | orHas(string $relation, string $operator = '>=', int $count = 1) Добавить условие подсчёта/существования связи к запросу с оператором «или». | |
| Builder|Builder | orWhereHas(string $relation, Closure $callback, string $operator = '>=', int $count = 1) Добавить условие подсчёта/существования связи к запросу с условиями «где» и оператором «или». | |
| Builder|Builder | addHasWhere(Builder $hasQuery, Relation $relation, string $operator, int $count, string $boolean) Добавить условие «has» в запрос с помощью условия «где». | |
| bool | shouldRunExistsQuery(string $operator, int $count) Проверить, можно ли выполнить запрос «существует» для оптимизации производительности. | |
| $this | whereCountQuery(Builder $query, string $operator = '>=', int $count = 1, string $boolean = 'and') Добавить условие подсчёта подзапроса к запросу. | |
| Builder|Builder | mergeModelDefinedRelationConstraints(Builder $relation) Объединить ограничения из запроса связи с текущим запросом. | |
| Relation | getHasRelationQuery(string $relation) Получить экземпляр базового запроса «has relation». | |
| $this | with(mixed $relations) Указать связи, которые должны быть загружены жадно. | |
| $this | without(mixed $relations) Запретить указанные связи от жадной загрузки. | |
| $this | withCount(mixed $relations) Добавить подзапросы для подсчёта связей. | |
| array | parseWithRelations(array $relations) Разбить список связей на отдельные. | |
| array | parseNestedWith(string $name, array $results) Обработать вложенные связи в связи. | |
| mixed | scopes(array $scopes) Добавить заданные области видимости к текущему экземпляру билдера. | |
| mixed | callScope(callable $scope, array $parameters = []) Применить заданную область видимости к текущему экземпляру билдера. | |
| Builder|Builder | applyScopes() Применить области видимости к экземпляру Eloquent билдера и вернуть его. | |
| bool | shouldNestWheresForScope(Builder $query, int $originalWhereCount) Определить, должна ли область видимости, добавленная после указанного смещения, быть вложена. | |
| void | nestWheresForScope(Builder $query, int $originalWhereCount) Вложить условия «где» путём их разделения по количеству условий «где». | |
| void | addNestedWhereSlice(Builder $query, array $wheres, int $offset, int $length = null) Разделить условия «где» по указанному смещению и добавить их в запрос как вложенное условие. | |
| array | nestWhereSlice(array $whereSlice, string $boolean = 'and') Создать массив «где» с вложенными условиями «где». | |
| Builder | getQuery() Получить лежащий в основе экземпляр билдера запросов. | |
| Builder | toBase() Получить экземпляр билдера базового запроса. | |
| $this | setQuery(Builder $query) Установить лежащий в основе экземпляр билдера запросов. | |
| array | getEagerLoads() Получить связи, которые загружаются жадно. | |
| $this | setEagerLoads(array $eagerLoad) Указать связи, которые загружаются жадно. | |
| Model | getModel() Получить экземпляр модели, к которой осуществляется запрос. | |
| $this | setModel(Model $model) Установить экземпляр модели для модели, к которой осуществляется запрос. |
| void | macro(string $name, Closure $callback) Расширить билдер заданным обратным вызовом. | |
| Closure | getMacro(string $name) Получить заданный макрос по имени. | |
| mixed | __call(string $method, array $parameters) Динамически обработать вызовы к экземпляру запроса. | |
| void | __clone() Вызвать клонирование базового билдера при клонировании. |
Подробности
void __construct(Builder $query)
Создать новый экземпляр билдера запросов Eloquent.
$this withGlobalScope(string $identifier, Scope|Closure $scope)
Зарегистрировать новый глобальный scope.
$this withoutGlobalScope(Scope|string $scope)
Удалить зарегистрированный глобальный scope.
$this withoutGlobalScopes(array $scopes = null)
Удалить все или переданные зарегистрированные глобальные scopes.
array removedScopes()
Получить массив глобальных scopes, которые были удалены из запроса.
Model|Collection|Builder[]|Builder|null find(mixed $id, array $columns = ['*'])
Найти модель по её первичному ключу.
Collection findMany(array $ids, array $columns = ['*'])
Найти несколько моделей по их первичным ключам.
Model|Collection findOrFail(mixed $id, array $columns = ['*'])
Найти модель по её первичному ключу или выбросить исключение.
Model findOrNew(mixed $id, array $columns = ['*'])
Найти модель по её первичному ключу или вернуть новый экземпляр модели.
Model firstOrNew(array $attributes)
Получить первую запись, соответствующую атрибутам, или создать её.
Model firstOrCreate(array $attributes, array $values = [])
Получить первую запись, соответствующую атрибутам, или создать её.
Model updateOrCreate(array $attributes, array $values = [])
Создать или обновить запись, соответствующую атрибутам, и заполнить её значениями.
Model|Builder firstOrFail(array $columns = ['*'])
Выполнить запрос и получить первый результат или выбросить исключение.
mixed value(string $column)
Получить значение одного столбца из первого результата запроса.
Генератор cursor()
Получить генератор для заданного запроса.
bool chunk(int $count, callable $callback)
Разбить результаты запроса на куски.
bool chunkById(int $count, callable $callback, string $column = 'id')
Разбить результаты запроса на куски, сравнивая числовые идентификаторы.
bool each(callable $callback, int $count = 1000)
Выполнить обратный вызов над каждым элементом с разбиением на куски.
Коллекция pluck(string $column, string|null $key = null)
Получить массив со значениями заданного столбца.
LengthAwarePaginator paginate(int $perPage = null, array $columns = ['*'], string $pageName = 'page', int|null $page = null)
Разбить запрос на страницы.
Пагинатор simplePaginate(int $perPage = null, array $columns = ['*'], string $pageName = 'page', int|null $page = null)
Разбить запрос на страницы с простым пагинатором.
int update(array $values)
Обновить запись в базе данных.
int increment(string $column, int $amount = 1, array $extra = [])
Увеличить значение столбца на заданную величину.
int decrement(string $column, int $amount = 1, array $extra = [])
Уменьшить значение столбца на заданную величину.
protected array addUpdatedAtColumn(array $values)
Добавить столбец «обновлено» в массив значений.
mixed delete()
Удалить запись из базы данных.
mixed forceDelete()
Запустить стандартную функцию удаления для билдера.
void onDelete(Закрытие $callback)
Зарегистрировать замену для стандартной функции удаления.
Модель[] getModels(array $columns = ['*'])
Получить гидратированные модели без ленивой загрузки.
array eagerLoadRelations(array $models)
Загрузить отношения с ленивой загрузкой для моделей.
protected array loadRelation(array $models, string $name, Закрытие $constraints)
Загрузить отношение для набора моделей.
Relation getRelation(string $name)
Получить экземпляр отношения для заданного имени отношения.
protected array nestedRelations(string $relation)
Получить глубоко вложенные отношения для заданного отношения верхнего уровня.
protected bool isNested(string $name, string $relation)
Определить, является ли отношение вложенным.
$this when(bool $value, Closure $callback, Closure $default = null)
Применить изменения запроса обратного вызова, если заданное "значение" истинно.
$this where(string|Closure $column, string $operator = null, mixed $value = null, string $boolean = 'and')
Добавить базовое условие where в запрос.
Builder|Builder orWhere(string|Closure $column, string $operator = null, mixed $value = null)
Добавить условие "or where" в запрос.
Builder|Builder has(string $relation, string $operator = '>=', int $count = 1, string $boolean = 'and', Closure $callback = null)
Добавить условие подсчёта/существования отношения к запросу.
protected Builder|Builder hasNested(string $relations, string $operator = '>=', int $count = 1, string $boolean = 'and', Closure|null $callback = null)
Добавить вложенные условия подсчёта/существования отношения к запросу.
Builder|Builder doesntHave(string $relation, string $boolean = 'and', Closure $callback = null)
Добавить условие подсчёта/существования отношения к запросу.
Builder|Builder whereHas(string $relation, Closure $callback = null, string $operator = '>=', int $count = 1)
Добавить условие подсчёта/существования отношения к запросу с условиями where.
Builder|Builder whereDoesntHave(string $relation, Closure $callback = null)
Добавить условие подсчёта/существования отношения к запросу с условиями where.
Builder|Builder orHas(string $relation, string $operator = '>=', int $count = 1)
Добавить условие подсчёта/существования отношения к запросу с "или".
Builder|Builder orWhereHas(string $relation, Closure $callback, string $operator = '>=', int $count = 1)
Добавить условие подсчёта/существования отношения к запросу с оператором «или».
protected Builder|Builder addHasWhere(Builder $hasQuery, Relation $relation, string $operator, int $count, string $boolean)
Добавить условие «has» в запрос.
protected bool shouldRunExistsQuery(string $operator, int $count)
Проверить возможность выполнения запроса «exists» для оптимизации производительности.
protected $this whereCountQuery(Builder $query, string $operator = '>=', int $count = 1, string $boolean = 'and')
Добавить условие подсчёта с помощью подзапроса к запросу.
Builder|Builder mergeModelDefinedRelationConstraints(Builder $relation)
Объединить ограничения из запроса отношения в текущий запрос.
protected Relation getHasRelationQuery(string $relation)
Получить экземпляр базового запроса «has relation».
$this with(mixed $relations)
Указать отношения, которые должны быть загружены с помощью жадной загрузки.
$this without(mixed $relations)
Запретить жадную загрузку указанных отношений.
$this withCount(mixed $relations)
Добавить подзапросы для подсчёта отношений.
protected array parseWithRelations(array $relations)
Разбор списка отношений на отдельные.
protected array parseNestedWith(string $name, array $results)
Разбор вложенных отношений в отношении.
mixed scopes(array $scopes)
Добавить указанные области видимости к текущему экземпляру билдера.
protected mixed callScope(callable $scope, array $parameters = [])
Применить данную область видимости к текущему экземпляру билдера.
Builder|Builder applyScopes()
Применить области видимости к экземпляру билдера Eloquent и вернуть его.
protected bool shouldNestWheresForScope(Builder $query, int $originalWhereCount)
Определить, нужно ли вкладывать условия, добавленные областью видимости после указанного смещения.
protected void nestWheresForScope(Builder $query, int $originalWhereCount)
Вложить условия where, разделив их по количеству условий where.
protected void addNestedWhereSlice(Builder $query, array $wheres, int $offset, int $length = null)
Разбить условия where по заданному смещению и добавить их в запрос как вложенное условие.
protected array nestWhereSlice(array $whereSlice, string $boolean = 'and')
Создать массив where с вложенными условиями where.
Builder getQuery()
Получить базовый экземпляр билдера запросов.
Builder toBase()
Получить базовый экземпляр билдера запросов.
$this setQuery(Builder $query)
Установить базовый экземпляр билдера запросов.
array getEagerLoads()
Получить загружаемые отношения.
$this setEagerLoads(array $eagerLoad)
Установить загружаемые отношения.
Model getModel()
Получить экземпляр модели, к которой обращается запрос.
$this setModel(Model $model)
Установить экземпляр модели для запроса.
void macro(string $name, Closure $callback)
Расширить билдер с помощью заданного обратного вызова.
Closure getMacro(string $name)
Получить макрос по заданному имени.
mixed __call(string $method, array $parameters)
Динамически обрабатывать вызовы в экземпляр запроса.
void __clone()
Принудительно клонировать базовый билдер запроса при клонировании.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Database/Eloquent/Builder.html
