First Local Commit - After Clean up.
Signed-off-by: Rick Hays <rhays@haysgang.com>
This commit is contained in:
17
system/Pager/Exceptions/PagerException.php
Normal file
17
system/Pager/Exceptions/PagerException.php
Normal file
@@ -0,0 +1,17 @@
|
||||
<?php namespace CodeIgniter\Pager\Exceptions;
|
||||
|
||||
use CodeIgniter\Exceptions\ExceptionInterface;
|
||||
use CodeIgniter\Exceptions\FrameworkException;
|
||||
|
||||
class PagerException extends FrameworkException implements ExceptionInterface
|
||||
{
|
||||
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]));
|
||||
}
|
||||
}
|
||||
536
system/Pager/Pager.php
Normal file
536
system/Pager/Pager.php
Normal file
@@ -0,0 +1,536 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* CodeIgniter
|
||||
*
|
||||
* An open source application development framework for PHP
|
||||
*
|
||||
* This content is released under the MIT License (MIT)
|
||||
*
|
||||
* Copyright (c) 2014-2019 British Columbia Institute of Technology
|
||||
* Copyright (c) 2019 CodeIgniter Foundation
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*
|
||||
* @package CodeIgniter
|
||||
* @author CodeIgniter Dev Team
|
||||
* @copyright 2019 CodeIgniter Foundation
|
||||
* @license https://opensource.org/licenses/MIT MIT License
|
||||
* @link https://codeigniter.com
|
||||
* @since Version 4.0.0
|
||||
* @filesource
|
||||
*/
|
||||
|
||||
namespace CodeIgniter\Pager;
|
||||
|
||||
use CodeIgniter\Pager\Exceptions\PagerException;
|
||||
use Config\Services;
|
||||
use CodeIgniter\View\RendererInterface;
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @package CodeIgniter\Pager
|
||||
*/
|
||||
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 \Config\Pager
|
||||
*/
|
||||
protected $config;
|
||||
|
||||
/**
|
||||
* The view engine to render the links with.
|
||||
*
|
||||
* @var RendererInterface
|
||||
*/
|
||||
protected $view;
|
||||
|
||||
/**
|
||||
* List of only permitted queries
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $only = [];
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param type $config
|
||||
* @param RendererInterface $view
|
||||
*/
|
||||
public function __construct($config, RendererInterface $view)
|
||||
{
|
||||
$this->config = $config;
|
||||
$this->view = $view;
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Handles creating and displaying the
|
||||
*
|
||||
* @param string $group
|
||||
* @param string $template The output template alias to render.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
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.
|
||||
*
|
||||
* @param string $group
|
||||
* @param string $template
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
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 integer $page
|
||||
* @param integer $perPage
|
||||
* @param integer $total
|
||||
* @param string $template The output template alias to render.
|
||||
* @param integer $segment (if page number is provided by URI segment)
|
||||
*
|
||||
* @param string|null $group optional group (i.e. if we'd like to define custom path)
|
||||
* @return string
|
||||
*/
|
||||
public function makeLinks(int $page, int $perPage, int $total, string $template = 'default_full', int $segment = 0, ?string $group = null): string
|
||||
{
|
||||
$name = time();
|
||||
|
||||
$this->store($group ?? $name, $page, $perPage, $total, $segment);
|
||||
|
||||
return $this->displayLinks($group ?? $name, $template);
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Does the actual work of displaying the view file. Used internally
|
||||
* by links(), simpleLinks(), and makeLinks().
|
||||
*
|
||||
* @param string $group
|
||||
* @param string $template
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
protected function displayLinks(string $group, string $template): string
|
||||
{
|
||||
$pager = new PagerRenderer($this->getDetails($group));
|
||||
|
||||
if (! array_key_exists($template, $this->config->templates))
|
||||
{
|
||||
throw PagerException::forInvalidTemplate($template);
|
||||
}
|
||||
|
||||
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.
|
||||
*
|
||||
* @param string $group
|
||||
* @param integer $page
|
||||
* @param integer $perPage
|
||||
* @param integer $total
|
||||
* @param integer $segment
|
||||
*
|
||||
* @return $this
|
||||
*/
|
||||
public function store(string $group, int $page, int $perPage, int $total, int $segment = 0)
|
||||
{
|
||||
$this->segment[$group] = $segment;
|
||||
|
||||
$this->ensureGroup($group);
|
||||
|
||||
$this->groups[$group]['currentPage'] = $page;
|
||||
$this->groups[$group]['perPage'] = $perPage;
|
||||
$this->groups[$group]['total'] = $total;
|
||||
$this->groups[$group]['pageCount'] = (int)ceil($total / $perPage);
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Sets the path that an aliased group of links will use.
|
||||
*
|
||||
* @param string $path
|
||||
* @param string $group
|
||||
*
|
||||
* @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 pages.
|
||||
*
|
||||
* @param string|null $group
|
||||
*
|
||||
* @return integer
|
||||
*/
|
||||
public function getPageCount(string $group = 'default'): int
|
||||
{
|
||||
$this->ensureGroup($group);
|
||||
|
||||
return $this->groups[$group]['pageCount'];
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Returns the number of the current page of results.
|
||||
*
|
||||
* @param string|null $group
|
||||
*
|
||||
* @return integer
|
||||
*/
|
||||
public function getCurrentPage(string $group = 'default'): int
|
||||
{
|
||||
$this->ensureGroup($group);
|
||||
|
||||
return $this->groups[$group]['currentPage'];
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Tells whether this group of results has any more pages of results.
|
||||
*
|
||||
* @param string|null $group
|
||||
*
|
||||
* @return boolean
|
||||
*/
|
||||
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.
|
||||
*
|
||||
* @param string $group
|
||||
*
|
||||
* @return integer|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.
|
||||
*
|
||||
* @param string $group
|
||||
*
|
||||
* @return integer
|
||||
*/
|
||||
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.
|
||||
*
|
||||
* @param integer|null $page
|
||||
* @param string $group
|
||||
* @param boolean $returnObject
|
||||
*
|
||||
* @return string|\CodeIgniter\HTTP\URI
|
||||
*/
|
||||
public function getPageURI(int $page = null, string $group = 'default', bool $returnObject = false)
|
||||
{
|
||||
$this->ensureGroup($group);
|
||||
|
||||
/**
|
||||
* @var \CodeIgniter\HTTP\URI $uri
|
||||
*/
|
||||
$uri = $this->groups[$group]['uri'];
|
||||
|
||||
$segment = $this->segment[$group] ?? 0;
|
||||
|
||||
if ($segment)
|
||||
{
|
||||
$uri->setSegment($segment, $page);
|
||||
}
|
||||
else
|
||||
{
|
||||
$uri->addQuery('page', $page);
|
||||
}
|
||||
|
||||
if ($this->only)
|
||||
{
|
||||
$query = array_intersect_key($_GET, array_flip($this->only));
|
||||
|
||||
if (! $segment)
|
||||
{
|
||||
$query['page'] = $page;
|
||||
}
|
||||
|
||||
$uri->setQueryArray($query);
|
||||
}
|
||||
|
||||
return $returnObject === true ? $uri : (string) $uri;
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Returns the full URI to the next page of results, or null.
|
||||
*
|
||||
* @param string $group
|
||||
* @param boolean $returnObject
|
||||
*
|
||||
* @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.
|
||||
*
|
||||
* @param string $group
|
||||
* @param boolean $returnObject
|
||||
*
|
||||
* @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.
|
||||
*
|
||||
* @param string $group
|
||||
*
|
||||
* @return integer
|
||||
*/
|
||||
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.
|
||||
*
|
||||
* @param string $group
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
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.
|
||||
*
|
||||
* @param array $queries
|
||||
*
|
||||
* @return Pager
|
||||
*/
|
||||
public function only(array $queries):Pager
|
||||
{
|
||||
$this->only = $queries;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Ensures that an array exists for the group specified.
|
||||
*
|
||||
* @param string $group
|
||||
*/
|
||||
protected function ensureGroup(string $group)
|
||||
{
|
||||
if (array_key_exists($group, $this->groups))
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
$this->groups[$group] = [
|
||||
'uri' => clone Services::request()->uri,
|
||||
'hasMore' => false,
|
||||
'total' => null,
|
||||
'perPage' => $this->config->perPage,
|
||||
'pageCount' => 1,
|
||||
];
|
||||
|
||||
if (array_key_exists($group, $this->segment))
|
||||
{
|
||||
try
|
||||
{
|
||||
$this->groups[$group]['currentPage'] = $this->groups[$group]['uri']->getSegment($this->segment[$group]);
|
||||
}
|
||||
catch (\CodeIgniter\HTTP\Exceptions\HTTPException $e)
|
||||
{
|
||||
$this->groups[$group]['currentPage'] = 1;
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
$this->groups[$group]['currentPage'] = $_GET['page_' . $group] ?? $_GET['page'] ?? 1;
|
||||
}
|
||||
|
||||
if ($_GET)
|
||||
{
|
||||
$this->groups[$group]['uri'] = $this->groups[$group]['uri']->setQueryArray($_GET);
|
||||
}
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
}
|
||||
228
system/Pager/PagerInterface.php
Normal file
228
system/Pager/PagerInterface.php
Normal file
@@ -0,0 +1,228 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* CodeIgniter
|
||||
*
|
||||
* An open source application development framework for PHP
|
||||
*
|
||||
* This content is released under the MIT License (MIT)
|
||||
*
|
||||
* Copyright (c) 2014-2019 British Columbia Institute of Technology
|
||||
* Copyright (c) 2019 CodeIgniter Foundation
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*
|
||||
* @package CodeIgniter
|
||||
* @author CodeIgniter Dev Team
|
||||
* @copyright 2019 CodeIgniter Foundation
|
||||
* @license https://opensource.org/licenses/MIT MIT License
|
||||
* @link https://codeigniter.com
|
||||
* @since Version 4.0.0
|
||||
* @filesource
|
||||
*/
|
||||
|
||||
namespace CodeIgniter\Pager;
|
||||
|
||||
/**
|
||||
* Expected behavior for a Pager
|
||||
*/
|
||||
interface PagerInterface
|
||||
{
|
||||
|
||||
/**
|
||||
* Handles creating and displaying the
|
||||
*
|
||||
* @param string $group
|
||||
* @param string $template The output template alias to render.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function links(string $group = 'default', string $template = 'default'): string;
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Creates simple Next/Previous links, instead of full pagination.
|
||||
*
|
||||
* @param string $group
|
||||
* @param string $template
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
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 integer $page
|
||||
* @param integer $perPage
|
||||
* @param integer $total
|
||||
* @param string $template The output template alias to render.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
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.
|
||||
*
|
||||
* @param string $group
|
||||
* @param integer $page
|
||||
* @param integer $perPage
|
||||
* @param integer $total
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
public function store(string $group, int $page, int $perPage, int $total);
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Sets the path that an aliased group of links will use.
|
||||
*
|
||||
* @param string $path
|
||||
* @param string $group
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
public function setPath(string $path, string $group = 'default');
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Returns the total number of pages.
|
||||
*
|
||||
* @param string|null $group
|
||||
*
|
||||
* @return integer
|
||||
*/
|
||||
public function getPageCount(string $group = 'default'): int;
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Returns the number of the current page of results.
|
||||
*
|
||||
* @param string|null $group
|
||||
*
|
||||
* @return integer
|
||||
*/
|
||||
public function getCurrentPage(string $group = 'default'): int;
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Returns the URI for a specific page for the specified group.
|
||||
*
|
||||
* @param integer|null $page
|
||||
* @param string $group
|
||||
* @param boolean $returnObject
|
||||
*
|
||||
* @return string|\CodeIgniter\HTTP\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.
|
||||
*
|
||||
* @param string|null $group
|
||||
*
|
||||
* @return boolean
|
||||
*/
|
||||
public function hasMore(string $group = 'default'): bool;
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Returns the first page.
|
||||
*
|
||||
* @param string $group
|
||||
*
|
||||
* @return integer
|
||||
*/
|
||||
public function getFirstPage(string $group = 'default');
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Returns the last page, if we have a total that we can calculate with.
|
||||
*
|
||||
* @param string $group
|
||||
*
|
||||
* @return integer|null
|
||||
*/
|
||||
public function getLastPage(string $group = 'default');
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Returns the full URI to the next page of results, or null.
|
||||
*
|
||||
* @param string $group
|
||||
*
|
||||
* @return string|null
|
||||
*/
|
||||
public function getNextPageURI(string $group = 'default');
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Returns the full URL to the previous page of results, or null.
|
||||
*
|
||||
* @param string $group
|
||||
*
|
||||
* @return string|null
|
||||
*/
|
||||
public function getPreviousPageURI(string $group = 'default');
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Returns the number of results per page that should be shown.
|
||||
*
|
||||
* @param string $group
|
||||
*
|
||||
* @return integer
|
||||
*/
|
||||
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.
|
||||
*
|
||||
* @param string $group
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function getDetails(string $group = 'default'): array;
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
}
|
||||
339
system/Pager/PagerRenderer.php
Normal file
339
system/Pager/PagerRenderer.php
Normal file
@@ -0,0 +1,339 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* CodeIgniter
|
||||
*
|
||||
* An open source application development framework for PHP
|
||||
*
|
||||
* This content is released under the MIT License (MIT)
|
||||
*
|
||||
* Copyright (c) 2014-2019 British Columbia Institute of Technology
|
||||
* Copyright (c) 2019 CodeIgniter Foundation
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*
|
||||
* @package CodeIgniter
|
||||
* @author CodeIgniter Dev Team
|
||||
* @copyright 2019 CodeIgniter Foundation
|
||||
* @license https://opensource.org/licenses/MIT MIT License
|
||||
* @link https://codeigniter.com
|
||||
* @since Version 4.0.0
|
||||
* @filesource
|
||||
*/
|
||||
|
||||
namespace CodeIgniter\Pager;
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @package CodeIgniter\Pager
|
||||
*/
|
||||
class PagerRenderer
|
||||
{
|
||||
|
||||
/**
|
||||
* First page number.
|
||||
*
|
||||
* @var integer
|
||||
*/
|
||||
protected $first;
|
||||
/**
|
||||
* Last page number.
|
||||
*
|
||||
* @var integer
|
||||
*/
|
||||
protected $last;
|
||||
/**
|
||||
* Current page number.
|
||||
*
|
||||
* @var integer
|
||||
*/
|
||||
protected $current;
|
||||
/**
|
||||
* Total number of pages? unused?
|
||||
*
|
||||
* @var integer
|
||||
*/
|
||||
protected $total;
|
||||
/**
|
||||
* Page count?
|
||||
*
|
||||
* @var integer
|
||||
*/
|
||||
protected $pageCount;
|
||||
/**
|
||||
* URI base for pagination links
|
||||
*
|
||||
* @var integer
|
||||
*/
|
||||
protected $uri;
|
||||
/**
|
||||
* Segment number used for pagination.
|
||||
*
|
||||
* @var integer
|
||||
*/
|
||||
protected $segment;
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param array $details
|
||||
*/
|
||||
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;
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @param integer|null $count
|
||||
*
|
||||
* @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.
|
||||
*
|
||||
* @return boolean
|
||||
*/
|
||||
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('page', $this->first - 1);
|
||||
}
|
||||
else
|
||||
{
|
||||
$uri->setSegment($this->segment, $this->first - 1);
|
||||
}
|
||||
|
||||
return (string) $uri;
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Checks to see if there is a "next" page after our "last" page.
|
||||
*
|
||||
* @return boolean
|
||||
*/
|
||||
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('page', $this->last + 1);
|
||||
}
|
||||
else
|
||||
{
|
||||
$uri->setSegment($this->segment, $this->last + 1);
|
||||
}
|
||||
|
||||
return (string) $uri;
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Returns the URI of the first page.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getFirst(): string
|
||||
{
|
||||
$uri = clone $this->uri;
|
||||
|
||||
if ($this->segment === 0)
|
||||
{
|
||||
$uri->addQuery('page', 1);
|
||||
}
|
||||
else
|
||||
{
|
||||
$uri->setSegment($this->segment, 1);
|
||||
}
|
||||
|
||||
return (string) $uri;
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Returns the URI of the last page.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getLast(): string
|
||||
{
|
||||
$uri = clone $this->uri;
|
||||
|
||||
if ($this->segment === 0)
|
||||
{
|
||||
$uri->addQuery('page', $this->pageCount);
|
||||
}
|
||||
else
|
||||
{
|
||||
$uri->setSegment($this->segment, $this->pageCount);
|
||||
}
|
||||
|
||||
return (string) $uri;
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Returns the URI of the current page.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getCurrent(): string
|
||||
{
|
||||
$uri = clone $this->uri;
|
||||
|
||||
if ($this->segment === 0)
|
||||
{
|
||||
$uri->addQuery('page', $this->current);
|
||||
}
|
||||
else
|
||||
{
|
||||
$uri->setSegment($this->segment, $this->current);
|
||||
}
|
||||
|
||||
return (string) $uri;
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function links(): array
|
||||
{
|
||||
$links = [];
|
||||
|
||||
$uri = clone $this->uri;
|
||||
|
||||
for ($i = $this->first; $i <= $this->last; $i ++)
|
||||
{
|
||||
$links[] = [
|
||||
'uri' => (string) ($this->segment === 0 ? $uri->addQuery('page', $i) : $uri->setSegment($this->segment, $i)),
|
||||
'title' => (int) $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 integer|null $count The new "surroundCount"
|
||||
*/
|
||||
protected function updatePages(int $count = null)
|
||||
{
|
||||
if (is_null($count))
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
$this->first = $this->current - $count > 0 ? (int) ($this->current - $count) : 1;
|
||||
$this->last = $this->current + $count <= $this->pageCount ? (int) ($this->current + $count) : (int) $this->pageCount;
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------
|
||||
}
|
||||
45
system/Pager/Views/default_full.php
Normal file
45
system/Pager/Views/default_full.php
Normal file
@@ -0,0 +1,45 @@
|
||||
<?php
|
||||
/**
|
||||
* @var \CodeIgniter\Pager\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">«</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">»</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>
|
||||
18
system/Pager/Views/default_head.php
Normal file
18
system/Pager/Views/default_head.php
Normal file
@@ -0,0 +1,18 @@
|
||||
<?php
|
||||
/**
|
||||
* @var \CodeIgniter\Pager\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;
|
||||
}
|
||||
21
system/Pager/Views/default_simple.php
Normal file
21
system/Pager/Views/default_simple.php
Normal file
@@ -0,0 +1,21 @@
|
||||
<?php
|
||||
/**
|
||||
* @var \CodeIgniter\Pager\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