Mage_Catalog_Block_Product_List Class Reference

Inheritance diagram for Mage_Catalog_Block_Product_List:

List of all members.

Public Member Functions
	getLoadedProductCollection ()
	getMode ()
	getToolbarBlock ()
	getToolbarHtml ()
	setCollection ($collection)
	addAttribute ($code)
	getPriceBlockTemplate ()
	prepareSortableFieldsByCategory ($category)
	getColumnCount ()
	addColumnCountLayoutDepend ($pageLayout, $columnCount)
	removeColumnCountLayoutDepend ($pageLayout)
	getColumnCountLayoutDepend ($pageLayout)
	getPageLayout ()
Protected Member Functions
	_getProductCollection ()
	_beforeToHtml ()
	_getConfig ()
Protected Attributes
	$_defaultToolbarBlock = 'catalog/product_list_toolbar'
	$_productCollection
	$_defaultColumnCount = 3
	$_columnCountLayoutDepend = array()

---

Detailed Description

Definition at line 35 of file List.php.

---

Member Function Documentation

_beforeToHtml

(

)

[protected]

Need use as _prepareLayout - but problem in declaring collection from another block (was problem with search result)

Reimplemented from Mage_Core_Block_Abstract.

Definition at line 137 of file List.php.

    {
        /*$toolbar = $this->getLayout()->createBlock('catalog/product_list_toolbar', microtime());
        if ($toolbarTemplate = $this->getToolbarTemplate()) {
            $toolbar->setTemplate($toolbarTemplate);
        }*/
        $toolbar = $this->getToolbarBlock();

        // called prepare sortable parameters
        $collection = $this->_getProductCollection();

        // use sortable parameters
        if ($orders = $this->getAvailableOrders()) {
            $toolbar->setAvailableOrders($orders);
        }
        if ($sort = $this->getSortBy()) {
            $toolbar->setDefaultOrder($sort);
        }
        if ($modes = $this->getModes()) {
            $toolbar->setModes($modes);
        }

        // set collection to tollbar and apply sort
        $toolbar->setCollection($collection);

        $this->setChild('toolbar', $toolbar);
        Mage::dispatchEvent('catalog_block_product_list_collection', array(
            'collection'=>$this->_getProductCollection(),
        ));

        $this->_getProductCollection()->load();
        Mage::getModel('review/review')->appendSummary($this->_getProductCollection());
        return parent::_beforeToHtml();
    }

_getConfig

(

)

[protected]

Retrieve Catalog Config object

Returns:

Mage_Catalog_Model_Config

Definition at line 220 of file List.php.

    {
        return Mage::getSingleton('catalog/config');
    }

_getProductCollection

(

)

[protected]

Retrieve loaded category collection

Returns:

Mage_Eav_Model_Entity_Collection_Abstract

Reimplemented in Mage_Catalog_Block_Product_List_Promotion, and Mage_Catalog_Block_Product_List_Random.

Definition at line 72 of file List.php.

    {
        if (is_null($this->_productCollection)) {
            $layer = Mage::getSingleton('catalog/layer');
            /* @var $layer Mage_Catalog_Model_Layer */
            if ($this->getShowRootCategory()) {
                $this->setCategoryId(Mage::app()->getStore()->getRootCategoryId());
            }

            // if this is a product view page
            if (Mage::registry('product')) {
                // get collection of categories this product is associated with
                $categories = Mage::registry('product')->getCategoryCollection()
                    ->setPage(1, 1)
                    ->load();
                // if the product is associated with any category
                if ($categories->count()) {
                    // show products from this category
                    $this->setCategoryId(current($categories->getIterator()));
                }
            }

            $origCategory = null;
            if ($this->getCategoryId()) {
                $category = Mage::getModel('catalog/category')->load($this->getCategoryId());
                if ($category->getId()) {
                    $origCategory = $layer->getCurrentCategory();
                    $layer->setCurrentCategory($category);
                }
            }
            $this->_productCollection = $layer->getProductCollection();

            $this->prepareSortableFieldsByCategory($layer->getCurrentCategory());

            if ($origCategory) {
                $layer->setCurrentCategory($origCategory);
            }
        }
        return $this->_productCollection;
    }

addAttribute

(

$

code

)

Definition at line 204 of file List.php.

    {
        $this->_getProductCollection()->addAttributeToSelect($code);
        return $this;
    }

addColumnCountLayoutDepend	(	$	pageLayout,
		$	columnCount
	)

Add row size depends on page layout

Parameters:

	string	$pageLayout
	int	$rowSize

Returns:

Mage_Catalog_Block_Product_List

Definition at line 280 of file List.php.

    {
        $this->_columnCountLayoutDepend[$pageLayout] = $columnCount;
        return $this;
    }

getColumnCount

(

)

Retrieve product amount per row in grid display mode

Returns:

int

Definition at line 256 of file List.php.

    {
        if (!$this->_getData('column_count')) {
            $pageLayout = $this->getPageLayout();
            if ($pageLayout && $this->getColumnCountLayoutDepend($pageLayout->getCode())) {
                $this->setData(
                    'column_count',
                    $this->getColumnCountLayoutDepend($pageLayout->getCode())
                );
            } else {
                $this->setData('column_count', $this->_defaultColumnCount);
            }
        }

        return (int) $this->_getData('column_count');
    }

getColumnCountLayoutDepend

(

$

pageLayout

)

Retrieve row size depends on page layout

Parameters:

string

$pageLayout

Returns:

int|boolean

Definition at line 307 of file List.php.

    {
        if (isset($this->_columnCountLayoutDepend[$pageLayout])) {
            return $this->_columnCountLayoutDepend[$pageLayout];
        }

        return false;
    }

getLoadedProductCollection

(

)

Retrieve loaded category collection

Returns:

Mage_Eav_Model_Entity_Collection_Abstract

Definition at line 118 of file List.php.

    {
        return $this->_getProductCollection();
    }

getMode

(

)

Retrieve current view mode

Returns:

string

Definition at line 128 of file List.php.

    {
        return $this->getChild('toolbar')->getCurrentMode();
    }

getPageLayout

(

)

Retrieve current page layout

Returns:

Varien_Object

Definition at line 321 of file List.php.

    {
        return $this->helper('page/layout')->getCurrentPageLayout();
    }

getPriceBlockTemplate

(

)

Definition at line 210 of file List.php.

    {
        return $this->_getData('price_block_template');
    }

getToolbarBlock

(

)

Retrieve Toolbar block

Returns:

Mage_Catalog_Block_Product_List_Toolbar

Definition at line 177 of file List.php.

    {
        if ($blockName = $this->getToolbarBlockName()) {
            if ($block = $this->getLayout()->getBlock($blockName)) {
                return $block;
            }
        }
        $block = $this->getLayout()->createBlock($this->_defaultToolbarBlock, microtime());
        return $block;
    }

getToolbarHtml

(

)

Retrieve list toolbar HTML

Returns:

string

Definition at line 193 of file List.php.

    {
        return $this->getChildHtml('toolbar');
    }

prepareSortableFieldsByCategory

(

$

category

)

Prepare Sort By fields from Category Data

Parameters:

Mage_Catalog_Model_Category

$category

Returns:

Mage_Catalog_Block_Product_List

Definition at line 231 of file List.php.

                                                               {
        if (!$this->getAvailableOrders()) {
            $this->setAvailableOrders($category->getAvailableSortByOptions());
        }
        $availableOrders = $this->getAvailableOrders();
        if (!$this->getSortBy()) {
            if ($categorySortBy = $category->getDefaultSortBy()) {
                if (!$availableOrders) {
                    $availableOrders = $this->_getConfig()->getAttributeUsedForSortByArray();
                }
                if (isset($availableOrders[$categorySortBy])) {
                    $this->setSortBy($categorySortBy);
                }
            }
        }


        return $this;
    }

removeColumnCountLayoutDepend

(

$

pageLayout

)

Remove row size depends on page layout

Parameters:

string

$pageLayout

Returns:

Mage_Catalog_Block_Product_List

Definition at line 292 of file List.php.

    {
        if (isset($this->_columnCountLayoutDepend[$pageLayout])) {
            unset($this->_columnCountLayoutDepend[$pageLayout]);
        }

        return $this;
    }

setCollection

(

$

collection

)

Definition at line 198 of file List.php.

    {
        $this->_productCollection = $collection;
        return $this;
    }

---

Member Data Documentation

$_columnCountLayoutDepend = array() [protected]

Definition at line 64 of file List.php.

$_defaultColumnCount = 3 [protected]

Definition at line 56 of file List.php.

$_defaultToolbarBlock = 'catalog/product_list_toolbar' [protected]

Definition at line 42 of file List.php.

$_productCollection [protected]

Definition at line 49 of file List.php.

---

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

• app/code/core/Mage/Catalog/Block/Product/List.php