LayoutProcessor Class Reference

Inheritance diagram for LayoutProcessor:

Public Member Functions
	__construct (\Magento\Checkout\Block\Checkout\AttributeMerger $merger, \Magento\Directory\Model\ResourceModel\Country\Collection $countryCollection, \Magento\Directory\Model\ResourceModel\Region\Collection $regionCollection, \Magento\Directory\Model\TopDestinationCountries $topDestinationCountries=null)
	process ($jsLayout)

Protected Member Functions
	isCityActive ()
	isStateActive ()

Protected Attributes
	$merger
	$countryCollection
	$regionCollection
	$defaultShippingAddress = null

Detailed Description

Definition at line 8 of file LayoutProcessor.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Checkout\Block\Checkout\AttributeMerger	$merger,
		\Magento\Directory\Model\ResourceModel\Country\Collection	$countryCollection,
		\Magento\Directory\Model\ResourceModel\Region\Collection	$regionCollection,
		\Magento\Directory\Model\TopDestinationCountries	$topDestinationCountries = null
	)

Parameters

\Magento\Checkout\Block\Checkout\AttributeMerger	$merger
\Magento\Directory\Model\ResourceModel\Country\Collection	$countryCollection
\Magento\Directory\Model\ResourceModel\Region\Collection	$regionCollection
\Magento\Directory\Model\TopDestinationCountries	$topDestinationCountries	@codeCoverageIgnore

Definition at line 42 of file LayoutProcessor.php.

      {
        $this->merger = $merger;
        $this->countryCollection = $countryCollection;
        $this->regionCollection = $regionCollection;
        $this->topDestinationCountries = $topDestinationCountries ?:
            \Magento\Framework\App\ObjectManager::getInstance()
                ->get(\Magento\Directory\Model\TopDestinationCountries::class);
    }

Member Function Documentation

isCityActive()

isCityActive ( )

protected

Show City in Shipping Estimation

Returns

bool @codeCoverageIgnore

Definition at line 62 of file LayoutProcessor.php.

    {
        return false;
    }

isStateActive()

isStateActive ( )

protected

Show State in Shipping Estimation

Returns

bool @codeCoverageIgnore

Definition at line 73 of file LayoutProcessor.php.

    {
        return false;
    }

process()

process

(

$jsLayout

)

Process js Layout of block

Parameters

array

$jsLayout

Returns

array @SuppressWarnings(PHPMD.NPathComplexity)

Implements LayoutProcessorInterface.

Definition at line 85 of file LayoutProcessor.php.

    {
        $elements = [
            'city' => [
                'visible' => $this->isCityActive(),
                'formElement' => 'input',
                'label' => __('City'),
                'value' =>  null
            ],
            'country_id' => [
                'visible' => true,
                'formElement' => 'select',
                'label' => __('Country'),
                'options' => [],
                'value' => null
            ],
            'region_id' => [
                'visible' => true,
                'formElement' => 'select',
                'label' => __('State/Province'),
                'options' => [],
                'value' => null
            ],
            'postcode' => [
                'visible' => true,
                'formElement' => 'input',
                'label' => __('Zip/Postal Code'),
                'value' => null
            ]
        ];

        if (!isset($jsLayout['components']['checkoutProvider']['dictionaries'])) {
            $jsLayout['components']['checkoutProvider']['dictionaries'] = [
                'country_id' => $this->countryCollection->loadByStore()->setForegroundCountries(
                    $this->topDestinationCountries->getTopDestinations()
                )->toOptionArray(),
                'region_id' => $this->regionCollection->addAllowedCountriesFilter()->toOptionArray(),
            ];
        }
        if (isset($jsLayout['components']['block-summary']['children']['block-shipping']['children']
            ['address-fieldsets']['children'])
        ) {
            $fieldSetPointer = &$jsLayout['components']['block-summary']['children']['block-shipping']
            ['children']['address-fieldsets']['children'];
            $fieldSetPointer = $this->merger->merge($elements, 'checkoutProvider', 'shippingAddress', $fieldSetPointer);
            $fieldSetPointer['region_id']['config']['skipValidation'] = true;
        }
        return $jsLayout;
    }

Field Documentation

$countryCollection

$countryCollection

protected

Definition at line 18 of file LayoutProcessor.php.

$defaultShippingAddress

$defaultShippingAddress = null

protected

Definition at line 28 of file LayoutProcessor.php.

$merger

$merger

protected

Definition at line 13 of file LayoutProcessor.php.

$regionCollection

$regionCollection

protected

Definition at line 23 of file LayoutProcessor.php.

---

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

• vendor/magento/module-checkout/Block/Cart/LayoutProcessor.php