Magento – How to call Mage_Page_Block_Html_Pager class in list.phtml

classmagento-1.7modelpaginationtemplate

I am wanting to include a larger than normal 'next page' type button in the list.phtml template whilst still having the normal pagination from pager.phtml

The function I'm wanting to use is found in code/core/Mage/Page/Block/Html/Pager.php:

public function getNextPageUrl()
    {
        return $this->getPageUrl($this->getCollection()->getCurPage(+1));
    }

This can be called in pager.phtml by performing $this->getNextPageUrl(). I'm wanting to call this function inside list.phtml but I'm not sure how to get it. Using $this->getNextPageUrl() doesn't work.

I've also tried variations of Mage::getModel('page/html_pager')->getNextPageUrl() without luck.

Best Answer

There are two ways of doing this. One is slightly easier than the other.

Add After getToolbarHtml call

If you do it after the call to getToolbarHtml in the list.phtml then the following code will work.

<?php echo $this->getChild('product_list_toolbar')->getChild('product_list_toolbar_pager')->getNextPageUrl() ?>

This is because the pager is actually inside the toolbar and not the list, see layout xml.

<block type="catalog/product_list" name="product_list" template="catalog/product/list.phtml">
    <block type="catalog/product_list_toolbar" name="product_list_toolbar" template="catalog/product/list/toolbar.phtml">
        <block type="page/html_pager" name="product_list_toolbar_pager"/>

And most importantly the collection is setup in the toolbar's getPagerHtml function:

public function getPagerHtml()
{
    $pagerBlock = $this->getChild('product_list_toolbar_pager');

    if ($pagerBlock instanceof Varien_Object) {

        /* @var $pagerBlock Mage_Page_Block_Html_Pager */
        $pagerBlock->setAvailableLimit($this->getAvailableLimit());

        $pagerBlock->setUseContainer(false)
            ->setShowPerPage(false)
            ->setShowAmounts(false)
            ->setLimitVarName($this->getLimitVarName())
            ->setPageVarName($this->getPageVarName())
            ->setLimit($this->getLimit())
            ->setFrameLength(Mage::getStoreConfig('design/pagination/pagination_frame'))
            ->setJump(Mage::getStoreConfig('design/pagination/pagination_frame_skip'))
            ->setCollection($this->getCollection());

        return $pagerBlock->toHtml();
    }

    return '';
}

Add before getToolbarHtml call

Or if you simply want to put it anywhere in the template what you can do is set the collection using the list`s collection with the following code.

$productCollection = $this->getLoadedProductCollection();
$pagerBlock = $this->getChild('product_list_toolbar')->getChild('product_list_toolbar_pager');
$pagerBlock->setCollection($productCollection);
echo $pagerBlock->getNextPageUrl();

Best practice: via the service contract

The best practice is always to use the service contract whenever it's possible. You can find the list of reasons here: Magento 2: what are the benefits of using service contracts?

For details on how to implement a service contract I suggest you check this topic: How to implement service contract for a custom module in Magento 2?

If no service contract available

If there is no service contract available, you should use the model repository get method. Using this method, you benefit from the magento caching system for example for the CategoryRepository class:

public function get($categoryId, $storeId = null)
{
    $cacheKey = null !== $storeId ? $storeId : 'all';
    if (!isset($this->instances[$categoryId][$cacheKey])) {
        /** @var Category $category */
        $category = $this->categoryFactory->create();
        if (null !== $storeId) {
            $category->setStoreId($storeId);
        }
        $category->load($categoryId);
        if (!$category->getId()) {
            throw NoSuchEntityException::singleField('id', $categoryId);
        }
        $this->instances[$categoryId][$cacheKey] = $category;
    }
    return $this->instances[$categoryId][$cacheKey];
}

Deprecated `load()` method

Magento 2 is slowly moving away from the standard CRUD system by dropping the inheritance system and implementing it via composition using the new 2.1 EntityManager you can find details here: Magento 2.1: using the entity manager

Also I suggest you read this interesting topic about the deprecated CRUD methods: Deprecated save and load methods in Abstract Model

Why not using the resource model load

The main reason is that if you use the resource model load method, you will skip some important part of the loading system that are implemented in the model load method, see Magento\Framework\Model\AbstractModel :

public function load($modelId, $field = null)
{
    $this->_beforeLoad($modelId, $field);
    $this->_getResource()->load($this, $modelId, $field);
    $this->_afterLoad();
    $this->setOrigData();
    $this->_hasDataChanges = false;
    $this->updateStoredData();
    return $this;
}

Calling the resource model load method directly will have the following impact:

_beforeLoad is not called: thus the model load before events are not dispatched
_afterLoad is not called: thus the model load after events are not dispatched
the stored data are not updated which can cause various problems (for instance if you call prepareDataForUpdate from Magento\Framework\Model\ResourceModel\Db\AbstractDb )

Best Answer

Related Solutions

Magento – How Are Magento Lib Files Loaded

Best Way to Load a Custom Model in Magento 2

Best practice: via the service contract

If no service contract available

Deprecated load() method

Why not using the resource model load

Related Topic

Deprecated `load()` method