VatValidator Class Reference

Public Member Functions
	__construct (\Magento\Customer\Helper\Address $customerAddress, \Magento\Customer\Model\Vat $customerVat)
	validate (\Magento\Quote\Model\Quote\Address $quoteAddress, $store)
	isEnabled (\Magento\Quote\Model\Quote\Address $quoteAddress, $store)

Protected Attributes
	$customerAddress
	$customerVat

Detailed Description

Definition at line 8 of file VatValidator.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Customer\Helper\Address	$customerAddress,
		\Magento\Customer\Model\Vat	$customerVat
	)

Parameters

\Magento\Customer\Helper\Address	$customerAddress
\Magento\Customer\Model\Vat	$customerVat

Definition at line 28 of file VatValidator.php.

      {
        $this->customerVat = $customerVat;
        $this->customerAddress = $customerAddress;
    }

Member Function Documentation

isEnabled()

isEnabled	(	\Magento\Quote\Model\Quote\Address	$quoteAddress,
			$store
	)

Check whether VAT ID validation is enabled

Parameters

\Magento\Quote\Model\Quote\Address	$quoteAddress
\Magento\Store\Model\Store | int	$store

Returns

bool

Definition at line 96 of file VatValidator.php.

    {
        $configAddressType = $this->customerAddress->getTaxCalculationAddressType($store);

        // When VAT is based on billing address then Magento have to handle only billing addresses
        $additionalBillingAddressCondition = $configAddressType ==
            \Magento\Customer\Model\Address\AbstractAddress::TYPE_BILLING ? $configAddressType !=
            $quoteAddress->getAddressType() : false;

        // Handle only addresses that corresponds to VAT configuration
        if (!$this->customerAddress->isVatValidationEnabled($store) || $additionalBillingAddressCondition) {
            return false;
        }

        return true;
    }

validate()

validate	(	\Magento\Quote\Model\Quote\Address	$quoteAddress,
			$store
	)

Validate VAT number

Parameters

\Magento\Quote\Model\Quote\Address	$quoteAddress
\Magento\Store\Model\Store | int	$store

Returns

\Magento\Framework\DataObject

Definition at line 43 of file VatValidator.php.

    {
        $customerCountryCode = $quoteAddress->getCountryId();
        $customerVatNumber = $quoteAddress->getVatId();

        $merchantCountryCode = $this->customerVat->getMerchantCountryCode();
        $merchantVatNumber = $this->customerVat->getMerchantVatNumber();

        $validationResult = null;
        if ($this->customerAddress->hasValidateOnEachTransaction(
            $store
        ) ||
            $customerCountryCode != $quoteAddress->getValidatedCountryCode() ||
            $customerVatNumber != $quoteAddress->getValidatedVatNumber()
        ) {
            // Send request to gateway
            $validationResult = $this->customerVat->checkVatNumber(
                $customerCountryCode,
                $customerVatNumber,
                $merchantVatNumber !== '' ? $merchantCountryCode : '',
                $merchantVatNumber
            );

            // Store validation results in corresponding quote address
            $quoteAddress->setVatIsValid((int)$validationResult->getIsValid());
            $quoteAddress->setVatRequestId($validationResult->getRequestIdentifier());
            $quoteAddress->setVatRequestDate($validationResult->getRequestDate());
            $quoteAddress->setVatRequestSuccess($validationResult->getRequestSuccess());
            $quoteAddress->setValidatedVatNumber($customerVatNumber);
            $quoteAddress->setValidatedCountryCode($customerCountryCode);
            $quoteAddress->save();
        } else {
            // Restore validation results from corresponding quote address
            $validationResult = new \Magento\Framework\DataObject(
                [
                    'is_valid' => (int)$quoteAddress->getVatIsValid(),
                    'request_identifier' => (string)$quoteAddress->getVatRequestId(),
                    'request_date' => (string)$quoteAddress->getVatRequestDate(),
                    'request_success' => (bool)$quoteAddress->getVatRequestSuccess(),
                ]
            );
        }

        return $validationResult;
    }

Field Documentation

$customerAddress

$customerAddress

protected

Definition at line 15 of file VatValidator.php.

$customerVat

$customerVat

protected

Definition at line 22 of file VatValidator.php.

---

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

• vendor/magento/module-quote/Observer/Frontend/Quote/Address/VatValidator.php