API Documentation
Back to top  

GXEngineOrder

Implements \OrderInterface, \AddonValueContainerInterface

Class GXEngineOrder

This class is used for managing order data.

category

System
package

Order
subpackage

Entities

Methods

GXEngineOrder constructor.

__construct()

Initializes default values for AddressBlock properties.

_initializeAddressProperties()

Initializes default values for Collection properties.

_initializeCollectionProperties()

Initializes default values for type and code properties.

_initializeTypeAndCodeProperties()

Adds an addon collection to the existing one.

addAddonValues(\KeyValueCollection $addonCollection) : \GXEngineOrder

Arguments

$addonCollection

\KeyValueCollection

Addon collection.

Response

\GXEngineOrder

Same instance for method chaining.

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

deleteAddonValue(\StringType $key) : \GXEngineOrder

Arguments

$key

\StringType

Addon key.

Response

\GXEngineOrder

Same instance for method chaining.

Returns the order addon value collection.

getAddonValue(\StringType $key) : \EditableKeyValueCollection

Arguments

$key

\StringType

Addon key.

Response

\EditableKeyValueCollection

Order addon value collection.

Returns the addon value container ID.

getAddonValueContainerId() : integer

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

Response

integer

Addon value container ID

Returns the order addon value collection.

getAddonValues() : \EditableKeyValueCollection

Response

\EditableKeyValueCollection

Order addon value collection.

Returns the billing address.

getBillingAddress() : \AddressBlockInterface

Response

\AddressBlockInterface

Billing address.

Returns the order comment.

getComment() : string

Response

string

Order comment.

Returns the order currency code.

getCurrencyCode() : \CurrencyCode

Response

\CurrencyCode

Order currency code.

Returns the customer address.

getCustomerAddress() : \AddressBlockInterface

Response

\AddressBlockInterface

Customer address.

Returns the associated customer email address.

getCustomerEmail() : string

Response

string

Associated customer email address.

Returns the associated customer ID.

getCustomerId() : integer

Response

integer

Associated customer ID.

Returns the customer number.

getCustomerNumber() : string

Response

string

Customer number.

Returns the Customer status information.

getCustomerStatusInformation() : \CustomerStatusInformation

Response

\CustomerStatusInformation

Customer status information.

Returns the associated customer telephone number.

getCustomerTelephone() : string

Response

string

Associated customer telephone number.

Returns the delivery address.

getDeliveryAddress() : \AddressBlockInterface

Response

\AddressBlockInterface

Delivery address.

Returns the order language code.

getLanguageCode() : \LanguageCode

Response

\LanguageCode

Order language code.

Returns the datetime of last modification.

getLastModifiedDateTime() : \DateTime

Response

\DateTime

Datetime of last modification.

Returns the unique order hash.

getOrderHash() : string

Response

string

Unique order hash.

Returns the order ID.

getOrderId() : integer

Response

integer

Order ID.

Returns the order items collection.

getOrderItems() : \OrderItemCollection

Response

\OrderItemCollection

Order items collection.

Returns the order totals collection.

getOrderTotals() : \OrderTotalCollection

Response

\OrderTotalCollection

Order totals collection.

Returns the order payment type.

getPaymentType() : \OrderPaymentType

Response

\OrderPaymentType

Order payment type.

Returns the order purchase datetime.

getPurchaseDateTime() : \DateTime

Response

\DateTime

Order purchase datetime.

Returns the order shipping type.

getShippingType() : \OrderShippingType

Response

\OrderShippingType

Order shipping type.

Returns the order status history.

getStatusHistory() : \OrderStatusHistoryListItemCollection

Response

\OrderStatusHistoryListItemCollection

Order status history.

Returns the order status ID.

getStatusId() : integer

Response

integer

Order status ID.

Returns the total weight of the ordered products.

getTotalWeight() : double

Response

double

Returns the VAT ID number.

getVatIdNumber() : string

Response

string

VAT ID number.

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

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

Arguments

$key

\StringType

Addon key.

$value

\StringType

Addon value.

Response

\GXEngineOrder

Same instance for method chaining.

Sets the billing address.

setBillingAddress(\AddressBlockInterface $address) : \GXEngineOrder

Arguments

$address

\AddressBlockInterface

Billing address.

Response

\GXEngineOrder

Same instance for method chaining.

Sets the order comment.

setComment(\StringType $comment) : \GXEngineOrder

Arguments

$comment

\StringType

Comment.

Response

\GXEngineOrder

Same instance for method chaining.

Sets the order currency code.

setCurrencyCode(\CurrencyCode $currencyCode) : \GXEngineOrder

Arguments

$currencyCode

\CurrencyCode

Currency code.

Response

\GXEngineOrder

Same instance for method chaining.

Sets the customer address.

setCustomerAddress(\AddressBlockInterface $address) : \GXEngineOrder

Arguments

$address

\AddressBlockInterface

Customer address.

Response

\GXEngineOrder

Same instance for method chaining.

Sets the customer email address.

setCustomerEmail(\EmailStringType $email) : \GXEngineOrder

Arguments

$email

\EmailStringType

Customer email address.

Response

\GXEngineOrder

Same instance for method chaining.

Sets the associated customer ID.

setCustomerId(\IdType $id) : \GXEngineOrder

Arguments

$id

\IdType

Customer ID.

Response

\GXEngineOrder

Same instance for method chaining.

Sets customer number of Order

setCustomerNumber(\StringType $customerNumber) : \GXEngineOrder

Arguments

$customerNumber

\StringType

Customer number.

Response

\GXEngineOrder

Same instance for method chaining.

Sets the customer status information.

setCustomerStatusInformation(\CustomerStatusInformation $customerStatusInformation)

Arguments

$customerStatusInformation

\CustomerStatusInformation

Customer status information.

Sets the customer telephone number.

setCustomerTelephone(\StringType $telephone) : \GXEngineOrder

Arguments

$telephone

\StringType

Customer telephone number.

Response

\GXEngineOrder

Same instance for method chaining.

Sets the delivery address.

setDeliveryAddress(\AddressBlockInterface $address) : \GXEngineOrder

Arguments

$address

\AddressBlockInterface

Delivery address.

Response

\GXEngineOrder

Same instance for method chaining.

Sets the order language code.

setLanguageCode(\LanguageCode $languageCode) : \GXEngineOrder

Arguments

$languageCode

\LanguageCode

Language code.

Response

\GXEngineOrder

Same instance for method chaining.

Sets the date time of last modification.

setLastModifiedDateTime(\DateTime $lastModifiedDateTime) : \GXEngineOrder

Arguments

$lastModifiedDateTime

\DateTime

Last modification date time

Response

\GXEngineOrder

Same instance for method chaining.

Sets the unique order hash.

setOrderHash(\NonEmptyStringType $orderHash) : \GXEngineOrder

Arguments

$orderHash

\NonEmptyStringType

Unique order hash.

Response

\GXEngineOrder

Same instance for method chaining.

Sets the order ID.

setOrderId(\IdType $id) : \GXEngineOrder

Note, that the ID will be saved as string to the class property.

Arguments

$id

\IdType

Order ID.

Response

\GXEngineOrder

Same instance for method chaining.

Sets the order items collection.

setOrderItems(\OrderItemCollection $collection) : \GXEngineOrder

Arguments

$collection

\OrderItemCollection

Items collection.

Response

\GXEngineOrder

Same instance for method chaining.

Sets order status history storage object.

setOrderStatusHistoryReader(\OrderStatusHistoryReaderInterface $orderStatusHistoryReader) : \GXEngineOrder

Arguments

$orderStatusHistoryReader

\OrderStatusHistoryReaderInterface

Order status history storage object.

Response

\GXEngineOrder

Same instance for method chaining.

Sets the order total collection.

setOrderTotals(\OrderTotalCollection $collection) : \GXEngineOrder

Arguments

$collection

\OrderTotalCollection

Total collection.

Response

\GXEngineOrder

Same instance for method chaining.

Sets the order payment type.

setPaymentType(\OrderPaymentType $paymentType) : \GXEngineOrder

Arguments

$paymentType

\OrderPaymentType

Payment type.

Response

\GXEngineOrder

Same instance for method chaining.

Sets the order purchase date time.

setPurchaseDateTime(\DateTime $purchaseDateTime) : \GXEngineOrder

Arguments

$purchaseDateTime

\DateTime

Purchase date time.

Response

\GXEngineOrder

Same instance for method chaining.

Sets the order shipping type.

setShippingType(\OrderShippingType $shippingType) : \GXEngineOrder

Arguments

$shippingType

\OrderShippingType

Shipping type.

Response

\GXEngineOrder

Same instance for method chaining.

Sets the order status ID.

setStatusId(\IntType $id) : \GXEngineOrder

Arguments

$id

\IntType

Status ID.

Response

\GXEngineOrder

Same instance for method chaining.

Sets the total weight of the ordered products.

setTotalWeight(\DecimalType $totalWeight) : $this|\GXEngineOrder

Arguments

$totalWeight

\DecimalType

Response

$this|\GXEngineOrder

Same instance for method chaining.

Sets the VAT ID Number.

setVatIdNumber(\StringType $vatIdNumber) : \GXEngineOrder

Arguments

$vatIdNumber

\StringType

VAT ID number.

Response

\GXEngineOrder

Same instance for method chaining.

Properties

Order ID.

orderId : integer
var

Type(s)

integer

Unique order hash.

orderHash : string
var

Type(s)

string

Order Status ID.

statusId : integer
var

Type(s)

integer

Customer ID.

customerId : integer
var

Type(s)

integer

Customer email address.

customerEmail : string
var

Type(s)

string

Customer telephone number.

customerTelephone : string
var

Type(s)

string

Customer number.

customerNumber : string
var

Type(s)

string

VAT ID number.

vatIdNumber : string
var

Type(s)

string

Customer status information.

customerStatusInformation : \CustomerStatusInformation
var

Type(s)

\CustomerStatusInformation

Customer address.

customerAddress : \AddressBlockInterface
var

Type(s)

\AddressBlockInterface

Billing address.

billingAddress : \AddressBlockInterface
var

Type(s)

\AddressBlockInterface

Delivery address.

deliveryAddress : \AddressBlockInterface
var

Type(s)

\AddressBlockInterface

Order items.

orderItems : \OrderItemCollection
var

Type(s)

\OrderItemCollection

Order totals.

orderTotals : \OrderTotalCollection
var

Type(s)

\OrderTotalCollection

Order shipping type.

shippingType : \OrderShippingType
var

Type(s)

\OrderShippingType

Order payment type.

paymentType : \OrderPaymentType
var

Type(s)

\OrderPaymentType

Order currency code.

currencyCode : \CurrencyCode
var

Type(s)

\CurrencyCode

Order language code.

languageCode : \LanguageCode
var

Type(s)

\LanguageCode

Order purchase date time.

purchaseDateTime : \DateTime
var

Type(s)

\DateTime

Order last modified date time

lastModifiedDateTime : \DateTime
var

Type(s)

\DateTime

Order comment.

comment : string
var

Type(s)

string

Order addon collection.

addonValues : \EditableKeyValueCollection
var

Type(s)

\EditableKeyValueCollection

Order status history.

orderStatusHistoryReader : \OrderStatusHistoryStorage
var

Type(s)

\OrderStatusHistoryStorage

totalWeight

totalWeight : float
var

Type(s)

float