Skip to content

Latest commit

 

History

History
123 lines (86 loc) · 3.09 KB

README.md

File metadata and controls

123 lines (86 loc) · 3.09 KB
Raw

Raw SQL Paginator - Laravel

SQL raw query paginator for Laravel

This class let you add pagination for raw SQL queries.

Requirements

  • Laravel 6+

Usage

Controller
public function index(Request $request, int $page)
    {
        $itemsPerPage = 10;
        $rawSqlQuery = 'SELECT * FROM articles WHERE author_id = :authorId';
        $params = ['authorId' => 1]; 
        $paginator = new Paginator($request);
        $paginator->setQuery($rawSqlQuery, $params)
                  ->setPageOptions($itemsPerPage, $page)
                  ->executeQuery();

        return view('post.index',compact('paginator'));
    }

Method setPageOptions is optional. Paginator try to get page number from query if it last value. $itemsPerPage is set default to 10. You can only set items per page value.

!Do not use LIMIT or OFFSET in highest "SELECT" level in query!

Blade file

Display pages list

{!! $paginator->renderPagesList() !!}

Display records from DB

@foreach($paginator->records as $post)
    <p>{{$post}}</p>
@endforeach

OPTIONS & WARNINGS

Display pages list

Output hmtl pages list is optimized for Bootstrap 4.* but of course you can modify output look by adding own style in css file.

You don't want to use renderPagesList() method? No problem. PrettyPagination provide necessary set of methods and properties, to create own pages list in `blade fi

Public methods

itemsPerPage() - How many items per page is displayed

totalPages() - Number of available pages

totalItems() - Quantity of all items / records from DB

nextPage() - Next available page

currentPage() - Current Page

isFirstOrLastPage(bool) - Check if current page is first or last. Pass as argument true to check if first page or false to check if last page.

Links generator

Raw SQL Paginator automatically try to get requested page number and generate page links base on current url: First class try to find GET "page" parameter

domain.com\path?page=5

If fail then try to find "page" keyword in url and get next number as a page

domain.com\path\2\page\14

If both fail then try to find any numeric value in url and set it as requested page

domain.com\path\2\path\path

!Must be only one numeric value in url if not then exception will throw!

If script some reason is not able to find page number then you can manually set the page number in method setPageOptions

Then use method setUri($url) to set url with placeholder that will be use to create links in pages buttons

$paginator->setUri('/posts/%/page');

Use "Percent sign - %" as a placeholder for page number.

Title value

All pages list links has default title value as follow:

$titles = [
       'first' => 'First',
       'previous' => 'Previous',
       'next' => 'Next',
       'last' => 'Last',
       'page' => 'Page',
       'current' => 'Current page'
        ];

If you would like to change some of them or all use setTitles method.

    $paginator->setTitle(
        [
            $key => $value
        ])