Magento 2 Documentation
2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
|
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) | |
![]() | |
__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 | |
![]() | |
$_moduleName | |
$_request | |
$_moduleManager | |
$_logger | |
$_urlBuilder | |
$_httpHeader | |
$_eventManager | |
$_remoteAddress | |
$urlEncoder | |
$urlDecoder | |
$scopeConfig | |
$_cacheConfig | |
Additional Inherited Members | |
![]() | |
_getRequest () | |
_getModuleName () | |
_getUrl ($route, $params=[]) | |
Customer address helper
@api @SuppressWarnings(PHPMD.CouplingBetweenObjects)
Definition at line 21 of file Address.php.
__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 | ||
) |
\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.
canShowConfig | ( | $key | ) |
Determine if specified address config value can be shown
string | $key |
Definition at line 237 of file Address.php.
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')
string[] | $origStreets | |
int | $toCount |
Definition at line 283 of file Address.php.
getBookUrl | ( | ) |
getConfig | ( | $key, | |
$store = null |
|||
) |
Return customer address config value by key and store
string | $key | |
\Magento\Store\Model\Store | int | string | $store |
Definition at line 170 of file Address.php.
getCreateUrl | ( | ) |
getDeleteUrl | ( | ) |
getEditUrl | ( | ) |
getFormat | ( | $code | ) |
getFormatTypeRenderer | ( | $code | ) |
Retrieve renderer by code
string | $code |
Definition at line 222 of file Address.php.
getRenderer | ( | $renderer | ) |
string | $renderer |
Definition at line 154 of file Address.php.
getStreetLines | ( | $store = null | ) |
Return Number of Lines in a Street Address for store
\Magento\Store\Model\Store | int | string | $store |
Definition at line 190 of file Address.php.
getTaxCalculationAddressType | ( | $store = null | ) |
Retrieve customer address type on which tax calculation must be based
\Magento\Store\Model\Store | string | int | null | $store |
Definition at line 357 of file Address.php.
hasValidateOnEachTransaction | ( | $store = null | ) |
Retrieve 'validate on each transaction' value
\Magento\Store\Model\Store | string | int | $store |
Definition at line 342 of file Address.php.
isAttributeVisible | ( | $code | ) |
Retrieve attribute visibility
string | $code |
Definition at line 386 of file Address.php.
isDisableAutoGroupAssignDefaultValue | ( | ) |
Retrieve disable auto group assign default value
Definition at line 328 of file Address.php.
isVatAttributeVisible | ( | ) |
Check if VAT ID address attribute has to be shown on frontend (on Customer Address management forms)
Definition at line 371 of file Address.php.
isVatValidationEnabled | ( | $store = null | ) |
Check whether VAT ID validation is enabled
\Magento\Store\Model\Store | string | int | $store |
Definition at line 314 of file Address.php.
|
protected |
Definition at line 94 of file Address.php.
|
protected |
Definition at line 89 of file Address.php.
|
protected |
Definition at line 48 of file Address.php.
|
protected |
Definition at line 72 of file Address.php.
|
protected |
Definition at line 55 of file Address.php.
|
protected |
Definition at line 84 of file Address.php.
|
protected |
Definition at line 67 of file Address.php.
|
protected |
Definition at line 77 of file Address.php.
|
protected |
Definition at line 62 of file Address.php.
const TYPE_BILLING = 'billing' |
Possible customer address types
Definition at line 39 of file Address.php.
const TYPE_SHIPPING = 'shipping' |
Definition at line 41 of file Address.php.
const XML_PATH_VAT_FRONTEND_VISIBILITY = 'customer/create_account/vat_frontend_visibility' |
Definition at line 34 of file Address.php.
const XML_PATH_VAT_VALIDATION_ENABLED = 'customer/create_account/auto_group_assign' |
Definition at line 30 of file Address.php.
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.
const XML_PATH_VIV_ON_EACH_TRANSACTION = 'customer/create_account/viv_on_each_transaction' |
Definition at line 28 of file Address.php.
const XML_PATH_VIV_TAX_CALCULATION_ADDRESS_TYPE = 'customer/create_account/tax_calculation_address_type' |
Definition at line 32 of file Address.php.