RichDocumentUserAddress
extends Element
in package
Uses
ElementTrait, EnumResolverTrait
This is the rich document user address class.
The document will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $address | : string | |
|---|---|---|
| $addressAdditionalInformation | : string | |
| $alias | : string | |
| $city | : string | |
| $company | : string | |
| $country | : string | |
| $error | : Error|null | |
| $fax | : string | |
| $firstName | : string | |
| $lastName | : string | |
| $location | : RichLocation|null | |
| $mobile | : string | |
| $nif | : string | |
| $number | : string | |
| $phone | : string | |
| $postalCode | : string | |
| $re | : bool | |
| $reverseChargeVat | : bool | |
| $state | : string | |
| $tax | : bool | |
| $vat | : string | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getAddress() | Returns the rich document user address address. | : string |
| getAddressAdditionalInformation() | Returns the rich document user address addressAdditionalInformation. | : string |
| getAlias() | Returns the rich document user address alias. | : string |
| getCity() | Returns the rich document user address city. | : string |
| getCompany() | Returns the rich document user address company. | : string |
| getCountry() | Returns the rich document user address country. | : string |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getFax() | Returns the rich document user address fax. | : string |
| getFirstName() | Returns the rich document user address firstName. | : string |
| getLastName() | Returns the rich document user address lastName. | : string |
| getLocation() | Returns the rich document user address address location. | : RichLocation|null |
| getMobile() | Returns the rich document user address mobile. | : string |
| getNif() | Returns the rich document user address nif. | : string |
| getNumber() | Returns the rich document user address number. | : string |
| getPhone() | Returns the rich document user address phone. | : string |
| getPostalCode() | Returns the rich document user address postalCode. | : string |
| getRe() | Returns the rich document user address re. | : bool |
| getReverseChargeVat() | Returns the rich document user address reverseChargeVat. | : bool |
| getState() | Returns the rich document user address state. | : string |
| getTax() | Returns the rich document user address tax. | : bool |
| getVat() | Returns the rich document user address vat. | : string |
| jsonSerialize() | Allow elements to be serialized. | : array<string|int, mixed> |
| toArray() | Used to allow elements to be serialized. | : array<string|int, mixed> |
| getFieldItem() | : object|null | |
| getFormattedData() | : mixed | |
| setArrayField() | Convert an API array of objects to a PHP array of objects. | : array<string|int, mixed> |
| setError() | : void | |
| setLocation() | : void |
Properties
$address
protected
string
$address
= ''
$addressAdditionalInformation
protected
string
$addressAdditionalInformation
= ''
$alias
protected
string
$alias
= ''
$city
protected
string
$city
= ''
$company
protected
string
$company
= ''
$country
protected
string
$country
= ''
$error
protected
Error|null
$error
= null
$fax
protected
string
$fax
= ''
$firstName
protected
string
$firstName
= ''
$lastName
protected
string
$lastName
= ''
$location
protected
RichLocation|null
$location
= null
$mobile
protected
string
$mobile
= ''
$nif
protected
string
$nif
= ''
$number
protected
string
$number
= ''
$phone
protected
string
$phone
= ''
$postalCode
protected
string
$postalCode
= ''
$re
protected
bool
$re
= false
$reverseChargeVat
protected
bool
$reverseChargeVat
= false
$state
protected
string
$state
= ''
$tax
protected
bool
$tax
= false
$vat
protected
string
$vat
= ''
Methods
__construct()
Elements constructor.
public
__construct([array<string|int, mixed> $data = [] ]) : mixed
Parameters
- $data : array<string|int, mixed> = []
-
Array that contains all the values to the object to initialize
Return values
mixed —__toString()
Uses "json_encode" function to return the JSON format of the element.
public
__toString() : string
Auto-invoked using echo or concatenations.
Return values
string —getAddress()
Returns the rich document user address address.
public
getAddress() : string
Return values
string —getAddressAdditionalInformation()
Returns the rich document user address addressAdditionalInformation.
public
getAddressAdditionalInformation() : string
Return values
string —getAlias()
Returns the rich document user address alias.
public
getAlias() : string
Return values
string —getCity()
Returns the rich document user address city.
public
getCity() : string
Return values
string —getCompany()
Returns the rich document user address company.
public
getCompany() : string
Return values
string —getCountry()
Returns the rich document user address country.
public
getCountry() : string
Return values
string —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getFax()
Returns the rich document user address fax.
public
getFax() : string
Return values
string —getFirstName()
Returns the rich document user address firstName.
public
getFirstName() : string
Return values
string —getLastName()
Returns the rich document user address lastName.
public
getLastName() : string
Return values
string —getLocation()
Returns the rich document user address address location.
public
getLocation() : RichLocation|null
Return values
RichLocation|null —getMobile()
Returns the rich document user address mobile.
public
getMobile() : string
Return values
string —getNif()
Returns the rich document user address nif.
public
getNif() : string
Return values
string —getNumber()
Returns the rich document user address number.
public
getNumber() : string
Return values
string —getPhone()
Returns the rich document user address phone.
public
getPhone() : string
Return values
string —getPostalCode()
Returns the rich document user address postalCode.
public
getPostalCode() : string
Return values
string —getRe()
Returns the rich document user address re.
public
getRe() : bool
Return values
bool —getReverseChargeVat()
Returns the rich document user address reverseChargeVat.
public
getReverseChargeVat() : bool
Return values
bool —getState()
Returns the rich document user address state.
public
getState() : string
Return values
string —getTax()
Returns the rich document user address tax.
public
getTax() : bool
Return values
bool —getVat()
Returns the rich document user address vat.
public
getVat() : string
Return values
string —jsonSerialize()
Allow elements to be serialized.
public
jsonSerialize() : array<string|int, mixed>
Auto-invoked using "json_encode" function.
Return values
array<string|int, mixed> —toArray()
Used to allow elements to be serialized.
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —getFieldItem()
protected
getFieldItem(array<string|int, mixed> $item, string $class) : object|null
Parameters
- $item : array<string|int, mixed>
- $class : string
Return values
object|null —getFormattedData()
protected
getFormattedData(mixed $value) : mixed
Parameters
- $value : mixed
Return values
mixed —setArrayField()
Convert an API array of objects to a PHP array of objects.
protected
setArrayField(array<string|int, mixed> $data, string $class) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
Array that contains all the values to the objects to initialize
- $class : string
-
The PHP class we want the objects to be
Return values
array<string|int, mixed> —setError()
protected
setError(mixed $error) : void
Parameters
- $error : mixed
Return values
void —setLocation()
protected
setLocation(array<string|int, mixed> $location) : void
Parameters
- $location : array<string|int, mixed>