Download the PHP package lampager/lampager-laravel without Composer
On this page you can find all versions of the php package lampager/lampager-laravel. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download lampager/lampager-laravel
More information about lampager/lampager-laravel
Files in lampager/lampager-laravel
Informations about the package lampager-laravel
Lampager for Laravel
Rapid pagination without using OFFSET
Requirements
- PHP:
^8.0
- Laravel:
^9.0 || ^10.0 || ^11.0
- lampager/lampager:
^0.4
Installing
Basic Usage
Register service provider.
config/app.php
:
Then you can chain ->lampager()
method from Query Builder, Eloquent Builder and Relation.
It will run the optimized query.
And you'll get
Resource Collection
Lampager supports Laravel's API Resources.
Use helper traits on Resource and ResourceCollection.
Classes
Note: See also lampager/lampager.
Name | Type | Parent Class | Description |
---|---|---|---|
Lampager\Laravel\Paginator |
Class | Lampager\Paginator |
Fluent factory implementation for Laravel |
Lampager\Laravel\Processor |
Class | Lampager\AbstractProcessor |
Processor implementation for Laravel |
Lampager\Laravel\PaginationResult |
Class | Lampager\PaginationResult |
PaginationResult implementation for Laravel |
Lampager\Laravel\MacroServiceProvider |
Class | Illuminate\Support\ServiceProvider |
Enable macros chainable from QueryBuilder, ElqouentBuilder and Relation |
Lampager\Laravel\LampagerResourceTrait |
Trait | Support for Laravel JsonResource | |
Lampager\Laravel\LampagerResourceCollectionTrait |
Trait | Support for Laravel ResourceCollection |
Paginator
, Processor
and PaginationResult
are macroable.
API
Note: See also lampager/lampager.
Paginator::__construct()
Paginator::create()
Create a new paginator instance.
If you use Laravel macros, however, you don't need to directly instantiate.
QueryBuilder
means\Illuminate\Database\Query\Builder
EloquentBuilder
means\Illuminate\Database\Eloquent\Builder
Relation
means\Illuminate\Database\Eloquent\Relation
Paginator::transform()
Transform Lampager Query into Illuminate builder.
Paginator::build()
Perform configure + transform.
Paginator::paginate()
Perform configure + transform + process.
Arguments
(mixed)
$cursor
An associative array that contains$column => $value
or an object that implements\Lampager\Contracts\Cursor
. It must be all-or-nothing.- For initial page, omit this parameter or pass empty array.
- For subsequent pages, pass all parameters. Partial parameters are not allowd.
Return Value
e.g.
(Default format when using \Illuminate\Database\Eloquent\Builder
)
Paginator::useFormatter()
Paginator::restoreFormatter()
Paginator::process()
Invoke Processor methods.
PaginationResult::toArray()
PaginationResult::jsonSerialize()
Convert the object into array.
IMPORTANT: camelCase
properties are converted into snake_case
form.
PaginationResult::__call()
Call macro or Collection methods.
e.g.
All versions of lampager-laravel with dependencies
ext-json Version *
lampager/lampager Version ^0.4
illuminate/contracts Version ^9.0 || ^10.0 || ^11.0
illuminate/support Version ^9.0 || ^10.0 || ^11.0
illuminate/database Version ^9.0 || ^10.0 || ^11.0