Mage_Catalog_Model_Layer_Filter_Abstract Class Reference

Inheritance diagram for Mage_Catalog_Model_Layer_Filter_Abstract:

List of all members.

Public Member Functions
	setRequestVar ($varName)
	getRequestVar ()
	getResetValue ()
	apply (Zend_Controller_Request_Abstract $request, $filterBlock)
	getItemsCount ()
	getItems ()
	getLayer ()
	setAttributeModel ($attribute)
	getAttributeModel ()
	getName ()
Protected Member Functions
	_getItemsData ()
	_initItems ()
	_createItem ($label, $value, $count=0)
	_getFilterEntityIds ()
	_getBaseCollectionSql ()
Protected Attributes
	$_requestVar
	$_items

---

Detailed Description

Definition at line 34 of file Abstract.php.

---

Member Function Documentation

_createItem	(	$	label,
		$	value,
		$	count = 0
	)			[protected]

Create filter item object

Parameters:

	string	$label
	mixed	$value
	int	$count

Returns:

Mage_Catalog_Model_Layer_Filter_Item

Definition at line 178 of file Abstract.php.

    {
        return Mage::getModel('catalog/layer_filter_item')
            ->setFilter($this)
            ->setLabel($label)
            ->setValue($value)
            ->setCount($count);
    }

_getBaseCollectionSql

(

)

[protected]

Get product collection select object with applied filters

Returns:

Varien_Db_Select

Definition at line 202 of file Abstract.php.

    {
        return $this->getLayer()->getProductCollection()->getSelect();
    }

_getFilterEntityIds

(

)

[protected]

Get all product ids from from collection with applied filters

Returns:

array

Definition at line 192 of file Abstract.php.

    {
        return $this->getLayer()->getProductCollection()->getAllIdsCache();
    }

_getItemsData

(

)

[protected]

Get data array for building filter items

result array should have next structure: array( $index => array( 'label' => $label, 'value' => $value, 'count' => $count ) )

Returns:

array

Reimplemented in Mage_Catalog_Model_Layer_Filter_Attribute, and Mage_Catalog_Model_Layer_Filter_Price.

Definition at line 129 of file Abstract.php.

    {
        return array();
    }

_initItems

(

)

[protected]

Initialize filter items

Returns:

Mage_Catalog_Model_Layer_Filter_Abstract

Definition at line 139 of file Abstract.php.

    {
        $data = $this->_getItemsData();
        $items=array();
        foreach ($data as $itemData) {
            $items[] = $this->_createItem(
                $itemData['label'],
                $itemData['value'],
                $itemData['count']
            );
        }
        $this->_items = $items;
        return $this;
    }

apply	(	Zend_Controller_Request_Abstract $	request,
		$	filterBlock
	)

Apply filter to collection

Parameters:

Zend_Controller_Request_Abstract

$request

Reimplemented in Mage_Catalog_Model_Layer_Filter_Attribute, Mage_Catalog_Model_Layer_Filter_Category, and Mage_Catalog_Model_Layer_Filter_Price.

Definition at line 87 of file Abstract.php.

    {
        return $this;
    }

getAttributeModel

(

)

Get attribute model associated with filter

Returns:

Mage_Eav_Model_Entity_Attribute

Definition at line 225 of file Abstract.php.

    {
        $attribute = $this->getData('attribute_model');
        if (is_null($attribute)) {
            Mage::throwException(Mage::helper('catalog')->__('Attribute model not defined'));
        }
        return $attribute;
    }

getItems

(

)

Get all filter items

Returns:

array

Definition at line 107 of file Abstract.php.

    {
        if (is_null($this->_items)) {
            $this->_initItems();
        }
        return $this->_items;
    }

getItemsCount

(

)

Get fiter items count

Returns:

int

Definition at line 97 of file Abstract.php.

    {
        return count($this->getItems());
    }

getLayer

(

)

Retrieve layer object

Returns:

Mage_Catalog_Model_Layer

Definition at line 160 of file Abstract.php.

    {
        $layer = $this->_getData('layer');
        if (is_null($layer)) {
            $layer = Mage::getSingleton('catalog/layer');
            $this->setData('layer', $layer);
        }
        return $layer;
    }

getName

(

)

Get filter text label

Returns:

string

Reimplemented in Mage_Catalog_Model_Layer_Filter_Category.

Definition at line 239 of file Abstract.php.

    {
        return $this->getAttributeModel()->getFrontendLabel();
    }

getRequestVar

(

)

Get request variable name which is used for apply filter

Returns:

string

Definition at line 67 of file Abstract.php.

    {
        return $this->_requestVar;
    }

getResetValue

(

)

Get filter value for reset current filter state

Returns:

mixed

Reimplemented in Mage_Catalog_Model_Layer_Filter_Category.

Definition at line 77 of file Abstract.php.

    {
        return null;
    }

setAttributeModel

(

$

attribute

)

Set attribute model to filter

Parameters:

Mage_Eav_Model_Entity_Attribute

$attribute

Returns:

Mage_Catalog_Model_Layer_Filter_Abstract

Definition at line 213 of file Abstract.php.

    {
        $this->setRequestVar($attribute->getAttributeCode());
        $this->setData('attribute_model', $attribute);
        return $this;
    }

setRequestVar

(

$

varName

)

Set request variable name which is used for apply filter

Parameters:

string

$varName

Returns:

Mage_Catalog_Model_Layer_Filter_Abstract

Definition at line 56 of file Abstract.php.

    {
        $this->_requestVar = $varName;
        return $this;
    }

---

Member Data Documentation

$_items [protected]

Definition at line 48 of file Abstract.php.

$_requestVar [protected]

Definition at line 41 of file Abstract.php.

---

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

• app/code/core/Mage/Catalog/Model/Layer/Filter/Abstract.php