{"id":15714874,"url":"https://github.com/iranianpep/paginator","last_synced_at":"2025-05-12T23:51:27.040Z","repository":{"id":57035093,"uuid":"149567054","full_name":"iranianpep/paginator","owner":"iranianpep","description":"A powerful PHP pagination engine to take care of pagination hassles","archived":false,"fork":false,"pushed_at":"2020-02-09T21:47:32.000Z","size":62,"stargazers_count":3,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-01T04:51:12.396Z","etag":null,"topics":["page","paginable","pagination","pagination-generator","pagination-library","paginator","paging"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/iranianpep.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-09-20T07:09:36.000Z","updated_at":"2023-06-19T22:41:48.000Z","dependencies_parsed_at":"2022-08-24T06:40:11.828Z","dependency_job_id":null,"html_url":"https://github.com/iranianpep/paginator","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iranianpep%2Fpaginator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iranianpep%2Fpaginator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iranianpep%2Fpaginator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iranianpep%2Fpaginator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iranianpep","download_url":"https://codeload.github.com/iranianpep/paginator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253843167,"owners_count":21972868,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["page","paginable","pagination","pagination-generator","pagination-library","paginator","paging"],"created_at":"2024-10-03T21:39:50.656Z","updated_at":"2025-05-12T23:51:27.019Z","avatar_url":"https://github.com/iranianpep.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Paginator\nA powerful PHP pagination engine to take care of pagination hassles\n\n[![Build Status](https://travis-ci.org/iranianpep/paginator.svg?branch=master)](https://travis-ci.org/iranianpep/paginator)\n[![Maintainability](https://api.codeclimate.com/v1/badges/9f8b2dd15bf3a8f48103/maintainability)](https://codeclimate.com/github/iranianpep/paginator/maintainability)\n[![Test Coverage](https://api.codeclimate.com/v1/badges/9f8b2dd15bf3a8f48103/test_coverage)](https://codeclimate.com/github/iranianpep/paginator/test_coverage)\n[![StyleCI](https://styleci.io/repos/149567054/shield?branch=master)](https://styleci.io/repos/149567054)\n[![Issue Count](https://codeclimate.com/github/iranianpep/paginator/badges/issue_count.svg)](https://codeclimate.com/github/iranianpep/paginator)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/1438614849564c76ac97e4eefccee63d)](https://www.codacy.com/app/iranianpep/paginator?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=iranianpep/paginator\u0026amp;utm_campaign=Badge_Grade)\n\n## Server Requirements\n- PHP \u003e= 7.1\n\n## Installation\n- Using Composer get the latest version:\n```\ncomposer require paginator/paginator\n```\n\n## Example\nThe simplest way to use Paginator is as follow:\n```\n$totalItems = 3;\n$perPage = 1;\n$currentPage = 1;\n$url = 'https://example.com';\n\n$paginator = new Paginator($totalItems, $perPage, $currentPage, $url);\n\nif ($paginator-\u003ehasPages() === true) {\n    if ($paginator-\u003egetPreviousPage()) {\n        $previousPageUrl = $paginator-\u003egetPreviousPageUrl();\n\n        echo \"\u003cli\u003e\u003ca href='{$previousPageUrl}'\u003ePrevious\u003c/a\u003e\u003c/li\u003e\";\n    }\n\n    foreach ($paginator-\u003egetPages() as $page) {\n        if (!$page instanceof Page) {\n            continue;\n        }\n\n        $pageNumber = $page-\u003egetNumber();\n        $pageUrl = $page-\u003egetUrl();\n        $cssClass = $page-\u003eisCurrent() === true ? 'active' : '';\n\n        echo \"\u003cli class='{$cssClass}'\u003e\u003ca href='{$pageUrl}'\u003e{$pageNumber}\u003c/a\u003e\u003c/li\u003e\";\n    }\n\n    if ($paginator-\u003egetNextPage()) {\n        $nextPageUrl = $paginator-\u003egetNextPageUrl();\n\n        echo \"\u003cli\u003e\u003ca href='{$nextPageUrl}'\u003eNext\u003c/a\u003e\u003c/li\u003e\";\n    }\n}\n```\n\nIf you are using any MVC framework like Laravel instantiate an object from Paginator class in the controller and pass it to the view:\n\n#### Controller\n```\npublic function index(Request $request)\n{\n    $totalProductsNumber = 10;\n    $perPage = 10;\n    $currentPageNumber = (int) $request-\u003eget('page') \u003e 0 ? $request-\u003eget('page') : 1;\n    $url = $request-\u003efullUrl();\n    \n    $paginator = new Paginator($totalProductsNumber, $perPage, $currentPageNumber, $url);\n\n    // you should use the offset in your database query to get a slice of data\n    $offset = $paginator-\u003ecalculateDatabaseOffset($currentPageNumber);\n\n    return view('view.index', [\n        'paginator' =\u003e $paginator\n    ]);\n}\n```\n\n#### View (Laravel Blade)\n```\n@if ($paginator-\u003ehasPages())\n    \u003cul class=\"pagination\"\u003e\n        @if ($paginator-\u003eisOnFirstPage() === true)\n            \u003cli class=\"page-item disabled\"\u003e\u003cspan class=\"page-link\"\u003e\u0026laquo;\u003c/span\u003e\u003c/li\u003e\n        @else\n            \u003cli class=\"page-item\"\u003e\u003ca class=\"page-link\" href=\"{{ $paginator-\u003egetPreviousPageUrl() }}\" rel=\"prev\" title=\"Previous\"\u003e\u0026laquo;\u003c/a\u003e\u003c/li\u003e\n        @endif\n\n        @php\n            $hiddenRanges = $paginator-\u003egetHiddenRanges();\n        @endphp\n\n        @foreach ($paginator-\u003egetPages() as $page)\n            {{-- \"Three Dots\" Separator --}}\n            @if ((isset($hiddenRanges[0]) \u0026\u0026 $page-\u003egetNumber() === $hiddenRanges[0]['start']) ||\n            (isset($hiddenRanges[1]) \u0026\u0026 $page-\u003egetNumber() === $hiddenRanges[1]['start']))\n                \u003cli class=\"page-item disabled\"\u003e\u003cspan class=\"page-link\"\u003e...\u003c/span\u003e\u003c/li\u003e\n            @elseif((isset($hiddenRanges[0]) \u0026\u0026 $page-\u003egetNumber() \u003e $hiddenRanges[0]['start'] \u0026\u0026 $page-\u003egetNumber() \u003c= $hiddenRanges[0]['finish']) ||\n            (isset($hiddenRanges[1]) \u0026\u0026 $page-\u003egetNumber() \u003e $hiddenRanges[1]['start'] \u0026\u0026 $page-\u003egetNumber() \u003c= $hiddenRanges[1]['finish']))\n                @continue\n            @else\n                @if ($page-\u003eisCurrent())\n                    \u003cli class=\"page-item active\"\u003e\u003cspan class=\"page-link\"\u003e{{ $page-\u003egetNumber() }}\u003c/span\u003e\u003c/li\u003e\n                @else\n                    \u003cli class=\"page-item\"\u003e\u003ca class=\"page-link\" href=\"{{ $page-\u003egetUrl() }}\" title=\"Page\"\u003e{{ $page-\u003egetNumber() }}\u003c/a\u003e\u003c/li\u003e\n                @endif\n            @endif\n        @endforeach\n\n        @if ($paginator-\u003eisOnLastPage() === false)\n            \u003cli class=\"page-item\"\u003e\u003ca class=\"page-link\" href=\"{{ $paginator-\u003egetNextPageUrl() }}\" rel=\"next\" title=\"Next\"\u003e\u0026raquo;\u003c/a\u003e\u003c/li\u003e\n        @else\n            \u003cli class=\"page-item disabled\"\u003e\u003cspan class=\"page-link\"\u003e\u0026raquo;\u003c/span\u003e\u003c/li\u003e\n        @endif\n    \u003c/ul\u003e\n@endif\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Firanianpep%2Fpaginator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Firanianpep%2Fpaginator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Firanianpep%2Fpaginator/lists"}