How is the «Sort By» control implemented on the frontend product lists?

dmitry_fedyuk · April 2, 2016, 5:03am

magento/magento2/blob/d447fa6e1/app/code/Magento/Catalog/view/frontend/templates/product/list/toolbar.phtml#L30-L32


<?php if ($block->isExpanded()): ?>
    <?php include ($block->getTemplateFile('Magento_Catalog::product/list/toolbar/sorter.phtml')) ?>
<?php endif; ?>

github.com

magento/magento2/blob/d447fa6e1/app/code/Magento/Catalog/view/frontend/templates/product/list/toolbar/sorter.phtml#L18-L30


<div class="toolbar-sorter sorter">
<label class="sorter-label" for="sorter"><?php /* @escapeNotVerified */ echo __('Sort By') ?></label>
<select id="sorter" data-role="sorter" class="sorter-options">
    <?php foreach ($block->getAvailableOrders() as $_key => $_order): ?>
        <option value="<?php /* @escapeNotVerified */ echo $_key; ?>"
            <?php if ($block->isOrderCurrent($_key)): ?>
                selected="selected"
            <?php endif; ?>
            >
            <?php echo $block->escapeHtml(__($_order)) ?>
        </option>
    <?php endforeach; ?>
</select>

github.com

magento/magento2/blob/d447fa6e1/app/code/Magento/Catalog/view/frontend/templates/product/list/toolbar/sorter.phtml#L31-L40


<?php if ($block->getCurrentDirection() == 'desc'): ?>
    <a title="<?php /* @escapeNotVerified */ echo __('Set Ascending Direction') ?>" href="#" class="action sorter-action sort-desc" data-role="direction-switcher" data-value="asc">
        <span><?php /* @escapeNotVerified */ echo __('Set Ascending Direction') ?></span>
    </a>
<?php else: ?>
    <a title="<?php /* @escapeNotVerified */ echo __('Set Descending Direction') ?>" href="#" class="action sorter-action sort-asc" data-role="direction-switcher" data-value="desc">
        <span><?php /* @escapeNotVerified */ echo __('Set Descending Direction') ?></span>
    </a>
<?php endif; ?>
</div>

github.com

magento/magento2/blob/d447fa6e1/app/code/Magento/Catalog/Block/Product/ProductList/Toolbar.php#L256-L275


public function getCurrentDirection()
{
    $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;
}

github.com

magento/magento2/blob/d447fa6e1/app/code/Magento/Catalog/Model/Product/ProductList/Toolbar.php#L64-L72


/**
 * Get sort direction
 *
 * @return string|bool
 */
public function getDirection()
{
    return $this->request->getParam(self::DIRECTION_PARAM_NAME);
}

github.com

magento/magento2/blob/d447fa6e1/app/code/Magento/Catalog/Model/Product/ProductList/Toolbar.php#L23-L26


/**
 * Sort direction cookie name
 */
const DIRECTION_PARAM_NAME = 'product_list_dir';

github.com

magento/magento2/blob/d447fa6e1/app/code/Magento/Catalog/Block/Product/ProductList/Toolbar.php#L62-L67


/**
 * Default direction
 *
 * @var string
 */
protected $_direction = ProductList::DEFAULT_SORT_DIRECTION;

github.com

magento/magento2/blob/d447fa6e1/app/code/Magento/Catalog/Block/Product/ProductList/Toolbar.php#L292-L304


/**
 * Set default sort direction
 *
 * @param string $dir
 * @return $this
 */
public function setDefaultDirection($dir)
{
    if (in_array(strtolower($dir), ['asc', 'desc'])) {
        $this->_direction = strtolower($dir);
    }
    return $this;
}