StructuredElementQuery

Type
Class
Namespace
craft\db
Inherits
craft\db\StructuredElementQuery » yii\db\ActiveQuery » yii\db\Query » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable, yii\db\ActiveQueryInterface, yii\db\ExpressionInterface, yii\db\QueryInterface
Uses traits
yii\db\ActiveQueryTrait, yii\db\ActiveRelationTrait, yii\db\QueryTrait
Since
3.0

View source

Public Properties

PropertyDescription
$asArrayboolean – Whether to return each record as an array.
$behaviorsyii\base\Behavior – List of behaviors attached to this component
$distinctboolean – Whether to select distinct rows of data only.
$emulateExecutionboolean – Whether to emulate the actual query execution, returning empty or false results.
$fromarray – The table(s) to be selected from.
$groupByarray – How to group the query results.
$havingstring, array, yii\db\ExpressionInterface – The condition to be applied in the GROUP BY clause.
$indexBystring, callable – The name of the column by which the query results should be indexed by.
$inverseOfstring – The name of the relation that is the inverse of this relation.
$joinarray – How to join with other tables.
$joinWitharray – A list of relations that this query should be joined with
$limitinteger, yii\db\ExpressionInterface – Maximum number of records to be returned.
$linkarray – The columns of the primary and foreign tables that establish a relation.
$modelClassstring – The name of the ActiveRecord class.
$multipleboolean – Whether this query represents a relation to more than one record.
$offsetinteger, yii\db\ExpressionInterface – Zero-based offset from where the records are to be returned.
$onstring, array – The join condition to be used when this query is used in a relational context.
$orderByarray – How to sort the query results.
$paramsarray – List of query parameter values indexed by parameter placeholders.
$primaryModelyii\db\ActiveRecord – The primary model of a relational query.
$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.
$selectarray – The columns being selected.
$selectOptionstring – Additional option that should be appended to the 'SELECT' keyword.
$sqlstring – The SQL statement to be executed for retrieving AR records.
$tablesUsedInFromstring[] – Table names indexed by aliases
$unionarray – This is used to construct the UNION clause(s) in a SQL statement.
$viaarray, object – The query associated with the junction table.
$wherestring, array – Query condition.
$witharray – A list of relations that this query should be performed with

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()Clones internal objects.
__construct()Constructor.
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object 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.
alias()Define an alias for the table defined in $modelClass.
all()Executes query and returns all results as an array.
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.
andOnCondition()Adds an additional ON condition to the existing one.
andWhere()Adds an additional WHERE condition to the existing one.
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.
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.
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.
filterHaving()Sets the HAVING part of the query but ignores empty operands.
filterWhere()Sets the WHERE part of the query but ignores empty operands.
findFor()Finds the related records for the specified primary record.
findWith()Finds records corresponding to one or multiple relations and populates them into the primary models.
from()Sets the FROM part of the query.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getTablesUsedInFrom()Returns table names used in from() indexed by aliases.
groupBy()Sets the GROUP BY part of the query.
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.
indexBy()Sets the indexBy() property.
init()Initializes the object.
innerJoin()Appends an INNER JOIN part to the query.
innerJoinWith()Inner joins with the specified relations.
inverseOf()Sets the name of the relation that is the inverse of this relation.
join()Appends a JOIN part to the query.
joinWith()Joins with the specified relations.
leftJoin()Appends a LEFT OUTER JOIN part to the query.
limit()Sets the LIMIT part of the query.
max()Returns the maximum of the specified column values.
min()Returns the minimum of the specified column values.
noCache()Disables query cache for this Query.
off()Detaches an existing event handler from this component.
offset()Sets the OFFSET part of the query.
on()Attaches an event handler to an event.
onCondition()Sets the ON condition for a relational query.
one()Executes 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.
orOnCondition()Adds an additional ON condition to the existing one.
orWhere()Adds an additional WHERE condition to the existing one.
orderBy()Sets the ORDER BY part of the query.
params()Sets the parameters to be bound to the query.
populate()Converts the raw query results into the format as specified by this query.
populateRelation()Finds the related records and populates them into the primary models.
prepare()Prepares for building SQL.
rightJoin()Appends a RIGHT OUTER JOIN part to the query.
scalar()Returns the query result as a scalar value.
select()Sets the SELECT part of the query.
sum()Returns the sum of the specified column values.
trigger()Triggers an event.
union()Appends a SQL statement using UNION operator.
via()Specifies the relation associated with the junction table.
viaTable()Specifies the junction table for a relational query.
where()Sets the WHERE part of the query.
with()Specifies the relations with which this query should be performed.

behaviors()

Returns a list of behaviors that this component should behave as.

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from \craft\db\Behavior. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using getBehavior() or be detached using detachBehavior(). Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

View source

Returns

array – The behavior configurations.

Signature

public array behaviors ( )

Protected Methods

MethodDescription
cleanUpTableNames()Clean up table names and aliases Both aliases and names are enclosed into .
createModels()Converts found rows into model instances.
filterCondition()Removes empty operands from the given query condition.
getPrimaryTableName()
getUnaliasedColumnsFromSelect()
getUniqueColumns()Returns unique column names excluding duplicates.
isEmpty()Returns a value indicating whether the give value is "empty".
normalizeOrderBy()Normalizes format of ORDER BY data.
queryScalar()Queries a scalar value by setting select() first.
setCommandCache()Sets $command cache, if this query has enabled caching.