ProductQuery

Type: Class
Namespace: craft\commerce\elements\db
Inherits: craft\commerce\elements\db\ProductQuery » 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

ProductQuery represents a SELECT SQL statement for products in a way that is independent of DBMS.

# 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.
availableForPurchase	boolean (opens new window), null (opens new window) – Whether the product is available for purchase
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.
dateCreated (opens new window)	`mixed` – When the resulting elements must have been created.
dateUpdated (opens new window)	`mixed` – When the resulting elements must have been last updated.
defaultHeight	`mixed` – The default height the resulting products must have.
defaultLength	`mixed` – The default length the resulting products must have.
defaultPrice	`mixed` – The default price the resulting products must have.
defaultSku	`mixed` – The default sku the resulting products must have.
defaultWeight	`mixed` – The default weight the resulting products must have.
defaultWidth	`mixed` – The default width the resulting products must have.
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.
editable	boolean (opens new window) – Whether to only return products that the user has permission to edit.
elementType (opens new window)	string (opens new window) – The name of the craft\base\ElementInterface (opens new window) class.
emulateExecution (opens new window)	boolean (opens new window) – Whether to emulate the actual query execution, returning empty or false results.
expiryDate	`mixed` – The Post Date that the resulting products 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.
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.
hasVariant	`mixed` – Only return products that match the resulting variant query.
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.
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.
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.
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.
postDate	`mixed` – The Post Date that the resulting products must have.
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).
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.
shippingCategoryId	`mixed` – The shipping category ID(s) that the resulting products must have.
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.
taxCategoryId	`mixed` – The tax category ID(s) that the resulting products must have.
title (opens new window)	`mixed` – The title that resulting elements must have.
trashed (opens new window)	boolean (opens new window), null (opens new window) – Whether to return trashed (soft-deleted) elements.
typeId	`mixed` – The product type ID(s) that the resulting products must have.
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.
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.

# `availableForPurchase`

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

Whether the product is available for purchase

View source (opens new window)

# `defaultHeight`

Type: mixed
Default value: null

The default height the resulting products must have.

View source (opens new window)

# `defaultLength`

Type: mixed
Default value: null

The default length the resulting products must have.

View source (opens new window)

# `defaultPrice`

Type: mixed
Default value: null

The default price the resulting products must have.

View source (opens new window)

# `defaultSku`

Type: mixed
Default value: null

The default sku the resulting products must have.

View source (opens new window)

# `defaultWeight`

Type: mixed
Default value: null

The default weight the resulting products must have.

View source (opens new window)

# `defaultWidth`

Type: mixed
Default value: null

The default width the resulting products must have.

View source (opens new window)

# `editable`

Type: boolean (opens new window)
Default value: false

Whether to only return products that the user has permission to edit.

View source (opens new window)

# `expiryDate`

Type: mixed
Default value: null

The Post Date that the resulting products must have.

View source (opens new window)

# `hasVariant`

Type: mixed
Default value: null

Only return products that match the resulting variant query.

View source (opens new window)

# `postDate`

Type: mixed
Default value: null

The Post Date that the resulting products must have.

View source (opens new window)

# `shippingCategoryId`

Type: mixed
Default value: null

The shipping category ID(s) that the resulting products must have.

View source (opens new window)

# `taxCategoryId`

Type: mixed
Default value: null

The tax category ID(s) that the resulting products must have.

View source (opens new window)

# `typeId`

Type: mixed
Default value: null

The product type ID(s) that the resulting products must have.

View source (opens new window)

# Protected Properties

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

# `defaultOrderBy`

Type: array (opens new window)
Default value: [ 'commerce_products.postDate' => SORT_DESC, ]

The default orderBy() (opens new window) value to use if orderBy() (opens new window) 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()	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.
after()	Narrows the query results to only products that were posted on or after a certain date.
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.
availableForPurchase()	Narrows the query results to only products that are available for purchase.
average() (opens new window)	Returns the average of the specified column values.
batch() (opens new window)	Starts a batch query.
before()	Narrows the query results to only products that were posted before a certain date.
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.
dateCreated() (opens new window)	Narrows the query results based on the {elements}’ creation dates.
dateUpdated() (opens new window)	Narrows the query results based on the {elements}’ last-updated dates.
defaultHeight()	Narrows the query results based on the products’ default variant height dimension IDs.
defaultLength()	Narrows the query results based on the products’ default variant length dimension IDs.
defaultPrice()	Narrows the query results based on the products’ default variant price.
defaultSku()	Narrows the query results based on the default productvariants defaultSku
defaultWeight()	Narrows the query results based on the products’ default variant weight dimension IDs.
defaultWidth()	Narrows the query results based on the products’ default variant width dimension IDs.
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.
editable()	Sets the editable() property.
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 products’ 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.
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.
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.
hasVariant()	Narrows the query results to only products that have certain variants.
having() (opens new window)	Sets the HAVING part of the query.
id() (opens new window)	Narrows the query results based on the {elements}’ IDs.
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.
isJoined() (opens new window)	Returns whether a given table has been joined in this query.
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)	Determines the number of {elements} that should be returned.
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()
off() (opens new window)	Detaches an existing event handler from this component.
offset() (opens new window)	Determines how many {elements} should be skipped in the results.
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() (opens new window)	Determines the order that the {elements} should be returned in. (If empty, defaults to `{default-order-by}`.)
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() (opens new window)	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.
postDate()	Narrows the query results based on the products’ post dates.
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.
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.
shippingCategory()	Narrows the query results based on the products’ shipping category.
shippingCategoryId()	Narrows the query results based on the products’ shipping categories, per the shipping categories’ IDs.
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()	Narrows the query results based on the {elements}’ statuses.
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.
taxCategory()	Narrows the query results based on the products’ tax category.
taxCategoryId()	Narrows the query results based on the products’ tax categories, per the tax categories’ IDs.
title() (opens new window)	Narrows the query results based on the {elements}’ titles.
toArray() (opens new window)	Converts the model into an array.
trashed() (opens new window)	Narrows the query results to only {elements} that have been soft-deleted.
trigger() (opens new window)	Triggers an event.
type()	Narrows the query results based on the products’ types.
typeId()	Narrows the query results based on the products’ types, per the types’ IDs.
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.
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.
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.

# `__construct()`

Constructor

View source (opens new window)

Arguments

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

# `__set()`

Sets the value of a component property.

This method will check in the following order and act accordingly:

a property defined by a setter: set the property value
an event in the format of "on xyz": attach the handler to the event "xyz"
a behavior in the format of "as xyz": attach the behavior named as "xyz"
a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

View source (opens new window)

Arguments

$name (string (opens new window)) – The property name or the event name
$value (mixed) – The property value

Throws

yii\base\UnknownPropertyException (opens new window)
if the property is not defined
yii\base\InvalidCallException (opens new window)
if the property is read-only.

# `after()`

Narrows the query results to only products that were posted on or after a certain date.

Possible values include:

Value	Fetches {elements}…
`'2018-04-01'`	that were posted after 2018-04-01.
a DateTime (opens new window) object	that were posted after the date represented by the object.

View source (opens new window)

Arguments

$value (string (opens new window), DateTime (opens new window)) – The property value

Returns

static – Self reference

{# Fetch {elements} posted this month #}
{% set firstDayOfMonth = date('first day of this month') %}

{% set {elements-var} = {twig-method}
  .after(firstDayOfMonth)
  .all() %}

# `all()`

View source (opens new window)

Arguments

$db

Returns

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

# `availableForPurchase()`

Narrows the query results to only products that are available for purchase.

View source (opens new window)

Arguments

$value (boolean (opens new window), null (opens new window)) – The property value

Returns

static – Self reference

Example

Twig
PHP

{# Fetch products that are available for purchase #}
{% set {elements-var} = {twig-method}
  .availableForPurchase()
  .all() %}

# `before()`

Narrows the query results to only products that were posted before a certain date.

Possible values include:

Value	Fetches {elements}…
`'2018-04-01'`	that were posted before 2018-04-01.
a DateTime (opens new window) object	that were posted before the date represented by the object.

View source (opens new window)

Arguments

$value (string (opens new window), DateTime (opens new window)) – The property value

Returns

static – Self reference

Example

Twig
PHP

{# Fetch {elements} posted before this month #}
{% set firstDayOfMonth = date('first day of this month') %}

{% set {elements-var} = {twig-method}
  .before(firstDayOfMonth)
  .all() %}

# `defaultHeight()`

Narrows the query results based on the products’ default variant height dimension IDs.

Possible values include:

Value	Fetches {elements}…
`1`	of a type with a dimension of 1.
`'not 1'`	not a dimension of 1.
`[1, 2]`	of a a dimension 1 or 2.
`['and', '>= ' ~ 100, '<= ' ~ 2000]`	of a dimension between 100 and 2000

View source (opens new window)

Arguments

$value (mixed) – The property value

Returns

static – Self reference

Example

Twig
PHP

{# Fetch {elements} of the product default dimension of 1 #}
{% set {elements-var} = {twig-method}
  .defaultHeight(1)
  .all() %}

# `defaultLength()`

Narrows the query results based on the products’ default variant length dimension IDs.

Possible values include:

Value	Fetches {elements}…
`1`	of a type with a dimension of 1.
`'not 1'`	not a dimension of 1.
`[1, 2]`	of a a dimension 1 or 2.
`['and', '>= ' ~ 100, '<= ' ~ 2000]`	of a dimension between 100 and 2000

View source (opens new window)

Arguments

$value (mixed) – The property value

Returns

static – Self reference

Example

Twig
PHP

{# Fetch {elements} of the product default dimension of 1 #}
{% set {elements-var} = {twig-method}
  .defaultLength(1)
  .all() %}

# `defaultPrice()`

Narrows the query results based on the products’ default variant price.

Possible values include:

Value	Fetches {elements}…
`10`	of a price of 10.
`['and', '>= ' ~ 100, '<= ' ~ 2000]`	of a default variant price between 100 and 2000

View source (opens new window)

Arguments

$value (mixed) – The property value

Returns

static – Self reference

Example

Twig
PHP

{# Fetch {elements} of the product type with an ID of 1 #}
{% set {elements-var} = {twig-method}
  .defaultPrice(1)
  .all() %}

# `defaultSku()`

Narrows the query results based on the default productvariants defaultSku

Possible values include:

Value	Fetches {elements}…
`xxx-001`	of products default SKU of `xxx-001`.
`'not xxx-001'`	not a default SKU of `xxx-001`.
`['not xxx-001', 'not xxx-002']`	of a default SKU of xxx-001 or xxx-002.
`['not',`xxx-001`,`xxx-002`]`	not a product default SKU of `xxx-001` or `xxx-001`.

View source (opens new window)

Arguments

$value (mixed) – The property value

Returns

static – Self reference

Example

Twig
PHP

{# Fetch {elements} of the product default SKU of `xxx-001` #}
{% set {elements-var} = {twig-method}
  .defaultSku('xxx-001')
  .all() %}

# `defaultWeight()`

Narrows the query results based on the products’ default variant weight dimension IDs.

Possible values include:

Value	Fetches {elements}…
`1`	of a type with a dimension of 1.
`'not 1'`	not a dimension of 1.
`[1, 2]`	of a a dimension 1 or 2.
`['and', '>= ' ~ 100, '<= ' ~ 2000]`	of a dimension between 100 and 2000

View source (opens new window)

Arguments

$value (mixed) – The property value

Returns

static – Self reference

Example

Twig
PHP

{# Fetch {elements} of the product default dimension of 1 #}
{% set {elements-var} = {twig-method}
  .defaultWeight(1)
  .all() %}

# `defaultWidth()`

Narrows the query results based on the products’ default variant width dimension IDs.

Possible values include:

Value	Fetches {elements}…
`1`	of a type with a dimension of 1.
`'not 1'`	not a dimension of 1.
`[1, 2]`	of a a dimension 1 or 2.
`['and', '>= ' ~ 100, '<= ' ~ 2000]`	of a dimension between 100 and 2000

View source (opens new window)

Arguments

$value (mixed) – The property value

Returns

static – Self reference

Example

Twig
PHP

{# Fetch {elements} of the product default dimension of 1 #}
{% set {elements-var} = {twig-method}
  .defaultWidth(1)
  .all() %}

# `editable()`

Sets the editable() property.

View source (opens new window)

Arguments

$value (boolean (opens new window)) – The property value (defaults to true)

Returns

static – Self reference

# `expiryDate()`

Narrows the query results based on the products’ 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

Twig
PHP

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

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

# `hasVariant()`

Narrows the query results to only products that have certain variants.

Possible values include:

Value	Fetches {elements}…
a VariantQuery object	with variants that match the query.

View source (opens new window)

Arguments

$value (craft\commerce\elements\db\VariantQuery, array (opens new window)) – The property value

Returns

static – Self reference

# `nth()`

View source (opens new window)

Arguments

$n
$db = null

Returns

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

# `one()`

View source (opens new window)

Arguments

$db

Returns

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

# `postDate()`

Narrows the query results based on the products’ post dates.

Possible values include:

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

View source (opens new window)

Arguments

$value (mixed) – The property value

Returns

static – Self reference

Example

Twig
PHP

{# Fetch {elements} posted last month #}
{% set start = date('first day of last month')|atom %}
{% set end = date('first day of this month')|atom %}

{% set {elements-var} = {twig-method}
  .postDate(['and', ">= #{start}", "< #{end}"])
  .all() %}

# `shippingCategory()`

Narrows the query results based on the products’ shipping category.

Possible values include:

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

View source (opens new window)

Arguments

$value (craft\commerce\models\ShippingCategory, string (opens new window), null (opens new window), string (opens new window)[]) – The property value

Returns

static – Self reference

Example

Twig
PHP

{# Fetch {elements} with a Foo shipping category #}
{% set {elements-var} = {twig-method}
  .shippingCategory('foo')
  .all() %}

# `shippingCategoryId()`

Narrows the query results based on the products’ shipping categories, per the shipping categories’ IDs.

Possible values include:

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

View source (opens new window)

Arguments

$value (mixed) – The property value

Returns

static – Self reference

Example

Twig
PHP

{# Fetch {elements} of the shipping category with an ID of 1 #}
{% set {elements-var} = {twig-method}
  .shippingCategoryId(1)
  .all() %}

# `status()`

Narrows the query results based on the {elements}’ statuses.

Possible values include:

Value	Fetches {elements}…
`'live'` (default)	that are live.
`'pending'`	that are pending (enabled with a Post Date in the future).
`'expired'`	that are expired (enabled with an Expiry Date in the past).
`'disabled'`	that are disabled.
`['live', 'pending']`	that are live or pending.

View source (opens new window)

Arguments

$value

Example

Twig
PHP

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

# `taxCategory()`

Narrows the query results based on the products’ tax category.

Possible values include:

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

View source (opens new window)

Arguments

$value (craft\commerce\models\TaxCategory, string (opens new window), null (opens new window), string (opens new window)[]) – The property value

Returns

static – Self reference

Example

Twig
PHP

{# Fetch {elements} with a Foo tax category #}
{% set {elements-var} = {twig-method}
  .taxCategory('foo')
  .all() %}

# `taxCategoryId()`

Narrows the query results based on the products’ tax categories, per the tax categories’ IDs.

Possible values include:

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

View source (opens new window)

Arguments

$value (mixed) – The property value

Returns

static – Self reference

Example

Twig
PHP

{# Fetch {elements} of the tax category with an ID of 1 #}
{% set {elements-var} = {twig-method}
  .taxCategoryId(1)
  .all() %}

# `type()`

Narrows the query results based on the products’ types.

Possible values include:

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

View source (opens new window)

Arguments

$value (craft\commerce\models\ProductType, string (opens new window), null (opens new window), string (opens new window)[]) – The property value

Returns

static – Self reference

Example

Twig
PHP

{# Fetch {elements} with a Foo product type #}
{% set {elements-var} = {twig-method}
  .type('foo')
  .all() %}

# `typeId()`

Narrows the query results based on the products’ types, per the types’ IDs.

Possible values include:

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

View source (opens new window)

Arguments

$value (mixed) – The property value

Returns

static – Self reference

Example

Twig
PHP

{# Fetch {elements} of the product type with an ID of 1 #}
{% set {elements-var} = {twig-method}
  .typeId(1)
  .all() %}

# 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()	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()	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

craft\db\QueryAbortedException (opens new window)

# `cacheTags()`

Since: 3.5.0

Returns any cache invalidation tags that caches involving this element query should use as dependencies.

Use the most specific tag(s) possible, to reduce the likelihood of pointless cache clearing.

When elements are created/updated/deleted, their craft\base\ElementInterface::getCacheTags() (opens new window) method will be called, and any caches that have those tags listed as dependencies will be invalidated.

View source (opens new window)

Returns

string (opens new window)[]

# `statusCondition()`

Returns the condition that should be applied to the element query for a given status.

For example, if you support a status called “pending”, which maps back to a pending database column that will either be 0 or 1, this method could do this:

protected function statusCondition($status)
{
    switch ($status) {
        case 'pending':
            return ['mytable.pending' => true];
        default:
            return parent::statusCondition($status);
    }

View source (opens new window)

Arguments

$status (string (opens new window)) – The status

Returns

string (opens new window), array (opens new window), yii\db\ExpressionInterface (opens new window), false (opens new window), null (opens new window) – The status condition, or false if $status is an unsupported status

← OrderQuery SubscriptionQuery →

ProductQuery

# Public Properties

# availableForPurchase

# defaultHeight

# defaultLength

# defaultPrice

# defaultSku

# defaultWeight

# defaultWidth

# editable

# expiryDate

# hasVariant

# postDate

# shippingCategoryId

# taxCategoryId

# typeId

# Protected Properties

# defaultOrderBy

# Public Methods

# __construct()

Arguments

# __set()

Arguments

Throws

# after()

Arguments

Returns

Example

# all()

Arguments

Returns

# availableForPurchase()

Arguments

Returns

Example

# before()

Arguments

Returns

Example

# defaultHeight()

Arguments

Returns

Example

# defaultLength()

Arguments

Returns

Example

# defaultPrice()

Arguments

Returns

Example

# defaultSku()

Arguments

Returns

Example

# defaultWeight()

Arguments

Returns

Example

# defaultWidth()

Arguments

Returns

Example

# editable()

Arguments

Returns

# expiryDate()

Arguments

Returns

Example

# hasVariant()

Arguments

Returns

# nth()

Arguments

Returns

# one()

Arguments

Returns

# postDate()

# `availableForPurchase`

# `defaultHeight`

# `defaultLength`

# `defaultPrice`

# `defaultSku`

# `defaultWeight`

# `defaultWidth`

# `editable`

# `expiryDate`

# `hasVariant`

# `postDate`

# `shippingCategoryId`

# `taxCategoryId`

# `typeId`

# `defaultOrderBy`

# `__construct()`

# `__set()`

# `after()`

# `all()`

# `availableForPurchase()`

# `before()`

# `defaultHeight()`

# `defaultLength()`

# `defaultPrice()`

# `defaultSku()`

# `defaultWeight()`

# `defaultWidth()`

# `editable()`

# `expiryDate()`

# `hasVariant()`

# `nth()`

# `one()`

# `postDate()`

# `shippingCategory()`

# `shippingCategoryId()`

# `status()`

# `taxCategory()`

# `taxCategoryId()`

# `type()`

# `typeId()`

# `beforePrepare()`

# `cacheTags()`

# `statusCondition()`