DocumentNote
extends Element
in package
Uses
ElementTrait, IdentifiableElementTrait, IntegrableElementTrait
This is the document note class.
The document notes 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 |
| $items | : array<string|int, mixed> | |
| $language | : DocumentNoteLanguage|null | |
| $pId | Public and readable element id. | : string |
| $user | : DocumentNoteUser|null | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getDate() | Returns the date when the document was created. | : 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 |
| getItems() | Returns the document items. | : array<string|int, DocumentNoteRow> |
| getLanguage() | Returns the document language object. | : DocumentNoteLanguage|null |
| getPId() | Returns the element public id (pId). | : string |
| getUser() | Returns the document user object. | : DocumentNoteUser|null |
| 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> |
| setDate() | : void | |
| setDocumentNumber() | : void | |
| setError() | : void | |
| setItems() | : void | |
| setLanguage() | : void | |
| setUser() | : 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.
$items
protected
array<string|int, mixed>
$items
= []
$language
protected
DocumentNoteLanguage|null
$language
= null
$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.
$user
protected
DocumentNoteUser|null
$user
= null
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 —getDate()
Returns the date when the document was created.
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 —getItems()
Returns the document items.
public
getItems() : array<string|int, DocumentNoteRow>
Return values
array<string|int, DocumentNoteRow> —getLanguage()
Returns the document language object.
public
getLanguage() : DocumentNoteLanguage|null
Return values
DocumentNoteLanguage|null —getPId()
Returns the element public id (pId).
public
getPId() : string
Return values
string —getUser()
Returns the document user object.
public
getUser() : DocumentNoteUser|null
Return values
DocumentNoteUser|null —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> —setDate()
protected
setDate(string $date) : void
Parameters
- $date : string
Return values
void —setDocumentNumber()
protected
setDocumentNumber(string $documentNumber) : void
Parameters
- $documentNumber : string
Return values
void —setError()
protected
setError(mixed $error) : void
Parameters
- $error : mixed
Return values
void —setItems()
protected
setItems(array<string|int, mixed> $items) : void
Parameters
- $items : array<string|int, mixed>
Return values
void —setLanguage()
protected
setLanguage(array<string|int, mixed> $language) : void
Parameters
- $language : array<string|int, mixed>
Return values
void —setUser()
protected
setUser(array<string|int, mixed> $user) : void
Parameters
- $user : array<string|int, mixed>