Spec-Zone.ru › Laravel 10

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 chunkByIdDesc(int $count, callable $callback, string|null $column = null, string|null $alias = null)

Разбить результаты запроса на куски, сравнивая идентификаторы в порядке убывания.
bool orderedChunkById(int $count, callable $callback, string|null $column = null, string|null $alias = null, bool $descending = false)

Разбить результаты запроса на куски, сравнивая идентификаторы в заданном порядке.
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
коллбек $callback
коллбек $default

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

$this|TWhenReturnType

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

Применить коллбек, если заданное «значение» ложно.

Параметры

$value
коллбек $callback
коллбек $default

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

$this|TUnlessReturnType

bool chunk(int $count, callable $callback)

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

Параметры

int $count
коллбек $callback

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

bool

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

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

Параметры

коллбек $callback
int $count

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

Collection
END_OF_DOCUMENT_MARKER

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

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

Parameters

callable $callback
int $count

Return Value

bool

Exceptions

RuntimeException

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

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

Parameters

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

Return Value

bool

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

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

Parameters

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

Return Value

bool

bool orderedChunkById(int $count, callable $callback, string|null $column = null, string|null $alias = null, bool $descending = false)

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

Parameters

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

Return Value

bool

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

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

Parameters

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

Return Value

bool

LazyCollection lazy(int $chunkSize = 1000)

Запрос ленивым образом, по фрагментам заданного размера.

Parameters

int $chunkSize

Return Value

LazyCollection

Exceptions

InvalidArgumentException

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

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

Parameters

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

Return Value

LazyCollection

Exceptions

InvalidArgumentException

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

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

Parameters

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

Return Value

LazyCollection

Exceptions

InvalidArgumentException

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

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

Parameters

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

Return Value

LazyCollection

Exceptions

InvalidArgumentException

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

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

Parameters

array|string $columns

Return Value

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

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

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

Parameters

array|string $columns

Return Value

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

Exceptions

RecordsNotFoundException
MultipleRecordsFoundException

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

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

Parameters

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

Return Value

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/10.x/Illuminate/Database/Concerns/BuildsQueries.html

Spec-Zone.ru

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