Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/old/vendor/magento/module-theme/Block/Html/ |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Theme\Block\Html;
/**
* Html pager block
*
* @SuppressWarnings(PHPMD.ExcessivePublicCount)
* @api
* @since 100.0.2
*/
class Pager extends \Magento\Framework\View\Element\Template
{
/**
* Current template name
*
* @var string
*/
protected $_template = 'Magento_Theme::html/pager.phtml';
/**
* @var \Magento\Framework\Data\Collection
*/
protected $_collection;
/**
* @var string
*/
protected $_pageVarName = 'p';
/**
* @var string
*/
protected $_limitVarName = 'limit';
/**
* The list of available pager limits
*
* @var array
*/
protected $_availableLimit = [10 => 10, 20 => 20, 50 => 50];
/**
* @var int
*/
protected $_displayPages = 5;
/**
* @var bool
*/
protected $_showPerPage = true;
/**
* @var int
*/
protected $_limit;
/**
* @var bool
*/
protected $_outputRequired = true;
/**
* Pages quantity per frame
*
* @var int
*/
protected $_frameLength = 5;
/**
* Next/previous page position relatively to the current frame
*
* @var int
*/
protected $_jump = 5;
/**
* Frame initialization flag
*
* @var bool
*/
protected $_frameInitialized = false;
/**
* Start page position in frame
*
* @var int
*/
protected $_frameStart;
/**
* Finish page position in frame
*
* @var int
*/
protected $_frameEnd;
/**
* Url Fragment for pagination
*
* @var string|null
*/
protected $_fragment = null;
/**
* Set pager data
*
* @return void
*/
protected function _construct()
{
parent::_construct();
$this->setData('show_amounts', true);
$this->setData('use_container', true);
}
/**
* Return current page
*
* @return int
*/
public function getCurrentPage()
{
if (is_object($this->_collection)) {
return $this->_collection->getCurPage();
}
return (int)$this->getRequest()->getParam($this->getPageVarName(), 1);
}
/**
* Return current page limit
*
* @return int
*/
public function getLimit()
{
if ($this->_limit !== null) {
return $this->_limit;
}
$limits = $this->getAvailableLimit();
if ($limit = $this->getRequest()->getParam($this->getLimitVarName())) {
if (isset($limits[$limit])) {
return $limit;
}
}
$limits = array_keys($limits);
return $limits[0];
}
/**
* Setter for limit items per page
*
* @param int $limit
* @return $this
*/
public function setLimit($limit)
{
$this->_limit = $limit;
return $this;
}
/**
* Set collection for pagination
*
* @param \Magento\Framework\Data\Collection $collection
* @return $this
*/
public function setCollection($collection)
{
$this->_collection = $collection->setCurPage($this->getCurrentPage());
// If not int - then not limit
if ((int)$this->getLimit()) {
$this->_collection->setPageSize($this->getLimit());
}
$this->_setFrameInitialized(false);
return $this;
}
/**
* Returns data collection
*
* @return \Magento\Framework\Data\Collection
*/
public function getCollection()
{
return $this->_collection;
}
/**
* Set page variable name
*
* @param string $varName
*
* @return $this
*/
public function setPageVarName($varName)
{
$this->_pageVarName = $varName;
return $this;
}
/**
* Get page variable name
*
* @return string
*/
public function getPageVarName()
{
return $this->_pageVarName;
}
/**
* Set show per page param
*
* @param bool $varName
*
* @return $this
*/
public function setShowPerPage($varName)
{
$this->_showPerPage = $varName;
return $this;
}
/**
* Is show per page
*
* @return bool
*/
public function isShowPerPage()
{
if (count($this->getAvailableLimit()) <= 1) {
return false;
}
return $this->_showPerPage;
}
/**
* Set the name for pager limit data
*
* @param string $varName
*
* @return $this
*/
public function setLimitVarName($varName)
{
$this->_limitVarName = $varName;
return $this;
}
/**
* Retrieve name for pager limit data
*
* @return string
*/
public function getLimitVarName()
{
return $this->_limitVarName;
}
/**
* Set pager limit
*
* @param array $limits
* @return $this
*/
public function setAvailableLimit(array $limits)
{
$this->_availableLimit = $limits;
return $this;
}
/**
* Retrieve pager limit
*
* @return array
*/
public function getAvailableLimit()
{
return $this->_availableLimit;
}
/**
* Get first number
*
* @return int
*/
public function getFirstNum()
{
$collection = $this->getCollection();
return $collection->getPageSize() * ($collection->getCurPage() - 1) + 1;
}
/**
* Get last number
*
* @return int
*/
public function getLastNum()
{
$collection = $this->getCollection();
return $collection->getPageSize() * ($collection->getCurPage() - 1) + $collection->count();
}
/**
* Retrieve total number of pages
*
* @return int
*/
public function getTotalNum()
{
return $this->getCollection()->getSize();
}
/**
* Check if current page is a first page in collection
*
* @return bool
*/
public function isFirstPage()
{
return $this->getCollection()->getCurPage() == 1;
}
/**
* Retrieve number of last page
*
* @return int
*/
public function getLastPageNum()
{
return $this->getCollection()->getLastPageNumber();
}
/**
* Check if current page is a last page in collection
*
* @return bool
*/
public function isLastPage()
{
return $this->getCollection()->getCurPage() >= $this->getLastPageNum();
}
/**
* Is limit current
*
* @param int $limit
*
* @return bool
*/
public function isLimitCurrent($limit)
{
return $limit == $this->getLimit();
}
/**
* Is page current
*
* @param int $page
*
* @return bool
*/
public function isPageCurrent($page)
{
return $page == $this->getCurrentPage();
}
/**
* Get pages
*
* @return array
*/
public function getPages()
{
$collection = $this->getCollection();
if ($collection->getLastPageNumber() <= $this->_displayPages) {
return range(1, $collection->getLastPageNumber());
} else {
$half = ceil($this->_displayPages / 2);
if ($collection->getCurPage() >= $half &&
$collection->getCurPage() <= $collection->getLastPageNumber() - $half
) {
$start = $collection->getCurPage() - $half + 1;
$finish = $start + $this->_displayPages - 1;
} elseif ($collection->getCurPage() < $half) {
$start = 1;
$finish = $this->_displayPages;
} elseif ($collection->getCurPage() > $collection->getLastPageNumber() - $half) {
$finish = $collection->getLastPageNumber();
$start = $finish - $this->_displayPages + 1;
}
return range($start, $finish);
}
}
/**
* Get first page url
*
* @return string
*/
public function getFirstPageUrl()
{
return $this->getPageUrl(1);
}
/**
* Retrieve previous page URL
*
* @return string
*/
public function getPreviousPageUrl()
{
return $this->getPageUrl($this->getCollection()->getCurPage(-1));
}
/**
* Retrieve next page URL
*
* @return string
*/
public function getNextPageUrl()
{
return $this->getPageUrl($this->getCollection()->getCurPage(+1));
}
/**
* Retrieve last page URL
*
* @return string
*/
public function getLastPageUrl()
{
return $this->getPageUrl($this->getCollection()->getLastPageNumber());
}
/**
* Retrieve page URL
*
* @param string $page
*
* @return string
*/
public function getPageUrl($page)
{
return $this->getPagerUrl(
[
$this->getPageVarName() => $page > 1 ? $page : null,
]
);
}
/**
* Get limit url
*
* @param int $limit
*
* @return string
*/
public function getLimitUrl($limit)
{
return $this->getPagerUrl($this->getPageLimitParams($limit));
}
/**
* Return page limit params
*
* @param int $limit
* @return array
*/
private function getPageLimitParams(int $limit): array
{
$data = [$this->getLimitVarName() => $limit];
$currentPage = $this->getCurrentPage();
$availableCount = (int) ceil($this->getTotalNum() / $limit);
if ($currentPage !== 1 && $availableCount < $currentPage) {
$data = array_merge($data, [$this->getPageVarName() => $availableCount === 1 ? null : $availableCount]);
}
return $data;
}
/**
* Retrieve page URL by defined parameters
*
* @param array $params
*
* @return string
*/
public function getPagerUrl($params = [])
{
$urlParams = [];
$urlParams['_current'] = true;
$urlParams['_escape'] = true;
$urlParams['_use_rewrite'] = true;
$urlParams['_fragment'] = $this->getFragment();
$urlParams['_query'] = $params;
return $this->getUrl($this->getPath(), $urlParams);
}
/**
* Get path
*
* @return string
*/
protected function getPath()
{
return $this->_getData('path') ?: '*/*/*';
}
/**
* Getter for $_frameStart
*
* @return int
*/
public function getFrameStart()
{
$this->_initFrame();
return $this->_frameStart;
}
/**
* Getter for $_frameEnd
*
* @return int
*/
public function getFrameEnd()
{
$this->_initFrame();
return $this->_frameEnd;
}
/**
* Return array of pages in frame
*
* @return array
*/
public function getFramePages()
{
$start = $this->getFrameStart();
$end = $this->getFrameEnd();
return range($start, $end);
}
/**
* Return page number of Previous jump
*
* @return int|null
*/
public function getPreviousJumpPage()
{
if (!$this->getJump()) {
return null;
}
$frameStart = $this->getFrameStart();
if ($frameStart - 1 > 1) {
return max(2, $frameStart - $this->getJump());
}
return null;
}
/**
* Prepare URL for Previous Jump
*
* @return string
*/
public function getPreviousJumpUrl()
{
return $this->getPageUrl($this->getPreviousJumpPage());
}
/**
* Return page number of Next jump
*
* @return int|null
*/
public function getNextJumpPage()
{
if (!$this->getJump()) {
return null;
}
$frameEnd = $this->getFrameEnd();
if ($this->getLastPageNum() - $frameEnd > 1) {
return min($this->getLastPageNum() - 1, $frameEnd + $this->getJump());
}
return null;
}
/**
* Prepare URL for Next Jump
*
* @return string
*/
public function getNextJumpUrl()
{
return $this->getPageUrl($this->getNextJumpPage());
}
/**
* Getter for $_frameLength
*
* @return int
*/
public function getFrameLength()
{
return $this->_frameLength;
}
/**
* Getter for $_jump
*
* @return int
*/
public function getJump()
{
return $this->_jump;
}
/**
* Setter for $_frameLength
*
* @param int $frame
* @return $this
*/
public function setFrameLength($frame)
{
$frame = abs((int)$frame);
if ($frame == 0) {
$frame = $this->_frameLength;
}
if ($this->getFrameLength() != $frame) {
$this->_setFrameInitialized(false);
$this->_frameLength = $frame;
}
return $this;
}
/**
* Setter for $_jump
*
* @param int $jump
* @return $this
*/
public function setJump($jump)
{
$jump = abs((int)$jump);
if ($this->getJump() != $jump) {
$this->_setFrameInitialized(false);
$this->_jump = $jump;
}
return $this;
}
/**
* Whether to show first page in pagination or not
*
* @return bool
*/
public function canShowFirst()
{
return $this->getJump() > 1 && $this->getFrameStart() > 1;
}
/**
* Whether to show last page in pagination or not
*
* @return bool
*/
public function canShowLast()
{
return $this->getJump() > 1 && $this->getFrameEnd() < $this->getLastPageNum();
}
/**
* Whether to show link to Previous Jump
*
* @return bool
*/
public function canShowPreviousJump()
{
return $this->getPreviousJumpPage() !== null;
}
/**
* Whether to show link to Next Jump
*
* @return bool
*/
public function canShowNextJump()
{
return $this->getNextJumpPage() !== null;
}
/**
* Initialize frame data, such as frame start, frame start etc.
*
* @return $this
*/
protected function _initFrame()
{
if (!$this->isFrameInitialized()) {
$start = 0;
$end = 0;
$collection = $this->getCollection();
if ($collection->getLastPageNumber() <= $this->getFrameLength()) {
$start = 1;
$end = $collection->getLastPageNumber();
} else {
$half = ceil($this->getFrameLength() / 2);
if ($collection->getCurPage() >= $half &&
$collection->getCurPage() <= $collection->getLastPageNumber() - $half
) {
$start = $collection->getCurPage() - $half + 1;
$end = $start + $this->getFrameLength() - 1;
} elseif ($collection->getCurPage() < $half) {
$start = 1;
$end = $this->getFrameLength();
} elseif ($collection->getCurPage() > $collection->getLastPageNumber() - $half) {
$end = $collection->getLastPageNumber();
$start = $end - $this->getFrameLength() + 1;
}
}
$this->_frameStart = $start;
$this->_frameEnd = $end;
$this->_setFrameInitialized(true);
}
return $this;
}
/**
* Setter for flag _frameInitialized
*
* @param bool $flag
* @return $this
*/
protected function _setFrameInitialized($flag)
{
$this->_frameInitialized = (bool)$flag;
return $this;
}
/**
* Check if frame data was initialized
*
* @return bool
*/
public function isFrameInitialized()
{
return $this->_frameInitialized;
}
/**
* Getter for alternative text for Previous link in pagination frame
*
* @return string
*/
public function getAnchorTextForPrevious()
{
return $this->_scopeConfig->getValue(
'design/pagination/anchor_text_for_previous',
\Magento\Store\Model\ScopeInterface::SCOPE_STORE
);
}
/**
* Getter for alternative text for Next link in pagination frame
*
* @return string
*/
public function getAnchorTextForNext()
{
return $this->_scopeConfig->getValue(
'design/pagination/anchor_text_for_next',
\Magento\Store\Model\ScopeInterface::SCOPE_STORE
);
}
/**
* Set whether output of the pager is mandatory
*
* @param bool $isRequired
* @return $this
*/
public function setIsOutputRequired($isRequired)
{
$this->_outputRequired = (bool)$isRequired;
return $this;
}
/**
* Determine whether the pagination should be eventually rendered
*
* @return string
*/
protected function _toHtml()
{
if ($this->_outputRequired || $this->getTotalNum() > $this->getLimit()) {
return parent::_toHtml();
}
return '';
}
/**
* Get the URL fragment
*
* @return string|null
*/
public function getFragment()
{
return $this->_fragment;
}
/**
* Set the URL fragment
*
* @param string|null $fragment
* @return $this
*/
public function setFragment($fragment)
{
$this->_fragment = $fragment;
return $this;
}
}