RichDocumentDeliveryPhysicalLocation
extends Element
in package
Uses
ElementTrait
This is the rich document delivery physical location 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 | |
| : string | ||
| $error | : Error|null | |
| $location | : RichLocation|null | |
| $name | : string | |
| $phone | : string | |
| $physicalLocationPId | : 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 rich document delivery physical location address. | : string |
| getCity() | Returns the rich document delivery physical location city. | : string |
| getEmail() | Returns the rich document delivery physical location email. | : string |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getLocation() | Returns the rich document delivery physical location location. | : RichLocation|null |
| getName() | Returns the rich document delivery physical location name. | : string |
| getPhone() | Returns the rich document delivery physical location Phone. | : string |
| getPhysicalLocationPId() | Returns the rich document delivery physical location physicalLocationPId. | : string |
| getPostalCode() | Returns the rich document delivery physical location postalCode. | : string |
| getState() | Returns the rich 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> |
| setError() | : void | |
| setLocation() | : void |
Properties
$address
protected
string
$address
= ''
$city
protected
string
$city
= ''
protected
string
$email
= ''
$error
protected
Error|null
$error
= null
$location
protected
RichLocation|null
$location
= null
$name
protected
string
$name
= ''
$phone
protected
string
$phone
= ''
$physicalLocationPId
protected
string
$physicalLocationPId
= ''
$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 rich document delivery physical location address.
public
getAddress() : string
Return values
string —getCity()
Returns the rich document delivery physical location city.
public
getCity() : string
Return values
string —getEmail()
Returns the rich document delivery physical location 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 —getLocation()
Returns the rich document delivery physical location location.
public
getLocation() : RichLocation|null
Return values
RichLocation|null —getName()
Returns the rich document delivery physical location name.
public
getName() : string
Return values
string —getPhone()
Returns the rich document delivery physical location Phone.
public
getPhone() : string
Return values
string —getPhysicalLocationPId()
Returns the rich document delivery physical location physicalLocationPId.
public
getPhysicalLocationPId() : string
Return values
string —getPostalCode()
Returns the rich document delivery physical location postalCode.
public
getPostalCode() : string
Return values
string —getState()
Returns the rich 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> —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>