Inheritance diagram for Toolbar:

Public Member Functions
	__construct (\Magento\Framework\View\Element\Template\Context $context, \Magento\Catalog\Model\Session $catalogSession, \Magento\Catalog\Model\Config $catalogConfig, ToolbarModel $toolbarModel, \Magento\Framework\Url\EncoderInterface $urlEncoder, ProductList $productListHelper, \Magento\Framework\Data\Helper\PostHelper $postDataHelper, array $data=[])

	disableParamsMemorizing ()

	setCollection ($collection)

	getCollection ()

	getCurrentPage ()

	getCurrentOrder ()

	getCurrentDirection ()

	setDefaultOrder ($field)

	setDefaultDirection ($dir)

	getAvailableOrders ()

	setAvailableOrders ($orders)

	addOrderToAvailableOrders ($order, $value)

	removeOrderFromAvailableOrders ($order)

	isOrderCurrent ($order)

	getPagerUrl ($params=[])

	getPagerEncodedUrl ($params=[])

	getCurrentMode ()

	isModeActive ($mode)

	getModes ()

	setModes ($modes)

	disableViewSwitcher ()

	enableViewSwitcher ()

	isEnabledViewSwitcher ()

	disableExpanded ()

	enableExpanded ()

	isExpanded ()

	getDefaultPerPageValue ()

	getAvailableLimit ()

	getLimit ()

	isLimitCurrent ($limit)

	getFirstNum ()

	getLastNum ()

	getTotalNum ()

	isFirstPage ()

	getLastPageNum ()

	getPagerHtml ()

	getWidgetOptionsJson (array $customOptions=[])

Public Member Functions inherited from Template
	__construct (Template\Context $context, array $data=[])

	setTemplateContext ($templateContext)

	getTemplate ()

	setTemplate ($template)

	getTemplateFile ($template=null)

	getArea ()

	assign ($key, $value=null)

	fetchView ($fileName)

	getBaseUrl ()

	getObjectData (\Magento\Framework\DataObject $object, $key)

	getCacheKeyInfo ()

Public Member Functions inherited from AbstractBlock
	__construct (\Magento\Framework\View\Element\Context $context, array $data=[])

	getJsLayout ()

	getRequest ()

	getParentBlock ()

	setLayout (\Magento\Framework\View\LayoutInterface $layout)

	getLayout ()

	setNameInLayout ($name)

	getChildNames ()

	setAttribute ($name, $value=null)

	setChild ($alias, $block)

	addChild ($alias, $block, $data=[])

	unsetChild ($alias)

	unsetCallChild ($alias, $callback, $result, $params)

	unsetChildren ()

	getChildBlock ($alias)

	getChildHtml ($alias='', $useCache=true)

	getChildChildHtml ($alias, $childChildAlias='', $useCache=true)

	getBlockHtml ($name)

	insert ($element, $siblingName=0, $after=true, $alias='')

	append ($element, $alias='')

	getGroupChildNames ($groupName)

	getChildData ($alias, $key='')

	getUiId ($arg1=null, $arg2=null, $arg3=null, $arg4=null, $arg5=null)

	getJsId ($arg1=null, $arg2=null, $arg3=null, $arg4=null, $arg5=null)

	getUrl ($route='', $params=[])

	getViewFileUrl ($fileId, array $params=[])

	formatDate ( $date=null, $format=\IntlDateFormatter::SHORT, $showTime=false, $timezone=null)

	formatTime ( $time=null, $format=\IntlDateFormatter::SHORT, $showDate=false)

	getModuleName ()

	escapeHtml ($data, $allowedTags=null)

	escapeJs ($string)

	escapeHtmlAttr ($string, $escapeSingleQuote=true)

	escapeCss ($string)

	stripTags ($data, $allowableTags=null, $allowHtmlEntities=false)

	escapeUrl ($string)

	escapeXssInUrl ($data)

	escapeQuote ($data, $addSlashes=false)

	escapeJsQuote ($data, $quote='\'')

	getNameInLayout ()

	getCacheKeyInfo ()

	getCacheKey ()

	getVar ($name, $module=null)

	isScopePrivate ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Public Member Functions inherited from BlockInterface
	toHtml ()

Protected Member Functions
	_memorizeParam ($param, $value)

	getOrderField ()

Protected Member Functions inherited from Template
	_construct ()

	_toHtml ()

	getRootDirectory ()

	getMediaDirectory ()

Protected Member Functions inherited from AbstractBlock
	_construct ()

	_prepareLayout ()

	_beforeToHtml ()

	_afterToHtml ($html)

	_toHtml ()

	_getNotFoundUrl ($route='', $params=['_direct'=> 'core/index/notFound'])

	getCacheTags ()

	getCacheLifetime ()

	_loadCache ()

	_saveCache ($data)

	_getSidPlaceholder ($cacheKey=null)

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_collection = null

	$_availableOrder = null

	$_availableMode = []

	$_enableViewSwitcher = true

	$_isExpanded = true

	$_orderField = null

	$_direction = ProductList::DEFAULT_SORT_DIRECTION

	$_viewMode = null

	$_paramsMemorizeAllowed = true

	$_template = 'Magento_Catalog::product/list/toolbar.phtml'

	$_catalogConfig

	$_catalogSession

	$_toolbarModel

	$_productListHelper

	$urlEncoder

	$_postDataHelper

Protected Attributes inherited from Template
	$_viewVars = []

	$_baseUrl

	$_jsUrl

	$_allowSymlinks

	$_filesystem

	$_template

	$templateEnginePool

	$_storeManager

	$_appState

	$directory

	$templateContext

	$pageConfig

	$resolver

	$validator

Protected Attributes inherited from AbstractBlock
	$_design

	$_session

	$_sidResolver

	$_nameInLayout

	$_layout

	$jsLayout = []

	$_request

	$_urlBuilder

	$_eventManager

	$_frontController

	$_assetRepo

	$_viewConfig

	$_cacheState

	$_logger

	$_escaper

	$filterManager

	$_localeDate

	$inlineTranslation

	$_isScopePrivate = false

	$_scopeConfig

	$_cache

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Public Member Functions inherited from AbstractBlock
static	extractModuleName ($className)

Data Fields inherited from Template
const	XML_PATH_TEMPLATE_ALLOW_SYMLINK = 'dev/template/allow_symlink'

Data Fields inherited from AbstractBlock
const	CACHE_GROUP = \Magento\Framework\App\Cache\Type\Block::TYPE_IDENTIFIER

const	CACHE_KEY_PREFIX = 'BLOCK_'

Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Product list toolbar

@api

Author: Magento Core Team core@.nosp@m.mage.nosp@m.ntoco.nosp@m.mmer.nosp@m.ce.co.nosp@m.m @SuppressWarnings(PHPMD.TooManyFields) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 20 of file Toolbar.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\View\Element\Template\Context	$context,
		\Magento\Catalog\Model\Session	$catalogSession,
		\Magento\Catalog\Model\Config	$catalogConfig,
		ToolbarModel	$toolbarModel,
		\Magento\Framework\Url\EncoderInterface	$urlEncoder,
		ProductList	$productListHelper,
		\Magento\Framework\Data\Helper\PostHelper	$postDataHelper,
		array	$data = `[]`
	)

Parameters

\Magento\Framework\View\Element\Template\Context	$context
\Magento\Catalog\Model\Session	$catalogSession
\Magento\Catalog\Model\Config	$catalogConfig
ToolbarModel	$toolbarModel
\Magento\Framework\Url\EncoderInterface	$urlEncoder
ProductList	$productListHelper
\Magento\Framework\Data\Helper\PostHelper	$postDataHelper
array	$data

Definition at line 132 of file Toolbar.php.

       {
         $this->_catalogSession = $catalogSession;
         $this->_catalogConfig = $catalogConfig;
         $this->_toolbarModel = $toolbarModel;
         $this->urlEncoder = $urlEncoder;
         $this->_productListHelper = $productListHelper;
         $this->_postDataHelper = $postDataHelper;
         parent::__construct($context, $data);
     }

Member Function Documentation

◆ _memorizeParam()

_memorizeParam	(	$param,
		$value
	)

protected

Memorize parameter value for session

Parameters

string	$param	parameter name
mixed	$value	parameter value

Returns: $this

Definition at line 169 of file Toolbar.php.

     {
         if ($this->_paramsMemorizeAllowed && !$this->_catalogSession->getParamsMemorizeDisabled()) {
             $this->_catalogSession->setData($param, $value);
         }
         return $this;
     }

◆ addOrderToAvailableOrders()

addOrderToAvailableOrders	(	$order,
		$value
	)

Add order to available orders

Parameters

string	$order
string	$value

Returns: \Magento\Catalog\Block\Product\ProductList\Toolbar

Definition at line 345 of file Toolbar.php.

     {
         $this->loadAvailableOrders();
         $this->_availableOrder[$order] = $value;
         return $this;
     }

◆ disableExpanded()

disableExpanded ( )

Disable Expanded

Returns: \Magento\Catalog\Block\Product\ProductList\Toolbar

Definition at line 500 of file Toolbar.php.

     {
         $this->_isExpanded = false;
         return $this;
     }

◆ disableParamsMemorizing()

disableParamsMemorizing ( )

Disable list state params memorizing

Returns: $this

Definition at line 156 of file Toolbar.php.

     {
         $this->_paramsMemorizeAllowed = false;
         return $this;
     }

◆ disableViewSwitcher()

disableViewSwitcher ( )

Disable view switcher

Returns: \Magento\Catalog\Block\Product\ProductList\Toolbar

Definition at line 468 of file Toolbar.php.

     {
         $this->_enableViewSwitcher = false;
         return $this;
     }

◆ enableExpanded()

enableExpanded ( )

Enable Expanded

Returns: \Magento\Catalog\Block\Product\ProductList\Toolbar

Definition at line 511 of file Toolbar.php.

     {
         $this->_isExpanded = true;
         return $this;
     }

◆ enableViewSwitcher()

enableViewSwitcher ( )

Enable view switcher

Returns: \Magento\Catalog\Block\Product\ProductList\Toolbar

Definition at line 479 of file Toolbar.php.

     {
         $this->_enableViewSwitcher = true;
         return $this;
     }

◆ getAvailableLimit()

getAvailableLimit ( )

Retrieve available limits for current view mode

Returns: array

Definition at line 547 of file Toolbar.php.

     {
         return $this->_productListHelper->getAvailableLimit($this->getCurrentMode());
     }

◆ getAvailableOrders()

getAvailableOrders ( )

Retrieve available Order fields list

Returns: array

Definition at line 320 of file Toolbar.php.

     {
         $this->loadAvailableOrders();
         return $this->_availableOrder;
     }

◆ getCollection()

getCollection ( )

Return products collection instance

Returns: \Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection

Definition at line 212 of file Toolbar.php.

     {
         return $this->_collection;
     }

◆ getCurrentDirection()

getCurrentDirection ( )

Retrieve current direction

Returns: string

Definition at line 265 of file Toolbar.php.

     {
         $dir = $this->_getData('_current_grid_direction');
         if ($dir) {
             return $dir;
         }
 
         $directions = ['asc', 'desc'];
         $dir = strtolower($this->_toolbarModel->getDirection());
         if (!$dir || !in_array($dir, $directions)) {
             $dir = $this->_direction;
         }
 
         if ($dir != $this->_direction) {
             $this->_memorizeParam('sort_direction', $dir);
         }
 
         $this->setData('_current_grid_direction', $dir);
         return $dir;
     }

◆ getCurrentMode()

getCurrentMode ( )

Retrieve current View mode

Returns: string

Definition at line 408 of file Toolbar.php.

     {
         $mode = $this->_getData('_current_grid_mode');
         if ($mode) {
             return $mode;
         }
         $defaultMode = $this->_productListHelper->getDefaultViewMode($this->getModes());
         $mode = $this->_toolbarModel->getMode();
         if (!$mode || !isset($this->_availableMode[$mode])) {
             $mode = $defaultMode;
         }
 
         $this->setData('_current_grid_mode', $mode);
         return $mode;
     }

◆ getCurrentOrder()

getCurrentOrder ( )

Get grit products sort order field

Returns: string

Definition at line 232 of file Toolbar.php.

     {
         $order = $this->_getData('_current_grid_order');
         if ($order) {
             return $order;
         }
 
         $orders = $this->getAvailableOrders();
         $defaultOrder = $this->getOrderField();
 
         if (!isset($orders[$defaultOrder])) {
             $keys = array_keys($orders);
             $defaultOrder = $keys[0];
         }
 
         $order = $this->_toolbarModel->getOrder();
         if (!$order || !isset($orders[$order])) {
             $order = $defaultOrder;
         }
 
         if ($order != $defaultOrder) {
             $this->_memorizeParam('sort_order', $order);
         }
 
         $this->setData('_current_grid_order', $order);
         return $order;
     }

◆ getCurrentPage()

getCurrentPage ( )

Return current page from request

Returns: int

Definition at line 222 of file Toolbar.php.

     {
         return $this->_toolbarModel->getCurrentPage();
     }

◆ getDefaultPerPageValue()

getDefaultPerPageValue ( )

Retrieve default per page values

Returns: string (comma separated)

Definition at line 532 of file Toolbar.php.

     {
         if ($this->getCurrentMode() == 'list' && ($default = $this->getDefaultListPerPage())) {
             return $default;
         } elseif ($this->getCurrentMode() == 'grid' && ($default = $this->getDefaultGridPerPage())) {
             return $default;
         }
         return $this->_productListHelper->getDefaultLimitPerPageValue($this->getCurrentMode());
     }

◆ getFirstNum()

getFirstNum ( )

Returns: int

Definition at line 596 of file Toolbar.php.

     {
         $collection = $this->getCollection();
         return $collection->getPageSize() * ($collection->getCurPage() - 1) + 1;
     }

◆ getLastNum()

getLastNum ( )

Returns: int

Definition at line 605 of file Toolbar.php.

     {
         $collection = $this->getCollection();
         return $collection->getPageSize() * ($collection->getCurPage() - 1) + $collection->count();
     }

◆ getLastPageNum()

getLastPageNum ( )

Returns: int

Definition at line 630 of file Toolbar.php.

     {
         return $this->getCollection()->getLastPageNumber();
     }

◆ getLimit()

getLimit ( )

Get specified products limit display per page

Returns: string

Definition at line 557 of file Toolbar.php.

     {
         $limit = $this->_getData('_current_limit');
         if ($limit) {
             return $limit;
         }
 
         $limits = $this->getAvailableLimit();
         $defaultLimit = $this->getDefaultPerPageValue();
         if (!$defaultLimit || !isset($limits[$defaultLimit])) {
             $keys = array_keys($limits);
             $defaultLimit = $keys[0];
         }
 
         $limit = $this->_toolbarModel->getLimit();
         if (!$limit || !isset($limits[$limit])) {
             $limit = $defaultLimit;
         }
 
         if ($limit != $defaultLimit) {
             $this->_memorizeParam('limit_page', $limit);
         }
 
         $this->setData('_current_limit', $limit);
         return $limit;
     }

◆ getModes()

getModes ( )

Retrieve available view modes

Returns: array

Definition at line 440 of file Toolbar.php.

     {
         if ($this->_availableMode === []) {
             $this->_availableMode = $this->_productListHelper->getAvailableViewMode();
         }
         return $this->_availableMode;
     }

◆ getOrderField()

getOrderField ( )

protected

Get order field

Returns: null|string

Definition at line 705 of file Toolbar.php.

     {
         if ($this->_orderField === null) {
             $this->_orderField = $this->_productListHelper->getDefaultSortField();
         }
         return $this->_orderField;
     }

◆ getPagerEncodedUrl()

getPagerEncodedUrl ( $params = [] )

Parameters

array $params

Returns: string

Definition at line 398 of file Toolbar.php.

     {
         return $this->urlEncoder->encode($this->getPagerUrl($params));
     }

◆ getPagerHtml()

getPagerHtml ( )

Render pagination HTML

Returns: string

Definition at line 640 of file Toolbar.php.

     {
         $pagerBlock = $this->getChildBlock('product_list_toolbar_pager');
 
         if ($pagerBlock instanceof \Magento\Framework\DataObject) {
             /* @var $pagerBlock \Magento\Theme\Block\Html\Pager */
             $pagerBlock->setAvailableLimit($this->getAvailableLimit());
 
             $pagerBlock->setUseContainer(
                 false
             )->setShowPerPage(
                 false
             )->setShowAmounts(
                 false
             )->setFrameLength(
                 $this->_scopeConfig->getValue(
                     'design/pagination/pagination_frame',
                     \Magento\Store\Model\ScopeInterface::SCOPE_STORE
                 )
             )->setJump(
                 $this->_scopeConfig->getValue(
                     'design/pagination/pagination_frame_skip',
                     \Magento\Store\Model\ScopeInterface::SCOPE_STORE
                 )
             )->setLimit(
                 $this->getLimit()
             )->setCollection(
                 $this->getCollection()
             );
 
             return $pagerBlock->toHtml();
         }
 
         return '';
     }

◆ getPagerUrl()

getPagerUrl ( $params = [] )

Return current URL with rewrites and additional parameters

Parameters

array $params Query parameters

Returns: string

Definition at line 384 of file Toolbar.php.

     {
         $urlParams = [];
         $urlParams['_current'] = true;
         $urlParams['_escape'] = false;
         $urlParams['_use_rewrite'] = true;
         $urlParams['_query'] = $params;
         return $this->getUrl('*/*/*', $urlParams);
     }

◆ getTotalNum()

getTotalNum ( )

Returns: int

Definition at line 614 of file Toolbar.php.

     {
         return $this->getCollection()->getSize();
     }

◆ getWidgetOptionsJson()

getWidgetOptionsJson ( array $customOptions = [] )

Retrieve widget options in json format

Parameters

array $customOptions Optional parameter for passing custom selectors from template

Returns: string

Definition at line 682 of file Toolbar.php.

     {
         $defaultMode = $this->_productListHelper->getDefaultViewMode($this->getModes());
         $options = [
             'mode' => ToolbarModel::MODE_PARAM_NAME,
             'direction' => ToolbarModel::DIRECTION_PARAM_NAME,
             'order' => ToolbarModel::ORDER_PARAM_NAME,
             'limit' => ToolbarModel::LIMIT_PARAM_NAME,
             'modeDefault' => $defaultMode,
             'directionDefault' => $this->_direction ?: ProductList::DEFAULT_SORT_DIRECTION,
             'orderDefault' => $this->getOrderField(),
             'limitDefault' => $this->_productListHelper->getDefaultLimitPerPageValue($defaultMode),
             'url' => $this->getPagerUrl(),
         ];
         $options = array_replace_recursive($options, $customOptions);
         return json_encode(['productListToolbarForm' => $options]);
     }

◆ isEnabledViewSwitcher()

isEnabledViewSwitcher ( )

Is a enabled view switcher

Returns: bool

Definition at line 490 of file Toolbar.php.

     {
         return $this->_enableViewSwitcher;
     }

◆ isExpanded()

isExpanded ( )

Check is Expanded

Returns: bool

Definition at line 522 of file Toolbar.php.

     {
         return $this->_isExpanded;
     }

◆ isFirstPage()

isFirstPage ( )

Returns: bool

Definition at line 622 of file Toolbar.php.

     {
         return $this->getCollection()->getCurPage() == 1;
     }

◆ isLimitCurrent()

isLimitCurrent ( $limit )

Parameters

int $limit

Returns: bool

Definition at line 588 of file Toolbar.php.

     {
         return $limit == $this->getLimit();
     }

◆ isModeActive()

isModeActive ( $mode )

Compare defined view mode with current active mode

Parameters

string $mode

Returns: bool

Definition at line 430 of file Toolbar.php.

     {
         return $this->getCurrentMode() == $mode;
     }

◆ isOrderCurrent()

isOrderCurrent ( $order )

Compare defined order field with current order field

Parameters

string $order

Returns: bool

Definition at line 373 of file Toolbar.php.

     {
         return $order == $this->getCurrentOrder();
     }

◆ removeOrderFromAvailableOrders()

removeOrderFromAvailableOrders ( $order )

Remove order from available orders if exists

Parameters

string $order

Returns: $this

Definition at line 358 of file Toolbar.php.

     {
         $this->loadAvailableOrders();
         if (isset($this->_availableOrder[$order])) {
             unset($this->_availableOrder[$order]);
         }
         return $this;
     }

◆ setAvailableOrders()

setAvailableOrders ( $orders )

Set Available order fields list

Parameters

array $orders

Returns: $this

Definition at line 332 of file Toolbar.php.

     {
         $this->_availableOrder = $orders;
         return $this;
     }

◆ setCollection()

setCollection ( $collection )

Set collection to pager

Parameters

\Magento\Framework\Data\Collection $collection

Returns: $this

Definition at line 183 of file Toolbar.php.

     {
         $this->_collection = $collection;
 
         $this->_collection->setCurPage($this->getCurrentPage());
 
         // we need to set pagination only if passed value integer and more that 0
         $limit = (int)$this->getLimit();
         if ($limit) {
             $this->_collection->setPageSize($limit);
         }
         if ($this->getCurrentOrder()) {
             if (($this->getCurrentOrder()) == 'position') {
                 $this->_collection->addAttributeToSort(
                     $this->getCurrentOrder(),
                     $this->getCurrentDirection()
                 );
             } else {
                 $this->_collection->setOrder($this->getCurrentOrder(), $this->getCurrentDirection());
             }
         }
         return $this;
     }

◆ setDefaultDirection()

setDefaultDirection ( $dir )

Set default sort direction

Parameters

string $dir

Returns: $this

Definition at line 307 of file Toolbar.php.

     {
         if (in_array(strtolower($dir), ['asc', 'desc'])) {
             $this->_direction = strtolower($dir);
         }
         return $this;
     }

◆ setDefaultOrder()

setDefaultOrder ( $field )

Set default Order field

Parameters

string $field

Returns: $this

Definition at line 292 of file Toolbar.php.

     {
         $this->loadAvailableOrders();
         if (isset($this->_availableOrder[$field])) {
             $this->_orderField = $field;
         }
         return $this;
     }

◆ setModes()

setModes ( $modes )

Set available view modes list

Parameters

array $modes

Returns: $this

Definition at line 454 of file Toolbar.php.

     {
         $this->getModes();
         if (!isset($this->_availableMode)) {
             $this->_availableMode = $modes;
         }
         return $this;
     }

Field Documentation

◆ $_availableMode

$_availableMode = []

protected

Definition at line 41 of file Toolbar.php.

◆ $_availableOrder

$_availableOrder = null

protected

Definition at line 34 of file Toolbar.php.

◆ $_catalogConfig

$_catalogConfig

protected

Definition at line 93 of file Toolbar.php.

◆ $_catalogSession

$_catalogSession

protected

Definition at line 100 of file Toolbar.php.

◆ $_collection

$_collection = null

protected

Definition at line 27 of file Toolbar.php.

◆ $_direction

$_direction = ProductList::DEFAULT_SORT_DIRECTION

protected

Definition at line 69 of file Toolbar.php.

◆ $_enableViewSwitcher

$_enableViewSwitcher = true

protected

Definition at line 48 of file Toolbar.php.

◆ $_isExpanded

$_isExpanded = true

protected

Definition at line 55 of file Toolbar.php.

◆ $_orderField

$_orderField = null

protected

Definition at line 62 of file Toolbar.php.

◆ $_paramsMemorizeAllowed

bool $_paramsMemorizeAllowed = true

protected

Definition at line 81 of file Toolbar.php.

◆ $_postDataHelper

$_postDataHelper

protected

Definition at line 120 of file Toolbar.php.

◆ $_productListHelper

$_productListHelper

protected

Definition at line 110 of file Toolbar.php.

◆ $_template

$_template = 'Magento_Catalog::product/list/toolbar.phtml'

protected

Definition at line 86 of file Toolbar.php.

◆ $_toolbarModel

$_toolbarModel

protected

Definition at line 105 of file Toolbar.php.

◆ $_viewMode

$_viewMode = null

protected

Definition at line 76 of file Toolbar.php.

◆ $urlEncoder

$urlEncoder

protected

Definition at line 115 of file Toolbar.php.

The documentation for this class was generated from the following file:

vendor/magento/module-catalog/Block/Product/ProductList/Toolbar.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _memorizeParam()

◆ addOrderToAvailableOrders()

◆ disableExpanded()

◆ disableParamsMemorizing()

◆ disableViewSwitcher()

◆ enableExpanded()

◆ enableViewSwitcher()

◆ getAvailableLimit()

◆ getAvailableOrders()

◆ getCollection()

◆ getCurrentDirection()

◆ getCurrentMode()

◆ getCurrentOrder()

◆ getCurrentPage()

◆ getDefaultPerPageValue()

◆ getFirstNum()

◆ getLastNum()

◆ getLastPageNum()

◆ getLimit()

◆ getModes()

◆ getOrderField()

◆ getPagerEncodedUrl()

◆ getPagerHtml()

◆ getPagerUrl()

◆ getTotalNum()

◆ getWidgetOptionsJson()

◆ isEnabledViewSwitcher()

◆ isExpanded()

◆ isFirstPage()

◆ isLimitCurrent()

◆ isModeActive()

◆ isOrderCurrent()

◆ removeOrderFromAvailableOrders()

◆ setAvailableOrders()

◆ setCollection()

◆ setDefaultDirection()

◆ setDefaultOrder()

◆ setModes()

Field Documentation

◆ $_availableMode

◆ $_availableOrder

◆ $_catalogConfig

◆ $_catalogSession

◆ $_collection

◆ $_direction

◆ $_enableViewSwitcher

◆ $_isExpanded

◆ $_orderField

◆ $_paramsMemorizeAllowed

◆ $_postDataHelper

◆ $_productListHelper

◆ $_template

◆ $_toolbarModel

◆ $_viewMode

◆ $urlEncoder