Mage_Catalog_Helper_Product_Compare Class Reference

Inheritance diagram for Mage_Catalog_Helper_Product_Compare:

List of all members.

Public Member Functions
	getListUrl ()
	getAddUrl ($product)
	getAddToWishlistUrl ($product)
	getAddToCartUrl ($product)
	getRemoveUrl ($item)
	getClearListUrl ()
	getItemCollection ()
	calculate ()
	getItemCount ()
	hasItems ()
	setAllowUsedFlat ($flag)
	getAllowUsedFlat ()
Protected Member Functions
	_getUrlParams ($product)
Protected Attributes
	$_itemCollection
	$_hasItems
	$_allowUsedFlat = true

---

Detailed Description

Definition at line 35 of file Compare.php.

---

Member Function Documentation

_getUrlParams

(

$

product

)

[protected]

Get parameters used for build add product to compare list urls

Parameters:

Mage_Catalog_Model_Product

$product

Returns:

array

Definition at line 84 of file Compare.php.

    {
        return array(
            'product' => $product->getId(),
            Mage_Core_Controller_Front_Action::PARAM_NAME_URL_ENCODED => $this->getEncodedUrl()
        );
    }

calculate

(

)

Calculate cache product compare collection

Returns:

Mage_Catalog_Helper_Product_Compare

Definition at line 200 of file Compare.php.

    {
        if (!Mage::getSingleton('customer/session')->isLoggedIn()
            and !Mage::getSingleton('log/visitor')->hasCatalogCompareItemsCount()
        ) {
            Mage::getSingleton('log/visitor')->setCatalogCompareItemsCount(0);
            return $this;
        }

        $itemCollection = Mage::getResourceModel('catalog/product_compare_item_collection');
        /* @var $itemCollection Mage_Catalog_Model_Resource_Eav_Mysql4_Product_Compare_Item_Collection */
        $itemCollection->setStoreId(Mage::app()->getStore()->getId());
        if (Mage::getSingleton('customer/session')->isLoggedIn()) {
            $itemCollection->setCustomerId(Mage::getSingleton('customer/session')->getCustomerId());
        }
        else {
            $itemCollection->setVisitorId(Mage::getSingleton('log/visitor')->getId());
        }
        Mage::getSingleton('catalog/product_visibility')
            ->addVisibleInSiteFilterToCollection($itemCollection);

        Mage::getSingleton('log/visitor')->setCatalogCompareItemsCount($itemCollection->getSize());
        return $this;
    }

getAddToCartUrl

(

$

product

)

Retrive add to cart url

Parameters:

Mage_Catalog_Model_Product

$product

Returns:

string

Definition at line 127 of file Compare.php.

    {
        $beforeCompareUrl = Mage::getSingleton('catalog/session')->getBeforeCompareUrl();
        $params = array(
            'product'=>$product->getId(),
            Mage_Core_Controller_Front_Action::PARAM_NAME_URL_ENCODED => $this->getEncodedUrl($beforeCompareUrl)
        );

        return $this->_getUrl('checkout/cart/add', $params);
    }

getAddToWishlistUrl

(

$

product

)

Retrive add to wishlist url

Parameters:

Mage_Catalog_Model_Product

$product

Returns:

string

Definition at line 109 of file Compare.php.

    {
        $beforeCompareUrl = Mage::getSingleton('catalog/session')->getBeforeCompareUrl();

        $params = array(
            'product'=>$product->getId(),
            Mage_Core_Controller_Front_Action::PARAM_NAME_URL_ENCODED => $this->getEncodedUrl($beforeCompareUrl)
        );

        return $this->_getUrl('wishlist/index/add', $params);
    }

getAddUrl

(

$

product

)

Retrieve url for adding product to conpare list

Parameters:

Mage_Catalog_Model_Product

$product

Returns:

string

Definition at line 98 of file Compare.php.

    {
        return $this->_getUrl('catalog/product_compare/add', $this->_getUrlParams($product));
    }

getAllowUsedFlat

(

)

Retrieve is allow used flat (for collection)

Returns:

bool

Definition at line 265 of file Compare.php.

    {
        return $this->_allowUsedFlat;
    }

getClearListUrl

(

)

Retrieve clear compare list url

Returns:

string

Definition at line 158 of file Compare.php.

    {
        $params = array(
            Mage_Core_Controller_Front_Action::PARAM_NAME_URL_ENCODED => $this->getEncodedUrl()
        );
        return $this->_getUrl('catalog/product_compare/clear', $params);
    }

getItemCollection

(

)

Retrieve compare list items collection

Returns:

Definition at line 171 of file Compare.php.

    {
        if (!$this->_itemCollection) {
            $this->_itemCollection = Mage::getResourceModel('catalog/product_compare_item_collection')
                ->useProductItem(true)
                ->setStoreId(Mage::app()->getStore()->getId());

            if (Mage::getSingleton('customer/session')->isLoggedIn()) {
                $this->_itemCollection->setCustomerId(Mage::getSingleton('customer/session')->getCustomerId());
            }
            else {
                $this->_itemCollection->setVisitorId(Mage::getSingleton('log/visitor')->getId());
            }

            Mage::getSingleton('catalog/product_visibility')->addVisibleInSiteFilterToCollection($this->_itemCollection);

            $this->_itemCollection->addAttributeToSelect('name')
                ->addUrlRewrite()
                ->load();
        }

        return $this->_itemCollection;
    }

getItemCount

(

)

Retrieve count of items in compare list

Returns:

int

Definition at line 230 of file Compare.php.

    {
        if (is_null(Mage::getSingleton('log/visitor')->getCatalogCompareItemsCount())) {
            $this->calculate();
        }
        return Mage::getSingleton('log/visitor')->getCatalogCompareItemsCount();
    }

getListUrl

(

)

Retrieve compare list url

Returns:

string

Definition at line 63 of file Compare.php.

    {
         $itemIds = array();
         foreach ($this->getItemCollection() as $item) {
             $itemIds[] = $item->getId();
         }

         $params = array(
            'items'=>implode(',', $itemIds),
            Mage_Core_Controller_Front_Action::PARAM_NAME_URL_ENCODED => $this->getEncodedUrl()
         );

         return $this->_getUrl('catalog/product_compare', $params);
    }

getRemoveUrl

(

$

item

)

Retrieve remove item from compare list url

Parameters:

$item

Returns:

string

Definition at line 144 of file Compare.php.

    {
        $params = array(
            'product'=>$item->getId(),
            Mage_Core_Controller_Front_Action::PARAM_NAME_URL_ENCODED => $this->getEncodedUrl()
        );
        return $this->_getUrl('catalog/product_compare/remove', $params);
    }

hasItems

(

)

Check has items

Returns:

bool

Definition at line 243 of file Compare.php.

    {
        return $this->getItemCount() > 0;
    }

setAllowUsedFlat

(

$

flag

)

Set is allow used flat (for collection)

Parameters:

bool

$flag

Returns:

Mage_Catalog_Helper_Product_Compare

Definition at line 254 of file Compare.php.

    {
        $this->_allowUsedFlat = (bool)$flag;
        return $this;
    }

---

Member Data Documentation

$_allowUsedFlat = true [protected]

Definition at line 56 of file Compare.php.

$_hasItems [protected]

Definition at line 49 of file Compare.php.

$_itemCollection [protected]

Definition at line 42 of file Compare.php.

---

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

• app/code/core/Mage/Catalog/Helper/Product/Compare.php