Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spatie/laravel-paginateroute
Laravel router extension to easily use Laravel's paginator without the query string
https://github.com/spatie/laravel-paginateroute
laravel pagination php seo
Last synced: 3 months ago
JSON representation
Laravel router extension to easily use Laravel's paginator without the query string
- Host: GitHub
- URL: https://github.com/spatie/laravel-paginateroute
- Owner: spatie
- License: mit
- Archived: true
- Created: 2015-06-03T08:50:07.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-10-24T11:29:05.000Z (about 6 years ago)
- Last Synced: 2024-10-11T09:22:15.830Z (3 months ago)
- Topics: laravel, pagination, php, seo
- Language: PHP
- Homepage: https://murze.be/2015/06/a-laravel-package-to-easily-add-paginated-routes/
- Size: 122 KB
- Stars: 307
- Watchers: 18
- Forks: 60
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-laravel-framework - Laravel Paginateroute - Laravel router extension to easily use Laravel's paginator without the query string (Popular Packages)
README
🚨 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
[](https://packagist.org/packages/spatie/laravel-paginateroute)
[](LICENSE.md)
[](https://travis-ci.org/spatie/laravel-paginateroute)
[](https://scrutinizer-ci.com/g/spatie/laravel-paginateroute)
[](https://styleci.io/repos/36791555)
[](https://packagist.org/packages/spatie/laravel-paginateroute)
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](https://spatie.be/opensource).
**Note:** If you're upgrading to 2.0, check out the [upgrade guide](#upgrading) below.
## Postcardware
You're free to use this package (it's [MIT-licensed](LICENSE.md)), 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
``` bash
$ composer require spatie/laravel-paginateroute
```
First register the service provider and facade in your application.
```php
// config/app.php
'providers' => [
...
'Spatie\PaginateRoute\PaginateRouteServiceProvider',
];
'aliases' => [
...
'PaginateRoute' => 'Spatie\PaginateRoute\PaginateRouteFacade',
];
```
Then register the macros in `App\Providers\RouteServiceProvider::boot()`.
```php
// app/Providers/RouteServiceProvider.php
use PaginateRoute;
// ...
public function boot()
{
PaginateRoute::registerMacros();
parent::boot();
}
```
## Usage
The `paginate` route macro will register two routes for you.
```php
// app/Http/routes.php
// Generates /users & /users/page/{page}
Route::paginate('users', 'UsersController@index');
```
In your route's action you can just use Laravel's regular pagination methods.
```php
// app/Http/Controllers/UsersController.php
public function index()
{
return view('users.index', ['users' => \App\User::simplePaginate(5)]);
}
```
If you want to customize or add translations for the "page" url segment, you can publish the language files.
``` bash
$ php artisan vendor:publish --provider="Spatie\PaginateRoute\PaginateRouteServiceProvider"
```
### 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.
```
{{-- $users is an instance of \Illuminate\Contracts\Pagination\Paginator --}}
@if(PaginateRoute::hasPreviousPage())
Previous
@endif
@if(PaginateRoute::hasNextPage($users))
Next
@endif
```
The `nextPage` functions require the paginator instance as a parameter, so they can determine whether there are any more records.
```php
/**
* @param \Illuminate\Contracts\Pagination\Paginator $paginator
* @return int|null
*/
public function nextPage(Paginator $paginator)
```
```php
/**
* @param \Illuminate\Contracts\Pagination\Paginator $paginator
* @return bool
*/
public function hasNextPage(Paginator $paginator)
```
```php
/**
* @param \Illuminate\Contracts\Pagination\Paginator $paginator
* @return string|null
*/
public function nextPageUrl(Paginator $paginator)
```
```php
/**
* @return int|null
*/
public function previousPage()
```
```php
/**
* @return bool
*/
public function hasPreviousPage()
```
```php
/**
* @param bool $full
* @return string|null
*/
public function previousPageUrl($full = false)
```
```php
/**
* @param int $page
* @param bool $full
* @return string
*/
public function pageUrl($page, $full = false)
```
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.
```php
/**
* @param string $url
* @param int $page
* @param bool $full
* @return string
*/
public function addPageQuery($url, $page, $full = false)
```
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`.
```php
/**
* @param \Illuminate\Contracts\Pagination\LengthAwarePaginator $paginator
* @param bool $full
* @return array
*/
public function allUrls(LengthAwarePaginator $paginator, $full = false)
```
```php
/**
* @param \Illuminate\Contracts\Pagination\LengthAwarePaginator $paginator
* @param bool $full
* @param string $class
* @param bool $additionalLinks
* @return string
*/
public function renderPageList(LengthAwarePaginator $paginator, $full = false, $class = null, $additionalLinks = false)
```
```html
```
You can render link tags to mark previous and next page for SEO. Note that these functions require a `LengthAwarePaginator`.
```php
/**
* @param \Illuminate\Contracts\Pagination\LengthAwarePaginator $paginator
* @param bool $full
* @return string
*/
public function renderRelLinks(LengthAwarePaginator $paginator, $full = false)
```
```html
```
## Tests
The package contains some integration/smoke tests, set up with Orchestra. The tests can be run via phpunit.
```
$ 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](CHANGELOG.md) for more information what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Credits
- [Sebastian De Deyne](https://github.com/sebastiandedeyne)
- [All Contributors](../../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](https://spatie.be/opensource).
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.