Address Class Reference

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\Sales\Model\OrderFactory $orderFactory, \Magento\Directory\Model\RegionFactory $regionFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])
	setOrder (\Magento\Sales\Model\Order $order)
	getRegionCode ()
	getName ()
	setData ($key, $value=null)
	explodeStreetAddress ()
	getOrder ()
	getStreet ()
	getStreetLine ($number)
	getAddressType ()
	getCity ()
	getCompany ()
	getCountryId ()
	getCustomerAddressId ()
	getCustomerId ()
	getEmail ()
	getEntityId ()
	setEntityId ($entityId)
	getFax ()
	getFirstname ()
	getLastname ()
	getMiddlename ()
	getParentId ()
	getPostcode ()
	getPrefix ()
	getRegion ()
	getRegionId ()
	getSuffix ()
	getTelephone ()
	getVatId ()
	getVatIsValid ()
	getVatRequestDate ()
	getVatRequestId ()
	getVatRequestSuccess ()
	setParentId ($id)
	setCustomerAddressId ($id)
	setRegionId ($id)
	setStreet ($street)
	setCustomerId ($id)
	setFax ($fax)
	setRegion ($region)
	setPostcode ($postcode)
	setLastname ($lastname)
	setCity ($city)
	setEmail ($email)
	setTelephone ($telephone)
	setCountryId ($id)
	setFirstname ($firstname)
	setAddressType ($addressType)
	setPrefix ($prefix)
	setMiddlename ($middlename)
	setSuffix ($suffix)
	setCompany ($company)
	setVatId ($id)
	setVatIsValid ($vatIsValid)
	setVatRequestId ($id)
	setRegionCode ($regionCode)
	setVatRequestDate ($vatRequestDate)
	setVatRequestSuccess ($vatRequestSuccess)
	getExtensionAttributes ()
	setExtensionAttributes (\Magento\Sales\Api\Data\OrderAddressExtensionInterface $extensionAttributes)
Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])
	getEventObject ()
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)
Public Member Functions inherited from OrderAddressInterface
	setExtensionAttributes (\Magento\Sales\Api\Data\OrderAddressExtensionInterface $extensionAttributes)

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'
Data Fields inherited from OrderAddressInterface
const	ENTITY_ID = 'entity_id'
const	PARENT_ID = 'parent_id'
const	CUSTOMER_ADDRESS_ID = 'customer_address_id'
const	REGION_ID = 'region_id'
const	KEY_REGION_CODE = 'region_code'
const	CUSTOMER_ID = 'customer_id'
const	FAX = 'fax'
const	REGION = 'region'
const	POSTCODE = 'postcode'
const	LASTNAME = 'lastname'
const	STREET = 'street'
const	CITY = 'city'
const	EMAIL = 'email'
const	TELEPHONE = 'telephone'
const	COUNTRY_ID = 'country_id'
const	FIRSTNAME = 'firstname'
const	ADDRESS_TYPE = 'address_type'
const	PREFIX = 'prefix'
const	MIDDLENAME = 'middlename'
const	SUFFIX = 'suffix'
const	COMPANY = 'company'
const	VAT_ID = 'vat_id'
const	VAT_IS_VALID = 'vat_is_valid'
const	VAT_REQUEST_ID = 'vat_request_id'
const	VAT_REQUEST_DATE = 'vat_request_date'
const	VAT_REQUEST_SUCCESS = 'vat_request_success'

Protected Member Functions
	_construct ()
	implodeStreetValue ($value)
	implodeStreetField (array $data)
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
	$order
	$_eventPrefix = 'sales_order_address'
	$_eventObject = 'address'
	$orderFactory
	$regionFactory
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
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Sales order address model

@api @method \Magento\Customer\Api\Data\AddressInterface getCustomerAddressData() @method Address setCustomerAddressData(\Magento\Customer\Api\Data\AddressInterface $value) @SuppressWarnings(PHPMD.CouplingBetweenObjects) @SuppressWarnings(PHPMD.ExcessivePublicCount)

Since

100.0.2

Definition at line 22 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\Sales\Model\OrderFactory	$orderFactory,
		\Magento\Directory\Model\RegionFactory	$regionFactory,
		\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\Sales\Model\OrderFactory	$orderFactory
\Magento\Directory\Model\RegionFactory	$regionFactory
\Magento\Framework\Model\ResourceModel\AbstractResource	$resource
\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection
array	$data

Definition at line 67 of file Address.php.

      {
        $data = $this->implodeStreetField($data);
        $this->regionFactory = $regionFactory;
        $this->orderFactory = $orderFactory;
        parent::__construct(
            $context,
            $registry,
            $extensionFactory,
            $customAttributeFactory,
            $resource,
            $resourceCollection,
            $data
        );
    }

Member Function Documentation

_construct()

_construct ( )

protected

Initialize resource

Returns

void

Definition at line 97 of file Address.php.

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

explodeStreetAddress()

explodeStreetAddress

(

)

Create fields street1, street2, etc.

To be used in controllers for views data

Returns

$this

Implements AddressModelInterface.

Definition at line 210 of file Address.php.

    {
        $streetLines = $this->getStreet();
        foreach ($streetLines as $lineNumber => $lineValue) {
            $this->setData(OrderAddressInterface::STREET . ($lineNumber + 1), $lineValue);
        }
        return $this;
    }

getAddressType()

getAddressType

(

)

Returns address_type

Returns

string

Implements OrderAddressInterface.

Definition at line 264 of file Address.php.

    {
        return $this->getData(OrderAddressInterface::ADDRESS_TYPE);
    }

getCity()

getCity

(

)

Returns city

Returns

string

Implements OrderAddressInterface.

Definition at line 274 of file Address.php.

    {
        return $this->getData(OrderAddressInterface::CITY);
    }

getCompany()

getCompany

(

)

Returns company

Returns

string

Implements OrderAddressInterface.

Definition at line 284 of file Address.php.

    {
        return $this->getData(OrderAddressInterface::COMPANY);
    }

getCountryId()

getCountryId

(

)

Returns country_id

Returns

string

Implements OrderAddressInterface.

Definition at line 294 of file Address.php.

    {
        return $this->getData(OrderAddressInterface::COUNTRY_ID);
    }

getCustomerAddressId()

getCustomerAddressId

(

)

Returns customer_address_id

Returns

int

Implements OrderAddressInterface.

Definition at line 304 of file Address.php.

    {
        return $this->getData(OrderAddressInterface::CUSTOMER_ADDRESS_ID);
    }

getCustomerId()

getCustomerId

(

)

Returns customer_id

Returns

int

Implements OrderAddressInterface.

Definition at line 314 of file Address.php.

    {
        return $this->getData(OrderAddressInterface::CUSTOMER_ID);
    }

getEmail()

getEmail

(

)

Returns email

Returns

string

Implements OrderAddressInterface.

Definition at line 324 of file Address.php.

    {
        return $this->getData(OrderAddressInterface::EMAIL);
    }

getEntityId()

getEntityId

(

)

Returns entity_id

Returns

int

Implements OrderAddressInterface.

Definition at line 334 of file Address.php.

    {
        return $this->getData(OrderAddressInterface::ENTITY_ID);
    }

getExtensionAttributes()

getExtensionAttributes

(

)

{Retrieve existing extension attributes object or create a new one.

Returns

\Magento\Sales\Api\Data\OrderAddressExtensionInterface|null

}

Returns

\Magento\Sales\Api\Data\OrderAddressExtensionInterface|null

Implements OrderAddressInterface.

Definition at line 715 of file Address.php.

    {
        return $this->_getExtensionAttributes();
    }

getFax()

getFax

(

)

Returns fax

Returns

string

Implements OrderAddressInterface.

Definition at line 355 of file Address.php.

    {
        return $this->getData(OrderAddressInterface::FAX);
    }

getFirstname()

getFirstname

(

)

Returns firstname

Returns

string

Implements OrderAddressInterface.

Definition at line 365 of file Address.php.

    {
        return $this->getData(OrderAddressInterface::FIRSTNAME);
    }

getLastname()

getLastname

(

)

Returns lastname

Returns

string

Implements OrderAddressInterface.

Definition at line 375 of file Address.php.

    {
        return $this->getData(OrderAddressInterface::LASTNAME);
    }

getMiddlename()

getMiddlename

(

)

Returns middlename

Returns

string

Implements OrderAddressInterface.

Definition at line 385 of file Address.php.

    {
        return $this->getData(OrderAddressInterface::MIDDLENAME);
    }

getName()

getName

(

)

Get full customer name

Returns

string

Definition at line 141 of file Address.php.

    {
        $name = '';
        if ($this->getPrefix()) {
            $name .= $this->getPrefix() . ' ';
        }
        $name .= $this->getFirstname();
        if ($this->getMiddlename()) {
            $name .= ' ' . $this->getMiddlename();
        }
        $name .= ' ' . $this->getLastname();
        if ($this->getSuffix()) {
            $name .= ' ' . $this->getSuffix();
        }
        return $name;
    }

getOrder()

getOrder

(

)

Get order

Returns

\Magento\Sales\Model\Order

Definition at line 224 of file Address.php.

    {
        if (!$this->order) {
            $this->order = $this->orderFactory->create()->load($this->getParentId());
        }
        return $this->order;
    }

getParentId()

getParentId

(

)

Returns parent_id

Returns

int

Implements OrderAddressInterface.

Definition at line 395 of file Address.php.

    {
        return $this->getData(OrderAddressInterface::PARENT_ID);
    }

getPostcode()

getPostcode

(

)

Returns postcode

Returns

string

Implements OrderAddressInterface.

Definition at line 405 of file Address.php.

    {
        return $this->getData(OrderAddressInterface::POSTCODE);
    }

getPrefix()

getPrefix

(

)

Returns prefix

Returns

string

Implements OrderAddressInterface.

Definition at line 415 of file Address.php.

    {
        return $this->getData(OrderAddressInterface::PREFIX);
    }

getRegion()

getRegion

(

)

Returns region

Returns

string

Implements OrderAddressInterface.

Definition at line 425 of file Address.php.

    {
        return $this->getData(OrderAddressInterface::REGION);
    }

getRegionCode()

getRegionCode

(

)

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

Returns

null|string

Implements OrderAddressInterface.

Definition at line 121 of file Address.php.

    {
        $regionId = (!$this->getRegionId() && is_numeric($this->getRegion())) ?
            $this->getRegion() :
            $this->getRegionId();
        $model = $this->regionFactory->create()->load($regionId);
        if ($model->getCountryId() == $this->getCountryId()) {
            return $model->getCode();
        } elseif (is_string($this->getRegion())) {
            return $this->getRegion();
        } else {
            return null;
        }
    }

getRegionId()

getRegionId

(

)

Returns region_id

Returns

int

Implements OrderAddressInterface.

Definition at line 435 of file Address.php.

    {
        return $this->getData(OrderAddressInterface::REGION_ID);
    }

getStreet()

getStreet

(

)

Retrieve street field of an address

Returns

string[]

Implements OrderAddressInterface.

Definition at line 237 of file Address.php.

    {
        if (is_array($this->getData(OrderAddressInterface::STREET))) {
            return $this->getData(OrderAddressInterface::STREET);
        }
        return explode(PHP_EOL, $this->getData(OrderAddressInterface::STREET));
    }

getStreetLine()

getStreetLine

(

$number

)

Get street line by number

Parameters

int

$number

Returns

string

Implements AddressModelInterface.

Definition at line 251 of file Address.php.

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

getSuffix()

getSuffix

(

)

Returns suffix

Returns

string

Implements OrderAddressInterface.

Definition at line 445 of file Address.php.

    {
        return $this->getData(OrderAddressInterface::SUFFIX);
    }

getTelephone()

getTelephone

(

)

Returns telephone

Returns

string

Implements OrderAddressInterface.

Definition at line 455 of file Address.php.

    {
        return $this->getData(OrderAddressInterface::TELEPHONE);
    }

getVatId()

getVatId

(

)

Returns vat_id

Returns

string

Implements OrderAddressInterface.

Definition at line 465 of file Address.php.

    {
        return $this->getData(OrderAddressInterface::VAT_ID);
    }

getVatIsValid()

getVatIsValid

(

)

Returns vat_is_valid

Returns

int

Implements OrderAddressInterface.

Definition at line 475 of file Address.php.

    {
        return $this->getData(OrderAddressInterface::VAT_IS_VALID);
    }

getVatRequestDate()

getVatRequestDate

(

)

Returns vat_request_date

Returns

string

Implements OrderAddressInterface.

Definition at line 485 of file Address.php.

    {
        return $this->getData(OrderAddressInterface::VAT_REQUEST_DATE);
    }

getVatRequestId()

getVatRequestId

(

)

Returns vat_request_id

Returns

string

Implements OrderAddressInterface.

Definition at line 495 of file Address.php.

    {
        return $this->getData(OrderAddressInterface::VAT_REQUEST_ID);
    }

getVatRequestSuccess()

getVatRequestSuccess

(

)

Returns vat_request_success

Returns

int

Implements OrderAddressInterface.

Definition at line 505 of file Address.php.

    {
        return $this->getData(OrderAddressInterface::VAT_REQUEST_SUCCESS);
    }

implodeStreetField()

implodeStreetField ( array  $data )

protected

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

Parameters

array

$data

Returns

array

Definition at line 195 of file Address.php.

    {
        if (array_key_exists(OrderAddressInterface::STREET, $data)) {
            $data[OrderAddressInterface::STREET] = $this->implodeStreetValue($data[OrderAddressInterface::STREET]);
        }
        return $data;
    }

implodeStreetValue()

implodeStreetValue (   $value )

protected

Combine values of street lines into a single string

Parameters

string[]|string

$value

Returns

string

Definition at line 164 of file Address.php.

    {
        if (is_array($value)) {
            $value = trim(implode(PHP_EOL, $value));
        }
        return $value;
    }

setAddressType()

setAddressType

(

$addressType

)

{Sets the address type for the order address.

Parameters

string

$addressType

Returns

$this

}

Implements OrderAddressInterface.

Definition at line 625 of file Address.php.

    {
        return $this->setData(OrderAddressInterface::ADDRESS_TYPE, $addressType);
    }

setCity()

setCity

(

$city

)

{Sets the city for the order address.

Parameters

string

$city

Returns

$this

}

Implements OrderAddressInterface.

Definition at line 585 of file Address.php.

    {
        return $this->setData(OrderAddressInterface::CITY, $city);
    }

setCompany()

setCompany

(

$company

)

{Sets the company for the order address.

Parameters

string

$company

Returns

$this

}

Implements OrderAddressInterface.

Definition at line 657 of file Address.php.

    {
        return $this->setData(OrderAddressInterface::COMPANY, $company);
    }

setCountryId()

setCountryId

(

$id

)

{Sets the country ID for the order address.

Parameters

string

$id

Returns

$this

}

Implements OrderAddressInterface.

Definition at line 609 of file Address.php.

    {
        return $this->setData(OrderAddressInterface::COUNTRY_ID, $id);
    }

setCustomerAddressId()

setCustomerAddressId

(

$id

)

{Sets the country address ID for the order address.

Parameters

int

$id

Returns

$this

}

Implements OrderAddressInterface.

Definition at line 521 of file Address.php.

    {
        return $this->setData(OrderAddressInterface::CUSTOMER_ADDRESS_ID, $id);
    }

setCustomerId()

setCustomerId

(

$id

)

{Sets the customer ID for the order address.

Parameters

int

$id

Returns

$this

}

Implements OrderAddressInterface.

Definition at line 545 of file Address.php.

    {
        return $this->setData(OrderAddressInterface::CUSTOMER_ID, $id);
    }

setData()

setData	(		$key,
			$value = null
	)

Enforce format of the street field

Parameters

array | string	$key
null	$value

Returns

\Magento\Framework\DataObject

Definition at line 179 of file Address.php.

    {
        if (is_array($key)) {
            $key = $this->implodeStreetField($key);
        } elseif ($key == OrderAddressInterface::STREET) {
            $value = $this->implodeStreetValue($value);
        }
        return parent::setData($key, $value);
    }

setEmail()

setEmail

(

$email

)

{Sets the email address for the order address.

Parameters

string

$email

Returns

$this

}

Implements OrderAddressInterface.

Definition at line 593 of file Address.php.

    {
        return $this->setData(OrderAddressInterface::EMAIL, $email);
    }

setEntityId()

setEntityId

(

$entityId

)

Sets the ID for the order address.

Parameters

int

$entityId

Returns

$this

Implements OrderAddressInterface.

Definition at line 345 of file Address.php.

    {
        return $this->setData(OrderAddressInterface::ENTITY_ID, $entityId);
    }

setExtensionAttributes()

setExtensionAttributes

(

\Magento\Sales\Api\Data\OrderAddressExtensionInterface

$extensionAttributes

)

{}

Parameters

\Magento\Sales\Api\Data\OrderAddressExtensionInterface

$extensionAttributes

Returns

$this

Definition at line 726 of file Address.php.

    {
        return $this->_setExtensionAttributes($extensionAttributes);
    }

setFax()

setFax

(

$fax

)

{Sets the fax number for the order address.

Parameters

string

$fax

Returns

$this

}

Implements OrderAddressInterface.

Definition at line 553 of file Address.php.

    {
        return $this->setData(OrderAddressInterface::FAX, $fax);
    }

setFirstname()

setFirstname

(

$firstname

)

{Sets the first name for the order address.

Parameters

string

$firstname

Returns

$this

}

Implements OrderAddressInterface.

Definition at line 617 of file Address.php.

    {
        return $this->setData(OrderAddressInterface::FIRSTNAME, $firstname);
    }

setLastname()

setLastname

(

$lastname

)

{Sets the last name for the order address.

Parameters

string

$lastname

Returns

$this

}

Implements OrderAddressInterface.

Definition at line 577 of file Address.php.

    {
        return $this->setData(OrderAddressInterface::LASTNAME, $lastname);
    }

setMiddlename()

setMiddlename

(

$middlename

)

{Sets the middle name for the order address.

Parameters

string

$middlename

Returns

$this

}

Implements OrderAddressInterface.

Definition at line 641 of file Address.php.

    {
        return $this->setData(OrderAddressInterface::MIDDLENAME, $middlename);
    }

setOrder()

setOrder

(

\Magento\Sales\Model\Order

$order

)

Set order

@codeCoverageIgnore

Parameters

\Magento\Sales\Model\Order

$order

Returns

$this

Definition at line 110 of file Address.php.

    {
        $this->order = $order;
        return $this;
    }

setParentId()

setParentId

(

$id

)

{Sets the parent ID for the order address.

Parameters

int

$id

Returns

$this

}

Implements OrderAddressInterface.

Definition at line 513 of file Address.php.

    {
        return $this->setData(OrderAddressInterface::PARENT_ID, $id);
    }

setPostcode()

setPostcode

(

$postcode

)

{Sets the postal code for the order address.

Parameters

string

$postcode

Returns

$this

}

Implements OrderAddressInterface.

Definition at line 569 of file Address.php.

    {
        return $this->setData(OrderAddressInterface::POSTCODE, $postcode);
    }

setPrefix()

setPrefix

(

$prefix

)

{Sets the prefix for the order address.

Parameters

string

$prefix

Returns

$this

}

Implements OrderAddressInterface.

Definition at line 633 of file Address.php.

    {
        return $this->setData(OrderAddressInterface::PREFIX, $prefix);
    }

setRegion()

setRegion

(

$region

)

{Sets the region for the order address.

Parameters

string

$region

Returns

$this

}

Implements OrderAddressInterface.

Definition at line 561 of file Address.php.

    {
        return $this->setData(OrderAddressInterface::REGION, $region);
    }

setRegionCode()

setRegionCode

(

$regionCode

)

{Set region code

Parameters

string

$regionCode

Returns

$this

}

Implements OrderAddressInterface.

Definition at line 689 of file Address.php.

    {
        return $this->setData(OrderAddressInterface::KEY_REGION_CODE, $regionCode);
    }

setRegionId()

setRegionId

(

$id

)

{Sets the region ID for the order address.

Parameters

int

$id

Returns

$this

}

Implements OrderAddressInterface.

Definition at line 529 of file Address.php.

    {
        return $this->setData(OrderAddressInterface::REGION_ID, $id);
    }

setStreet()

setStreet

(

$street

)

{Sets the street values, if any, for the order address.

Parameters

string|string[]

$street

Returns

$this

}

Implements OrderAddressInterface.

Definition at line 537 of file Address.php.

    {
        return $this->setData(OrderAddressInterface::STREET, $street);
    }

setSuffix()

setSuffix

(

$suffix

)

{Sets the suffix for the order address.

Parameters

string

$suffix

Returns

$this

}

Implements OrderAddressInterface.

Definition at line 649 of file Address.php.

    {
        return $this->setData(OrderAddressInterface::SUFFIX, $suffix);
    }

setTelephone()

setTelephone

(

$telephone

)

{Sets the telephone number for the order address.

Parameters

string

$telephone

Returns

$this

}

Implements OrderAddressInterface.

Definition at line 601 of file Address.php.

    {
        return $this->setData(OrderAddressInterface::TELEPHONE, $telephone);
    }

setVatId()

setVatId

(

$id

)

{Sets the VAT ID for the order address.

Parameters

string

$id

Returns

$this

}

Implements OrderAddressInterface.

Definition at line 665 of file Address.php.

    {
        return $this->setData(OrderAddressInterface::VAT_ID, $id);
    }

setVatIsValid()

setVatIsValid

(

$vatIsValid

)

{Sets the VAT-is-valid flag value for the order address.

Parameters

int

$vatIsValid

Returns

$this

}

Implements OrderAddressInterface.

Definition at line 673 of file Address.php.

    {
        return $this->setData(OrderAddressInterface::VAT_IS_VALID, $vatIsValid);
    }

setVatRequestDate()

setVatRequestDate

(

$vatRequestDate

)

{Sets the VAT request date for the order address.

Parameters

string

$vatRequestDate

Returns

$this

}

Implements OrderAddressInterface.

Definition at line 697 of file Address.php.

    {
        return $this->setData(OrderAddressInterface::VAT_REQUEST_DATE, $vatRequestDate);
    }

setVatRequestId()

setVatRequestId

(

$id

)

{Sets the VAT request ID for the order address.

Parameters

string

$id

Returns

$this

}

Implements OrderAddressInterface.

Definition at line 681 of file Address.php.

    {
        return $this->setData(OrderAddressInterface::VAT_REQUEST_ID, $id);
    }

setVatRequestSuccess()

setVatRequestSuccess

(

$vatRequestSuccess

)

{Sets the VAT-request-success flag value for the order address.

Parameters

int

$vatRequestSuccess

Returns

$this

}

Implements OrderAddressInterface.

Definition at line 705 of file Address.php.

    {
        return $this->setData(OrderAddressInterface::VAT_REQUEST_SUCCESS, $vatRequestSuccess);
    }

Field Documentation

$_eventObject

$_eventObject = 'address'

protected

Definition at line 44 of file Address.php.

$_eventPrefix

$_eventPrefix = 'sales_order_address'

protected

Definition at line 39 of file Address.php.

$order

$order

protected

Definition at line 34 of file Address.php.

$orderFactory

$orderFactory

protected

Definition at line 49 of file Address.php.

$regionFactory

$regionFactory

protected

Definition at line 54 of file Address.php.

TYPE_BILLING

const TYPE_BILLING = 'billing'

Possible customer address types

Definition at line 27 of file Address.php.

TYPE_SHIPPING

const TYPE_SHIPPING = 'shipping'

Definition at line 29 of file Address.php.

---

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

• vendor/magento/module-sales/Model/Order/Address.php