Class Mage_Page_Block_Html_Pager

Description

Html page block

Located in /Page/Block/Html/Pager.php (line 36)

Varien_Object
   |
   --Mage_Core_Block_Abstract
      |
      --Mage_Core_Block_Template
         |
         --Mage_Page_Block_Html_Pager
Direct descendents
Class Description
Mage_Catalog_Block_Seo_Sitemap_Tree_Pager Html page block
Mage_Catalog_Block_Product_List_Toolbar_Pager Product list pagination
Variable Summary
Method Summary
bool canShowFirst ()
bool canShowLast ()
bool canShowNextJump ()
void getCurrentPage ()
void getFirstNum ()
void getFirstPageUrl ()
int getFrameEnd ()
array getFramePages ()
int getFrameStart ()
int getJump ()
void getLastNum ()
void getLastPageNum ()
void getLastPageUrl ()
void getLimit ()
void getLimitUrl ( $limit)
void getLimitVarName ()
string getNextJumpUrl ()
void getNextPageUrl ()
void getPagerUrl ([ $params = array()])
void getPages ()
void getPageUrl ( $page)
void getPageVarName ()
string getPreviousJumpUrl ()
void getShowPerPage ()
void getTotalNum ()
void isFirstPage ()
void isLastPage ()
void isLimitCurrent ( $limit)
void isPageCurrent ( $page)
void setAvailableLimit ( $limits)
void setCollection ( $collection)
void setLimitVarName ( $varName)
void setPageVarName ( $varName)
void setShowPerPage ( $varName)
void _construct ()
string _toHtml ()
Variables
mixed $_availableLimit = array(10=>10,20=>20,50=>50) (line 41)
  • access: protected
mixed $_collection = null (line 38)
  • access: protected
mixed $_dispersion = 3 (line 42)
  • access: protected
mixed $_displayPages = 5 (line 43)
  • access: protected
int $_frameEnd (line 76)

Finish page position in frame

  • access: protected

Redefined in descendants as:
bool $_frameInitialized = false (line 64)

Frame initialization flag

  • access: protected

Redefined in descendants as:
int $_frameLength = 5 (line 52)

Pages quantity per frame

  • access: protected

Redefined in descendants as:
int $_frameStart (line 70)

Start page position in frame

  • access: protected

Redefined in descendants as:
int $_jump = 5 (line 58)

Next/previous page position relatively to the current frame

  • access: protected

Redefined in descendants as:
mixed $_limit = null (line 45)
  • access: protected

Redefined in descendants as:
mixed $_limitVarName = 'limit' (line 40)
  • access: protected
mixed $_outputRequired = true (line 46)
  • access: protected
mixed $_pageVarName = 'p' (line 39)
  • access: protected
mixed $_showPerPage = true (line 44)
  • access: protected

Redefined in descendants as:

Inherited Variables

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
canShowFirst (line 451)

Whether to show first page in pagination or not

  • access: public
bool canShowFirst ()

Redefined in descendants as:
canShowLast (line 461)

Whether to show last page in pagination or not

  • access: public
bool canShowLast ()

Redefined in descendants as:
canShowNextJump (line 481)

Whether to show link to Next Jump

  • access: public
bool canShowNextJump ()

Redefined in descendants as:
canShowPreviousJump (line 471)

Whether to show link to Previous Jump

  • access: public
bool canShowPreviousJump ()

Redefined in descendants as:
getAnchorTextForNext (line 563)

Getter for alternative text for Next link in pagination frame

  • access: public
string getAnchorTextForNext ()
getAnchorTextForPrevious (line 553)

Getter for alternative text for Previous link in pagination frame

  • access: public
string getAnchorTextForPrevious ()
getAvailableLimit (line 184)
  • access: public
void getAvailableLimit ()
getCollection (line 138)
  • access: public

Redefined in descendants as:
getCurrentPage (line 86)
  • access: public
void getCurrentPage ()

Redefined in descendants as:
getFirstNum (line 189)
  • access: public
void getFirstNum ()

Redefined in descendants as:
getFirstPageUrl (line 259)
  • access: public
void getFirstPageUrl ()
getFrameEnd (line 315)

Getter for $_frameEnd

  • access: public
int getFrameEnd ()

Redefined in descendants as:
getFrameLength (line 394)

Getter for $_frameLength

  • access: public
int getFrameLength ()

Redefined in descendants as:
getFramePages (line 326)

Return array of pages in frame

  • access: public
array getFramePages ()

Redefined in descendants as:
getFrameStart (line 304)

Getter for $_frameStart

  • access: public
int getFrameStart ()

Redefined in descendants as:
getJump (line 404)

Getter for $_jump

  • access: public
int getJump ()

Redefined in descendants as:
getLastNum (line 195)
  • access: public
void getLastNum ()

Redefined in descendants as:
getLastPageNum (line 211)
  • access: public
void getLastPageNum ()

Redefined in descendants as:
getLastPageUrl (line 274)
  • access: public
void getLastPageUrl ()

Redefined in descendants as:
getLimit (line 94)
  • access: public
void getLimit ()

Redefined in descendants as:
getLimitUrl (line 284)
  • access: public
void getLimitUrl ( $limit)
  • $limit
getLimitVarName (line 174)
  • access: public
void getLimitVarName ()
getNextJumpPage (line 366)

Return page number of Next jump

  • access: public
int getNextJumpPage ()

Redefined in descendants as:
getNextJumpUrl (line 384)

Prepare URL for Next Jump

  • access: public
string getNextJumpUrl ()

Redefined in descendants as:
getNextPageUrl (line 269)
  • access: public
void getNextPageUrl ()

Redefined in descendants as:
getPagerUrl (line 289)
  • access: public
void getPagerUrl ([ $params = array()])
  • $params
getPages (line 231)
  • access: public
void getPages ()

Redefined in descendants as:
getPageUrl (line 279)
  • access: public
void getPageUrl ( $page)
  • $page
getPageVarName (line 149)
  • access: public
void getPageVarName ()
getPreviousJumpPage (line 338)

Return page number of Previous jump

  • access: public
int getPreviousJumpPage ()

Redefined in descendants as:
getPreviousJumpUrl (line 356)

Prepare URL for Previous Jump

  • access: public
string getPreviousJumpUrl ()

Redefined in descendants as:
getPreviousPageUrl (line 264)
  • access: public
void getPreviousPageUrl ()

Redefined in descendants as:
getShowPerPage (line 160)
  • access: public
void getShowPerPage ()
getTotalNum (line 201)
  • access: public
void getTotalNum ()

Redefined in descendants as:
isFirstPage (line 206)
  • access: public
void isFirstPage ()

Redefined in descendants as:
isFrameInitialized (line 543)

Check if frame data was initialized

  • access: public
Mage_Page_Block_Html_Pager isFrameInitialized ()

Redefined in descendants as:
isLastPage (line 216)
  • access: public
void isLastPage ()

Redefined in descendants as:
isLimitCurrent (line 221)
  • access: public
void isLimitCurrent ( $limit)
  • $limit
isPageCurrent (line 226)
  • access: public
void isPageCurrent ( $page)
  • $page
setAvailableLimit (line 179)
  • access: public
void setAvailableLimit ( $limits)
  • array $limits
setCollection (line 121)
  • access: public
void setCollection ( $collection)
  • $collection

Redefined in descendants as:
setFrameLength (line 415)

Setter for $_frameLength

  • access: public
Mage_Page_Block_Html_Pager setFrameLength (int $frame)
  • int $frame

Redefined in descendants as:
setIsOutputRequired (line 574)

Set whether output of the pager is mandatory

  • access: public
Mage_Page_Block_Html_Pager setIsOutputRequired (bool $isRequired)
  • bool $isRequired
setJump (line 435)

Setter for $_jump

  • access: public
Mage_Page_Block_Html_Pager setJump (int $jump)
  • int $jump

Redefined in descendants as:
setLimit (line 115)

Setter for limit items per page

  • access: public
Mage_Page_Block_Html_Pager setLimit (int $limit)
  • int $limit

Redefined in descendants as:
setLimitVarName (line 168)
  • access: public
void setLimitVarName ( $varName)
  • $varName
setPageVarName (line 143)
  • access: public
void setPageVarName ( $varName)
  • $varName
setShowPerPage (line 154)
  • access: public
void setShowPerPage ( $varName)
  • $varName
_construct (line 78)
  • access: protected
void _construct ()

Redefinition of:
Mage_Core_Block_Template::_construct()
Internal constructor, that is called from real constructor

Redefined in descendants as:
_initFrame (line 491)

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

  • access: protected

Redefined in descendants as:
_setFrameInitialized (line 532)

Setter for flag _frameInitialized

  • access: protected
Mage_Page_Block_Html_Pager _setFrameInitialized (bool $flag)
  • bool $flag

Redefined in descendants as:
_toHtml (line 585)

Determine whether the pagination should be eventually rendered

  • access: protected
string _toHtml ()

Redefinition of:
Mage_Core_Block_Template::_toHtml()
Render block HTML

Redefined in descendants as:

Inherited Methods

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

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