Address
Address class
Namespace: Aspose.Barcode.ComplexBarcode
Address of creditor or debtor. You can either set street, house number, postal code and town (type structured address) or address line 1 and 2 (type combined address elements). The type is automatically set once any of these fields is set. Before setting the fields, the address type is undetermined. If fields of both types are set, the address type becomes conflicting. Name and country code must always be set unless all fields are empty.
Constructors
| Name | Description |
|---|---|
| __construct |
Methods
| Name | Static | Description |
|---|---|---|
| clear | No | Clears all fields and sets the type to AddressType.Undetermined. |
| construct | Yes | Constructs an Address object from AddressDTO. |
Properties
| Name | Read/Write | Description |
|---|---|---|
| AddressLine1 | Read/Write | Gets the address line 1. Address line 1 contains street name, house number or P.O. box. Setting this field sets the address type to AddressType.CombinedElements unless it’s already AddressType.Structured, in which case it becomes AddressType.Conflicting. This field is only used for combined elements addresses and is optional. |
| AddressLine2 | Read/Write | Gets the address line 2. Address line 2 contains postal code and town. Setting this field sets the address type to AddressType.CombinedElements unless it’s already AddressType.Structured, in which case it becomes AddressType.Conflicting. This field is only used for combined elements addresses. For this type, it’s mandatory. |
| CountryCode | Read/Write | Gets the two-letter ISO country code. The country code is mandatory unless the entire address contains null or emtpy values. |
| HouseNo | Read/Write | Gets the house number. Setting this field sets the address type to AddressType.Structured unless it’s already AddressType.CombinedElements, in which case it becomes AddressType.Conflicting. This field is only used for structured addresses and is optional. |
| Name | Read/Write | Gets the name, either the first and last name of a natural person or the company name of a legal person. |
| PostalCode | Read/Write | Gets the postal code. Setting this field sets the address type to AddressType.Structured unless it’s already AddressType.CombinedElements, in which case it becomes AddressType.Conflicting. This field is only used for structured addresses. For this type, it’s mandatory. |
| Street | Read/Write | Gets the street. The street must be speicfied without house number. Setting this field sets the address type to AddressType.Structured unless it’s already AddressType.CombinedElements, in which case it becomes AddressType.Conflicting. This field is only used for structured addresses and is optional. |
| Town | Read/Write | Gets the town or city. Setting this field sets the address type to AddressType.Structured unless it’s already AddressType.CombinedElements, in which case it becomes AddressType.Conflicting. This field is only used for structured addresses. For this type, it’s mandatory. |
| Type | Read-only | Gets the address type. The address type is automatically set by either setting street / house number or address line 1 and 2. Before setting the fields, the address type is Undetermined. If fields of both types are set, the address type becomes Conflicting. |
Address__construct()
clearclear()
Clears all fields and sets the type to AddressType.Undetermined.
constructconstruct(\Aspose\Barcode\Bridge\AddressDTO $addressDto) (static)
Constructs an Address object from AddressDTO.
| Parameter | Type | Description |
|---|---|---|
$addressDto | \Aspose\Barcode\Bridge\AddressDTO |
Returns: Address
AddressLine1
Access: Read/Write
Returns: string The address line 1.
Gets the address line 1. Address line 1 contains street name, house number or P.O. box. Setting this field sets the address type to AddressType.CombinedElements unless it’s already AddressType.Structured, in which case it becomes AddressType.Conflicting. This field is only used for combined elements addresses and is optional.
Sets the address line 1. Address line 1 contains street name, house number or P.O. box. Setting this field sets the address type to AddressType.CombinedElements unless it’s already AddressType.Structured, in which case it becomes AddressType.Conflicting. This field is only used for combined elements addresses and is optional.
| Parameter | Type | Description |
|---|---|---|
$value | ?string |
AddressLine2
Access: Read/Write
Returns: string The address line 2.
Gets the address line 2. Address line 2 contains postal code and town. Setting this field sets the address type to AddressType.CombinedElements unless it’s already AddressType.Structured, in which case it becomes AddressType.Conflicting. This field is only used for combined elements addresses. For this type, it’s mandatory.
Sets the address line 2. Address line 2 contains postal code and town. Setting this field sets the address type to AddressType.CombinedElements unless it’s already AddressType.Structured, in which case it becomes AddressType.Conflicting. This field is only used for combined elements addresses. For this type, it’s mandatory.
| Parameter | Type | Description |
|---|---|---|
$value | ?string |
CountryCode
Access: Read/Write
Returns: string The ISO country code.
Gets the two-letter ISO country code. The country code is mandatory unless the entire address contains null or emtpy values.
Sets the two-letter ISO country code. The country code is mandatory unless the entire address contains null or emtpy values.
| Parameter | Type | Description |
|---|---|---|
$value | ?string |
HouseNo
Access: Read/Write
Returns: string The house number.
Gets the house number. Setting this field sets the address type to AddressType.Structured unless it’s already AddressType.CombinedElements, in which case it becomes AddressType.Conflicting. This field is only used for structured addresses and is optional.
Sets the house number. Setting this field sets the address type to AddressType.Structured unless it’s already AddressType.CombinedElements, in which case it becomes AddressType.Conflicting. This field is only used for structured addresses and is optional.
| Parameter | Type | Description |
|---|---|---|
$value | ?string |
Name
Access: Read/Write
Returns: string The name.
Gets the name, either the first and last name of a natural person or the company name of a legal person.
Sets the name, either the first and last name of a natural person or the company name of a legal person.
| Parameter | Type | Description |
|---|---|---|
$value | ?string |
PostalCode
Access: Read/Write
Gets the postal code. Setting this field sets the address type to AddressType.Structured unless it’s already AddressType.CombinedElements, in which case it becomes AddressType.Conflicting. This field is only used for structured addresses. For this type, it’s mandatory.
Sets the postal code. Setting this field sets the address type to AddressType.Structured unless it’s already AddressType.CombinedElements, in which case it becomes AddressType.Conflicting. This field is only used for structured addresses. For this type, it’s mandatory.
| Parameter | Type | Description |
|---|---|---|
$value | ?string |
Street
Access: Read/Write
Returns: string The street.
Gets the street. The street must be speicfied without house number. Setting this field sets the address type to AddressType.Structured unless it’s already AddressType.CombinedElements, in which case it becomes AddressType.Conflicting. This field is only used for structured addresses and is optional.
Sets the street. The street must be speicfied without house number. Setting this field sets the address type to AddressType.Structured unless it’s already AddressType.CombinedElements, in which case it becomes AddressType.Conflicting. This field is only used for structured addresses and is optional.
| Parameter | Type | Description |
|---|---|---|
$value | ?string |
Town
Access: Read/Write
Returns: string The town or city.
Gets the town or city. Setting this field sets the address type to AddressType.Structured unless it’s already AddressType.CombinedElements, in which case it becomes AddressType.Conflicting. This field is only used for structured addresses. For this type, it’s mandatory.
Sets the town or city. Setting this field sets the address type to AddressType.Structured unless it’s already AddressType.CombinedElements, in which case it becomes AddressType.Conflicting. This field is only used for structured addresses. For this type, it’s mandatory.
| Parameter | Type | Description |
|---|---|---|
$value | ?string |
Type
Access: Read-only
Returns: int The address type.
Gets the address type. The address type is automatically set by either setting street / house number or address line 1 and 2. Before setting the fields, the address type is Undetermined. If fields of both types are set, the address type becomes Conflicting.