RichDocumentPaymentSystem
extends Element
in package
Uses
ElementTrait, EnumResolverTrait
This is the rich document payment system class.
The document will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $error | : Error|null | |
|---|---|---|
| $increaseMin | : float | |
| $increaseType | : string | |
| $increaseValue | : float | |
| $message | : string | |
| $name | : string | |
| $paymentSystemPId | : string | |
| $paymentType | : string | |
| $price | : string | |
| $priceWithTaxes | : string | |
| $taxes | : array<string|int, mixed> | |
| __construct() | Elements constructor. | : mixed |
| __toString() | Uses "json_encode" function to return the JSON format of the element. | : string |
| getError() | Returns the current element error (if there is error). | : Error|null |
| getIncreaseMin() | Returns the rich document payment system increaseMin. | : float |
| getIncreaseType() | Returns the rich document payment system increaseType. | : string |
| getIncreaseValue() | Returns the rich document payment system increaseValue. | : float |
| getMessage() | Returns the rich document payment system message. | : string |
| getName() | Returns the rich document payment system name. | : string |
| getPaymentSystemPId() | Returns the document payment system PId. | : string |
| getPaymentType() | Returns the rich document payment system paymentType. | : string |
| getPrice() | Returns the rich document payment system price. | : string |
| getPriceWithTaxes() | Returns the rich document payment system priceWithTaxes. | : string |
| getTaxes() | Returns the rich document payment system taxes. | : array<string|int, RichDocumentElementTax> |
| 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> |
| setError() | : void | |
| setTaxes() | : void |
Properties
$error
protected
Error|null
$error
= null
$increaseMin
protected
float
$increaseMin
= 0.0
$increaseType
protected
string
$increaseType
= ''
$increaseValue
protected
float
$increaseValue
= 0.0
$message
protected
string
$message
= ''
$name
protected
string
$name
= ''
$paymentSystemPId
protected
string
$paymentSystemPId
= ''
$paymentType
protected
string
$paymentType
= ''
$price
protected
string
$price
= ''
$priceWithTaxes
protected
string
$priceWithTaxes
= ''
$taxes
protected
array<string|int, mixed>
$taxes
= []
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 —getError()
Returns the current element error (if there is error).
public
getError() : Error|null
Return values
Error|null —getIncreaseMin()
Returns the rich document payment system increaseMin.
public
getIncreaseMin() : float
Return values
float —getIncreaseType()
Returns the rich document payment system increaseType.
public
getIncreaseType() : string
Return values
string —getIncreaseValue()
Returns the rich document payment system increaseValue.
public
getIncreaseValue() : float
Return values
float —getMessage()
Returns the rich document payment system message.
public
getMessage() : string
Return values
string —getName()
Returns the rich document payment system name.
public
getName() : string
Return values
string —getPaymentSystemPId()
Returns the document payment system PId.
public
getPaymentSystemPId() : string
Return values
string —getPaymentType()
Returns the rich document payment system paymentType.
public
getPaymentType() : string
Return values
string —getPrice()
Returns the rich document payment system price.
public
getPrice() : string
Return values
string —getPriceWithTaxes()
Returns the rich document payment system priceWithTaxes.
public
getPriceWithTaxes() : string
Return values
string —getTaxes()
Returns the rich document payment system taxes.
public
getTaxes() : array<string|int, RichDocumentElementTax>
Return values
array<string|int, RichDocumentElementTax> —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> —setError()
protected
setError(mixed $error) : void
Parameters
- $error : mixed
Return values
void —setTaxes()
protected
setTaxes(array<string|int, mixed> $taxes) : void
Parameters
- $taxes : array<string|int, mixed>