AbstractOrder

Inheritance diagram for AbstractOrder:

Description

See also

Order

DraftOrder

Public Properties
const	MAP
Public Properties inherited from AbstractEntity
const	DIR = ''
	All subclasses must redeclare this to match their REST directory (without container). More...
const	TYPE = ''
	All subclasses must redeclare this to match their types. More...
Public Properties inherited from Data
const	MAP = []
const	PATCH = []

Public Methods
magic null Address	getBillingAddress ()
magic string	getCreatedAt ()
magic string	getCurrency ()
magic null Customer	getCustomer ()
magic string	getEmail ()
magic OrderItem[]	getLineItems ()
magic string	getName ()
magic string	getNote ()
magic array[]	getNoteAttributes ()
	name-value "hash" More...
magic null Address	getShippingAddress ()
magic string	getSubtotalPrice ()
magic string	getTags ()
magic Tax[]	getTaxLines ()
magic string	getTotalPrice ()
magic string	getTotalTax ()
magic string	getUpdatedAt ()
magic bool	hasTaxesIncluded ()
magic $this	setBillingAddress (?Address $address)
magic $this	setCurrency (string $iso4217)
magic $this	setCustomer (?Customer $customer)
magic $this	setEmail (string $email)
magic $this	setName (string $name)
magic $this	setNote (string $note)
magic $this	setNoteAttributes (array[] $hash)
magic $this	setShippingAddress (?Address $address)
magic $this	setSubtotalPrice (string $price)
magic $this	setTags (string $csv)
magic $this	setTaxesIncluded (bool $included)
magic $this	setTaxLines (Tax[] $taxes)
magic $this	setTotalPrice (string $price)
magic $this	setTotalTax (string $amount)
Public Methods inherited from AbstractEntity
string	__toString ()
null string	getId ()
string[]	getPoolKeys ()
bool	hasId ()
$this	reload ()
	Fully reloads the entity from Shopify. More...
Public Methods inherited from Data
mixed	__call (string $method, array $args)
	__construct ($caller, array $data=[])
string	serialize ()
	Dehydrated JSON encode. More...
array	toArray ()
void	unserialize ($serialized)
Public Methods inherited from MetafieldTrait
Metafield[]	getMetafields ()
Metafield	newMetafield ()
	Factory. More...

Additional Inherited Members
Protected Properties inherited from Data
Api	$api
Pool	$pool
Public Static Methods inherited from AbstractEntity
static null self	load ($caller, string $id, array $query=[])
static self[]	loadAll ($caller, string $path, array $query=[])
Protected Methods inherited from AbstractEntity
null AbstractEntity	_container ()
	The container/owner object, if any. More...
mixed	_get (string $field)
	Lazy-loads missing fields. More...
void	_onDelete ()
void	_onSave ()
void	_reload (string $field)
Protected Methods inherited from Data
mixed	_hydrate (string $class, $item)
	A factory that also hydrates / caches entities. More...
array	_select ($subject, callable $filter,... $args)
	Magic method: selectField(callable $filter) More...
$this	_setData (array $data)
	Clears all diffs and sets all data, hydrating mapped fields. More...
$this	_setField (string $field, $value)
	Sets a value, hydrating if mapped, and clears the diff. More...
Protected Methods inherited from MetafieldTrait
string	_metafieldType ()

Properties

MAP

const MAP

Initial value:

= [
        'billing_address' => Address::class,
        'customer' => Customer::class,
        'line_items' => [OrderItem::class],
        'shipping_address' => Address::class,
        'tax_lines' => [Tax::class]
    ]

Methods

getBillingAddress()

magic null Address getBillingAddress

(

)

Returns

null|Address

getCreatedAt()

magic string getCreatedAt

(

)

Returns

string

getCurrency()

magic string getCurrency

(

)

Returns

string

getCustomer()

magic null Customer getCustomer

(

)

Returns

null|Customer

getEmail()

magic string getEmail

(

)

Returns

string

getLineItems()

magic OrderItem [] getLineItems

(

)

Returns

OrderItem[]

getName()

magic string getName

(

)

Returns

string

getNote()

magic string getNote

(

)

Returns

string

getNoteAttributes()

magic array [] getNoteAttributes

(

)

name-value "hash"

Returns

array[]

getShippingAddress()

magic null Address getShippingAddress

(

)

Returns

null|Address

getSubtotalPrice()

magic string getSubtotalPrice

(

)

Returns

string

getTags()

magic string getTags

(

)

Returns

string

getTaxLines()

magic Tax [] getTaxLines

(

)

Returns

Tax[]

getTotalPrice()

magic string getTotalPrice

(

)

Returns

string

getTotalTax()

magic string getTotalTax

(

)

Returns

string

getUpdatedAt()

magic string getUpdatedAt

(

)

Returns

string

hasTaxesIncluded()

magic bool hasTaxesIncluded

(

)

Returns

bool

setBillingAddress()

magic $this setBillingAddress

(

?Address

$address

)

Returns

$this

setCurrency()

magic $this setCurrency

(

string

$iso4217

)

Returns

$this

setCustomer()

magic $this setCustomer

(

?Customer

$customer

)

Returns

$this

setEmail()

magic $this setEmail

(

string

$email

)

Returns

$this

setName()

magic $this setName

(

string

$name

)

Depends:

create-only

Returns

$this

setNote()

magic $this setNote

(

string

$note

)

Returns

$this

setNoteAttributes()

magic $this setNoteAttributes

(

array[]

$hash

)

Returns

$this

setShippingAddress()

magic $this setShippingAddress

(

?Address

$address

)

Returns

$this

setSubtotalPrice()

magic $this setSubtotalPrice

(

string

$price

)

Returns

$this

setTags()

magic $this setTags

(

string

$csv

)

Returns

$this

setTaxesIncluded()

magic $this setTaxesIncluded

(

bool

$included

)

Returns

$this

setTaxLines()

magic $this setTaxLines

(

Tax[]

$taxes

)

Returns

$this

Reimplemented in Order.

setTotalPrice()

magic $this setTotalPrice

(

string

$price

)

Returns

$this

setTotalTax()

magic $this setTotalTax

(

string

$amount

)

Returns

$this