Initial
This commit is contained in:
Markus
27
system/Pager/Exceptions/PagerException.php
Normal file
27
system/Pager/Exceptions/PagerException.php
Normal file
@@ -0,0 +1,27 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* This file is part of CodeIgniter 4 framework.
|
||||
*
|
||||
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
||||
*
|
||||
* For the full copyright and license information, please view
|
||||
* the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace CodeIgniter\Pager\Exceptions;
|
||||
|
||||
use CodeIgniter\Exceptions\FrameworkException;
|
||||
|
||||
class PagerException extends FrameworkException
|
||||
{
|
||||
public static function forInvalidTemplate(?string $template = null)
|
||||
{
|
||||
return new static(lang('Pager.invalidTemplate', [$template]));
|
||||
}
|
||||
|
||||
public static function forInvalidPaginationGroup(?string $group = null)
|
||||
{
|
||||
return new static(lang('Pager.invalidPaginationGroup', [$group]));
|
||||
}
|
||||
}
|
||||
420
system/Pager/Pager.php
Normal file
420
system/Pager/Pager.php
Normal file
@@ -0,0 +1,420 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* This file is part of CodeIgniter 4 framework.
|
||||
*
|
||||
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
||||
*
|
||||
* For the full copyright and license information, please view
|
||||
* the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace CodeIgniter\Pager;
|
||||
|
||||
use CodeIgniter\HTTP\Exceptions\HTTPException;
|
||||
use CodeIgniter\HTTP\URI;
|
||||
use CodeIgniter\Pager\Exceptions\PagerException;
|
||||
use CodeIgniter\View\RendererInterface;
|
||||
use Config\Pager as PagerConfig;
|
||||
|
||||
/**
|
||||
* Class Pager
|
||||
*
|
||||
* The Pager class provides semi-automatic and manual methods for creating
|
||||
* pagination links and reading the current url's query variable, "page"
|
||||
* to determine the current page. This class can support multiple
|
||||
* paginations on a single page.
|
||||
*/
|
||||
class Pager implements PagerInterface
|
||||
{
|
||||
/**
|
||||
* The group data.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $groups = [];
|
||||
|
||||
/**
|
||||
* URI segment for groups if provided.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $segment = [];
|
||||
|
||||
/**
|
||||
* Our configuration instance.
|
||||
*
|
||||
* @var PagerConfig
|
||||
*/
|
||||
protected $config;
|
||||
|
||||
/**
|
||||
* The view engine to render the links with.
|
||||
*
|
||||
* @var RendererInterface
|
||||
*/
|
||||
protected $view;
|
||||
|
||||
/**
|
||||
* List of only permitted queries
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $only = [];
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*/
|
||||
public function __construct(PagerConfig $config, RendererInterface $view)
|
||||
{
|
||||
$this->config = $config;
|
||||
$this->view = $view;
|
||||
}
|
||||
|
||||
/**
|
||||
* Handles creating and displaying the
|
||||
*
|
||||
* @param string $template The output template alias to render.
|
||||
*/
|
||||
public function links(string $group = 'default', string $template = 'default_full'): string
|
||||
{
|
||||
$this->ensureGroup($group);
|
||||
|
||||
return $this->displayLinks($group, $template);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates simple Next/Previous links, instead of full pagination.
|
||||
*/
|
||||
public function simpleLinks(string $group = 'default', string $template = 'default_simple'): string
|
||||
{
|
||||
$this->ensureGroup($group);
|
||||
|
||||
return $this->displayLinks($group, $template);
|
||||
}
|
||||
|
||||
/**
|
||||
* Allows for a simple, manual, form of pagination where all of the data
|
||||
* is provided by the user. The URL is the current URI.
|
||||
*
|
||||
* @param string $template The output template alias to render.
|
||||
* @param int $segment (whether page number is provided by URI segment)
|
||||
* @param string|null $group optional group (i.e. if we'd like to define custom path)
|
||||
*/
|
||||
public function makeLinks(int $page, ?int $perPage, int $total, string $template = 'default_full', int $segment = 0, ?string $group = 'default'): string
|
||||
{
|
||||
$group = $group === '' ? 'default' : $group;
|
||||
|
||||
$this->store($group, $page, $perPage ?? $this->config->perPage, $total, $segment);
|
||||
|
||||
return $this->displayLinks($group, $template);
|
||||
}
|
||||
|
||||
/**
|
||||
* Does the actual work of displaying the view file. Used internally
|
||||
* by links(), simpleLinks(), and makeLinks().
|
||||
*/
|
||||
protected function displayLinks(string $group, string $template): string
|
||||
{
|
||||
if (! array_key_exists($template, $this->config->templates)) {
|
||||
throw PagerException::forInvalidTemplate($template);
|
||||
}
|
||||
|
||||
$pager = new PagerRenderer($this->getDetails($group));
|
||||
|
||||
return $this->view->setVar('pager', $pager)->render($this->config->templates[$template]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Stores a set of pagination data for later display. Most commonly used
|
||||
* by the model to automate the process.
|
||||
*
|
||||
* @return $this
|
||||
*/
|
||||
public function store(string $group, int $page, ?int $perPage, int $total, int $segment = 0)
|
||||
{
|
||||
if ($segment) {
|
||||
$this->setSegment($segment, $group);
|
||||
}
|
||||
|
||||
$this->ensureGroup($group, $perPage);
|
||||
|
||||
if ($segment > 0 && $this->groups[$group]['currentPage'] > 0) {
|
||||
$page = $this->groups[$group]['currentPage'];
|
||||
}
|
||||
|
||||
$perPage = $perPage ?? $this->config->perPage;
|
||||
$pageCount = (int) ceil($total / $perPage);
|
||||
|
||||
$this->groups[$group]['currentPage'] = $page > $pageCount ? $pageCount : $page;
|
||||
$this->groups[$group]['perPage'] = $perPage;
|
||||
$this->groups[$group]['total'] = $total;
|
||||
$this->groups[$group]['pageCount'] = $pageCount;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets segment for a group.
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
public function setSegment(int $number, string $group = 'default')
|
||||
{
|
||||
$this->segment[$group] = $number;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the path that an aliased group of links will use.
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
public function setPath(string $path, string $group = 'default')
|
||||
{
|
||||
$this->ensureGroup($group);
|
||||
|
||||
$this->groups[$group]['uri']->setPath($path);
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the total number of items in data store.
|
||||
*/
|
||||
public function getTotal(string $group = 'default'): int
|
||||
{
|
||||
$this->ensureGroup($group);
|
||||
|
||||
return $this->groups[$group]['total'];
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the total number of pages.
|
||||
*/
|
||||
public function getPageCount(string $group = 'default'): int
|
||||
{
|
||||
$this->ensureGroup($group);
|
||||
|
||||
return $this->groups[$group]['pageCount'];
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the number of the current page of results.
|
||||
*/
|
||||
public function getCurrentPage(string $group = 'default'): int
|
||||
{
|
||||
$this->ensureGroup($group);
|
||||
|
||||
return $this->groups[$group]['currentPage'] ?: 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Tells whether this group of results has any more pages of results.
|
||||
*/
|
||||
public function hasMore(string $group = 'default'): bool
|
||||
{
|
||||
$this->ensureGroup($group);
|
||||
|
||||
return ($this->groups[$group]['currentPage'] * $this->groups[$group]['perPage']) < $this->groups[$group]['total'];
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the last page, if we have a total that we can calculate with.
|
||||
*
|
||||
* @return int|null
|
||||
*/
|
||||
public function getLastPage(string $group = 'default')
|
||||
{
|
||||
$this->ensureGroup($group);
|
||||
|
||||
if (! is_numeric($this->groups[$group]['total']) || ! is_numeric($this->groups[$group]['perPage'])) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return (int) ceil($this->groups[$group]['total'] / $this->groups[$group]['perPage']);
|
||||
}
|
||||
|
||||
/**
|
||||
* Determines the first page # that should be shown.
|
||||
*/
|
||||
public function getFirstPage(string $group = 'default'): int
|
||||
{
|
||||
$this->ensureGroup($group);
|
||||
|
||||
// @todo determine based on a 'surroundCount' value
|
||||
return 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the URI for a specific page for the specified group.
|
||||
*
|
||||
* @return string|URI
|
||||
*/
|
||||
public function getPageURI(?int $page = null, string $group = 'default', bool $returnObject = false)
|
||||
{
|
||||
$this->ensureGroup($group);
|
||||
|
||||
/**
|
||||
* @var URI $uri
|
||||
*/
|
||||
$uri = $this->groups[$group]['uri'];
|
||||
|
||||
$segment = $this->segment[$group] ?? 0;
|
||||
|
||||
if ($segment) {
|
||||
$uri->setSegment($segment, $page);
|
||||
} else {
|
||||
$uri->addQuery($this->groups[$group]['pageSelector'], $page);
|
||||
}
|
||||
|
||||
if ($this->only) {
|
||||
$query = array_intersect_key($_GET, array_flip($this->only));
|
||||
|
||||
if (! $segment) {
|
||||
$query[$this->groups[$group]['pageSelector']] = $page;
|
||||
}
|
||||
|
||||
$uri->setQueryArray($query);
|
||||
}
|
||||
|
||||
return $returnObject === true ? $uri : URI::createURIString($uri->getScheme(), $uri->getAuthority(), $uri->getPath(), $uri->getQuery(), $uri->getFragment());
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the full URI to the next page of results, or null.
|
||||
*
|
||||
* @return string|null
|
||||
*/
|
||||
public function getNextPageURI(string $group = 'default', bool $returnObject = false)
|
||||
{
|
||||
$this->ensureGroup($group);
|
||||
|
||||
$last = $this->getLastPage($group);
|
||||
$curr = $this->getCurrentPage($group);
|
||||
$page = null;
|
||||
|
||||
if (! empty($last) && ! empty($curr) && $last === $curr) {
|
||||
return null;
|
||||
}
|
||||
|
||||
if ($last > $curr) {
|
||||
$page = $curr + 1;
|
||||
}
|
||||
|
||||
return $this->getPageURI($page, $group, $returnObject);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the full URL to the previous page of results, or null.
|
||||
*
|
||||
* @return string|null
|
||||
*/
|
||||
public function getPreviousPageURI(string $group = 'default', bool $returnObject = false)
|
||||
{
|
||||
$this->ensureGroup($group);
|
||||
|
||||
$first = $this->getFirstPage($group);
|
||||
$curr = $this->getCurrentPage($group);
|
||||
$page = null;
|
||||
|
||||
if (! empty($first) && ! empty($curr) && $first === $curr) {
|
||||
return null;
|
||||
}
|
||||
|
||||
if ($first < $curr) {
|
||||
$page = $curr - 1;
|
||||
}
|
||||
|
||||
return $this->getPageURI($page, $group, $returnObject);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the number of results per page that should be shown.
|
||||
*/
|
||||
public function getPerPage(string $group = 'default'): int
|
||||
{
|
||||
$this->ensureGroup($group);
|
||||
|
||||
return (int) $this->groups[$group]['perPage'];
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an array with details about the results, including
|
||||
* total, per_page, current_page, last_page, next_url, prev_url, from, to.
|
||||
* Does not include the actual data. This data is suitable for adding
|
||||
* a 'data' object to with the result set and converting to JSON.
|
||||
*/
|
||||
public function getDetails(string $group = 'default'): array
|
||||
{
|
||||
if (! array_key_exists($group, $this->groups)) {
|
||||
throw PagerException::forInvalidPaginationGroup($group);
|
||||
}
|
||||
|
||||
$newGroup = $this->groups[$group];
|
||||
|
||||
$newGroup['next'] = $this->getNextPageURI($group);
|
||||
$newGroup['previous'] = $this->getPreviousPageURI($group);
|
||||
$newGroup['segment'] = $this->segment[$group] ?? 0;
|
||||
|
||||
return $newGroup;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets only allowed queries on pagination links.
|
||||
*/
|
||||
public function only(array $queries): self
|
||||
{
|
||||
$this->only = $queries;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Ensures that an array exists for the group specified.
|
||||
*
|
||||
* @param int $perPage
|
||||
*/
|
||||
protected function ensureGroup(string $group, ?int $perPage = null)
|
||||
{
|
||||
if (array_key_exists($group, $this->groups)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$this->groups[$group] = [
|
||||
'uri' => clone current_url(true),
|
||||
'hasMore' => false,
|
||||
'total' => null,
|
||||
'perPage' => $perPage ?? $this->config->perPage,
|
||||
'pageCount' => 1,
|
||||
'pageSelector' => $group === 'default' ? 'page' : 'page_' . $group,
|
||||
];
|
||||
|
||||
$this->calculateCurrentPage($group);
|
||||
|
||||
if ($_GET) {
|
||||
$this->groups[$group]['uri'] = $this->groups[$group]['uri']->setQueryArray($_GET);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Calculating the current page
|
||||
*/
|
||||
protected function calculateCurrentPage(string $group)
|
||||
{
|
||||
if (array_key_exists($group, $this->segment)) {
|
||||
try {
|
||||
$this->groups[$group]['currentPage'] = (int) $this->groups[$group]['uri']->setSilent(false)->getSegment($this->segment[$group]);
|
||||
} catch (HTTPException $e) {
|
||||
$this->groups[$group]['currentPage'] = 1;
|
||||
}
|
||||
} else {
|
||||
$pageSelector = $this->groups[$group]['pageSelector'];
|
||||
|
||||
$page = (int) ($_GET[$pageSelector] ?? 1);
|
||||
|
||||
$this->groups[$group]['currentPage'] = $page < 1 ? 1 : $page;
|
||||
}
|
||||
}
|
||||
}
|
||||
118
system/Pager/PagerInterface.php
Normal file
118
system/Pager/PagerInterface.php
Normal file
@@ -0,0 +1,118 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* This file is part of CodeIgniter 4 framework.
|
||||
*
|
||||
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
||||
*
|
||||
* For the full copyright and license information, please view
|
||||
* the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace CodeIgniter\Pager;
|
||||
|
||||
use CodeIgniter\HTTP\URI;
|
||||
|
||||
/**
|
||||
* Expected behavior for a Pager
|
||||
*/
|
||||
interface PagerInterface
|
||||
{
|
||||
/**
|
||||
* Handles creating and displaying the
|
||||
*
|
||||
* @param string $template The output template alias to render.
|
||||
*/
|
||||
public function links(string $group = 'default', string $template = 'default'): string;
|
||||
|
||||
/**
|
||||
* Creates simple Next/Previous links, instead of full pagination.
|
||||
*/
|
||||
public function simpleLinks(string $group = 'default', string $template = 'default'): string;
|
||||
|
||||
/**
|
||||
* Allows for a simple, manual, form of pagination where all of the data
|
||||
* is provided by the user. The URL is the current URI.
|
||||
*
|
||||
* @param string $template The output template alias to render.
|
||||
*/
|
||||
public function makeLinks(int $page, int $perPage, int $total, string $template = 'default'): string;
|
||||
|
||||
/**
|
||||
* Stores a set of pagination data for later display. Most commonly used
|
||||
* by the model to automate the process.
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
public function store(string $group, int $page, int $perPage, int $total);
|
||||
|
||||
/**
|
||||
* Sets the path that an aliased group of links will use.
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
public function setPath(string $path, string $group = 'default');
|
||||
|
||||
/**
|
||||
* Returns the total number of pages.
|
||||
*/
|
||||
public function getPageCount(string $group = 'default'): int;
|
||||
|
||||
/**
|
||||
* Returns the number of the current page of results.
|
||||
*/
|
||||
public function getCurrentPage(string $group = 'default'): int;
|
||||
|
||||
/**
|
||||
* Returns the URI for a specific page for the specified group.
|
||||
*
|
||||
* @return string|URI
|
||||
*/
|
||||
public function getPageURI(?int $page = null, string $group = 'default', bool $returnObject = false);
|
||||
|
||||
/**
|
||||
* Tells whether this group of results has any more pages of results.
|
||||
*/
|
||||
public function hasMore(string $group = 'default'): bool;
|
||||
|
||||
/**
|
||||
* Returns the first page.
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
public function getFirstPage(string $group = 'default');
|
||||
|
||||
/**
|
||||
* Returns the last page, if we have a total that we can calculate with.
|
||||
*
|
||||
* @return int|null
|
||||
*/
|
||||
public function getLastPage(string $group = 'default');
|
||||
|
||||
/**
|
||||
* Returns the full URI to the next page of results, or null.
|
||||
*
|
||||
* @return string|null
|
||||
*/
|
||||
public function getNextPageURI(string $group = 'default');
|
||||
|
||||
/**
|
||||
* Returns the full URL to the previous page of results, or null.
|
||||
*
|
||||
* @return string|null
|
||||
*/
|
||||
public function getPreviousPageURI(string $group = 'default');
|
||||
|
||||
/**
|
||||
* Returns the number of results per page that should be shown.
|
||||
*/
|
||||
public function getPerPage(string $group = 'default'): int;
|
||||
|
||||
/**
|
||||
* Returns an array with details about the results, including
|
||||
* total, per_page, current_page, last_page, next_url, prev_url, from, to.
|
||||
* Does not include the actual data. This data is suitable for adding
|
||||
* a 'data' object to with the result set and converting to JSON.
|
||||
*/
|
||||
public function getDetails(string $group = 'default'): array;
|
||||
}
|
||||
378
system/Pager/PagerRenderer.php
Normal file
378
system/Pager/PagerRenderer.php
Normal file
@@ -0,0 +1,378 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* This file is part of CodeIgniter 4 framework.
|
||||
*
|
||||
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
||||
*
|
||||
* For the full copyright and license information, please view
|
||||
* the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace CodeIgniter\Pager;
|
||||
|
||||
use CodeIgniter\HTTP\URI;
|
||||
|
||||
/**
|
||||
* Class PagerRenderer
|
||||
*
|
||||
* This class is passed to the view that describes the pagination,
|
||||
* and is used to get the link information and provide utility
|
||||
* methods needed to work with pagination.
|
||||
*/
|
||||
class PagerRenderer
|
||||
{
|
||||
/**
|
||||
* First page number.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
protected $first;
|
||||
|
||||
/**
|
||||
* Last page number.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
protected $last;
|
||||
|
||||
/**
|
||||
* Current page number.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
protected $current;
|
||||
|
||||
/**
|
||||
* Total number of items.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
protected $total;
|
||||
|
||||
/**
|
||||
* Total number of pages.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
protected $pageCount;
|
||||
|
||||
/**
|
||||
* URI base for pagination links
|
||||
*
|
||||
* @var URI
|
||||
*/
|
||||
protected $uri;
|
||||
|
||||
/**
|
||||
* Segment number used for pagination.
|
||||
*
|
||||
* @var int
|
||||
*/
|
||||
protected $segment;
|
||||
|
||||
/**
|
||||
* Name of $_GET parameter
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $pageSelector;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*/
|
||||
public function __construct(array $details)
|
||||
{
|
||||
$this->first = 1;
|
||||
$this->last = $details['pageCount'];
|
||||
$this->current = $details['currentPage'];
|
||||
$this->total = $details['total'];
|
||||
$this->uri = $details['uri'];
|
||||
$this->pageCount = $details['pageCount'];
|
||||
$this->segment = $details['segment'] ?? 0;
|
||||
$this->pageSelector = $details['pageSelector'] ?? 'page';
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the total number of links that should appear on either
|
||||
* side of the current page. Adjusts the first and last counts
|
||||
* to reflect it.
|
||||
*
|
||||
* @return PagerRenderer
|
||||
*/
|
||||
public function setSurroundCount(?int $count = null)
|
||||
{
|
||||
$this->updatePages($count);
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks to see if there is a "previous" page before our "first" page.
|
||||
*/
|
||||
public function hasPrevious(): bool
|
||||
{
|
||||
return $this->first > 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a URL to the "previous" page. The previous page is NOT the
|
||||
* page before the current page, but is the page just before the
|
||||
* "first" page.
|
||||
*
|
||||
* You MUST call hasPrevious() first, or this value may be invalid.
|
||||
*
|
||||
* @return string|null
|
||||
*/
|
||||
public function getPrevious()
|
||||
{
|
||||
if (! $this->hasPrevious()) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$uri = clone $this->uri;
|
||||
|
||||
if ($this->segment === 0) {
|
||||
$uri->addQuery($this->pageSelector, $this->first - 1);
|
||||
} else {
|
||||
$uri->setSegment($this->segment, $this->first - 1);
|
||||
}
|
||||
|
||||
return URI::createURIString($uri->getScheme(), $uri->getAuthority(), $uri->getPath(), $uri->getQuery(), $uri->getFragment());
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks to see if there is a "next" page after our "last" page.
|
||||
*/
|
||||
public function hasNext(): bool
|
||||
{
|
||||
return $this->pageCount > $this->last;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a URL to the "next" page. The next page is NOT, the
|
||||
* page after the current page, but is the page that follows the
|
||||
* "last" page.
|
||||
*
|
||||
* You MUST call hasNext() first, or this value may be invalid.
|
||||
*
|
||||
* @return string|null
|
||||
*/
|
||||
public function getNext()
|
||||
{
|
||||
if (! $this->hasNext()) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$uri = clone $this->uri;
|
||||
|
||||
if ($this->segment === 0) {
|
||||
$uri->addQuery($this->pageSelector, $this->last + 1);
|
||||
} else {
|
||||
$uri->setSegment($this->segment, $this->last + 1);
|
||||
}
|
||||
|
||||
return URI::createURIString($uri->getScheme(), $uri->getAuthority(), $uri->getPath(), $uri->getQuery(), $uri->getFragment());
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the URI of the first page.
|
||||
*/
|
||||
public function getFirst(): string
|
||||
{
|
||||
$uri = clone $this->uri;
|
||||
|
||||
if ($this->segment === 0) {
|
||||
$uri->addQuery($this->pageSelector, 1);
|
||||
} else {
|
||||
$uri->setSegment($this->segment, 1);
|
||||
}
|
||||
|
||||
return URI::createURIString($uri->getScheme(), $uri->getAuthority(), $uri->getPath(), $uri->getQuery(), $uri->getFragment());
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the URI of the last page.
|
||||
*/
|
||||
public function getLast(): string
|
||||
{
|
||||
$uri = clone $this->uri;
|
||||
|
||||
if ($this->segment === 0) {
|
||||
$uri->addQuery($this->pageSelector, $this->pageCount);
|
||||
} else {
|
||||
$uri->setSegment($this->segment, $this->pageCount);
|
||||
}
|
||||
|
||||
return URI::createURIString($uri->getScheme(), $uri->getAuthority(), $uri->getPath(), $uri->getQuery(), $uri->getFragment());
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the URI of the current page.
|
||||
*/
|
||||
public function getCurrent(): string
|
||||
{
|
||||
$uri = clone $this->uri;
|
||||
|
||||
if ($this->segment === 0) {
|
||||
$uri->addQuery($this->pageSelector, $this->current);
|
||||
} else {
|
||||
$uri->setSegment($this->segment, $this->current);
|
||||
}
|
||||
|
||||
return URI::createURIString($uri->getScheme(), $uri->getAuthority(), $uri->getPath(), $uri->getQuery(), $uri->getFragment());
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an array of links that should be displayed. Each link
|
||||
* is represented by another array containing of the URI the link
|
||||
* should go to, the title (number) of the link, and a boolean
|
||||
* value representing whether this link is active or not.
|
||||
*/
|
||||
public function links(): array
|
||||
{
|
||||
$links = [];
|
||||
|
||||
$uri = clone $this->uri;
|
||||
|
||||
for ($i = $this->first; $i <= $this->last; $i++) {
|
||||
$uri = $this->segment === 0 ? $uri->addQuery($this->pageSelector, $i) : $uri->setSegment($this->segment, $i);
|
||||
$links[] = [
|
||||
'uri' => URI::createURIString($uri->getScheme(), $uri->getAuthority(), $uri->getPath(), $uri->getQuery(), $uri->getFragment()),
|
||||
'title' => $i,
|
||||
'active' => ($i === $this->current),
|
||||
];
|
||||
}
|
||||
|
||||
return $links;
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates the first and last pages based on $surroundCount,
|
||||
* which is the number of links surrounding the active page
|
||||
* to show.
|
||||
*
|
||||
* @param int|null $count The new "surroundCount"
|
||||
*/
|
||||
protected function updatePages(?int $count = null)
|
||||
{
|
||||
if ($count === null) {
|
||||
return;
|
||||
}
|
||||
|
||||
$this->first = $this->current - $count > 0 ? $this->current - $count : 1;
|
||||
$this->last = $this->current + $count <= $this->pageCount ? $this->current + $count : (int) $this->pageCount;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks to see if there is a "previous" page before our "first" page.
|
||||
*/
|
||||
public function hasPreviousPage(): bool
|
||||
{
|
||||
return $this->current > 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a URL to the "previous" page.
|
||||
*
|
||||
* You MUST call hasPreviousPage() first, or this value may be invalid.
|
||||
*
|
||||
* @return string|null
|
||||
*/
|
||||
public function getPreviousPage()
|
||||
{
|
||||
if (! $this->hasPreviousPage()) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$uri = clone $this->uri;
|
||||
|
||||
if ($this->segment === 0) {
|
||||
$uri->addQuery($this->pageSelector, $this->current - 1);
|
||||
} else {
|
||||
$uri->setSegment($this->segment, $this->current - 1);
|
||||
}
|
||||
|
||||
return URI::createURIString($uri->getScheme(), $uri->getAuthority(), $uri->getPath(), $uri->getQuery(), $uri->getFragment());
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks to see if there is a "next" page after our "last" page.
|
||||
*/
|
||||
public function hasNextPage(): bool
|
||||
{
|
||||
return $this->current < $this->last;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a URL to the "next" page.
|
||||
*
|
||||
* You MUST call hasNextPage() first, or this value may be invalid.
|
||||
*
|
||||
* @return string|null
|
||||
*/
|
||||
public function getNextPage()
|
||||
{
|
||||
if (! $this->hasNextPage()) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$uri = clone $this->uri;
|
||||
|
||||
if ($this->segment === 0) {
|
||||
$uri->addQuery($this->pageSelector, $this->current + 1);
|
||||
} else {
|
||||
$uri->setSegment($this->segment, $this->current + 1);
|
||||
}
|
||||
|
||||
return URI::createURIString($uri->getScheme(), $uri->getAuthority(), $uri->getPath(), $uri->getQuery(), $uri->getFragment());
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the page number of the first page.
|
||||
*/
|
||||
public function getFirstPageNumber(): int
|
||||
{
|
||||
return $this->first;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the page number of the current page.
|
||||
*/
|
||||
public function getCurrentPageNumber(): int
|
||||
{
|
||||
return $this->current;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the page number of the last page.
|
||||
*/
|
||||
public function getLastPageNumber(): int
|
||||
{
|
||||
return $this->last;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns total number of pages.
|
||||
*/
|
||||
public function getPageCount(): int
|
||||
{
|
||||
return $this->pageCount;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the previous page number.
|
||||
*/
|
||||
public function getPreviousPageNumber(): ?int
|
||||
{
|
||||
return ($this->current === 1) ? null : $this->current - 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the next page number.
|
||||
*/
|
||||
public function getNextPageNumber(): ?int
|
||||
{
|
||||
return ($this->current === $this->pageCount) ? null : $this->current + 1;
|
||||
}
|
||||
}
|
||||
47
system/Pager/Views/default_full.php
Normal file
47
system/Pager/Views/default_full.php
Normal file
@@ -0,0 +1,47 @@
|
||||
<?php
|
||||
|
||||
use CodeIgniter\Pager\PagerRenderer;
|
||||
|
||||
/**
|
||||
* @var PagerRenderer $pager
|
||||
*/
|
||||
$pager->setSurroundCount(2);
|
||||
?>
|
||||
|
||||
<nav aria-label="<?= lang('Pager.pageNavigation') ?>">
|
||||
<ul class="pagination">
|
||||
<?php if ($pager->hasPrevious()) : ?>
|
||||
<li>
|
||||
<a href="<?= $pager->getFirst() ?>" aria-label="<?= lang('Pager.first') ?>">
|
||||
<span aria-hidden="true"><?= lang('Pager.first') ?></span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="<?= $pager->getPrevious() ?>" aria-label="<?= lang('Pager.previous') ?>">
|
||||
<span aria-hidden="true"><?= lang('Pager.previous') ?></span>
|
||||
</a>
|
||||
</li>
|
||||
<?php endif ?>
|
||||
|
||||
<?php foreach ($pager->links() as $link) : ?>
|
||||
<li <?= $link['active'] ? 'class="active"' : '' ?>>
|
||||
<a href="<?= $link['uri'] ?>">
|
||||
<?= $link['title'] ?>
|
||||
</a>
|
||||
</li>
|
||||
<?php endforeach ?>
|
||||
|
||||
<?php if ($pager->hasNext()) : ?>
|
||||
<li>
|
||||
<a href="<?= $pager->getNext() ?>" aria-label="<?= lang('Pager.next') ?>">
|
||||
<span aria-hidden="true"><?= lang('Pager.next') ?></span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="<?= $pager->getLast() ?>" aria-label="<?= lang('Pager.last') ?>">
|
||||
<span aria-hidden="true"><?= lang('Pager.last') ?></span>
|
||||
</a>
|
||||
</li>
|
||||
<?php endif ?>
|
||||
</ul>
|
||||
</nav>
|
||||
27
system/Pager/Views/default_head.php
Normal file
27
system/Pager/Views/default_head.php
Normal file
@@ -0,0 +1,27 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* This file is part of CodeIgniter 4 framework.
|
||||
*
|
||||
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
||||
*
|
||||
* For the full copyright and license information, please view
|
||||
* the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
use CodeIgniter\Pager\PagerRenderer;
|
||||
|
||||
/**
|
||||
* @var PagerRenderer $pager
|
||||
*/
|
||||
$pager->setSurroundCount(0);
|
||||
|
||||
if ($pager->hasPrevious()) {
|
||||
echo '<link rel="prev" href="' . $pager->getPrevious() . '">' . PHP_EOL;
|
||||
}
|
||||
|
||||
echo '<link rel="canonical" href="' . $pager->getCurrent() . '">' . PHP_EOL;
|
||||
|
||||
if ($pager->hasNext()) {
|
||||
echo '<link rel="next" href="' . $pager->getNext() . '">' . PHP_EOL;
|
||||
}
|
||||
23
system/Pager/Views/default_simple.php
Normal file
23
system/Pager/Views/default_simple.php
Normal file
@@ -0,0 +1,23 @@
|
||||
<?php
|
||||
|
||||
use CodeIgniter\Pager\PagerRenderer;
|
||||
|
||||
/**
|
||||
* @var PagerRenderer $pager
|
||||
*/
|
||||
$pager->setSurroundCount(0);
|
||||
?>
|
||||
<nav>
|
||||
<ul class="pager">
|
||||
<li <?= $pager->hasPrevious() ? '' : 'class="disabled"' ?>>
|
||||
<a href="<?= $pager->getPrevious() ?? '#' ?>" aria-label="<?= lang('Pager.previous') ?>">
|
||||
<span aria-hidden="true"><?= lang('Pager.newer') ?></span>
|
||||
</a>
|
||||
</li>
|
||||
<li <?= $pager->hasNext() ? '' : 'class="disabled"' ?>>
|
||||
<a href="<?= $pager->getnext() ?? '#' ?>" aria-label="<?= lang('Pager.next') ?>">
|
||||
<span aria-hidden="true"><?= lang('Pager.older') ?></span>
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
Reference in New Issue
Block a user