Class OrderItem

OrderItem implements OrderItemInterface

Direct known subclasses

StoredOrderItem

Package: Order\Entities
Category: System
Located at Services/Core/Order/Entities/OrderItem.inc.php

Methods summary

`public`	# `__construct( StringType $name )` OrderItem constructor. OrderItem constructor. Parameters `$name` Order item name.
`public string`	# `getProductModel( )` Returns the product model of the order item. Returns the product model of the order item. Returns string Product model of the order item. Implementation of `OrderItemInterface::getProductModel()`
`public string`	# `getName( )` Returns the name of the order item. Returns the name of the order item. Returns string Name of the order item. Implementation of `OrderItemInterface::getName()`
`public float`	# `getPrice( )` Returns the price of the order item. Returns the price of the order item. Returns float Price of the order item. Implementation of `OrderItemInterface::getPrice()`
`public float`	# `getQuantity( )` Returns the quantity of the order item. Returns the quantity of the order item. Returns float Quantity of the order item. Implementation of `OrderItemInterface::getQuantity()`
`public float`	# `getFinalPrice( )` Returns the final price of the order item. Returns the final price of the order item. Returns float Final price of the order item. Implementation of `OrderItemInterface::getFinalPrice()`
`public float`	# `getTax( )` Returns the tax of the order item. Returns the tax of the order item. Returns float Tax of the order item. Implementation of `OrderItemInterface::getTax()`
`public boolean`	# `isTaxAllowed( )` Is tax of the order item allowed? Is tax of the order item allowed? Returns boolean Is tax of the order item allowed? Implementation of `OrderItemInterface::isTaxAllowed()`
`public float`	# `getDiscountMade( )` Returns the amount of discount of the order item. Returns the amount of discount of the order item. Returns float Amount of discount of the order item. Implementation of `OrderItemInterface::getDiscountMade()`
`public string`	# `getShippingTimeInfo( )` Returns the shipping time of the order item. Returns the shipping time of the order item. Returns string Shipping time of the order item. Implementation of `OrderItemInterface::getShippingTimeInfo()`
`public OrderItemAttributeCollection`	# `getAttributes( )` Returns the attributes of the order item. Returns the attributes of the order item. Returns `OrderItemAttributeCollection` Attributes of the order item. Implementation of `OrderItemInterface::getAttributes()`
`public string`	# `getQuantityUnitName( )` Returns the name of quantity unit of the order item. Returns the name of quantity unit of the order item. Returns string Name of quantity unit of the order item. Implementation of `OrderItemInterface::getQuantityUnitName()`
`public string`	# `getCheckoutInformation( )` Returns the checkout information of the order item. Returns the checkout information of the order item. Returns string Checkout information of the order item. Implementation of `OrderItemInterface::getCheckoutInformation()`
`public OrderItemDownloadInformationCollection`	# `getDownloadInformation( )` Returns the download information collection of the order item. Returns the download information collection of the order item. Returns `OrderItemDownloadInformationCollection` Download information collection of the order item. Implementation of `OrderItemInterface::getDownloadInformation()`
`public EditableKeyValueCollection`	# `getAddonValues( )` Returns the addon collection of an order item. Returns the addon collection of an order item. Returns `EditableKeyValueCollection` Addon collection. Implementation of `OrderItemInterface::getAddonValues()`
`public string`	# `getAddonValue( StringType $key )` Returns the order addon key value from collection. Returns the order addon key value from collection. Parameters `$key` Addon key. Returns string Addon value. Throws InvalidArgumentException On invalid arguments. Implementation of `OrderItemInterface::getAddonValue()`
`public OrderItem`	# `setProductModel( StringType $model )` Sets product model of the OrderItem. Sets product model of the OrderItem. Parameters `$model` Model of the OrderItem. Returns `OrderItem` Same instance for method chaining. Implementation of `OrderItemInterface::setProductModel()`
`public OrderItem`	# `setName( StringType $name )` Sets name of the OrderItem. Sets name of the OrderItem. Parameters `$name` Name of the OrderItem. Returns `OrderItem` Same instance for method chaining. Implementation of `OrderItemInterface::setName()`
`public OrderItem`	# `setPrice( DecimalType $price )` Sets price of the OrderItem. Sets price of the OrderItem. Parameters `$price` Price of the OrderItem. Returns `OrderItem` Same instance for method chaining. Implementation of `OrderItemInterface::setPrice()`
`public OrderItem`	# `setQuantity( DecimalType $quantity )` Sets quantity of the OrderItem. Sets quantity of the OrderItem. Parameters `$quantity` Quantity of the OrderItem. Returns `OrderItem` Same instance for method chaining. Implementation of `OrderItemInterface::setQuantity()`
`public OrderItem`	# `setTax( DecimalType $tax )` Sets tax of the OrderItem. Sets tax of the OrderItem. Parameters `$tax` Tax of the OrderItem. Returns `OrderItem` Same instance for method chaining. Implementation of `OrderItemInterface::setTax()`
`public OrderItem`	# `setTaxAllowed( BoolType $allow )` Sets whether tax of the OrderItem is allowed or not. Sets whether tax of the OrderItem is allowed or not. Parameters `$allow` Tax allowed or not? Returns `OrderItem` Same instance for method chaining. Implementation of `OrderItemInterface::setTaxAllowed()`
`public OrderItem`	# `setDiscountMade( DecimalType $discount )` Sets discount of the OrderItem. Sets discount of the OrderItem. Parameters `$discount` Discount of the OrderItem. Returns `OrderItem` Same instance for method chaining. Implementation of `OrderItemInterface::setDiscountMade()`
`public OrderItem`	# `setShippingTimeInfo( StringType $time )` Sets shipping time of the OrderItem. Sets shipping time of the OrderItem. Parameters `$time` Shipping time of the OrderItem. Returns `OrderItem` Same instance for method chaining. Implementation of `OrderItemInterface::setShippingTimeInfo()`
`public OrderItem`	# `setAttributes( OrderItemAttributeCollection $attributeCollection )` Sets attributes of the OrderItem. Sets attributes of the OrderItem. Parameters `$attributeCollection` Attributes of the OrderItem. Returns `OrderItem` Same instance for method chaining. Implementation of `OrderItemInterface::setAttributes()`
`public OrderItem`	# `setQuantityUnitName( StringType $name )` Sets name of quantity unit of the OrderItem. Sets name of quantity unit of the OrderItem. Parameters `$name` Name of quantity unit of the OrderItem. Returns `OrderItem` Same instance for method chaining. Implementation of `OrderItemInterface::setQuantityUnitName()`
`public OrderItem`	# `setCheckoutInformation( StringType $checkoutInformation )` Sets the checkout information. Sets the checkout information. Parameters `$checkoutInformation` Contains the checkout info of the order item. Returns `OrderItem` Same instance for method chaining. Implementation of `OrderItemInterface::setCheckoutInformation()`
`public OrderItem`	# `setDownloadInformation( OrderItemDownloadInformationCollection $downloads )` Sets the download information of the OrderItem. Sets the download information of the OrderItem. Parameters `$downloads` Download information collection. Returns `OrderItem` Same instance for method chaining. Implementation of `OrderItemInterface::setDownloadInformation()`
`public OrderItem`	# `setAddonValue( StringType $key, StringType $value )` Adds/updates a key value in the addon value collection. Adds/updates a key value in the addon value collection. Parameters `$key` Addon key. `$value` Addon value. Returns `OrderItem` Same instance for method chaining. Implementation of `OrderItemInterface::setAddonValue()`
`public OrderItem`	# `addAddonValues( KeyValueCollection $addonValues )` Merges the existing addon values with new ones. Merges the existing addon values with new ones. Parameters `$addonValues` Contains the new addon values to be merged with the existing ones. Returns `OrderItem` Same instance for method chaining. Implementation of `OrderItemInterface::addAddonValues()`
`public OrderItem`	# `deleteAddonValue( StringType $key )` Deletes a specific addon value entry by key. Deletes a specific addon value entry by key. Parameters `$key` Addon key. Returns `OrderItem` Same instance for method chaining. Implementation of `OrderItemInterface::deleteAddonValue()`

Properties summary

`protected string`	`$productModel` Product model. Product model.	# `''`
`protected string`	`$name` Name. Name.	# `''`
`protected float`	`$price` Price. Price.	# `0.0`
`protected float`	`$quantity` Quantity. Quantity.	# `0.0`
`protected float`	`$tax` Tax amount. Tax amount.	# `0.0`
`protected boolean`	`$taxAllowed` Tax allowed on this order item. Tax allowed on this order item.	# `false`
`protected float`	`$discountMade` Amount of discount made on this order item.. Amount of discount made on this order item..	# `0.0`
`protected string`	`$shippingTimeInfo` Order item shipping time info text. Order item shipping time info text.	# `''`
`protected OrderItemAttributeCollection`	`$attributes` Attributes of the order item. Attributes of the order item.	#
`protected string`	`$quantityUnitName` Order item quantity unit name. Order item quantity unit name.	# `''`
`protected string`	`$checkoutInformation` Checkout information. Checkout information.	# `''`
`protected OrderItemDownloadInformationCollection`	`$downloadInformation` Download information. Download information.	#
`protected EditableKeyValueCollection`	`$addonValues` Order item addon collection. Order item addon collection.	#

Packages

Classes

Class OrderItem

Direct known subclasses

Methods summary

Parameters

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of