Class GXEngineOrder

Class GXEngineOrder

This class is used for managing order data.

GXEngineOrder implements OrderInterface, AddonValueContainerInterface
Package: Order\Entities
Category: System
Located at Services/Core/Order/Entities/GXEngineOrder.inc.php

Methods summary

public __construct( void )

GXEngineOrder constructor.

protected _initializeAddressProperties( void )

Initializes default values for AddressBlock properties.

protected _initializeCollectionProperties( void )

Initializes default values for Collection properties.

protected _initializeTypeAndCodeProperties( void )

Initializes default values for type and code properties.

public setOrderId( IdType $id ) : GXEngineOrder

Sets the order ID.

public getOrderId( void ) : integer

Returns the order ID.

public setOrderHash( NonEmptyStringType $orderHash ) : GXEngineOrder

Sets the unique order hash.

public getOrderHash( void ) : string

Returns the unique order hash.

public setCustomerId( IdType $id ) : GXEngineOrder

Sets the associated customer ID.

public getCustomerId( void ) : integer

Returns the associated customer ID.

public setCustomerEmail( EmailStringType $email ) : GXEngineOrder

Sets the customer email address.

public getCustomerEmail( void ) : string

Returns the associated customer email address.

public setCustomerTelephone( StringType $telephone ) : GXEngineOrder

Sets the customer telephone number.

public getCustomerTelephone( void ) : string

Returns the associated customer telephone number.

public setStatusId( IntType $id ) : GXEngineOrder

Sets the order status ID.

public getStatusId( void ) : integer

Returns the order status ID.

public setCustomerNumber( StringType $customerNumber ) : GXEngineOrder

Sets customer number of Order

public getCustomerNumber( void ) : string

Returns the customer number.

public setVatIdNumber( StringType $vatIdNumber ) : GXEngineOrder

Sets the VAT ID Number.

public getVatIdNumber( void ) : string

Returns the VAT ID number.

public setCustomerStatusInformation( CustomerStatusInformation $customerStatusInformation )

Sets the customer status information.

public getCustomerStatusInformation( void ) : CustomerStatusInformation

Returns the Customer status information.

public setCustomerAddress( AddressBlockInterface $address ) : GXEngineOrder

Sets the customer address.

public getCustomerAddress( void ) : AddressBlockInterface

Returns the customer address.

public setBillingAddress( AddressBlockInterface $address ) : GXEngineOrder

Sets the billing address.

public getBillingAddress( void ) : AddressBlockInterface

Returns the billing address.

public setDeliveryAddress( AddressBlockInterface $address ) : GXEngineOrder

Sets the delivery address.

public getDeliveryAddress( void ) : AddressBlockInterface

Returns the delivery address.

public setOrderItems( OrderItemCollection $collection ) : GXEngineOrder

Sets the order items collection.

public getOrderItems( void ) : OrderItemCollection

Returns the order items collection.

public setOrderTotals( OrderTotalCollection $collection ) : GXEngineOrder

Sets the order total collection.

public getOrderTotals( void ) : OrderTotalCollection

Returns the order totals collection.

public setShippingType( OrderShippingType $shippingType ) : GXEngineOrder

Sets the order shipping type.

public getShippingType( void ) : OrderShippingType

Returns the order shipping type.

public setPaymentType( OrderPaymentType $paymentType ) : GXEngineOrder

Sets the order payment type.

public getPaymentType( void ) : OrderPaymentType

Returns the order payment type.

public setCurrencyCode( CurrencyCode $currencyCode ) : GXEngineOrder

Sets the order currency code.

public getCurrencyCode( void ) : CurrencyCode

Returns the order currency code.

public setLanguageCode( LanguageCode $languageCode ) : GXEngineOrder

Sets the order language code.

public getLanguageCode( void ) : LanguageCode

Returns the order language code.

public setPurchaseDateTime( DateTime $purchaseDateTime ) : GXEngineOrder

Sets the order purchase date time.

public getPurchaseDateTime( void ) : DateTime

Returns the order purchase datetime.

public setLastModifiedDateTime( DateTime $lastModifiedDateTime ) : GXEngineOrder

Sets the date time of last modification.

public getLastModifiedDateTime( void ) : DateTime

Returns the datetime of last modification.

public setOrderStatusHistoryReader( OrderStatusHistoryReaderInterface $orderStatusHistoryReader ) : GXEngineOrder

Sets order status history storage object.

public getStatusHistory( void ) : OrderStatusHistoryListItemCollection

Returns the order status history.

public setComment( StringType $comment ) : GXEngineOrder

Sets the order comment.

public getComment( void ) : string

Returns the order comment.

public getTotalWeight( void ) : float

Returns the total weight of the ordered products.

public setTotalWeight( DecimalType $totalWeight ) :

Sets the total weight of the ordered products.

public getAddonValueContainerId( void ) : integer

Returns the addon value container ID. The addon value container id is equal to the orders id.

public getAddonValue( StringType $key ) : EditableKeyValueCollection

Returns the order addon value collection.

public getAddonValues( void ) : EditableKeyValueCollection

Returns the order addon value collection.

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

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

public addAddonValues( KeyValueCollection $addonCollection ) : GXEngineOrder

Adds an addon collection to the existing one.

public deleteAddonValue( StringType $key ) : GXEngineOrder

Removes an addon value from the addon value container by the given key.

Properties summary

protected $orderId : integer

Order ID.

0
protected $orderHash : string

Unique order hash.

''
protected $statusId : integer

Order Status ID.

0
protected $customerId : integer

Customer ID.

0
protected $customerEmail : string

Customer email address.

''
protected $customerTelephone : string

Customer telephone number.

''
protected $customerNumber : string

Customer number.

''
protected $vatIdNumber : string

VAT ID number.

''
protected $customerStatusInformation : CustomerStatusInformation

Customer status information.


		

		

			
			
				
				protected  
				

				
					$customerAddress
				

				: AddressBlockInterface
			

			

				
Customer address.

			


			

			

		

		

			
			
				
				protected  
				

				
					$billingAddress
				

				: AddressBlockInterface
			

			

				
Billing address.

			


			

			

		

		

			
			
				
				protected  
				

				
					$deliveryAddress
				

				: AddressBlockInterface
			

			

				
Delivery address.

			


			

			

		

		

			
			
				
				protected  
				

				
					$orderItems
				

				: OrderItemCollection
			

			

				
Order items.

			


			

			

		

		

			
			
				
				protected  
				

				
					$orderTotals
				

				: OrderTotalCollection
			

			

				
Order totals.

			


			

			

		

		

			
			
				
				protected  
				

				
					$shippingType
				

				: OrderShippingType
			

			

				
Order shipping type.

			


			

			

		

		

			
			
				
				protected  
				

				
					$paymentType
				

				: OrderPaymentType
			

			

				
Order payment type.

			


			

			

		

		

			
			
				
				protected  
				

				
					$currencyCode
				

				: CurrencyCode
			

			

				
Order currency code.

			


			

			

		

		

			
			
				
				protected  
				

				
					$languageCode
				

				: LanguageCode
			

			

				
Order language code.

			


			

			

		

		

			
			
				
				protected  
				

				
					$purchaseDateTime
				

				: DateTime
			

			

				
Order purchase date time.

			


			

			

		

		

			
			
				
				protected  
				

				
					$lastModifiedDateTime
				

				: DateTime
			

			

				
Order last modified date time

			


			

			

		

		

			
			
				
				protected  
				

				
					$comment
				

				: string
			

			

				
Order comment.

			


			

			
''

		

		

			
			
				
				protected  
				

				
					$addonValues
				

				: EditableKeyValueCollection
			

			

				
Order addon collection.

			


			

			

		

		

			
			
				
				protected  
				

				
					$orderStatusHistoryReader
				

				: OrderStatusHistoryStorage
			

			

				
Order status history.

			


			

			

		

		

			
			
				
				protected  
				

				
					$totalWeight
				

				: float
			

			

				
			


			

			
0.0