Data Class Reference

Inheritance diagram for Data:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Checkout\Model\Session $checkoutSession, \Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate, \Magento\Framework\Mail\Template\TransportBuilder $transportBuilder, \Magento\Framework\Translate\Inline\StateInterface $inlineTranslation, PriceCurrencyInterface $priceCurrency, PaymentFailuresInterface $paymentFailures=null)
	getCheckout ()
	getQuote ()
	formatPrice ($price)
	convertPrice ($price, $format=true)
	canOnepageCheckout ()
	getPriceInclTax ($item)
	getSubtotalInclTax ($item)
	getBasePriceInclTax ($item)
	getBaseSubtotalInclTax ($item)
	sendPaymentFailedEmail (\Magento\Quote\Model\Quote $checkout, string $message, string $checkoutType='onepage')
	isAllowedGuestCheckout (\Magento\Quote\Model\Quote $quote, $store=null)
	isContextCheckout ()
	isCustomerMustBeLogged ()
	isDisplayBillingOnPaymentMethodAvailable ()
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Data Fields
const	XML_PATH_GUEST_CHECKOUT = 'checkout/options/guest_checkout'
const	XML_PATH_CUSTOMER_MUST_BE_LOGGED = 'checkout/options/customer_must_be_logged'

Protected Member Functions
	_getEmails ($configPath, $storeId)
Protected Member Functions inherited from AbstractHelper
	_getRequest ()
	_getModuleName ()
	_getUrl ($route, $params=[])

Protected Attributes
	$_storeManager
	$_checkoutSession
	$_localeDate
	$_transportBuilder
	$inlineTranslation
	$priceCurrency
Protected Attributes inherited from AbstractHelper
	$_moduleName
	$_request
	$_moduleManager
	$_logger
	$_urlBuilder
	$_httpHeader
	$_eventManager
	$_remoteAddress
	$urlEncoder
	$urlDecoder
	$scopeConfig
	$_cacheConfig

Detailed Description

Checkout default 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)

Definition at line 20 of file Data.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Checkout\Model\Session	$checkoutSession,
		\Magento\Framework\Stdlib\DateTime\TimezoneInterface	$localeDate,
		\Magento\Framework\Mail\Template\TransportBuilder	$transportBuilder,
		\Magento\Framework\Translate\Inline\StateInterface	$inlineTranslation,
		PriceCurrencyInterface	$priceCurrency,
		PaymentFailuresInterface	$paymentFailures = null
	)

Parameters

\Magento\Framework\App\Helper\Context	$context
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Checkout\Model\Session	$checkoutSession
\Magento\Framework\Stdlib\DateTime\TimezoneInterface	$localeDate
\Magento\Framework\Mail\Template\TransportBuilder	$transportBuilder
\Magento\Framework\Translate\Inline\StateInterface	$inlineTranslation
PriceCurrencyInterface	$priceCurrency
PaymentFailuresInterface | null	$paymentFailures	@codeCoverageIgnore

Definition at line 72 of file Data.php.

      {
        $this->_storeManager = $storeManager;
        $this->_checkoutSession = $checkoutSession;
        $this->_localeDate = $localeDate;
        $this->_transportBuilder = $transportBuilder;
        $this->inlineTranslation = $inlineTranslation;
        $this->priceCurrency = $priceCurrency;
        $this->paymentFailures = $paymentFailures ? : \Magento\Framework\App\ObjectManager::getInstance()
            ->get(PaymentFailuresInterface::class);
        parent::__construct($context);
    }

Member Function Documentation

_getEmails()

_getEmails (   $configPath,   $storeId  )

protected

Parameters

string	$configPath
null | string | bool | int | Store	$storeId

Returns

array|false

Definition at line 231 of file Data.php.

    {
        $data = $this->scopeConfig->getValue(
            $configPath,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
            $storeId
        );
        if (!empty($data)) {
            return explode(',', $data);
        }
        return false;
    }

canOnepageCheckout()

canOnepageCheckout

(

)

Get onepage checkout availability

Returns

bool

Definition at line 146 of file Data.php.

    {
        return (bool)$this->scopeConfig->getValue(
            'checkout/options/onepage_checkout_enabled',
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        );
    }

convertPrice()

convertPrice	(		$price,
			$format = true
	)

Parameters

float	$price
bool	$format

Returns

float

Definition at line 134 of file Data.php.

    {
        return $format
            ? $this->priceCurrency->convertAndFormat($price)
            : $this->priceCurrency->convert($price);
    }

formatPrice()

formatPrice

(

$price

)

Parameters

float

$price

Returns

string

Definition at line 119 of file Data.php.

    {
        return $this->priceCurrency->format(
            $price,
            true,
            PriceCurrencyInterface::DEFAULT_PRECISION,
            $this->getQuote()->getStore()
        );
    }

getBasePriceInclTax()

getBasePriceInclTax

(

$item

)

Parameters

AbstractItem

$item

Returns

float

Definition at line 190 of file Data.php.

    {
        $qty = $item->getQty() ? $item->getQty() : ($item->getQtyOrdered() ? $item->getQtyOrdered() : 1);
        $taxAmount = $item->getBaseTaxAmount() + $item->getBaseDiscountTaxCompensation();
        $price = (float)$qty ? ($item->getBaseRowTotal() + $taxAmount) / $qty : 0;
        return $this->priceCurrency->round($price);
    }

getBaseSubtotalInclTax()

getBaseSubtotalInclTax

(

$item

)

Parameters

AbstractItem

$item

Returns

float

Definition at line 202 of file Data.php.

    {
        $tax = $item->getBaseTaxAmount() + $item->getBaseDiscountTaxCompensation();
        return $item->getBaseRowTotal() + $tax;
    }

getCheckout()

getCheckout

(

)

Retrieve checkout session model

Returns

\Magento\Checkout\Model\Session @codeCoverageIgnore

Definition at line 99 of file Data.php.

    {
        return $this->_checkoutSession;
    }

getPriceInclTax()

getPriceInclTax

(

$item

)

Get sales item (quote item, order item etc) price including tax based on row total and tax amount

Parameters

\Magento\Framework\DataObject

$item

Returns

float

Definition at line 160 of file Data.php.

    {
        if ($item->getPriceInclTax()) {
            return $item->getPriceInclTax();
        }
        $qty = $item->getQty() ? $item->getQty() : ($item->getQtyOrdered() ? $item->getQtyOrdered() : 1);
        $taxAmount = $item->getTaxAmount() + $item->getDiscountTaxCompensation();
        $price = (float)$qty ? ($item->getRowTotal() + $taxAmount) / $qty : 0;
        return $this->priceCurrency->round($price);
    }

getQuote()

getQuote

(

)

Retrieve checkout quote model object

Returns

\Magento\Quote\Model\Quote @codeCoverageIgnore

Definition at line 110 of file Data.php.

    {
        return $this->getCheckout()->getQuote();
    }

getSubtotalInclTax()

getSubtotalInclTax

(

$item

)

Get sales item (quote item, order item etc) row total price including tax

Parameters

\Magento\Framework\DataObject

$item

Returns

float

Definition at line 177 of file Data.php.

    {
        if ($item->getRowTotalInclTax()) {
            return $item->getRowTotalInclTax();
        }
        $tax = $item->getTaxAmount() + $item->getDiscountTaxCompensation();
        return $item->getRowTotal() + $tax;
    }

isAllowedGuestCheckout()

isAllowedGuestCheckout	(	\Magento\Quote\Model\Quote	$quote,
			$store = null
	)

Check is allowed Guest Checkout Use config settings and observer

Parameters

\Magento\Quote\Model\Quote	$quote
int | Store	$store

Returns

bool

Definition at line 252 of file Data.php.

    {
        if ($store === null) {
            $store = $quote->getStoreId();
        }
        $guestCheckout = $this->scopeConfig->isSetFlag(
            self::XML_PATH_GUEST_CHECKOUT,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
            $store
        );

        if ($guestCheckout == true) {
            $result = new \Magento\Framework\DataObject();
            $result->setIsAllowed($guestCheckout);
            $this->_eventManager->dispatch(
                'checkout_allow_guest',
                ['quote' => $quote, 'store' => $store, 'result' => $result]
            );

            $guestCheckout = $result->getIsAllowed();
        }

        return $guestCheckout;
    }

isContextCheckout()

isContextCheckout

(

)

Check if context is checkout

Returns

bool @codeCoverageIgnore

Definition at line 283 of file Data.php.

    {
        return $this->_request->getParam('context') == 'checkout';
    }

isCustomerMustBeLogged()

isCustomerMustBeLogged

(

)

Check if user must be logged during checkout process

Returns

boolean @codeCoverageIgnore

Definition at line 294 of file Data.php.

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

isDisplayBillingOnPaymentMethodAvailable()

isDisplayBillingOnPaymentMethodAvailable

(

)

Checks if display billing address on payment method is available, otherwise billing address should be display on payment page

Returns

bool

Definition at line 307 of file Data.php.

    {
        return (bool) !$this->scopeConfig->getValue(
            'checkout/options/display_billing_address_on',
            ScopeInterface::SCOPE_STORE
        );
    }

sendPaymentFailedEmail()

sendPaymentFailedEmail	(	\Magento\Quote\Model\Quote	$checkout,
		string	$message,
		string	$checkoutType = 'onepage'
	)

Send email id payment was failed

Parameters

\Magento\Quote\Model\Quote	$checkout
string	$message
string	$checkoutType

Returns

$this

Definition at line 216 of file Data.php.

     : \Magento\Checkout\Helper\Data {
        $this->paymentFailures->handle((int)$checkout->getId(), $message, $checkoutType);

        return $this;
    }

Field Documentation

$_checkoutSession

$_checkoutSession

protected

Definition at line 34 of file Data.php.

$_localeDate

$_localeDate

protected

Definition at line 39 of file Data.php.

$_storeManager

$_storeManager

protected

Definition at line 29 of file Data.php.

$_transportBuilder

$_transportBuilder

protected

Definition at line 44 of file Data.php.

$inlineTranslation

$inlineTranslation

protected

Definition at line 49 of file Data.php.

$priceCurrency

$priceCurrency

protected

Definition at line 54 of file Data.php.

XML_PATH_CUSTOMER_MUST_BE_LOGGED

const XML_PATH_CUSTOMER_MUST_BE_LOGGED = 'checkout/options/customer_must_be_logged'

Definition at line 24 of file Data.php.

XML_PATH_GUEST_CHECKOUT

const XML_PATH_GUEST_CHECKOUT = 'checkout/options/guest_checkout'

Definition at line 22 of file Data.php.

---

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

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