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
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.

View source

# 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
cachedResult craft\base\ElementInterface, null – $elements The resulting elements, or null if setCachedResult() was never called or the criteria has changed
contentTable string, null – The content table that will be joined by this query.
criteria array
customFields craft\base\FieldInterface, null – The fields that may be involved in this query.
customerId boolean – The completion status 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 integer, false, null – The source element ID that drafts should be returned for.
drafts boolean – Whether draft elements should be returned.
elementType string, null – The name of the craft\base\ElementInterface class.
email string – The email address the resulting orders must have.
emulateExecution boolean – Whether to emulate the actual query execution, returning empty or false results.
enabledForSite boolean – Whether the elements must be enabled for the chosen site.
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 – The table(s) to be selected from.
gatewayId integer – The gateway ID that the resulting orders must have.
groupBy array – How to group the query results.
hasDescendants boolean, null – Whether the resulting elements must have descendants.
hasLineItems boolean – Whether the order has any line items.
hasPurchasables craft\commerce\base\PurchasableInterface, craft\commerce\base\PurchasableInterface[] – The resulting orders must contain these Purchasables.
hasTransactions boolean – Whether the order has any transactions
having string, array, yii\db\ExpressionInterface – The condition to be applied in the GROUP BY clause.
id integer, integer[], false, null – The element ID(s).
ignorePlaceholders boolean – Whether to ignore placeholder elements when populating the results.
inReverse boolean – Whether the results should be queried in reverse.
indexBy string, callable – 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 – Whether the order is paid
isUnpaid boolean – Whether the order is unpaid
iterator ArrayIterator
join array – 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 – 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 string – The order number of the resulting order.
offset integer, yii\db\ExpressionInterface – Zero-based offset from where the records are to be returned.
orderBy array – How to sort the query results.
orderStatusId integer – The Order Status ID that the resulting orders must have.
origin string, null – The origin the resulting orders must have.
params array – 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.
query craft\db\Query, null – The query object created by prepare()
queryCacheDependency yii\caching\Dependency – The dependency to be associated with the cached query result for this query
queryCacheDuration integer, true – The default number of seconds that query results can remain valid in cache.
rawSql string
ref string, string[], null – The reference code(s) used to identify the element(s).
reference string – The order reference of the resulting order.
relatedTo integer, array, craft\base\ElementInterface, null – 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 – Whether revision elements should be returned.
search string, array, craft\search\SearchQuery, null – The search term to filter the resulting elements by.
select array – The columns being selected.
selectOption string – Additional option that should be appended to the 'SELECT' keyword.
shortNumber string – 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.
siteId integer, integer[], string, null – The site ID(s) that the elements should be returned in, or '*' if elements should be returned in all supported sites.
slug string, string[], null – The slug that resulting elements must have.
status string, string[], null – The status(es) that the resulting elements must have.
structureId integer, false, null – 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 string, string[], null – The title that resulting elements must have.
trashed boolean, null – Whether to return trashed (soft-deleted) elements.
uid string, string[], null – The element UID(s).
union array – 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 string, string[], null – The URI that the resulting element must have.
where string, array, yii\db\ExpressionInterface – Query condition.
with string, array, null – The eager-loading declaration.
withQueries array – 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.

# customerId

Type
boolean

The completion status that the resulting orders must have.

View source

# dateAuthorized

Type
mixed

The date the order was authorized in full.

View source

# dateOrdered

Type
mixed

The Date Ordered date that the resulting orders must have.

View source

# datePaid

Type
mixed

The date the order was paid in full.

View source

# email

Type
string

The email address the resulting orders must have.

View source

# expiryDate

Type
mixed

The Expiry Date that the resulting orders must have.

View source

# gatewayId

Type
integer

The gateway ID that the resulting orders must have.

View source

# hasLineItems

Type
boolean

Whether the order has any line items.

View source

# hasPurchasables

Type
craft\commerce\base\PurchasableInterface, craft\commerce\base\PurchasableInterface[]

The resulting orders must contain these Purchasables.

View source

# hasTransactions

Type
boolean

Whether the order has any transactions

View source

# isCompleted

Type
boolean

The completion status that the resulting orders must have.

View source

# isPaid

Type
boolean

Whether the order is paid

View source

# isUnpaid

Type
boolean

Whether the order is unpaid

View source

# number

Type
string

The order number of the resulting order.

View source

# orderStatusId

Type
integer

The Order Status ID that the resulting orders must have.

View source

# origin

Type
string, null

The origin the resulting orders must have.

View source

# reference

Type
string

The order reference of the resulting order.

View source

# shortNumber

Type
string

The short order number of the resulting order.

View source

# Protected Properties

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

# defaultOrderBy

Type
array

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()
__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.
all() Executes the query and returns all results as an array.
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}.
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.
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() Clears out the status() and enabledForSite() parameters.
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.
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.
criteriaAttributes() Returns the query's criteria attributes.
customer() Narrows the query results based on the customer.
customerId() Narrows the query results based on the customer, per their 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}.
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.
email() Narrows the query results based on the customers’ email addresses.
emulateExecution() Sets whether to emulate query execution, preventing any interaction with data storage.
enabledForSite() Narrows the query results based on whether the {elements} are enabled in the site they’re being queried in, per the site() parameter.
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.
find() Returns all elements that match the criteria.
first() Returns the first element that matches the criteria.
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.
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.
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() Narrows the query results based on the {elements}’ IDs.
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().
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.
join() Appends a JOIN part to the query.
last() Returns the last element that matches the criteria.
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.
locale() Sets the \craft\elements\db\$site property.
localeEnabled() Sets the enabledForSite property.
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}.
noCache() Disables query cache for this Query.
nth() Executes the query and returns a single row of result at a given offset.
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() Executes the query and returns a single row of result.
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.
order() Sets the orderBy property.
orderBy() Determines the order that the {elements} should be returned in. (If empty, defaults to {default-order-by}.)
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}.
positionedBefore() Narrows the query results to only {elements} that are positioned before another {element}.
preferSites() If unique() is set, this determines which site should be selected when querying multi-site elements.
prepare() Prepares for building SQL.
prevSiblingOf() Narrows the query results to only the {element} that comes immediately before another {element}.
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.
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.
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.
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}.
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.
slug() Narrows the query results based on the {elements}’ slugs.
status() Narrows the query results based on the {elements}’ statuses.
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() Returns the total elements that match the criteria.
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.
where() Sets the WHERE part of the query.
with() Causes the query to return matching {elements} eager-loaded with related elements.
withQuery() Prepends a SQL statement using WITH syntax.
withStructure() Explicitly determines whether the query should join in the structure data.

# __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

# customer()

Narrows the query results based on the customer.

Possible values include:

Value Fetches {elements}…
a Customer object with a customer represented by the object.

View source

Arguments

Returns

static – Self reference

Example

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

# customerId()

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

Possible values include:

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

View source

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

Example

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

{# 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

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

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

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

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

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

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) – The property value

Returns

static – Self reference

Example

{# Fetch orders that do or do not have line items #}
{% set {elements-var} = {twig-function}
    .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

Returns

static – Self reference

# hasTransactions()

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

View source

Arguments

  • $value (boolean) – The property value

Returns

static – Self reference

Example

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

# isCompleted()

Narrows the query results to only orders that are completed.

View source

Arguments

  • $value (boolean) – The property value

Returns

static – Self reference

Example

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

# isPaid()

Narrows the query results to only orders that are paid.

View source

Arguments

  • $value (boolean) – The property value

Returns

static – Self reference

Example

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

# isUnpaid()

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

View source

Arguments

  • $value (boolean) – The property value

Returns

static – Self reference

Example

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

# 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

Returns

static – Self reference

Example

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

# 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

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

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}
    .authorGroupId(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

Returns

static – Self reference

Example

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

# reference()

Narrows the query results based on the order reference.

Possible values include:

Value Fetches {elements}…
'xxxx' with a matching order reference

View source

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() %}

# 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

Returns

static – Self reference

Example

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

# user()

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

Returns

static – Self reference

Example

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

# 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.
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.
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 craft_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.