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

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

View source

Public Properties

PropertyDescription
$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.
$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).
$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.
$ownerSiteIdinteger, string, null – The site ID that the resulting Matrix blocks must have been defined in, or ':empty:' to find blocks without an owner site ID.
$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.
$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.
$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, null – The site ID that the elements should be returned in.
$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.
$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.
$uristring, string[], null – The URI that the resulting element must have.
$wherestring, array – Query condition.
$withstring, array, null – The eager-loading declaration.
$withStructureboolean, null – Whether element structure data should automatically be left-joined into the query.

$fieldId

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

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

View source

Signature

public integer, integer[], string, false, null $fieldId = null

$ownerId

Type
integer, integer[], null

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

View source

Signature

public integer, integer[], null $ownerId = null

$ownerSiteId

Type
integer, string, null

The site ID that the resulting Matrix blocks must have been defined in, or ':empty:' to find blocks without an owner site ID.

View source

Signature

public integer, string, null $ownerSiteId = null

$typeId

Type
integer, integer[], null

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

View source

Signature

public integer, integer[], null $typeId = null

Example

Protected Properties

PropertyDescription
$defaultOrderByarray – The default orderBy() value to use if orderBy() is empty but not null.

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.
ancestorDist()Sets the $ancestorDist property.
ancestorOf()Sets the $ancestorOf property.
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()Appends a value to the with() property.
archived()Sets the $archived property.
asArray()Sets the $asArray property.
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()Sets the $dateCreated property.
dateUpdated()Sets the $dateUpdated property.
descendantDist()Sets the $descendantDist property.
descendantOf()Sets the $descendantOf property.
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.
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()Sets the $enabledForSite property.
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()Sets the $fieldId property.
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()Sets the $fixedOrder property.
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()Sets the $hasDescendants property.
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()Sets the $id property.
ids()Executes the query and returns the IDs of the resulting elements.
inReverse()Sets the $inReverse property.
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()Sets the $leaves property.
leftJoin()Appends a LEFT OUTER JOIN part to the query.
level()Sets the $level property.
limit()Sets the LIMIT part of the query.
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()Sets the $nextSiblingOf property.
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()Sets the OFFSET part of the query.
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()Sets the ORDER BY part of the query.
owner()Sets the $ownerId and ownerSiteId() properties based on a given element.
ownerId()Sets the $ownerId property.
ownerLocale()Sets the \craft\elements\db\$ownerLocale property.
ownerSite()Sets the $ownerSiteId property based on a given site(s)’s handle(s).
ownerSiteId()Sets the $ownerSiteId and siteId() properties.
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()Sets the $positionedAfter property.
positionedBefore()Sets the $positionedBefore property.
prepare()Prepares for building SQL.
prevSiblingOf()Sets the $prevSiblingOf property.
ref()Sets the $ref property.
relatedTo()Sets the $relatedTo property.
rightJoin()Appends a RIGHT OUTER JOIN part to the query.
scalar()Returns the query result as a scalar value.
search()Sets the $search property.
select()Sets the SELECT part of the query.
setCachedResult()Sets the resulting elements.
siblingOf()Sets the $siblingOf property.
site()Sets the $siteId property based on a given site’s handle.
siteId()Sets the $siteId property.
slug()Sets the $slug property.
status()Sets the $status property.
structureId()Sets the $structureId property.
sum()Returns the sum of the specified column values.
title()Sets the $title property.
toArray()Converts the model into an array.
total()Returns the total elements that match the criteria.
trigger()Triggers an event.
type()Sets the $typeId property based on a given block type(s)’s handle(s).
typeId()Sets the $typeId property.
uid()Sets the $uid property.
union()Appends a SQL statement using UNION operator.
uri()Sets the $uri property.
where()Sets the WHERE part of the query.
with()Sets the $with property.
withStructure()Sets the $withStructure property.

__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

Signature

public void __construct ( $elementType, array $config = [] )

__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

Signature

public void __set ( $name, $value )

fieldId()

Sets the $fieldId property.

View source

Arguments

Returns

static – Self reference

Signature

public static fieldId ( $value )

owner()

Sets the $ownerId and ownerSiteId() properties based on a given element.

View source

Arguments

Returns

static – Self reference

Signature

public static owner ( craft\base\ElementInterface $owner )

ownerId()

Sets the $ownerId property.

View source

Arguments

Returns

static – Self reference

Signature

public static ownerId ( $value )

ownerLocale()

DEPRECATED

Deprecated in 3.0. Use ownerSiteId() instead.

Sets the \craft\elements\db\$ownerLocale property.

View source

Arguments

Returns

static – Self reference

Signature

public static ownerLocale ( $value )

ownerSite()

Sets the $ownerSiteId property based on a given site(s)’s handle(s).

View source

Arguments

Returns

static – Self reference

Throws

Signature

public static ownerSite ( $value )

ownerSiteId()

Sets the $ownerSiteId and siteId() properties.

View source

Arguments

Returns

static – Self reference

Signature

public static ownerSiteId ( $value )

type()

Sets the $typeId property based on a given block type(s)’s handle(s).

View source

Arguments

Returns

static – Self reference

Signature

public static type ( $value )

typeId()

Sets the $typeId property.

View source

Arguments

Returns

static – Self reference

Signature

public static typeId ( $value )

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

Signature

protected boolean beforePrepare ( )

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

Signature

protected craft\base\FieldInterface[] customFields ( )