Pager Class Reference

Inheritance diagram for Pager:

Public Member Functions
	getCurrentPage ()
	getLimit ()
	setLimit ($limit)
	setCollection ($collection)
	getCollection ()
	setPageVarName ($varName)
	getPageVarName ()
	setShowPerPage ($varName)
	isShowPerPage ()
	setLimitVarName ($varName)
	getLimitVarName ()
	setAvailableLimit (array $limits)
	getAvailableLimit ()
	getFirstNum ()
	getLastNum ()
	getTotalNum ()
	isFirstPage ()
	getLastPageNum ()
	isLastPage ()
	isLimitCurrent ($limit)
	isPageCurrent ($page)
	getPages ()
	getFirstPageUrl ()
	getPreviousPageUrl ()
	getNextPageUrl ()
	getLastPageUrl ()
	getPageUrl ($page)
	getLimitUrl ($limit)
	getPagerUrl ($params=[])
	getFrameStart ()
	getFrameEnd ()
	getFramePages ()
	getPreviousJumpPage ()
	getPreviousJumpUrl ()
	getNextJumpPage ()
	getNextJumpUrl ()
	getFrameLength ()
	getJump ()
	setFrameLength ($frame)
	setJump ($jump)
	canShowFirst ()
	canShowLast ()
	canShowPreviousJump ()
	canShowNextJump ()
	isFrameInitialized ()
	getAnchorTextForPrevious ()
	getAnchorTextForNext ()
	setIsOutputRequired ($isRequired)
	getFragment ()
	setFragment ($fragment)
Public Member Functions inherited from Template
	__construct (Template\Context $context, array $data=[])
	setTemplateContext ($templateContext)
	getTemplate ()
	setTemplate ($template)
	getTemplateFile ($template=null)
	getArea ()
	assign ($key, $value=null)
	fetchView ($fileName)
	getBaseUrl ()
	getObjectData (\Magento\Framework\DataObject $object, $key)
	getCacheKeyInfo ()
Public Member Functions inherited from AbstractBlock
	__construct (\Magento\Framework\View\Element\Context $context, array $data=[])
	getJsLayout ()
	getRequest ()
	getParentBlock ()
	setLayout (\Magento\Framework\View\LayoutInterface $layout)
	getLayout ()
	setNameInLayout ($name)
	getChildNames ()
	setAttribute ($name, $value=null)
	setChild ($alias, $block)
	addChild ($alias, $block, $data=[])
	unsetChild ($alias)
	unsetCallChild ($alias, $callback, $result, $params)
	unsetChildren ()
	getChildBlock ($alias)
	getChildHtml ($alias='', $useCache=true)
	getChildChildHtml ($alias, $childChildAlias='', $useCache=true)
	getBlockHtml ($name)
	insert ($element, $siblingName=0, $after=true, $alias='')
	append ($element, $alias='')
	getGroupChildNames ($groupName)
	getChildData ($alias, $key='')
	getUiId ($arg1=null, $arg2=null, $arg3=null, $arg4=null, $arg5=null)
	getJsId ($arg1=null, $arg2=null, $arg3=null, $arg4=null, $arg5=null)
	getUrl ($route='', $params=[])
	getViewFileUrl ($fileId, array $params=[])
	formatDate ( $date=null, $format=\IntlDateFormatter::SHORT, $showTime=false, $timezone=null)
	formatTime ( $time=null, $format=\IntlDateFormatter::SHORT, $showDate=false)
	getModuleName ()
	escapeHtml ($data, $allowedTags=null)
	escapeJs ($string)
	escapeHtmlAttr ($string, $escapeSingleQuote=true)
	escapeCss ($string)
	stripTags ($data, $allowableTags=null, $allowHtmlEntities=false)
	escapeUrl ($string)
	escapeXssInUrl ($data)
	escapeQuote ($data, $addSlashes=false)
	escapeJsQuote ($data, $quote='\'')
	getNameInLayout ()
	getCacheKeyInfo ()
	getCacheKey ()
	getVar ($name, $module=null)
	isScopePrivate ()
Public Member Functions inherited from DataObject
	__construct (array $data=[])
	addData (array $arr)
	setData ($key, $value=null)
	unsetData ($key=null)
	getData ($key='', $index=null)
	getDataByPath ($path)
	getDataByKey ($key)
	setDataUsingMethod ($key, $args=[])
	getDataUsingMethod ($key, $args=null)
	hasData ($key='')
	toArray (array $keys=[])
	convertToArray (array $keys=[])
	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	toJson (array $keys=[])
	convertToJson (array $keys=[])
	toString ($format='')
	__call ($method, $args)
	isEmpty ()
	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
	debug ($data=null, &$objects=[])
	offsetSet ($offset, $value)
	offsetExists ($offset)
	offsetUnset ($offset)
	offsetGet ($offset)
Public Member Functions inherited from BlockInterface
	toHtml ()

Protected Member Functions
	_construct ()
	getPath ()
	_initFrame ()
	_setFrameInitialized ($flag)
	_toHtml ()
Protected Member Functions inherited from Template
	_construct ()
	_toHtml ()
	getRootDirectory ()
	getMediaDirectory ()
Protected Member Functions inherited from AbstractBlock
	_construct ()
	_prepareLayout ()
	_beforeToHtml ()
	_afterToHtml ($html)
	_toHtml ()
	_getNotFoundUrl ($route='', $params=['_direct'=> 'core/index/notFound'])
	getCacheTags ()
	getCacheLifetime ()
	_loadCache ()
	_saveCache ($data)
	_getSidPlaceholder ($cacheKey=null)
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)

Protected Attributes
	$_template = 'Magento_Theme::html/pager.phtml'
	$_collection
	$_pageVarName = 'p'
	$_limitVarName = 'limit'
	$_availableLimit = [10 => 10, 20 => 20, 50 => 50]
	$_displayPages = 5
	$_showPerPage = true
	$_limit
	$_outputRequired = true
	$_frameLength = 5
	$_jump = 5
	$_frameInitialized = false
	$_frameStart
	$_frameEnd
	$_fragment = null
Protected Attributes inherited from Template
	$_viewVars = []
	$_baseUrl
	$_jsUrl
	$_allowSymlinks
	$_filesystem
	$_template
	$templateEnginePool
	$_storeManager
	$_appState
	$directory
	$templateContext
	$pageConfig
	$resolver
	$validator
Protected Attributes inherited from AbstractBlock
	$_design
	$_session
	$_sidResolver
	$_nameInLayout
	$_layout
	$jsLayout = []
	$_request
	$_urlBuilder
	$_eventManager
	$_frontController
	$_assetRepo
	$_viewConfig
	$_cacheState
	$_logger
	$_escaper
	$filterManager
	$_localeDate
	$inlineTranslation
	$_isScopePrivate = false
	$_scopeConfig
	$_cache
Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Public Member Functions inherited from AbstractBlock
static	extractModuleName ($className)
Data Fields inherited from Template
const	XML_PATH_TEMPLATE_ALLOW_SYMLINK = 'dev/template/allow_symlink'
Data Fields inherited from AbstractBlock
const	CACHE_GROUP = \Magento\Framework\App\Cache\Type\Block::TYPE_IDENTIFIER
const	CACHE_KEY_PREFIX = 'BLOCK_'
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Html pager block

@SuppressWarnings(PHPMD.ExcessivePublicCount) @api

Since

100.0.2

Definition at line 15 of file Pager.php.

Member Function Documentation

_construct()

_construct ( )

protected

Set pager data

Returns

void

Definition at line 113 of file Pager.php.

    {
        parent::_construct();
        $this->setData('show_amounts', true);
        $this->setData('use_container', true);
    }

_initFrame()

_initFrame ( )

protected

Initialize frame data, such as frame start, frame start etc.

Returns

$this

Definition at line 657 of file Pager.php.

    {
        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;
    }

_setFrameInitialized()

_setFrameInitialized (   $flag )

protected

Setter for flag _frameInitialized

Parameters

bool

$flag

Returns

$this

Definition at line 697 of file Pager.php.

    {
        $this->_frameInitialized = (bool)$flag;
        return $this;
    }

_toHtml()

_toHtml ( )

protected

Determine whether the pagination should be eventually rendered

Returns

string

Definition at line 756 of file Pager.php.

    {
        if ($this->_outputRequired || $this->getTotalNum() > $this->getLimit()) {
            return parent::_toHtml();
        }
        return '';
    }

canShowFirst()

canShowFirst

(

)

Whether to show first page in pagination or not

Returns

bool

Definition at line 617 of file Pager.php.

    {
        return $this->getJump() > 1 && $this->getFrameStart() > 1;
    }

canShowLast()

canShowLast

(

)

Whether to show last page in pagination or not

Returns

bool

Definition at line 627 of file Pager.php.

    {
        return $this->getJump() > 1 && $this->getFrameEnd() < $this->getLastPageNum();
    }

canShowNextJump()

canShowNextJump

(

)

Whether to show link to Next Jump

Returns

bool

Definition at line 647 of file Pager.php.

    {
        return $this->getNextJumpPage() !== null;
    }

canShowPreviousJump()

canShowPreviousJump

(

)

Whether to show link to Previous Jump

Returns

bool

Definition at line 637 of file Pager.php.

    {
        return $this->getPreviousJumpPage() !== null;
    }

getAnchorTextForNext()

getAnchorTextForNext

(

)

Getter for alternative text for Next link in pagination frame

Returns

string

Definition at line 731 of file Pager.php.

    {
        return $this->_scopeConfig->getValue(
            'design/pagination/anchor_text_for_next',
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        );
    }

getAnchorTextForPrevious()

getAnchorTextForPrevious

(

)

Getter for alternative text for Previous link in pagination frame

Returns

string

Definition at line 718 of file Pager.php.

    {
        return $this->_scopeConfig->getValue(
            'design/pagination/anchor_text_for_previous',
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        );
    }

getAvailableLimit()

getAvailableLimit

(

)

Retrieve pager limit

Returns

array

Definition at line 272 of file Pager.php.

    {
        return $this->_availableLimit;
    }

getCollection()

getCollection

(

)

Returns

\Magento\Framework\Data\Collection

Definition at line 189 of file Pager.php.

    {
        return $this->_collection;
    }

getCurrentPage()

getCurrentPage

(

)

Return current page

Returns

int

Definition at line 125 of file Pager.php.

    {
        if (is_object($this->_collection)) {
            return $this->_collection->getCurPage();
        }
        return (int)$this->getRequest()->getParam($this->getPageVarName(), 1);
    }

getFirstNum()

getFirstNum

(

)

Returns

int

Definition at line 280 of file Pager.php.

    {
        $collection = $this->getCollection();
        return $collection->getPageSize() * ($collection->getCurPage() - 1) + 1;
    }

getFirstPageUrl()

getFirstPageUrl

(

)

Returns

string

Definition at line 382 of file Pager.php.

    {
        return $this->getPageUrl(1);
    }

getFragment()

getFragment

(

)

Get the URL fragment

Returns

string|null

Definition at line 769 of file Pager.php.

    {
        return $this->_fragment;
    }

getFrameEnd()

getFrameEnd

(

)

Getter for $_frameEnd

Returns

int

Definition at line 479 of file Pager.php.

    {
        $this->_initFrame();
        return $this->_frameEnd;
    }

getFrameLength()

getFrameLength

(

)

Getter for $_frameLength

Returns

int

Definition at line 560 of file Pager.php.

    {
        return $this->_frameLength;
    }

getFramePages()

getFramePages

(

)

Return array of pages in frame

Returns

array

Definition at line 490 of file Pager.php.

    {
        $start = $this->getFrameStart();
        $end = $this->getFrameEnd();
        return range($start, $end);
    }

getFrameStart()

getFrameStart

(

)

Getter for $_frameStart

Returns

int

Definition at line 468 of file Pager.php.

    {
        $this->_initFrame();
        return $this->_frameStart;
    }

getJump()

getJump

(

)

Getter for $_jump

Returns

int

Definition at line 570 of file Pager.php.

    {
        return $this->_jump;
    }

getLastNum()

getLastNum

(

)

Returns

int

Definition at line 289 of file Pager.php.

    {
        $collection = $this->getCollection();
        return $collection->getPageSize() * ($collection->getCurPage() - 1) + $collection->count();
    }

getLastPageNum()

getLastPageNum

(

)

Retrieve number of last page

Returns

int

Definition at line 320 of file Pager.php.

    {
        return $this->getCollection()->getLastPageNumber();
    }

getLastPageUrl()

getLastPageUrl

(

)

Retrieve last page URL

Returns

string

Definition at line 412 of file Pager.php.

    {
        return $this->getPageUrl($this->getCollection()->getLastPageNumber());
    }

getLimit()

getLimit

(

)

Return current page limit

Returns

int

Definition at line 138 of file Pager.php.

    {
        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];
    }

getLimitUrl()

getLimitUrl

(

$limit

)

Parameters

int

$limit

Returns

string

Definition at line 432 of file Pager.php.

    {
        return $this->getPagerUrl([$this->getLimitVarName() => $limit]);
    }

getLimitVarName()

getLimitVarName

(

)

Retrieve name for pager limit data

Returns

string

Definition at line 250 of file Pager.php.

    {
        return $this->_limitVarName;
    }

getNextJumpPage()

getNextJumpPage

(

)

Return page number of Next jump

Returns

int|null

Definition at line 531 of file Pager.php.

    {
        if (!$this->getJump()) {
            return null;
        }

        $frameEnd = $this->getFrameEnd();
        if ($this->getLastPageNum() - $frameEnd > 1) {
            return min($this->getLastPageNum() - 1, $frameEnd + $this->getJump());
        }

        return null;
    }

getNextJumpUrl()

getNextJumpUrl

(

)

Prepare URL for Next Jump

Returns

string

Definition at line 550 of file Pager.php.

    {
        return $this->getPageUrl($this->getNextJumpPage());
    }

getNextPageUrl()

getNextPageUrl

(

)

Retrieve next page URL

Returns

string

Definition at line 402 of file Pager.php.

    {
        return $this->getPageUrl($this->getCollection()->getCurPage(+1));
    }

getPagerUrl()

getPagerUrl

(

$params = []

)

Retrieve page URL by defined parameters

Parameters

array

$params

Returns

string

Definition at line 443 of file Pager.php.

    {
        $urlParams = [];
        $urlParams['_current'] = true;
        $urlParams['_escape'] = true;
        $urlParams['_use_rewrite'] = true;
        $urlParams['_fragment'] = $this->getFragment();
        $urlParams['_query'] = $params;

        return $this->getUrl($this->getPath(), $urlParams);
    }

getPages()

getPages

(

)

Returns

array

Definition at line 356 of file Pager.php.

    {
        $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);
        }
    }

getPageUrl()

getPageUrl

(

$page

)

Retrieve page URL

Parameters

string

$page

Returns

string

Definition at line 423 of file Pager.php.

    {
        return $this->getPagerUrl([$this->getPageVarName() => $page]);
    }

getPageVarName()

getPageVarName

(

)

Returns

string

Definition at line 207 of file Pager.php.

    {
        return $this->_pageVarName;
    }

getPath()

getPath ( )

protected

Returns

string

Definition at line 458 of file Pager.php.

    {
        return $this->_getData('path') ?: '*/*/*';
    }

getPreviousJumpPage()

getPreviousJumpPage

(

)

Return page number of Previous jump

Returns

int|null

Definition at line 502 of file Pager.php.

    {
        if (!$this->getJump()) {
            return null;
        }

        $frameStart = $this->getFrameStart();
        if ($frameStart - 1 > 1) {
            return max(2, $frameStart - $this->getJump());
        }

        return null;
    }

getPreviousJumpUrl()

getPreviousJumpUrl

(

)

Prepare URL for Previous Jump

Returns

string

Definition at line 521 of file Pager.php.

    {
        return $this->getPageUrl($this->getPreviousJumpPage());
    }

getPreviousPageUrl()

getPreviousPageUrl

(

)

Retrieve previous page URL

Returns

string

Definition at line 392 of file Pager.php.

    {
        return $this->getPageUrl($this->getCollection()->getCurPage(-1));
    }

getTotalNum()

getTotalNum

(

)

Retrieve total number of pages

Returns

int

Definition at line 300 of file Pager.php.

    {
        return $this->getCollection()->getSize();
    }

isFirstPage()

isFirstPage

(

)

Check if current page is a first page in collection

Returns

bool

Definition at line 310 of file Pager.php.

    {
        return $this->getCollection()->getCurPage() == 1;
    }

isFrameInitialized()

isFrameInitialized

(

)

Check if frame data was initialized

Returns

bool

Definition at line 708 of file Pager.php.

    {
        return $this->_frameInitialized;
    }

isLastPage()

isLastPage

(

)

Check if current page is a last page in collection

Returns

bool

Definition at line 330 of file Pager.php.

    {
        return $this->getCollection()->getCurPage() >= $this->getLastPageNum();
    }

isLimitCurrent()

isLimitCurrent

(

$limit

)

Parameters

int

$limit

Returns

bool

Definition at line 339 of file Pager.php.

    {
        return $limit == $this->getLimit();
    }

isPageCurrent()

isPageCurrent

(

$page

)

Parameters

int

$page

Returns

bool

Definition at line 348 of file Pager.php.

    {
        return $page == $this->getCurrentPage();
    }

isShowPerPage()

isShowPerPage

(

)

Returns

bool

Definition at line 225 of file Pager.php.

    {
        if (sizeof($this->getAvailableLimit()) <= 1) {
            return false;
        }
        return $this->_showPerPage;
    }

setAvailableLimit()

setAvailableLimit

(

array

$limits

)

Set pager limit

Parameters

array

$limits

Returns

$this

Definition at line 261 of file Pager.php.

    {
        $this->_availableLimit = $limits;
        return $this;
    }

setCollection()

setCollection

(

$collection

)

Set collection for pagination

Parameters

\Magento\Framework\Data\Collection

$collection

Returns

$this

Definition at line 173 of file Pager.php.

    {
        $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;
    }

setFragment()

setFragment

(

$fragment

)

Set the URL fragment

Parameters

string | null

$fragment

Returns

$this

Definition at line 780 of file Pager.php.

    {
        $this->_fragment = $fragment;
        return $this;
    }

setFrameLength()

setFrameLength

(

$frame

)

Setter for $_frameLength

Parameters

int

$frame

Returns

$this

Definition at line 581 of file Pager.php.

    {
        $frame = abs(intval($frame));
        if ($frame == 0) {
            $frame = $this->_frameLength;
        }
        if ($this->getFrameLength() != $frame) {
            $this->_setFrameInitialized(false);
            $this->_frameLength = $frame;
        }

        return $this;
    }

setIsOutputRequired()

setIsOutputRequired

(

$isRequired

)

Set whether output of the pager is mandatory

Parameters

bool

$isRequired

Returns

$this

Definition at line 745 of file Pager.php.

    {
        $this->_outputRequired = (bool)$isRequired;
        return $this;
    }

setJump()

setJump

(

$jump

)

Setter for $_jump

Parameters

int

$jump

Returns

$this

Definition at line 601 of file Pager.php.

    {
        $jump = abs(intval($jump));
        if ($this->getJump() != $jump) {
            $this->_setFrameInitialized(false);
            $this->_jump = $jump;
        }

        return $this;
    }

setLimit()

setLimit

(

$limit

)

Setter for limit items per page

Parameters

int

$limit

Returns

$this

Definition at line 161 of file Pager.php.

    {
        $this->_limit = $limit;
        return $this;
    }

setLimitVarName()

setLimitVarName

(

$varName

)

Set the name for pager limit data

Parameters

string

$varName

Returns

$this

Definition at line 239 of file Pager.php.

    {
        $this->_limitVarName = $varName;
        return $this;
    }

setPageVarName()

setPageVarName

(

$varName

)

Parameters

string

$varName

Returns

$this

Definition at line 198 of file Pager.php.

    {
        $this->_pageVarName = $varName;
        return $this;
    }

setShowPerPage()

setShowPerPage

(

$varName

)

Parameters

bool

$varName

Returns

$this

Definition at line 216 of file Pager.php.

    {
        $this->_showPerPage = $varName;
        return $this;
    }

Field Documentation

$_availableLimit

$_availableLimit = [10 => 10, 20 => 20, 50 => 50]

protected

Definition at line 44 of file Pager.php.

$_collection

$_collection

protected

Definition at line 27 of file Pager.php.

$_displayPages

$_displayPages = 5

protected

Definition at line 49 of file Pager.php.

$_fragment

$_fragment = null

protected

Definition at line 106 of file Pager.php.

$_frameEnd

$_frameEnd

protected

Definition at line 99 of file Pager.php.

$_frameInitialized

$_frameInitialized = false

protected

Definition at line 85 of file Pager.php.

$_frameLength

$_frameLength = 5

protected

Definition at line 71 of file Pager.php.

$_frameStart

$_frameStart

protected

Definition at line 92 of file Pager.php.

$_jump

$_jump = 5

protected

Definition at line 78 of file Pager.php.

$_limit

$_limit

protected

Definition at line 59 of file Pager.php.

$_limitVarName

$_limitVarName = 'limit'

protected

Definition at line 37 of file Pager.php.

$_outputRequired

$_outputRequired = true

protected

Definition at line 64 of file Pager.php.

$_pageVarName

$_pageVarName = 'p'

protected

Definition at line 32 of file Pager.php.

$_showPerPage

$_showPerPage = true

protected

Definition at line 54 of file Pager.php.

$_template

$_template = 'Magento_Theme::html/pager.phtml'

protected

Definition at line 22 of file Pager.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-theme/Block/Html/Pager.php