PaymentFormItemDTO
in package
Table of Contents
Properties
- $description : string|null
- $forFree : bool
- $grossPrice : bool
- Whether the price is final: for a VAT payer, VAT is computed from the top and the customer pays the price 1:1. `false` means the price is a base without VAT, the default for all tariffs including credit packages (prices are always without VAT; final prices only for SMS gates with `final_prices` and for a non-monetary currency).
- $group : string
- $id : int
- $name : string
- $paid : bool
- $productTypeId : int|null
- Invoice product-type axis (`tariff.cms_mod_invoicer_product_types_product_type_id`), copied into the payment item snapshot (`cms_system_payment_items`); only the old PDF variant matrix reads it.
- $supplyKindId : int|null
- Supply kind of the item (`cms_system_supply_kinds`): tariff, else category. `null` means the default kind (`is_default`), which the bridge `api/system/tax/resolve` fills in. The engine decides the rate and treatment.
- $prices : array<string|int, mixed>
Methods
- __construct() : mixed
- getPrice() : PaymentFormItemPriceDTO|null
- isDisabled() : bool
Properties
$description read-only
public
string|null
$description
$forFree read-only
public
bool
$forFree
$grossPrice read-only
Whether the price is final: for a VAT payer, VAT is computed from the top and the customer pays the price 1:1. `false` means the price is a base without VAT, the default for all tariffs including credit packages (prices are always without VAT; final prices only for SMS gates with `final_prices` and for a non-monetary currency).
public
bool
$grossPrice
= false
$group read-only
public
string
$group
$id read-only
public
int
$id
$name read-only
public
string
$name
$paid read-only
public
bool
$paid
= false
$productTypeId read-only
Invoice product-type axis (`tariff.cms_mod_invoicer_product_types_product_type_id`), copied into the payment item snapshot (`cms_system_payment_items`); only the old PDF variant matrix reads it.
public
int|null
$productTypeId
= null
null when the tariff has no axis or the item is not a tariff.
$supplyKindId read-only
Supply kind of the item (`cms_system_supply_kinds`): tariff, else category. `null` means the default kind (`is_default`), which the bridge `api/system/tax/resolve` fills in. The engine decides the rate and treatment.
public
int|null
$supplyKindId
= null
$prices read-only
private
array<string|int, mixed>
$prices
= []
Methods
__construct()
public
__construct(string $group, int $id, string $name, string|null $description, bool $forFree[, bool $paid = false ][, array<string|int, PaymentFormItemPriceDTO> $prices = [] ][, int|null $productTypeId = null ][, int|null $supplyKindId = null ][, bool $grossPrice = false ]) : mixed
Parameters
- $group : string
- $id : int
- $name : string
- $description : string|null
- $forFree : bool
- $paid : bool = false
- $prices : array<string|int, PaymentFormItemPriceDTO> = []
- $productTypeId : int|null = null
- $supplyKindId : int|null = null
- $grossPrice : bool = false
getPrice()
public
getPrice(int|null $paymentRegionId, int|null $paymentGateId, int|null $currencyId) : PaymentFormItemPriceDTO|null
Parameters
- $paymentRegionId : int|null
- $paymentGateId : int|null
- $currencyId : int|null
Return values
PaymentFormItemPriceDTO|nullisDisabled()
public
isDisabled() : bool