class CustomerOrderItem extends DataModel

Order item in customer order.

Constants

TYPE_DISCOUNT

TYPE_PRODUCT

TYPE_SHIPPING

TYPE_SURCHARGE

TYPE_COUPON

Properties

protected array $fields from DataModel
protected boolean $isEncrypted from DataModel
protected Identity $configItemId
protected Identity $customerOrderId
protected Identity $id
protected Identity $productId
protected string $name
protected double $price
protected double $priceGross
protected double $quantity
protected string $sku
protected string $type
protected string $unique
protected double $vat
protected CustomerOrderItemVariation[] $variations

Methods

__construct()

Constructor

multitype:
getProperties()

Get the Model Properties

from Model
setOptions(stdClass $object = null, array $options = null)

Sets Properties with matching Array Values

from DataModel
stdClass
getPublic(array $publics = array('fields', 'isEncrypted', 'identities', '_type'))

Convert the Model into stdClass Object

from DataModel
toJson()

No description

from Model
mixed:string
getFields()

Fields Getter

from DataModel
validate()

Object Validation

from DataModel
mixed:string|NULL
getField(boolean $toWawi = false, string $key)

Get a Model Member Name

from DataModel
map(boolean $toWawi = false, stdClass $obj = null)

Object Mapping

from DataModel
getModelType()

No description

from DataModel
boolean
isEncrypted()

Encrypted Status

from DataModel
setIdentity(string $propertyName, string|null $endpoint = null, int|null $host = null)

No description

from DataModel
setProperty($name, $value, $type)

No description

from DataModel
validateType($value, $type)

No description

from DataModel
setConfigItemId(Identity $configItemId)

No description

getConfigItemId()

No description

setCustomerOrderId(Identity $customerOrderId)

No description

getCustomerOrderId()

No description

setId(Identity $id)

No description

getId()

No description

setProductId(Identity $productId)

No description

getProductId()

No description

setName(string $name)

No description

string
getName()

No description

setPrice(double $price)

No description

double
getPrice()

No description

setPriceGross(double $priceGross)

No description

double
getPriceGross()

No description

setQuantity(double $quantity)

No description

double
getQuantity()

No description

setSku(string $sku)

No description

string
getSku()

No description

setType(string $type)

No description

string
getType()

No description

setUnique(string $unique)

No description

string
getUnique()

No description

setVat(double $vat)

No description

double
getVat()

No description

setVariations(array $variations)

No description

Details

at line 156
__construct()

Constructor

in Model at line 33
multitype: getProperties()

Get the Model Properties

Return Value

multitype: string

in DataModel at line 172
Model setOptions(stdClass $object = null, array $options = null)

Sets Properties with matching Array Values

Parameters

stdClass $object
array $options

Return Value

Model

in DataModel at line 70
stdClass getPublic(array $publics = array('fields', 'isEncrypted', 'identities', '_type'))

Convert the Model into stdClass Object

Parameters

array $publics

Return Value

stdClass $object

in Model at line 115
toJson()

in DataModel at line 35
mixed:string getFields()

Fields Getter

Return Value

mixed:string

in DataModel at line 45
validate()

Object Validation

Exceptions

SchemaException

in DataModel at line 59
mixed:string|NULL getField(boolean $toWawi = false, string $key)

Get a Model Member Name

Parameters

boolean $toWawi
string $key

Return Value

mixed:string|NULL

in DataModel at line 81
map(boolean $toWawi = false, stdClass $obj = null)

Object Mapping

Parameters

boolean $toWawi
stdClass $obj Object to map

in DataModel at line 42
DataType getModelType()

Return Value

DataType

in DataModel at line 59
boolean isEncrypted()

Encrypted Status

Return Value

boolean

in DataModel at line 123
setIdentity(string $propertyName, string|null $endpoint = null, int|null $host = null)

Parameters

string $propertyName
string|null $endpoint
int|null $host

in DataModel at line 179
protected setProperty($name, $value, $type)

Parameters

$name
$value
$type

in DataModel at line 190
protected validateType($value, $type)

Parameters

$value
$type

at line 169
CustomerOrderItem setConfigItemId(Identity $configItemId)

Parameters

Identity $configItemId Optional reference to configItemId (if item is part of a configurable item)

Return Value

CustomerOrderItem

Exceptions

InvalidArgumentException if the provided argument is not of type 'Identity'.

at line 177
Identity getConfigItemId()

Return Value

Identity Optional reference to configItemId (if item is part of a configurable item)

at line 187
CustomerOrderItem setCustomerOrderId(Identity $customerOrderId)

Parameters

Identity $customerOrderId Reference to customerOrder

Return Value

CustomerOrderItem

Exceptions

InvalidArgumentException if the provided argument is not of type 'Identity'.

at line 195
Identity getCustomerOrderId()

Return Value

Identity Reference to customerOrder

at line 205
CustomerOrderItem setId(Identity $id)

Parameters

Identity $id Unique customerOrderItem id

Return Value

CustomerOrderItem

Exceptions

InvalidArgumentException if the provided argument is not of type 'Identity'.

at line 213
Identity getId()

Return Value

Identity Unique customerOrderItem id

at line 223
CustomerOrderItem setProductId(Identity $productId)

Parameters

Identity $productId Reference to product

Return Value

CustomerOrderItem

Exceptions

InvalidArgumentException if the provided argument is not of type 'Identity'.

at line 231
Identity getProductId()

Return Value

Identity Reference to product

at line 240
CustomerOrderItem setName(string $name)

Parameters

string $name Order item name

Return Value

CustomerOrderItem

at line 248
string getName()

Return Value

string Order item name

at line 257
CustomerOrderItem setPrice(double $price)

Parameters

double $price Price (net)

Return Value

CustomerOrderItem

at line 265
double getPrice()

Return Value

double Price (net)

at line 274
CustomerOrderItem setPriceGross(double $priceGross)

Parameters

double $priceGross Price (gross)

Return Value

CustomerOrderItem

at line 282
double getPriceGross()

Return Value

double PriceGross (gross)

at line 291
CustomerOrderItem setQuantity(double $quantity)

Parameters

double $quantity Quantity purchased

Return Value

CustomerOrderItem

at line 299
double getQuantity()

Return Value

double Quantity purchased

at line 308
CustomerOrderItem setSku(string $sku)

Parameters

string $sku Stock keeping Unit (unique item identifier)

Return Value

CustomerOrderItem

at line 316
string getSku()

Return Value

string Stock keeping Unit (unique item identifier)

at line 325
CustomerOrderItem setType(string $type)

Parameters

string $type

Return Value

CustomerOrderItem

at line 333
string getType()

Return Value

string

at line 342
CustomerOrderItem setUnique(string $unique)

Parameters

string $unique Optional unique Hashsum (if item is part of configurable item

Return Value

CustomerOrderItem

at line 350
string getUnique()

Return Value

string Optional unique Hashsum (if item is part of configurable item

at line 359
CustomerOrderItem setVat(double $vat)

Parameters

double $vat Value added tax

Return Value

CustomerOrderItem

at line 367
double getVat()

Return Value

double Value added tax

at line 376
CustomerOrderItem addVariation(CustomerOrderItemVariation $variation)

Parameters

CustomerOrderItemVariation $variation

Return Value

CustomerOrderItem

at line 386
CustomerOrderItem setVariations(array $variations)

Parameters

array $variations

Return Value

CustomerOrderItem

at line 395
CustomerOrderItemVariation[] getVariations()

at line 403
CustomerOrderItem clearVariations()

Return Value

CustomerOrderItem