PhysicalLocation
extends Element
in package
Uses
ElementTrait, IdentifiableElementTrait, IntegrableElementTrait, ElementNameTrait
This is the physical location class.
The information of API physical locations 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 | |
| $pId | Public and readable element id. | : string |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getActive() | Returns the physichal location active. | : bool |
| getAddress() | Returns the physichal location address. | : string |
| getCity() | Returns the physichal location city. | : string |
| getDeliveryPoint() | Returns if the physichal location is a delivery point. | : bool |
| getEmail() | Returns the physichal location email. | : string |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getId() | Returns the element id. | : int |
| getLanguage() | Returns the language of the physichal location. | : PhysicalLocationLanguage|null |
| getLocation() | Returns the location of the physichal location. | : Location|null |
| getName() | Returns the element name on the website current language. | : string |
| getPhone() | Returns the physichal location phone. | : string |
| getPId() | Returns the element public id (pId). | : string |
| getPostalCode() | Returns the physichal location postal code. | : string |
| getReturnPoint() | Returns if the physichal location is a refund point. | : bool |
| getState() | Returns the physichal location state. | : string |
| getVisibleOnMap() | Returns if the physichal location is visible on map. | : bool |
| getZoneRadius() | Returns the physichal location zone radius. | : float |
| 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
= ''
$pId
Public and readable element id.
protected
string
$pId
= ''
Setted by the user on LogiCommerce. All the integrable elements by the LogiCommerce API will send it. Useful for integrations and other 3rd party softwares that need to connect to LogiCommerce software.
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 —getActive()
Returns the physichal location active.
public
getActive() : bool
Return values
bool —getAddress()
Returns the physichal location address.
public
getAddress() : string
Return values
string —getCity()
Returns the physichal location city.
public
getCity() : string
Return values
string —getDeliveryPoint()
Returns if the physichal location is a delivery point.
public
getDeliveryPoint() : bool
Return values
bool —getEmail()
Returns the physichal 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 —getId()
Returns the element id.
public
getId() : int
Return values
int —getLanguage()
Returns the language of the physichal location.
public
getLanguage() : PhysicalLocationLanguage|null
Return values
PhysicalLocationLanguage|null —getLocation()
Returns the location of the physichal location.
public
getLocation() : Location|null
Return values
Location|null —getName()
Returns the element name on the website current language.
public
getName() : string
Return values
string —getPhone()
Returns the physichal location phone.
public
getPhone() : string
Return values
string —getPId()
Returns the element public id (pId).
public
getPId() : string
Return values
string —getPostalCode()
Returns the physichal location postal code.
public
getPostalCode() : string
Return values
string —getReturnPoint()
Returns if the physichal location is a refund point.
public
getReturnPoint() : bool
Return values
bool —getState()
Returns the physichal location state.
public
getState() : string
Return values
string —getVisibleOnMap()
Returns if the physichal location is visible on map.
public
getVisibleOnMap() : bool
Return values
bool —getZoneRadius()
Returns the physichal location zone radius.
public
getZoneRadius() : float
Return values
float —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