UserDocument
extends Element
in package
Uses
IdentifiableElementTrait, IntegrableElementTrait
This is the user base document main class.
The user base document information will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $date | : Date|null | |
|---|---|---|
| $documentNumber | : string | |
| $error | : Error|null | |
| $id | Autonumeric element id. | : int |
| $pId | Public and readable element id. | : string |
| getDate() | Returns the order date. | : Date|null |
| getDocumentNumber() | Returns the order document number. | : string |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getId() | Returns the element id. | : int |
| getPId() | Returns the element public id (pId). | : string |
| setDate() | : void | |
| setError() | : void |
Properties
$date
protected
Date|null
$date
= null
$documentNumber
protected
string
$documentNumber
= ''
$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
getDate()
Returns the order date.
public
getDate() : Date|null
Return values
Date|null —getDocumentNumber()
Returns the order 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 —getPId()
Returns the element public id (pId).
public
getPId() : string
Return values
string —setDate()
protected
setDate(string $date) : void
Parameters
- $date : string
Return values
void —setError()
protected
setError(mixed $error) : void
Parameters
- $error : mixed