Class OrderItem

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.

public getProductModel( void ) : string

Returns the product model of the order item.

public getName( void ) : string

Returns the name of the order item.

public getPrice( void ) : float

Returns the price of the order item.

public getQuantity( void ) : float

Returns the quantity of the order item.

public getFinalPrice( void ) : float

Returns the final price of the order item.

public getTax( void ) : float

Returns the tax of the order item.

public isTaxAllowed( void ) : boolean

Is tax of the order item allowed?

public getDiscountMade( void ) : float

Returns the amount of discount of the order item.

public getShippingTimeInfo( void ) : string

Returns the shipping time of the order item.

public getAttributes( void ) : OrderItemAttributeCollection

Returns the attributes of the order item.

public getQuantityUnitName( void ) : string

Returns the name of quantity unit of the order item.

public getCheckoutInformation( void ) : string

Returns the checkout information of the order item.

public getDownloadInformation( void ) : OrderItemDownloadInformationCollection

Returns the download information collection of the order item.

public getGXCustomizerData( void ) : OrderItemGXCustomizerDataCollection

Returns the gx customizer data collection of the order item.

public getAddonValues( void ) : EditableKeyValueCollection

Returns the addon collection of an order item.

public getAddonValue( StringType $key ) : string

Returns the order addon key value from collection.

public setProductModel( StringType $model ) : OrderItem

Sets product model of the OrderItem.

public setName( StringType $name ) : OrderItem

Sets name of the OrderItem.

public setPrice( DecimalType $price ) : OrderItem

Sets price of the OrderItem.

public setQuantity( DecimalType $quantity ) : OrderItem

Sets quantity of the OrderItem.

public setTax( DecimalType $tax ) : OrderItem

Sets tax of the OrderItem.

public setTaxAllowed( BoolType $allow ) : OrderItem

Sets whether tax of the OrderItem is allowed or not.

public setDiscountMade( DecimalType $discount ) : OrderItem

Sets discount of the OrderItem.

public setShippingTimeInfo( StringType $time ) : OrderItem

Sets shipping time of the OrderItem.

public setAttributes( OrderItemAttributeCollection $attributeCollection ) : OrderItem

Sets attributes of the OrderItem.

public setQuantityUnitName( StringType $name ) : OrderItem

Sets name of quantity unit of the OrderItem.

public setCheckoutInformation( StringType $checkoutInformation ) : OrderItem

Sets the checkout information.

public setDownloadInformation( OrderItemDownloadInformationCollection $downloads ) : OrderItem

Sets the download information of the OrderItem.

public setGXCustomizerData( OrderItemGXCustomizerDataCollection $gxCustomizerData ) : OrderItem

Sets the gx customizer data of the OrderItem.

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

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

public addAddonValues( KeyValueCollection $addonValues ) : OrderItem

Merges the existing addon values with new ones.

public deleteAddonValue( StringType $key ) : OrderItem

Deletes a specific addon value entry by key.

Properties summary

protected $productModel : string

Product model.

''
protected $name : string

Name.

''
protected $price : float

Price.

0.0
protected $quantity : float

Quantity.

0.0
protected $tax : float

Tax amount.

0.0
protected $taxAllowed : boolean

Tax allowed on this order item.

false
protected $discountMade : float

Amount of discount made on this order item..

0.0
protected $shippingTimeInfo : string

Order item shipping time info text.

''
protected $attributes : OrderItemAttributeCollection

Attributes of the order item.


		

		

			
			
				
				protected  
				

				
					$quantityUnitName
				

				: string
			

			

				
Order item quantity unit name.

			


			

			
''

		

		

			
			
				
				protected  
				

				
					$checkoutInformation
				

				: string
			

			

				
Checkout information.

			


			

			
''

		

		

			
			
				
				protected  
				

				
					$downloadInformation
				

				: OrderItemDownloadInformationCollection
			

			

				
Download information.

			


			

			

		

		

			
			
				
				protected  
				

				
					$gxCustomizerData
				

				: OrderItemGXCustomizerDataCollection
			

			

				
GX customizer data.

			


			

			

		

		

			
			
				
				protected  
				

				
					$addonValues
				

				: EditableKeyValueCollection
			

			

				
Order item addon collection.