OrderQuery

Type: Class
Namespace: craft\commerce\elements\db
Inherits: craft\commerce\elements\db\OrderQuery » craft\elements\db\ElementQuery » craft\db\Query » yii\db\Query » yii\base\Component » yii\base\BaseObject
Implements: ArrayAccess, IteratorAggregate, craft\elements\db\ElementQueryInterface, yii\base\Configurable, yii\db\ExpressionInterface, yii\db\QueryInterface
Uses traits: craft\base\ClonefixTrait, yii\base\ArrayableTrait, yii\db\QueryTrait
Since: 2.0

OrderQuery represents a SELECT SQL statement for orders in a way that is independent of DBMS.

Public Properties

Property	Description
ancestorDist	integer, null – The maximum number of levels that results may be separated from ancestorOf().
ancestorOf	integer, craft\base\ElementInterface, null – The element (or its ID) that results must be an ancestor of.
archived	boolean – Whether to return only archived elements.
asArray	boolean – Whether to return each element as an array.
behaviors	yii\base\Behavior – List of behaviors attached to this component.
cacheTags	string[]
cachedResult	`\craft\elements\db\TElement[]`, null – $elements The resulting elements, or null if setCachedResult() was never called or the criteria has changed
criteria	array
customFields	craft\base\FieldInterface, null – The fields that may be involved in this query.
customerId	`mixed` – The user ID that the resulting orders must have.
dateAuthorized	`mixed` – The date the order was authorized in full.
dateCreated	`mixed` – When the resulting elements must have been created.
dateOrdered	`mixed` – The Date Ordered date that the resulting orders must have.
datePaid	`mixed` – The date the order was paid in full.
dateUpdated	`mixed` – When the resulting elements must have been last updated.
descendantDist	integer, null – The maximum number of levels that results may be separated from descendantOf().
descendantOf	integer, craft\base\ElementInterface, null – The element (or its ID) that results must be a descendant of.
distinct	boolean – Whether to select distinct rows of data only.
draftCreator	integer, null – The drafts’ creator ID
draftId	integer, null – The ID of the draft to return (from the `drafts` table)
draftOf	`mixed` – The source element ID that drafts should be returned for.
drafts	boolean, null – Whether draft elements should be returned.
eagerLoadAlias	string, null – The eager-loading alias that should be used.
eagerLoadHandle	string, null – The handle that could be used to eager-load the query's target elmeents.
eagerLoadSourceElement	craft\base\ElementInterface, null – The source element that this query is fetching relations for.
eagerly	boolean – Whether the query should be used to eager-load results for the `$eagerSourceElement` and any other elements in its collection.
elementType	string – The name of the craft\base\ElementInterface class.
email	`mixed` – The email address the resulting orders must have.
emulateExecution	boolean – Whether to emulate the actual query execution, returning empty or false results.
expiryDate	`mixed` – The Expiry Date that the resulting orders must have.
fixedOrder	boolean – Whether results should be returned in the order specified by id().
from	array, null – The table(s) to be selected from.
gatewayId	`mixed` – The gateway ID that the resulting orders must have.
groupBy	array, null – How to group the query results.
hasDescendants	boolean, null – Whether the resulting elements must have descendants.
hasLineItems	boolean, null – Whether the order has any line items.
hasPurchasables	`mixed` – The resulting orders must contain these Purchasables.
hasTransactions	boolean, null – Whether the order has any transactions
having	string, array, yii\db\ExpressionInterface, null – The condition to be applied in the GROUP BY clause.
id	`mixed` – The element ID(s).
ignorePlaceholders	boolean – Whether to ignore placeholder elements when populating the results.
inBulkOp	string, null – The bulk element operation key that the resulting elements were involved in.
inReverse	boolean – Whether the results should be queried in reverse.
indexBy	string, callable, null – The name of the column by which the query results should be indexed by.
isCompleted	boolean – The completion status that the resulting orders must have.
isPaid	boolean, null – Whether the order is paid
isUnpaid	boolean, null – Whether the order is unpaid
itemSubtotal	`mixed` – The subtotal price of the items resulting orders must have.
itemTotal	`mixed` – The total price of the items resulting orders must have.
iterator	ArrayIterator
join	array, null – How to join with other tables.
leaves	boolean – Whether the elements must be “leaves” in the structure.
level	`mixed` – The element’s level within the structure
limit	integer, yii\db\ExpressionInterface, null – Maximum number of records to be returned.
nextSiblingOf	integer, craft\base\ElementInterface, null – The element (or its ID) that the result must be the next sibling of.
number	`mixed` – The order number of the resulting order.
offset	integer, yii\db\ExpressionInterface, null – Zero-based offset from where the records are to be returned.
orderBy	array, null – How to sort the query results.
orderLanguage	`mixed` – The language the order was made that the resulting the order must have.
orderSiteId	`mixed` – The Order Site ID that the resulting orders must have.
orderStatusId	`mixed` – The Order Status ID that the resulting orders must have.
origin	`mixed` – The origin the resulting orders must have.
params	array, null – List of query parameter values indexed by parameter placeholders.
positionedAfter	integer, craft\base\ElementInterface, null – The element (or its ID) that the results must be positioned after.
positionedBefore	integer, craft\base\ElementInterface, null – The element (or its ID) that the results must be positioned before.
preferSites	array, null – Determines which site should be selected when querying multi-site elements.
prevSiblingOf	integer, craft\base\ElementInterface, null – The element (or its ID) that the result must be the previous sibling of.
provisionalDrafts	boolean, null – Whether provisional drafts should be returned.
query	craft\db\Query, null – The query object created by prepare()
queryCacheDependency	yii\caching\Dependency, null – The dependency to be associated with the cached query result for this query
queryCacheDuration	integer, boolean, null – The default number of seconds that query results can remain valid in cache.
rawSql	string
ref	`mixed` – The reference code(s) used to identify the element(s).
reference	`mixed` – The order reference of the resulting order.
relatedTo	`mixed` – The element relation criteria.
revisionCreator	integer, null – The revisions’ creator ID
revisionId	integer, null – The ID of the revision to return (from the `revisions` table)
revisionOf	integer, null – The source element ID that revisions should be returned for
revisions	boolean, null – Whether revision elements should be returned.
savedDraftsOnly	boolean – Whether only unpublished drafts which have been saved after initial creation should be included in the results.
search	`mixed` – The search term to filter the resulting elements by.
select	array, null – The columns being selected.
selectOption	string, null – Additional option that should be appended to the 'SELECT' keyword.
shippingMethodHandle	`mixed` – The shipping method handle the resulting orders must have.
shortNumber	`mixed` – The short order number of the resulting order.
siblingOf	integer, craft\base\ElementInterface, null – The element (or its ID) that the results must be a sibling of.
site	string, string[], craft\models\Site – The site(s) that resulting elements must be returned in
siteId	`mixed` – The site ID(s) that the elements should be returned in, or `'*'` if elements should be returned in all supported sites.
siteSettingsId	`mixed` – The element ID(s) in the `elements_sites` table.
slug	`mixed` – The slug that resulting elements must have.
status	string, string[], null – The status(es) that the resulting elements must have.
storeId	integer, null – The store ID that the resulting orders must have.
structureId	`mixed` – The structure ID that should be used to join in the structureelements table.
subQuery	craft\db\Query, null – The subselect’s query object created by prepare()
tablesUsedInFrom	string[] – Table names indexed by aliases.
title	`mixed` – The title that resulting elements must have.
total	`mixed` – The total of the order resulting orders must have.
totalDiscount	`mixed` – The total discount of the order resulting orders must have.
totalPaid	`mixed` – The total paid amount of the order resulting orders must have.
totalPrice	`mixed` – The total price of the order resulting orders must have.
totalQty	`mixed` – The total qty of the order resulting orders must have.
totalTax	`mixed` – The total tax resulting orders must have.
totalWeight	`mixed` – The total weight of the order resulting orders must have.
trashed	boolean, null – Whether to return trashed (soft-deleted) elements.
uid	`mixed` – The element UID(s).
union	array, null – This is used to construct the UNION clause(s) in a SQL statement.
unique	boolean – Whether only elements with unique IDs should be returned by the query.
uri	`mixed` – The URI that the resulting element must have.
where	string, array, yii\db\ExpressionInterface, null – Query condition.
with	string, array, null – The eager-loading declaration.
withAddresses	boolean – Eager loads the shipping and billing addressees on the resulting orders.
withAdjustments	boolean – Eager loads the order adjustments on the resulting orders.
withAll	boolean – Eager loads all relational data (addresses, adjustments, users, line items, transactions) for the resulting orders.
withCustomFields	boolean – Whether custom fields should be factored into the query.
withCustomer	boolean – Eager load the user on to the order.
withLineItems	boolean – Eager loads the line items on the resulting orders.
withQueries	array, null – This is used to construct the WITH section in a SQL query.
withStructure	boolean, null – Whether element structure data should automatically be left-joined into the query.
withTransactions	boolean – Eager loads the transactions on the resulting orders.

`customerId`

Type: mixed
Default value: null

The user ID that the resulting orders must have.

View source

`dateAuthorized`

Type: mixed
Default value: null

The date the order was authorized in full.

View source

`dateOrdered`

Type: mixed
Default value: null

The Date Ordered date that the resulting orders must have.

View source

`datePaid`

Type: mixed
Default value: null

The date the order was paid in full.

View source

`email`

Type: mixed
Default value: null

The email address the resulting orders must have.

View source

`expiryDate`

Type: mixed
Default value: null

The Expiry Date that the resulting orders must have.

View source

`gatewayId`

Type: mixed
Default value: null

The gateway ID that the resulting orders must have.

View source

`hasLineItems`

Type: boolean, null
Default value: null

Whether the order has any line items.

View source

`hasPurchasables`

Type: mixed
Default value: null

The resulting orders must contain these Purchasables.

View source

`hasTransactions`

Type: boolean, null
Default value: null

Whether the order has any transactions

View source

`isCompleted`

Type: boolean
Default value: null

The completion status that the resulting orders must have.

View source

`isPaid`

Type: boolean, null
Default value: null

Whether the order is paid

View source

`isUnpaid`

Type: boolean, null
Default value: null

Whether the order is unpaid

View source

`itemSubtotal`

Type: mixed
Default value: null
Since: 4.2.0

The subtotal price of the items resulting orders must have.

View source

`itemTotal`

Type: mixed
Default value: null
Since: 4.2.0

The total price of the items resulting orders must have.

View source

`number`

Type: mixed
Default value: null

The order number of the resulting order.

View source

`orderLanguage`

Type: mixed
Default value: null

The language the order was made that the resulting the order must have.

View source

`orderSiteId`

Type: mixed
Default value: null

The Order Site ID that the resulting orders must have.

View source

`orderStatusId`

Type: mixed
Default value: null

The Order Status ID that the resulting orders must have.

View source

`origin`

Type: mixed
Default value: null

The origin the resulting orders must have.

View source

`reference`

Type: mixed
Default value: null

The order reference of the resulting order.

View source

`shippingMethodHandle`

Type: mixed
Default value: null
Since: 4.2.0

The shipping method handle the resulting orders must have.

View source

`shortNumber`

Type: mixed
Default value: null

The short order number of the resulting order.

View source

`storeId`

Type: integer, null
Default value: null

The store ID that the resulting orders must have.

View source

`total`

Type: mixed
Default value: null
Since: 4.2.0

The total of the order resulting orders must have.

View source

`totalDiscount`

Type: mixed
Default value: null
Since: 4.2.0

The total discount of the order resulting orders must have.

View source

`totalPaid`

Type: mixed
Default value: null
Since: 4.2.0

The total paid amount of the order resulting orders must have.

View source

`totalPrice`

Type: mixed
Default value: null
Since: 4.2.0

The total price of the order resulting orders must have.

View source

`totalQty`

Type: mixed
Default value: null
Since: 4.2.0

The total qty of the order resulting orders must have.

View source

`totalTax`

Type: mixed
Default value: null
Since: 4.2.0

The total tax resulting orders must have.

View source

`totalWeight`

Type: mixed
Default value: null
Since: 5.0.0

The total weight of the order resulting orders must have.

View source

`withAddresses`

Type: boolean
Default value: false

Eager loads the shipping and billing addressees on the resulting orders.

View source

`withAdjustments`

Type: boolean
Default value: false

Eager loads the order adjustments on the resulting orders.

View source

`withAll`

Type: boolean
Default value: false

Eager loads all relational data (addresses, adjustments, users, line items, transactions) for the resulting orders.

View source

`withCustomer`

Type: boolean
Default value: false

Eager load the user on to the order.

View source

`withLineItems`

Type: boolean
Default value: false

Eager loads the line items on the resulting orders.

View source

`withTransactions`

Type: boolean
Default value: false

Eager loads the transactions on the resulting orders.

View source

Protected Properties

Property	Description
defaultOrderBy	array – The default orderBy() value to use if orderBy() is empty but not null.

`defaultOrderBy`

Type: array
Default value: [ 'commerce_orders.id' => SORT_ASC, ]

The default orderBy() value to use if orderBy() is empty but not null.

View source

Public Methods

Method	Description
__call()	Calls the named method which is not a class method.
__clone()	This method is called after the object is created by cloning an existing one.
__construct()	Constructor
__get()	Returns the value of a component property.
__isset()	Checks if a property is set, i.e. defined and not null.
__set()	Sets the value of a component property.
__toString()	Returns the SQL representation of Query
__unset()	Sets a component property to be null.
addGroupBy()	Adds additional group-by columns to the existing ones.
addOrderBy()	Adds additional ORDER BY columns to the query.
addParams()	Adds additional parameters to be bound to the query.
addSelect()	Add more columns to the SELECT part of the query.
afterPopulate()	Performs any post-population processing on elements.
all()
ancestorDist()	Narrows the query results to only {elements} that are up to a certain distance away from the {element} specified by ancestorOf().
ancestorOf()	Narrows the query results to only {elements} that are ancestors of another {element} in its structure.
andFilterCompare()	Adds a filtering condition for a specific column and allow the user to choose a filter operator.
andFilterHaving()	Adds an additional HAVING condition to the existing one but ignores empty operands.
andFilterWhere()	Adds an additional WHERE condition to the existing one but ignores empty operands.
andHaving()	Adds an additional HAVING condition to the existing one.
andRelatedTo()	Narrows the query results to only {elements} that are related to certain other elements.
andWhere()	Adds an additional WHERE condition to the existing one.
andWith()	Causes the query to return matching {elements} eager-loaded with related elements, in addition to the elements that were already specified by with().
anyStatus()	Sets the status param to `null`.
archived()	Sets the archived property.
asArray()	Causes the query to return matching {elements} as arrays of data, rather than [[{element-class}]] objects.
attachBehavior()	Attaches a behavior to this component.
attachBehaviors()	Attaches a list of behaviors to the component.
average()	Returns the average of the specified column values.
batch()	Starts a batch query.
behaviors()	Returns a list of behaviors that this component should behave as.
cache()	Enables query cache for this Query.
canGetProperty()	Returns a value indicating whether a property can be read.
canSetProperty()	Returns a value indicating whether a property can be set.
className()	Returns the fully qualified name of this class.
clearCachedResult()	Clears the cached result.
collect()
column()	Executes the query and returns the first column of the result.
count()	Returns the number of records.
create()	Creates a new Query object and copies its property values from an existing one.
createCommand()	Creates a DB command that can be used to execute this query.
createElement()	Converts a found row into an element instance.
criteriaAttributes()	Returns the query's criteria attributes.
customer()	Narrows the query results based on the customer’s user account.
customerId()	Narrows the query results based on the customer, per their user ID.
dateAuthorized()	Narrows the query results based on the orders’ authorized dates.
dateCreated()	Narrows the query results based on the {elements}’ creation dates.
dateOrdered()	Narrows the query results based on the orders’ completion dates.
datePaid()	Narrows the query results based on the orders’ paid dates.
dateUpdated()	Narrows the query results based on the {elements}’ last-updated dates.
descendantDist()	Narrows the query results to only {elements} that are up to a certain distance away from the {element} specified by descendantOf().
descendantOf()	Narrows the query results to only {elements} that are descendants of another {element} in its structure.
detachBehavior()	Detaches a behavior from the component.
detachBehaviors()	Detaches all behaviors from the component.
distinct()	Sets the value indicating whether to SELECT DISTINCT or not.
draftCreator()	Narrows the query results to only drafts created by a given user.
draftId()	Narrows the query results based on the {elements}’ draft’s ID (from the `drafts` table).
draftOf()	Narrows the query results to only drafts of a given {element}.
drafts()	Narrows the query results to only drafts {elements}.
each()	Starts a batch query and retrieves data row by row.
eagerly()	Causes the query to be used to eager-load results for the query’s source element and any other elements in its collection.
email()	Narrows the query results based on the customers’ email addresses.
emulateExecution()	Sets whether to emulate query execution, preventing any interaction with data storage.
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.
exists()	Returns a value indicating whether the query result contains any row of data.
expiryDate()	Narrows the query results based on the orders’ expiry dates.
extraFields()	Returns the list of fields that can be expanded further and returned by toArray().
fields()	Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
filterHaving()	Sets the HAVING part of the query but ignores empty operands.
filterWhere()	Sets the WHERE part of the query but ignores empty operands.
fixedOrder()	Causes the query results to be returned in the order specified by id().
from()	Sets the FROM part of the query.
gateway()	Narrows the query results based on the gateway.
gatewayId()	Narrows the query results based on the gateway, per its ID.
getBehavior()	Returns the named behavior object.
getBehaviors()	Returns all behaviors attached to this component.
getCacheTags()
getCachedResult()	Returns the resulting elements set by setCachedResult(), if the criteria params haven’t changed since then.
getCriteria()	Returns an array of the current criteria attribute values.
getIterator()	Required by the IteratorAggregate interface.
getRawSql()	Shortcut for `createCommand()->getRawSql()`.
getTablesUsedInFrom()	Returns table names used in from() indexed by aliases.
groupBy()	Sets the GROUP BY part of the query.
hasDescendants()	Narrows the query results based on whether the {elements} have any descendants in their structure.
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.
hasLineItems()	Narrows the query results to only orders that have line items.
hasMethod()	Returns a value indicating whether a method is defined.
hasProperty()	Returns a value indicating whether a property is defined for this component.
hasPurchasables()	Narrows the query results to only orders that have certain purchasables.
hasTransactions()	Narrows the query results to only carts that have at least one transaction.
having()	Sets the HAVING part of the query.
id()
ids()	Executes the query and returns the IDs of the resulting elements.
ignorePlaceholders()	Causes the query to return matching {elements} as they are stored in the database, ignoring matching placeholder elements that were set by craft\services\Elements::setPlaceholderElement().
inBulkOp()	Narrows the query results to only {elements} that were involved in a bulk element operation.
inReverse()	Causes the query results to be returned in reverse order.
indexBy()	Sets the indexBy() property.
init()	Initializes the object.
innerJoin()	Appends an INNER JOIN part to the query.
isCompleted()	Narrows the query results to only orders that are completed.
isJoined()	Returns whether a given table has been joined in this query.
isPaid()	Narrows the query results to only orders that are paid.
isUnpaid()	Narrows the query results to only orders that are not paid.
itemSubtotal()	Narrows the query results based on the order’s item subtotal.
itemTotal()	Narrows the query results based on the order’s item total.
join()	Appends a JOIN part to the query.
language()	Determines which site(s) the {elements} should be queried in, based on their language.
leaves()	Narrows the query results based on whether the {elements} are “leaves” ({elements} with no descendants).
leftJoin()	Appends a LEFT OUTER JOIN part to the query.
level()	Narrows the query results based on the {elements}’ level within the structure.
limit()	Determines the number of {elements} that should be returned.
max()	Returns the maximum of the specified column values.
min()	Returns the minimum of the specified column values.
nextSiblingOf()	Narrows the query results to only the {element} that comes immediately after another {element} in its structure.
noCache()	Disables query cache for this Query.
nth()
number()	Narrows the query results based on the order number.
off()	Detaches an existing event handler from this component.
offset()	Determines how many {elements} should be skipped in the results.
offsetExists()	Required by the ArrayAccess interface.
offsetGet()	Required by the ArrayAccess interface.
offsetSet()	Required by the ArrayAccess interface.
offsetUnset()	Required by the ArrayAccess interface.
on()	Attaches an event handler to an event.
one()
orFilterHaving()	Adds an additional HAVING condition to the existing one but ignores empty operands.
orFilterWhere()	Adds an additional WHERE condition to the existing one but ignores empty operands.
orHaving()	Adds an additional HAVING condition to the existing one.
orWhere()	Adds an additional WHERE condition to the existing one.
orderBy()
orderLanguage()	Narrows the query results based on the order language, per the language string provided.
orderSiteId()	Narrows the query results based on the order language, per the language string provided.
orderStatus()	Narrows the query results based on the order statuses.
orderStatusId()	Narrows the query results based on the order statuses, per their IDs.
origin()	Narrows the query results based on the origin.
pairs()	Executes the query and returns the first two columns in the results as key/value pairs.
params()	Sets the parameters to be bound to the query.
populate()	Converts the raw query results into the format as specified by this query.
positionedAfter()	Narrows the query results to only {elements} that are positioned after another {element} in its structure.
positionedBefore()	Narrows the query results to only {elements} that are positioned before another {element} in its structure.
preferSites()	If unique() is set, this determines which site should be selected when querying multi-site elements.
prepForEagerLoading()	Prepares the query for lazy eager loading.
prepare()	Prepares for building SQL.
prepareSubquery()	Prepares the element query and returns its subquery (which determines what elements will be returned).
prevSiblingOf()	Narrows the query results to only the {element} that comes immediately before another {element} in its structure.
provisionalDrafts()	Narrows the query results to only provisional drafts.
ref()	Narrows the query results based on a reference string.
reference()	Narrows the query results based on the order reference.
relatedTo()	Narrows the query results to only {elements} that are related to certain other elements.
render()	Executes the query and renders the resulting elements using their partial templates.
revisionCreator()	Narrows the query results to only revisions created by a given user.
revisionId()	Narrows the query results based on the {elements}’ revision’s ID (from the `revisions` table).
revisionOf()	Narrows the query results to only revisions of a given {element}.
revisions()	Narrows the query results to only revision {elements}.
rightJoin()	Appends a RIGHT OUTER JOIN part to the query.
savedDraftsOnly()	Narrows the query results to only unpublished drafts which have been saved after initial creation.
scalar()	Returns the query result as a scalar value.
search()	Narrows the query results to only {elements} that match a search query.
select()	Sets the SELECT part of the query.
setCachedResult()	Sets the resulting elements.
shippingMethodHandle()	Narrows the query results based on the shipping method handle.
shortNumber()	Narrows the query results based on the order short number.
siblingOf()	Narrows the query results to only {elements} that are siblings of another {element} in its structure.
site()	Determines which site(s) the {elements} should be queried in.
siteId()	Determines which site(s) the {elements} should be queried in, per the site’s ID.
siteSettingsId()	Narrows the query results based on the {elements}’ IDs in the `elements_sites` table.
slug()	Narrows the query results based on the {elements}’ slugs.
status()
storeId()	Narrows the query results to only orders that are related to the given store.
structureId()	Determines which structure data should be joined into the query.
sum()	Returns the sum of the specified column values.
title()	Narrows the query results based on the {elements}’ titles.
toArray()	Converts the model into an array.
total()	Narrows the query results based on the total.
totalDiscount()	Narrows the query results based on the total discount.
totalPaid()	Narrows the query results based on the total paid amount.
totalPrice()	Narrows the query results based on the total price.
totalQty()	Narrows the query results based on the total qty of items.
totalTax()	Narrows the query results based on the total tax.
totalWeight()	Narrows the query results based on the total weight of items.
trashed()	Narrows the query results to only {elements} that have been soft-deleted.
trigger()	Triggers an event.
uid()	Narrows the query results based on the {elements}’ UIDs.
union()	Appends a SQL statement using UNION operator.
unique()	Determines whether only elements with unique IDs should be returned by the query.
uri()	Narrows the query results based on the {elements}’ URIs.
user()	Narrows the query results based on the customer’s user account.
wasCountEagerLoaded()	Returns whether the query result count was already eager loaded by the query's source element.
wasEagerLoaded()	Returns whether the query results were already eager loaded by the query's source element.
where()	Sets the WHERE part of the query.
with()	Causes the query to return matching {elements} eager-loaded with related elements.
withAddresses()	Eager loads the shipping and billing addressees on the resulting orders.
withAdjustments()	Eager loads the order adjustments on the resulting orders.
withAll()	Eager loads all relational data (addresses, adjustments, customers, line items, transactions) for the resulting orders.
withCustomFields()	Sets whether custom fields should be factored into the query.
withCustomer()	Eager loads the user on the resulting orders.
withLineItems()	Eager loads the line items on the resulting orders.
withQuery()	Prepends a SQL statement using WITH syntax.
withStructure()	Explicitly determines whether the query should join in the structure data.
withTransactions()	Eager loads the transactions on the resulting orders.

`__construct()`

Constructor

View source

Arguments

$elementType (string) – The element type class associated with this query
$config (array) – Configurations to be applied to the newly created query object

`all()`

View source

Arguments

$db

Returns

craft\commerce\elements\Order[], array –

`customer()`

Narrows the query results based on the customer’s user account.

Possible values include:

Value	Fetches {elements}…
`1`	with a customer with a user account ID of 1.
a User object	with a customer with a user account represented by the object.
`'not 1'`	not the user account with an ID 1.
`[1, 2]`	with an user account ID of 1 or 2.
`['not', 1, 2]`	not with a user account ID of 1 or 2.

View source

Arguments

$value (craft\elements\User, integer, null) – The property value

Returns

static – Self reference

Example

twigphp

twig

{# Fetch the current user's orders #}
{% set {elements-var} = {twig-method}
  .customer(currentUser)
  .all() %}

php

// Fetch the current user's orders
$user = Craft::$app->user->getIdentity();
${elements-var} = {php-method}
    ->customer($user)
    ->all();

`customerId()`

Narrows the query results based on the customer, per their user ID.

Possible values include:

Value	Fetches {elements}…
`1`	with a user with an ID of 1.
`'not 1'`	not with a user with an ID of 1.
`[1, 2]`	with a user with an ID of 1 or 2.
`['not', 1, 2]`	not with a user with an ID of 1 or 2.

View source

Arguments

$value (mixed) – The property value

Returns

static – Self reference

Example

twigphp

twig

{# Fetch the current user's orders #}
{% set {elements-var} = {twig-method}
  .customerId(currentUser.id)
  .all() %}

php

// Fetch the current user's orders
$user = Craft::$app->user->getIdentity();
${elements-var} = {php-method}
    ->customerId($user->id)
    ->all();

`dateAuthorized()`

Narrows the query results based on the orders’ authorized dates.

Possible values include:

Value	Fetches {elements}…
`'>= 2018-04-01'`	that were authorized on or after 2018-04-01.
`'< 2018-05-01'`	that were authorized before 2018-05-01
`['and', '>= 2018-04-04', '< 2018-05-01']`	that were completed between 2018-04-01 and 2018-05-01.

View source

Arguments

$value (mixed) – The property value

Returns

static – Self reference

Example

twigphp

twig

{# Fetch {elements} that were authorized recently #}
{% set aWeekAgo = date('7 days ago')|atom %}

{% set {elements-var} = {twig-method}
  .dateAuthorized(">= #{aWeekAgo}")
  .all() %}

php

// Fetch {elements} that were authorized recently
$aWeekAgo = new \DateTime('7 days ago')->format(\DateTime::ATOM);

${elements-var} = {php-method}
    ->dateAuthorized(">= {$aWeekAgo}")
    ->all();

`dateOrdered()`

Narrows the query results based on the orders’ completion dates.

Possible values include:

Value	Fetches {elements}…
`'>= 2018-04-01'`	that were completed on or after 2018-04-01.
`'< 2018-05-01'`	that were completed before 2018-05-01
`['and', '>= 2018-04-04', '< 2018-05-01']`	that were completed between 2018-04-01 and 2018-05-01.

View source

Arguments

$value (mixed) – The property value

Returns

static – Self reference

Example

twigphp

twig

{# Fetch {elements} that were completed recently #}
{% set aWeekAgo = date('7 days ago')|atom %}

{% set {elements-var} = {twig-method}
  .dateOrdered(">= #{aWeekAgo}")
  .all() %}

php

// Fetch {elements} that were completed recently
$aWeekAgo = new \DateTime('7 days ago')->format(\DateTime::ATOM);

${elements-var} = {php-method}
    ->dateOrdered(">= {$aWeekAgo}")
    ->all();

`datePaid()`

Narrows the query results based on the orders’ paid dates.

Possible values include:

Value	Fetches {elements}…
`'>= 2018-04-01'`	that were paid on or after 2018-04-01.
`'< 2018-05-01'`	that were paid before 2018-05-01
`['and', '>= 2018-04-04', '< 2018-05-01']`	that were completed between 2018-04-01 and 2018-05-01.

View source

Arguments

$value (mixed) – The property value

Returns

static – Self reference

Example

twigphp

twig

{# Fetch {elements} that were paid for recently #}
{% set aWeekAgo = date('7 days ago')|atom %}

{% set {elements-var} = {twig-method}
  .datePaid(">= #{aWeekAgo}")
  .all() %}

php

// Fetch {elements} that were paid for recently
$aWeekAgo = new \DateTime('7 days ago')->format(\DateTime::ATOM);

${elements-var} = {php-method}
    ->datePaid(">= {$aWeekAgo}")
    ->all();

`email()`

Narrows the query results based on the customers’ email addresses.

Possible values include:

Value	Fetches {elements} with customers…
`'foo@bar.baz'`	with an email of `foo@bar.baz`.
`'not foo@bar.baz'`	not with an email of `foo@bar.baz`.
`'*@bar.baz'`	with an email that ends with `@bar.baz`.

View source

Arguments

$value (string, string[], null) – The property value

Returns

static – Self reference

Example

twigphp

twig

{# Fetch orders from customers with a .co.uk domain on their email address #}
{% set {elements-var} = {twig-method}
  .email('*.co.uk')
  .all() %}

php

// Fetch orders from customers with a .co.uk domain on their email address
${elements-var} = {php-method}
    ->email('*.co.uk')
    ->all();

`expiryDate()`

Narrows the query results based on the orders’ expiry dates.

Possible values include:

Value	Fetches {elements}…
`'>= 2020-04-01'`	that will expire on or after 2020-04-01.
`'< 2020-05-01'`	that will expire before 2020-05-01
`['and', '>= 2020-04-04', '< 2020-05-01']`	that will expire between 2020-04-01 and 2020-05-01.

View source

Arguments

$value (mixed) – The property value

Returns

static – Self reference

Example

twigphp

twig

{# Fetch {elements} expiring this month #}
{% set nextMonth = date('first day of next month')|atom %}

{% set {elements-var} = {twig-method}
  .expiryDate("< #{nextMonth}")
  .all() %}

php

// Fetch {elements} expiring this month
$nextMonth = new \DateTime('first day of next month')->format(\DateTime::ATOM);

${elements-var} = {php-method}
    ->expiryDate("< {$nextMonth}")
    ->all();

`gateway()`

Narrows the query results based on the gateway.

Possible values include:

Value	Fetches {elements}…
a Gateway object	with a gateway represented by the object.

View source

Arguments

$value (craft\commerce\base\GatewayInterface, null) – The property value

Returns

static – Self reference

`gatewayId()`

Narrows the query results based on the gateway, per its ID.

Possible values include:

Value	Fetches {elements}…
`1`	with a gateway with an ID of 1.
`'not 1'`	not with a gateway with an ID of 1.
`[1, 2]`	with a gateway with an ID of 1 or 2.
`['not', 1, 2]`	not with a gateway with an ID of 1 or 2.

View source

Arguments

$value (mixed) – The property value

Returns

static – Self reference

`hasLineItems()`

Narrows the query results to only orders that have line items.

View source

Arguments

$value (boolean, null) – The property value

Returns

static – Self reference

Example

twigphp

twig

{# Fetch orders that do or do not have line items #}
{% set {elements-var} = {twig-method}
  .hasLineItems()
  .all() %}

php

// Fetch unpaid orders
${elements-var} = {element-class}::find()
    ->hasLineItems()
    ->all();

`hasPurchasables()`

Narrows the query results to only orders that have certain purchasables.

Possible values include:

Value	Fetches {elements}…
a PurchasableInterface object	with a purchasable represented by the object.
an array of PurchasableInterface objects	with all the purchasables represented by the objects.

View source

Arguments

$value (craft\commerce\base\PurchasableInterface, array<int,int|\craft\commerce\base\PurchasableInterface>, null) – The property value

Returns

static – Self reference

`hasTransactions()`

Narrows the query results to only carts that have at least one transaction.

View source

Arguments

$value (boolean, null) – The property value

Returns

static – Self reference

Example

twigphp

twig

{# Fetch carts that have attempted payments #}
{% set {elements-var} = {twig-method}
  .hasTransactions()
  .all() %}

php

// Fetch carts that have attempted payments
${elements-var} = {element-class}::find()
    ->hasTransactions()
    ->all();

`id()`

View source

Arguments

$value

Returns

self –

`isCompleted()`

Narrows the query results to only orders that are completed.

View source

Arguments

$value (boolean) – The property value

Returns

static – Self reference

Example

twigphp

twig

{# Fetch completed orders #}
{% set {elements-var} = {twig-method}
  .isCompleted()
  .all() %}

php

// Fetch completed orders
${elements-var} = {element-class}::find()
    ->isCompleted()
    ->all();

`isPaid()`

Narrows the query results to only orders that are paid.

View source

Arguments

$value (boolean, null) – The property value

Returns

static – Self reference

Example

twigphp

twig

{# Fetch paid orders #}
{% set {elements-var} = {twig-method}
  .isPaid()
  .all() %}

php

// Fetch paid orders
${elements-var} = {element-class}::find()
    ->isPaid()
    ->all();

`isUnpaid()`

Narrows the query results to only orders that are not paid.

View source

Arguments

$value (boolean, null) – The property value

Returns

static – Self reference

Example

twigphp

twig

{# Fetch unpaid orders #}
{% set {elements-var} = {twig-method}
  .isUnpaid()
  .all() %}

php

// Fetch unpaid orders
${elements-var} = {element-class}::find()
    ->isUnpaid()
    ->all();

`itemSubtotal()`

Since: 4.2.0

Narrows the query results based on the order’s item subtotal.

Possible values include:

Value	Fetches {elements}…
`100`	with an item subtotal of $100.
`'< 1000000'`	with an item subtotal of less than $1,000,000.
`['>= 10', '< 100']`	with an item subtotal of between $10 and $100.

View source

Arguments

$value (mixed) – The property value

Returns

static – Self reference

`itemTotal()`

Since: 4.2.0

Narrows the query results based on the order’s item total.

Possible values include:

Value	Fetches {elements}…
`100`	with an item total of $100.
`'< 1000000'`	with an item total of less than $1,000,000.
`['>= 10', '< 100']`	with an item total of between $10 and $100.

View source

Arguments

$value (mixed) – The property value

Returns

static – Self reference

`nth()`

View source

Arguments

$n
$db

Returns

craft\commerce\elements\Order, array, null –

`number()`

Narrows the query results based on the order number.

Possible values include:

Value	Fetches {elements}…
`'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'`	with a matching order number

View source

Arguments

$value (string, array, null) – The property value.

Returns

static – Self reference

Example

twigphp

twig

{# Fetch the requested {element} #}
{% set orderNumber = craft.app.request.getQueryParam('number') %}
{% set {element-var} = {twig-method}
  .number(orderNumber)
  .one() %}

php

// Fetch the requested {element}
$orderNumber = Craft::$app->request->getQueryParam('number');
${element-var} = {php-method}
    ->number($orderNumber)
    ->one();

`one()`

View source

Arguments

$db

Returns

craft\commerce\elements\Order, array, null –

`orderBy()`

View source

Arguments

$columns

Returns

self –

`orderLanguage()`

Narrows the query results based on the order language, per the language string provided.

Possible values include:

Value	Fetches {elements}…
`'en'`	with an order language that is `'en'`.
`'not en'`	not with an order language that is not `'en'`.
`['en', 'en-us']`	with an order language that is `'en'` or `'en-us'`.
`['not', 'en']`	not with an order language that is not `'en'`.

View source

Arguments

$value (mixed) – The property value

Returns

static – Self reference

Example

twigphp

twig

{# Fetch {elements} with an order language that is `'en'` #}
{% set {elements-var} = {twig-method}
  .orderLanguage('en')
  .all() %}

php

// Fetch {elements} with an order language that is `'en'`
${elements-var} = {php-method}
    ->orderLanguage('en')
    ->all();

`orderSiteId()`

Narrows the query results based on the order language, per the language string provided.

Possible values include:

Value	Fetches {elements}…
`1`	with an order site ID of 1.
`'not 1'`	not with an order site ID that is no 1.
`[1, 2]`	with an order site ID of 1 or 2.
`['not', 1, 2]`	not with an order site ID of 1 or 2.

View source

Arguments

$value (mixed) – The property value

Returns

static – Self reference

Example

twigphp

twig

{# Fetch {elements} with an order site ID of 1 #}
{% set {elements-var} = {twig-method}
  .orderSiteId(1)
  .all() %}

php

// Fetch {elements} with an order site ID of 1
${elements-var} = {php-method}
    ->orderSiteId(1)
    ->all();

`orderStatus()`

Narrows the query results based on the order statuses.

Possible values include:

Value	Fetches {elements}…
`'foo'`	with an order status with a handle of `foo`.
`'not foo'`	not with an order status with a handle of `foo`.
`['foo', 'bar']`	with an order status with a handle of `foo` or `bar`.
`['not', 'foo', 'bar']`	not with an order status with a handle of `foo` or `bar`.
a OrderStatus object	with an order status represented by the object.

View source

Arguments

$value (string, string[], craft\commerce\models\OrderStatus, null) – The property value

Returns

static – Self reference

Example

twigphp

twig

{# Fetch shipped {elements} #}
{% set {elements-var} = {twig-method}
  .orderStatus('shipped')
  .all() %}

php

// Fetch shipped {elements}
${elements-var} = {php-method}
    ->orderStatus('shipped')
    ->all();

`orderStatusId()`

Narrows the query results based on the order statuses, per their IDs.

Possible values include:

Value	Fetches {elements}…
`1`	with an order status with an ID of 1.
`'not 1'`	not with an order status with an ID of 1.
`[1, 2]`	with an order status with an ID of 1 or 2.
`['not', 1, 2]`	not with an order status with an ID of 1 or 2.

View source

Arguments

$value (mixed) – The property value

Returns

static – Self reference

Example

twigphp

twig

{# Fetch {elements} with an order status with an ID of 1 #}
{% set {elements-var} = {twig-method}
  .orderStatusId(1)
  .all() %}

php

// Fetch {elements} with an order status with an ID of 1
${elements-var} = {php-method}
    ->orderStatusId(1)
    ->all();

`origin()`

Narrows the query results based on the origin.

Possible values include:

Value	Fetches {elements}…
`'web'`	with an origin of `web`.
`'not remote'`	not with an origin of `remote`.
`['web', 'cp']`	with an order origin of `web` or `cp`.
`['not', 'remote', 'cp']`	not with an origin of `web` or `cp`.

View source

Arguments

$value (string, string[], null) – The property value

Returns

static – Self reference

Example

twigphp

twig

{# Fetch shipped {elements} #}
{% set {elements-var} = {twig-method}
  .origin('web')
  .all() %}

php

// Fetch shipped {elements}
${elements-var} = {php-method}
    ->origin('web')
    ->all();

`populate()`

Converts the raw query results into the format as specified by this query.

This method is internally used to convert the data fetched from database into the format as required by this query.

View source

Arguments

$rows (array) – The raw query result from database

Returns

\craft\elements\db\TElement[], array – The resulting elements.

`reference()`

Narrows the query results based on the order reference.

Possible values include:

Value	Fetches {elements}…
`'Foo'`	with a reference of `Foo`.
`'Foo*'`	with a reference that begins with `Foo`.
`'*Foo'`	with a reference that ends with `Foo`.
`'Foo'`	with a reference that contains `Foo`.
`'not Foo'`	with a reference that doesn’t contain `Foo`.
`['Foo', 'Bar']`	with a reference that contains `Foo` or `Bar`.
`['not', 'Foo', 'Bar']`	with a reference that doesn’t contain `Foo` or `Bar`.

View source

Arguments

$value (string, null) – The property value

Returns

static – Self reference

Example

twigphp

twig

{# Fetch the requested {element} #}
{% set orderReference = craft.app.request.getQueryParam('ref') %}
{% set {element-var} = {twig-method}
  .reference(orderReference)
  .one() %}

php

// Fetch the requested {element}
$orderReference = Craft::$app->request->getQueryParam('ref');
${element-var} = {php-method}
    ->reference($orderReference)
    ->one();

`shippingMethodHandle()`

Narrows the query results based on the shipping method handle.

Possible values include:

Value	Fetches {elements}…
`'foo'`	with a shipping method with a handle of `foo`.
`'not foo'`	not with a shipping method with a handle of `foo`.
`['foo', 'bar']`	with a shipping method with a handle of `foo` or `bar`.
`['not', 'foo', 'bar']`	not with a shipping method with a handle of `foo` or `bar`.
a `\craft\commerce\elements\db\ShippingMethod` object	with a shipping method represented by the object.

View source

Arguments

$value (string, string[], null) – The property value

Returns

static – Self reference

Example

twigphp

twig

{# Fetch collection shipping method {elements} #}
{% set {elements-var} = {twig-method}
  .shippingMethodHandle('collection')
  .all() %}

php

// Fetch collection shipping method {elements}
${elements-var} = {php-method}
    ->shippingMethodHandle('collection')
    ->all();

`shortNumber()`

Since: 2.2

Narrows the query results based on the order short number.

Possible values include:

Value	Fetches {elements}…
`'xxxxxxx'`	with a matching order number

View source

Arguments

$value (string, array, null) – The property value.

Returns

static – Self reference

Example

twigphp

twig

{# Fetch the requested {element} #}
{% set orderNumber = craft.app.request.getQueryParam('shortNumber') %}
{% set {element-var} = {twig-method}
  .shortNumber(orderNumber)
  .one() %}

php

// Fetch the requested {element}
$orderNumber = Craft::$app->request->getQueryParam('shortNumber');
${element-var} = {php-method}
    ->shortNumber($orderNumber)
    ->one();

`status()`

View source

Arguments

$value

Returns

self –

`storeId()`

Narrows the query results to only orders that are related to the given store.

Possible values include:

Value	Fetches {elements}…
`1`	with a `storeId` of `1`.

View source

Arguments

$value (integer, null)

Returns

static – Self reference

`total()`

Since: 4.2.0

Narrows the query results based on the total.

Possible values include:

Value	Fetches {elements}…
`10`	with a total price of $10.
`['and', 10, 20]`	an order with a total of $10 or $20.

View source

Arguments

$value (mixed) – The property value

Returns

static – Self reference

`totalDiscount()`

Since: 4.2.0

Narrows the query results based on the total discount.

Possible values include:

Value	Fetches {elements}…
`10`	with a total discount of 10.
`[10, 20]`	an order with a total discount of 10 or 20.

View source

Arguments

$value (mixed) – The property value

Returns

static – Self reference

`totalPaid()`

Since: 4.2.0

Narrows the query results based on the total paid amount.

Possible values include:

Value	Fetches {elements}…
`10`	with a total paid amount of $10.
`['and', 10, 20]`	an order with a total paid amount of $10 or $20.

View source

Arguments

$value (mixed) – The property value

Returns

static – Self reference

`totalPrice()`

Since: 4.2.0

Narrows the query results based on the total price.

Possible values include:

Value	Fetches {elements}…
`10`	with a total price of $10.
`['and', 10, 20]`	an order with a total price of $10 or $20.

View source

Arguments

$value (mixed) – The property value

Returns

static – Self reference

`totalQty()`

Since: 4.2.0

Narrows the query results based on the total qty of items.

Possible values include:

Value	Fetches {elements}…
`10`	with a total qty of 10.
`[10, 20]`	an order with a total qty of 10 or 20.

View source

Arguments

$value (mixed) – The property value

Returns

static – Self reference

`totalTax()`

Since: 4.2.0

Narrows the query results based on the total tax.

Possible values include:

Value	Fetches {elements}…
`10`	with a total tax of 10.
`[10, 20]`	an order with a total tax of 10 or 20.

View source

Arguments

$value (mixed) – The property value

Returns

static – Self reference

`totalWeight()`

Since: 4.2.0

Narrows the query results based on the total weight of items.

Possible values include:

Value	Fetches {elements}…
`10`	with a total weight of 10.
`[10, 20]`	an order with a total weight of 10 or 20.

View source

Arguments

$value (mixed) – The property value

Returns

static – Self reference

`user()`

DEPRECATED

Deprecated since version 4.0.0: in favor of customer()

Narrows the query results based on the customer’s user account.

Possible values include:

Value	Fetches {elements}…
`1`	with a customer with a user account ID of 1.
a User object	with a customer with a user account represented by the object.

View source

Arguments

$value (craft\elements\User, integer, null) – The property value

Returns

static – Self reference

Example

twigphp

twig

{# Fetch the current user's orders #}
{% set {elements-var} = {twig-method}
  .user(currentUser)
  .all() %}

php

// Fetch the current user's orders
$user = Craft::$app->user->getIdentity();
${elements-var} = {php-method}
    ->user($user)
    ->all();

`withAddresses()`

Eager loads the shipping and billing addressees on the resulting orders.

Possible values include:

Value	Fetches addresses
bool	`true` to eager-load, `false` to not eager load.

View source

Arguments

$value (boolean) – The property value

Returns

static – Self reference

`withAdjustments()`

Eager loads the order adjustments on the resulting orders.

Possible values include:

Value	Fetches adjustments
bool	`true` to eager-load, `false` to not eager load.

View source

Arguments

$value (boolean) – The property value

Returns

static – Self reference

`withAll()`

Eager loads all relational data (addresses, adjustments, customers, line items, transactions) for the resulting orders.

Possible values include:

Value	Fetches addresses, adjustments, customers, line items, transactions
bool	`true` to eager-load, `false` to not eager load.

View source

Arguments

$value (boolean) – The property value

Returns

static – Self reference

`withCustomer()`

Eager loads the user on the resulting orders.

Possible values include:

Value	Fetches adjustments
bool	`true` to eager-load, `false` to not eager load.

View source

Arguments

$value (boolean) – The property value

Returns

static – Self reference

`withLineItems()`

Eager loads the line items on the resulting orders.

Possible values include:

Value	Fetches line items
bool	`true` to eager-load, `false` to not eager load.

View source

Arguments

$value (boolean) – The property value

Returns

static – Self reference

`withTransactions()`

Eager loads the transactions on the resulting orders.

Possible values include:

Value	Fetches transactions…
bool	`true` to eager-load, `false` to not eager load.

View source

Arguments

$value (boolean) – The property value

Returns

static – Self reference

Protected Methods

Method	Description
afterPrepare()	This method is called at the end of preparing an element query for the query builder.
beforePrepare()	This method is called at the beginning of preparing an element query for the query builder.
cacheTags()	Returns any cache invalidation tags that caches involving this element query should use as dependencies.
cleanUpTableNames()	Clean up table names and aliases Both aliases and names are enclosed into .
customFields()	Returns the fields that should take part in an upcoming elements query.
extractFieldsFor()	Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".
extractRootFields()	Extracts the root field names from nested fields.
fieldLayouts()	Returns the field layouts whose custom fields should be returned by customFields().
filterCondition()	Removes empty operands from the given query condition.
getUnaliasedColumnsFromSelect()
getUniqueColumns()	Returns unique column names excluding duplicates.
isEmpty()	Returns a value indicating whether the give value is "empty".
joinElementTable()	Joins in a table with an `id` column that has a foreign key pointing to `elements.id`.
normalizeOrderBy()	Normalizes format of ORDER BY data.
normalizeSelect()	Normalizes the SELECT columns passed to select() or addSelect().
queryScalar()	Queries a scalar value by setting select() first.
resolveFields()	Determines which fields can be returned by toArray().
setCommandCache()	Sets $command cache, if this query has enabled caching.
statusCondition()	Returns the condition that should be applied to the element query for a given status.

`beforePrepare()`

This method is called at the beginning of preparing an element query for the query builder.

The main Query object being prepared for the query builder is available via query. The subselect’s Query object being prepared is available via subQuery. The role of the subselect query is to apply conditions to the query and narrow the result set down to just the elements that should actually be returned. The role of the main query is to join in any tables that should be included in the results, and select all of the columns that should be included in the results.

View source

Returns

boolean – Whether the query should be prepared and returned to the query builder. If false, the query will be cancelled and no results will be returned.

Throws

craft\db\QueryAbortedException

controllers

actions

conditions

addresses

customers

orders

products

purchasables

transfers

users

variants

db

traits

arguments

elements

interfaces

elements

queries

resolvers

elements

types

elements

generators

input

inventory

payments

responses

subscriptions

jobs

fixtures

elements

mockclasses

assets

catalogpricing

chartjs

commercecp

commerceui

commercewidgets

coupons

deepmerge

editproduct

inventory

orderswidget

productindex

purchasablepricefield

statwidgets

transfers

variantmatrix

twig

OrderQuery ​

Public Properties ​

customerId ​

dateAuthorized ​

dateOrdered ​

datePaid ​

email ​

expiryDate ​

gatewayId ​

hasLineItems ​

hasPurchasables ​

hasTransactions ​

isCompleted ​

isPaid ​

isUnpaid ​

itemSubtotal ​

itemTotal ​

number ​

orderLanguage ​

orderSiteId ​

orderStatusId ​

origin ​

reference ​

shippingMethodHandle ​

shortNumber ​

storeId ​

total ​

totalDiscount ​

totalPaid ​

totalPrice ​

totalQty ​

OrderQuery

Public Properties

`customerId`

`dateAuthorized`

`dateOrdered`

`datePaid`

`email`

`expiryDate`

`gatewayId`

`hasLineItems`

`hasPurchasables`

`hasTransactions`

`isCompleted`

`isPaid`

`isUnpaid`

`itemSubtotal`

`itemTotal`

`number`

`orderLanguage`

`orderSiteId`

`orderStatusId`

`origin`

`reference`

`shippingMethodHandle`

`shortNumber`

`storeId`

`total`

`totalDiscount`

`totalPaid`

`totalPrice`

`totalQty`

`totalTax`

`totalWeight`

`withAddresses`

`withAdjustments`

`withAll`

`withCustomer`

`withLineItems`

`withTransactions`

Protected Properties

`defaultOrderBy`

Public Methods

`__construct()`

Arguments

`all()`

Arguments

Returns

`customer()`

Arguments

Returns

Example

`customerId()`

Arguments

Returns

Example

`dateAuthorized()`

Arguments

Returns

Example

`dateOrdered()`

Arguments

Returns

Example

`datePaid()`

Arguments

Returns

Example

`email()`

Arguments