BuildsQueries
trait BuildsQueries (View source)
Traits
| Conditionable |
Methods
| $this|mixed | when(mixed $value, callable $callback, callable|null $default = null)
Apply the callback if the given "value" is truthy. | from Conditionable |
| $this|mixed | unless(mixed $value, callable $callback, callable|null $default = null)
Apply the callback if the given "value" is falsy. | from Conditionable |
| bool | chunk(int $count, callable $callback)
Chunk the results of the query. | |
| Collection | chunkMap(callable $callback, int $count = 1000)
Run a map over each item while chunking. | |
| bool | each(callable $callback, int $count = 1000)
Execute a callback over each item while chunking. | |
| bool | chunkById(int $count, callable $callback, string|null $column = null, string|null $alias = null)
Chunk the results of a query by comparing IDs. | |
| bool | eachById(callable $callback, int $count = 1000, string|null $column = null, string|null $alias = null)
Execute a callback over each item while chunking by ID. | |
| LazyCollection | lazy(int $chunkSize = 1000)
Query lazily, by chunks of the given size. | |
| LazyCollection | lazyById(int $chunkSize = 1000, string|null $column = null, string|null $alias = null)
Query lazily, by chunking the results of a query by comparing IDs. | |
| LazyCollection | lazyByIdDesc(int $chunkSize = 1000, string|null $column = null, string|null $alias = null)
Query lazily, by chunking the results of a query by comparing IDs in descending order. | |
| LazyCollection | orderedLazyById(int $chunkSize = 1000, string|null $column = null, string|null $alias = null, bool $descending = false)
Query lazily, by chunking the results of a query by comparing IDs in a given order. | |
| Model|object|BuildsQueries|null | first(array|string $columns = ['*'])
Execute the query and get the first result. | |
| Model|object|BuildsQueries|null | sole(array|string $columns = ['*'])
Execute the query and get the first result if it's the sole matching record. | |
| CursorPaginator | paginateUsingCursor(int $perPage, array $columns = ['*'], string $cursorName = 'cursor', Cursor|string|null $cursor = null)
Paginate the given query using a cursor paginator. | |
| string | getOriginalColumnNameForCursorPagination(Builder|Builder $builder, string $parameter)
Get the original column name of the given column, without any aliasing. | |
| LengthAwarePaginator | paginator(Collection $items, int $total, int $perPage, int $currentPage, array $options)
Create a new length-aware paginator instance. | |
| Paginator | simplePaginator(Collection $items, int $perPage, int $currentPage, array $options)
Create a new simple paginator instance. | |
| CursorPaginator | cursorPaginator(Collection $items, int $perPage, Cursor $cursor, array $options)
Create a new cursor paginator instance. | |
| $this|mixed | tap(callable $callback)
Pass the query to a given callback. |
Details
$this|mixed when(mixed $value, callable $callback, callable|null $default = null)
Apply the callback if the given "value" is truthy.
$this|mixed unless(mixed $value, callable $callback, callable|null $default = null)
Apply the callback if the given "value" is falsy.
bool chunk(int $count, callable $callback)
Chunk the results of the query.
Collection chunkMap(callable $callback, int $count = 1000)
Run a map over each item while chunking.
bool each(callable $callback, int $count = 1000)
Execute a callback over each item while chunking.
bool chunkById(int $count, callable $callback, string|null $column = null, string|null $alias = null)
Chunk the results of a query by comparing IDs.
bool eachById(callable $callback, int $count = 1000, string|null $column = null, string|null $alias = null)
Execute a callback over each item while chunking by ID.
LazyCollection lazy(int $chunkSize = 1000)
Query lazily, by chunks of the given size.
LazyCollection lazyById(int $chunkSize = 1000, string|null $column = null, string|null $alias = null)
Query lazily, by chunking the results of a query by comparing IDs.
LazyCollection lazyByIdDesc(int $chunkSize = 1000, string|null $column = null, string|null $alias = null)
Query lazily, by chunking the results of a query by comparing IDs in descending order.
protected LazyCollection orderedLazyById(int $chunkSize = 1000, string|null $column = null, string|null $alias = null, bool $descending = false)
Query lazily, by chunking the results of a query by comparing IDs in a given order.
Model|object|BuildsQueries|null first(array|string $columns = ['*'])
Execute the query and get the first result.
Model|object|BuildsQueries|null sole(array|string $columns = ['*'])
Execute the query and get the first result if it's the sole matching record.
protected CursorPaginator paginateUsingCursor(int $perPage, array $columns = ['*'], string $cursorName = 'cursor', Cursor|string|null $cursor = null)
Paginate the given query using a cursor paginator.
protected string getOriginalColumnNameForCursorPagination(Builder|Builder $builder, string $parameter)
Get the original column name of the given column, without any aliasing.
protected LengthAwarePaginator paginator(Collection $items, int $total, int $perPage, int $currentPage, array $options)
Create a new length-aware paginator instance.
protected Paginator simplePaginator(Collection $items, int $perPage, int $currentPage, array $options)
Create a new simple paginator instance.
protected CursorPaginator cursorPaginator(Collection $items, int $perPage, Cursor $cursor, array $options)
Create a new cursor paginator instance.
$this|mixed tap(callable $callback)
Pass the query to a given callback.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Database/Concerns/BuildsQueries.html
