DefaultConfigProvider Class Reference

Inheritance diagram for DefaultConfigProvider:

Public Member Functions
	__construct (CheckoutHelper $checkoutHelper, CheckoutSession $checkoutSession, CustomerRepository $customerRepository, CustomerSession $customerSession, CustomerUrlManager $customerUrlManager, HttpContext $httpContext, \Magento\Quote\Api\CartRepositoryInterface $quoteRepository, QuoteItemRepository $quoteItemRepository, ShippingMethodManager $shippingMethodManager, ConfigurationPool $configurationPool, QuoteIdMaskFactory $quoteIdMaskFactory, LocaleFormat $localeFormat, \Magento\Customer\Model\Address\Mapper $addressMapper, \Magento\Customer\Model\Address\Config $addressConfig, FormKey $formKey, \Magento\Catalog\Helper\Image $imageHelper, \Magento\Framework\View\ConfigInterface $viewConfig, \Magento\Directory\Model\Country\Postcode\ConfigInterface $postCodesConfig, Cart\ImageProvider $imageProvider, \Magento\Directory\Helper\Data $directoryHelper, CartTotalRepositoryInterface $cartTotalRepository, ScopeConfigInterface $scopeConfig, \Magento\Shipping\Model\Config $shippingMethodConfig, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Quote\Api\PaymentMethodManagementInterface $paymentMethodManagement, UrlInterface $urlBuilder, AddressMetadataInterface $addressMetadata=null, AttributeOptionManagementInterface $attributeOptionManager=null)
	getConfig ()
	getRegisterUrl ()
	getCheckoutUrl ()
	pageNotFoundUrl ()
	getDefaultSuccessPageUrl ()

Protected Member Functions
	getFormattedOptionValue ($item)
	getStaticBaseUrl ()

Protected Attributes
	$quoteIdMaskFactory
	$localeFormat
	$addressMapper
	$addressConfig
	$formKey
	$imageHelper
	$viewConfig
	$postCodesConfig
	$directoryHelper
	$imageProvider
	$cartTotalRepository
	$scopeConfig
	$shippingMethodConfig
	$storeManager
	$paymentMethodManagement
	$urlBuilder

Detailed Description

Default Config Provider

@SuppressWarnings(PHPMD.CouplingBetweenObjects) @SuppressWarnings(PHPMD.TooManyFields)

Definition at line 35 of file DefaultConfigProvider.php.

Constructor & Destructor Documentation

__construct()

__construct	(	CheckoutHelper	$checkoutHelper,
		CheckoutSession	$checkoutSession,
		CustomerRepository	$customerRepository,
		CustomerSession	$customerSession,
		CustomerUrlManager	$customerUrlManager,
		HttpContext	$httpContext,
		\Magento\Quote\Api\CartRepositoryInterface	$quoteRepository,
		QuoteItemRepository	$quoteItemRepository,
		ShippingMethodManager	$shippingMethodManager,
		ConfigurationPool	$configurationPool,
		QuoteIdMaskFactory	$quoteIdMaskFactory,
		LocaleFormat	$localeFormat,
		\Magento\Customer\Model\Address\Mapper	$addressMapper,
		\Magento\Customer\Model\Address\Config	$addressConfig,
		FormKey	$formKey,
		\Magento\Catalog\Helper\Image	$imageHelper,
		\Magento\Framework\View\ConfigInterface	$viewConfig,
		\Magento\Directory\Model\Country\Postcode\ConfigInterface	$postCodesConfig,
		Cart\ImageProvider	$imageProvider,
		\Magento\Directory\Helper\Data	$directoryHelper,
		CartTotalRepositoryInterface	$cartTotalRepository,
		ScopeConfigInterface	$scopeConfig,
		\Magento\Shipping\Model\Config	$shippingMethodConfig,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Quote\Api\PaymentMethodManagementInterface	$paymentMethodManagement,
		UrlInterface	$urlBuilder,
		AddressMetadataInterface	$addressMetadata = null,
		AttributeOptionManagementInterface	$attributeOptionManager = null
	)

Parameters

CheckoutHelper	$checkoutHelper
Session	$checkoutSession
CustomerRepository	$customerRepository
CustomerSession	$customerSession
CustomerUrlManager	$customerUrlManager
HttpContext	$httpContext
\Magento\Quote\Api\CartRepositoryInterface	$quoteRepository
QuoteItemRepository	$quoteItemRepository
ShippingMethodManager	$shippingMethodManager
ConfigurationPool	$configurationPool
QuoteIdMaskFactory	$quoteIdMaskFactory
LocaleFormat	$localeFormat
\Magento\Customer\Model\Address\Mapper	$addressMapper
\Magento\Customer\Model\Address\Config	$addressConfig
FormKey	$formKey
\Magento\Catalog\Helper\Image	$imageHelper
\Magento\Framework\View\ConfigInterface	$viewConfig
\Magento\Directory\Model\Country\Postcode\ConfigInterface	$postCodesConfig
Cart\ImageProvider	$imageProvider
\Magento\Directory\Helper\Data	$directoryHelper
CartTotalRepositoryInterface	$cartTotalRepository
ScopeConfigInterface	$scopeConfig
\Magento\Shipping\Model\Config	$shippingMethodConfig
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Quote\Api\PaymentMethodManagementInterface	$paymentMethodManagement
UrlInterface	$urlBuilder
AddressMetadataInterface	$addressMetadata
AttributeOptionManagementInterface	$attributeOptionManager	@codeCoverageIgnore @SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 209 of file DefaultConfigProvider.php.

      {
        $this->checkoutHelper = $checkoutHelper;
        $this->checkoutSession = $checkoutSession;
        $this->customerRepository = $customerRepository;
        $this->customerSession = $customerSession;
        $this->customerUrlManager = $customerUrlManager;
        $this->httpContext = $httpContext;
        $this->quoteRepository = $quoteRepository;
        $this->quoteItemRepository = $quoteItemRepository;
        $this->shippingMethodManager = $shippingMethodManager;
        $this->configurationPool = $configurationPool;
        $this->quoteIdMaskFactory = $quoteIdMaskFactory;
        $this->localeFormat = $localeFormat;
        $this->addressMapper = $addressMapper;
        $this->addressConfig = $addressConfig;
        $this->formKey = $formKey;
        $this->imageHelper = $imageHelper;
        $this->viewConfig = $viewConfig;
        $this->postCodesConfig = $postCodesConfig;
        $this->imageProvider = $imageProvider;
        $this->directoryHelper = $directoryHelper;
        $this->cartTotalRepository = $cartTotalRepository;
        $this->scopeConfig = $scopeConfig;
        $this->shippingMethodConfig = $shippingMethodConfig;
        $this->storeManager = $storeManager;
        $this->paymentMethodManagement = $paymentMethodManagement;
        $this->urlBuilder = $urlBuilder;
        $this->addressMetadata = $addressMetadata ?: ObjectManager::getInstance()->get(AddressMetadataInterface::class);
        $this->attributeOptionManager = $attributeOptionManager ??
            ObjectManager::getInstance()->get(AttributeOptionManagementInterface::class);
    }

Member Function Documentation

getCheckoutUrl()

getCheckoutUrl

(

)

Retrieve checkout URL

Returns

string @codeCoverageIgnore

Definition at line 484 of file DefaultConfigProvider.php.

    {
        return $this->urlBuilder->getUrl('checkout');
    }

getConfig()

getConfig

(

)

Return configuration array

Returns

array|mixed

Exceptions

Implements ConfigProviderInterface.

Definition at line 276 of file DefaultConfigProvider.php.

    {
        $quoteId = $this->checkoutSession->getQuote()->getId();
        $output['formKey'] = $this->formKey->getFormKey();
        $output['customerData'] = $this->getCustomerData();
        $output['quoteData'] = $this->getQuoteData();
        $output['quoteItemData'] = $this->getQuoteItemData();
        $output['isCustomerLoggedIn'] = $this->isCustomerLoggedIn();
        $output['selectedShippingMethod'] = $this->getSelectedShippingMethod();
        $output['storeCode'] = $this->getStoreCode();
        $output['isGuestCheckoutAllowed'] = $this->isGuestCheckoutAllowed();
        $output['isCustomerLoginRequired'] = $this->isCustomerLoginRequired();
        $output['registerUrl'] = $this->getRegisterUrl();
        $output['checkoutUrl'] = $this->getCheckoutUrl();
        $output['defaultSuccessPageUrl'] = $this->getDefaultSuccessPageUrl();
        $output['pageNotFoundUrl'] = $this->pageNotFoundUrl();
        $output['forgotPasswordUrl'] = $this->getForgotPasswordUrl();
        $output['staticBaseUrl'] = $this->getStaticBaseUrl();
        $output['priceFormat'] = $this->localeFormat->getPriceFormat(
            null,
            $this->checkoutSession->getQuote()->getQuoteCurrencyCode()
        );
        $output['basePriceFormat'] = $this->localeFormat->getPriceFormat(
            null,
            $this->checkoutSession->getQuote()->getBaseCurrencyCode()
        );
        $output['postCodes'] = $this->postCodesConfig->getPostCodes();
        $output['imageData'] = $this->imageProvider->getImages($quoteId);
        $output['totalsData'] = $this->getTotalsData();
        $output['shippingPolicy'] = [
            'isEnabled' => $this->scopeConfig->isSetFlag(
                'shipping/shipping_policy/enable_shipping_policy',
                ScopeInterface::SCOPE_STORE
            ),
            'shippingPolicyContent' => nl2br(
                $this->scopeConfig->getValue(
                    'shipping/shipping_policy/shipping_policy_content',
                    ScopeInterface::SCOPE_STORE
                )
            )
        ];
        $output['activeCarriers'] = $this->getActiveCarriers();
        $output['originCountryCode'] = $this->getOriginCountryCode();
        $output['paymentMethods'] = $this->getPaymentMethods();
        $output['autocomplete'] = $this->isAutocompleteEnabled();
        $output['displayBillingOnPaymentMethod'] = $this->checkoutHelper->isDisplayBillingOnPaymentMethodAvailable();
        return $output;
    }

getDefaultSuccessPageUrl()

getDefaultSuccessPageUrl

(

)

Retrieve default success page URL

Returns

string @codeCoverageIgnore

Definition at line 506 of file DefaultConfigProvider.php.

    {
        return $this->urlBuilder->getUrl('checkout/onepage/success/');
    }

getFormattedOptionValue()

getFormattedOptionValue (   $item )

protected

Retrieve formatted item options view

Parameters

\Magento\Quote\Api\Data\CartItemInterface

$item

Returns

array

Definition at line 449 of file DefaultConfigProvider.php.

    {
        $optionsData = [];
        $options = $this->configurationPool->getByProductType($item->getProductType())->getOptions($item);
        foreach ($options as $index => $optionValue) {
            /* @var $helper \Magento\Catalog\Helper\Product\Configuration */
            $helper = $this->configurationPool->getByProductType('default');
            $params = [
                'max_length' => 55,
                'cut_replacer' => ' <a href="#" class="dots tooltip toggle" onclick="return false">...</a>'
            ];
            $option = $helper->getFormattedOptionValue($optionValue, $params);
            $optionsData[$index] = $option;
            $optionsData[$index]['label'] = $optionValue['label'];
        }
        return $optionsData;
    }

getRegisterUrl()

getRegisterUrl

(

)

Retrieve customer registration URL

Returns

string @codeCoverageIgnore

Definition at line 473 of file DefaultConfigProvider.php.

    {
        return $this->customerUrlManager->getRegisterUrl();
    }

getStaticBaseUrl()

getStaticBaseUrl ( )

protected

Return base static url.

Returns

string @codeCoverageIgnore

Definition at line 592 of file DefaultConfigProvider.php.

    {
        return $this->checkoutSession->getQuote()->getStore()->getBaseUrl(UrlInterface::URL_TYPE_STATIC);
    }

pageNotFoundUrl()

pageNotFoundUrl

(

)

Retrieve checkout URL

Returns

string @codeCoverageIgnore

Definition at line 495 of file DefaultConfigProvider.php.

    {
        return $this->urlBuilder->getUrl('checkout/noroute');
    }

Field Documentation

$addressConfig

$addressConfig

protected

Definition at line 110 of file DefaultConfigProvider.php.

$addressMapper

$addressMapper

protected

Definition at line 105 of file DefaultConfigProvider.php.

$cartTotalRepository

$cartTotalRepository

protected

Definition at line 145 of file DefaultConfigProvider.php.

$directoryHelper

$directoryHelper

protected

Definition at line 135 of file DefaultConfigProvider.php.

$formKey

$formKey

protected

Definition at line 115 of file DefaultConfigProvider.php.

$imageHelper

$imageHelper

protected

Definition at line 120 of file DefaultConfigProvider.php.

$imageProvider

$imageProvider

protected

Definition at line 140 of file DefaultConfigProvider.php.

$localeFormat

$localeFormat

protected

Definition at line 100 of file DefaultConfigProvider.php.

$paymentMethodManagement

$paymentMethodManagement

protected

Definition at line 165 of file DefaultConfigProvider.php.

$postCodesConfig

$postCodesConfig

protected

Definition at line 130 of file DefaultConfigProvider.php.

$quoteIdMaskFactory

$quoteIdMaskFactory

protected

Parameters

QuoteIdMaskFactory

Definition at line 95 of file DefaultConfigProvider.php.

$scopeConfig

$scopeConfig

protected

Definition at line 150 of file DefaultConfigProvider.php.

$shippingMethodConfig

$shippingMethodConfig

protected

Definition at line 155 of file DefaultConfigProvider.php.

$storeManager

$storeManager

protected

Definition at line 160 of file DefaultConfigProvider.php.

$urlBuilder

$urlBuilder

protected

Definition at line 170 of file DefaultConfigProvider.php.

$viewConfig

$viewConfig

protected

Definition at line 125 of file DefaultConfigProvider.php.

---

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

• vendor/magento/module-checkout/Model/DefaultConfigProvider.php