Inheritance diagram for Address:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, \Magento\Framework\View\Element\BlockFactory $blockFactory, \Magento\Store\Model\StoreManagerInterface $storeManager, CustomerMetadataInterface $customerMetadataService, AddressMetadataInterface $addressMetadataService, \Magento\Customer\Model\Address\Config $addressConfig)

	getBookUrl ()

	getEditUrl ()

	getDeleteUrl ()

	getCreateUrl ()

	getRenderer ($renderer)

	getConfig ($key, $store=null)

	getStreetLines ($store=null)

	getFormat ($code)

	getFormatTypeRenderer ($code)

	canShowConfig ($key)

	convertStreetLines ($origStreets, $toCount)

	isVatValidationEnabled ($store=null)

	isDisableAutoGroupAssignDefaultValue ()

	hasValidateOnEachTransaction ($store=null)

	getTaxCalculationAddressType ($store=null)

	isVatAttributeVisible ()

	isAttributeVisible ($code)

Public Member Functions inherited from AbstractHelper
	__construct (Context $context)

	isModuleOutputEnabled ($moduleName=null)

Data Fields
const	XML_PATH_VIV_DISABLE_AUTO_ASSIGN_DEFAULT = 'customer/create_account/viv_disable_auto_group_assign_default'

const	XML_PATH_VIV_ON_EACH_TRANSACTION = 'customer/create_account/viv_on_each_transaction'

const	XML_PATH_VAT_VALIDATION_ENABLED = 'customer/create_account/auto_group_assign'

const	XML_PATH_VIV_TAX_CALCULATION_ADDRESS_TYPE = 'customer/create_account/tax_calculation_address_type'

const	XML_PATH_VAT_FRONTEND_VISIBILITY = 'customer/create_account/vat_frontend_visibility'

const	TYPE_BILLING = 'billing'

const	TYPE_SHIPPING = 'shipping'

Protected Attributes
	$_attributes

	$_config = []

	$_streetLines = []

	$_formatTemplate = []

	$_blockFactory

	$_storeManager

	$_customerMetadataService

	$_addressMetadataService

	$_addressConfig

Protected Attributes inherited from AbstractHelper
	$_moduleName

	$_request

	$_moduleManager

	$_logger

	$_urlBuilder

	$_httpHeader

	$_eventManager

	$_remoteAddress

	$urlEncoder

	$urlDecoder

	$scopeConfig

	$_cacheConfig

Additional Inherited Members
Protected Member Functions inherited from AbstractHelper
	_getRequest ()

	_getModuleName ()

	_getUrl ($route, $params=[])

Detailed Description

Customer address helper

@api @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 21 of file Address.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		\Magento\Framework\View\Element\BlockFactory	$blockFactory,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		CustomerMetadataInterface	$customerMetadataService,
		AddressMetadataInterface	$addressMetadataService,
		\Magento\Customer\Model\Address\Config	$addressConfig
	)

Parameters

\Magento\Framework\App\Helper\Context	$context
\Magento\Framework\View\Element\BlockFactory	$blockFactory
\Magento\Store\Model\StoreManagerInterface	$storeManager
CustomerMetadataInterface	$customerMetadataService
AddressMetadataInterface	$addressMetadataService
\Magento\Customer\Model\Address\Config	$addressConfig

Definition at line 104 of file Address.php.

       {
         $this->_blockFactory = $blockFactory;
         $this->_storeManager = $storeManager;
         $this->_customerMetadataService = $customerMetadataService;
         $this->_addressMetadataService = $addressMetadataService;
         $this->_addressConfig = $addressConfig;
         parent::__construct($context);
     }

Member Function Documentation

◆ canShowConfig()

canShowConfig ( $key )

Determine if specified address config value can be shown

Parameters

string $key

Returns: bool

Definition at line 237 of file Address.php.

     {
         return (bool)$this->getConfig($key);
     }

◆ convertStreetLines()

convertStreetLines	(	$origStreets,
		$toCount
	)

Convert streets array to new street lines count Examples of use: $origStreets = array('street1', 'street2', 'street3', 'street4') $toCount = 3 Result: array('street1 street2', 'street3', 'street4') $toCount = 2 Result: array('street1 street2', 'street3 street4')

Parameters

	string[]	$origStreets
int	$toCount

Returns: string[]

Definition at line 283 of file Address.php.

     {
         $lines = [];
         if (!empty($origStreets) && $toCount > 0) {
             $countArgs = (int)floor(count($origStreets) / $toCount);
             $modulo = count($origStreets) % $toCount;
             $offset = 0;
             $neededLinesCount = 0;
             for ($i = 0; $i < $toCount; $i++) {
                 $offset += $neededLinesCount;
                 $neededLinesCount = $countArgs;
                 if ($modulo > 0) {
                     ++$neededLinesCount;
                     --$modulo;
                 }
                 $values = array_slice($origStreets, $offset, $neededLinesCount);
                 if (is_array($values)) {
                     $lines[] = implode(' ', $values);
                 }
             }
         }
 
         return $lines;
     }

◆ getBookUrl()

getBookUrl ( )

Addresses url

Returns: void

Definition at line 125 of file Address.php.

126 {

127 }

◆ getConfig()

getConfig	(	$key,
		$store = `null`
	)

Return customer address config value by key and store

Parameters

string	$key
\Magento\Store\Model\Store \| int \| string	$store

Returns: string|null

Definition at line 170 of file Address.php.

     {
         $store = $this->_storeManager->getStore($store);
         $websiteId = $store->getWebsiteId();
         if (!isset($this->_config[$websiteId])) {
             $this->_config[$websiteId] = $this->scopeConfig->getValue(
                 'customer/address',
                 \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
                 $store
             );
         }
         return isset($this->_config[$websiteId][$key]) ? (string)$this->_config[$websiteId][$key] : null;
     }

◆ getCreateUrl()

getCreateUrl ( )

Returns: void

Definition at line 146 of file Address.php.

147 {

148 }

◆ getDeleteUrl()

getDeleteUrl ( )

Returns: void

Definition at line 139 of file Address.php.

140 {

141 }

◆ getEditUrl()

getEditUrl ( )

Returns: void

Definition at line 132 of file Address.php.

133 {

134 }

◆ getFormat()

getFormat ( $code )

Parameters

string $code

Returns: Format|string

Definition at line 210 of file Address.php.

     {
         $format = $this->_addressConfig->getFormatByCode($code);
         return $format->getRenderer() ? $format->getRenderer()->getFormatArray() : '';
     }

◆ getFormatTypeRenderer()

getFormatTypeRenderer ( $code )

Retrieve renderer by code

Parameters

string $code

Returns: \Magento\Customer\Block\Address\Renderer\RendererInterface|null

Definition at line 222 of file Address.php.

     {
         $formatType = $this->_addressConfig->getFormatByCode($code);
         if (!$formatType || !$formatType->getRenderer()) {
             return null;
         }
         return $formatType->getRenderer();
     }

◆ getRenderer()

getRenderer ( $renderer )

Parameters

string $renderer

Returns: \Magento\Framework\View\Element\BlockInterface

Definition at line 154 of file Address.php.

     {
         if (is_string($renderer) && $renderer) {
             return $this->_blockFactory->createBlock($renderer, []);
         } else {
             return $renderer;
         }
     }

◆ getStreetLines()

getStreetLines ( $store = null )

Return Number of Lines in a Street Address for store

Parameters

\Magento\Store\Model\Store | int | string $store

Returns: int

Definition at line 190 of file Address.php.

     {
         $websiteId = $this->_storeManager->getStore($store)->getWebsiteId();
         if (!isset($this->_streetLines[$websiteId])) {
             $attribute = $this->_addressMetadataService->getAttributeMetadata('street');
 
             $lines = $attribute->getMultilineCount();
             if ($lines <= 0) {
                 $lines = 2;
             }
             $this->_streetLines[$websiteId] = min($lines, 20);
         }
 
         return $this->_streetLines[$websiteId];
     }

◆ getTaxCalculationAddressType()

getTaxCalculationAddressType ( $store = null )

Retrieve customer address type on which tax calculation must be based

Parameters

\Magento\Store\Model\Store | string | int | null $store

Returns: string

Definition at line 357 of file Address.php.

     {
         return (string)$this->scopeConfig->getValue(
             self::XML_PATH_VIV_TAX_CALCULATION_ADDRESS_TYPE,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $store
         );
     }

◆ hasValidateOnEachTransaction()

hasValidateOnEachTransaction ( $store = null )

Retrieve 'validate on each transaction' value

Parameters

\Magento\Store\Model\Store | string | int $store

Returns: bool

Definition at line 342 of file Address.php.

     {
         return (bool)$this->scopeConfig->getValue(
             self::XML_PATH_VIV_ON_EACH_TRANSACTION,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $store
         );
     }

◆ isAttributeVisible()

isAttributeVisible ( $code )

Retrieve attribute visibility

Parameters

string $code

Returns: bool

Since: 101.0.0

Definition at line 386 of file Address.php.

     {
         $attributeMetadata = $this->_addressMetadataService->getAttributeMetadata($code);
         if ($attributeMetadata) {
             return $attributeMetadata->isVisible();
         }
         return false;
     }

◆ isDisableAutoGroupAssignDefaultValue()

isDisableAutoGroupAssignDefaultValue ( )

Retrieve disable auto group assign default value

Returns: bool

Definition at line 328 of file Address.php.

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

◆ isVatAttributeVisible()

isVatAttributeVisible ( )

Check if VAT ID address attribute has to be shown on frontend (on Customer Address management forms)

Returns: boolean

Definition at line 371 of file Address.php.

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

◆ isVatValidationEnabled()

isVatValidationEnabled ( $store = null )

Check whether VAT ID validation is enabled

Parameters

\Magento\Store\Model\Store | string | int $store

Returns: bool

Definition at line 314 of file Address.php.

     {
         return (bool)$this->scopeConfig->getValue(
             self::XML_PATH_VAT_VALIDATION_ENABLED,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $store
         );
     }

Field Documentation

◆ $_addressConfig

$_addressConfig

protected

Definition at line 94 of file Address.php.

◆ $_addressMetadataService

$_addressMetadataService

protected

Definition at line 89 of file Address.php.

◆ $_attributes

$_attributes

protected

Definition at line 48 of file Address.php.

◆ $_blockFactory

$_blockFactory

protected

Definition at line 72 of file Address.php.

◆ $_config

$_config = []

protected

Definition at line 55 of file Address.php.

◆ $_customerMetadataService

$_customerMetadataService

protected

Definition at line 84 of file Address.php.

◆ $_formatTemplate

$_formatTemplate = []

protected

Definition at line 67 of file Address.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 77 of file Address.php.

◆ $_streetLines

$_streetLines = []

protected

Definition at line 62 of file Address.php.

◆ TYPE_BILLING

const TYPE_BILLING = 'billing'

Possible customer address types

Definition at line 39 of file Address.php.

◆ TYPE_SHIPPING

const TYPE_SHIPPING = 'shipping'

Definition at line 41 of file Address.php.

◆ XML_PATH_VAT_FRONTEND_VISIBILITY

const XML_PATH_VAT_FRONTEND_VISIBILITY = 'customer/create_account/vat_frontend_visibility'

Definition at line 34 of file Address.php.

◆ XML_PATH_VAT_VALIDATION_ENABLED

const XML_PATH_VAT_VALIDATION_ENABLED = 'customer/create_account/auto_group_assign'

Definition at line 30 of file Address.php.

◆ XML_PATH_VIV_DISABLE_AUTO_ASSIGN_DEFAULT

const XML_PATH_VIV_DISABLE_AUTO_ASSIGN_DEFAULT = 'customer/create_account/viv_disable_auto_group_assign_default'

VAT Validation parameters XML paths

Definition at line 26 of file Address.php.

◆ XML_PATH_VIV_ON_EACH_TRANSACTION

const XML_PATH_VIV_ON_EACH_TRANSACTION = 'customer/create_account/viv_on_each_transaction'

Definition at line 28 of file Address.php.

◆ XML_PATH_VIV_TAX_CALCULATION_ADDRESS_TYPE

const XML_PATH_VIV_TAX_CALCULATION_ADDRESS_TYPE = 'customer/create_account/tax_calculation_address_type'

Definition at line 32 of file Address.php.

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

vendor/magento/module-customer/Helper/Address.php

Public Member Functions

Data Fields

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ canShowConfig()

◆ convertStreetLines()

◆ getBookUrl()

◆ getConfig()

◆ getCreateUrl()

◆ getDeleteUrl()

◆ getEditUrl()

◆ getFormat()

◆ getFormatTypeRenderer()

◆ getRenderer()

◆ getStreetLines()

◆ getTaxCalculationAddressType()

◆ hasValidateOnEachTransaction()

◆ isAttributeVisible()

◆ isDisableAutoGroupAssignDefaultValue()

◆ isVatAttributeVisible()

◆ isVatValidationEnabled()

Field Documentation

◆ $_addressConfig

◆ $_addressMetadataService

◆ $_attributes

◆ $_blockFactory

◆ $_config

◆ $_customerMetadataService

◆ $_formatTemplate

◆ $_storeManager

◆ $_streetLines

◆ TYPE_BILLING

◆ TYPE_SHIPPING

◆ XML_PATH_VAT_FRONTEND_VISIBILITY

◆ XML_PATH_VAT_VALIDATION_ENABLED

◆ XML_PATH_VIV_DISABLE_AUTO_ASSIGN_DEFAULT

◆ XML_PATH_VIV_ON_EACH_TRANSACTION

◆ XML_PATH_VIV_TAX_CALCULATION_ADDRESS_TYPE