Строитель
класс Строитель (Просмотреть исходный код)
Трейты
| BuildsQueries |
| QueriesRelationships |
Свойства
| protected Строитель | $query | Базовый экземпляр строителя запросов. | |
| protected Модель | $model | Модель, к которой осуществляется запрос. | |
| protected массив | $eagerLoad | Связи, которые должны быть загружены с помощью eager loading. | |
| static protected массив | $macros | Все глобально зарегистрированные макросы строителя. | |
| protected массив | $localMacros | Все локально зарегистрированные макросы строителя. | |
| protected Closure | $onDelete | Замена стандартной функции удаления. | |
| protected массив | $passthru | Методы, которые должны быть возвращены из строителя запросов. | |
| protected массив | $scopes | Применённые глобальные scope. | |
| protected массив | $removedScopes | Удаленные глобальные scope. |
Методы
| bool | chunk(int $count, callable $callback) Разбить результаты запроса на части. | from BuildsQueries |
| bool | each(callable $callback, int $count = 1000) Выполнить обратный вызов для каждого элемента во время разбиения на части. | from BuildsQueries |
| Model|BuildsQueries|null | first(array $columns = ['*']) Выполнить запрос и получить первый результат. | from BuildsQueries |
| mixed | when(mixed $value, callable $callback, callable $default = null) Применить изменения запроса обратного вызова, если заданное "значение" истинно. | from BuildsQueries |
| Builder | tap(Closure $callback) Передать запрос в заданный обратный вызов. | from BuildsQueries |
| mixed | unless(mixed $value, callable $callback, callable $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(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 |
| $this | withCount(mixed $relations) Добавить подзапросы для подсчета связей. | from QueriesRelationships |
| Builder|QueriesRelationships | addHasWhere(Builder $hasQuery, Relation $relation, string $operator, int $count, string $boolean) Добавить условие "has" where-условие к запросу. | 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) Получить базовый экземпляр запроса для "имеет отношение". | from QueriesRelationships |
| bool | canUseExistsForExistenceCheck(string $operator, int $count) Проверить, можно ли использовать запрос "exists" для оптимизации производительности. | from QueriesRelationships |
| void | __construct(Builder $query) Создать новый экземпляр билдера запросов Eloquent. | |
| Model | make(array $attributes = []) Создать и вернуть экземпляр модели без сохранения. | |
| $this | withGlobalScope(string $identifier, Scope|Closure $scope) Зарегистрировать новый глобальный scope. | |
| $this | withoutGlobalScope(Scope|string $scope) Удалить зарегистрированный глобальный scope. | |
| $this | withoutGlobalScopes(array $scopes = null) Удалить все или переданные зарегистрированные глобальные scopes. | |
| array | removedScopes() Получить массив глобальных scopes, которые были удалены из запроса. | |
| $this | whereKey(mixed $id) Добавить условие where по первичному ключу в запрос. | |
| $this | whereKeyNot(mixed $id) Добавить условие where по первичному ключу в запрос. | |
| $this | where(string|array|Closure $column, string $operator = null, mixed $value = null, string $boolean = 'and') Добавить базовое условие where в запрос. | |
| Builder|Builder | orWhere(Closure|array|string $column, string $operator = null, mixed $value = null) Добавить условие "или где" в запрос. | |
| Collection | hydrate(array $items) Создать коллекцию моделей из обычных массивов. | |
| Collection | fromQuery(string $query, array $bindings = []) Создать коллекцию моделей из сырого запроса. | |
| Model|Collection|Builder[]|Builder|null | find(mixed $id, array $columns = ['*']) Найти модель по её первичному ключу. | |
| Collection | findMany(Arrayable|array $ids, array $columns = ['*']) Найти несколько моделей по их первичным ключам. | |
| Model|Collection | findOrFail(mixed $id, array $columns = ['*']) Найти модель по первичному ключу или выбросить исключение. | |
| Model | findOrNew(mixed $id, array $columns = ['*']) Найти модель по первичному ключу или вернуть новый экземпляр модели. | |
| Model | firstOrNew(array $attributes, array $values = []) Получить первую запись, соответствующую атрибутам, или создать её экземпляр. | |
| Model | firstOrCreate(array $attributes, array $values = []) Получить первую запись, соответствующую атрибутам, или создать её. | |
| Model | updateOrCreate(array $attributes, array $values = []) Создать или обновить запись, соответствующую атрибутам, и заполнить её значениями. | |
| Model|Builder | firstOrFail(array $columns = ['*']) Выполнить запрос и получить первый результат или выбросить исключение. | |
| Model|Builder|mixed | firstOr(Closure|array $columns = ['*'], Closure $callback = null) Выполнить запрос и получить первый результат или вызвать колбэк. | |
| mixed | value(string $column) Получить значение одиночного столбца из первого результата запроса. | |
| Collection|Builder[] | get(array $columns = ['*']) Выполнить запрос как операцию "select". | |
| Model[] | getModels(array $columns = ['*']) Получить загруженные модели без eager loading. | |
| array | eagerLoadRelations(array $models) Загрузить связанные сущности для моделей. | |
| array | eagerLoadRelation(array $models, string $name, Closure $constraints) Загрузить связанные сущности для набора моделей. | |
| Relation | getRelation(string $name) Получить экземпляр связи для заданного имени связи. | |
| array | relationsNestedUnder(string $relation) Получить глубоко вложенные связи для заданной связи верхнего уровня. |
| bool | isNestedUnder(string $relation, string $name) Определить, является ли отношение вложенным. | |
| Generator | cursor() Получить генератор для данного запроса. | |
| bool | chunkById(int $count, callable $callback, string $column = null, string|null $alias = null) Разбить результаты запроса на части по сравнение численных идентификаторов. | |
| void | enforceOrderBy() Добавить универсальное условие «упорядочить по» если в запросе его нет. | |
| 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) Разбить результаты запроса на простые страницы. | |
| Model|$this | create(array $attributes = []) Сохранить новую модель и вернуть экземпляр. | |
| Model|$this | forceCreate(array $attributes) Сохранить новую модель и вернуть экземпляр. Разрешить массовое назначение. | |
| 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) Добавить столбец «обновлено» в массив значений. | |
| mixed | delete() Удалить запись из базы данных. | |
| mixed | forceDelete() Выполнить стандартную функцию удаления на билдере. | |
| void | onDelete(Closure $callback) Зарегистрировать замену для стандартной функции удаления. | |
| mixed | scopes(array $scopes) Вызвать заданные локальные модель-скоупы. | |
| Builder|Builder | applyScopes() Применить скоупы к экземпляру Eloquent билдера и вернуть его. | |
| mixed | callScope(callable $scope, array $parameters = []) Применить заданный скоуп к текущему экземпляру билдера. | |
| 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 | newModelInstance(array $attributes = []) Создать новый экземпляр модели, к которой осуществляется запрос. | |
| array | parseWithRelations(array $relations) Обработать список отношений в отдельные единицы. | |
| array | createSelectWithConstraint(string $name) Создать ограничение для выбора указанных столбцов для отношения. | |
| array | addNestedWiths(string $name, array $results) Обработать вложенные отношения в отношении. | |
| Builder | getQuery() Получить базовый экземпляр билдера запросов. | |
| $this | setQuery(Builder $query) Установить базовый экземпляр билдера запросов. | |
| Builder | toBase() Получить базовый экземпляр билдера запросов. | |
| array | getEagerLoads() Получить отношения, которые загружаются с помощью eager loading. | |
| $this | setEagerLoads(array $eagerLoad) Установить отношения, которые загружаются с помощью eager loading. | |
| Model | getModel() Получить экземпляр модели, к которой осуществляется запрос. | |
| $this | setModel(Model $model) Установить экземпляр модели для модели, к которой осуществляется запрос. | |
| Closure | getMacro(string $name) Получить заданный макрос по имени. | |
| mixed | __call(string $method, array $parameters) Динамически обработать вызовы к экземпляру запроса. | |
| static mixed | __callStatic(string $method, array $parameters) Динамически обработать вызовы к экземпляру запроса. | |
| void | __clone() Принудительно клонировать базовый билдер запросов при клонировании. |
Details
bool chunk(int $count, callable $callback)
Разбить результаты запроса на части.
bool each(callable $callback, int $count = 1000)
Выполнить обратный вызов над каждым элементом с поблочным чанкингом.
Модель|BuildsQueries|null first(array $columns = ['*'])
Выполнить запрос и получить первый результат.
mixed when(mixed $value, callable $callback, callable $default = null)
Применить изменения запроса обратного вызова, если заданное «значение» истинно.
mixed unless(mixed $value, callable $callback, callable $default = null)
Применить изменения запроса обратного вызова, если заданное «значение» ложно.
protected LengthAwarePaginator paginator(Collection $items, int $total, int $perPage, int $currentPage, array $options)
Создать новый экземпляр пагинатора с учетом длины.
protected Paginator simplePaginator(Collection $items, int $perPage, int $currentPage, array $options)
Создать новый простой экземпляр пагинатора.
Билдер|QueriesRelationships has(string $relation, string $operator = '>=', int $count = 1, string $boolean = 'and', Closure $callback = null)
Добавить условие подсчета/существования отношения к запросу.
protected Билдер|QueriesRelationships hasNested(string $relations, string $operator = '>=', int $count = 1, string $boolean = 'and', Closure|null $callback = null)
Добавить вложенные условия подсчета/существования отношения к запросу.
Настраивает рекурсивный вызов whereHas, пока не закончатся вложенные отношения.
Билдер|QueriesRelationships orHas(string $relation, string $operator = '>=', int $count = 1)
Добавить условие подсчета/существования отношения к запросу с «или».
Билдер|QueriesRelationships doesntHave(string $relation, string $boolean = 'and', Closure $callback = null)
Добавить условие подсчета/существования отношения к запросу.
Билдер|QueriesRelationships orDoesntHave(string $relation)
Добавить условие подсчета/существования отношения к запросу с «или».
Builder|СвязанныеЗапросы whereHas(string $relation, Closure $callback = null, string $operator = '>=', int $count = 1)
Добавить условие подсчёта/существования отношения к запросу с условиями where.
Builder|СвязанныеЗапросы orWhereHas(string $relation, Closure $callback = null, string $operator = '>=', int $count = 1)
Добавить условие подсчёта/существования отношения к запросу с условиями where и оператором "или".
Builder|СвязанныеЗапросы whereDoesntHave(string $relation, Closure $callback = null)
Добавить условие подсчёта/существования отношения к запросу с условиями where.
Builder|СвязанныеЗапросы orWhereDoesntHave(string $relation, Closure $callback = null)
Добавить условие подсчёта/существования отношения к запросу с условиями where и оператором "или".
$this withCount(mixed $relations)
Добавить подзапросы для подсчёта отношений.
protected Builder|СвязанныеЗапросы addHasWhere(Builder $hasQuery, Relation $relation, string $operator, int $count, string $boolean)
Добавить условие "имеет" в оператор where запроса.
Builder|СвязанныеЗапросы mergeConstraintsFrom(Builder $from)
Объединить условия where из другого запроса в текущий запрос.
protected $this addWhereCountQuery(Builder $query, string $operator = '>=', int $count = 1, string $boolean = 'and')
Добавить условие подсчёта подзапроса к этому запросу.
protected Relation getRelationWithoutConstraints(string $relation)
Получить экземпляр базового запроса "имеет отношение".
protected bool canUseExistsForExistenceCheck(string $operator, int $count)
Проверить, можем ли мы выполнить запрос "существует" для оптимизации производительности.
void __construct(Builder $query)
Создать новый экземпляр билдера запросов Eloquent.
Модель make(array $attributes = [])
Создать и вернуть экземпляр модели без сохранения.
$this withGlobalScope(string $identifier, Scope|Closure $scope)
Зарегистрировать новый глобальный scope.
$this withoutGlobalScope(Scope|string $scope)
Удалить зарегистрированный глобальный scope.
$this withoutGlobalScopes(array $scopes = null)
Удалить все или указанные зарегистрированные глобальные scopes.
array removedScopes()
Получить массив глобальных scopes, которые были удалены из запроса.
$this whereKey(mixed $id)
Добавить условие where по первичному ключу в запрос.
$this whereKeyNot(mixed $id)
Добавить условие where по первичному ключу в запрос.
$this where(string|array|Closure $column, string $operator = null, mixed $value = null, string $boolean = 'and')
Добавить базовое условие where в запрос.
Builder|Builder orWhere(Closure|array|string $column, string $operator = null, mixed $value = null)
Добавить условие "или где" в запрос.
Collection hydrate(array $items)
Создать коллекцию моделей из обычных массивов.
Collection fromQuery(string $query, array $bindings = [])
Создать коллекцию моделей из исходного запроса.
Model|Collection|Builder[]|Builder|null find(mixed $id, array $columns = ['*'])
Найти модель по её первичному ключу.
Collection findMany(Arrayable|array $ids, array $columns = ['*'])
Найти несколько моделей по их первичным ключам.
Model|Collection findOrFail(mixed $id, array $columns = ['*'])
Найти модель по её первичному ключу или выбросить исключение.
Model findOrNew(mixed $id, array $columns = ['*'])
Найти модель по её первичному ключу или вернуть новый экземпляр модели.
Model firstOrNew(array $attributes, array $values = [])
Получить первую запись, соответствующую атрибутам, или создать её.
Model firstOrCreate(array $attributes, array $values = [])
Получить первую запись, соответствующую атрибутам, или создать её, если она не существует.
Модель updateOrCreate(array $attributes, array $values = [])
Создать или обновить запись, соответствующую атрибутам, и заполнить её значениями.
Модель|Билдер firstOrFail(array $columns = ['*'])
Выполнить запрос и получить первый результат или выбросить исключение.
Модель|Билдер|смешанный тип firstOr(Замыкание|array $columns = ['*'], Замыкание $callback = null)
Выполнить запрос и получить первый результат или вызвать обратный вызов.
смешанный тип value(string $column)
Получить значение отдельного столбца из первого результата запроса.
Модель[] getModels(array $columns = ['*'])
Получить модели с гидратацией без ленивой загрузки.
array eagerLoadRelations(array $models)
Загрузить отношения с нетерпением для моделей.
protected array eagerLoadRelation(array $models, string $name, Замыкание $constraints)
Загрузить отношение с нетерпением для набора моделей.
Отношение getRelation(string $name)
Получить экземпляр отношения для заданного имени отношения.
protected array relationsNestedUnder(string $relation)
Получить глубоко вложенные отношения для заданного отношения верхнего уровня.
protected bool isNestedUnder(string $relation, string $name)
Определить, является ли отношение вложенным.
Генератор cursor()
Получить генератор для заданного запроса.
bool chunkById(int $count, callable $callback, string $column = null, string|null $alias = null)
Разбить результаты запроса на части, сравнивая числовые идентификаторы.
protected void enforceOrderBy()
Добавить общий оператор "order by", если в запросе его нет.
Коллекция pluck(string $column, string|null $key = null)
Получить массив со значениями заданного столбца.
Страничный агрегатор с размером страницы 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)
Разбить заданный запрос на страницы с помощью простого пагинатора.
Модель|$this create(array $attributes = [])
Сохранить новую модель и вернуть экземпляр.
Модель|$this forceCreate(array $attributes)
Сохранить новую модель и вернуть экземпляр. Разрешить массовое назначение.
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)
Добавить столбец "updated at" в массив значений.
mixed delete()
Удалить запись из базы данных.
mixed forceDelete()
Выполнить стандартную функцию удаления на билдере.
Поскольку мы здесь не применяем области видимости, строка фактически будет удалена.
void onDelete(Closure $callback)
Зарегистрировать замену для стандартной функции удаления.
mixed scopes(array $scopes)
Вызвать заданные локальные области видимости модели.
Builder|Builder applyScopes()
Применить области видимости к экземпляру билдера Eloquent и вернуть его.
protected mixed callScope(callable $scope, array $parameters = [])
Применить заданную область видимости к текущему экземпляру билдера.
protected void addNewWheresWithinGroup(Builder $query, int $originalWhereCount)
Вложить условия where, разделив их на заданном количестве where.
protected void groupWhereSliceForScope(Builder $query, array $whereSlice)
Разделить условия where на заданный смещение и добавить их в запрос как вложенное условие.
protected array createNestedWhere(array $whereSlice, string $boolean = 'and')
Создать массив where с вложенными условиями where.
$this with(mixed $relations)
Установить отношения, которые должны быть загружены с помощью жадной загрузки.
$this without(mixed $relations)
Запретить указанные отношения от жадной загрузки.
Модель newModelInstance(array $attributes = [])
Создать новый экземпляр модели, по которой выполняется запрос.
protected array parseWithRelations(array $relations)
Обработать список отношений в отдельные сущности.
protected array createSelectWithConstraint(string $name)
Создать ограничение для выбора заданных столбцов для отношения.
protected array addNestedWiths(string $name, array $results)
Обработать вложенные отношения в отношении.
Builder getQuery()
Получить базовый экземпляр билдера запросов.
$this setQuery(Builder $query)
Установить базовый экземпляр билдера запросов.
Builder toBase()
Получить базовый экземпляр билдера запросов.
array getEagerLoads()
Получить отношения, загружаемые с жадной загрузкой.
$this setEagerLoads(array $eagerLoad)
Установить отношения, загружаемые с жадной загрузкой.
Model getModel()
Получить экземпляр модели, к которой осуществляется запрос.
$this setModel(Model $model)
Установить экземпляр модели для запроса.
Closure getMacro(string $name)
Получить макрос по имени.
mixed __call(string $method, array $parameters)
Динамически обработать вызов в экземпляр запроса.
static mixed __callStatic(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.5/Illuminate/Database/Eloquent/Builder.html
