Class Mage_Page_Block_Html_Pager

Html page block

Varien_Object

Mage_Core_Block_Abstract

Mage_Core_Block_Template

Mage_Page_Block_Html_Pager

Direct known subclasses

Mage_Catalog_Block_Seo_Sitemap_Tree_Pager

Package: Mage\Page
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Page/Block/Html/Pager.php

Methods summary
`protected`	# `_construct( )` Internal constructor, that is called from real constructor Internal constructor, that is called from real constructor Overrides `Mage_Core_Block_Template::_construct()`
`public`	# `getCurrentPage( )`
`public`	# `getLimit( )`
`public Mage_Page_Block_Html_Pager`	# `setLimit( integer $limit )` Setter for limit items per page Setter for limit items per page Parameters `$limit` `integer` $limit Returns `Mage_Page_Block_Html_Pager`
`public`	# `setCollection( mixed $collection )`
`public Mage_Core_Model_Mysql4_Collection_Abstract`	# `getCollection( )` Returns `Mage_Core_Model_Mysql4_Collection_Abstract`
`public`	# `setPageVarName( mixed $varName )`
`public`	# `getPageVarName( )`
`public`	# `setShowPerPage( mixed $varName )`
`public`	# `getShowPerPage( )`
`public`	# `setLimitVarName( mixed $varName )`
`public`	# `getLimitVarName( )`
`public`	# `setAvailableLimit( array $limits )`
`public`	# `getAvailableLimit( )`
`public`	# `getFirstNum( )`
`public`	# `getLastNum( )`
`public`	# `getTotalNum( )`
`public`	# `isFirstPage( )`
`public`	# `getLastPageNum( )`
`public`	# `isLastPage( )`
`public`	# `isLimitCurrent( mixed $limit )`
`public`	# `isPageCurrent( mixed $page )`
`public`	# `getPages( )`
`public`	# `getFirstPageUrl( )`
`public`	# `getPreviousPageUrl( )`
`public`	# `getNextPageUrl( )`
`public`	# `getLastPageUrl( )`
`public`	# `getPageUrl( mixed $page )`
`public`	# `getLimitUrl( mixed $limit )`
`public`	# `getPagerUrl( mixed $params = array() )`
`public integer`	# `getFrameStart( )` Getter for $_frameStart Getter for $_frameStart Returns `integer`
`public integer`	# `getFrameEnd( )` Getter for $_frameEnd Getter for $_frameEnd Returns `integer`
`public array`	# `getFramePages( )` Return array of pages in frame Return array of pages in frame Returns `array`
`public integer`	# `getPreviousJumpPage( )` Return page number of Previous jump Return page number of Previous jump Returns `integer`
`public string`	# `getPreviousJumpUrl( )` Prepare URL for Previous Jump Prepare URL for Previous Jump Returns `string`
`public integer`	# `getNextJumpPage( )` Return page number of Next jump Return page number of Next jump Returns `integer`
`public string`	# `getNextJumpUrl( )` Prepare URL for Next Jump Prepare URL for Next Jump Returns `string`
`public integer`	# `getFrameLength( )` Getter for $_frameLength Getter for $_frameLength Returns `integer`
`public integer`	# `getJump( )` Getter for $_jump Getter for $_jump Returns `integer`
`public Mage_Page_Block_Html_Pager`	# `setFrameLength( integer $frame )` Setter for $_frameLength Setter for $_frameLength Parameters `$frame` `integer` $frame Returns `Mage_Page_Block_Html_Pager`
`public Mage_Page_Block_Html_Pager`	# `setJump( integer $jump )` Setter for $_jump Setter for $_jump Parameters `$jump` `integer` $jump Returns `Mage_Page_Block_Html_Pager`
`public boolean`	# `canShowFirst( )` Whether to show first page in pagination or not Whether to show first page in pagination or not Returns `boolean`
`public boolean`	# `canShowLast( )` Whether to show last page in pagination or not Whether to show last page in pagination or not Returns `boolean`
`public boolean`	# `canShowPreviousJump( )` Whether to show link to Previous Jump Whether to show link to Previous Jump Returns `boolean`
`public boolean`	# `canShowNextJump( )` Whether to show link to Next Jump Whether to show link to Next Jump Returns `boolean`
`protected Mage_Page_Block_Html_Pager`	# `_initFrame( )` Initialize frame data, such as frame start, frame start etc. Initialize frame data, such as frame start, frame start etc. Returns `Mage_Page_Block_Html_Pager`
`protected Mage_Page_Block_Html_Pager`	# `_setFrameInitialized( boolean $flag )` Setter for flag _frameInitialized Setter for flag _frameInitialized Parameters `$flag` `boolean` $flag Returns `Mage_Page_Block_Html_Pager`
`public Mage_Page_Block_Html_Pager`	# `isFrameInitialized( )` Check if frame data was initialized Check if frame data was initialized Returns `Mage_Page_Block_Html_Pager`
`public string`	# `getAnchorTextForPrevious( )` Getter for alternative text for Previous link in pagination frame Getter for alternative text for Previous link in pagination frame Returns `string`
`public string`	# `getAnchorTextForNext( )` Getter for alternative text for Next link in pagination frame Getter for alternative text for Next link in pagination frame Returns `string`
`public Mage_Page_Block_Html_Pager`	# `setIsOutputRequired( boolean $isRequired )` Set whether output of the pager is mandatory Set whether output of the pager is mandatory Parameters `$isRequired` `boolean` $isRequired Returns `Mage_Page_Block_Html_Pager`
`protected string`	# `_toHtml( )` Determine whether the pagination should be eventually rendered Determine whether the pagination should be eventually rendered Returns `string` Overrides `Mage_Core_Block_Template::_toHtml()`

Methods inherited from Mage_Core_Block_Template
`_getAllowSymlinks(), assign(), fetchView(), getArea(), getBaseUrl(), getCacheKeyInfo(), getDirectOutput(), getJsUrl(), getObjectData(), getShowTemplateHints(), getTemplate(), getTemplateFile(), renderView(), setScriptPath(), setTemplate()`

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

Constants inherited from Mage_Core_Block_Template
`XML_PATH_DEBUG_TEMPLATE_HINTS, XML_PATH_DEBUG_TEMPLATE_HINTS_BLOCKS, XML_PATH_TEMPLATE_ALLOW_SYMLINK`

Constants inherited from Mage_Core_Block_Abstract
`CACHE_GROUP`

Properties summary
`protected mixed`	`$_collection`	`null`	#
`protected string`	`$_pageVarName`	`'p'`	#
`protected string`	`$_limitVarName`	`'limit'`	#
`protected array`	`$_availableLimit`	`array(10=>10,20=>20,50=>50)`	#
`protected integer`	`$_dispersion`	`3`	#
`protected integer`	`$_displayPages`	`5`	#
`protected boolean`	`$_showPerPage`	`true`	#
`protected mixed`	`$_limit`	`null`	#
`protected boolean`	`$_outputRequired`	`true`	#
`protected integer`	`$_frameLength`	`5`	# Pages quantity per frame Pages quantity per frame
`protected integer`	`$_jump`	`5`	# Next/previous page position relatively to the current frame Next/previous page position relatively to the current frame
`protected boolean`	`$_frameInitialized`	`false`	# Frame initialization flag Frame initialization flag
`protected integer`	`$_frameStart`		# Start page position in frame Start page position in frame
`protected integer`	`$_frameEnd`		# Finish page position in frame Finish page position in frame

Properties inherited from Mage_Core_Block_Template
`$_allowSymlinks, $_baseUrl, $_jsUrl, $_showTemplateHints, $_showTemplateHintsBlocks, $_template, $_viewDir, $_viewVars`

Properties inherited from Mage_Core_Block_Abstract
`$_alias, $_anonSuffix, $_childGroups, $_children, $_childrenHtmlCache, $_frameCloseTag, $_frameOpenTag, $_isAnonymous, $_layout, $_messagesBlock, $_nameInLayout, $_parent, $_parentBlock, $_request, $_sortInstructions, $_sortedChildren, $_urlModel`

Packages

Classes

Class Mage_Page_Block_Html_Pager

Direct known subclasses

Overrides

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Overrides