Commerce 4 Class Reference

OrderQuery

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

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

View source (opens new window)

# Public Properties

Property Description
ancestorDist (opens new window) integer (opens new window), null (opens new window) – The maximum number of levels that results may be separated from ancestorOf() (opens new window).
ancestorOf (opens new window) integer (opens new window), craft\base\ElementInterface (opens new window), null (opens new window) – The element (or its ID) that results must be an ancestor of.
archived (opens new window) boolean (opens new window) – Whether to return only archived elements.
asArray (opens new window) boolean (opens new window) – Whether to return each element as an array.
behaviors (opens new window) yii\base\Behavior (opens new window) – List of behaviors attached to this component.
cacheTags (opens new window) string (opens new window)[]
cachedResult (opens new window) craft\base\ElementInterface (opens new window), null (opens new window) – $elements The resulting elements, or null if setCachedResult() was never called or the criteria has changed
contentTable (opens new window) string (opens new window), null (opens new window) – The content table that will be joined by this query.
criteria (opens new window) array (opens new window)
customFields (opens new window) craft\base\FieldInterface (opens new window), null (opens new window) – 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 (opens new window) 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 (opens new window) mixed – When the resulting elements must have been last updated.
descendantDist (opens new window) integer (opens new window), null (opens new window) – The maximum number of levels that results may be separated from descendantOf() (opens new window).
descendantOf (opens new window) integer (opens new window), craft\base\ElementInterface (opens new window), null (opens new window) – The element (or its ID) that results must be a descendant of.
distinct (opens new window) boolean (opens new window) – Whether to select distinct rows of data only.
draftCreator (opens new window) integer (opens new window), null (opens new window) – The drafts’ creator ID
draftId (opens new window) integer (opens new window), null (opens new window) – The ID of the draft to return (from the drafts table)
draftOf (opens new window) mixed – The source element ID that drafts should be returned for.
drafts (opens new window) boolean (opens new window), null (opens new window) – Whether draft elements should be returned.
elementType (opens new window) string (opens new window) – The name of the craft\base\ElementInterface (opens new window) class.
email mixed – The email address the resulting orders must have.
emulateExecution (opens new window) boolean (opens new window) – Whether to emulate the actual query execution, returning empty or false results.
expiryDate mixed – The Expiry Date that the resulting orders must have.
fixedOrder (opens new window) boolean (opens new window) – Whether results should be returned in the order specified by id() (opens new window).
from (opens new window) array (opens new window), null (opens new window) – The table(s) to be selected from.
gatewayId mixed – The gateway ID that the resulting orders must have.
groupBy (opens new window) array (opens new window), null (opens new window) – How to group the query results.
hasDescendants (opens new window) boolean (opens new window), null (opens new window) – Whether the resulting elements must have descendants.
hasLineItems boolean (opens new window), null (opens new window) – Whether the order has any line items.
hasPurchasables mixed – The resulting orders must contain these Purchasables.
hasTransactions boolean (opens new window), null (opens new window) – Whether the order has any transactions
having (opens new window) string (opens new window), array (opens new window), yii\db\ExpressionInterface (opens new window), null (opens new window) – The condition to be applied in the GROUP BY clause.
id (opens new window) mixed – The element ID(s).
ignorePlaceholders (opens new window) boolean (opens new window) – Whether to ignore placeholder elements when populating the results.
inReverse (opens new window) boolean (opens new window) – Whether the results should be queried in reverse.
indexBy (opens new window) string (opens new window), callable (opens new window), null (opens new window) – The name of the column by which the query results should be indexed by.
isCompleted boolean (opens new window) – The completion status that the resulting orders must have.
isPaid boolean (opens new window), null (opens new window) – Whether the order is paid
isUnpaid boolean (opens new window), null (opens new window) – 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 (opens new window) ArrayIterator (opens new window)
join (opens new window) array (opens new window), null (opens new window) – How to join with other tables.
leaves (opens new window) boolean (opens new window) – Whether the elements must be “leaves” in the structure.
level (opens new window) mixed – The element’s level within the structure
limit (opens new window) integer (opens new window), yii\db\ExpressionInterface (opens new window), null (opens new window) – Maximum number of records to be returned.
nextSiblingOf (opens new window) integer (opens new window), craft\base\ElementInterface (opens new window), null (opens new window) – The element (or its ID) that the result must be the next sibling of.
number mixed – The order number of the resulting order.
offset (opens new window) integer (opens new window), yii\db\ExpressionInterface (opens new window), null (opens new window) – Zero-based offset from where the records are to be returned.
orderBy (opens new window) array (opens new window), null (opens new window) – 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 (opens new window) array (opens new window), null (opens new window) – List of query parameter values indexed by parameter placeholders.
positionedAfter (opens new window) integer (opens new window), craft\base\ElementInterface (opens new window), null (opens new window) – The element (or its ID) that the results must be positioned after.
positionedBefore (opens new window) integer (opens new window), craft\base\ElementInterface (opens new window), null (opens new window) – The element (or its ID) that the results must be positioned before.
preferSites (opens new window) array (opens new window), null (opens new window) – Determines which site should be selected when querying multi-site elements.
prevSiblingOf (opens new window) integer (opens new window), craft\base\ElementInterface (opens new window), null (opens new window) – The element (or its ID) that the result must be the previous sibling of.
provisionalDrafts (opens new window) boolean (opens new window), null (opens new window) – Whether provisional drafts should be returned.
query (opens new window) craft\db\Query (opens new window), null (opens new window) – The query object created by prepare() (opens new window)
queryCacheDependency (opens new window) yii\caching\Dependency (opens new window), null (opens new window) – The dependency to be associated with the cached query result for this query
queryCacheDuration (opens new window) integer (opens new window), boolean (opens new window), null (opens new window) – The default number of seconds that query results can remain valid in cache.
rawSql (opens new window) string (opens new window)
ref (opens new window) mixed – The reference code(s) used to identify the element(s).
reference mixed – The order reference of the resulting order.
relatedTo (opens new window) mixed – The element relation criteria.
revisionCreator (opens new window) integer (opens new window), null (opens new window) – The revisions’ creator ID
revisionId (opens new window) integer (opens new window), null (opens new window) – The ID of the revision to return (from the revisions table)
revisionOf (opens new window) integer (opens new window), null (opens new window) – The source element ID that revisions should be returned for
revisions (opens new window) boolean (opens new window), null (opens new window) – Whether revision elements should be returned.
savedDraftsOnly (opens new window) boolean (opens new window) – Whether only unpublished drafts which have been saved after initial creation should be included in the results.
search (opens new window) mixed – The search term to filter the resulting elements by.
select (opens new window) array (opens new window), null (opens new window) – The columns being selected.
selectOption (opens new window) string (opens new window), null (opens new window) – 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 (opens new window) integer (opens new window), craft\base\ElementInterface (opens new window), null (opens new window) – The element (or its ID) that the results must be a sibling of.
site (opens new window) string (opens new window), string (opens new window)[], craft\models\Site (opens new window) – The site(s) that resulting elements must be returned in
siteId (opens new window) mixed – The site ID(s) that the elements should be returned in, or '*' if elements should be returned in all supported sites.
siteSettingsId (opens new window) mixed – The element ID(s) in the elements_sites table.
slug (opens new window) mixed – The slug that resulting elements must have.
status (opens new window) string (opens new window), string (opens new window)[], null (opens new window) – The status(es) that the resulting elements must have.
structureId (opens new window) mixed – The structure ID that should be used to join in the structureelements table.
subQuery (opens new window) craft\db\Query (opens new window), null (opens new window) – The subselect’s query object created by prepare() (opens new window)
tablesUsedInFrom (opens new window) string (opens new window)[] – Table names indexed by aliases.
title (opens new window) 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.
trashed (opens new window) boolean (opens new window), null (opens new window) – Whether to return trashed (soft-deleted) elements.
uid (opens new window) mixed – The element UID(s).
union (opens new window) array (opens new window), null (opens new window) – This is used to construct the UNION clause(s) in a SQL statement.
unique (opens new window) boolean (opens new window) – Whether only elements with unique IDs should be returned by the query.
uri (opens new window) mixed – The URI that the resulting element must have.
where (opens new window) string (opens new window), array (opens new window), yii\db\ExpressionInterface (opens new window), null (opens new window) – Query condition.
with (opens new window) string (opens new window), array (opens new window), null (opens new window) – The eager-loading declaration.
withAddresses boolean (opens new window) – Eager loads the shipping and billing addressees on the resulting orders.
withAdjustments boolean (opens new window) – Eager loads the order adjustments on the resulting orders.
withAll boolean (opens new window) – Eager loads all relational data (addresses, adjustments, users, line items, transactions) for the resulting orders.
withCustomer boolean (opens new window) – Eager load the user on to the order.
withLineItems boolean (opens new window) – Eager loads the line items on the resulting orders.
withQueries (opens new window) array (opens new window), null (opens new window) – This is used to construct the WITH section in a SQL query.
withStructure (opens new window) boolean (opens new window), null (opens new window) – Whether element structure data should automatically be left-joined into the query.
withTransactions boolean (opens new window) – 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 (opens new window)

# dateAuthorized

Type
mixed
Default value
null

The date the order was authorized in full.

View source (opens new window)

# dateOrdered

Type
mixed
Default value
null

The Date Ordered date that the resulting orders must have.

View source (opens new window)

# datePaid

Type
mixed
Default value
null

The date the order was paid in full.

View source (opens new window)

# email

Type
mixed
Default value
null

The email address the resulting orders must have.

View source (opens new window)

# expiryDate

Type
mixed
Default value
null

The Expiry Date that the resulting orders must have.

View source (opens new window)

# gatewayId

Type
mixed
Default value
null

The gateway ID that the resulting orders must have.

View source (opens new window)

# hasLineItems

Type
boolean (opens new window), null (opens new window)
Default value
null

Whether the order has any line items.

View source (opens new window)

# hasPurchasables

Type
mixed
Default value
null

The resulting orders must contain these Purchasables.

View source (opens new window)

# hasTransactions

Type
boolean (opens new window), null (opens new window)
Default value
null

Whether the order has any transactions

View source (opens new window)

# isCompleted

Type
boolean (opens new window)
Default value
null

The completion status that the resulting orders must have.

View source (opens new window)

# isPaid

Type
boolean (opens new window), null (opens new window)
Default value
null

Whether the order is paid

View source (opens new window)

# isUnpaid

Type
boolean (opens new window), null (opens new window)
Default value
null

Whether the order is unpaid

View source (opens new window)

# itemSubtotal

Type
mixed
Default value
null
Since
4.2.0

The subtotal price of the items resulting orders must have.

View source (opens new window)

# itemTotal

Type
mixed
Default value
null
Since
4.2.0

The total price of the items resulting orders must have.

View source (opens new window)

# number

Type
mixed
Default value
null

The order number of the resulting order.

View source (opens new window)

# orderLanguage

Type
mixed
Default value
null

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

View source (opens new window)

# orderSiteId

Type
mixed
Default value
null

The Order Site ID that the resulting orders must have.

View source (opens new window)

# orderStatusId

Type
mixed
Default value
null

The Order Status ID that the resulting orders must have.

View source (opens new window)

# origin

Type
mixed
Default value
null

The origin the resulting orders must have.

View source (opens new window)

# reference

Type
mixed
Default value
null

The order reference of the resulting order.

View source (opens new window)

# shippingMethodHandle

Type
mixed
Default value
null
Since
4.2.0

The shipping method handle the resulting orders must have.

View source (opens new window)

# shortNumber

Type
mixed
Default value
null

The short order number of the resulting order.

View source (opens new window)

# total

Type
mixed
Default value
null
Since
4.2.0

The total of the order resulting orders must have.

View source (opens new window)

# totalDiscount

Type
mixed
Default value
null
Since
4.2.0

The total discount of the order resulting orders must have.

View source (opens new window)

# totalPaid

Type
mixed
Default value
null
Since
4.2.0

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

View source (opens new window)

# totalPrice

Type
mixed
Default value
null
Since
4.2.0

The total price of the order resulting orders must have.

View source (opens new window)

# totalQty

Type
mixed
Default value
null
Since
4.2.0

The total qty of the order resulting orders must have.

View source (opens new window)

# totalTax

Type
mixed
Default value
null
Since
4.2.0

The total tax resulting orders must have.

View source (opens new window)

# withAddresses

Type
boolean (opens new window)
Default value
false

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

View source (opens new window)

# withAdjustments

Type
boolean (opens new window)
Default value
false

Eager loads the order adjustments on the resulting orders.

View source (opens new window)

# withAll

Type
boolean (opens new window)
Default value
false

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

View source (opens new window)

# withCustomer

Type
boolean (opens new window)
Default value
false

Eager load the user on to the order.

View source (opens new window)

# withLineItems

Type
boolean (opens new window)
Default value
false

Eager loads the line items on the resulting orders.

View source (opens new window)

# withTransactions

Type
boolean (opens new window)
Default value
false

Eager loads the transactions on the resulting orders.

View source (opens new window)

# Protected Properties

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

# defaultOrderBy

Type
array (opens new window)
Default value
[ 'commerce_orders.id' => SORT_ASC, ]

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

View source (opens new window)

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__clone() (opens new window)
__construct() Constructor
__get() (opens new window) Returns the value of a component property.
__isset() (opens new window) Checks if a property is set, i.e. defined and not null.
__set() (opens new window) Sets the value of a component property.
__toString() (opens new window) Returns the SQL representation of Query
__unset() (opens new window) Sets a component property to be null.
addGroupBy() (opens new window) Adds additional group-by columns to the existing ones.
addOrderBy() (opens new window) Adds additional ORDER BY columns to the query.
addParams() (opens new window) Adds additional parameters to be bound to the query.
addSelect() (opens new window) Add more columns to the SELECT part of the query.
afterPopulate() (opens new window) Performs any post-population processing on elements.
all()
ancestorDist() (opens new window) Narrows the query results to only {elements} that are up to a certain distance away from the {element} specified by ancestorOf() (opens new window).
ancestorOf() (opens new window) Narrows the query results to only {elements} that are ancestors of another {element} in its structure.
andFilterCompare() (opens new window) Adds a filtering condition for a specific column and allow the user to choose a filter operator.
andFilterHaving() (opens new window) Adds an additional HAVING condition to the existing one but ignores empty operands (opens new window).
andFilterWhere() (opens new window) Adds an additional WHERE condition to the existing one but ignores empty operands (opens new window).
andHaving() (opens new window) Adds an additional HAVING condition to the existing one.
andRelatedTo() (opens new window) Narrows the query results to only {elements} that are related to certain other elements.
andWhere() (opens new window) Adds an additional WHERE condition to the existing one.
andWith() (opens new window) Causes the query to return matching {elements} eager-loaded with related elements, in addition to the elements that were already specified by with() (opens new window).
anyStatus() (opens new window) Sets the status (opens new window) param to null.
archived() (opens new window) Sets the archived (opens new window) property.
asArray() (opens new window) Causes the query to return matching {elements} as arrays of data, rather than [[{element-class}]] objects.
attachBehavior() (opens new window) Attaches a behavior to this component.
attachBehaviors() (opens new window) Attaches a list of behaviors to the component.
average() (opens new window) Returns the average of the specified column values.
batch() (opens new window) Starts a batch query.
behaviors() (opens new window) Returns a list of behaviors that this component should behave as.
cache() (opens new window) Enables query cache for this Query.
canGetProperty() (opens new window) Returns a value indicating whether a property can be read.
canSetProperty() (opens new window) Returns a value indicating whether a property can be set.
className() (opens new window) Returns the fully qualified name of this class.
clearCachedResult() (opens new window) Clears the cached result (opens new window).
collect() (opens new window)
column() (opens new window) Executes the query and returns the first column of the result.
count() (opens new window) Returns the number of records.
create() (opens new window) Creates a new Query object and copies its property values from an existing one.
createCommand() (opens new window) Creates a DB command that can be used to execute this query.
createElement() (opens new window) Converts a found row into an element instance.
criteriaAttributes() (opens new window) 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() (opens new window) 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() (opens new window) Narrows the query results based on the {elements}’ last-updated dates.
descendantDist() (opens new window) Narrows the query results to only {elements} that are up to a certain distance away from the {element} specified by descendantOf() (opens new window).
descendantOf() (opens new window) Narrows the query results to only {elements} that are descendants of another {element} in its structure.
detachBehavior() (opens new window) Detaches a behavior from the component.
detachBehaviors() (opens new window) Detaches all behaviors from the component.
distinct() (opens new window) Sets the value indicating whether to SELECT DISTINCT or not.
draftCreator() (opens new window) Narrows the query results to only drafts created by a given user.
draftId() (opens new window) Narrows the query results based on the {elements}’ draft’s ID (from the drafts table).
draftOf() (opens new window) Narrows the query results to only drafts of a given {element}.
drafts() (opens new window) Narrows the query results to only drafts {elements}.
each() (opens new window) Starts a batch query and retrieves data row by row.
email() Narrows the query results based on the customers’ email addresses.
emulateExecution() (opens new window) Sets whether to emulate query execution, preventing any interaction with data storage.
ensureBehaviors() (opens new window) Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
exists() (opens new window) 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() (opens new window) Returns the list of fields that can be expanded further and returned by toArray() (opens new window).
fields() (opens new window) Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified.
filterHaving() (opens new window) Sets the HAVING part of the query but ignores empty operands (opens new window).
filterWhere() (opens new window) Sets the WHERE part of the query but ignores empty operands (opens new window).
fixedOrder() (opens new window) Causes the query results to be returned in the order specified by id() (opens new window).
from() (opens new window) 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() (opens new window) Returns the named behavior object.
getBehaviors() (opens new window) Returns all behaviors attached to this component.
getCacheTags() (opens new window)
getCachedResult() (opens new window) Returns the resulting elements set by setCachedResult() (opens new window), if the criteria params haven’t changed since then.
getCriteria() (opens new window) Returns an array of the current criteria attribute values.
getIterator() (opens new window) Required by the IteratorAggregate interface.
getRawSql() (opens new window) Shortcut for createCommand()->getRawSql().
getTablesUsedInFrom() (opens new window) Returns table names used in from() (opens new window) indexed by aliases.
groupBy() (opens new window) Sets the GROUP BY part of the query.
hasDescendants() (opens new window) Narrows the query results based on whether the {elements} have any descendants in their structure.
hasEventHandlers() (opens new window) 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() (opens new window) Returns a value indicating whether a method is defined.
hasProperty() (opens new window) 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() (opens new window) Sets the HAVING part of the query.
id()
ids() (opens new window) Executes the query and returns the IDs of the resulting elements.
ignorePlaceholders() (opens new window) 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() (opens new window).
inReverse() (opens new window) Causes the query results to be returned in reverse order.
indexBy() (opens new window) Sets the indexBy() (opens new window) property.
init() (opens new window) Initializes the object.
innerJoin() (opens new window) Appends an INNER JOIN part to the query.
isCompleted() Narrows the query results to only orders that are completed.
isJoined() (opens new window) 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() (opens new window) Appends a JOIN part to the query.
leaves() (opens new window) Narrows the query results based on whether the {elements} are “leaves” ({elements} with no descendants).
leftJoin() (opens new window) Appends a LEFT OUTER JOIN part to the query.
level() (opens new window) Narrows the query results based on the {elements}’ level within the structure.
limit() (opens new window) Sets the LIMIT part of the query.
max() (opens new window) Returns the maximum of the specified column values.
min() (opens new window) Returns the minimum of the specified column values.
nextSiblingOf() (opens new window) Narrows the query results to only the {element} that comes immediately after another {element} in its structure.
noCache() (opens new window) Disables query cache for this Query.
nth()
number() Narrows the query results based on the order number.
off() (opens new window) Detaches an existing event handler from this component.
offset() (opens new window) Sets the OFFSET part of the query.
offsetExists() (opens new window) Required by the ArrayAccess interface.
offsetGet() (opens new window) Required by the ArrayAccess interface.
offsetSet() (opens new window) Required by the ArrayAccess interface.
offsetUnset() (opens new window) Required by the ArrayAccess interface.
on() (opens new window) Attaches an event handler to an event.
one()
orFilterHaving() (opens new window) Adds an additional HAVING condition to the existing one but ignores empty operands (opens new window).
orFilterWhere() (opens new window) Adds an additional WHERE condition to the existing one but ignores empty operands (opens new window).
orHaving() (opens new window) Adds an additional HAVING condition to the existing one.
orWhere() (opens new window) 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() (opens new window) Executes the query and returns the first two columns in the results as key/value pairs.
params() (opens new window) Sets the parameters to be bound to the query.
populate() Converts the raw query results into the format as specified by this query.
positionedAfter() (opens new window) Narrows the query results to only {elements} that are positioned after another {element} in its structure.
positionedBefore() (opens new window) Narrows the query results to only {elements} that are positioned before another {element} in its structure.
preferSites() (opens new window) If unique() (opens new window) is set, this determines which site should be selected when querying multi-site elements.
prepare() (opens new window) Prepares for building SQL.
prepareSubquery() (opens new window) Prepares the element query and returns its subquery (which determines what elements will be returned).
prevSiblingOf() (opens new window) Narrows the query results to only the {element} that comes immediately before another {element} in its structure.
provisionalDrafts() (opens new window) Narrows the query results to only provisional drafts.
ref() (opens new window) Narrows the query results based on a reference string.
reference() Narrows the query results based on the order reference.
relatedTo() (opens new window) Narrows the query results to only {elements} that are related to certain other elements.
revisionCreator() (opens new window) Narrows the query results to only revisions created by a given user.
revisionId() (opens new window) Narrows the query results based on the {elements}’ revision’s ID (from the revisions table).
revisionOf() (opens new window) Narrows the query results to only revisions of a given {element}.
revisions() (opens new window) Narrows the query results to only revision {elements}.
rightJoin() (opens new window) Appends a RIGHT OUTER JOIN part to the query.
savedDraftsOnly() (opens new window) Narrows the query results to only unpublished drafts which have been saved after initial creation.
scalar() (opens new window) Returns the query result as a scalar value.
search() (opens new window) Narrows the query results to only {elements} that match a search query.
select() (opens new window) Sets the SELECT part of the query.
setCachedResult() (opens new window) 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() (opens new window) Narrows the query results to only {elements} that are siblings of another {element} in its structure.
site() (opens new window) Determines which site(s) the {elements} should be queried in.
siteId() (opens new window) Determines which site(s) the {elements} should be queried in, per the site’s ID.
siteSettingsId() (opens new window) Narrows the query results based on the {elements}’ IDs in the elements_sites table.
slug() (opens new window) Narrows the query results based on the {elements}’ slugs.
status()
structureId() (opens new window) Determines which structure data should be joined into the query.
sum() (opens new window) Returns the sum of the specified column values.
title() (opens new window) Narrows the query results based on the {elements}’ titles.
toArray() (opens new window) 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.
trashed() (opens new window) Narrows the query results to only {elements} that have been soft-deleted.
trigger() (opens new window) Triggers an event.
uid() (opens new window) Narrows the query results based on the {elements}’ UIDs.
union() (opens new window) Appends a SQL statement using UNION operator.
unique() (opens new window) Determines whether only elements with unique IDs should be returned by the query.
uri() (opens new window) Narrows the query results based on the {elements}’ URIs.
user() Narrows the query results based on the customer’s user account.
where() (opens new window) Sets the WHERE part of the query.
with() (opens new window) Causes the query to return matching {elements} eager-loaded with related elements.
withAddresses() Eager loads the 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, adjustents, customers, line items, transactions) for the resulting orders.
withCustomer() Eager loads the user on the resulting orders.
withLineItems() Eager loads the line items on the resulting orders.
withQuery() (opens new window) Prepends a SQL statement using WITH syntax.
withStructure() (opens new window) Explicitly determines whether the query should join in the structure data.
withTransactions() Eager loads the transactions on the resulting orders.

# __construct()

Constructor

View source (opens new window)

Arguments

# all()

View source (opens new window)

Arguments

  • $db

Returns

craft\commerce\elements\Order[], array (opens new window) –

# 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 (opens new window) 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 (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch the current user's orders #}
{% set {elements-var} = {twig-method}
  .customer(currentUser)
  .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 (opens new window)

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

Example

{# Fetch the current user's orders #}
{% set {elements-var} = {twig-method}
  .customerId(currentUser.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 (opens new window)

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

Example

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

{% set {elements-var} = {twig-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 (opens new window)

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

Example

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

{% set {elements-var} = {twig-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 (opens new window)

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

Example

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

{% set {elements-var} = {twig-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 (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch orders from customers with a .co.uk domain on their email address #}
{% set {elements-var} = {twig-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 (opens new window)

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

Example

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

{% set {elements-var} = {twig-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 (opens new window)

Arguments

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 (opens new window)

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

# hasLineItems()

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

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch orders that do or do not have line items #}
{% set {elements-var} = {twig-method}
  .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 (opens new window)

Arguments

Returns

static – Self reference

# hasTransactions()

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

View source (opens new window)

Arguments

Returns

static – Self reference

Example

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

# id()

View source (opens new window)

Arguments

  • $value

Returns

self –

# isCompleted()

Narrows the query results to only orders that are completed.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

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

# isPaid()

Narrows the query results to only orders that are paid.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

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

# isUnpaid()

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

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch unpaid orders #}
{% set {elements-var} = {twig-method}
  .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 (opens new window)

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 (opens new window)

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

# nth()

View source (opens new window)

Arguments

  • $n
  • $db = null

Returns

craft\commerce\elements\Order, array (opens new window), null (opens new window) –

# number()

Narrows the query results based on the order number.

Possible values include:

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

View source (opens new window)

Arguments

Returns

static – Self reference

Example

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

# one()

View source (opens new window)

Arguments

  • $db

Returns

craft\commerce\elements\Order, array (opens new window), null (opens new window) –

# orderBy()

View source (opens new window)

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 (opens new window)

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

Example

{# Fetch {elements} with an order language that is `'en'` #}
{% set {elements-var} = {twig-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 (opens new window)

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

Example

{# Fetch {elements} with an order site ID of 1 #}
{% set {elements-var} = {twig-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 (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch shipped {elements} #}
{% set {elements-var} = {twig-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 (opens new window)

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

Example

{# Fetch {elements} with an order status with an ID of 1 #}
{% set {elements-var} = {twig-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 (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch shipped {elements} #}
{% set {elements-var} = {twig-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 (opens new window)

Arguments

Returns

craft\base\ElementInterface (opens new window), array (opens new window) – 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 (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch the requested {element} #}
{% set orderReference = craft.app.request.getQueryParam('ref') %}
{% set {element-var} = {twig-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 (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch collection shipping method {elements} #}
{% set {elements-var} = {twig-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 (opens new window)

Arguments

Returns

static – Self reference

Example

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

# status()

View source (opens new window)

Arguments

  • $value

Returns

self –

# 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 (opens new window)

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 (opens new window)

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 (opens new window)

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 (opens new window)

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 (opens new window)

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 (opens new window)

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 (opens new window) object with a customer with a user account represented by the object.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

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

# withAddresses()

Eager loads the 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 (opens new window)

Arguments

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 (opens new window)

Arguments

Returns

static – Self reference

# withAll()

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

Possible values include:

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

View source (opens new window)

Arguments

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 (opens new window)

Arguments

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 (opens new window)

Arguments

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 (opens new window)

Arguments

Returns

static – Self reference

# Protected Methods

Method Description
afterPrepare() (opens new window) 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() (opens new window) Returns any cache invalidation tags that caches involving this element query should use as dependencies.
cleanUpTableNames() (opens new window) Clean up table names and aliases Both aliases and names are enclosed into .
customFields() (opens new window) Returns the fields that should take part in an upcoming elements query.
extractFieldsFor() (opens new window) 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() (opens new window) Extracts the root field names from nested fields.
filterCondition() (opens new window) Removes empty operands (opens new window) from the given query condition.
getUnaliasedColumnsFromSelect() (opens new window)
getUniqueColumns() (opens new window) Returns unique column names excluding duplicates.
isEmpty() (opens new window) Returns a value indicating whether the give value is "empty".
joinElementTable() (opens new window) Joins in a table with an id column that has a foreign key pointing to elements.id.
normalizeOrderBy() (opens new window) Normalizes format of ORDER BY data.
normalizeSelect() (opens new window) Normalizes the SELECT columns passed to select() (opens new window) or addSelect() (opens new window).
queryScalar() (opens new window) Queries a scalar value by setting select() (opens new window) first.
resolveFields() (opens new window) Determines which fields can be returned by toArray() (opens new window).
setCommandCache() (opens new window) Sets $command cache, if this query has enabled caching.
statusCondition() (opens new window) 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 (opens new window). The subselect’s Query object being prepared is available via subQuery (opens new window). 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 (opens new window)

Returns

boolean (opens new window) – 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

← ProductQuery →