RichDocumentHeadquarter
extends Element
in package
Uses
ElementTrait
This is the rich document headquarter class.
The document will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $address | : string | |
|---|---|---|
| $city | : string | |
| $countryCode | : string | |
| $countryName | : string | |
| : string | ||
| $error | : Error|null | |
| $name | : string | |
| $phone | : string | |
| $postalCode | : string | |
| $state | : string | |
| $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 headquarter address. | : string |
| getCity() | Returns the rich document headquarter city. | : string |
| getCountryCode() | Returns the rich document headquarter countryCode. | : string |
| getCountryName() | Returns the rich document headquarter countryName. | : string |
| getEmail() | Returns the rich document headquarter email. | : string |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getLogo() | Returns the invoicing company logo | : string |
| getName() | Returns the rich document headquarter name. | : string |
| getPhone() | Returns the rich document headquarter phone. | : string |
| getPostalCode() | Returns the rich document headquarter postalCode. | : string |
| getState() | Returns the rich document headquarter state. | : string |
| getTimeZone() | Returns the invoicing company timeZone | : string |
| getVat() | Returns the rich document headquarter 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 |
Properties
$address
protected
string
$address
= ''
$city
protected
string
$city
= ''
$countryCode
protected
string
$countryCode
= ''
$countryName
protected
string
$countryName
= ''
protected
string
$email
= ''
$error
protected
Error|null
$error
= null
$name
protected
string
$name
= ''
$phone
protected
string
$phone
= ''
$postalCode
protected
string
$postalCode
= ''
$state
protected
string
$state
= ''
$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 headquarter address.
public
getAddress() : string
Return values
string —getCity()
Returns the rich document headquarter city.
public
getCity() : string
Return values
string —getCountryCode()
Returns the rich document headquarter countryCode.
public
getCountryCode() : string
Return values
string —getCountryName()
Returns the rich document headquarter countryName.
public
getCountryName() : string
Return values
string —getEmail()
Returns the rich document headquarter email.
public
getEmail() : string
Return values
string —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getLogo()
Returns the invoicing company logo
public
getLogo() : string
Return values
string —getName()
Returns the rich document headquarter name.
public
getName() : string
Return values
string —getPhone()
Returns the rich document headquarter phone.
public
getPhone() : string
Return values
string —getPostalCode()
Returns the rich document headquarter postalCode.
public
getPostalCode() : string
Return values
string —getState()
Returns the rich document headquarter state.
public
getState() : string
Return values
string —getTimeZone()
Returns the invoicing company timeZone
public
getTimeZone() : string
Return values
string —getVat()
Returns the rich document headquarter 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