Inheritance diagram for Compare:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Catalog\Model\ResourceModel\Product\Compare\Item\CollectionFactory $itemCollectionFactory, \Magento\Catalog\Model\Product\Visibility $catalogProductVisibility, \Magento\Customer\Model\Visitor $customerVisitor, \Magento\Customer\Model\Session $customerSession, \Magento\Catalog\Model\Session $catalogSession, \Magento\Framework\Data\Form\FormKey $formKey, \Magento\Wishlist\Helper\Data $wishlistHelper, \Magento\Framework\Data\Helper\PostHelper $postHelper)

	getListUrl ()

	getPostDataParams ($product)

	getAddUrl ()

	getAddToWishlistParams ($product)

	getAddToCartUrl ($product)

	getRemoveUrl ()

	getPostDataRemove ($product)

	getClearListUrl ()

	getPostDataClearList ()

	getItemCollection ()

	getItemCount ()

	hasItems ()

	setAllowUsedFlat ($flag)

	getAllowUsedFlat ()

	setCustomerId ($id)

Public Member Functions inherited from Data
	getCurrentBase64Url ()

	getEncodedUrl ($url=null)

	addRequestParam ($url, $param)

	removeRequestParam ($url, $paramKey, $caseSensitive=false)

Public Member Functions inherited from AbstractHelper
	__construct (Context $context)

	isModuleOutputEnabled ($moduleName=null)

Protected Attributes
	$_itemCollection

	$_hasItems

	$_allowUsedFlat = true

	$_customerId = null

	$_catalogSession

	$_customerSession

	$_customerVisitor

	$_catalogProductVisibility

	$_itemCollectionFactory

	$_formKey

	$_wishlistHelper

	$postHelper

Protected Attributes inherited from AbstractHelper
	$_moduleName

	$_request

	$_moduleManager

	$_logger

	$_urlBuilder

	$_httpHeader

	$_eventManager

	$_remoteAddress

	$urlEncoder

	$urlDecoder

	$scopeConfig

	$_cacheConfig

Additional Inherited Members
Protected Member Functions inherited from AbstractHelper
	_getRequest ()

	_getModuleName ()

	_getUrl ($route, $params=[])

Detailed Description

Catalog Product Compare Helper

@api @SuppressWarnings(PHPMD.LongVariable) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 19 of file Compare.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Catalog\Model\ResourceModel\Product\Compare\Item\CollectionFactory	$itemCollectionFactory,
		\Magento\Catalog\Model\Product\Visibility	$catalogProductVisibility,
		\Magento\Customer\Model\Visitor	$customerVisitor,
		\Magento\Customer\Model\Session	$customerSession,
		\Magento\Catalog\Model\Session	$catalogSession,
		\Magento\Framework\Data\Form\FormKey	$formKey,
		\Magento\Wishlist\Helper\Data	$wishlistHelper,
		\Magento\Framework\Data\Helper\PostHelper	$postHelper
	)

Parameters

\Magento\Framework\App\Helper\Context	$context
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Catalog\Model\ResourceModel\Product\Compare\Item\CollectionFactory	$itemCollectionFactory
\Magento\Catalog\Model\Product\Visibility	$catalogProductVisibility
\Magento\Customer\Model\Visitor	$customerVisitor
\Magento\Customer\Model\Session	$customerSession
\Magento\Catalog\Model\Session	$catalogSession
\Magento\Framework\Data\Form\FormKey	$formKey
\Magento\Wishlist\Helper\Data	$wishlistHelper
\Magento\Framework\Data\Helper\PostHelper	$postHelper	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 117 of file Compare.php.

       {
         $this->_itemCollectionFactory = $itemCollectionFactory;
         $this->_catalogProductVisibility = $catalogProductVisibility;
         $this->_customerVisitor = $customerVisitor;
         $this->_customerSession = $customerSession;
         $this->_catalogSession = $catalogSession;
         $this->_formKey = $formKey;
         $this->_wishlistHelper = $wishlistHelper;
         $this->postHelper = $postHelper;
         $this->_storeManager = $storeManager;
         parent::__construct($context);
     }

Member Function Documentation

◆ getAddToCartUrl()

getAddToCartUrl ( $product )

Retrieve add to cart url

Parameters

Product $product

Returns: string

Definition at line 205 of file Compare.php.

     {
         $beforeCompareUrl = $this->_catalogSession->getBeforeCompareUrl();
         $params = [
             'product' => $product->getId(),
             \Magento\Framework\App\ActionInterface::PARAM_NAME_URL_ENCODED => $this->getEncodedUrl($beforeCompareUrl),
             '_secure' => $this->_getRequest()->isSecure()
         ];
 
         return $this->_getUrl('checkout/cart/add', $params);
     }

◆ getAddToWishlistParams()

getAddToWishlistParams ( $product )

Retrieve add to wishlist params

Parameters

Product $product

Returns: string

Definition at line 188 of file Compare.php.

     {
         $beforeCompareUrl = $this->_catalogSession->getBeforeCompareUrl();
 
         $encodedUrl = [
             \Magento\Framework\App\ActionInterface::PARAM_NAME_URL_ENCODED => $this->getEncodedUrl($beforeCompareUrl)
         ];
 
         return $this->_wishlistHelper->getAddParams($product, $encodedUrl);
     }

◆ getAddUrl()

getAddUrl ( )

Retrieve url for adding product to compare list

Returns: string

Definition at line 177 of file Compare.php.

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

◆ getAllowUsedFlat()

getAllowUsedFlat ( )

Retrieve is allow used flat (for collection)

Returns: bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 375 of file Compare.php.

     {
         return $this->_allowUsedFlat;
     }

◆ getClearListUrl()

getClearListUrl ( )

Retrieve clear compare list url

Returns: string

Definition at line 249 of file Compare.php.

     {
         return $this->_getUrl('catalog/product_compare/clear');
     }

◆ getItemCollection()

getItemCollection ( )

Retrieve compare list items collection

Returns: Collection

Definition at line 274 of file Compare.php.

     {
         if (!$this->_itemCollection) {
             // cannot be placed in constructor because of the cyclic dependency which cannot be fixed with proxy class
             // collection uses this helper in constructor when calling isEnabledFlat() method
             $this->_itemCollection = $this->_itemCollectionFactory->create();
             $this->_itemCollection->useProductItem(true)->setStoreId($this->_storeManager->getStore()->getId());
 
             if ($this->_customerSession->isLoggedIn()) {
                 $this->_itemCollection->setCustomerId($this->_customerSession->getCustomerId());
             } elseif ($this->_customerId) {
                 $this->_itemCollection->setCustomerId($this->_customerId);
             } else {
                 $this->_itemCollection->setVisitorId($this->_customerVisitor->getId());
             }
 
             $this->_itemCollection->setVisibility($this->_catalogProductVisibility->getVisibleInSiteIds());
 
             /* Price data is added to consider item stock status using price index */
             $this->_itemCollection->addPriceData();
 
             $this->_itemCollection->addAttributeToSelect('name')->addUrlRewrite()->load();
 
             /* update compare items count */
             $this->_catalogSession->setCatalogCompareItemsCount(count($this->_itemCollection));
         }
 
         return $this->_itemCollection;
     }

◆ getItemCount()

getItemCount ( )

Retrieve count of items in compare list

Returns: int

Definition at line 338 of file Compare.php.

     {
         if (!$this->_catalogSession->hasCatalogCompareItemsCount()) {
             $this->calculate();
         }
 
         return $this->_catalogSession->getCatalogCompareItemsCount();
     }

◆ getListUrl()

getListUrl ( )

Retrieve compare list url

Returns: string

Definition at line 146 of file Compare.php.

     {
         $itemIds = [];
         foreach ($this->getItemCollection() as $item) {
             $itemIds[] = $item->getId();
         }
 
         $params = [
             'items' => implode(',', $itemIds),
             \Magento\Framework\App\ActionInterface::PARAM_NAME_URL_ENCODED => $this->getEncodedUrl()
         ];
 
         return $this->_getUrl('catalog/product_compare', $params);
     }

◆ getPostDataClearList()

getPostDataClearList ( )

Get parameters to clear compare list

Returns: string

Definition at line 259 of file Compare.php.

     {
         $params = [
             \Magento\Framework\App\ActionInterface::PARAM_NAME_URL_ENCODED => '',
             'confirmation' => true,
             'confirmationMessage' => __('Are you sure you want to remove all items from your Compare Products list?'),
         ];
         return $this->postHelper->getPostData($this->getClearListUrl(), $params);
     }

◆ getPostDataParams()

getPostDataParams ( $product )

Get parameters used for build add product to compare list urls

Parameters

Product $product

Returns: string

Definition at line 167 of file Compare.php.

     {
         return $this->postHelper->getPostData($this->getAddUrl(), ['product' => $product->getId()]);
     }

◆ getPostDataRemove()

getPostDataRemove ( $product )

Get parameters to remove products from compare list

Parameters

Product $product

Returns: string

Definition at line 233 of file Compare.php.

     {
         $data = [
             \Magento\Framework\App\ActionInterface::PARAM_NAME_URL_ENCODED => '',
             'product' => $product->getId(),
             'confirmation' => true,
             'confirmationMessage' => __('Are you sure you want to remove this item from your Compare Products list?')
         ];
         return $this->postHelper->getPostData($this->getRemoveUrl(), $data);
     }

◆ getRemoveUrl()

getRemoveUrl ( )

Retrieve remove item from compare list url

Returns: string

Definition at line 222 of file Compare.php.

     {
         return $this->_getUrl('catalog/product_compare/remove');
     }

◆ hasItems()

hasItems ( )

Check has items

Returns: bool

Definition at line 352 of file Compare.php.

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

◆ setAllowUsedFlat()

setAllowUsedFlat ( $flag )

Set is allow used flat (for collection)

Parameters

bool $flag

Returns: $this

Definition at line 363 of file Compare.php.

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

◆ setCustomerId()

setCustomerId ( $id )

Setter for customer id

Parameters

int $id

Returns: $this

Definition at line 386 of file Compare.php.

     {
         $this->_customerId = $id;
         return $this;
     }

Field Documentation

◆ $_allowUsedFlat

$_allowUsedFlat = true

protected

Definition at line 40 of file Compare.php.

◆ $_catalogProductVisibility

$_catalogProductVisibility

protected

Definition at line 75 of file Compare.php.

◆ $_catalogSession

$_catalogSession

protected

Definition at line 54 of file Compare.php.

◆ $_customerId

$_customerId = null

protected

Definition at line 47 of file Compare.php.

◆ $_customerSession

$_customerSession

protected

Definition at line 61 of file Compare.php.

◆ $_customerVisitor

$_customerVisitor

protected

Definition at line 68 of file Compare.php.

◆ $_formKey

$_formKey

protected

Definition at line 87 of file Compare.php.

◆ $_hasItems

$_hasItems

protected

Definition at line 33 of file Compare.php.

◆ $_itemCollection

$_itemCollection

protected

Definition at line 26 of file Compare.php.

◆ $_itemCollectionFactory

$_itemCollectionFactory

protected

Definition at line 82 of file Compare.php.

◆ $_wishlistHelper

$_wishlistHelper

protected

Definition at line 92 of file Compare.php.

◆ $postHelper

$postHelper

protected

Definition at line 97 of file Compare.php.

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

vendor/magento/module-catalog/Helper/Product/Compare.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAddToCartUrl()

◆ getAddToWishlistParams()

◆ getAddUrl()

◆ getAllowUsedFlat()

◆ getClearListUrl()

◆ getItemCollection()

◆ getItemCount()

◆ getListUrl()

◆ getPostDataClearList()

◆ getPostDataParams()

◆ getPostDataRemove()

◆ getRemoveUrl()

◆ hasItems()

◆ setAllowUsedFlat()

◆ setCustomerId()

Field Documentation

◆ $_allowUsedFlat

◆ $_catalogProductVisibility

◆ $_catalogSession

◆ $_customerId

◆ $_customerSession

◆ $_customerVisitor

◆ $_formKey

◆ $_hasItems

◆ $_itemCollection

◆ $_itemCollectionFactory

◆ $_wishlistHelper

◆ $postHelper