RewardPoints
in package
This is the RewardPoints class, a macro class for the documentViewHelper.
The purpose of this class is to encapsulate the logic that calculates the view parameters for the document reward points.
Tags
Table of Contents
| $class | : string | |
|---|---|---|
| $document | : AbstractDocumentBase|null | |
| $showHeader | : bool | |
| $showTotalEarned | : bool | |
| $showTotalRedeemed | : bool | |
| __construct() | Constructor method for RewardPoints. | : mixed |
| getViewParameters() | This method returns all calculated arguments and new parameters for UserViewHelper.php | : array<string|int, mixed> |
| getProperties() | Return macro use properties | : array<string|int, mixed> |
Properties
$class
public
string
$class
= ''
$document
public
AbstractDocumentBase|null
$document
= null
$showHeader
public
bool
$showHeader
= true
$showTotalEarned
public
bool
$showTotalEarned
= true
$showTotalRedeemed
public
bool
$showTotalRedeemed
= true
Methods
__construct()
Constructor method for RewardPoints.
public
__construct(array<string|int, mixed> $arguments) : mixed
Parameters
- $arguments : array<string|int, mixed>
Tags
Return values
mixed —getViewParameters()
This method returns all calculated arguments and new parameters for UserViewHelper.php
public
getViewParameters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getProperties()
Return macro use properties
protected
getProperties() : array<string|int, mixed>