ItemInterface
Methods summary
| Return Type | Method Name | Description | |
|---|---|---|---|
| string | getUuid() | Runtime unique id for cart item | |
| ItemInterface | setId(string|null $id) | Set type prefixed product identifier | |
| string|null | getId() | Get prefixed product identifier | |
| ItemInterface | setName(string $name) | Set description name | |
| string | getName() | Get description name | |
| ItemInterface | setBillingCycle($billingCycle) | Set billing cycle, such as free, onetime, monthly, quarterly, etc | |
| string | getBillingCycle() | Get billing cycle | |
| ItemInterface | setBillingPeriod(string $billingPeriod) | Start date for items that renew | |
| int | getBillingPeriod() | Get start date for items that renew | |
| ItemInterface | setQuantity(int $qty) | Set quantity for scaling quantity items | |
| int | getQuantity() | Get quantity for scaling quantity items | |
| ItemInterface | setAmount(Price $amount) | Set initial cost amount | |
| Price | getAmount() | Get Initial cost amount | |
| ItemInterface | setRecurringAmount(Price $recurring = null) | Set recurring cost amount | |
| Price|null | getRecurringAmount() | Get recurring cost amount | |
| ItemInterface | setTaxed(bool $taxed) | Set taxable status of item | |
| bool | isTaxed() | Is item taxable | |
| ItemInterface | setInitialPeriod(string $period, string $cycle) | Set initial period in days for prorated item | |
| bool | hasInitialPeriod() | If an initial period is defined (prorata) | |
| bool | isRecurring() | If the item is a of a recurring cycle | |
| string | getType() | Item type such as Product, Addon, Domain or generic Item | |
| Price | getSetupAmount() | The setup amount | |
| setSetupAmount(Price|null $amount) | Set the setup amount | ||
| Price | getRecurringBasePrice() | The recurring base price without Tax or Setup fee | |
| setRecurringBasePrice(Price|null $amount) | Set the base prince | ||
| string | getItemName() | Item's name without concatenated group's name | |
| setItemName(string $name) | - | ||
| string | getItemGroupName() | Item's group name (without its name) | |
| setItemGroupName(string $groupName) | - | ||
| int | getItemGroupId() | - | |
| setItemGroupId(int $groupId) | - | ||
| Price | getAmountExcludeTaxSetup() | Initial cost without Tax and Setup fee | |
| setAmountExcludeTaxSetup(Price|null $price) | - | ||
| bool | isFree() | If the cart item has free billing cycle |
Details
string
getUuid ()
Runtime unique id for cart item
ItemInterface
setId (string|null $id)
Set type prefixed product identifier
string|null
getId ()
Get prefixed product identifier
ItemInterface
setName (string $name)
Set description name
string
getName ()
Get description name
ItemInterface
setBillingCycle ($billingCycle)
Set billing cycle, such as free, onetime, monthly, quarterly, etc
string
getBillingCycle ()
Get billing cycle
ItemInterface
setBillingPeriod (string $billingPeriod)
Start date for items that renew
int
getBillingPeriod ()
Get start date for items that renew
ItemInterface
setQuantity (int $qty)
Set quantity for scaling quantity items
int
getQuantity ()
Get quantity for scaling quantity items
ItemInterface
setAmount (Price $amount)
Set initial cost amount
Price
getAmount ()
Get Initial cost amount
ItemInterface
setRecurringAmount (Price $recurring = null)
Set recurring cost amount
Price|null
getRecurringAmount ()
Get recurring cost amount
ItemInterface
setTaxed (bool $taxed)
Set taxable status of item
bool
isTaxed ()
Is item taxable
ItemInterface
setInitialPeriod (string $period, string $cycle)
Set initial period in days for prorated item
bool
hasInitialPeriod ()
If an initial period is defined (prorata)
bool
isRecurring ()
If the item is a of a recurring cycle
string
getType ()
Item type such as Product, Addon, Domain or generic Item
Price
getSetupAmount ()
The setup amount
setSetupAmount (Price|null $amount)
Set the setup amount
Price
getRecurringBasePrice ()
The recurring base price without Tax or Setup fee
setRecurringBasePrice (Price|null $amount)
Set the base prince
string
getItemName ()
Item's name without concatenated group's name
setItemName (string $name)
string
getItemGroupName ()
Item's group name (without its name)
setItemGroupName (string $groupName)
int
getItemGroupId ()
setItemGroupId (int $groupId)
Price
getAmountExcludeTaxSetup ()
Initial cost without Tax and Setup fee
setAmountExcludeTaxSetup (Price|null $price)
bool
isFree ()
If the cart item has free billing cycle