Class Mage_Catalog_Block_Product_List_Toolbar_Pager

Description
Description | Vars (details) | Methods (details) Constants

Product list pagination

Located in /Catalog/Block/Product/List/Toolbar/Pager.php (line 34) 

Varien_Object
   |
   --Mage_Core_Block_Abstract
      |
      --Mage_Core_Block_Template
         |
         --Mage_Page_Block_Html_Pager
            |
            --Mage_Catalog_Block_Product_List_Toolbar_Pager
Variable Summary
Description | Vars (details) | Methods (details) Constants
int $_frameEnd
bool $_frameInitialized
int $_frameLength
int $_frameStart
int $_jump
int $_limit
Method Summary
Description | Constants Vars (details) | Methods (details)
bool canShowFirst ()
bool canShowLast ()
bool canShowNextJump ()
bool canShowPreviousJump ()
int getFrameEnd ()
int getFrameLength ()
array getFramePages ()
int getFrameStart ()
int getJump ()
int getLimit ()
int getNextJumpPage ()
string getNextJumpUrl ()
int getPreviousJumpPage ()
string getPreviousJumpUrl ()
Mage_Catalog_Block_Product_List_Toolbar_Pager isFrameInitialized ()
Mage_Catalog_Block_Product_List_Toolbar_Pager setCollection (Varien_Data_Collection $collection)
Mage_Catalog_Block_Product_List_Toolbar_Pager setFrameLength (int $frame)
Mage_Catalog_Block_Product_List_Toolbar_Pager setJump (int $jump)
Mage_Catalog_Block_Product_List_Toolbar_Pager setLimit (int $limit)
void _construct ()
Mage_Catalog_Block_Product_List_Toolbar_Pager _initFrame ()
Mage_Catalog_Block_Product_List_Toolbar_Pager _setFrameInitialized (bool $flag)
string _toHtml ()
Variables
Description | Vars (details) Constants | Methods (details)
int $_frameEnd (line 64)

Finish page position in frame

  • access: protected
Redefinition of:
Mage_Page_Block_Html_Pager::$_frameEnd
Finish page position in frame
bool $_frameInitialized = false (line 52)

Frame initialization flag

  • access: protected
Redefinition of:
Mage_Page_Block_Html_Pager::$_frameInitialized
Frame initialization flag
int $_frameLength = 5 (line 40)

Pages quantity per frame

  • access: protected
Redefinition of:
Mage_Page_Block_Html_Pager::$_frameLength
Pages quantity per frame
int $_frameStart (line 58)

Start page position in frame

  • access: protected
Redefinition of:
Mage_Page_Block_Html_Pager::$_frameStart
Start page position in frame
int $_jump = 5 (line 46)

Next/previous page position relatively to the current frame

  • access: protected
Redefinition of:
Mage_Page_Block_Html_Pager::$_jump
Next/previous page position relatively to the current frame
int $_limit (line 70)

Custom limit

  • access: protected
Redefinition of:
Mage_Page_Block_Html_Pager::$_limit

Inherited Variables

Inherited from Mage_Page_Block_Html_Pager

Mage_Page_Block_Html_Pager::$_availableLimit
 Mage_Page_Block_Html_Pager::$_collection
 Mage_Page_Block_Html_Pager::$_dispersion
 Mage_Page_Block_Html_Pager::$_displayPages
 Mage_Page_Block_Html_Pager::$_limitVarName
 Mage_Page_Block_Html_Pager::$_outputRequired
 Mage_Page_Block_Html_Pager::$_pageVarName
 Mage_Page_Block_Html_Pager::$_showPerPage

Inherited from Mage_Core_Block_Template

Mage_Core_Block_Template::$_baseUrl
 Mage_Core_Block_Template::$_jsUrl
 Mage_Core_Block_Template::$_showTemplateHints
 Mage_Core_Block_Template::$_showTemplateHintsBlocks
 Mage_Core_Block_Template::$_template
 Mage_Core_Block_Template::$_viewDir
 Mage_Core_Block_Template::$_viewVars

Inherited from Mage_Core_Block_Abstract

Mage_Core_Block_Abstract::$_alias
 Mage_Core_Block_Abstract::$_anonSuffix
 Mage_Core_Block_Abstract::$_childGroups
 Mage_Core_Block_Abstract::$_children
 Mage_Core_Block_Abstract::$_childrenHtmlCache
 Mage_Core_Block_Abstract::$_frameCloseTag
 Mage_Core_Block_Abstract::$_frameOpenTag
 Mage_Core_Block_Abstract::$_isAnonymous
 Mage_Core_Block_Abstract::$_layout
 Mage_Core_Block_Abstract::$_messagesBlock
 Mage_Core_Block_Abstract::$_nameInLayout
 Mage_Core_Block_Abstract::$_parent
 Mage_Core_Block_Abstract::$_parentBlock
 Mage_Core_Block_Abstract::$_request
 Mage_Core_Block_Abstract::$_sortedChildren
 Mage_Core_Block_Abstract::$_urlModel
Methods
Description | Vars (details) Constants Methods (details)
canShowFirst (line 268)

Whether to show first page in pagination or not

  • access: public
bool canShowFirst ()
Redefinition of:
Mage_Page_Block_Html_Pager::canShowFirst()
Whether to show first page in pagination or not
canShowLast (line 278)

Whether to show last page in pagination or not

  • access: public
bool canShowLast ()
Redefinition of:
Mage_Page_Block_Html_Pager::canShowLast()
Whether to show last page in pagination or not
canShowNextJump (line 298)

Whether to show link to Next Jump

  • access: public
bool canShowNextJump ()
Redefinition of:
Mage_Page_Block_Html_Pager::canShowNextJump()
Whether to show link to Next Jump
canShowPreviousJump (line 288)

Whether to show link to Previous Jump

  • access: public
bool canShowPreviousJump ()
Redefinition of:
Mage_Page_Block_Html_Pager::canShowPreviousJump()
Whether to show link to Previous Jump
getFrameEnd (line 97)

Getter for $_frameEnd

  • access: public
int getFrameEnd ()
Redefinition of:
Mage_Page_Block_Html_Pager::getFrameEnd()
Getter for $_frameEnd
getFrameLength (line 176)

Getter for $_frameLength

  • access: public
int getFrameLength ()
Redefinition of:
Mage_Page_Block_Html_Pager::getFrameLength()
Getter for $_frameLength
getFramePages (line 108)

Return array of pages in frame

  • access: public
array getFramePages ()
Redefinition of:
Mage_Page_Block_Html_Pager::getFramePages()
Return array of pages in frame
getFrameStart (line 86)

Getter for $_frameStart

  • access: public
int getFrameStart ()
Redefinition of:
Mage_Page_Block_Html_Pager::getFrameStart()
Getter for $_frameStart
getJump (line 186)

Getter for $_jump

  • access: public
int getJump ()
Redefinition of:
Mage_Page_Block_Html_Pager::getJump()
Getter for $_jump
getLimit (line 242)

Return pager limitation from request or as assigned value

  • access: public
int getLimit ()
Redefinition of:
Mage_Page_Block_Html_Pager::getLimit()
getNextJumpPage (line 148)

Return page number of Next jump

  • access: public
int getNextJumpPage ()
Redefinition of:
Mage_Page_Block_Html_Pager::getNextJumpPage()
Return page number of Next jump
getNextJumpUrl (line 166)

Prepare URL for Next Jump

  • access: public
string getNextJumpUrl ()
Redefinition of:
Mage_Page_Block_Html_Pager::getNextJumpUrl()
Prepare URL for Next Jump
getPreviousJumpPage (line 120)

Return page number of Previous jump

  • access: public
int getPreviousJumpPage ()
Redefinition of:
Mage_Page_Block_Html_Pager::getPreviousJumpPage()
Return page number of Previous jump
getPreviousJumpUrl (line 138)

Prepare URL for Previous Jump

  • access: public
string getPreviousJumpUrl ()
Redefinition of:
Mage_Page_Block_Html_Pager::getPreviousJumpUrl()
Prepare URL for Previous Jump
isFrameInitialized (line 361)

Check if frame data was initialized

  • access: public
Mage_Catalog_Block_Product_List_Toolbar_Pager isFrameInitialized ()
Redefinition of:
Mage_Page_Block_Html_Pager::isFrameInitialized()
Check if frame data was initialized
setCollection (line 256)

Custom setter for pager collection

  • access: public
Mage_Catalog_Block_Product_List_Toolbar_Pager setCollection (Varien_Data_Collection $collection)
  • Varien_Data_Collection $collection
Redefinition of:
Mage_Page_Block_Html_Pager::setCollection()
setFrameLength (line 197)

Setter for $_frameLength

  • access: public
Mage_Catalog_Block_Product_List_Toolbar_Pager setFrameLength (int $frame)
  • int $frame
Redefinition of:
Mage_Page_Block_Html_Pager::setFrameLength()
Setter for $_frameLength
setJump (line 214)

Setter for $_jump

  • access: public
Mage_Catalog_Block_Product_List_Toolbar_Pager setJump (int $jump)
  • int $jump
Redefinition of:
Mage_Page_Block_Html_Pager::setJump()
Setter for $_jump
setLimit (line 231)

Setter for $_limit

  • access: public
Mage_Catalog_Block_Product_List_Toolbar_Pager setLimit (int $limit)
  • int $limit
Redefinition of:
Mage_Page_Block_Html_Pager::setLimit()
Setter for limit items per page
_construct (line 75)

Define default template and settings

  • access: protected
void _construct ()
Redefinition of:
Mage_Page_Block_Html_Pager::_construct()
_initFrame (line 308)

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

  • access: protected
Mage_Catalog_Block_Product_List_Toolbar_Pager _initFrame ()
Redefinition of:
Mage_Page_Block_Html_Pager::_initFrame()
Initialize frame data, such as frame start, frame start etc.
_setFrameInitialized (line 350)

Setter for flag _frameInitialized

  • access: protected
Mage_Catalog_Block_Product_List_Toolbar_Pager _setFrameInitialized (bool $flag)
  • bool $flag
Redefinition of:
Mage_Page_Block_Html_Pager::_setFrameInitialized()
Setter for flag _frameInitialized
_toHtml (line 371)

Render block HTML

  • access: protected
string _toHtml ()
Redefinition of:
Mage_Page_Block_Html_Pager::_toHtml()
Determine whether the pagination should be eventually rendered

Inherited Methods

Inherited From Mage_Page_Block_Html_Pager

Mage_Page_Block_Html_Pager::canShowFirst()
Mage_Page_Block_Html_Pager::canShowLast()
Mage_Page_Block_Html_Pager::canShowNextJump()
Mage_Page_Block_Html_Pager::canShowPreviousJump()
Mage_Page_Block_Html_Pager::getAnchorTextForNext()
Mage_Page_Block_Html_Pager::getAnchorTextForPrevious()
Mage_Page_Block_Html_Pager::getAvailableLimit()
Mage_Page_Block_Html_Pager::getCollection()
Mage_Page_Block_Html_Pager::getCurrentPage()
Mage_Page_Block_Html_Pager::getFirstNum()
Mage_Page_Block_Html_Pager::getFirstPageUrl()
Mage_Page_Block_Html_Pager::getFrameEnd()
Mage_Page_Block_Html_Pager::getFrameLength()
Mage_Page_Block_Html_Pager::getFramePages()
Mage_Page_Block_Html_Pager::getFrameStart()
Mage_Page_Block_Html_Pager::getJump()
Mage_Page_Block_Html_Pager::getLastNum()
Mage_Page_Block_Html_Pager::getLastPageNum()
Mage_Page_Block_Html_Pager::getLastPageUrl()
Mage_Page_Block_Html_Pager::getLimit()
Mage_Page_Block_Html_Pager::getLimitUrl()
Mage_Page_Block_Html_Pager::getLimitVarName()
Mage_Page_Block_Html_Pager::getNextJumpPage()
Mage_Page_Block_Html_Pager::getNextJumpUrl()
Mage_Page_Block_Html_Pager::getNextPageUrl()
Mage_Page_Block_Html_Pager::getPagerUrl()
Mage_Page_Block_Html_Pager::getPages()
Mage_Page_Block_Html_Pager::getPageUrl()
Mage_Page_Block_Html_Pager::getPageVarName()
Mage_Page_Block_Html_Pager::getPreviousJumpPage()
Mage_Page_Block_Html_Pager::getPreviousJumpUrl()
Mage_Page_Block_Html_Pager::getPreviousPageUrl()
Mage_Page_Block_Html_Pager::getShowPerPage()
Mage_Page_Block_Html_Pager::getTotalNum()
Mage_Page_Block_Html_Pager::isFirstPage()
Mage_Page_Block_Html_Pager::isFrameInitialized()
Mage_Page_Block_Html_Pager::isLastPage()
Mage_Page_Block_Html_Pager::isLimitCurrent()
Mage_Page_Block_Html_Pager::isPageCurrent()
Mage_Page_Block_Html_Pager::setAvailableLimit()
Mage_Page_Block_Html_Pager::setCollection()
Mage_Page_Block_Html_Pager::setFrameLength()
Mage_Page_Block_Html_Pager::setIsOutputRequired()
Mage_Page_Block_Html_Pager::setJump()
Mage_Page_Block_Html_Pager::setLimit()
Mage_Page_Block_Html_Pager::setLimitVarName()
Mage_Page_Block_Html_Pager::setPageVarName()
Mage_Page_Block_Html_Pager::setShowPerPage()
Mage_Page_Block_Html_Pager::_construct()
Mage_Page_Block_Html_Pager::_initFrame()
Mage_Page_Block_Html_Pager::_setFrameInitialized()
Mage_Page_Block_Html_Pager::_toHtml()

Inherited From Mage_Core_Block_Template

Mage_Core_Block_Template::assign()
Mage_Core_Block_Template::fetchView()
Mage_Core_Block_Template::getArea()
Mage_Core_Block_Template::getBaseUrl()
Mage_Core_Block_Template::getCacheKeyInfo()
Mage_Core_Block_Template::getDirectOutput()
Mage_Core_Block_Template::getJsUrl()
Mage_Core_Block_Template::getObjectData()
Mage_Core_Block_Template::getShowTemplateHints()
Mage_Core_Block_Template::getTemplate()
Mage_Core_Block_Template::getTemplateFile()
Mage_Core_Block_Template::renderView()
Mage_Core_Block_Template::setScriptPath()
Mage_Core_Block_Template::setTemplate()
Mage_Core_Block_Template::_construct()
Mage_Core_Block_Template::_toHtml()

Inherited From Mage_Core_Block_Abstract

Mage_Core_Block_Abstract::addToChildGroup()
Mage_Core_Block_Abstract::addToParentGroup()
Mage_Core_Block_Abstract::append()
Mage_Core_Block_Abstract::countChildren()
Mage_Core_Block_Abstract::escapeHtml()
Mage_Core_Block_Abstract::escapeUrl()
Mage_Core_Block_Abstract::formatDate()
Mage_Core_Block_Abstract::formatTime()
Mage_Core_Block_Abstract::getAction()
Mage_Core_Block_Abstract::getAnonSuffix()
Mage_Core_Block_Abstract::getBlockAlias()
Mage_Core_Block_Abstract::getBlockHtml()
Mage_Core_Block_Abstract::getCacheKey()
Mage_Core_Block_Abstract::getCacheKeyInfo()
Mage_Core_Block_Abstract::getCacheLifetime()
Mage_Core_Block_Abstract::getCacheTags()
Mage_Core_Block_Abstract::getChild()
Mage_Core_Block_Abstract::getChildChildHtml()
Mage_Core_Block_Abstract::getChildData()
Mage_Core_Block_Abstract::getChildGroup()
Mage_Core_Block_Abstract::getChildHtml()
Mage_Core_Block_Abstract::getHelper()
Mage_Core_Block_Abstract::getIsAnonymous()
Mage_Core_Block_Abstract::getLayout()
Mage_Core_Block_Abstract::getMessagesBlock()
Mage_Core_Block_Abstract::getModuleName()
Mage_Core_Block_Abstract::getNameInLayout()
Mage_Core_Block_Abstract::getParentBlock()
Mage_Core_Block_Abstract::getRequest()
Mage_Core_Block_Abstract::getSkinUrl()
Mage_Core_Block_Abstract::getSortedChildBlocks()
Mage_Core_Block_Abstract::getSortedChildren()
Mage_Core_Block_Abstract::getUrl()
Mage_Core_Block_Abstract::getUrlBase64()
Mage_Core_Block_Abstract::getUrlEncoded()
Mage_Core_Block_Abstract::helper()
Mage_Core_Block_Abstract::htmlEscape()
Mage_Core_Block_Abstract::insert()
Mage_Core_Block_Abstract::jsQuoteEscape()
Mage_Core_Block_Abstract::setAnonSuffix()
Mage_Core_Block_Abstract::setAttribute()
Mage_Core_Block_Abstract::setBlockAlias()
Mage_Core_Block_Abstract::setChild()
Mage_Core_Block_Abstract::setFrameTags()
Mage_Core_Block_Abstract::setIsAnonymous()
Mage_Core_Block_Abstract::setLayout()
Mage_Core_Block_Abstract::setMessagesBlock()
Mage_Core_Block_Abstract::setNameInLayout()
Mage_Core_Block_Abstract::setParentBlock()
Mage_Core_Block_Abstract::stripTags()
Mage_Core_Block_Abstract::toHtml()
Mage_Core_Block_Abstract::unsetCallChild()
Mage_Core_Block_Abstract::unsetChild()
Mage_Core_Block_Abstract::unsetChildren()
Mage_Core_Block_Abstract::urlEscape()
Mage_Core_Block_Abstract::_afterCacheUrl()
Mage_Core_Block_Abstract::_afterToHtml()
Mage_Core_Block_Abstract::_beforeCacheUrl()
Mage_Core_Block_Abstract::_beforeChildToHtml()
Mage_Core_Block_Abstract::_beforeToHtml()
Mage_Core_Block_Abstract::_construct()
Mage_Core_Block_Abstract::_getChildHtml()
Mage_Core_Block_Abstract::_getUrlModel()
Mage_Core_Block_Abstract::_getUrlModelClass()
Mage_Core_Block_Abstract::_loadCache()
Mage_Core_Block_Abstract::_prepareLayout()
Mage_Core_Block_Abstract::_saveCache()
Mage_Core_Block_Abstract::_toHtml()
Mage_Core_Block_Abstract::__()
Class Constants
Description | Constants (details) Vars (details) | Methods (details)

Inherited Constants

Inherited from Mage_Core_Block_Abstract

Mage_Core_Block_Abstract::CACHE_GROUP

Documentation generated on Fri, 11 Feb 2011 17:09:35 +0200 by phpDocumentor 1.4.3