Download the PHP package spatie/laravel-paginateroute without Composer
On this page you can find all versions of the php package spatie/laravel-paginateroute. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download spatie/laravel-paginateroute
More information about spatie/laravel-paginateroute
Files in spatie/laravel-paginateroute
Package laravel-paginateroute
Short Description Laravel outer extension to easily use laravel's paginator without the query string
License MIT
Homepage https://github.com/spatie/laravel-paginateroute
Informations about the package laravel-paginateroute
🚨 THIS PACKAGE HAS BEEN ABANDONED 🚨
We don't use this package anymore in our own projects and cannot justify the time needed to maintain it anymore. That's why we have chosen to abandon it. Feel free to fork our code and maintain your own copy.
Laravel Paginate Route
This package adds the paginate
route method to support pagination via custom routes instead of query strings. This also allows for easily translatable pagination routes ex. /news/page/2
, /nieuws/pagina/2
.
Spatie is a webdesign agency in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
Note: If you're upgrading to 2.0, check out the upgrade guide below.
Postcardware
You're free to use this package (it's MIT-licensed), but if it makes it to your production environment you are required to send us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.
The best postcards will get published on the open source page on our website.
Install
Via Composer
First register the service provider and facade in your application.
Then register the macros in App\Providers\RouteServiceProvider::boot()
.
Usage
The paginate
route macro will register two routes for you.
In your route's action you can just use Laravel's regular pagination methods.
If you want to customize or add translations for the "page" url segment, you can publish the language files.
Generating Url's
Since Laravel's paginator url's will still use a query string, PaginateRoute has it's own url generator and page helper functions.
The nextPage
functions require the paginator instance as a parameter, so they can determine whether there are any more records.
If $full
is true, the first page will be a fully qualified url. Ex. /users/page/1
instead if just /users
(this is the default).
To retrieve the url of a specific page of a paginated route, that isn't the current route, there's the addPageQuery
function.
You can also retrieve an array with all available urls. These can be rendered as a plain html list with page numbers. Note that these functions require a LengthAwarePaginator
.
You can render link tags to mark previous and next page for SEO. Note that these functions require a LengthAwarePaginator
.
Tests
The package contains some integration/smoke tests, set up with Orchestra. The tests can be run via phpunit.
Upgrading
1.x => 2.0
The 2.0 release changes the route macro to only register one route with the entire query in it, so providing a page parameter to the action link is no longer possible.
For example, action('FooController@bar', ['page' => 3])
is no longer possible, and should be replaced by PaginateRoute::addPageQuery(action('FooController@bar'), 3)
.
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Sebastian De Deyne
- All Contributors
About Spatie
Spatie is a webdesign agency in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
License
The MIT License (MIT). Please see License File for more information.