Inheritance diagram for Address:

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, \Magento\Customer\Model\Address\Config $addressConfig, \Magento\Directory\Model\RegionFactory $regionFactory, \Magento\Directory\Model\CountryFactory $countryFactory, AddressMetadataInterface $metadataService, AddressInterfaceFactory $addressDataFactory, RegionInterfaceFactory $regionDataFactory, \Magento\Framework\Api\DataObjectHelper $dataObjectHelper, CustomerFactory $customerFactory, \Magento\Framework\Reflection\DataObjectProcessor $dataProcessor, \Magento\Framework\Indexer\IndexerRegistry $indexerRegistry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	updateData (AddressInterface $address)

	getDataModel ($defaultBillingAddressId=null, $defaultShippingAddressId=null)

	getCustomerId ()

	setCustomerId ($id)

	getCustomer ()

	setCustomer (Customer $customer)

	getAttributes ()

	getDefaultAttributeCodes ()

	__clone ()

	getEntityType ()

	getRegionId ()

	setRegionId ($regionId)

	getEntityTypeId ()

	afterSave ()

	afterDeleteCommit ()

	getAttributeSetId ()

Public Member Functions inherited from AbstractAddress
	__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)

Protected Member Functions
	_construct ()

	_createCustomer ()

	getCustomAttributesCodes ()

Protected Member Functions inherited from AbstractAddress
	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
	$_customer

	$_customerFactory

	$dataProcessor

	$dataObjectHelper

	$indexerRegistry

Protected Attributes inherited from AbstractAddress
	$_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 = []

Additional Inherited Members
Data Fields inherited from AbstractAddress
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'

Static Protected Attributes inherited from AbstractAddress
static	$_countryModels = []

static	$_regionModels = []

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

Detailed Description

Customer address model

@api @method int getParentId() getParentId() @method \Magento\Customer\Model\Address setParentId() setParentId(int $parentId) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 23 of file Address.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,
		\Magento\Customer\Model\Address\Config	$addressConfig,
		\Magento\Directory\Model\RegionFactory	$regionFactory,
		\Magento\Directory\Model\CountryFactory	$countryFactory,
		AddressMetadataInterface	$metadataService,
		AddressInterfaceFactory	$addressDataFactory,
		RegionInterfaceFactory	$regionDataFactory,
		\Magento\Framework\Api\DataObjectHelper	$dataObjectHelper,
		CustomerFactory	$customerFactory,
		\Magento\Framework\Reflection\DataObjectProcessor	$dataProcessor,
		\Magento\Framework\Indexer\IndexerRegistry	$indexerRegistry,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = `null`,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = `null`,
		array	$data = `[]`
	)

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
Address\Config	$addressConfig
\Magento\Directory\Model\RegionFactory	$regionFactory
\Magento\Directory\Model\CountryFactory	$countryFactory
AddressMetadataInterface	$metadataService
AddressInterfaceFactory	$addressDataFactory
RegionInterfaceFactory	$regionDataFactory
\Magento\Framework\Api\DataObjectHelper	$dataObjectHelper
CustomerFactory	$customerFactory
\Magento\Framework\Reflection\DataObjectProcessor	$dataProcessor
\Magento\Framework\Indexer\IndexerRegistry	$indexerRegistry
\Magento\Framework\Model\ResourceModel\AbstractResource \| null	$resource
\Magento\Framework\Data\Collection\AbstractDb \| null	$resourceCollection
array	$data	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 80 of file Address.php.

       {
         $this->dataProcessor = $dataProcessor;
         $this->_customerFactory = $customerFactory;
         $this->indexerRegistry = $indexerRegistry;
         parent::__construct(
             $context,
             $registry,
             $extensionFactory,
             $customAttributeFactory,
             $directoryData,
             $eavConfig,
             $addressConfig,
             $regionFactory,
             $countryFactory,
             $metadataService,
             $addressDataFactory,
             $regionDataFactory,
             $dataObjectHelper,
             $resource,
             $resourceCollection,
             $data
         );
     }

Member Function Documentation

◆ __clone()

__clone ( )

Returns: void

Definition at line 266 of file Address.php.

     {
         $this->setId(null);
     }

◆ _construct()

_construct ( )

protected

Returns: void

Definition at line 127 of file Address.php.

     {
         $this->_init(\Magento\Customer\Model\ResourceModel\Address::class);
     }

◆ _createCustomer()

_createCustomer ( )

protected

Returns: Customer

Definition at line 306 of file Address.php.

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

◆ afterDeleteCommit()

afterDeleteCommit ( )

Init indexing process after customer delete

Returns: \Magento\Framework\Model\AbstractModel

Definition at line 340 of file Address.php.

     {
         $this->reindex();
         return parent::afterDeleteCommit();
     }

◆ afterSave()

afterSave ( )

Processing object after save data

Returns: $this

Definition at line 326 of file Address.php.

     {
         $indexer = $this->indexerRegistry->get(Customer::CUSTOMER_GRID_INDEXER_ID);
         if ($indexer->getState()->getStatus() == StateInterface::STATUS_VALID) {
             $this->_getResource()->addCommitCallback([$this, 'reindex']);
         }
         return parent::afterSave();
     }

◆ getAttributes()

getAttributes ( )

Retrieve address entity attributes

Returns: Attribute[]

Definition at line 243 of file Address.php.

     {
         $attributes = $this->getData('attributes');
         if ($attributes === null) {
             $attributes = $this->_getResource()->loadAllAttributes($this)->getSortedAttributes();
             $this->setData('attributes', $attributes);
         }
         return $attributes;
     }

◆ getAttributeSetId()

getAttributeSetId ( )

Retrieve attribute set id for customer address.

Returns: int

Since: 101.0.0

Definition at line 388 of file Address.php.

     {
         return parent::getAttributeSetId() ?: AddressMetadataInterface::ATTRIBUTE_SET_ID_ADDRESS;
     }

◆ getCustomAttributesCodes()

getCustomAttributesCodes ( )

protected

{}

Since: 100.0.6

Definition at line 362 of file Address.php.

     {
         return array_keys($this->getAttributeList()->getAttributes());
     }

◆ getCustomer()

getCustomer ( )

Retrieve address customer

Returns: Customer|false

Definition at line 214 of file Address.php.

     {
         if (!$this->getCustomerId()) {
             return false;
         }
         if (empty($this->_customer)) {
             $this->_customer = $this->_createCustomer()->load($this->getCustomerId());
         }
         return $this->_customer;
     }

◆ getCustomerId()

getCustomerId ( )

Retrieve address customer identifier

Returns: int

Definition at line 191 of file Address.php.

     {
         return $this->_getData('customer_id') ? $this->_getData('customer_id') : $this->getParentId();
     }

◆ getDataModel()

getDataModel	(	$defaultBillingAddressId = `null`,
		$defaultShippingAddressId = `null`
	)

{}

Definition at line 173 of file Address.php.

     {
         if ($this->getCustomerId() || $this->getParentId()) {
             if ($this->getCustomer()->getDefaultBillingAddress()) {
                 $defaultBillingAddressId = $this->getCustomer()->getDefaultBillingAddress()->getId();
             }
             if ($this->getCustomer()->getDefaultShippingAddress()) {
                 $defaultShippingAddressId = $this->getCustomer()->getDefaultShippingAddress()->getId();
             }
         }
         return parent::getDataModel($defaultBillingAddressId, $defaultShippingAddressId);
     }

◆ getDefaultAttributeCodes()

getDefaultAttributeCodes ( )

Get attributes created by default

Returns: string[]

Definition at line 258 of file Address.php.

     {
         return $this->_getResource()->getDefaultAttributes();
     }

◆ getEntityType()

getEntityType ( )

Return Entity Type instance

Returns: \Magento\Eav\Model\Entity\Type

Definition at line 276 of file Address.php.

     {
         return $this->_getResource()->getEntityType();
     }

◆ getEntityTypeId()

getEntityTypeId ( )

Return Entity Type ID

Returns: int

Definition at line 316 of file Address.php.

     {
         return $this->getEntityType()->getId();
     }

◆ getRegionId()

getRegionId ( )

Return Region ID

Returns: int

Definition at line 286 of file Address.php.

     {
         return (int)$this->getData('region_id');
     }

◆ setCustomer()

setCustomer ( Customer $customer )

Specify address customer

Parameters

Customer $customer

Returns: $this

Definition at line 231 of file Address.php.

     {
         $this->_customer = $customer;
         $this->setCustomerId($customer->getId());
         return $this;
     }

◆ setCustomerId()

setCustomerId ( $id )

Declare address customer identifier

Parameters

int $id

Returns: $this

Definition at line 202 of file Address.php.

     {
         $this->setParentId($id);
         $this->setData('customer_id', $id);
         return $this;
     }

◆ setRegionId()

setRegionId ( $regionId )

Set Region ID. $regionId is automatically converted to integer

Parameters

int $regionId

Returns: $this

Definition at line 297 of file Address.php.

     {
         $this->setData('region_id', (int)$regionId);
         return $this;
     }

◆ updateData()

updateData ( AddressInterface $address )

Update Model with the data from Data Interface

Parameters

AddressInterface $address

Returns: $this Use Api/RepositoryInterface for the operations in the Data Interfaces. Don't rely on Address Model

Definition at line 139 of file Address.php.

     {
         // Set all attributes
         $attributes = $this->dataProcessor
             ->buildOutputDataArray($address, \Magento\Customer\Api\Data\AddressInterface::class);
 
         foreach ($attributes as $attributeCode => $attributeData) {
             if (AddressInterface::REGION === $attributeCode) {
                 $this->setRegion($address->getRegion()->getRegion());
                 $this->setRegionCode($address->getRegion()->getRegionCode());
                 $this->setRegionId($address->getRegion()->getRegionId());
             } else {
                 $this->setDataUsingMethod($attributeCode, $attributeData);
             }
         }
         // Need to explicitly set this due to discrepancy in the keys between model and data object
         $this->setIsDefaultBilling($address->isDefaultBilling());
         $this->setIsDefaultShipping($address->isDefaultShipping());
         if (!$this->getAttributeSetId()) {
             $this->setAttributeSetId(AddressMetadataInterface::ATTRIBUTE_SET_ID_ADDRESS);
         }
         $customAttributes = $address->getCustomAttributes();
         if ($customAttributes !== null) {
             foreach ($customAttributes as $attribute) {
                 $this->setData($attribute->getAttributeCode(), $attribute->getValue());
             }
         }
 
         return $this;
     }

Field Documentation

◆ $_customer

$_customer

protected

Definition at line 30 of file Address.php.

◆ $_customerFactory

$_customerFactory

protected

Definition at line 35 of file Address.php.

◆ $dataObjectHelper

$dataObjectHelper

protected

Definition at line 45 of file Address.php.

◆ $dataProcessor

$dataProcessor

protected

Definition at line 40 of file Address.php.

◆ $indexerRegistry

$indexerRegistry

protected

Definition at line 50 of file Address.php.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __clone()

◆ _construct()

◆ _createCustomer()

◆ afterDeleteCommit()

◆ afterSave()

◆ getAttributes()

◆ getAttributeSetId()

◆ getCustomAttributesCodes()

◆ getCustomer()

◆ getCustomerId()

◆ getDataModel()

◆ getDefaultAttributeCodes()

◆ getEntityType()

◆ getEntityTypeId()

◆ getRegionId()

◆ setCustomer()

◆ setCustomerId()

◆ setRegionId()

◆ updateData()

Field Documentation

◆ $_customer

◆ $_customerFactory

◆ $dataObjectHelper

◆ $dataProcessor

◆ $indexerRegistry