DocumentHeadquarter
extends Element
in package
Uses
ElementTrait, IdentifiableElementTrait, ElementNameTrait
This is the document headquarter class.
The document headquarter will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $error | : Error|null | |
|---|---|---|
| $id | Autonumeric element id. | : int |
| $name | : string | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getAddress() | Returns the headquarter address. | : string |
| getCity() | Returns the headquarter city. | : string |
| getCountryCode() | Returns the headquarter countryCode. | : string |
| getEmail() | Returns the headquarter email. | : string |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getHeadquarterId() | Returns the headquarter internal identifier. | : int |
| getId() | Returns the element id. | : int |
| getLogo() | Returns the invoicing company logo | : string |
| getName() | Returns the element name on the website current language. | : string |
| getPhone() | Returns the headquarter phone. | : string |
| getPostalCode() | Returns the headquarter postalCode. | : string |
| getState() | Returns the headquarter state. | : string |
| getVat() | Returns the 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
$error
protected
Error|null
$error
= null
$id
Autonumeric element id.
protected
int
$id
= 0
All the given elements by the LogiCommerce API will send it.
$name
protected
string
$name
= ''
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 headquarter address.
public
getAddress() : string
Return values
string —getCity()
Returns the headquarter city.
public
getCity() : string
Return values
string —getCountryCode()
Returns the headquarter countryCode.
public
getCountryCode() : string
Return values
string —getEmail()
Returns the 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 —getHeadquarterId()
Returns the headquarter internal identifier.
public
getHeadquarterId() : int
Return values
int —getId()
Returns the element id.
public
getId() : int
Return values
int —getLogo()
Returns the invoicing company logo
public
getLogo() : string
Return values
string —getName()
Returns the element name on the website current language.
public
getName() : string
Return values
string —getPhone()
Returns the headquarter phone.
public
getPhone() : string
Return values
string —getPostalCode()
Returns the headquarter postalCode.
public
getPostalCode() : string
Return values
string —getState()
Returns the headquarter state.
public
getState() : string
Return values
string —getVat()
Returns the 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