DocumentPhysicalLocation
extends Element
in package
Uses
ElementTrait, ElementNameTrait
This is the DocumentPhysicalLocation class.
The Document Deliveries will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $address | : string | |
|---|---|---|
| $city | : string | |
| $coordinate | : Coordinate|null | |
| $error | : Error|null | |
| $geographicalZone | : GeographicalZone|null | |
| $name | : string | |
| $postalCode | : string | |
| $state | : string | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getAddress() | Returns the document delivery physical location address. | : string |
| getCity() | Returns the document delivery physical location city. | : string |
| getCoordinate() | Returns the document delivery physical location coordinate. | : Coordinate |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getGeographicalZone() | Returns the document delivery physical location geographical zone. | : GeographicalZone |
| getName() | Returns the element name on the website current language. | : string |
| getPostalCode() | Returns the document delivery physical location postalCode. | : string |
| getState() | Returns the document delivery physical location state. | : 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> |
| setCoordinate() | : void | |
| setError() | : void | |
| setGeographicalZone() | : void |
Properties
$address
protected
string
$address
= ''
$city
protected
string
$city
= ''
$coordinate
protected
Coordinate|null
$coordinate
= null
$error
protected
Error|null
$error
= null
$geographicalZone
protected
GeographicalZone|null
$geographicalZone
= null
$name
protected
string
$name
= ''
$postalCode
protected
string
$postalCode
= ''
$state
protected
string
$state
= ''
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 document delivery physical location address.
public
getAddress() : string
Return values
string —getCity()
Returns the document delivery physical location city.
public
getCity() : string
Return values
string —getCoordinate()
Returns the document delivery physical location coordinate.
public
getCoordinate() : Coordinate
Return values
Coordinate —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getGeographicalZone()
Returns the document delivery physical location geographical zone.
public
getGeographicalZone() : GeographicalZone
Return values
GeographicalZone —getName()
Returns the element name on the website current language.
public
getName() : string
Return values
string —getPostalCode()
Returns the document delivery physical location postalCode.
public
getPostalCode() : string
Return values
string —getState()
Returns the document delivery physical location state.
public
getState() : 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> —setCoordinate()
protected
setCoordinate(array<string|int, mixed> $coordinate) : void
Parameters
- $coordinate : array<string|int, mixed>
Return values
void —setError()
protected
setError(mixed $error) : void
Parameters
- $error : mixed
Return values
void —setGeographicalZone()
protected
setGeographicalZone(array<string|int, mixed> $geographicalZone) : void
Parameters
- $geographicalZone : array<string|int, mixed>