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( )` GXEngineOrder constructor. GXEngineOrder constructor.
`protected`	# `_initializeAddressProperties( )` Initializes default values for AddressBlock properties. Initializes default values for AddressBlock properties.
`protected`	# `_initializeCollectionProperties( )` Initializes default values for Collection properties. Initializes default values for Collection properties.
`protected`	# `_initializeTypeAndCodeProperties( )` Initializes default values for type and code properties. Initializes default values for type and code properties.
`public GXEngineOrder`	# `setOrderId( IdType $id )` Sets the order ID. Sets the order ID. Note, that the ID will be saved as string to the class property. Parameters `$id` Order ID. Returns `GXEngineOrder` Same instance for method chaining. Implementation of `OrderInterface::setOrderId()`
`public integer`	# `getOrderId( )` Returns the order ID. Returns the order ID. Returns integer Order ID. Implementation of `OrderInterface::getOrderId()`
`public GXEngineOrder`	# `setOrderHash( NonEmptyStringType $orderHash )` Sets the unique order hash. Sets the unique order hash. Parameters `$orderHash` Unique order hash. Returns `GXEngineOrder` Same instance for method chaining. Implementation of `OrderInterface::setOrderHash()`
`public string`	# `getOrderHash( )` Returns the unique order hash. Returns the unique order hash. Returns string Unique order hash. Implementation of `OrderInterface::getOrderHash()`
`public GXEngineOrder`	# `setCustomerId( IdType $id )` Sets the associated customer ID. Sets the associated customer ID. Parameters `$id` Customer ID. Returns `GXEngineOrder` Same instance for method chaining. Implementation of `OrderInterface::setCustomerId()`
`public integer`	# `getCustomerId( )` Returns the associated customer ID. Returns the associated customer ID. Returns integer Associated customer ID. Implementation of `OrderInterface::getCustomerId()`
`public GXEngineOrder`	# `setCustomerEmail( EmailStringType $email )` Sets the customer email address. Sets the customer email address. Parameters `$email` Customer email address. Returns `GXEngineOrder` Same instance for method chaining. Implementation of `OrderInterface::setCustomerEmail()`
`public string`	# `getCustomerEmail( )` Returns the associated customer email address. Returns the associated customer email address. Returns string Associated customer email address. Implementation of `OrderInterface::getCustomerEmail()`
`public GXEngineOrder`	# `setCustomerTelephone( StringType $telephone )` Sets the customer telephone number. Sets the customer telephone number. Parameters `$telephone` Customer telephone number. Returns `GXEngineOrder` Same instance for method chaining. Implementation of `OrderInterface::setCustomerTelephone()`
`public string`	# `getCustomerTelephone( )` Returns the associated customer telephone number. Returns the associated customer telephone number. Returns string Associated customer telephone number. Implementation of `OrderInterface::getCustomerTelephone()`
`public GXEngineOrder`	# `setStatusId( IntType $id )` Sets the order status ID. Sets the order status ID. Parameters `$id` Status ID. Returns `GXEngineOrder` Same instance for method chaining. Implementation of `OrderInterface::setStatusId()`
`public integer`	# `getStatusId( )` Returns the order status ID. Returns the order status ID. Returns integer Order status ID. Implementation of `OrderInterface::getStatusId()`
`public GXEngineOrder`	# `setCustomerNumber( StringType $customerNumber )` Sets customer number of Order Sets customer number of Order Parameters `$customerNumber` Customer number. Returns `GXEngineOrder` Same instance for method chaining. Implementation of `OrderInterface::setCustomerNumber()`
`public string`	# `getCustomerNumber( )` Returns the customer number. Returns the customer number. Returns string Customer number. Implementation of `OrderInterface::getCustomerNumber()`
`public GXEngineOrder`	# `setVatIdNumber( StringType $vatIdNumber )` Sets the VAT ID Number. Sets the VAT ID Number. Parameters `$vatIdNumber` VAT ID number. Returns `GXEngineOrder` Same instance for method chaining. Implementation of `OrderInterface::setVatIdNumber()`
`public string`	# `getVatIdNumber( )` Returns the VAT ID number. Returns the VAT ID number. Returns string VAT ID number. Implementation of `OrderInterface::getVatIdNumber()`
`public`	# `setCustomerStatusInformation( CustomerStatusInformation $customerStatusInformation )` Sets the customer status information. Sets the customer status information. Parameters `$customerStatusInformation` Customer status information. Implementation of `OrderInterface::setCustomerStatusInformation()`
`public CustomerStatusInformation`	# `getCustomerStatusInformation( )` Returns the Customer status information. Returns the Customer status information. Returns `CustomerStatusInformation` Customer status information. Implementation of `OrderInterface::getCustomerStatusInformation()`
`public GXEngineOrder`	# `setCustomerAddress( AddressBlockInterface $address )` Sets the customer address. Sets the customer address. Parameters `$address` Customer address. Returns `GXEngineOrder` Same instance for method chaining. Implementation of `OrderInterface::setCustomerAddress()`
`public AddressBlockInterface`	# `getCustomerAddress( )` Returns the customer address. Returns the customer address. Returns `AddressBlockInterface` Customer address. Implementation of `OrderInterface::getCustomerAddress()`
`public GXEngineOrder`	# `setBillingAddress( AddressBlockInterface $address )` Sets the billing address. Sets the billing address. Parameters `$address` Billing address. Returns `GXEngineOrder` Same instance for method chaining. Implementation of `OrderInterface::setBillingAddress()`
`public AddressBlockInterface`	# `getBillingAddress( )` Returns the billing address. Returns the billing address. Returns `AddressBlockInterface` Billing address. Implementation of `OrderInterface::getBillingAddress()`
`public GXEngineOrder`	# `setDeliveryAddress( AddressBlockInterface $address )` Sets the delivery address. Sets the delivery address. Parameters `$address` Delivery address. Returns `GXEngineOrder` Same instance for method chaining. Implementation of `OrderInterface::setDeliveryAddress()`
`public AddressBlockInterface`	# `getDeliveryAddress( )` Returns the delivery address. Returns the delivery address. Returns `AddressBlockInterface` Delivery address. Implementation of `OrderInterface::getDeliveryAddress()`
`public GXEngineOrder`	# `setOrderItems( OrderItemCollection $collection )` Sets the order items collection. Sets the order items collection. Parameters `$collection` Items collection. Returns `GXEngineOrder` Same instance for method chaining. Implementation of `OrderInterface::setOrderItems()`
`public OrderItemCollection`	# `getOrderItems( )` Returns the order items collection. Returns the order items collection. Returns `OrderItemCollection` Order items collection. Implementation of `OrderInterface::getOrderItems()`
`public GXEngineOrder`	# `setOrderTotals( OrderTotalCollection $collection )` Sets the order total collection. Sets the order total collection. Parameters `$collection` Total collection. Returns `GXEngineOrder` Same instance for method chaining. Implementation of `OrderInterface::setOrderTotals()`
`public OrderTotalCollection`	# `getOrderTotals( )` Returns the order totals collection. Returns the order totals collection. Returns `OrderTotalCollection` Order totals collection. Implementation of `OrderInterface::getOrderTotals()`
`public GXEngineOrder`	# `setShippingType( OrderShippingType $shippingType )` Sets the order shipping type. Sets the order shipping type. Parameters `$shippingType` Shipping type. Returns `GXEngineOrder` Same instance for method chaining. Implementation of `OrderInterface::setShippingType()`
`public OrderShippingType`	# `getShippingType( )` Returns the order shipping type. Returns the order shipping type. Returns `OrderShippingType` Order shipping type. Implementation of `OrderInterface::getShippingType()`
`public GXEngineOrder`	# `setPaymentType( OrderPaymentType $paymentType )` Sets the order payment type. Sets the order payment type. Parameters `$paymentType` Payment type. Returns `GXEngineOrder` Same instance for method chaining. Implementation of `OrderInterface::setPaymentType()`
`public OrderPaymentType`	# `getPaymentType( )` Returns the order payment type. Returns the order payment type. Returns `OrderPaymentType` Order payment type. Implementation of `OrderInterface::getPaymentType()`
`public GXEngineOrder`	# `setCurrencyCode( CurrencyCode $currencyCode )` Sets the order currency code. Sets the order currency code. Parameters `$currencyCode` Currency code. Returns `GXEngineOrder` Same instance for method chaining. Implementation of `OrderInterface::setCurrencyCode()`
`public CurrencyCode`	# `getCurrencyCode( )` Returns the order currency code. Returns the order currency code. Returns `CurrencyCode` Order currency code. Implementation of `OrderInterface::getCurrencyCode()`
`public GXEngineOrder`	# `setLanguageCode( LanguageCode $languageCode )` Sets the order language code. Sets the order language code. Parameters `$languageCode` Language code. Returns `GXEngineOrder` Same instance for method chaining. Implementation of `OrderInterface::setLanguageCode()`
`public LanguageCode`	# `getLanguageCode( )` Returns the order language code. Returns the order language code. Returns `LanguageCode` Order language code. Implementation of `OrderInterface::getLanguageCode()`
`public GXEngineOrder`	# `setPurchaseDateTime( DateTime $purchaseDateTime )` Sets the order purchase date time. Sets the order purchase date time. Parameters `$purchaseDateTime` Purchase date time. Returns `GXEngineOrder` Same instance for method chaining. Implementation of `OrderInterface::setPurchaseDateTime()`
`public DateTime`	# `getPurchaseDateTime( )` Returns the order purchase datetime. Returns the order purchase datetime. Returns DateTime Order purchase datetime. Implementation of `OrderInterface::getPurchaseDateTime()`
`public GXEngineOrder`	# `setLastModifiedDateTime( DateTime $lastModifiedDateTime )` Sets the date time of last modification. Sets the date time of last modification. Parameters `$lastModifiedDateTime` Last modification date time Returns `GXEngineOrder` Same instance for method chaining. Implementation of `OrderInterface::setLastModifiedDateTime()`
`public DateTime`	# `getLastModifiedDateTime( )` Returns the datetime of last modification. Returns the datetime of last modification. Returns DateTime Datetime of last modification. Implementation of `OrderInterface::getLastModifiedDateTime()`
`public GXEngineOrder`	# `setOrderStatusHistoryReader( OrderStatusHistoryReaderInterface $orderStatusHistoryReader )` Sets order status history storage object. Sets order status history storage object. Parameters `$orderStatusHistoryReader` Order status history storage object. Returns `GXEngineOrder` Same instance for method chaining.
`public OrderStatusHistoryListItemCollection`	# `getStatusHistory( )` Returns the order status history. Returns the order status history. Returns `OrderStatusHistoryListItemCollection` Order status history. Implementation of `OrderInterface::getStatusHistory()`
`public GXEngineOrder`	# `setComment( StringType $comment )` Sets the order comment. Sets the order comment. Parameters `$comment` Comment. Returns `GXEngineOrder` Same instance for method chaining. Implementation of `OrderInterface::setComment()`
`public string`	# `getComment( )` Returns the order comment. Returns the order comment. Returns string Order comment. Implementation of `OrderInterface::getComment()`
`public float`	# `getTotalWeight( )` Returns the total weight of the ordered products. Returns the total weight of the ordered products. Returns float Implementation of `OrderInterface::getTotalWeight()`
`public`	# `setTotalWeight( DecimalType $totalWeight )` Sets the total weight of the ordered products. Sets the total weight of the ordered products. Parameters `$totalWeight` Returns $this\|GXEngineOrder Same instance for method chaining. Implementation of `OrderInterface::setTotalWeight()`
`public integer`	# `getAddonValueContainerId( )` Returns the addon value container ID. The addon value container id is equal to the orders id. Returns the addon value container ID. The addon value container id is equal to the orders id. Returns integer Addon value container ID Implementation of `AddonValueContainerInterface::getAddonValueContainerId()`
`public EditableKeyValueCollection`	# `getAddonValue( StringType $key )` Returns the order addon value collection. Returns the order addon value collection. Parameters `$key` Addon key. Returns `EditableKeyValueCollection` Order addon value collection. Implementation of `OrderInterface::getAddonValue()`
`public EditableKeyValueCollection`	# `getAddonValues( )` Returns the order addon value collection. Returns the order addon value collection. Returns `EditableKeyValueCollection` Order addon value collection. Implementation of `OrderInterface::getAddonValues()`
`public GXEngineOrder`	# `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 `GXEngineOrder` Same instance for method chaining. Implementation of `OrderInterface::setAddonValue()`
`public GXEngineOrder`	# `addAddonValues( KeyValueCollection $addonCollection )` Adds an addon collection to the existing one. Adds an addon collection to the existing one. Parameters `$addonCollection` Addon collection. Returns `GXEngineOrder` Same instance for method chaining. Implementation of `OrderInterface::addAddonValues()`
`public GXEngineOrder`	# `deleteAddonValue( StringType $key )` Removes an addon value from the addon value container by the given key. Removes an addon value from the addon value container by the given key. Parameters `$key` Addon key. Returns `GXEngineOrder` Same instance for method chaining. Implementation of `AddonValueContainerInterface::deleteAddonValue()`

Properties summary

`protected integer`	`$orderId` Order ID. Order ID.	# `0`
`protected string`	`$orderHash` Unique order hash. Unique order hash.	# `''`
`protected integer`	`$statusId` Order Status ID. Order Status ID.	# `0`
`protected integer`	`$customerId` Customer ID. Customer ID.	# `0`
`protected string`	`$customerEmail` Customer email address. Customer email address.	# `''`
`protected string`	`$customerTelephone` Customer telephone number. Customer telephone number.	# `''`
`protected string`	`$customerNumber` Customer number. Customer number.	# `''`
`protected string`	`$vatIdNumber` VAT ID number. VAT ID number.	# `''`
`protected CustomerStatusInformation`	`$customerStatusInformation` Customer status information. Customer status information.	#
`protected AddressBlockInterface`	`$customerAddress` Customer address. Customer address.	#
`protected AddressBlockInterface`	`$billingAddress` Billing address. Billing address.	#
`protected AddressBlockInterface`	`$deliveryAddress` Delivery address. Delivery address.	#
`protected OrderItemCollection`	`$orderItems` Order items. Order items.	#
`protected OrderTotalCollection`	`$orderTotals` Order totals. Order totals.	#
`protected OrderShippingType`	`$shippingType` Order shipping type. Order shipping type.	#
`protected OrderPaymentType`	`$paymentType` Order payment type. Order payment type.	#
`protected CurrencyCode`	`$currencyCode` Order currency code. Order currency code.	#
`protected LanguageCode`	`$languageCode` Order language code. Order language code.	#
`protected DateTime`	`$purchaseDateTime` Order purchase date time. Order purchase date time.	#
`protected DateTime`	`$lastModifiedDateTime` Order last modified date time Order last modified date time	#
`protected string`	`$comment` Order comment. Order comment.	# `''`
`protected EditableKeyValueCollection`	`$addonValues` Order addon collection. Order addon collection.	#
`protected OrderStatusHistoryStorage`	`$orderStatusHistoryReader` Order status history. Order status history.	#
`protected float`	`$totalWeight`	# `0.0`

Packages

Classes

Class GXEngineOrder

Methods summary

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns