phpDocumentor

OrderInterface
in

Interface OrderInterface

Tags
category

System

subpackage

Interfaces

Table of Contents

addAddonValues()  : OrderInterface
Adds an addon collection to the existing one.
getAddonValue()  : string
Returns the order addon key value from collection.
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()  : OrderInterface
Adds/updates a key value in the addon value collection.
setBillingAddress()  : OrderInterface
Sets the billing address.
setComment()  : OrderInterface
Sets the order comment.
setCurrencyCode()  : OrderInterface
Sets the order currency code.
setCustomerAddress()  : OrderInterface
Sets the customer address.
setCustomerEmail()  : OrderInterface
Sets the customer email address.
setCustomerId()  : OrderInterface
Sets the associated customer ID.
setCustomerNumber()  : OrderInterface
Sets customer number of Order
setCustomerStatusInformation()  : mixed
Sets the customer status information.
setCustomerTelephone()  : OrderInterface
Sets the customer telephone number.
setDeliveryAddress()  : OrderInterface
Sets the delivery address.
setLanguageCode()  : OrderInterface
Sets the order language code.
setLastModifiedDateTime()  : OrderInterface
Sets the date time of last modification.
setOrderHash()  : GXEngineOrder
Sets the unique order hash.
setOrderId()  : OrderInterface
Sets the order ID.
setOrderItems()  : OrderInterface
Sets the order items collection.
setOrderTotals()  : OrderInterface
Sets the order total collection.
setPaymentType()  : OrderInterface
Sets the order payment type.
setPurchaseDateTime()  : OrderInterface
Sets the order purchase date time.
setShippingType()  : OrderInterface
Sets the order shipping type.
setStatusId()  : OrderInterface
Sets the order status ID.
setTotalWeight()  : $this|OrderInterface
Sets the total weight of the ordered products.
setVatIdNumber()  : OrderInterface
Sets the VAT ID Number.

Methods

getAddonValue()

Returns the order addon key value from collection.

public getAddonValue(StringType $key) : string
Parameters
$key : StringType

Addon key.

Return values
string —

Addon value.

getComment()

Returns the order comment.

public getComment() : string
Return values
string —

Order comment.

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.

getCustomerTelephone()

Returns the associated customer telephone number.

public getCustomerTelephone() : string
Return values
string —

Associated customer telephone number.

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.

getPurchaseDateTime()

Returns the order purchase datetime.

public getPurchaseDateTime() : DateTime
Return values
DateTime —

Order purchase datetime.

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.

setLastModifiedDateTime()

Sets the date time of last modification.

public setLastModifiedDateTime(DateTime $lastModifiedDateTime) : OrderInterface
Parameters
$lastModifiedDateTime : DateTime

Last modification date time

Return values
OrderInterface —

Same instance for method chaining.

setPurchaseDateTime()

Sets the order purchase date time.

public setPurchaseDateTime(DateTime $dateTime) : OrderInterface
Parameters
$dateTime : DateTime

Purchase date time.

Return values
OrderInterface —

Same instance for method chaining.

Search results