Class Mage_Catalog_Block_Product_List_Toolbar

Product list toolbar

Varien_Object

Mage_Catalog_Block_Product_List_Toolbar

Package: Mage\Catalog
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/Catalog/Block/Product/List/Toolbar.php

Methods summary
`protected Mage_Catalog_Model_Config`	# `_getConfig( )` Retrieve Catalog Config object Retrieve Catalog Config object Returns `Mage_Catalog_Model_Config`
`protected`	# `_construct( )` Init Toolbar Init Toolbar Overrides `Mage_Core_Block_Template::_construct()`
`public`	# `disableParamsMemorizing( )` Disable list state params memorizing Disable list state params memorizing
`protected Mage_Catalog_Block_Product_List_Toolbar`	# `_memorizeParam( string $param, mixed $value )` Memorize parameter value for session Memorize parameter value for session Parameters `$param` `string` $param parameter name `$value` `mixed` $value parameter value Returns `Mage_Catalog_Block_Product_List_Toolbar`
`public Mage_Catalog_Block_Product_List_Toolbar`	# `setCollection( Varien_Data_Collection $collection )` Set collection to pager Set collection to pager Parameters `$collection` `Varien_Data_Collection` $collection Returns `Mage_Catalog_Block_Product_List_Toolbar`
`public Mage_Core_Model_Mysql4_Collection_Abstract`	# `getCollection( )` Return products collection instance Return products collection instance Returns `Mage_Core_Model_Mysql4_Collection_Abstract`
`public string`	# `getPageVarName( )` Getter for $_pageVarName Getter for $_pageVarName Returns `string`
`public string`	# `getOrderVarName( )` Retrieve order field GET var name Retrieve order field GET var name Returns `string`
`public string`	# `getDirectionVarName( )` Retrieve sort direction GET var name Retrieve sort direction GET var name Returns `string`
`public string`	# `getModeVarName( )` Retrieve view mode GET var name Retrieve view mode GET var name Returns `string`
`public string`	# `getLimitVarName( )` Getter for $_limitVarName Getter for $_limitVarName Returns `string`
`public integer`	# `getCurrentPage( )` Return current page from request Return current page from request Returns `integer`
`public string`	# `getCurrentOrder( )` Get grit products sort order field Get grit products sort order field Returns `string`
`public string`	# `getCurrentDirection( )` Retrieve current direction Retrieve current direction Returns `string`
`public Mage_Catalog_Block_Product_List_Toolbar`	# `setDefaultOrder( string $field )` Set default Order field Set default Order field Parameters `$field` `string` $field Returns `Mage_Catalog_Block_Product_List_Toolbar`
`public Mage_Catalog_Block_Product_List_Toolbar`	# `setDefaultDirection( string $dir )` Set default sort direction Set default sort direction Parameters `$dir` `string` $dir Returns `Mage_Catalog_Block_Product_List_Toolbar`
`public array`	# `getAvailableOrders( )` Retrieve available Order fields list Retrieve available Order fields list Returns `array`
`public Mage_Catalog_Block_Product_List_Toolbar`	# `setAvailableOrders( array $orders )` Set Available order fields list Set Available order fields list Parameters `$orders` `array` $orders Returns `Mage_Catalog_Block_Product_List_Toolbar`
`public Mage_Catalog_Block_Product_List_Toolbar`	# `addOrderToAvailableOrders( string $order, string $value )` Add order to available orders Add order to available orders Parameters `$order` `string` $order `$value` `string` $value Returns `Mage_Catalog_Block_Product_List_Toolbar`
`public`	# `removeOrderFromAvailableOrders( string $order )` Remove order from available orders if exists Remove order from available orders if exists Parameters `$order` `string` $order
`public boolean`	# `isOrderCurrent( string $order )` Compare defined order field vith current order field Compare defined order field vith current order field Parameters `$order` `string` $order Returns `boolean`
`public string`	# `getOrderUrl( string $order, string $direction )` Retrieve Pager URL Retrieve Pager URL Parameters `$order` `string` $order `$direction` `string` $direction Returns `string`
`public string`	# `getPagerUrl( array $params = array() )` Return current URL with rewrites and additional parameters Return current URL with rewrites and additional parameters Parameters `$params` `array` $params Query parameters Returns `string`
`public string`	# `getCurrentMode( )` Retrieve current View mode Retrieve current View mode Returns `string`
`public boolean`	# `isModeActive( string $mode )` Compare defined view mode with current active mode Compare defined view mode with current active mode Parameters `$mode` `string` $mode Returns `boolean`
`public array`	# `getModes( )` Retrieve availables view modes Retrieve availables view modes Returns `array`
`public Mage_Catalog_Block_Product_List_Toolbar`	# `setModes( array $modes )` Set available view modes list Set available view modes list Parameters `$modes` `array` $modes Returns `Mage_Catalog_Block_Product_List_Toolbar`
`public string`	# `getModeUrl( string $mode )` Retrive URL for view mode Retrive URL for view mode Parameters `$mode` `string` $mode Returns `string`
`public Mage_Catalog_Block_Product_List_Toolbar`	# `disableViewSwitcher( )` Disable view switcher Disable view switcher Returns `Mage_Catalog_Block_Product_List_Toolbar`
`public Mage_Catalog_Block_Product_List_Toolbar`	# `enableViewSwitcher( )` Enable view switcher Enable view switcher Returns `Mage_Catalog_Block_Product_List_Toolbar`
`public boolean`	# `isEnabledViewSwitcher( )` Is a enabled view switcher Is a enabled view switcher Returns `boolean`
`public Mage_Catalog_Block_Product_List_Toolbar`	# `disableExpanded( )` Disable Expanded Disable Expanded Returns `Mage_Catalog_Block_Product_List_Toolbar`
`public Mage_Catalog_Block_Product_List_Toolbar`	# `enableExpanded( )` Enable Expanded Enable Expanded Returns `Mage_Catalog_Block_Product_List_Toolbar`
`public boolean`	# `isExpanded( )` Check is Expanded Check is Expanded Returns `boolean`
`public string`	# `getDefaultPerPageValue( )` Retrieve default per page values Retrieve default per page values Returns `string` (comma separated)
`public Mage_Catalog_Block_Product_List_Toolbar`	# `addPagerLimit( string $mode, string $value, string $label = '' )` Add new limit to pager for mode Add new limit to pager for mode Parameters `$mode` `string` $mode `$value` `string` $value `$label` `string` $label Returns `Mage_Catalog_Block_Product_List_Toolbar`
`public array`	# `getAvailableLimit( )` Retrieve available limits for current view mode Retrieve available limits for current view mode Returns `array`
`protected array`	# `_getAvailableLimit( mixed $mode )` Retrieve available limits for specified view mode Retrieve available limits for specified view mode Returns `array`
`public string`	# `getLimit( )` Get specified products limit display per page Get specified products limit display per page Returns `string`
`public string`	# `getLimitUrl( integer $limit )` Retrieve Limit Pager URL Retrieve Limit Pager URL Parameters `$limit` `integer` $limit Returns `string`
`public`	# `isLimitCurrent( mixed $limit )`
`public`	# `getFirstNum( )`
`public`	# `getLastNum( )`
`public`	# `getTotalNum( )`
`public`	# `isFirstPage( )`
`public`	# `getLastPageNum( )`
`public string`	# `getPagerHtml( )` Render pagination HTML Render pagination HTML Returns `string`

Methods inherited from Mage_Core_Block_Template
`_getAllowSymlinks(), _toHtml(), 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 Mage_Core_Model_Mysql4_Collection_Abstract`	`$_collection`	`null`	# Products collection Products collection
`protected string`	`$_pageVarName`	`'p'`	# GET parameter page variable GET parameter page variable
`protected string`	`$_orderVarName`	`'order'`	# GET parameter order variable GET parameter order variable
`protected string`	`$_directionVarName`	`'dir'`	# GET parameter direction variable GET parameter direction variable
`protected string`	`$_modeVarName`	`'mode'`	# GET parameter mode variable GET parameter mode variable
`protected string`	`$_limitVarName`	`'limit'`	# GET parameter limit variable GET parameter limit variable
`protected array`	`$_availableOrder`	`array()`	# List of available order fields List of available order fields
`protected string`	`$_availableMode`	`array()`	# List of available view types List of available view types
`protected boolean`	`$_enableViewSwitcher`	`true`	# Is enable View switcher Is enable View switcher
`protected boolean`	`$_isExpanded`	`true`	# Is Expanded Is Expanded
`protected string`	`$_orderField`	`null`	# Default Order field Default Order field
`protected string`	`$_direction`	`'asc'`	# Default direction Default direction
`protected string`	`$_viewMode`	`null`	# Default View mode Default View mode
`protected array`	`$_availableLimit`	`array()`	# Available page limits for different list modes Available page limits for different list modes
`protected array`	`$_defaultAvailableLimit`	`array(10=>10,20=>20,50=>50)`	# Default limits per page Default limits per page
`protected boolean`	`$_paramsMemorizeAllowed`	`true`	# $_paramsMemorizeAllowed $_paramsMemorizeAllowed

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

Interfaces

Class Mage_Catalog_Block_Product_List_Toolbar

Returns

Overrides

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Returns