SalesAgentSales
extends Element
in package
Uses
ElementTrait, EnumResolverTrait, IdentifiableElementTrait, IntegrableElementTrait
This is the sales agent sales class.
The asales agent sales 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 |
| $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 |
| getAllowReturn() | Returns the order allow return. | : bool |
| getCustomer() | Returns information about sales agent | : SalesAgentSalesCustomer|null |
| getDate() | Returns the document date. | : Date|null |
| getDocumentNumber() | Returns the document number | : string |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getId() | Returns the element id. | : int |
| getInvoices() | Returns invoice information | : array<string|int, UserInvoice> |
| getPId() | Returns the element public id (pId). | : string |
| getRmas() | Returns information about rmas | : array<string|int, UserRMA> |
| getSalesAgentDetails() | Returns information about sales agent | : SalesAgentDetails|null |
| getShipments() | Returns information about shipment records | : array<string|int, UserDocumentShipment> |
| getStatus() | Returns the document status | : string |
| getSubstatus() | Returns the document substatus | : 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> |
| setCustomer() | : void | |
| setError() | : void | |
| setSalesAgentDetails() | : 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.
$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 —getAllowReturn()
Returns the order allow return.
public
getAllowReturn() : bool
Return values
bool —getCustomer()
Returns information about sales agent
public
getCustomer() : SalesAgentSalesCustomer|null
Return values
SalesAgentSalesCustomer|null —getDate()
Returns the document date.
public
getDate() : Date|null
Return values
Date|null —getDocumentNumber()
Returns the document number
public
getDocumentNumber() : 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 —getInvoices()
Returns invoice information
public
getInvoices() : array<string|int, UserInvoice>
Return values
array<string|int, UserInvoice> —getPId()
Returns the element public id (pId).
public
getPId() : string
Return values
string —getRmas()
Returns information about rmas
public
getRmas() : array<string|int, UserRMA>
Return values
array<string|int, UserRMA> —getSalesAgentDetails()
Returns information about sales agent
public
getSalesAgentDetails() : SalesAgentDetails|null
Return values
SalesAgentDetails|null —getShipments()
Returns information about shipment records
public
getShipments() : array<string|int, UserDocumentShipment>
Return values
array<string|int, UserDocumentShipment> —getStatus()
Returns the document status
public
getStatus() : string
Return values
string —getSubstatus()
Returns the document substatus
public
getSubstatus() : 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> —setCustomer()
protected
setCustomer(array<string|int, mixed> $salesAgentCustomer) : void
Parameters
- $salesAgentCustomer : array<string|int, mixed>
Return values
void —setError()
protected
setError(mixed $error) : void
Parameters
- $error : mixed
Return values
void —setSalesAgentDetails()
protected
setSalesAgentDetails(array<string|int, mixed> $salesAgentDetails) : void
Parameters
- $salesAgentDetails : array<string|int, mixed>