Class Mage_Catalog_Block_Product_List_Toolbar

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

Product list toolbar

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

Varien_Object
   |
   --Mage_Core_Block_Abstract
      |
      --Mage_Core_Block_Template
         |
         --Mage_Catalog_Block_Product_List_Toolbar
Variable Summary
Description | Vars (details) | Methods (details) Constants
array $_availableLimit
string $_availableMode
array $_availableOrder
Mage_Core_Model_Mysql4_Collection_Abstract $_collection
array $_defaultAvailableLimit
string $_direction
string $_directionVarName
bool $_enableViewSwitcher
bool $_isExpanded
string $_limitVarName
string $_modeVarName
string $_orderField
string $_orderVarName
string $_pageVarName
bool $_paramsMemorizeAllowed
string $_viewMode
Method Summary
Description | Constants Vars (details) | Methods (details)
Mage_Catalog_Block_Product_List_Toolbar addOrderToAvailableOrders (string $order, string $value)
Mage_Catalog_Block_Product_List_Toolbar addPagerLimit (string $mode, string $value, [string $label = ''])
Mage_Catalog_Block_Product_List_Toolbar disableExpanded ()
void disableParamsMemorizing ()
Mage_Catalog_Block_Product_List_Toolbar disableViewSwitcher ()
Mage_Catalog_Block_Product_List_Toolbar enableExpanded ()
Mage_Catalog_Block_Product_List_Toolbar enableViewSwitcher ()
array getAvailableLimit ()
array getAvailableOrders ()
Mage_Core_Model_Mysql4_Collection_Abstract getCollection ()
string getCurrentDirection ()
string getCurrentMode ()
string getCurrentOrder ()
int getCurrentPage ()
string getDefaultPerPageValue ()
string getDirectionVarName ()
void getFirstNum ()
void getLastNum ()
void getLastPageNum ()
string getLimit ()
string getLimitUrl (int $limit)
string getLimitVarName ()
array getModes ()
string getModeUrl (string $mode)
string getModeVarName ()
string getOrderUrl (string $order, string $direction)
string getOrderVarName ()
string getPagerHtml ()
string getPagerUrl ([array $params = array()])
string getPageVarName ()
void getTotalNum ()
bool isEnabledViewSwitcher ()
bool isExpanded ()
void isFirstPage ()
void isLimitCurrent ( $limit)
bool isModeActive (string $mode)
bool isOrderCurrent (string $order)
void removeOrderFromAvailableOrders (string $order, Mage_Catalog_Block_Product_List_Toolbar 1)
Mage_Catalog_Block_Product_List_Toolbar setAvailableOrders (array $orders)
Mage_Catalog_Block_Product_List_Toolbar setCollection (Varien_Data_Collection $collection)
Mage_Catalog_Block_Product_List_Toolbar setDefaultDirection (string $dir)
Mage_Catalog_Block_Product_List_Toolbar setDefaultOrder (string $field)
Mage_Catalog_Block_Product_List_Toolbar setModes (array $modes)
void _construct ()
array _getAvailableLimit ( $mode)
Mage_Catalog_Model_Config _getConfig ()
Mage_Catalog_Block_Product_List_Toolbar _memorizeParam (string $param, mixed $value)
Variables
Description | Vars (details) Constants | Methods (details)
array $_availableLimit = array() (line 133)

Available page limits for different list modes

  • access: protected
string $_availableMode = array() (line 91)

List of available view types

  • access: protected
array $_availableOrder = array() (line 84)

List of available order fields

  • access: protected
Mage_Core_Model_Mysql4_Collection_Abstract $_collection = null (line 42)

Products collection

  • access: protected
array $_defaultAvailableLimit = array(10=>10,20=>20,50=>50) (line 140)

Default limits per page

  • access: protected
string $_direction = 'asc' (line 119)

Default direction

  • access: protected
string $_directionVarName = 'dir' (line 63)

GET parameter direction variable

  • access: protected
bool $_enableViewSwitcher = true (line 98)

Is enable View switcher

  • access: protected
bool $_isExpanded = true (line 105)

Is Expanded

  • access: protected
string $_limitVarName = 'limit' (line 77)

GET parameter limit variable

  • access: protected
string $_modeVarName = 'mode' (line 70)

GET parameter mode variable

  • access: protected
string $_orderField = null (line 112)

Default Order field

  • access: protected
string $_orderVarName = 'order' (line 56)

GET parameter order variable

  • access: protected
string $_pageVarName = 'p' (line 49)

GET parameter page variable

  • access: protected
bool $_paramsMemorizeAllowed = true (line 145)
  • access: protected
string $_viewMode = null (line 126)

Default View mode

  • access: protected

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
Description | Vars (details) Constants Methods (details)
addOrderToAvailableOrders (line 437)

Add order to available orders

  • access: public
Mage_Catalog_Block_Product_List_Toolbar addOrderToAvailableOrders (string $order, string $value)
  • string $order
  • string $value
addPagerLimit (line 673)

Add new limit to pager for mode

  • access: public
Mage_Catalog_Block_Product_List_Toolbar addPagerLimit (string $mode, string $value, [string $label = ''])
  • string $mode
  • string $value
  • string $label
disableExpanded (line 616)

Disable Expanded

  • access: public
Mage_Catalog_Block_Product_List_Toolbar disableExpanded ()
disableParamsMemorizing (line 193)

Disable list state params memorizing

  • access: public
void disableParamsMemorizing ()
disableViewSwitcher (line 584)

Disable view switcher

  • access: public
Mage_Catalog_Block_Product_List_Toolbar disableViewSwitcher ()
enableExpanded (line 627)

Enable Expanded

  • access: public
Mage_Catalog_Block_Product_List_Toolbar enableExpanded ()
enableViewSwitcher (line 595)

Enable view switcher

  • access: public
Mage_Catalog_Block_Product_List_Toolbar enableViewSwitcher ()
getAvailableLimit (line 687)

Retrieve available limits for current view mode

  • access: public
array getAvailableLimit ()
getAvailableOrders (line 413)

Retrieve available Order fields list

  • access: public
array getAvailableOrders ()
getCollection (line 243)

Return products collection instance

  • access: public
Mage_Core_Model_Mysql4_Collection_Abstract getCollection ()
getCurrentDirection (line 354)

Retrieve current direction

  • access: public
string getCurrentDirection ()
getCurrentMode (line 507)

Retrieve current View mode

  • access: public
string getCurrentMode ()
getCurrentOrder (line 316)

Get grit products sort order field

  • access: public
string getCurrentOrder ()
getCurrentPage (line 303)

Return current page from request

  • access: public
int getCurrentPage ()
getDefaultPerPageValue (line 648)

Retrieve default per page values

  • return: (comma separated)
  • access: public
string getDefaultPerPageValue ()
getDirectionVarName (line 273)

Retrieve sort direction GET var name

  • access: public
string getDirectionVarName ()
getFirstNum (line 774)
  • access: public
void getFirstNum ()
getLastNum (line 780)
  • access: public
void getLastNum ()
getLastPageNum (line 796)
  • access: public
void getLastPageNum ()
getLimit (line 723)

Get specified products limit display per page

  • access: public
string getLimit ()
getLimitUrl (line 761)

Retrieve Limit Pager URL

  • access: public
string getLimitUrl (int $limit)
  • int $limit
getLimitVarName (line 293)

Getter for $_limitVarName

  • access: public
string getLimitVarName ()
getModes (line 549)

Retrieve availables view modes

  • access: public
array getModes ()
getModeUrl (line 574)

Retrive URL for view mode

  • access: public
string getModeUrl (string $mode)
  • string $mode
getModeVarName (line 283)

Retrieve view mode GET var name

  • access: public
string getModeVarName ()
getOrderUrl (line 474)

Retrieve Pager URL

  • access: public
string getOrderUrl (string $order, string $direction)
  • string $order
  • string $direction
getOrderVarName (line 263)

Retrieve order field GET var name

  • access: public
string getOrderVarName ()
getPagerHtml (line 806)

Render pagination HTML

  • access: public
string getPagerHtml ()
getPagerUrl (line 492)

Return current URL with rewrites and additional parameters

  • access: public
string getPagerUrl ([array $params = array()])
  • array $params: Query parameters
getPageVarName (line 253)

Getter for $_pageVarName

  • access: public
string getPageVarName ()
getTotalNum (line 786)
  • access: public
void getTotalNum ()
isEnabledViewSwitcher (line 606)

Is a enabled view switcher

  • access: public
bool isEnabledViewSwitcher ()
isExpanded (line 638)

Check is Expanded

  • access: public
bool isExpanded ()
isFirstPage (line 791)
  • access: public
void isFirstPage ()
isLimitCurrent (line 769)
  • access: public
void isLimitCurrent ( $limit)
  • $limit
isModeActive (line 539)

Compare defined view mode with current active mode

  • access: public
bool isModeActive (string $mode)
  • string $mode
isOrderCurrent (line 462)

Compare defined order field vith current order field

  • access: public
bool isOrderCurrent (string $order)
  • string $order
removeOrderFromAvailableOrders (line 448)

Remove order from available orders if exists

  • access: public
void removeOrderFromAvailableOrders (string $order, Mage_Catalog_Block_Product_List_Toolbar 1)
setAvailableOrders (line 424)

Set Available order fields list

  • access: public
Mage_Catalog_Block_Product_List_Toolbar setAvailableOrders (array $orders)
  • array $orders
setCollection (line 221)

Set collection to pager

  • access: public
Mage_Catalog_Block_Product_List_Toolbar setCollection (Varien_Data_Collection $collection)
  • Varien_Data_Collection $collection
setDefaultDirection (line 400)

Set default sort direction

  • access: public
Mage_Catalog_Block_Product_List_Toolbar setDefaultDirection (string $dir)
  • string $dir
setDefaultOrder (line 386)

Set default Order field

  • access: public
Mage_Catalog_Block_Product_List_Toolbar setDefaultOrder (string $field)
  • string $field
setModes (line 560)

Set available view modes list

  • access: public
Mage_Catalog_Block_Product_List_Toolbar setModes (array $modes)
  • array $modes
_construct (line 161)

Init Toolbar

  • access: protected
void _construct ()
Redefinition of:
Mage_Core_Block_Template::_construct()
Internal constructor, that is called from real constructor
_getAvailableLimit (line 702)

Retrieve available limits for specified view mode

  • access: protected
array _getAvailableLimit ( $mode)
  • $mode
_getConfig (line 152)

Retrieve Catalog Config object

  • access: protected
Mage_Catalog_Model_Config _getConfig ()
_memorizeParam (line 206)

Memorize parameter value for session

  • access: protected
Mage_Catalog_Block_Product_List_Toolbar _memorizeParam (string $param, mixed $value)
  • string $param: parameter name
  • mixed $value: parameter value

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
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:14:50 +0200 by phpDocumentor 1.4.3