Spec-Zone.ru › Laravel 9

BuildsQueries

trait BuildsQueries (View source)

Свойства

Conditionable

Методы

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

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

from Conditionable
$this|TUnlessReturnType unless($value = null, callable $callback = null, callable $default = null)

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

from Conditionable
bool chunk(int $count, callable $callback)

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

Collection chunkMap(callable $callback, int $count = 1000)

Применить функцию к каждому элементу с разбиением на куски.

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

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

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

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

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

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

LazyCollection lazy(int $chunkSize = 1000)

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

LazyCollection lazyById(int $chunkSize = 1000, string|null $column = null, string|null $alias = null)

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

LazyCollection lazyByIdDesc(int $chunkSize = 1000, string|null $column = null, string|null $alias = null)

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

LazyCollection orderedLazyById(int $chunkSize = 1000, string|null $column = null, string|null $alias = null, bool $descending = false)

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

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

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

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

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

CursorPaginator paginateUsingCursor(int $perPage, array|string $columns = ['*'], string $cursorName = 'cursor', Cursor|string|null $cursor = null)

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

string getOriginalColumnNameForCursorPagination(Builder|Builder $builder, string $parameter)

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

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

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

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

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

CursorPaginator cursorPaginator(Collection $items, int $perPage, Cursor $cursor, array $options)

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

$this tap(callable $callback)

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

Подробности

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

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

Параметры

$value
callable $callback
callable $default

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

$this|TWhenReturnType

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

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

Параметры

$value
callable $callback
callable $default

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

$this|TUnlessReturnType

bool chunk(int $count, callable $callback)

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

Параметры

int $count
callable $callback

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

bool

Collection chunkMap(callable $callback, int $count = 1000)

Применить функцию к каждому элементу с разбиением на куски.

Параметры

callable $callback
int $count

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

Collection

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

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

Параметры

callable $callback
int $count

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

bool

Исключения

RuntimeException

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

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

Параметры

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)

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

Параметры

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

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

bool

LazyCollection lazy(int $chunkSize = 1000)

Ленивый запрос по кускам заданного размера.

Параметры

int $chunkSize

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

LazyCollection

Исключения

InvalidArgumentException

LazyCollection lazyById(int $chunkSize = 1000, string|null $column = null, string|null $alias = null)

Ленивый запрос, разбивающий результаты запроса по сравнениям идентификаторов.

Параметры

int $chunkSize
string|null $column
string|null $alias

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

LazyCollection

Исключения

InvalidArgumentException

LazyCollection lazyByIdDesc(int $chunkSize = 1000, string|null $column = null, string|null $alias = null)

Ленивый запрос, разбивающий результаты запроса по сравнениям идентификаторов в порядке убывания.

Параметры

int $chunkSize
string|null $column
string|null $alias

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

LazyCollection

Исключения

InvalidArgumentException

protected LazyCollection orderedLazyById(int $chunkSize = 1000, string|null $column = null, string|null $alias = null, bool $descending = false)

Ленивый запрос, разбивающий результаты запроса по сравнениям идентификаторов в заданном порядке.

Параметры

int $chunkSize
string|null $column
string|null $alias
bool $descending

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

LazyCollection

Исключения

InvalidArgumentException

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

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

Параметры

array|string $columns

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

Model|object|BuildsQueries|null

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

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

Параметры

array|string $columns

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

Model|object|BuildsQueries|null

Исключения

RecordsNotFoundException
MultipleRecordsFoundException

protected CursorPaginator paginateUsingCursor(int $perPage, array|string $columns = ['*'], string $cursorName = 'cursor', Cursor|string|null $cursor = null)

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

Параметры

int $perPage
array|string $columns
string $cursorName
Cursor|string|null $cursor

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

CursorPaginator

protected string getOriginalColumnNameForCursorPagination(Builder|Builder $builder, string $parameter)

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

Параметры

Builder|Builder $builder
string $parameter

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

string

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

protected CursorPaginator cursorPaginator(Collection $items, int $perPage, Cursor $cursor, array $options)

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

Параметры

Collection $items
int $perPage
Cursor $cursor
array $options

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

CursorPaginator

$this tap(callable $callback)

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

Параметры

callable $callback

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

$this

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

Spec-Zone.ru

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