.. rst-class:: phpdoctorst

.. role:: php(code)
	:language: php


Address
=======


.. php:namespace:: Firstred\PostNL\Entity

.. php:class:: Address


	.. rst-class:: phpdoc-description
	
		| Class Address\.
		
	
	:Parent:
		:php:class:`Firstred\\PostNL\\Entity\\AbstractEntity`
	


Summary
-------

Methods
~~~~~~~

* :php:meth:`public \_\_construct\($AddressType, $FirstName, $Name, $CompanyName, $Street, $HouseNr, $HouseNrExt, $Zipcode, $City, $Countrycode, $Area, $BuildingName, $Department, $Doorcode, $Floor, $Region, $Remark, $StreetHouseNrExt\)<Firstred\\PostNL\\Entity\\Address::\_\_construct\(\)>`
* :php:meth:`public setZipcode\($Zipcode\)<Firstred\\PostNL\\Entity\\Address::setZipcode\(\)>`
* :php:meth:`public setAddressType\($AddressType\)<Firstred\\PostNL\\Entity\\Address::setAddressType\(\)>`


Properties
----------

.. php:attr:: public defaultProperties

	:Type: string[][] 


.. php:attr:: protected static AddressType

	:Type: string | null PostNL internal applications validate the receiver address\. In case the spelling of
		addresses should be different according to our PostNL information, the address details will
		be corrected\. This can be noticed in Track & Trace\.
		
		Please note that the webservice will not add address details\. Street and City fields will
		only be printed when they are in the call towards the labeling webservice\.
		
		The element Address type is a code in the request\. Possible values are:
		
		Code Description
		01   Receiver
		02   Sender
		03   Alternative sender address
		04   Collection address \(In the orders need to be collected first\)
		08   Return address\*
		09   Drop off location \(for use with Pick up at PostNL location\)
		
		\> \* When using the ‘label in the box return label’, it is mandatory to use an
		\>   \`Antwoordnummer\` in AddressType 08\.
		\>   This cannot be a regular address
		
		The following rules apply:
		If there is no Address specified with AddressType = 02, the data from Customer/Address
		will be added to the list as AddressType 02\.
		If there is no Customer/Address, the message will be rejected\.
		
		At least one other AddressType must be specified, other than AddressType 02
		In most cases this will be AddressType 01, the receiver address\.
	


.. php:attr:: protected static Area

	:Type: string | null 


.. php:attr:: protected static Buildingname

	:Type: string | null 


.. php:attr:: protected static City

	:Type: string | null 


.. php:attr:: protected static CompanyName

	:Type: string | null 


.. php:attr:: protected static Countrycode

	:Type: string | null 


.. php:attr:: protected static Department

	:Type: string | null 


.. php:attr:: protected static Doorcode

	:Type: string | null 


.. php:attr:: protected static FirstName

	:Type: string | null 


.. php:attr:: protected static Floor

	:Type: string | null 


.. php:attr:: protected static HouseNr

	:Type: string | null 


.. php:attr:: protected static HouseNrExt

	:Type: string | null 


.. php:attr:: protected static StreetHouseNrExt

	:Type: string | null 


.. php:attr:: protected static Name

	:Type: string | null 


.. php:attr:: protected static Region

	:Type: string | null 


.. php:attr:: protected static Remark

	:Type: string | null 


.. php:attr:: protected static Street

	:Type: string | null 


.. php:attr:: protected static Zipcode

	:Type: string | null 


.. php:attr:: protected static other

	:Type: array | null Array with optional properties


Methods
-------

.. rst-class:: public

	.. php:method:: public __construct( $AddressType=null, $FirstName=null, $Name=null, $CompanyName=null, $Street=null, $HouseNr=null, $HouseNrExt=null, $Zipcode=null, $City=null, $Countrycode=null, $Area=null, $BuildingName=null, $Department=null, $Doorcode=null, $Floor=null, $Region=null, $Remark=null, $StreetHouseNrExt=null)
	
		
		:Parameters:
			* **$AddressType** (string | null)  
			* **$FirstName** (string | null)  
			* **$Name** (string | null)  
			* **$CompanyName** (string | null)  
			* **$Street** (string | null)  
			* **$HouseNr** (string | null)  
			* **$HouseNrExt** (string | null)  
			* **$Zipcode** (string | null)  
			* **$City** (string | null)  
			* **$Countrycode** (string | null)  
			* **$Area** (string | null)  
			* **$BuildingName** (string | null)  
			* **$Department** (string | null)  
			* **$Doorcode** (string | null)  
			* **$Floor** (string | null)  
			* **$Region** (string | null)  
			* **$Remark** (string | null)  
			* **$StreetHouseNrExt** (string | null)  

		
	
	

.. rst-class:: public

	.. php:method:: public setZipcode( $Zipcode=null)
	
		.. rst-class:: phpdoc-description
		
			| Set postcode\.
			
		
		
		:Parameters:
			* **$Zipcode** (string | null)  

		
		:Returns: static 
	
	

.. rst-class:: public

	.. php:method:: public setAddressType( $AddressType=null)
	
		.. rst-class:: phpdoc-description
		
			| Set the AddressType\.
			
		
		
		:Parameters:
			* **$AddressType** (int | string | null)  

		
		:Returns: static