RichDocumentRewardPoints
extends Element
in package
Uses
ElementTrait, IdentifiableElementTrait
This is the rich document reward point class.
The document will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $earned | : RichDocumentRewardPointsEarned|null | |
|---|---|---|
| $error | : Error|null | |
| $expirationDate | : string | |
| $expirationDays | : string | |
| $expirationType | : string | |
| $id | Autonumeric element id. | : int |
| $pId | : string | |
| $redeemed | : RichDocumentRewardPointsRedeemed|null | |
| $summary | : RichDocumentRewardPointsSummary|null | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getEarned() | Returns the rich document reward point earned. | : RichDocumentRewardPointsEarned|null |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getExpirationDate() | Returns the rich document reward point expirationDate. | : string |
| getExpirationDays() | Returns the rich document reward point expirationDays. | : string |
| getExpirationType() | Returns the rich document reward point expirationType. | : string |
| getId() | Returns the element id. | : int |
| getPId() | Returns the rich document reward point pId. | : string |
| getRedeemed() | Returns the rich document reward point redeemed. | : RichDocumentRewardPointsRedeemed|null |
| getSummary() | Returns the rich document reward point summary. | : RichDocumentRewardPointsSummary|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> |
| setEarned() | : void | |
| setError() | : void | |
| setRedeemed() | : void | |
| setSummary() | : void |
Properties
$earned
protected
RichDocumentRewardPointsEarned|null
$earned
= null
$error
protected
Error|null
$error
= null
$expirationDate
protected
string
$expirationDate
= ''
$expirationDays
protected
string
$expirationDays
= ''
$expirationType
protected
string
$expirationType
= ''
$id
Autonumeric element id.
protected
int
$id
= 0
All the given elements by the LogiCommerce API will send it.
$pId
protected
string
$pId
= ''
$redeemed
protected
RichDocumentRewardPointsRedeemed|null
$redeemed
= null
$summary
protected
RichDocumentRewardPointsSummary|null
$summary
= 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 —getEarned()
Returns the rich document reward point earned.
public
getEarned() : RichDocumentRewardPointsEarned|null
Return values
RichDocumentRewardPointsEarned|null —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getExpirationDate()
Returns the rich document reward point expirationDate.
public
getExpirationDate() : string
Return values
string —getExpirationDays()
Returns the rich document reward point expirationDays.
public
getExpirationDays() : string
Return values
string —getExpirationType()
Returns the rich document reward point expirationType.
public
getExpirationType() : string
Return values
string —getId()
Returns the element id.
public
getId() : int
Return values
int —getPId()
Returns the rich document reward point pId.
public
getPId() : string
Return values
string —getRedeemed()
Returns the rich document reward point redeemed.
public
getRedeemed() : RichDocumentRewardPointsRedeemed|null
Return values
RichDocumentRewardPointsRedeemed|null —getSummary()
Returns the rich document reward point summary.
public
getSummary() : RichDocumentRewardPointsSummary|null
Return values
RichDocumentRewardPointsSummary|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> —setEarned()
protected
setEarned(array<string|int, mixed> $earned) : void
Parameters
- $earned : array<string|int, mixed>
Return values
void —setError()
protected
setError(mixed $error) : void
Parameters
- $error : mixed
Return values
void —setRedeemed()
protected
setRedeemed(array<string|int, mixed> $redeemed) : void
Parameters
- $redeemed : array<string|int, mixed>
Return values
void —setSummary()
protected
setSummary(array<string|int, mixed> $summary) : void
Parameters
- $summary : array<string|int, mixed>