Download the PHP package michaloravec/laravel-paginateroute without Composer
On this page you can find all versions of the php package michaloravec/laravel-paginateroute. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download michaloravec/laravel-paginateroute
More information about michaloravec/laravel-paginateroute
Files in michaloravec/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/michaloravec/laravel-paginateroute
Informations about the package laravel-paginateroute
Laravel Paginate Route
This package is inspired by the original 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. (normal) /news/page/2
, /novinky/stranka/2
or (dash) /news/page-2
, /novinky/stranka-2
. It is also possible to remove the word "page" from the URL ex. (simple) /news/2
Installation
Via Composer
The package will automatically register itself.
You can publish the config-file with:
This is the contents of the published config file:
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.
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
- Michal Oravec
- All Contributors
License
The MIT License (MIT). Please see License File for more information.