Data Class Reference

Inheritance diagram for Data:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, \Magento\Framework\Registry $coreRegistry, \Magento\Customer\Model\Session $customerSession, \Magento\Wishlist\Model\WishlistFactory $wishlistFactory, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\Data\Helper\PostHelper $postDataHelper, \Magento\Customer\Helper\View $customerViewHelper, WishlistProviderInterface $wishlistProvider, \Magento\Catalog\Api\ProductRepositoryInterface $productRepository)
	setCustomer (\Magento\Customer\Api\Data\CustomerInterface $customer)
	getCustomer ()
	getWishlist ()
	getItemCount ()
	getWishlistItemCollection ()
	getRemoveParams ($item, $addReferer=false)
	getConfigureUrl ($item)
	getAddParams ($item, array $params=[])
	getMoveFromCartParams ($itemId)
	getUpdateParams ($item)
	getAddToCartUrl ($item)
	getAddToCartParams ($item, $addReferer=false)
	addRefererToParams (array $params)
	getSharedAddToCartUrl ($item)
	getSharedAddAllToCartUrl ()
	getListUrl ($wishlistId=null)
	isAllow ()
	isAllowInCart ()
	getCustomerName ()
	getRssUrl ($wishlistId=null)
	defaultCommentString ()
	getDefaultWishlistName ()
	calculate ()
	isDisplayQty ()
	getProductUrl ($item, $additional=[])
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Data Fields
const	XML_PATH_WISHLIST_LINK_USE_QTY = 'wishlist/wishlist_link/use_qty'
const	XML_PATH_CATALOGINVENTORY_SHOW_OUT_OF_STOCK = 'cataloginventory/options/show_out_of_stock'

Protected Member Functions
	_isCustomerLogIn ()
	_getCurrentCustomer ()
	_createWishlistItemCollection ()
	_getUrlStore ($item)
	_getCartUrlParameters ($item)
Protected Member Functions inherited from AbstractHelper
	_getRequest ()
	_getModuleName ()
	_getUrl ($route, $params=[])

Protected Attributes
	$_currentCustomer
	$_wishlist
	$_productCollection
	$_wishlistItemCollection
	$_coreRegistry
	$_customerSession
	$_wishlistFactory
	$_storeManager
	$_postDataHelper
	$_customerViewHelper
	$wishlistProvider
	$productRepository
Protected Attributes inherited from AbstractHelper
	$_moduleName
	$_request
	$_moduleManager
	$_logger
	$_urlBuilder
	$_httpHeader
	$_eventManager
	$_remoteAddress
	$urlEncoder
	$urlDecoder
	$scopeConfig
	$_cacheConfig

Detailed Description

Wishlist Data Helper

Author

Magento Core Team core@.nosp@m.mage.nosp@m.ntoco.nosp@m.mmer.nosp@m.ce.co.nosp@m.m @SuppressWarnings(PHPMD.CouplingBetweenObjects)

@api

Since

100.0.2

Definition at line 20 of file Data.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		\Magento\Framework\Registry	$coreRegistry,
		\Magento\Customer\Model\Session	$customerSession,
		\Magento\Wishlist\Model\WishlistFactory	$wishlistFactory,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\Data\Helper\PostHelper	$postDataHelper,
		\Magento\Customer\Helper\View	$customerViewHelper,
		WishlistProviderInterface	$wishlistProvider,
		\Magento\Catalog\Api\ProductRepositoryInterface	$productRepository
	)

Parameters

\Magento\Framework\App\Helper\Context	$context
\Magento\Framework\Registry	$coreRegistry
\Magento\Customer\Model\Session	$customerSession
\Magento\Wishlist\Model\WishlistFactory	$wishlistFactory
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\Data\Helper\PostHelper	$postDataHelper
\Magento\Customer\Helper\View	$customerViewHelper
WishlistProviderInterface	$wishlistProvider
\Magento\Catalog\Api\ProductRepositoryInterface	$productRepository

Definition at line 113 of file Data.php.

      {
        $this->_coreRegistry = $coreRegistry;
        $this->_customerSession = $customerSession;
        $this->_wishlistFactory = $wishlistFactory;
        $this->_storeManager = $storeManager;
        $this->_postDataHelper = $postDataHelper;
        $this->_customerViewHelper = $customerViewHelper;
        $this->wishlistProvider = $wishlistProvider;
        $this->productRepository = $productRepository;
        parent::__construct($context);
    }

Member Function Documentation

_createWishlistItemCollection()

_createWishlistItemCollection ( )

protected

Create wishlist item collection

Returns

\Magento\Wishlist\Model\ResourceModel\Item\Collection

Definition at line 232 of file Data.php.

    {
        return $this->getWishlist()->getItemCollection();
    }

_getCartUrlParameters()

_getCartUrlParameters (   $item )

protected

Get cart URL parameters

Parameters

string | \Magento\Catalog\Model\Product | \Magento\Wishlist\Model\Item

$item

Returns

array

Definition at line 459 of file Data.php.

    {
        $params = [
            'item' => is_string($item) ? $item : $item->getWishlistItemId(),
        ];
        if ($item instanceof \Magento\Wishlist\Model\Item) {
            $params['qty'] = $item->getQty();
        }
        return $params;
    }

_getCurrentCustomer()

_getCurrentCustomer ( )

protected

Retrieve logged in customer

Returns

\Magento\Customer\Api\Data\CustomerInterface

Definition at line 150 of file Data.php.

    {
        return $this->getCustomer();
    }

_getUrlStore()

_getUrlStore (   $item )

protected

Retrieve Item Store for URL

Parameters

\Magento\Catalog\Model\Product | \Magento\Wishlist\Model\Item

$item

Returns

\Magento\Store\Model\Store

Definition at line 256 of file Data.php.

    {
        $storeId = null;
        $product = null;
        if ($item instanceof \Magento\Wishlist\Model\Item) {
            $product = $item->getProduct();
        } elseif ($item instanceof \Magento\Catalog\Model\Product) {
            $product = $item;
        }
        if ($product) {
            if ($product->isVisibleInSiteVisibility()) {
                $storeId = $product->getStoreId();
            } else {
                if ($product->hasUrlDataObject()) {
                    $storeId = $product->getUrlDataObject()->getStoreId();
                }
            }
        }
        return $this->_storeManager->getStore($storeId);
    }

_isCustomerLogIn()

_isCustomerLogIn ( )

protected

Retrieve customer login status

Returns

bool

Definition at line 140 of file Data.php.

    {
        return $this->_customerSession->isLoggedIn();
    }

addRefererToParams()

addRefererToParams

(

array

$params

)

Add UENC referer to params

Parameters

array

$params

Returns

array

Definition at line 420 of file Data.php.

    {
        $params[ActionInterface::PARAM_NAME_URL_ENCODED] =
            $this->urlEncoder->encode($this->_getRequest()->getServer('HTTP_REFERER'));
        return $params;
    }

calculate()

calculate

(

)

Calculate count of wishlist items and put value to customer session. Method called after wishlist modifications and trigger 'wishlist_items_renewed' event. Depends from configuration.

Returns

$this

Definition at line 570 of file Data.php.

    {
        $count = 0;
        if ($this->getCustomer()) {
            $collection = $this->getWishlistItemCollection()->setInStockFilter(true);
            if ($this->scopeConfig->getValue(
                self::XML_PATH_WISHLIST_LINK_USE_QTY,
                \Magento\Store\Model\ScopeInterface::SCOPE_STORE
            )
            ) {
                $count = $collection->getItemsQty();
            } else {
                $count = $collection->count();
            }
            $this->_customerSession->setWishlistDisplayType(
                $this->scopeConfig->getValue(
                    self::XML_PATH_WISHLIST_LINK_USE_QTY,
                    \Magento\Store\Model\ScopeInterface::SCOPE_STORE
                )
            );
            $this->_customerSession->setDisplayOutOfStockProducts(
                $this->scopeConfig->getValue(
                    self::XML_PATH_CATALOGINVENTORY_SHOW_OUT_OF_STOCK,
                    \Magento\Store\Model\ScopeInterface::SCOPE_STORE
                )
            );
        }
        $this->_customerSession->setWishlistItemCount($count);
        $this->_eventManager->dispatch('wishlist_items_renewed');
        return $this;
    }

defaultCommentString()

defaultCommentString

(

)

Retrieve default empty comment message

Returns

\Magento\Framework\Phrase

Definition at line 548 of file Data.php.

    {
        return __('Comment');
    }

getAddParams()

getAddParams	(		$item,
		array	$params = []
	)

Retrieve params for adding product to wishlist

Parameters

\Magento\Catalog\Model\Product | \Magento\Wishlist\Model\Item	$item
array	$params

Returns

string

Definition at line 321 of file Data.php.

    {
        $productId = null;
        if ($item instanceof \Magento\Catalog\Model\Product) {
            $productId = $item->getEntityId();
        }
        if ($item instanceof \Magento\Wishlist\Model\Item) {
            $productId = $item->getProductId();
        }

        $url = $this->_getUrlStore($item)->getUrl('wishlist/index/add');
        if ($productId) {
            $params['product'] = $productId;
        }

        return $this->_postDataHelper->getPostData($url, $params);
    }

getAddToCartParams()

getAddToCartParams	(		$item,
			$addReferer = false
	)

Retrieve URL for adding item to shopping cart

Parameters

string | \Magento\Catalog\Model\Product | \Magento\Wishlist\Model\Item	$item
bool	$addReferer

Returns

string

Definition at line 399 of file Data.php.

    {
        $params = $this->_getCartUrlParameters($item);
        $params[ActionInterface::PARAM_NAME_URL_ENCODED] = '';

        if ($addReferer) {
            $params = $this->addRefererToParams($params);
        }

        return $this->_postDataHelper->getPostData(
            $this->_getUrlStore($item)->getUrl('wishlist/index/cart'),
            $params
        );
    }

getAddToCartUrl()

getAddToCartUrl

(

$item

)

Retrieve params for adding item to shopping cart

Parameters

string | \Magento\Catalog\Model\Product | \Magento\Wishlist\Model\Item

$item

Returns

string

Definition at line 387 of file Data.php.

    {
        return $this->_getUrlStore($item)->getUrl('wishlist/index/cart', $this->_getCartUrlParameters($item));
    }

getConfigureUrl()

getConfigureUrl

(

$item

)

Retrieve URL for configuring item from wishlist

Parameters

\Magento\Catalog\Model\Product | \Magento\Wishlist\Model\Item

$item

Returns

string

Definition at line 303 of file Data.php.

    {
        return $this->_getUrl(
            'wishlist/index/configure',
            [
                'id' => $item->getWishlistItemId(),
                'product_id' => $item->getProductId()
            ]
        );
    }

getCustomer()

getCustomer

(

)

Retrieve current customer

Returns

\Magento\Customer\Api\Data\CustomerInterface|null

Definition at line 171 of file Data.php.

    {
        if (!$this->_currentCustomer && $this->_customerSession->isLoggedIn()) {
            $this->_currentCustomer = $this->_customerSession->getCustomerDataObject();
        }
        return $this->_currentCustomer;
    }

getCustomerName()

getCustomerName

(

)

Retrieve customer name

Returns

string|null

Definition at line 517 of file Data.php.

    {
        return $this->getCustomer()
            ? $this->_customerViewHelper->getCustomerName($this->getCustomer())
            : null;
    }

getDefaultWishlistName()

getDefaultWishlistName

(

)

Retrieve default empty comment message

Returns

\Magento\Framework\Phrase

Definition at line 558 of file Data.php.

    {
        return __('Wish List');
    }

getItemCount()

getItemCount

(

)

Retrieve wishlist item count (include config settings)

Used in top link menu only

Returns

int

Definition at line 203 of file Data.php.

    {
        $storedDisplayType = $this->_customerSession->getWishlistDisplayType();
        $currentDisplayType = $this->scopeConfig->getValue(
            self::XML_PATH_WISHLIST_LINK_USE_QTY,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        );

        $storedDisplayOutOfStockProducts = $this->_customerSession->getDisplayOutOfStockProducts();
        $currentDisplayOutOfStockProducts = $this->scopeConfig->getValue(
            self::XML_PATH_CATALOGINVENTORY_SHOW_OUT_OF_STOCK,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        );
        if (!$this->_customerSession->hasWishlistItemCount() ||
            $currentDisplayType != $storedDisplayType ||
            $this->_customerSession->hasDisplayOutOfStockProducts() ||
            $currentDisplayOutOfStockProducts != $storedDisplayOutOfStockProducts
        ) {
            $this->calculate();
        }

        return $this->_customerSession->getWishlistItemCount();
    }

getListUrl()

getListUrl

(

$wishlistId = null

)

Retrieve customer wishlist url

Parameters

int

$wishlistId

Returns

string

Definition at line 476 of file Data.php.

    {
        $params = [];
        if ($wishlistId) {
            $params['wishlist_id'] = $wishlistId;
        }
        return $this->_getUrl('wishlist', $params);
    }

getMoveFromCartParams()

getMoveFromCartParams

(

$itemId

)

Retrieve params for adding product to wishlist

Parameters

int

$itemId

Returns

string

Definition at line 346 of file Data.php.

    {
        $url = $this->_getUrl('wishlist/index/fromcart');
        $params = ['item' => $itemId];
        return $this->_postDataHelper->getPostData($url, $params);
    }

getProductUrl()

getProductUrl	(		$item,
			$additional = []
	)

Retrieve URL to item Product

Parameters

\Magento\Wishlist\Model\Item | \Magento\Catalog\Model\Product	$item
array	$additional

Returns

string

Definition at line 622 of file Data.php.

    {
        if ($item instanceof \Magento\Catalog\Model\Product) {
            $product = $item;
        } else {
            $product = $item->getProduct();
        }
        $buyRequest = $item->getBuyRequest();
        if (is_object($buyRequest)) {
            $config = $buyRequest->getSuperProductConfig();
            if ($config && !empty($config['product_id'])) {
                $product = $this->productRepository->getById(
                    $config['product_id'],
                    false,
                    $this->_storeManager->getStore()->getStoreId()
                );
            }
        }
        return $product->getUrlModel()->getUrl($product, $additional);
    }

getRemoveParams()

getRemoveParams	(		$item,
			$addReferer = false
	)

Retrieve params for removing item from wishlist

Parameters

\Magento\Catalog\Model\Product | \Magento\Wishlist\Model\Item	$item
bool	$addReferer

Returns

string

Definition at line 284 of file Data.php.

    {
        $url = $this->_getUrl('wishlist/index/remove');
        $params = ['item' => $item->getWishlistItemId()];
        $params[ActionInterface::PARAM_NAME_URL_ENCODED] = '';

        if ($addReferer) {
            $params = $this->addRefererToParams($params);
        }

        return $this->_postDataHelper->getPostData($url, $params);
    }

getRssUrl()

getRssUrl

(

$wishlistId = null

)

Retrieve RSS URL

Parameters

int | string | null

$wishlistId

Returns

string

Definition at line 530 of file Data.php.

    {
        $customer = $this->_getCurrentCustomer();
        if ($customer) {
            $key = $customer->getId() . ',' . $customer->getEmail();
            $params = ['data' => $this->urlEncoder->encode($key), '_secure' => false];
        }
        if ($wishlistId) {
            $params['wishlist_id'] = $wishlistId;
        }
        return $this->_getUrl('wishlist/index/rss', $params);
    }

getSharedAddAllToCartUrl()

getSharedAddAllToCartUrl

(

)

Retrieve URL for adding All items to shopping cart from shared wishlist

Returns

string

Definition at line 446 of file Data.php.

    {
        return $this->_postDataHelper->getPostData(
            $this->_storeManager->getStore()->getUrl('*/*/allcart', ['_current' => true])
        );
    }

getSharedAddToCartUrl()

getSharedAddToCartUrl

(

$item

)

Retrieve URL for adding item to shopping cart from shared wishlist

Parameters

string | \Magento\Catalog\Model\Product | \Magento\Wishlist\Model\Item

$item

Returns

string

Definition at line 433 of file Data.php.

    {
        return $this->_postDataHelper->getPostData(
            $this->_getUrlStore($item)->getUrl('wishlist/shared/cart'),
            $this->_getCartUrlParameters($item)
        );
    }

getUpdateParams()

getUpdateParams

(

$item

)

Retrieve params for updating product in wishlist

Parameters

\Magento\Catalog\Model\Product | \Magento\Wishlist\Model\Item

$item

Returns

string|false

Definition at line 360 of file Data.php.

    {
        $itemId = null;
        if ($item instanceof \Magento\Catalog\Model\Product) {
            $itemId = $item->getWishlistItemId();
            $productId = $item->getId();
        }
        if ($item instanceof \Magento\Wishlist\Model\Item) {
            $itemId = $item->getId();
            $productId = $item->getProduct()->getId();
        }

        $url = $this->_getUrl('wishlist/index/updateItemOptions');
        if ($itemId) {
            $params = ['id' => $itemId, 'product' => $productId, 'qty' => $item->getQty()];
            return $this->_postDataHelper->getPostData($url, $params);
        }

        return false;
    }

getWishlist()

getWishlist

(

)

Retrieve wishlist by logged in customer

Returns

\Magento\Wishlist\Model\Wishlist

Definition at line 184 of file Data.php.

    {
        if ($this->_wishlist === null) {
            if ($this->_coreRegistry->registry('shared_wishlist')) {
                $this->_wishlist = $this->_coreRegistry->registry('shared_wishlist');
            } else {
                $this->_wishlist = $this->wishlistProvider->getWishlist();
            }
        }
        return $this->_wishlist;
    }

getWishlistItemCollection()

getWishlistItemCollection

(

)

Retrieve wishlist items collection

Returns

\Magento\Wishlist\Model\ResourceModel\Item\Collection

Definition at line 242 of file Data.php.

    {
        if ($this->_wishlistItemCollection === null) {
            $this->_wishlistItemCollection = $this->_createWishlistItemCollection();
        }
        return $this->_wishlistItemCollection;
    }

isAllow()

isAllow

(

)

Check is allow wishlist module

Returns

bool

Definition at line 490 of file Data.php.

    {
        if ($this->_moduleManager->isOutputEnabled($this->_getModuleName()) && $this->scopeConfig->getValue(
            'wishlist/general/active',
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        )
        ) {
            return true;
        }
        return false;
    }

isAllowInCart()

isAllowInCart

(

)

Check is allow wishlist action in shopping cart

Returns

bool

Definition at line 507 of file Data.php.

    {
        return $this->isAllow() && $this->getCustomer();
    }

isDisplayQty()

isDisplayQty

(

)

Should display item quantities in my wishlist link

Returns

bool

Definition at line 607 of file Data.php.

    {
        return $this->scopeConfig->getValue(
            self::XML_PATH_WISHLIST_LINK_USE_QTY,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        );
    }

setCustomer()

setCustomer

(

\Magento\Customer\Api\Data\CustomerInterface

$customer

)

Set current customer

Parameters

\Magento\Customer\Api\Data\CustomerInterface

$customer

Returns

void

Definition at line 161 of file Data.php.

    {
        $this->_currentCustomer = $customer;
    }

Field Documentation

$_coreRegistry

$_coreRegistry

protected

Definition at line 65 of file Data.php.

$_currentCustomer

$_currentCustomer

protected

Definition at line 37 of file Data.php.

$_customerSession

$_customerSession

protected

Definition at line 70 of file Data.php.

$_customerViewHelper

$_customerViewHelper

protected

Definition at line 90 of file Data.php.

$_postDataHelper

$_postDataHelper

protected

Definition at line 85 of file Data.php.

$_productCollection

$_productCollection

protected

Definition at line 51 of file Data.php.

$_storeManager

$_storeManager

protected

Definition at line 80 of file Data.php.

$_wishlist

$_wishlist

protected

Definition at line 44 of file Data.php.

$_wishlistFactory

$_wishlistFactory

protected

Definition at line 75 of file Data.php.

$_wishlistItemCollection

$_wishlistItemCollection

protected

Definition at line 58 of file Data.php.

$productRepository

$productRepository

protected

Definition at line 100 of file Data.php.

$wishlistProvider

$wishlistProvider

protected

Definition at line 95 of file Data.php.

XML_PATH_CATALOGINVENTORY_SHOW_OUT_OF_STOCK

const XML_PATH_CATALOGINVENTORY_SHOW_OUT_OF_STOCK = 'cataloginventory/options/show_out_of_stock'

Config key 'Display Out of Stock Products'

Definition at line 30 of file Data.php.

XML_PATH_WISHLIST_LINK_USE_QTY

const XML_PATH_WISHLIST_LINK_USE_QTY = 'wishlist/wishlist_link/use_qty'

Config key 'Display Wishlist Summary'

Definition at line 25 of file Data.php.

---

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

• vendor/magento/module-wishlist/Helper/Data.php