Data Class Reference

Inheritance diagram for Data:

Public Member Functions
	__construct (Context $context, StoreManagerInterface $storeManager, \Magento\Msrp\Model\Product\Options $productOptions, \Magento\Msrp\Model\Msrp $msrp, \Magento\Msrp\Model\Config $config, \Magento\Framework\Pricing\PriceCurrencyInterface $priceCurrency, ProductRepositoryInterface $productRepository)
	canApplyMsrp ($product, $visibility=null)
	getMsrpPriceMessage ($product)
	isShowPriceOnGesture ($product)
	isShowBeforeOrderConfirm ($product)
	isMinimalPriceLessMsrp ($product)
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Protected Attributes
	$storeManager
	$productOptions
	$config
	$priceCurrency
	$productRepository
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

Msrp data helper

Definition at line 18 of file Data.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Context	$context,
		StoreManagerInterface	$storeManager,
		\Magento\Msrp\Model\Product\Options	$productOptions,
		\Magento\Msrp\Model\Msrp	$msrp,
		\Magento\Msrp\Model\Config	$config,
		\Magento\Framework\Pricing\PriceCurrencyInterface	$priceCurrency,
		ProductRepositoryInterface	$productRepository
	)

Parameters

Context	$context
StoreManagerInterface	$storeManager
\Magento\Msrp\Model\Product\Options	$productOptions
\Magento\Msrp\Model\Msrp	$msrp
\Magento\Msrp\Model\Config	$config
\Magento\Framework\Pricing\PriceCurrencyInterface	$priceCurrency
ProductRepositoryInterface	$productRepository

Definition at line 54 of file Data.php.

      {
        parent::__construct($context);
        $this->storeManager = $storeManager;
        $this->productOptions = $productOptions;
        $this->msrp = $msrp;
        $this->config = $config;
        $this->priceCurrency = $priceCurrency;
        $this->productRepository = $productRepository;
    }

Member Function Documentation

canApplyMsrp()

canApplyMsrp	(		$product,
			$visibility = null
	)

Check if can apply Minimum Advertise price to product in specific visibility

Parameters

int | Product	$product
int | null	$visibility	Check displaying price in concrete place (by default generally)

Returns

bool

@SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 82 of file Data.php.

    {
        if (!$this->config->isEnabled()) {
            return false;
        }
        if (is_numeric($product)) {
            $product = $this->productRepository->getById($product, false, $this->storeManager->getStore()->getId());
        }
        $result = $this->msrp->canApplyToProduct($product);
        if ($result && $visibility !== null) {
            $productPriceVisibility = $product->getMsrpDisplayActualPriceType();
            if ($productPriceVisibility == Type\Price::TYPE_USE_CONFIG) {
                $productPriceVisibility = $this->config->getDisplayActualPriceType();
            }
            $result = $productPriceVisibility == $visibility;
        }

        if ($product->getTypeInstance()->isComposite($product) && (!$result || $visibility !== null)) {
            $isEnabledInOptions = $this->productOptions->isEnabled($product, $visibility);
            if ($isEnabledInOptions !== null) {
                $result = $isEnabledInOptions;
            }
        }

        return $result;
    }

getMsrpPriceMessage()

getMsrpPriceMessage

(

$product

)

Get Msrp message for price

Parameters

Product

$product

Returns

string

Definition at line 115 of file Data.php.

    {
        $message = "";
        if ($this->canApplyMsrp($product, Type::TYPE_IN_CART)) {
            $message = __('To see product price, add this item to your cart. You can always remove it later.');
        } elseif ($this->canApplyMsrp($product, Type::TYPE_BEFORE_ORDER_CONFIRM)) {
            $message = __('See price before order confirmation.');
        }
        return $message;
    }

isMinimalPriceLessMsrp()

isMinimalPriceLessMsrp

(

$product

)

Parameters

int | Product

$product

Returns

bool|float

Definition at line 150 of file Data.php.

    {
        if (is_numeric($product)) {
            $product = $this->productRepository->getById($product, false, $this->storeManager->getStore()->getId());
        }
        $msrp = $product->getMsrp();
        $price = $product->getPriceInfo()->getPrice(\Magento\Catalog\Pricing\Price\FinalPrice::PRICE_CODE);
        if ($msrp === null) {
            if ($product->getTypeId() !== \Magento\GroupedProduct\Model\Product\Type\Grouped::TYPE_CODE) {
                return false;
            } else {
                $msrp = $product->getTypeInstance()->getChildrenMsrp($product);
            }
        }
        if ($msrp) {
            $msrp = $this->priceCurrency->convertAndRound($msrp);
        }
        return $msrp > $price->getValue();
    }

isShowBeforeOrderConfirm()

isShowBeforeOrderConfirm

(

$product

)

Parameters

int | Product

$product

Returns

bool

Definition at line 141 of file Data.php.

    {
        return $this->canApplyMsrp($product, Type::TYPE_BEFORE_ORDER_CONFIRM);
    }

isShowPriceOnGesture()

isShowPriceOnGesture

(

$product

)

Check is product need gesture to show price

Parameters

int | Product

$product

Returns

bool

Definition at line 132 of file Data.php.

    {
        return $this->canApplyMsrp($product, Type::TYPE_ON_GESTURE);
    }

Field Documentation

$config

$config

protected

Definition at line 33 of file Data.php.

$priceCurrency

$priceCurrency

protected

Definition at line 38 of file Data.php.

$productOptions

$productOptions

protected

Definition at line 28 of file Data.php.

$productRepository

$productRepository

protected

Definition at line 43 of file Data.php.

$storeManager

$storeManager

protected

Definition at line 23 of file Data.php.

---

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

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