StoredOrderItemInterface
extends
OrderItemInterface
in
Interface StoredOrderItemInterface
Tags
Table of Contents
- addAddonValues() : OrderItemInterface
- Merges the existing addon values with new ones.
- deleteAddonValue() : OrderItemInterface
- 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 the 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.
- getOrderItemId() : int
- Returns ID of the stored order item ID.
- 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() : OrderItemInterface
- Adds/updates a key value in the addon value collection.
- setAttributes() : OrderItemInterface
- Sets the attributes of the order item.
- setCheckoutInformation() : OrderItemInterface
- Sets the checkout information.
- setDiscountMade() : OrderItemInterface
- Sets the discount of the order item.
- setDownloadInformation() : OrderItemInterface
- Sets the download information of the order item.
- setGXCustomizerData() : OrderItemInterface
- Sets the gx customizer data of the order item.
- setName() : OrderItemInterface
- Sets the name of the order item.
- setPrice() : OrderItemInterface
- Sets the price of the order item.
- setProductModel() : OrderItemInterface
- Sets the product model of the order item.
- setQuantity() : OrderItemInterface
- Sets the quantity of the order item.
- setQuantityUnitName() : OrderItemInterface
- Sets the name of quantity unit of the order item.
- setShippingTimeInfo() : OrderItemInterface
- Sets the shipping time of the order item.
- setTax() : OrderItemInterface
- Sets the tax of the order item.
- setTaxAllowed() : OrderItemInterface
- Sets whether tax of the OrderItem is allowed or not.
Methods
addAddonValues()
Merges the existing addon values with new ones.
public
addAddonValues(KeyValueCollection $addonValues) : OrderItemInterface
Parameters
- $addonValues : KeyValueCollection
-
Contains the new addon values to be merged with the existing ones.
Return values
OrderItemInterface —Same instance for method chaining.
deleteAddonValue()
Deletes a specific addon value entry by key.
public
deleteAddonValue(StringType $key) : OrderItemInterface
Parameters
- $key : StringType
-
Addon key.
Return values
OrderItemInterface —Same instance for method chaining.
getAddonValue()
Returns the order addon key value from collection.
public
getAddonValue(StringType $key) : string
Parameters
- $key : StringType
-
Addon key.
Tags
Return values
string —Addon value.
getAddonValues()
Returns the addon collection of the order item.
public
getAddonValues() : EditableKeyValueCollection
Return values
EditableKeyValueCollection —The addon collection of the order item.
getAttributes()
Returns the attributes of the order item.
public
getAttributes() : OrderItemAttributeCollection
Return values
OrderItemAttributeCollection —Attributes of the order item.
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.
getDownloadInformation()
Returns the download information collection of the order item.
public
getDownloadInformation() : OrderItemDownloadInformationCollection
Return values
OrderItemDownloadInformationCollection —Download information collection 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.
getGXCustomizerData()
Returns the gx customizer data collection of the order item.
public
getGXCustomizerData() : OrderItemGXCustomizerDataCollection
Return values
OrderItemGXCustomizerDataCollection —GXCustomizerData collection of the order item.
getName()
Returns the name of the order item.
public
getName() : string
Return values
string —Name of the order item.
getOrderItemId()
Returns ID of the stored order item ID.
public
getOrderItemId() : int
Return values
int —Order item ID.
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?
setAddonValue()
Adds/updates a key value in the addon value collection.
public
setAddonValue(StringType $key, StringType $value) : OrderItemInterface
Parameters
- $key : StringType
-
Addon key.
- $value : StringType
-
Addon value.
Return values
OrderItemInterface —Same instance for method chaining.
setAttributes()
Sets the attributes of the order item.
public
setAttributes(OrderItemAttributeCollection $attributeCollection) : OrderItemInterface
Parameters
- $attributeCollection : OrderItemAttributeCollection
-
Attributes of the order item.
Return values
OrderItemInterface —Same instance for method chaining.
setCheckoutInformation()
Sets the checkout information.
public
setCheckoutInformation(StringType $checkoutInformation) : OrderItemInterface
Parameters
- $checkoutInformation : StringType
-
Contains the checkout info of the order item.
Return values
OrderItemInterface —Same instance for method chaining.
setDiscountMade()
Sets the discount of the order item.
public
setDiscountMade(DecimalType $discount) : OrderItemInterface
Parameters
- $discount : DecimalType
-
Discount of the order item.
Return values
OrderItemInterface —Same instance for method chaining.
setDownloadInformation()
Sets the download information of the order item.
public
setDownloadInformation(OrderItemDownloadInformationCollection $downloads) : OrderItemInterface
Parameters
- $downloads : OrderItemDownloadInformationCollection
-
Download information collection of the order item.
Return values
OrderItemInterface —Same instance for method chaining.
setGXCustomizerData()
Sets the gx customizer data of the order item.
public
setGXCustomizerData(OrderItemGXCustomizerDataCollection $gxCustomizerData) : OrderItemInterface
Parameters
- $gxCustomizerData : OrderItemGXCustomizerDataCollection
-
GXCustomizerData collection of the order item.
Return values
OrderItemInterface —Same instance for method chaining.
setName()
Sets the name of the order item.
public
setName(StringType $name) : OrderItemInterface
Parameters
- $name : StringType
-
Name of the order item.
Return values
OrderItemInterface —Same instance for method chaining.
setPrice()
Sets the price of the order item.
public
setPrice(DecimalType $price) : OrderItemInterface
Parameters
- $price : DecimalType
-
Price of the order item.
Return values
OrderItemInterface —Same instance for method chaining.
setProductModel()
Sets the product model of the order item.
public
setProductModel(StringType $model) : OrderItemInterface
Parameters
- $model : StringType
-
Model of the order item.
Return values
OrderItemInterface —Same instance for method chaining.
setQuantity()
Sets the quantity of the order item.
public
setQuantity(DecimalType $quantity) : OrderItemInterface
Parameters
- $quantity : DecimalType
-
Quantity of the order item.
Return values
OrderItemInterface —Same instance for method chaining.
setQuantityUnitName()
Sets the name of quantity unit of the order item.
public
setQuantityUnitName(StringType $name) : OrderItemInterface
Parameters
- $name : StringType
-
Name of quantity unit of the order item.
Return values
OrderItemInterface —Same instance for method chaining.
setShippingTimeInfo()
Sets the shipping time of the order item.
public
setShippingTimeInfo(StringType $time) : OrderItemInterface
Parameters
- $time : StringType
-
Shipping time of the order item.
Return values
OrderItemInterface —Same instance for method chaining.
setTax()
Sets the tax of the order item.
public
setTax(DecimalType $tax) : OrderItemInterface
Parameters
- $tax : DecimalType
-
Tax of the order item.
Return values
OrderItemInterface —Same instance for method chaining.
setTaxAllowed()
Sets whether tax of the OrderItem is allowed or not.
public
setTaxAllowed(BoolType $allow) : OrderItemInterface
Parameters
- $allow : BoolType
-
Tax allowed or not?
Return values
OrderItemInterface —Same instance for method chaining.