DocumentPaymentSystem
extends Element
in package
Uses
ElementTrait, IdentifiableElementTrait, ElementNameTrait, EnumResolverTrait
This is the document payment system class.
The document payment system will be stored in that class and will remain immutable (only get methods are available)
Tags
Table of Contents
| $error | : Error|null | |
|---|---|---|
| $id | Autonumeric element id. | : int |
| $module | : string | |
| $name | : string | |
| $paymentSystemPId | : string | |
| $paymentType | : string | |
| __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 |
| getId() | Returns the element id. | : int |
| getIncreaseMin() | Returns the document payment system increase min. | : float |
| getIncreaseType() | Returns the document payment system increase type. | : string |
| getIncreaseValue() | Returns the document payment system increase value. | : float |
| getMessage() | Returns the document payment system message. | : string |
| getModule() | Returns the document payment system plugin module. | : string |
| getName() | Returns the element name on the website current language. | : string |
| getPaymentSystemId() | Returns the document payment system internal identifier. | : int |
| getPaymentSystemPId() | Returns the document payment system PId. | : string |
| getPaymentType() | Returns the pay response paymentType. | : string |
| getPrice() | Returns the document payment system price. | : float |
| getTaxes() | Returns the document payment system taxes. | : array<string|int, DocumentPaymentSystemTax> |
| 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 |
Properties
$error
protected
Error|null
$error
= null
$id
Autonumeric element id.
protected
int
$id
= 0
All the given elements by the LogiCommerce API will send it.
$module
protected
string
$module
= ''
$name
protected
string
$name
= ''
$paymentSystemPId
protected
string
$paymentSystemPId
= ''
$paymentType
protected
string
$paymentType
= ''
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 —getId()
Returns the element id.
public
getId() : int
Return values
int —getIncreaseMin()
Returns the document payment system increase min.
public
getIncreaseMin() : float
Return values
float —getIncreaseType()
Returns the document payment system increase type.
public
getIncreaseType() : string
Return values
string —getIncreaseValue()
Returns the document payment system increase value.
public
getIncreaseValue() : float
Return values
float —getMessage()
Returns the document payment system message.
public
getMessage() : string
Return values
string —getModule()
Returns the document payment system plugin module.
public
getModule() : string
Return values
string —getName()
Returns the element name on the website current language.
public
getName() : string
Return values
string —getPaymentSystemId()
Returns the document payment system internal identifier.
public
getPaymentSystemId() : int
Return values
int —getPaymentSystemPId()
Returns the document payment system PId.
public
getPaymentSystemPId() : string
Return values
string —getPaymentType()
Returns the pay response paymentType.
public
getPaymentType() : string
Return values
string —getPrice()
Returns the document payment system price.
public
getPrice() : float
Return values
float —getTaxes()
Returns the document payment system taxes.
public
getTaxes() : array<string|int, DocumentPaymentSystemTax>
Return values
array<string|int, DocumentPaymentSystemTax> —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