phpDocumentor

OrderItem
in package
implements OrderItemInterface

Class OrderItem

Tags
category

System

subpackage

Entities

Interfaces, Classes and Traits

OrderItemInterface
Interface OrderItemInterface

Table of Contents

$addonValues  : EditableKeyValueCollection
Order item addon collection.
$attributes  : OrderItemAttributeCollection
Attributes of the order item.
$checkoutInformation  : string
Checkout information.
$discountMade  : float
Amount of discount made on this order item.
$downloadInformation  : OrderItemDownloadInformationCollection
Download information.
$gxCustomizerData  : OrderItemGXCustomizerDataCollection
GX customizer data.
$name  : string
Name.
$price  : float
Price.
$productModel  : string
Product model.
$quantity  : float
Quantity.
$quantityUnitName  : string
Order item quantity unit name.
$shippingTimeInfo  : string
Order item shipping time info text.
$tax  : float
Tax amount.
$taxAllowed  : bool
Tax allowed on this order item.
__construct()  : mixed
OrderItem constructor.
addAddonValues()  : OrderItem
Merges the existing addon values with new ones.
deleteAddonValue()  : OrderItem
Deletes a specific addon value entry by key.
getAddonValue()  : string
Returns the order addon key value from collection.
getAddonValues()  : EditableKeyValueCollection
Returns the addon collection of an order item.
getAttributes()  : OrderItemAttributeCollection
Returns the attributes of the order item.
getCheckoutInformation()  : string
Returns the checkout information of the order item.
getDiscountMade()  : float
Returns the amount of discount of the order item.
getDownloadInformation()  : OrderItemDownloadInformationCollection
Returns the download information collection of the order item.
getFinalPrice()  : float
Returns the final price of the order item.
getGXCustomizerData()  : OrderItemGXCustomizerDataCollection
Returns the gx customizer data collection of the order item.
getName()  : string
Returns the name of the order item.
getPrice()  : float
Returns the price of the order item.
getProductModel()  : string
Returns the product model of the order item.
getQuantity()  : float
Returns the quantity of the order item.
getQuantityUnitName()  : string
Returns the name of quantity unit of the order item.
getShippingTimeInfo()  : string
Returns the shipping time of the order item.
getTax()  : float
Returns the tax of the order item.
isTaxAllowed()  : bool
Is tax of the order item allowed?
setAddonValue()  : OrderItem
Adds/updates a key value in the addon value collection.
setAttributes()  : OrderItem
Sets attributes of the OrderItem.
setCheckoutInformation()  : OrderItem
Sets the checkout information.
setDiscountMade()  : OrderItem
Sets discount of the OrderItem.
setDownloadInformation()  : OrderItem
Sets the download information of the OrderItem.
setGXCustomizerData()  : OrderItem
Sets the gx customizer data of the OrderItem.
setName()  : OrderItem
Sets name of the OrderItem.
setPrice()  : OrderItem
Sets price of the OrderItem.
setProductModel()  : OrderItem
Sets product model of the OrderItem.
setQuantity()  : OrderItem
Sets quantity of the OrderItem.
setQuantityUnitName()  : OrderItem
Sets name of quantity unit of the OrderItem.
setShippingTimeInfo()  : OrderItem
Sets shipping time of the OrderItem.
setTax()  : OrderItem
Sets tax of the OrderItem.
setTaxAllowed()  : OrderItem
Sets whether tax of the OrderItem is allowed or not.

Properties

$checkoutInformation

Checkout information.

protected string $checkoutInformation = ''

$discountMade

Amount of discount made on this order item.

protected float $discountMade = 0.0

.

$productModel

Product model.

protected string $productModel = ''

$quantityUnitName

Order item quantity unit name.

protected string $quantityUnitName = ''

$shippingTimeInfo

Order item shipping time info text.

protected string $shippingTimeInfo = ''

$taxAllowed

Tax allowed on this order item.

protected bool $taxAllowed = alse

Methods

getAddonValue()

Returns the order addon key value from collection.

public getAddonValue(StringType $key) : string
Parameters
$key : StringType

Addon key.

Return values
string —

Addon value.

getCheckoutInformation()

Returns the checkout information of the order item.

public getCheckoutInformation() : string
Return values
string —

Checkout information of the order item.

getDiscountMade()

Returns the amount of discount of the order item.

public getDiscountMade() : float
Return values
float —

Amount of discount of the order item.

getFinalPrice()

Returns the final price of the order item.

public getFinalPrice() : float
Return values
float —

Final price of the order item.

getName()

Returns the name of the order item.

public getName() : string
Return values
string —

Name of the order item.

getPrice()

Returns the price of the order item.

public getPrice() : float
Return values
float —

Price of the order item.

getProductModel()

Returns the product model of the order item.

public getProductModel() : string
Return values
string —

Product model of the order item.

getQuantity()

Returns the quantity of the order item.

public getQuantity() : float
Return values
float —

Quantity of the order item.

getQuantityUnitName()

Returns the name of quantity unit of the order item.

public getQuantityUnitName() : string
Return values
string —

Name of quantity unit of the order item.

getShippingTimeInfo()

Returns the shipping time of the order item.

public getShippingTimeInfo() : string
Return values
string —

Shipping time of the order item.

getTax()

Returns the tax of the order item.

public getTax() : float
Return values
float —

Tax of the order item.

isTaxAllowed()

Is tax of the order item allowed?

public isTaxAllowed() : bool
Return values
bool —

Is tax of the order item allowed?

setCheckoutInformation()

Sets the checkout information.

public setCheckoutInformation(StringType $checkoutInformation) : OrderItem
Parameters
$checkoutInformation : StringType

Contains the checkout info of the order item.

Return values
OrderItem —

Same instance for method chaining.

setQuantityUnitName()

Sets name of quantity unit of the OrderItem.

public setQuantityUnitName(StringType $name) : OrderItem
Parameters
$name : StringType

Name of quantity unit of the OrderItem.

Return values
OrderItem —

Same instance for method chaining.

setTaxAllowed()

Sets whether tax of the OrderItem is allowed or not.

public setTaxAllowed(BoolType $allow) : OrderItem
Parameters
$allow : BoolType

Tax allowed or not?

Return values
OrderItem —

Same instance for method chaining.

Search results