Config Class Reference

Public Member Functions
	__construct (ScopeConfigInterface $scopeConfig, StoreManagerInterface $storeManager, Escaper $escaper)
	setStoreId ($store)
	isEnabled ()
	getDisplayActualPriceType ()
	getExplanationMessage ()
	getExplanationMessageWhatsThis ()

Data Fields
const	XML_PATH_MSRP_ENABLED = 'sales/msrp/enabled'
const	XML_PATH_MSRP_DISPLAY_ACTUAL_PRICE_TYPE = 'sales/msrp/display_price_type'
const	XML_PATH_MSRP_EXPLANATION_MESSAGE = 'sales/msrp/explanation_message'
const	XML_PATH_MSRP_EXPLANATION_MESSAGE_WHATS_THIS = 'sales/msrp/explanation_message_whats_this'

Protected Attributes
	$scopeConfig
	$storeManager
	$escaper
	$storeId

Detailed Description

Definition at line 13 of file Config.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ScopeConfigInterface	$scopeConfig,
		StoreManagerInterface	$storeManager,
		Escaper	$escaper
	)

Parameters

ScopeConfigInterface	$scopeConfig
StoreManagerInterface	$storeManager
Escaper	$escaper

Definition at line 47 of file Config.php.

      {
        $this->scopeConfig = $scopeConfig;
        $this->storeManager = $storeManager;
        $this->escaper = $escaper;
    }

Member Function Documentation

getDisplayActualPriceType()

getDisplayActualPriceType

(

)

Return Msrp display actual type

Returns

null|string

Definition at line 89 of file Config.php.

    {
        return $this->scopeConfig->getValue(
            self::XML_PATH_MSRP_DISPLAY_ACTUAL_PRICE_TYPE,
            ScopeInterface::SCOPE_STORE,
            $this->storeId
        );
    }

getExplanationMessage()

getExplanationMessage

(

)

Return Msrp explanation message

Returns

string

Definition at line 103 of file Config.php.

    {
        return $this->escaper->escapeHtml(
            $this->scopeConfig->getValue(
                self::XML_PATH_MSRP_EXPLANATION_MESSAGE,
                ScopeInterface::SCOPE_STORE,
                $this->storeId
            ),
            ['b', 'br', 'strong', 'i', 'u', 'p', 'span']
        );
    }

getExplanationMessageWhatsThis()

getExplanationMessageWhatsThis

(

)

Return Msrp explanation message for "Whats This" window

Returns

string

Definition at line 120 of file Config.php.

    {
        return $this->escaper->escapeHtml(
            $this->scopeConfig->getValue(
                self::XML_PATH_MSRP_EXPLANATION_MESSAGE_WHATS_THIS,
                ScopeInterface::SCOPE_STORE,
                $this->storeId
            ),
            ['b', 'br', 'strong', 'i', 'u', 'p', 'span']
        );
    }

isEnabled()

isEnabled

(

)

Check if Minimum Advertised Price is enabled

Returns

bool @api

Definition at line 75 of file Config.php.

    {
        return (bool)$this->scopeConfig->getValue(
            self::XML_PATH_MSRP_ENABLED,
            ScopeInterface::SCOPE_STORE,
            $this->storeId
        );
    }

setStoreId()

setStoreId

(

$store

)

Set a specified store ID value

Parameters

int

$store

Returns

$this

Definition at line 63 of file Config.php.

    {
        $this->storeId = $store;
        return $this;
    }

Field Documentation

$escaper

$escaper

protected

Definition at line 35 of file Config.php.

$scopeConfig

$scopeConfig

protected

#- #-

Definition at line 25 of file Config.php.

$storeId

$storeId

protected

Definition at line 40 of file Config.php.

$storeManager

$storeManager

protected

Definition at line 30 of file Config.php.

XML_PATH_MSRP_DISPLAY_ACTUAL_PRICE_TYPE

const XML_PATH_MSRP_DISPLAY_ACTUAL_PRICE_TYPE = 'sales/msrp/display_price_type'

Definition at line 19 of file Config.php.

XML_PATH_MSRP_ENABLED

const XML_PATH_MSRP_ENABLED = 'sales/msrp/enabled'

#+ Minimum advertise price constants

Definition at line 18 of file Config.php.

XML_PATH_MSRP_EXPLANATION_MESSAGE

const XML_PATH_MSRP_EXPLANATION_MESSAGE = 'sales/msrp/explanation_message'

Definition at line 20 of file Config.php.

XML_PATH_MSRP_EXPLANATION_MESSAGE_WHATS_THIS

const XML_PATH_MSRP_EXPLANATION_MESSAGE_WHATS_THIS = 'sales/msrp/explanation_message_whats_this'

Definition at line 21 of file Config.php.

---

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

• vendor/magento/module-msrp/Model/Config.php