README

Laravel paginator for routes or route based pagination for Laravel :)

This package solves the problem with native Laravel paginator, which generates urls with query string parameters for the page.

https://example.com/category?page=4

This package allows you to create pretty urls with page parameter according route pattern.

https://example.com/category/4
# with fallback to
https://example.com/category?page=4

Installation

composer install camohub/paginator

Examples

Lets imagine a controller for articles with route

Route::get('/{categorySlug}/{page?}', 'ArticleController@index')->name('articles');

The index action displays all articles in required category.

public function index(Request $request, $categorySlug, $page = 1)
{
    $category = Category::where('slug', $categorySlug)->first()
    
    if( ! $category ) abort(404);
    
    $paginator = new Paginator($request, $category->articles(), 'articles', ['categorySlug' => $categorySlug]);

    $view = [
        'articles' => $paginator->getItems(),
        'paginator' => $paginator,
        'category' => $category,
    ];

    return view('articles.index', $view);
}

Paginator __construct() method expects second parameter to be query builder which can call skip() and take() methods to paginate the collection.

Internal implementation looks like

$this->items = $this->model->skip($this->skip)->take($this->perPage)->get();

and the view will look like

@foreach( $articles as $a ) 
... 
@endforeach 

{{$paginator->render()}}

Options

Paginator requires 3 non optional parameters.

1. Request object
2. Query builder / model
3. Route name

In addition there are few optional parameters which can be used to configure the paginator.

1. Route parameters - route paremeters without page parameter. Page param will be merged in template. Default is [].
2. pageParam - the name of the route parameter which represents the page. Default is "page". Packege will look for $request->route()->parameter($pageParam) or $request->query($pageParam)
3. perPage - items per page. Default is 15.
4. sideItemsCount - the number of items around the current page in paginator. It is ekvivalent of Laravel native ->onEachSide() paginator method. Default is 3.

You can override the whole paginator with simple MyPaginator extends Paginator and also publish the template files and rewrites it. Current template is based on Bootstrap 4.

##Simple paginator There is also SimplePaginator class to create simple prev next navigation.

$paginator = new Paginator($request, $category->articles(), 'articles', ['categorySlug' => $categorySlug]);