MatrixBlockQuery

Type
Class
Namespace
craft\elements\db
Inherits
craft\elements\db\MatrixBlockQuery » 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
3.0.0

MatrixBlockQuery represents a SELECT SQL statement for global sets in a way that is independent of DBMS.

View source

Public Properties

PropertyDescription
allowOwnerDraftsboolean, null – Whether the owner elements can be drafts.
allowOwnerRevisionsboolean, null – Whether the owner elements can be revisions.
ancestorDistinteger, null – The maximum number of levels that results may be separated from ancestorOf().
ancestorOfinteger, craft\base\ElementInterface, null – The element (or its ID) that results must be an ancestor of.
archivedboolean – Whether to return only archived elements.
asArrayboolean – Whether to return each element as an array.
behaviorsyii\base\Behavior – List of behaviors attached to this component
cachedResultcraft\base\ElementInterface[], null – $elements The resulting elements, or null if setCachedResult() was never called or the criteria has changed
contentTablestring, null – The content table that will be joined by this query.
criteriaarray
customFieldscraft\base\FieldInterface[], null – The fields that may be involved in this query.
dateCreatedmixed – When the resulting elements must have been created.
dateUpdatedmixed – When the resulting elements must have been last updated.
descendantDistinteger, null – The maximum number of levels that results may be separated from descendantOf().
descendantOfinteger, craft\base\ElementInterface, null – The element (or its ID) that results must be a descendant of.
distinctboolean – Whether to select distinct rows of data only.
draftCreatorinteger, null – The drafts’ creator ID
draftIdinteger, null – The ID of the draft to return (from the drafts table)
draftOfinteger, false, null – The source element ID that drafts should be returned for.
draftsboolean – Whether draft elements should be returned.
elementTypestring, null – The name of the craft\base\ElementInterface class.
emulateExecutionboolean – Whether to emulate the actual query execution, returning empty or false results.
enabledForSiteboolean – Whether the elements must be enabled for the chosen site.
fieldIdinteger, integer[], string, false, null – The field ID(s) that the resulting Matrix blocks must belong to.
fixedOrderboolean – Whether results should be returned in the order specified by id().
fromarray – The table(s) to be selected from.
groupByarray – How to group the query results.
hasDescendantsboolean, null – Whether the resulting elements must have descendants.
havingstring, array, yii\db\ExpressionInterface – The condition to be applied in the GROUP BY clause.
idinteger, integer[], false, null – The element ID(s).
ignorePlaceholdersboolean – Whether to ignore placeholder elements when populating the results.
inReverseboolean – Whether the results should be queried in reverse.
indexBystring, callable – The name of the column by which the query results should be indexed by.
iteratorArrayIterator
joinarray – How to join with other tables.
leavesboolean – Whether the elements must be “leaves” in the structure.
levelmixed – The element’s level within the structure
limitinteger, yii\db\ExpressionInterface – Maximum number of records to be returned.
nextSiblingOfinteger, craft\base\ElementInterface, null – The element (or its ID) that the result must be the next sibling of.
offsetinteger, yii\db\ExpressionInterface – Zero-based offset from where the records are to be returned.
orderByarray – How to sort the query results.
ownerIdinteger, integer[], null – The owner element ID(s) that the resulting Matrix blocks must belong to.
ownerSiteIdmixed
paramsarray – List of query parameter values indexed by parameter placeholders.
positionedAfterinteger, craft\base\ElementInterface, null – The element (or its ID) that the results must be positioned after.
positionedBeforeinteger, craft\base\ElementInterface, null – The element (or its ID) that the results must be positioned before.
preferSitesarray, null – Determines which site should be selected when querying multi-site elements.
prevSiblingOfinteger, craft\base\ElementInterface, null – The element (or its ID) that the result must be the previous sibling of.
querycraft\db\Query, null – The query object created by prepare()
queryCacheDependencyyii\caching\Dependency – The dependency to be associated with the cached query result for this query
queryCacheDurationinteger, true – The default number of seconds that query results can remain valid in cache.
rawSqlstring
refstring, string[], null – The reference code(s) used to identify the element(s).
relatedTointeger, array, craft\base\ElementInterface, null – The element relation criteria.
revisionCreatorinteger, null – The revisions’ creator ID
revisionIdinteger, null – The ID of the revision to return (from the revisions table)
revisionOfinteger, null – The source element ID that revisions should be returned for
revisionsboolean – Whether revision elements should be returned.
searchstring, array, craft\search\SearchQuery, null – The search term to filter the resulting elements by.
selectarray – The columns being selected.
selectOptionstring – Additional option that should be appended to the 'SELECT' keyword.
siblingOfinteger, craft\base\ElementInterface, null – The element (or its ID) that the results must be a sibling of.
siteIdinteger, integer[], string, null – The site ID(s) that the elements should be returned in, or '*' if elements should be returned in all supported sites.
slugstring, string[], null – The slug that resulting elements must have.
statusstring, string[], null – The status(es) that the resulting elements must have.
structureIdinteger, false, null – The structure ID that should be used to join in the structureelements table.
subQuerycraft\db\Query, null – The subselect’s query object created by prepare()
tablesUsedInFromstring[] – Table names indexed by aliases
titlestring, string[], null – The title that resulting elements must have.
trashedboolean, null – Whether to return trashed (soft-deleted) elements.
typeIdinteger, integer[], null – The block type ID(s) that the resulting Matrix blocks must have.
uidstring, string[], null – The element UID(s).
unionarray – This is used to construct the UNION clause(s) in a SQL statement.
uniqueboolean – Whether only elements with unique IDs should be returned by the query.
uristring, string[], null – The URI that the resulting element must have.
wherestring, array, yii\db\ExpressionInterface – Query condition.
withstring, array, null – The eager-loading declaration.
withStructureboolean, null – Whether element structure data should automatically be left-joined into the query.

allowOwnerDrafts

Type
boolean, null
Since
3.3.10

Whether the owner elements can be drafts.

View source

allowOwnerRevisions

Type
boolean, null
Since
3.3.10

Whether the owner elements can be revisions.

View source

fieldId

Type
integer, integer[], string, false, null

The field ID(s) that the resulting Matrix blocks must belong to.

View source

ownerId

Type
integer, integer[], null

The owner element ID(s) that the resulting Matrix blocks must belong to.

View source

ownerSiteId

DEPRECATED

Deprecated in 3.2

Type
mixed

View source

typeId

Type
integer, integer[], null

The block type ID(s) that the resulting Matrix blocks must have.

View source

Example

Protected Properties

PropertyDescription
defaultOrderByarray – 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

MethodDescription
__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 an object property to 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.
allowOwnerDrafts()Narrows the query results based on whether the Matrix blocks’ owners are drafts.
allowOwnerRevisions()Narrows the query results based on whether the Matrix blocks’ owners are revisions.
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.
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.
dateCreated()Narrows the query results based on the {elements}’ creation 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.
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.
extraFields()Returns the list of fields that can be expanded further and returned by toArray().
fieldId()Narrows the query results based on the field the Matrix blocks belong to, per the fields’ IDs.
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.
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.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined.
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.
isJoined()Returns whether a given table has been joined in this query.
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.
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.
owner()Sets the ownerId() and siteId() parameters based on a given element.
ownerId()Narrows the query results based on the owner element of the Matrix blocks, per the owners’ IDs.
ownerLocale()
ownerSite()
ownerSiteId()
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.
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.
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.
type()Narrows the query results based on the Matrix blocks’ block types.
typeId()Narrows the query results based on the Matrix blocks’ block types, per the types’ IDs.
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.
where()Sets the WHERE part of the query.
with()Causes the query to return matching {elements} eager-loaded with related elements.
withStructure()Explicitly determines whether the query should join in the structure data.

__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

Arguments

  • $name (string) – The property name or the event name
  • $value (mixed) – The property value

Throws

allowOwnerDrafts()

Since
3.3.10

Narrows the query results based on whether the Matrix blocks’ owners are drafts. Possible values include:

ValueFetches {elements}…
truewhich can belong to a draft.
falsewhich cannot belong to a draft.

View source

Arguments

Returns

static – Self reference

allowOwnerRevisions()

Since
3.3.10

Narrows the query results based on whether the Matrix blocks’ owners are revisions. Possible values include:

ValueFetches {elements}…
truewhich can belong to a revision.
falsewhich cannot belong to a revision.

View source

Arguments

Returns

static – Self reference

fieldId()

Narrows the query results based on the field the Matrix blocks belong to, per the fields’ IDs. Possible values include:

ValueFetches {elements}…
1in a field with an ID of 1.
'not 1'not in a field with an ID of 1.
[1, 2]in a field with an ID of 1 or 2.
['not', 1, 2]not in a field with an ID of 1 or 2.

View source

Arguments

Returns

static – Self reference

Example

owner()

Sets the ownerId() and siteId() parameters based on a given element.

View source

Arguments

Returns

static – Self reference

Example

ownerId()

Narrows the query results based on the owner element of the Matrix blocks, per the owners’ IDs. Possible values include:

ValueFetches {elements}…
1created for an element with an ID of 1.
'not 1'not created for an element with an ID of 1.
[1, 2]created for an element with an ID of 1 or 2.
['not', 1, 2]not created for an element with an ID of 1 or 2.

View source

Arguments

Returns

static – Self reference

Example

ownerLocale()

DEPRECATED

Deprecated in 3.0.

View source

Returns

static – Self reference

ownerSite()

DEPRECATED

Deprecated in 3.2.

View source

Returns

static – Self reference

ownerSiteId()

DEPRECATED

Deprecated in 3.2.

View source

Returns

static – Self reference

type()

Narrows the query results based on the Matrix blocks’ block types. Possible values include:

ValueFetches {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 MatrixBlockType objectof a type represented by the object.

View source

Arguments

Returns

static – Self reference

Example

typeId()

Narrows the query results based on the Matrix blocks’ block types, per the types’ IDs. Possible values include:

ValueFetches {elements}…
1of 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

Arguments

Returns

static – Self reference

Example

Protected Methods

MethodDescription
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 {{ and }}.
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.

customFields()

Returns the fields that should take part in an upcoming elements query.

These fields will get their own criteria parameters in the craft\elements\db\ElementQueryInterface that gets passed in, their field types will each have an opportunity to help build the element query, and their columns in the content table will be selected by the query (for those that have one). If a field has its own column in the content table, but the column name is prefixed with something besides “field_”, make sure you set the columnPrefix attribute on the craft\base\Field, so craft\services\Elements::buildElementsQuery() knows which column to select.

View source

Returns

craft\base\FieldInterface[] – The fields that should take part in the upcoming elements query