lioneagle/lioneagle-paginator

A simple package to allow Laravels Paginator to get the page size and page number from the URL query parameters.

v2.0.0 2022-05-16 04:16 UTC

Requires

• php: ^8.0

Requires (Dev)

• orchestra/testbench: ^6.15
• phpunit/phpunit: ^9.3

MIT

• laravel
• lioneagle
• lioneagle-paginator

README

Installation

You can install the package via composer:

composer require lioneagle/lioneagle-paginator

You can publish and run the migrations with:

You can publish the config file with:

php artisan vendor:publish --provider="Lioneagle\LioneaglePaginator\LioneaglePaginatorServiceProvider" --tag="lioneagle-config"

Usage

class UserController extends Controller
{
    public function index()
    {
        $users = User::paginator();

        return UserResource($users);
    }
}

Now a request formatted as below (when using the default config) will return a paginated response as expected;

/users?page[number]=5&page[size]=50

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

• James Mooring

License

The MIT License (MIT). Please see License File for more information.