RewardPointsRule
in package
Uses ElementTrait, IdentifiableElementTrait, EnumResolverTrait

This is the reward points rule class.

The API reward points rule will be stored in that class and will remain immutable (only get methods are available)

Tags
see
RewardPointsRule::getLanguage()
see
RewardPointsRule::getFrom()
see
RewardPointsRule::getTo()
see
RewardPointsRule::getValue()
see
RewardPointsRule::getType()
see
RewardPointsRule::getValueMode()
see
RewardPointsRule::getEarned()
see
ElementTrait

Table of Contents

$id Autonumeric element id.  : int
__construct() Elements constructor.  : mixed
__toString() Uses "json_encode" function to return the JSON format of the element.  : string
getEarned() Returns the earned reward points.  : float
getFrom() Returns the from value  : float
getId() Returns the element id.  : int
getLanguage() Returns name and description.  : null|NameDescription
getTo() Returns the to value  : float
getType() Returns the type  : string
getValue() Returns the value  : float
getValueMode() Returns the ValueMode  : 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>

Properties

$id

Autonumeric element id.

protected int $id = 0

All the given elements by the LogiCommerce API will send it.

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 earned reward points.

public getEarned() : float
Return values
float —

getFrom()

Returns the from value

public getFrom() : float
Return values
float —

getTo()

Returns the to value

public getTo() : float
Return values
float —

getType()

Returns the type

public getType() : string
Return values
string —

getValue()

Returns the value

public getValue() : float
Return values
float —

getValueMode()

Returns the ValueMode

public getValueMode() : 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> —

Search results