Package
in package
YetiForce shop product price Package class.
Table of Contents
- PAYMENT_FREQ_MAP = ['monthly' => 'M', 'yearly' => 'Y']
- $currencyCode : string|null
- $id : string
- $label : string|null
- $max : int
- $name : string
- $paymentFrequency : string|null
- $priceGross : float
- $priceNet : int
- __construct() : mixed
- Construct.
- getCurrencyCode() : string
- Get currency Code
- getId() : string
- Get package ID.
- getLabel() : string|null
- Get label.
- getName() : string
- Get name.
- getPaymentFrequency() : string
- Get payment frequency
- getPaymentFrequencyLabel() : string
- Get full name for payment frequency
- getPaymentFrequencyShort() : string
- Get short name payment frequency
- getPrice() : int
- Get price.
- getPriceGross() : int|float|string
- Get gross price
- getPriceNet() : int|float|string
- Get net price
- isAvailable() : bool
- Check if package is available.
Constants
PAYMENT_FREQ_MAP
private
mixed
PAYMENT_FREQ_MAP
= ['monthly' => 'M', 'yearly' => 'Y']
Properties
$currencyCode
private
string|null
$currencyCode
Currency code
$id
private
string
$id
Package ID
$label
private
string|null
$label
Label.
$max
private
int
$max
= 0
User Terms.
$name
private
string
$name
Name.
$paymentFrequency
private
string|null
$paymentFrequency
Payment frequency.
$priceGross
private
float
$priceGross
Price gross.
$priceNet
private
int
$priceNet
Price net.
Methods
__construct()
Construct.
public
__construct(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
Return values
mixed —getCurrencyCode()
Get currency Code
public
getCurrencyCode() : string
Return values
string —getId()
Get package ID.
public
getId() : string
Return values
string —getLabel()
Get label.
public
getLabel() : string|null
Return values
string|null —getName()
Get name.
public
getName() : string
Return values
string —getPaymentFrequency()
Get payment frequency
public
getPaymentFrequency() : string
Return values
string —getPaymentFrequencyLabel()
Get full name for payment frequency
public
getPaymentFrequencyLabel() : string
Return values
string —getPaymentFrequencyShort()
Get short name payment frequency
public
getPaymentFrequencyShort() : string
Return values
string —getPrice()
Get price.
public
getPrice() : int
Return values
int —getPriceGross()
Get gross price
public
getPriceGross([bool $format = false ]) : int|float|string
Parameters
- $format : bool = false
Return values
int|float|string —getPriceNet()
Get net price
public
getPriceNet([bool $format = false ]) : int|float|string
Parameters
- $format : bool = false
Return values
int|float|string —isAvailable()
Check if package is available.
public
isAvailable() : bool