API Documentation
Back to top  

OrderItem

Implements \OrderItemInterface

Class OrderItem

category

System
package

Order
subpackage

Entities

Methods

OrderItem constructor.

__construct(\StringType $name)

Arguments

$name

\StringType

Order item name.

Merges the existing addon values with new ones.

addAddonValues(\KeyValueCollection $addonValues) : \OrderItem

Arguments

$addonValues

\KeyValueCollection

Contains the new addon values to be merged with the existing ones.

Response

\OrderItem

Same instance for method chaining.

Deletes a specific addon value entry by key.

deleteAddonValue(\StringType $key) : \OrderItem

Arguments

$key

\StringType

Addon key.

Response

\OrderItem

Same instance for method chaining.

Returns the order addon key value from collection.

getAddonValue(\StringType $key) : string

Arguments

$key

\StringType

Addon key.

Response

string

Addon value.

Returns the addon collection of an order item.

getAddonValues() : \EditableKeyValueCollection

Response

\EditableKeyValueCollection

Addon collection.

Returns the attributes of the order item.

getAttributes() : \OrderItemAttributeCollection

Response

\OrderItemAttributeCollection

Attributes of the order item.

Returns the checkout information of the order item.

getCheckoutInformation() : string

Response

string

Checkout information of the order item.

Returns the amount of discount of the order item.

getDiscountMade() : float

Response

float

Amount of discount of the order item.

Returns the download information collection of the order item.

getDownloadInformation() : \OrderItemDownloadInformationCollection

Response

\OrderItemDownloadInformationCollection

Download information collection of the order item.

Returns the final price of the order item.

getFinalPrice() : float

Response

float

Final price of the order item.

Returns the gx customizer data collection of the order item.

getGXCustomizerData() : \OrderItemGXCustomizerDataCollection

Response

\OrderItemGXCustomizerDataCollection

GXCustomizerData collection of the order item.

Returns the name of the order item.

getName() : string

Response

string

Name of the order item.

Returns the price of the order item.

getPrice() : double

Response

double

Price of the order item.

Returns the product model of the order item.

getProductModel() : string

Response

string

Product model of the order item.

Returns the quantity of the order item.

getQuantity() : double

Response

double

Quantity of the order item.

Returns the name of quantity unit of the order item.

getQuantityUnitName() : string

Response

string

Name of quantity unit of the order item.

Returns the shipping time of the order item.

getShippingTimeInfo() : string

Response

string

Shipping time of the order item.

Returns the tax of the order item.

getTax() : float

Response

float

Tax of the order item.

Is tax of the order item allowed?

isTaxAllowed() : boolean

Response

boolean

Is tax of the order item allowed?

Adds/updates a key value in the addon value collection.

setAddonValue(\StringType $key, \StringType $value) : \OrderItem

Arguments

$key

\StringType

Addon key.

$value

\StringType

Addon value.

Response

\OrderItem

Same instance for method chaining.

Sets attributes of the OrderItem.

setAttributes(\OrderItemAttributeCollection $attributeCollection) : \OrderItem

Arguments

$attributeCollection

\OrderItemAttributeCollection

Attributes of the OrderItem.

Response

\OrderItem

Same instance for method chaining.

Sets the checkout information.

setCheckoutInformation(\StringType $checkoutInformation) : \OrderItem

Arguments

$checkoutInformation

\StringType

Contains the checkout info of the order item.

Response

\OrderItem

Same instance for method chaining.

Sets discount of the OrderItem.

setDiscountMade(\DecimalType $discount) : \OrderItem

Arguments

$discount

\DecimalType

Discount of the OrderItem.

Response

\OrderItem

Same instance for method chaining.

Sets the download information of the OrderItem.

setDownloadInformation(\OrderItemDownloadInformationCollection $downloads) : \OrderItem

Arguments

$downloads

\OrderItemDownloadInformationCollection

Download information collection.

Response

\OrderItem

Same instance for method chaining.

Sets the gx customizer data of the OrderItem.

setGXCustomizerData(\OrderItemGXCustomizerDataCollection $gxCustomizerData) : \OrderItem

Arguments

$gxCustomizerData

\OrderItemGXCustomizerDataCollection

GXCustomizerData collection.

Response

\OrderItem

Same instance for method chaining.

Sets name of the OrderItem.

setName(\StringType $name) : \OrderItem

Arguments

$name

\StringType

Name of the OrderItem.

Response

\OrderItem

Same instance for method chaining.

Sets price of the OrderItem.

setPrice(\DecimalType $price) : \OrderItem

Arguments

$price

\DecimalType

Price of the OrderItem.

Response

\OrderItem

Same instance for method chaining.

Sets product model of the OrderItem.

setProductModel(\StringType $model) : \OrderItem

Arguments

$model

\StringType

Model of the OrderItem.

Response

\OrderItem

Same instance for method chaining.

Sets quantity of the OrderItem.

setQuantity(\DecimalType $quantity) : \OrderItem

Arguments

$quantity

\DecimalType

Quantity of the OrderItem.

Response

\OrderItem

Same instance for method chaining.

Sets name of quantity unit of the OrderItem.

setQuantityUnitName(\StringType $name) : \OrderItem

Arguments

$name

\StringType

Name of quantity unit of the OrderItem.

Response

\OrderItem

Same instance for method chaining.

Sets shipping time of the OrderItem.

setShippingTimeInfo(\StringType $time) : \OrderItem

Arguments

$time

\StringType

Shipping time of the OrderItem.

Response

\OrderItem

Same instance for method chaining.

Sets tax of the OrderItem.

setTax(\DecimalType $tax) : \OrderItem

Arguments

$tax

\DecimalType

Tax of the OrderItem.

Response

\OrderItem

Same instance for method chaining.

Sets whether tax of the OrderItem is allowed or not.

setTaxAllowed(\BoolType $allow) : \OrderItem

Arguments

$allow

\BoolType

Tax allowed or not?

Response

\OrderItem

Same instance for method chaining.

Properties

Product model.

productModel : string
var

Type(s)

string

Name.

name : string
var

Type(s)

string

Price.

price : float
var

Type(s)

float

Quantity.

quantity : float
var

Type(s)

float

Tax amount.

tax : float
var

Type(s)

float

Tax allowed on this order item.

taxAllowed : boolean
var

Type(s)

boolean

Amount of discount made on this order item.

discountMade : float

.

var

Type(s)

float

Order item shipping time info text.

shippingTimeInfo : string
var

Type(s)

string

Attributes of the order item.

attributes : \OrderItemAttributeCollection
var

Type(s)

\OrderItemAttributeCollection

Order item quantity unit name.

quantityUnitName : string
var

Type(s)

string

Checkout information.

checkoutInformation : string
var

Type(s)

string

Download information.

downloadInformation : \OrderItemDownloadInformationCollection
var

Type(s)

\OrderItemDownloadInformationCollection

GX customizer data.

gxCustomizerData : \OrderItemGXCustomizerDataCollection
var

Type(s)

\OrderItemGXCustomizerDataCollection

Order item addon collection.

addonValues : \EditableKeyValueCollection
var

Type(s)

\EditableKeyValueCollection