Vat Class Reference

Public Member Functions
	__construct (ScopeConfigInterface $scopeConfig, PsrLogger $logger)
	getMerchantCountryCode ($store=null)
	getMerchantVatNumber ($store=null)
	getCustomerGroupIdBasedOnVatNumber ($customerCountryCode, $vatValidationResult, $store=null)
	checkVatNumber ($countryCode, $vatNumber, $requesterCountryCode='', $requesterVatNumber='')
	canCheckVatNumber ($countryCode, $vatNumber, $requesterCountryCode, $requesterVatNumber)
	getCustomerVatClass ($customerCountryCode, $vatValidationResult, $store=null)
	isCountryInEU ($countryCode, $storeId=null)

Data Fields
const	XML_PATH_CUSTOMER_VIV_INTRA_UNION_GROUP = 'customer/create_account/viv_intra_union_group'
const	XML_PATH_CUSTOMER_VIV_DOMESTIC_GROUP = 'customer/create_account/viv_domestic_group'
const	XML_PATH_CUSTOMER_VIV_INVALID_GROUP = 'customer/create_account/viv_invalid_group'
const	XML_PATH_CUSTOMER_VIV_ERROR_GROUP = 'customer/create_account/viv_error_group'
const	VAT_CLASS_DOMESTIC = 'domestic'
const	VAT_CLASS_INTRA_UNION = 'intra_union'
const	VAT_CLASS_INVALID = 'invalid'
const	VAT_CLASS_ERROR = 'error'
const	VAT_VALIDATION_WSDL_URL = 'http://ec.europa.eu/taxation_customs/vies/services/checkVatService?wsdl'
const	XML_PATH_CUSTOMER_GROUP_AUTO_ASSIGN = 'customer/create_account/auto_group_assign'
const	XML_PATH_EU_COUNTRIES_LIST = 'general/country/eu_countries'

Protected Member Functions
	createVatNumberValidationSoapClient ($trace=false)

Protected Attributes
	$scopeConfig
	$logger

Detailed Description

Customer VAT model

Definition at line 19 of file Vat.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ScopeConfigInterface	$scopeConfig,
		PsrLogger	$logger
	)

Parameters

ScopeConfigInterface	$scopeConfig
PsrLogger	$logger

Definition at line 73 of file Vat.php.

      {
        $this->scopeConfig = $scopeConfig;
        $this->logger = $logger;
    }

Member Function Documentation

canCheckVatNumber()

canCheckVatNumber	(		$countryCode,
			$vatNumber,
			$requesterCountryCode,
			$requesterVatNumber
	)

Check if parameters are valid to send to VAT validation service

Parameters

string	$countryCode
string	$vatNumber
string	$requesterCountryCode
string	$requesterVatNumber

Returns

boolean

@SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 241 of file Vat.php.

    {
        return !(!is_string($countryCode)
            || !is_string($vatNumber)
            || !is_string($requesterCountryCode)
            || !is_string($requesterVatNumber)
            || empty($countryCode)
            || !$this->isCountryInEU($countryCode)
            || empty($vatNumber)
            || empty($requesterCountryCode) && !empty($requesterVatNumber)
            || !empty($requesterCountryCode) && empty($requesterVatNumber)
            || !empty($requesterCountryCode) && !$this->isCountryInEU($requesterCountryCode)
        );
    }

checkVatNumber()

checkVatNumber	(		$countryCode,
			$vatNumber,
			$requesterCountryCode = '',
			$requesterVatNumber = ''
	)

Send request to VAT validation service and return validation result

Parameters

string	$countryCode
string	$vatNumber
string	$requesterCountryCode
string	$requesterVatNumber

Returns

DataObject

Definition at line 162 of file Vat.php.

    {
        // Default response
        $gatewayResponse = new DataObject([
            'is_valid' => false,
            'request_date' => '',
            'request_identifier' => '',
            'request_success' => false,
            'request_message' => __('Error during VAT Number verification.'),
        ]);

        if (!extension_loaded('soap')) {
            $this->logger->critical(new LocalizedException(__('PHP SOAP extension is required.')));
            return $gatewayResponse;
        }

        if (!$this->canCheckVatNumber($countryCode, $vatNumber, $requesterCountryCode, $requesterVatNumber)) {
            return $gatewayResponse;
        }

        try {
            $soapClient = $this->createVatNumberValidationSoapClient();

            $requestParams = [];
            $requestParams['countryCode'] = $countryCode;
            $vatNumberSanitized = $this->isCountryInEU($countryCode)
                ? str_replace([' ', '-', $countryCode], ['', '', ''], $vatNumber)
                : str_replace([' ', '-'], ['', ''], $vatNumber);
            $requestParams['vatNumber'] = $vatNumberSanitized;
            $requestParams['requesterCountryCode'] = $requesterCountryCode;
            $reqVatNumSanitized = $this->isCountryInEU($requesterCountryCode)
                ? str_replace([' ', '-', $requesterCountryCode], ['', '', ''], $requesterVatNumber)
                : str_replace([' ', '-'], ['', ''], $requesterVatNumber);
            $requestParams['requesterVatNumber'] = $reqVatNumSanitized;
            // Send request to service
            $result = $soapClient->checkVatApprox($requestParams);

            $gatewayResponse->setIsValid((bool)$result->valid);
            $gatewayResponse->setRequestDate((string)$result->requestDate);
            $gatewayResponse->setRequestIdentifier((string)$result->requestIdentifier);
            $gatewayResponse->setRequestSuccess(true);

            if ($gatewayResponse->getIsValid()) {
                $gatewayResponse->setRequestMessage(__('VAT Number is valid.'));
            } else {
                $gatewayResponse->setRequestMessage(__('Please enter a valid VAT number.'));
            }
        } catch (\Exception $exception) {
            $gatewayResponse->setIsValid(false);
            $gatewayResponse->setRequestDate('');
            $gatewayResponse->setRequestIdentifier('');
        }

        return $gatewayResponse;
    }

createVatNumberValidationSoapClient()

createVatNumberValidationSoapClient (   $trace = false )

protected

Create SOAP client based on VAT validation service WSDL

Parameters

boolean

$trace

Returns

\SoapClient

Definition at line 224 of file Vat.php.

    {
        return new \SoapClient(self::VAT_VALIDATION_WSDL_URL, ['trace' => $trace]);
    }

getCustomerGroupIdBasedOnVatNumber()

getCustomerGroupIdBasedOnVatNumber	(		$customerCountryCode,
			$vatValidationResult,
			$store = null
	)

Retrieve customer group ID based on his VAT number

Parameters

string	$customerCountryCode
DataObject	$vatValidationResult
\Magento\Store\Model\Store | string | int	$store

Returns

null|int

Definition at line 119 of file Vat.php.

    {
        $groupId = null;

        $isAutoGroupAssign = $this->scopeConfig->isSetFlag(
            self::XML_PATH_CUSTOMER_GROUP_AUTO_ASSIGN,
            ScopeInterface::SCOPE_STORE,
            $store
        );
        if (!$isAutoGroupAssign) {
            return $groupId;
        }

        $vatClass = $this->getCustomerVatClass($customerCountryCode, $vatValidationResult, $store);

        $vatClassToGroupXmlPathMap = [
            self::VAT_CLASS_DOMESTIC => self::XML_PATH_CUSTOMER_VIV_DOMESTIC_GROUP,
            self::VAT_CLASS_INTRA_UNION => self::XML_PATH_CUSTOMER_VIV_INTRA_UNION_GROUP,
            self::VAT_CLASS_INVALID => self::XML_PATH_CUSTOMER_VIV_INVALID_GROUP,
            self::VAT_CLASS_ERROR => self::XML_PATH_CUSTOMER_VIV_ERROR_GROUP,
        ];

        if (isset($vatClassToGroupXmlPathMap[$vatClass])) {
            $groupId = (int)$this->scopeConfig->getValue(
                $vatClassToGroupXmlPathMap[$vatClass],
                ScopeInterface::SCOPE_STORE,
                $store
            );
        }

        return $groupId;
    }

getCustomerVatClass()

getCustomerVatClass	(		$customerCountryCode,
			$vatValidationResult,
			$store = null
	)

Get VAT class

Parameters

string	$customerCountryCode
DataObject	$vatValidationResult
Store | string | int | null	$store

Returns

null|string

Definition at line 264 of file Vat.php.

    {
        $vatClass = null;

        $isVatNumberValid = $vatValidationResult->getIsValid();

        if (is_string($customerCountryCode)
            && !empty($customerCountryCode)
            && $customerCountryCode === $this->getMerchantCountryCode($store)
            && $isVatNumberValid
        ) {
            $vatClass = self::VAT_CLASS_DOMESTIC;
        } elseif ($isVatNumberValid) {
            $vatClass = self::VAT_CLASS_INTRA_UNION;
        } else {
            $vatClass = self::VAT_CLASS_INVALID;
        }

        if (!$vatValidationResult->getRequestSuccess()) {
            $vatClass = self::VAT_CLASS_ERROR;
        }

        return $vatClass;
    }

getMerchantCountryCode()

getMerchantCountryCode

(

$store = null

)

Retrieve merchant country code

Parameters

Store | string | int | null

$store

Returns

string

Definition at line 87 of file Vat.php.

    {
        return (string)$this->scopeConfig->getValue(
            StoreInformation::XML_PATH_STORE_INFO_COUNTRY_CODE,
            ScopeInterface::SCOPE_STORE,
            $store
        );
    }

getMerchantVatNumber()

getMerchantVatNumber

(

$store = null

)

Retrieve merchant VAT number

Parameters

Store | string | int | null

$store

Returns

string

Definition at line 102 of file Vat.php.

    {
        return (string)$this->scopeConfig->getValue(
            StoreInformation::XML_PATH_STORE_INFO_VAT_NUMBER,
            ScopeInterface::SCOPE_STORE,
            $store
        );
    }

isCountryInEU()

isCountryInEU	(		$countryCode,
			$storeId = null
	)

Check whether specified country is in EU countries list

Parameters

string	$countryCode
null | int	$storeId

Returns

bool

Definition at line 296 of file Vat.php.

    {
        $euCountries = explode(
            ',',
            $this->scopeConfig->getValue(self::XML_PATH_EU_COUNTRIES_LIST, ScopeInterface::SCOPE_STORE, $storeId)
        );
        return in_array($countryCode, $euCountries);
    }

Field Documentation

$logger

$logger

protected

Definition at line 67 of file Vat.php.

$scopeConfig

$scopeConfig

protected

Definition at line 62 of file Vat.php.

VAT_CLASS_DOMESTIC

const VAT_CLASS_DOMESTIC = 'domestic'

VAT class constants

Definition at line 35 of file Vat.php.

VAT_CLASS_ERROR

const VAT_CLASS_ERROR = 'error'

Definition at line 41 of file Vat.php.

VAT_CLASS_INTRA_UNION

const VAT_CLASS_INTRA_UNION = 'intra_union'

Definition at line 37 of file Vat.php.

VAT_CLASS_INVALID

const VAT_CLASS_INVALID = 'invalid'

Definition at line 39 of file Vat.php.

VAT_VALIDATION_WSDL_URL

const VAT_VALIDATION_WSDL_URL = 'http://ec.europa.eu/taxation_customs/vies/services/checkVatService?wsdl'

WSDL of VAT validation service

Definition at line 47 of file Vat.php.

XML_PATH_CUSTOMER_GROUP_AUTO_ASSIGN

const XML_PATH_CUSTOMER_GROUP_AUTO_ASSIGN = 'customer/create_account/auto_group_assign'

Config path to option that enables/disables automatic group assignment based on VAT

Definition at line 52 of file Vat.php.

XML_PATH_CUSTOMER_VIV_DOMESTIC_GROUP

const XML_PATH_CUSTOMER_VIV_DOMESTIC_GROUP = 'customer/create_account/viv_domestic_group'

Definition at line 26 of file Vat.php.

XML_PATH_CUSTOMER_VIV_ERROR_GROUP

const XML_PATH_CUSTOMER_VIV_ERROR_GROUP = 'customer/create_account/viv_error_group'

Definition at line 30 of file Vat.php.

XML_PATH_CUSTOMER_VIV_INTRA_UNION_GROUP

const XML_PATH_CUSTOMER_VIV_INTRA_UNION_GROUP = 'customer/create_account/viv_intra_union_group'

Config paths to VAT related customer groups

Definition at line 24 of file Vat.php.

XML_PATH_CUSTOMER_VIV_INVALID_GROUP

const XML_PATH_CUSTOMER_VIV_INVALID_GROUP = 'customer/create_account/viv_invalid_group'

Definition at line 28 of file Vat.php.

XML_PATH_EU_COUNTRIES_LIST

const XML_PATH_EU_COUNTRIES_LIST = 'general/country/eu_countries'

Config path to UE country list

Definition at line 57 of file Vat.php.

---

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

• vendor/magento/module-customer/Model/Vat.php