Inheritance diagram for AbstractAddress:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory, \Magento\Framework\Api\AttributeValueFactory $customAttributeFactory, \Magento\Directory\Helper\Data $directoryData, \Magento\Eav\Model\Config $eavConfig, Config $addressConfig, \Magento\Directory\Model\RegionFactory $regionFactory, \Magento\Directory\Model\CountryFactory $countryFactory, AddressMetadataInterface $metadataService, AddressInterfaceFactory $addressDataFactory, RegionInterfaceFactory $regionDataFactory, \Magento\Framework\Api\DataObjectHelper $dataObjectHelper, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[], CompositeValidator $compositeValidator=null)

	getName ()

	getStreet ()

	getStreetLine ($number)

	getStreetFull ()

	setStreetFull ($street)

	setStreet ($street)

	setData ($key, $value=null)

	explodeStreetAddress ()

	getRegion ()

	getRegionCode ()

	getRegionId ()

	getCountry ()

	getCountryModel ()

	getRegionModel ($regionId=null)

	format ($type)

	getConfig ()

	beforeSave ()

	validate ()

	unsRegion ()

Public Member Functions inherited from AbstractExtensibleModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	getCustomAttributes ()

	getCustomAttribute ($attributeCode)

	setCustomAttributes (array $attributes)

	setCustomAttribute ($attributeCode, $attributeValue)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	setId ($value)

	__sleep ()

	__wakeup ()

Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	__sleep ()

	__wakeup ()

	setIdFieldName ($name)

	getIdFieldName ()

	getId ()

	setId ($value)

	isDeleted ($isDeleted=null)

	hasDataChanges ()

	setData ($key, $value=null)

	unsetData ($key=null)

	setDataChanges ($value)

	getOrigData ($key=null)

	setOrigData ($key=null, $data=null)

	dataHasChangedFor ($field)

	getResourceName ()

	getResourceCollection ()

	getCollection ()

	load ($modelId, $field=null)

	beforeLoad ($identifier, $field=null)

	afterLoad ()

	isSaveAllowed ()

	setHasDataChanges ($flag)

	save ()

	afterCommitCallback ()

	isObjectNew ($flag=null)

	beforeSave ()

	validateBeforeSave ()

	getCacheTags ()

	cleanModelCache ()

	afterSave ()

	delete ()

	beforeDelete ()

	afterDelete ()

	afterDeleteCommit ()

	getResource ()

	getEntityId ()

	setEntityId ($entityId)

	clearInstance ()

	getStoredData ()

	getEventPrefix ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Data Fields
const	TYPE_BILLING = 'billing'

const	TYPE_SHIPPING = 'shipping'

Data Fields inherited from CustomAttributesDataInterface
const	CUSTOM_ATTRIBUTES = 'custom_attributes'

Data Fields inherited from ExtensibleDataInterface
const	EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'

Protected Member Functions
	isAddressMultilineAttribute ($code)

	_implodeArrayField (array $data)

	_implodeArrayValues ($value)

	_createRegionInstance ()

	_createCountryInstance ()

	isCompanyRequired ()

	isTelephoneRequired ()

	isFaxRequired ()

Protected Member Functions inherited from AbstractExtensibleModel
	filterCustomAttributes ($data)

	initializeCustomAttributes ()

	convertCustomAttributeValues (array &$customAttributes)

	getCustomAttributesCodes ()

	_setExtensionAttributes (\Magento\Framework\Api\ExtensionAttributesInterface $extensionAttributes)

	_getExtensionAttributes ()

Protected Member Functions inherited from AbstractModel
	_construct ()

	_init ($resourceModel)

	_setResourceModel ($resourceName, $collectionName=null)

	_getResource ()

	_getEventData ()

	_beforeLoad ($modelId, $field=null)

	_afterLoad ()

	_hasModelChanged ()

	_getValidatorBeforeSave ()

	_createValidatorBeforeSave ()

	_getValidationRulesBeforeSave ()

	_clearReferences ()

	_clearData ()

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_eventPrefix = 'customer_address'

	$_eventObject = 'customer_address'

	$_directoryData = null

	$_eavConfig

	$_addressConfig

	$_regionFactory

	$_countryFactory

	$metadataService

	$addressDataFactory

	$regionDataFactory

	$dataObjectHelper

Protected Attributes inherited from AbstractExtensibleModel
	$extensionAttributesFactory

	$extensionAttributes

	$customAttributeFactory

	$customAttributesCodes = null

	$customAttributesChanged = false

Protected Attributes inherited from AbstractModel
	$_eventPrefix = 'core_abstract'

	$_eventObject = 'object'

	$_idFieldName = 'id'

	$_hasDataChanges = false

	$_origData

	$_isDeleted = false

	$_resource

	$_resourceCollection

	$_resourceName

	$_collectionName

	$_cacheTag = false

	$_dataSaveAllowed = true

	$_isObjectNew = null

	$_validatorBeforeSave = null

	$_eventManager

	$_cacheManager

	$_registry

	$_logger

	$_appState

	$_actionValidator

	$storedData = []

Protected Attributes inherited from DataObject
	$_data = []

Static Protected Attributes
static	$_countryModels = []

static	$_regionModels = []

Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Address abstract model

@method string getPrefix() @method string getSuffix() @method string getFirstname() @method string getMiddlename() @method string getLastname() @method int getCountryId() @method string getCity() @method string getTelephone() @method string getCompany() @method string getFax() @method string getPostcode() @method bool getShouldIgnoreValidation() @SuppressWarnings(PHPMD.CouplingBetweenObjects)

@api

Since: 100.0.2

Definition at line 38 of file AbstractAddress.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory,
		\Magento\Framework\Api\AttributeValueFactory	$customAttributeFactory,
		\Magento\Directory\Helper\Data	$directoryData,
		\Magento\Eav\Model\Config	$eavConfig,
		Config	$addressConfig,
		\Magento\Directory\Model\RegionFactory	$regionFactory,
		\Magento\Directory\Model\CountryFactory	$countryFactory,
		AddressMetadataInterface	$metadataService,
		AddressInterfaceFactory	$addressDataFactory,
		RegionInterfaceFactory	$regionDataFactory,
		\Magento\Framework\Api\DataObjectHelper	$dataObjectHelper,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = `null`,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = `null`,
		array	$data = `[]`,
		CompositeValidator	$compositeValidator = `null`
	)

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory
\Magento\Framework\Api\AttributeValueFactory	$customAttributeFactory
\Magento\Directory\Helper\Data	$directoryData
\Magento\Eav\Model\Config	$eavConfig
Config	$addressConfig
\Magento\Directory\Model\RegionFactory	$regionFactory
\Magento\Directory\Model\CountryFactory	$countryFactory
AddressMetadataInterface	$metadataService
AddressInterfaceFactory	$addressDataFactory
RegionInterfaceFactory	$regionDataFactory
\Magento\Framework\Api\DataObjectHelper	$dataObjectHelper
\Magento\Framework\Model\ResourceModel\AbstractResource	$resource
\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection
array	$data
CompositeValidator	$compositeValidator	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 146 of file AbstractAddress.php.

       {
         $this->_directoryData = $directoryData;
         $data = $this->_implodeArrayField($data);
         $this->_eavConfig = $eavConfig;
         $this->_addressConfig = $addressConfig;
         $this->_regionFactory = $regionFactory;
         $this->_countryFactory = $countryFactory;
         $this->metadataService = $metadataService;
         $this->addressDataFactory = $addressDataFactory;
         $this->regionDataFactory = $regionDataFactory;
         $this->dataObjectHelper = $dataObjectHelper;
         $this->compositeValidator = $compositeValidator ?: ObjectManager::getInstance()
             ->get(CompositeValidator::class);
         parent::__construct(
             $context,
             $registry,
             $extensionFactory,
             $customAttributeFactory,
             $resource,
             $resourceCollection,
             $data
         );
     }

Member Function Documentation

◆ _createCountryInstance()

_createCountryInstance ( )

protected

Returns: \Magento\Directory\Model\Country

Definition at line 604 of file AbstractAddress.php.

     {
         return $this->_countryFactory->create();
     }

◆ _createRegionInstance()

_createRegionInstance ( )

protected

Returns: \Magento\Directory\Model\Region

Definition at line 596 of file AbstractAddress.php.

     {
         return $this->_regionFactory->create();
     }

◆ _implodeArrayField()

_implodeArrayField ( array $data )

protected

Implode value of the array field, if it is present among other fields

Parameters

array $data

Returns: array

Definition at line 303 of file AbstractAddress.php.

     {
         foreach ($data as $key => $value) {
             if (is_array($value) && $this->isAddressMultilineAttribute($key)) {
                 $data[$key] = $this->_implodeArrayValues($data[$key]);
             }
         }
         return $data;
     }

◆ _implodeArrayValues()

_implodeArrayValues ( $value )

protected

Combine values of field lines into a single string

Parameters

string[]|string $value

Returns: string

Definition at line 319 of file AbstractAddress.php.

     {
         if (is_array($value)) {
             if (!count($value)) {
                 return '';
             }
 
             $isScalar = false;
             foreach ($value as $val) {
                 if (is_scalar($val)) {
                     $isScalar = true;
                 }
             }
             if ($isScalar) {
                 $value = trim(implode("\n", $value));
             }
         }
         return $value;
     }

◆ beforeSave()

beforeSave ( )

Returns: $this

Definition at line 507 of file AbstractAddress.php.

     {
         parent::beforeSave();
         $this->getRegion();
         return $this;
     }

◆ explodeStreetAddress()

explodeStreetAddress ( )

Create fields street1, street2, etc.

To be used in controllers for views data

Returns: $this

Implements AddressModelInterface.

Definition at line 346 of file AbstractAddress.php.

     {
         $streetLines = $this->getStreet();
         foreach ($streetLines as $i => $line) {
             $this->setData('street' . ($i + 1), $line);
         }
         return $this;
     }

◆ format()

format ( $type )

Format address in a specific way

Deprecated, use this code instead: $renderer = $this->_addressConfig->getFormatByCode('html')->getRenderer(); $addressMapper = \Magento\Customer\Model\Address\Mapper type $addressData = $addressMapper->toFlatArray($address); $formattedAddress = $renderer->renderArray($addressData);

Parameters

string $type

Returns: string|null

Definition at line 485 of file AbstractAddress.php.

     {
         if (!($formatType = $this->getConfig()->getFormatByCode($type)) || !$formatType->getRenderer()) {
             return null;
         }
         $this->_eventManager->dispatch('customer_address_format', ['type' => $formatType, 'address' => $this]);
         return $formatType->getRenderer()->render($this);
     }

◆ getConfig()

getConfig ( )

Retrieve address config object

Returns: Config

Definition at line 499 of file AbstractAddress.php.

     {
         return $this->_addressConfig;
     }

◆ getCountry()

getCountry ( )

Returns: int

Definition at line 430 of file AbstractAddress.php.

     {
         $country = $this->getCountryId();
         return $country ? $country : $this->getData('country');
     }

◆ getCountryModel()

getCountryModel ( )

Retrieve country model

Returns: \Magento\Directory\Model\Country

Definition at line 441 of file AbstractAddress.php.

     {
         if (!isset(self::$_countryModels[$this->getCountryId()])) {
             $country = $this->_createCountryInstance();
             $country->load($this->getCountryId());
             self::$_countryModels[$this->getCountryId()] = $country;
         }
 
         return self::$_countryModels[$this->getCountryId()];
     }

◆ getName()

getName ( )

Get full customer name

Returns: string

Definition at line 193 of file AbstractAddress.php.

     {
         $name = '';
         if ($this->_eavConfig->getAttribute('customer_address', 'prefix')->getIsVisible() && $this->getPrefix()) {
             $name .= $this->getPrefix() . ' ';
         }
         $name .= $this->getFirstname();
         $middleName = $this->_eavConfig->getAttribute('customer_address', 'middlename');
         if ($middleName->getIsVisible() && $this->getMiddlename()) {
             $name .= ' ' . $this->getMiddlename();
         }
         $name .= ' ' . $this->getLastname();
         if ($this->_eavConfig->getAttribute('customer_address', 'suffix')->getIsVisible() && $this->getSuffix()) {
             $name .= ' ' . $this->getSuffix();
         }
         return $name;
     }

◆ getRegion()

getRegion ( )

Retrieve region name

Returns: string

Definition at line 360 of file AbstractAddress.php.

     {
         $regionId = $this->getData('region_id');
         $region = $this->getData('region');
 
         if (!$regionId && is_numeric($region)) {
             if ($this->getRegionModel($region)->getCountryId() == $this->getCountryId()) {
                 $this->setData('region', $this->getRegionModel($region)->getName());
                 $this->setData('region_id', $region);
             }
         } elseif ($regionId) {
             if ($this->getRegionModel($regionId)->getCountryId() == $this->getCountryId()) {
                 $this->setData('region', $this->getRegionModel($regionId)->getName());
             }
         } elseif (is_string($region)) {
             $this->setData('region', $region);
         }
 
         return $this->getData('region');
     }

◆ getRegionCode()

getRegionCode ( )

Return 2 letter state code if available, otherwise full region name

Returns: string

Definition at line 386 of file AbstractAddress.php.

     {
         $regionId = $this->getData('region_id');
         $region = $this->getData('region');
 
         if (!$regionId && is_numeric($region)) {
             if ($this->getRegionModel($region)->getCountryId() == $this->getCountryId()) {
                 $this->setData('region_code', $this->getRegionModel($region)->getCode());
             }
         } elseif ($regionId) {
             if ($this->getRegionModel($regionId)->getCountryId() == $this->getCountryId()) {
                 $this->setData('region_code', $this->getRegionModel($regionId)->getCode());
             }
         } elseif (is_string($region)) {
             $this->setData('region_code', $region);
         }
         return $this->getData('region_code');
     }

◆ getRegionId()

getRegionId ( )

Returns: int

Definition at line 408 of file AbstractAddress.php.

     {
         $regionId = $this->getData('region_id');
         $region = $this->getData('region');
         if (!$regionId) {
             if (is_numeric($region)) {
                 $this->setData('region_id', $region);
                 $this->unsRegion();
             } else {
                 $regionModel = $this->_createRegionInstance()->loadByCode(
                     $this->getRegionCode(),
                     $this->getCountryId()
                 );
                 $this->setData('region_id', $regionModel->getId());
             }
         }
         return $this->getData('region_id');
     }

◆ getRegionModel()

getRegionModel ( $regionId = null )

Retrieve country model

Parameters

int | null $regionId

Returns: \Magento\Directory\Model\Region

Definition at line 458 of file AbstractAddress.php.

     {
         if ($regionId === null) {
             $regionId = $this->getRegionId();
         }
 
         if (!isset(self::$_regionModels[$regionId])) {
             $region = $this->_createRegionInstance();
             $region->load($regionId);
             self::$_regionModels[$regionId] = $region;
         }
 
         return self::$_regionModels[$regionId];
     }

◆ getStreet()

getStreet ( )

Retrieve street field of an address

Returns: string[]

Definition at line 216 of file AbstractAddress.php.

     {
         if (is_array($this->getStreetFull())) {
             return $this->getStreetFull();
         }
         return explode("\n", $this->getStreetFull());
     }

◆ getStreetFull()

getStreetFull ( )

Retrieve text of street lines, concatenated using LF symbol

Returns: string

Definition at line 241 of file AbstractAddress.php.

     {
         $street = $this->getData('street');
         return is_array($street) ? implode("\n", $street) : $street;
     }

◆ getStreetLine()

getStreetLine ( $number )

Get steet line by number

Parameters

int $number

Returns: string

Implements AddressModelInterface.

Definition at line 230 of file AbstractAddress.php.

     {
         $lines = $this->getStreet();
         return isset($lines[$number - 1]) ? $lines[$number - 1] : '';
     }

◆ isAddressMultilineAttribute()

isAddressMultilineAttribute ( $code )

protected

Check that address can have multiline attribute by this code (as street or some custom attribute)

Parameters

string $code

Returns: bool

Definition at line 292 of file AbstractAddress.php.

     {
         return $code == 'street' || in_array($code, $this->getCustomAttributesCodes());
     }

◆ isCompanyRequired()

isCompanyRequired ( )

protected

Returns: bool

Since: 101.0.0

Definition at line 623 of file AbstractAddress.php.

     {
         return ($this->_eavConfig->getAttribute('customer_address', 'company')->getIsRequired());
     }

◆ isFaxRequired()

isFaxRequired ( )

protected

Returns: bool

Since: 101.0.0

Definition at line 641 of file AbstractAddress.php.

     {
         return ($this->_eavConfig->getAttribute('customer_address', 'fax')->getIsRequired());
     }

◆ isTelephoneRequired()

isTelephoneRequired ( )

protected

Returns: bool

Since: 101.0.0

Definition at line 632 of file AbstractAddress.php.

     {
         return ($this->_eavConfig->getAttribute('customer_address', 'telephone')->getIsRequired());
     }

◆ setData()

setData	(	$key,
		$value = `null`
	)

Enforce format of the street field or other multiline custom attributes

Parameters

array \| string	$key
null	$value

Returns: \Magento\Framework\DataObject

Definition at line 277 of file AbstractAddress.php.

     {
         if (is_array($key)) {
             $key = $this->_implodeArrayField($key);
         } elseif (is_array($value) && $this->isAddressMultilineAttribute($key)) {
             $value = $this->_implodeArrayValues($value);
         }
         return parent::setData($key, $value);
     }

◆ setStreet()

setStreet ( $street )

Non-magic setter for a street field

Parameters

string|string[] $street

Returns: $this

Definition at line 264 of file AbstractAddress.php.

     {
         $this->setData('street', $street);
         return $this;
     }

◆ setStreetFull()

setStreetFull ( $street )

Alias for a street setter. To be used though setDataUsingMethod('street_full', $value).

Parameters

string|string[] $street

Returns: $this

Definition at line 253 of file AbstractAddress.php.

     {
         return $this->setStreet($street);
     }

◆ unsRegion()

unsRegion ( )

Unset Region from address

Returns: $this

Since: 101.0.0

Definition at line 614 of file AbstractAddress.php.

     {
         return $this->unsetData("region");
     }

◆ validate()

validate ( )

Validate address attribute values.

Returns: array|bool

Definition at line 578 of file AbstractAddress.php.

     {
         if ($this->getShouldIgnoreValidation()) {
             return true;
         }
 
         $errors = $this->compositeValidator->validate($this);
 
         if (empty($errors)) {
             return true;
         }
 
         return $errors;
     }

Field Documentation

◆ $_addressConfig

$_addressConfig

protected

Definition at line 90 of file AbstractAddress.php.

◆ $_countryFactory

$_countryFactory

protected

Definition at line 100 of file AbstractAddress.php.

◆ $_countryModels

$_countryModels = []

staticprotected

Definition at line 66 of file AbstractAddress.php.

◆ $_directoryData

$_directoryData = null

protected

Definition at line 80 of file AbstractAddress.php.

◆ $_eavConfig

$_eavConfig

protected

Definition at line 85 of file AbstractAddress.php.

◆ $_eventObject

$_eventObject = 'customer_address'

protected

Definition at line 59 of file AbstractAddress.php.

◆ $_eventPrefix

$_eventPrefix = 'customer_address'

protected

Definition at line 52 of file AbstractAddress.php.

◆ $_regionFactory

$_regionFactory

protected

Definition at line 95 of file AbstractAddress.php.

◆ $_regionModels

$_regionModels = []

staticprotected

Definition at line 73 of file AbstractAddress.php.

◆ $addressDataFactory

$addressDataFactory

protected

Definition at line 110 of file AbstractAddress.php.

◆ $dataObjectHelper

$dataObjectHelper

protected

Definition at line 120 of file AbstractAddress.php.

◆ $metadataService

$metadataService

protected

Definition at line 105 of file AbstractAddress.php.

◆ $regionDataFactory

$regionDataFactory

protected

Definition at line 115 of file AbstractAddress.php.

◆ TYPE_BILLING

const TYPE_BILLING = 'billing'

Possible customer address types

Definition at line 43 of file AbstractAddress.php.

◆ TYPE_SHIPPING

const TYPE_SHIPPING = 'shipping'

Definition at line 45 of file AbstractAddress.php.

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

vendor/magento/module-customer/Model/Address/AbstractAddress.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _createCountryInstance()

◆ _createRegionInstance()

◆ _implodeArrayField()

◆ _implodeArrayValues()

◆ beforeSave()

◆ explodeStreetAddress()

◆ format()

◆ getConfig()

◆ getCountry()

◆ getCountryModel()

◆ getName()

◆ getRegion()

◆ getRegionCode()

◆ getRegionId()

◆ getRegionModel()

◆ getStreet()

◆ getStreetFull()

◆ getStreetLine()

◆ isAddressMultilineAttribute()

◆ isCompanyRequired()

◆ isFaxRequired()

◆ isTelephoneRequired()

◆ setData()

◆ setStreet()

◆ setStreetFull()

◆ unsRegion()

◆ validate()

Field Documentation

◆ $_addressConfig

◆ $_countryFactory

◆ $_countryModels

◆ $_directoryData

◆ $_eavConfig

◆ $_eventObject

◆ $_eventPrefix

◆ $_regionFactory

◆ $_regionModels

◆ $addressDataFactory

◆ $dataObjectHelper

◆ $metadataService

◆ $regionDataFactory

◆ TYPE_BILLING

◆ TYPE_SHIPPING