GXEngineOrder
in package
implements
OrderInterface, AddonValueContainerInterface
Class GXEngineOrder
This class is used for managing order data.
Tags
Interfaces, Classes and Traits
- OrderInterface
- Interface OrderInterface
- AddonValueContainerInterface
- Interface AddonValueContainerInterface
Table of Contents
- $addonValues : EditableKeyValueCollection
- Order addon collection.
- $billingAddress : AddressBlockInterface
- Billing address.
- $comment : string
- Order comment.
- $currencyCode : CurrencyCode
- Order currency code.
- $customerAddress : AddressBlockInterface
- Customer address.
- $customerEmail : string
- Customer email address.
- $customerId : int
- Customer ID.
- $customerNumber : string
- Customer number.
- $customerStatusInformation : CustomerStatusInformation
- Customer status information.
- $customerTelephone : string
- Customer telephone number.
- $deliveryAddress : AddressBlockInterface
- Delivery address.
- $languageCode : LanguageCode
- Order language code.
- $lastModifiedDateTime : DateTime
- Order last modified date time
- $orderHash : string
- Unique order hash.
- $orderId : int
- Order ID.
- $orderItems : OrderItemCollection
- Order items.
- $orderStatusHistoryReader : OrderStatusHistoryStorage
- Order status history.
- $orderTotals : OrderTotalCollection
- Order totals.
- $paymentType : OrderPaymentType
- Order payment type.
- $purchaseDateTime : DateTime
- Order purchase date time.
- $shippingType : OrderShippingType
- Order shipping type.
- $statusId : int
- Order Status ID.
- $totalWeight : float
- $vatIdNumber : string
- VAT ID number.
- __construct() : mixed
- GXEngineOrder constructor.
- addAddonValues() : GXEngineOrder
- Adds an addon collection to the existing one.
- deleteAddonValue() : GXEngineOrder
- Removes an addon value from the addon value container by the given key.
- getAddonValue() : EditableKeyValueCollection
- Returns the order addon value collection.
- getAddonValueContainerId() : int
- Returns the addon value container ID.
- getAddonValues() : EditableKeyValueCollection
- Returns the order addon value collection.
- getBillingAddress() : AddressBlockInterface
- Returns the billing address.
- getComment() : string
- Returns the order comment.
- getCurrencyCode() : CurrencyCode
- Returns the order currency code.
- getCustomerAddress() : AddressBlockInterface
- Returns the customer address.
- getCustomerEmail() : string
- Returns the associated customer email address.
- getCustomerId() : int
- Returns the associated customer ID.
- getCustomerNumber() : string
- Returns the customer number.
- getCustomerStatusInformation() : CustomerStatusInformation
- Returns the Customer status information.
- getCustomerTelephone() : string
- Returns the associated customer telephone number.
- getDeliveryAddress() : AddressBlockInterface
- Returns the delivery address.
- getLanguageCode() : LanguageCode
- Returns the order language code.
- getLastModifiedDateTime() : DateTime
- Returns the datetime of last modification.
- getOrderHash() : string
- Returns the unique order hash.
- getOrderId() : int
- Returns the order ID.
- getOrderItems() : OrderItemCollection
- Returns the order items collection.
- getOrderTotals() : OrderTotalCollection
- Returns the order totals collection.
- getPaymentType() : OrderPaymentType
- Returns the order payment type.
- getPurchaseDateTime() : DateTime
- Returns the order purchase datetime.
- getShippingType() : OrderShippingType
- Returns the order shipping type.
- getStatusHistory() : OrderStatusHistoryListItemCollection
- Returns the order status history.
- getStatusId() : int
- Returns the order status ID.
- getTotalWeight() : float
- Returns the total weight of the ordered products.
- getVatIdNumber() : string
- Returns the VAT ID number.
- setAddonValue() : GXEngineOrder
- Adds/updates a key value in the addon value collection.
- setBillingAddress() : GXEngineOrder
- Sets the billing address.
- setComment() : GXEngineOrder
- Sets the order comment.
- setCurrencyCode() : GXEngineOrder
- Sets the order currency code.
- setCustomerAddress() : GXEngineOrder
- Sets the customer address.
- setCustomerEmail() : GXEngineOrder
- Sets the customer email address.
- setCustomerId() : GXEngineOrder
- Sets the associated customer ID.
- setCustomerNumber() : GXEngineOrder
- Sets customer number of Order
- setCustomerStatusInformation() : mixed
- Sets the customer status information.
- setCustomerTelephone() : GXEngineOrder
- Sets the customer telephone number.
- setDeliveryAddress() : GXEngineOrder
- Sets the delivery address.
- setLanguageCode() : GXEngineOrder
- Sets the order language code.
- setLastModifiedDateTime() : GXEngineOrder
- Sets the date time of last modification.
- setOrderHash() : GXEngineOrder
- Sets the unique order hash.
- setOrderId() : GXEngineOrder
- Sets the order ID.
- setOrderItems() : GXEngineOrder
- Sets the order items collection.
- setOrderStatusHistoryReader() : GXEngineOrder
- Sets order status history storage object.
- setOrderTotals() : GXEngineOrder
- Sets the order total collection.
- setPaymentType() : GXEngineOrder
- Sets the order payment type.
- setPurchaseDateTime() : GXEngineOrder
- Sets the order purchase date time.
- setShippingType() : GXEngineOrder
- Sets the order shipping type.
- setStatusId() : GXEngineOrder
- Sets the order status ID.
- setTotalWeight() : $this|GXEngineOrder
- Sets the total weight of the ordered products.
- setVatIdNumber() : GXEngineOrder
- Sets the VAT ID Number.
- _initializeAddressProperties() : mixed
- Initializes default values for AddressBlock properties.
- _initializeCollectionProperties() : mixed
- Initializes default values for Collection properties.
- _initializeTypeAndCodeProperties() : mixed
- Initializes default values for type and code properties.
Properties
$addonValues
Order addon collection.
protected
EditableKeyValueCollection
$addonValues
$billingAddress
Billing address.
protected
AddressBlockInterface
$billingAddress
$comment
Order comment.
protected
string
$comment
= ''
$currencyCode
Order currency code.
protected
CurrencyCode
$currencyCode
$customerAddress
Customer address.
protected
AddressBlockInterface
$customerAddress
$customerEmail
Customer email address.
protected
string
$customerEmail
= ''
$customerId
Customer ID.
protected
int
$customerId
= 0
$customerNumber
Customer number.
protected
string
$customerNumber
= ''
$customerStatusInformation
Customer status information.
protected
CustomerStatusInformation
$customerStatusInformation
$customerTelephone
Customer telephone number.
protected
string
$customerTelephone
= ''
$deliveryAddress
Delivery address.
protected
AddressBlockInterface
$deliveryAddress
$languageCode
Order language code.
protected
LanguageCode
$languageCode
$lastModifiedDateTime
Order last modified date time
protected
DateTime
$lastModifiedDateTime
$orderHash
Unique order hash.
protected
string
$orderHash
= ''
$orderId
Order ID.
protected
int
$orderId
= 0
$orderItems
Order items.
protected
OrderItemCollection
$orderItems
$orderStatusHistoryReader
Order status history.
protected
OrderStatusHistoryStorage
$orderStatusHistoryReader
$orderTotals
Order totals.
protected
OrderTotalCollection
$orderTotals
$paymentType
Order payment type.
protected
OrderPaymentType
$paymentType
$purchaseDateTime
Order purchase date time.
protected
DateTime
$purchaseDateTime
$shippingType
Order shipping type.
protected
OrderShippingType
$shippingType
$statusId
Order Status ID.
protected
int
$statusId
= 0
$totalWeight
protected
float
$totalWeight
= 0.0
$vatIdNumber
VAT ID number.
protected
string
$vatIdNumber
= ''
Methods
__construct()
GXEngineOrder constructor.
public
__construct() : mixed
Return values
mixed —addAddonValues()
Adds an addon collection to the existing one.
public
addAddonValues(KeyValueCollection $addonCollection) : GXEngineOrder
Parameters
- $addonCollection : KeyValueCollection
-
Addon collection.
Return values
GXEngineOrder —Same instance for method chaining.
deleteAddonValue()
Removes an addon value from the addon value container by the given key.
public
deleteAddonValue(StringType $key) : GXEngineOrder
Parameters
- $key : StringType
-
Addon key.
Return values
GXEngineOrder —Same instance for method chaining.
getAddonValue()
Returns the order addon value collection.
public
getAddonValue(StringType $key) : EditableKeyValueCollection
Parameters
- $key : StringType
-
Addon key.
Return values
EditableKeyValueCollection —Order addon value collection.
getAddonValueContainerId()
Returns the addon value container ID.
public
getAddonValueContainerId() : int
The addon value container id is equal to the orders id.
Return values
int —Addon value container ID
getAddonValues()
Returns the order addon value collection.
public
getAddonValues() : EditableKeyValueCollection
Return values
EditableKeyValueCollection —Order addon value collection.
getBillingAddress()
Returns the billing address.
public
getBillingAddress() : AddressBlockInterface
Return values
AddressBlockInterface —Billing address.
getComment()
Returns the order comment.
public
getComment() : string
Return values
string —Order comment.
getCurrencyCode()
Returns the order currency code.
public
getCurrencyCode() : CurrencyCode
Return values
CurrencyCode —Order currency code.
getCustomerAddress()
Returns the customer address.
public
getCustomerAddress() : AddressBlockInterface
Return values
AddressBlockInterface —Customer address.
getCustomerEmail()
Returns the associated customer email address.
public
getCustomerEmail() : string
Return values
string —Associated customer email address.
getCustomerId()
Returns the associated customer ID.
public
getCustomerId() : int
Return values
int —Associated customer ID.
getCustomerNumber()
Returns the customer number.
public
getCustomerNumber() : string
Return values
string —Customer number.
getCustomerStatusInformation()
Returns the Customer status information.
public
getCustomerStatusInformation() : CustomerStatusInformation
Return values
CustomerStatusInformation —Customer status information.
getCustomerTelephone()
Returns the associated customer telephone number.
public
getCustomerTelephone() : string
Return values
string —Associated customer telephone number.
getDeliveryAddress()
Returns the delivery address.
public
getDeliveryAddress() : AddressBlockInterface
Return values
AddressBlockInterface —Delivery address.
getLanguageCode()
Returns the order language code.
public
getLanguageCode() : LanguageCode
Return values
LanguageCode —Order language code.
getLastModifiedDateTime()
Returns the datetime of last modification.
public
getLastModifiedDateTime() : DateTime
Return values
DateTime —Datetime of last modification.
getOrderHash()
Returns the unique order hash.
public
getOrderHash() : string
Return values
string —Unique order hash.
getOrderId()
Returns the order ID.
public
getOrderId() : int
Return values
int —Order ID.
getOrderItems()
Returns the order items collection.
public
getOrderItems() : OrderItemCollection
Return values
OrderItemCollection —Order items collection.
getOrderTotals()
Returns the order totals collection.
public
getOrderTotals() : OrderTotalCollection
Return values
OrderTotalCollection —Order totals collection.
getPaymentType()
Returns the order payment type.
public
getPaymentType() : OrderPaymentType
Return values
OrderPaymentType —Order payment type.
getPurchaseDateTime()
Returns the order purchase datetime.
public
getPurchaseDateTime() : DateTime
Return values
DateTime —Order purchase datetime.
getShippingType()
Returns the order shipping type.
public
getShippingType() : OrderShippingType
Return values
OrderShippingType —Order shipping type.
getStatusHistory()
Returns the order status history.
public
getStatusHistory() : OrderStatusHistoryListItemCollection
Return values
OrderStatusHistoryListItemCollection —Order status history.
getStatusId()
Returns the order status ID.
public
getStatusId() : int
Return values
int —Order status ID.
getTotalWeight()
Returns the total weight of the ordered products.
public
getTotalWeight() : float
Return values
float —getVatIdNumber()
Returns the VAT ID number.
public
getVatIdNumber() : string
Return values
string —VAT ID number.
setAddonValue()
Adds/updates a key value in the addon value collection.
public
setAddonValue(StringType $key, StringType $value) : GXEngineOrder
Parameters
- $key : StringType
-
Addon key.
- $value : StringType
-
Addon value.
Return values
GXEngineOrder —Same instance for method chaining.
setBillingAddress()
Sets the billing address.
public
setBillingAddress(AddressBlockInterface $address) : GXEngineOrder
Parameters
- $address : AddressBlockInterface
-
Billing address.
Return values
GXEngineOrder —Same instance for method chaining.
setComment()
Sets the order comment.
public
setComment(StringType $comment) : GXEngineOrder
Parameters
- $comment : StringType
-
Comment.
Return values
GXEngineOrder —Same instance for method chaining.
setCurrencyCode()
Sets the order currency code.
public
setCurrencyCode(CurrencyCode $currencyCode) : GXEngineOrder
Parameters
- $currencyCode : CurrencyCode
-
Currency code.
Return values
GXEngineOrder —Same instance for method chaining.
setCustomerAddress()
Sets the customer address.
public
setCustomerAddress(AddressBlockInterface $address) : GXEngineOrder
Parameters
- $address : AddressBlockInterface
-
Customer address.
Return values
GXEngineOrder —Same instance for method chaining.
setCustomerEmail()
Sets the customer email address.
public
setCustomerEmail(EmailStringType $email) : GXEngineOrder
Parameters
- $email : EmailStringType
-
Customer email address.
Return values
GXEngineOrder —Same instance for method chaining.
setCustomerId()
Sets the associated customer ID.
public
setCustomerId(IdType $id) : GXEngineOrder
Parameters
- $id : IdType
-
Customer ID.
Return values
GXEngineOrder —Same instance for method chaining.
setCustomerNumber()
Sets customer number of Order
public
setCustomerNumber(StringType $customerNumber) : GXEngineOrder
Parameters
- $customerNumber : StringType
-
Customer number.
Return values
GXEngineOrder —Same instance for method chaining.
setCustomerStatusInformation()
Sets the customer status information.
public
setCustomerStatusInformation(CustomerStatusInformation $customerStatusInformation) : mixed
Parameters
- $customerStatusInformation : CustomerStatusInformation
-
Customer status information.
Return values
mixed —setCustomerTelephone()
Sets the customer telephone number.
public
setCustomerTelephone(StringType $telephone) : GXEngineOrder
Parameters
- $telephone : StringType
-
Customer telephone number.
Return values
GXEngineOrder —Same instance for method chaining.
setDeliveryAddress()
Sets the delivery address.
public
setDeliveryAddress(AddressBlockInterface $address) : GXEngineOrder
Parameters
- $address : AddressBlockInterface
-
Delivery address.
Return values
GXEngineOrder —Same instance for method chaining.
setLanguageCode()
Sets the order language code.
public
setLanguageCode(LanguageCode $languageCode) : GXEngineOrder
Parameters
- $languageCode : LanguageCode
-
Language code.
Return values
GXEngineOrder —Same instance for method chaining.
setLastModifiedDateTime()
Sets the date time of last modification.
public
setLastModifiedDateTime(DateTime $lastModifiedDateTime) : GXEngineOrder
Parameters
- $lastModifiedDateTime : DateTime
-
Last modification date time
Return values
GXEngineOrder —Same instance for method chaining.
setOrderHash()
Sets the unique order hash.
public
setOrderHash(NonEmptyStringType $orderHash) : GXEngineOrder
Parameters
- $orderHash : NonEmptyStringType
-
Unique order hash.
Return values
GXEngineOrder —Same instance for method chaining.
setOrderId()
Sets the order ID.
public
setOrderId(IdType $id) : GXEngineOrder
Note, that the ID will be saved as string to the class property.
Parameters
- $id : IdType
-
Order ID.
Return values
GXEngineOrder —Same instance for method chaining.
setOrderItems()
Sets the order items collection.
public
setOrderItems(OrderItemCollection $collection) : GXEngineOrder
Parameters
- $collection : OrderItemCollection
-
Items collection.
Return values
GXEngineOrder —Same instance for method chaining.
setOrderStatusHistoryReader()
Sets order status history storage object.
public
setOrderStatusHistoryReader(OrderStatusHistoryReaderInterface $orderStatusHistoryReader) : GXEngineOrder
Parameters
- $orderStatusHistoryReader : OrderStatusHistoryReaderInterface
-
Order status history storage object.
Return values
GXEngineOrder —Same instance for method chaining.
setOrderTotals()
Sets the order total collection.
public
setOrderTotals(OrderTotalCollection $collection) : GXEngineOrder
Parameters
- $collection : OrderTotalCollection
-
Total collection.
Return values
GXEngineOrder —Same instance for method chaining.
setPaymentType()
Sets the order payment type.
public
setPaymentType(OrderPaymentType $paymentType) : GXEngineOrder
Parameters
- $paymentType : OrderPaymentType
-
Payment type.
Return values
GXEngineOrder —Same instance for method chaining.
setPurchaseDateTime()
Sets the order purchase date time.
public
setPurchaseDateTime(DateTime $purchaseDateTime) : GXEngineOrder
Parameters
- $purchaseDateTime : DateTime
-
Purchase date time.
Return values
GXEngineOrder —Same instance for method chaining.
setShippingType()
Sets the order shipping type.
public
setShippingType(OrderShippingType $shippingType) : GXEngineOrder
Parameters
- $shippingType : OrderShippingType
-
Shipping type.
Return values
GXEngineOrder —Same instance for method chaining.
setStatusId()
Sets the order status ID.
public
setStatusId(IntType $id) : GXEngineOrder
Parameters
- $id : IntType
-
Status ID.
Return values
GXEngineOrder —Same instance for method chaining.
setTotalWeight()
Sets the total weight of the ordered products.
public
setTotalWeight(DecimalType $totalWeight) : $this|GXEngineOrder
Parameters
- $totalWeight : DecimalType
Return values
$this|GXEngineOrder —Same instance for method chaining.
setVatIdNumber()
Sets the VAT ID Number.
public
setVatIdNumber(StringType $vatIdNumber) : GXEngineOrder
Parameters
- $vatIdNumber : StringType
-
VAT ID number.
Return values
GXEngineOrder —Same instance for method chaining.
_initializeAddressProperties()
Initializes default values for AddressBlock properties.
protected
_initializeAddressProperties() : mixed
Return values
mixed —_initializeCollectionProperties()
Initializes default values for Collection properties.
protected
_initializeCollectionProperties() : mixed
Return values
mixed —_initializeTypeAndCodeProperties()
Initializes default values for type and code properties.
protected
_initializeTypeAndCodeProperties() : mixed