creativecrafts/laravel-paginate-collection

A handy package to paginate laravel collection

1.0.0 2024-03-17 18:21 UTC

Requires

• php: ^8.2
• illuminate/contracts: ^11.0|^10.0
• spatie/laravel-package-tools: ^1.16

Requires (Dev)

• larastan/larastan: ^2.9
• laravel/pint: ^1.14
• nunomaduro/collision: ^8.1|^7.0
• orchestra/testbench: ^9.0|^8.0
• pestphp/pest: ^2.34
• pestphp/pest-plugin-arch: ^2.7
• pestphp/pest-plugin-laravel: ^2.3
• phpstan/extension-installer: ^1.3
• phpstan/phpstan-deprecation-rules: ^1.1
• phpstan/phpstan-phpunit: ^1.3

MIT

• Godspower

• laravel
• laravel-paginate-collection
• creativeCrafts

README

A handy package to paginate a collection.

Installation

You can install the package via composer:

composer require creativecrafts/laravel-paginate-collection

You can publish the config file with:

php artisan vendor:publish --tag="paginate-collection-config"

This is the contents of the published config file:

return [
   /**
     * This is the default number of items that will be displayed per page.
     * default: 10
     */
    'items_per_page' => 10,

    /**
     * This is the default page name that will be used in the query string.
     * default: page
     */
    'page_name' => 'page',
];

Usage

You can use the Facade to paginate a collection
use CreativeCrafts\Paginate\Facades\Paginate 
or use the helper function
use CreativeCrafts\Paginate\Paginate;

$collection = collect([
   ['name' => 'Jack', 'age' => 40],
   ['name' => 'John', 'age' => 30],
   ['name' => 'Jane', 'age' => 25],
]);

$paginatedCollection = Paginate::collection($collection, 1);
// output:
// [
//    "current_page" => 1
//    "data" => [
//       0 => [
//          "name" => "Jack"
//          "age" => 40
//       ]
//    ],
//    "first_page_url" => "http://localhost:8000/?page=1"
//    "from" => 1
//    "last_page" => 3
//    "last_page_url" => "http://localhost:8000/?page=3"
//    "next_page_url" => "http://localhost:8000/?page=2"
//    "path" => "http://localhost:8000"
//    "per_page" => 1
//    "prev_page_url" => null
//    "to" => 1
//    "total" => 3
//    "links" => [
//       0 => [
//          "url" => "null",
//          "label" => "« Previous",
//          "active" => false
//       ],
//       1 => [
//          "url" => "http://localhost:8000/?page=1",
//          "label" => "1",
//          "active" => true
//       ],
//       2 => [
//          "url" => "http://localhost:8000/?page=2",
//          "label" => "2",
//          "active" => false
//       ],
//       3 => [
//          "url" => "http://localhost:8000/?page=3",
//          "label" => "3",
//          "active" => false
//       ],
//       4 => [
//          "url" => "http://localhost:8000/?page=2",
//          "label" => "Next »",
//          "active" => false
//       ]
//    ]
//]
You can get the default items per page from the config file
$paginatedCollection = Paginate::collection($collection, Paginate::defaultItemsPerPage());

You can also get the default page name that will be used in the query string from the config file
$pageName = Paginate::defaultPageName();

Testing

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Godspower
• All Contributors

License

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