DocumentRewardPoints
in package
Uses
ElementTrait, IntegrableElementTrait, EnumResolverTrait
This is the document reward points class.
The document reward points of API items will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $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 |
| getEarned() | Returns earned | : null|earned |
| getExpirationDate() | Returns the expiration Date value. | : Date|null |
| getExpirationDays() | Returns the expiration Days | : int |
| getExpirationType() | Returns the expiration type | : string |
| getLanguage() | Returns name and description. | : null|NameDescription |
| getPId() | Returns the element public id (pId). | : string |
| getRedeemed() | Returns redeemed | : null|Redeemed |
| getRewardPointsId() | Returns the reward points id | : int |
| getSummary() | Returns summary | : null|RewardPointsSummary |
| 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> |
Properties
$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 —getEarned()
Returns earned
public
getEarned() : null|earned
Return values
null|earned —getExpirationDate()
Returns the expiration Date value.
public
getExpirationDate() : Date|null
Return values
Date|null —getExpirationDays()
Returns the expiration Days
public
getExpirationDays() : int
Return values
int —getExpirationType()
Returns the expiration type
public
getExpirationType() : string
Return values
string —getLanguage()
Returns name and description.
public
getLanguage() : null|NameDescription
Return values
null|NameDescription —getPId()
Returns the element public id (pId).
public
getPId() : string
Return values
string —getRedeemed()
Returns redeemed
public
getRedeemed() : null|Redeemed
Return values
null|Redeemed —getRewardPointsId()
Returns the reward points id
public
getRewardPointsId() : int
Return values
int —getSummary()
Returns summary
public
getSummary() : null|RewardPointsSummary
Return values
null|RewardPointsSummary —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