Class yii\mongodb\ActiveQuery

All Classes | Properties | Methods | Events
Inheritanceyii\mongodb\ActiveQuery » yii\mongodb\Query » yii\base\Component
Implementsyii\db\ActiveQueryInterface, yii\db\QueryInterface
Uses Traitsyii\db\ActiveQueryTrait, yii\db\ActiveRelationTrait, yii\db\QueryTrait
Available since extension's version2.0
Source Code https://github.com/yiisoft/yii2-mongodb/blob/master/src/ActiveQuery.php

ActiveQuery represents a Mongo query associated with an Active Record class.

  1. Normal Query
  2. Relational query

An ActiveQuery can be a normal query or be used in a relational context.

ActiveQuery instances are usually created by yii\mongodb\ActiveRecord::find(). Relational queries are created by ActiveRecord::hasOne() and ActiveRecord::hasMany().

Normal Query

ActiveQuery instances are usually created by yii\mongodb\ActiveRecord::find().

Because ActiveQuery extends from yii\mongodb\Query, one can use query methods, such as where(), orderBy() to customize the query options.

ActiveQuery also provides the following additional query options:

  • with(): list of relations that this query should be performed with.
  • asArray(): whether to return each record as an array.

These options can be configured using methods of the same name. For example:

$customers = Customer::find()->with('orders')->asArray()->all();

Relational query

In relational context ActiveQuery represents a relation between two Active Record classes.

Relational ActiveQuery instances are usually created by calling ActiveRecord::hasOne() and ActiveRecord::hasMany(). An Active Record class declares a relation by defining a getter method which calls one of the above methods and returns the created ActiveQuery object.

A relation is specified by link which represents the association between columns of different collections; and the multiplicity of the relation is indicated by multiple.

If a relation involves a junction collection, it may be specified by via(). This methods may only be called in a relational context. Same is true for inverseOf(), which marks a relation as inverse of another relation.

Public Properties

Hide inherited properties

Property Type Description Defined By
$collection yii\mongodb\Collection Collection instance. yii\mongodb\ActiveQuery
$from string|array The collection to be selected from. yii\mongodb\Query
$options array Cursor options in format: optionKey => optionValue yii\mongodb\Query
$select array The fields of the results to return. yii\mongodb\Query

Public Methods

Hide inherited methods

Method Description Defined By
__construct() Constructor. yii\mongodb\ActiveQuery
addOptions() Adds additional cursor options. yii\mongodb\Query
all() Executes query and returns all results as an array. yii\mongodb\ActiveQuery
andFilterCompare() Helper method for easy querying on values containing some common operators. yii\mongodb\Query
average() Returns the average of the specified column values. yii\mongodb\Query
batch() Starts a batch query. yii\mongodb\Query
buildCursor() Builds the MongoDB cursor for this query. yii\mongodb\Query
column() Executes the query and returns the first column of the result. yii\mongodb\Query
count() Returns the number of records. yii\mongodb\Query
distinct() Returns a list of distinct values for the given column across a collection. yii\mongodb\Query
each() Starts a batch query and retrieves data row by row. yii\mongodb\Query
exists() Returns a value indicating whether the query result contains any row of data. yii\mongodb\Query
from() Sets the collection to be selected from. yii\mongodb\Query
getCollection() Returns the Mongo collection for this query. yii\mongodb\ActiveQuery
init() Initializes the object. yii\mongodb\ActiveQuery
max() Returns the maximum of the specified column values. yii\mongodb\Query
min() Returns the minimum of the specified column values. yii\mongodb\Query
modify() Performs 'findAndModify' query and returns a single row of result. yii\mongodb\ActiveQuery
one() Executes query and returns a single row of result. yii\mongodb\ActiveQuery
options() Sets the cursor options. yii\mongodb\Query
populate() Converts the raw query results into the format as specified by this query. yii\mongodb\ActiveQuery
prepare() Prepares for query building. yii\mongodb\ActiveQuery
scalar() Returns the query result as a scalar value. yii\mongodb\Query
select() Sets the list of fields of the results to return. yii\mongodb\Query
sum() Returns the sum of the specified column values. yii\mongodb\Query

Protected Methods

Hide inherited methods

Method Description Defined By
aggregate() Performs the aggregation for the given column. yii\mongodb\Query
fetchRows() Fetches rows from the given Mongo cursor. yii\mongodb\Query
fetchRowsInternal() yii\mongodb\Query

Events

Hide inherited events

Event Type Description Defined By
EVENT_INIT yii\mongodb\Event An event that is triggered when the query is initialized via init(). yii\mongodb\ActiveQuery

Property Details

Hide inherited properties

$collection public property

Collection instance.

public yii\mongodb\Collection $collection = null

Method Details

Hide inherited methods

__construct() public method

Constructor.

public void __construct ( $modelClass, $config = [] )
$modelClass string

The model class associated with this query
$config array

Configurations to be applied to the newly created query object

 

                public function __construct($modelClass, $config = [])
{
    $this->modelClass = $modelClass;
    parent::__construct($config);
}
addOptions() public method

Defined in: yii\mongodb\Query::addOptions()

Adds additional cursor options.

See also options().

public $this addOptions ( $options )
$options array

Cursor options in format: optionName => optionValue
return $this

The query object itself

 

                public function addOptions($options)
{
    if (is_array($this->options)) {
        $this->options = array_merge($this->options, $options);
    } else {
        $this->options = $options;
    }
    return $this;
}
aggregate() protected method

Defined in: yii\mongodb\Query::aggregate()

Performs the aggregation for the given column.

protected integer aggregate ( $column, $operator, $db )
$column string

Column name.
$operator string

Aggregation operator.
$db yii\mongodb\Connection

The database connection used to execute the query.
return integer

Aggregation result.

 

                protected function aggregate($column, $operator, $db)
{
    if (!empty($this->emulateExecution)) {
        return null;
    }
    $this->prepare();
    $collection = $this->getCollection($db);
    $pipelines = [];
    if ($this->where !== null) {
        $pipelines[] = ['$match' => $this->where];
    }
    $pipelines[] = [
        '$group' => [
            '_id' => '1',
            'total' => [
                '$' . $operator => '$' . $column
            ],
        ]
    ];
    $result = $collection->aggregate($pipelines);
    if (array_key_exists(0, $result)) {
        return $result[0]['total'];
    }
    return null;
}
all() public method

Executes query and returns all results as an array.

public array|yii\mongodb\ActiveRecord all ( $db = null )
$db yii\mongodb\Connection

The Mongo connection used to execute the query. If null, the Mongo connection returned by modelClass will be used.
return array|yii\mongodb\ActiveRecord

The query results. If the query results in nothing, an empty array will be returned.

 

                public function all($db = null)
{
    return parent::all($db);
}
andFilterCompare() public method (available since version 2.0.5)

Defined in: yii\mongodb\Query::andFilterCompare()

Helper method for easy querying on values containing some common operators.

The comparison operator is intelligently determined based on the first few characters in the given value and internally translated to a MongoDB operator. In particular, it recognizes the following operators if they appear as the leading characters in the given value: <: the column must be less than the given value ($lt). >: the column must be greater than the given value ($gt). <=: the column must be less than or equal to the given value ($lte). >=: the column must be greater than or equal to the given value ($gte). <>: the column must not be the same as the given value ($ne). Note that when $partialMatch is true, this would mean the value must not be a substring of the column. =: the column must be equal to the given value ($eq). none of the above: use the $defaultOperator

Note that when the value is empty, no comparison expression will be added to the search condition.

See also \yii\mongodb\Collection::buildCondition().

public $this andFilterCompare ( $name, $value, $defaultOperator = '=' )
$name string

Column name
$value string

Column value
$defaultOperator string

Defaults to =, performing an exact match. For example: use 'LIKE' or 'REGEX' for partial cq regex matching
return $this

The query object itself.

 

                public function andFilterCompare($name, $value, $defaultOperator = '=')
{
    $matches = [];
    if (preg_match('/^(<>|>=|>|<=|<|=)/', (string)$value, $matches)) {
        $op = $matches[1];
        $value = substr($value, strlen($op));
    } else {
        $op = $defaultOperator;
    }
    return $this->andFilterWhere([$op, $name, $value]);
}
average() public method

Defined in: yii\mongodb\Query::average()

Returns the average of the specified column values.

public integer average ( $q, $db = null )
$q string

The column name. Make sure you properly quote column names in the expression.
$db yii\mongodb\Connection

The Mongo connection used to execute the query. If this parameter is not given, the mongodb application component will be used.
return integer

The average of the specified column values.

 

                public function average($q, $db = null)
{
    if (!empty($this->emulateExecution)) {
        return 0;
    }
    return $this->aggregate($q, 'avg', $db);
}
batch() public method (available since version 2.1)

Defined in: yii\mongodb\Query::batch()

Starts a batch query.

A batch query supports fetching data in batches, which can keep the memory usage under a limit. This method will return a yii\mongodb\BatchQueryResult object which implements the Iterator interface and can be traversed to retrieve the data in batches.

For example,

$query = (new Query)->from('user');
foreach ($query->batch() as $rows) {
    // $rows is an array of 10 or fewer rows from user collection
}
public yii\mongodb\BatchQueryResult batch ( $batchSize = 100, $db = null )
$batchSize integer

The number of records to be fetched in each batch.
$db yii\mongodb\Connection

The MongoDB connection. If not set, the "mongodb" application component will be used.
return yii\mongodb\BatchQueryResult

The batch query result. It implements the Iterator interface and can be traversed to retrieve the data in batches.

 

                public function batch($batchSize = 100, $db = null)
{
    return Yii::createObject([
        'class' => BatchQueryResult::className(),
        'query' => $this,
        'batchSize' => $batchSize,
        'db' => $db,
        'each' => false,
    ]);
}
buildCursor() public method

Defined in: yii\mongodb\Query::buildCursor()

Builds the MongoDB cursor for this query.

public \MongoDB\Driver\Cursor buildCursor ( $db = null )
$db yii\mongodb\Connection

The MongoDB connection used to execute the query.
return \MongoDB\Driver\Cursor

Mongo cursor instance.

 

                public function buildCursor($db = null)
{
    $this->prepare();
    $options = $this->options;
    if (!empty($this->orderBy)) {
        $options['sort'] = $this->orderBy;
    }
    $options['limit'] = $this->limit;
    $options['skip'] = $this->offset;
    $cursor = $this->getCollection($db)->find($this->composeCondition(), $this->select, $options);
    return $cursor;
}
column() public method (available since version 2.1.2)

Defined in: yii\mongodb\Query::column()

Executes the query and returns the first column of the result.

Column _id will be automatically excluded from select fields, if select() is not empty and _id is not selected explicitly.

public array column ( $db = null )
$db yii\mongodb\Connection

The MongoDB connection used to generate the query. If this parameter is not given, the mongodb application component will be used.
return array

The first column of the query result. An empty array is returned if the query results in nothing.

 

                public function column($db = null)
{
    if (!empty($this->emulateExecution)) {
        return [];
    }
    $originSelect = (array)$this->select;
    if (!isset($originSelect['_id']) && array_search('_id', $originSelect, true) === false) {
        $this->select['_id'] = false;
    }
    if (is_string($this->indexBy) && $originSelect && count($originSelect) === 1) {
        $this->select[] = $this->indexBy;
    }
    $cursor = $this->buildCursor($db);
    $rows = $this->fetchRows($cursor, true);
    if (empty($rows)) {
        return [];
    }
    $results = [];
    foreach ($rows as $row) {
        $value = reset($row);
        if ($this->indexBy === null) {
            $results[] = $value;
        } else {
            if ($this->indexBy instanceof \Closure) {
                $results[call_user_func($this->indexBy, $row)] = $value;
            } else {
                $results[$row[$this->indexBy]] = $value;
            }
        }
    }
    return $results;
}
count() public method

Defined in: yii\mongodb\Query::count()

Returns the number of records.

public integer count ( $q = '*', $db = null )
$q string

Kept to match QueryInterface, its value is ignored.
$db yii\mongodb\Connection

The Mongo connection used to execute the query. If this parameter is not given, the mongodb application component will be used.
return integer

Number of records
throws yii\mongodb\Exception

on failure.

 

                public function count($q = '*', $db = null)
{
    if (!empty($this->emulateExecution)) {
        return 0;
    }
    $this->prepare();
    $collection = $this->getCollection($db);
    return $collection->count($this->where, $this->options);
}
distinct() public method

Defined in: yii\mongodb\Query::distinct()

Returns a list of distinct values for the given column across a collection.

public array distinct ( $q, $db = null )
$q string

Column to use.
$db yii\mongodb\Connection

The MongoDB connection used to execute the query. If this parameter is not given, the mongodb application component will be used.
return array

Array of distinct values

 

                public function distinct($q, $db = null)
{
    if (!empty($this->emulateExecution)) {
        return [];
    }
    $this->prepare();
    $collection = $this->getCollection($db);
    if ($this->where !== null) {
        $condition = $this->where;
    } else {
        $condition = [];
    }
    $result = $collection->distinct($q, $condition);
    if ($result === false) {
        return [];
    }
    return $result;
}
each() public method (available since version 2.1)

Defined in: yii\mongodb\Query::each()

Starts a batch query and retrieves data row by row.

This method is similar to batch() except that in each iteration of the result, only one row of data is returned. For example,

$query = (new Query)->from('user');
foreach ($query->each() as $row) {
}
public yii\mongodb\BatchQueryResult each ( $batchSize = 100, $db = null )
$batchSize integer

The number of records to be fetched in each batch.
$db yii\mongodb\Connection

The MongoDB connection. If not set, the "mongodb" application component will be used.
return yii\mongodb\BatchQueryResult

The batch query result. It implements the Iterator interface and can be traversed to retrieve the data in batches.

 

                public function each($batchSize = 100, $db = null)
{
    return Yii::createObject([
        'class' => BatchQueryResult::className(),
        'query' => $this,
        'batchSize' => $batchSize,
        'db' => $db,
        'each' => true,
    ]);
}
exists() public method

Defined in: yii\mongodb\Query::exists()

Returns a value indicating whether the query result contains any row of data.

public boolean exists ( $db = null )
$db yii\mongodb\Connection

The Mongo connection used to execute the query. If this parameter is not given, the mongodb application component will be used.
return boolean

Whether the query result contains any row of data.

 

                public function exists($db = null)
{
    if (!empty($this->emulateExecution)) {
        return false;
    }
    $cursor = $this->buildCursor($db);
    foreach ($cursor as $row) {
        return true;
    }
    return false;
}
fetchRows() protected method

Defined in: yii\mongodb\Query::fetchRows()

Fetches rows from the given Mongo cursor.

protected array|boolean fetchRows ( $cursor, $all = true, $indexBy = null )
$cursor \MongoDB\Driver\Cursor

Mongo cursor instance to fetch data from.
$all boolean

Whether to fetch all rows or only first one.
$indexBy string|callable

The column name or PHP callback, by which the query results should be indexed by.
return array|boolean

Result.
throws yii\mongodb\Exception

on failure.

 

                protected function fetchRows($cursor, $all = true, $indexBy = null)
{
    $token = 'fetch cursor id = ' . $cursor->getId();
    Yii::info($token, __METHOD__);
    try {
        Yii::beginProfile($token, __METHOD__);
        $result = $this->fetchRowsInternal($cursor, $all);
        Yii::endProfile($token, __METHOD__);
        return $result;
    } catch (\Exception $e) {
        Yii::endProfile($token, __METHOD__);
        throw new Exception($e->getMessage(), (int) $e->getCode(), $e);
    }
}
fetchRowsInternal() protected method

Defined in: yii\mongodb\Query::fetchRowsInternal()

See also yii\mongodb\Query::fetchRows().

protected array|boolean fetchRowsInternal ( $cursor, $all )
$cursor \MongoDB\Driver\Cursor

Mongo cursor instance to fetch data from.
$all boolean

Whether to fetch all rows or only first one.
return array|boolean

Result.

 

                protected function fetchRowsInternal($cursor, $all)
{
    $result = [];
    if ($all) {
        foreach ($cursor as $row) {
            $result[] = $row;
        }
    } else {
        if ($row = current($cursor->toArray())) {
            $result = $row;
        } else {
            $result = false;
        }
    }
    return $result;
}
from() public method

Defined in: yii\mongodb\Query::from()

Sets the collection to be selected from.

public $this from ( $collection )
$collection
return $this

The query object itself.

 

                public function from($collection)
{
    $this->from = $collection;
    return $this;
}
getCollection() public method

Returns the Mongo collection for this query.

public yii\mongodb\Collection getCollection ( $db = null )
$db yii\mongodb\Connection

Mongo connection.
return yii\mongodb\Collection

Collection instance.

 

                public function getCollection($db = null)
{
    /* @var $modelClass ActiveRecord */
    $modelClass = $this->modelClass;
    if ($db === null) {
        $db = $modelClass::getDb();
    }
    if ($this->from === null) {
        $this->from = $modelClass::collectionName();
    }
    return $db->getCollection($this->from);
}
init() public method

Initializes the object.

This method is called at the end of the constructor. The default implementation will trigger an EVENT_INIT event. If you override this method, make sure you call the parent implementation at the end to ensure triggering of the event.

public void init ( )

                public function init()
{
    parent::init();
    $this->trigger(self::EVENT_INIT);
}
max() public method

Defined in: yii\mongodb\Query::max()

Returns the maximum of the specified column values.

public integer max ( $q, $db = null )
$q string

The column name. Make sure you properly quote column names in the expression.
$db yii\mongodb\Connection

The MongoDB connection used to execute the query. If this parameter is not given, the mongodb application component will be used.
return integer

The maximum of the specified column values.

 

                public function max($q, $db = null)
{
    return $this->aggregate($q, 'max', $db);
}
min() public method

Defined in: yii\mongodb\Query::min()

Returns the minimum of the specified column values.

public integer min ( $q, $db = null )
$q string

The column name. Make sure you properly quote column names in the expression.
$db yii\mongodb\Connection

The MongoDB connection used to execute the query. If this parameter is not given, the db application component will be used.
return integer

The minimum of the specified column values.

 

                public function min($q, $db = null)
{
    return $this->aggregate($q, 'min', $db);
}
modify() public method

Performs 'findAndModify' query and returns a single row of result.

Warning: in case 'new' option is set to 'false' (which is by default) usage of this method may lead to unexpected behavior at some Active Record features, because object will be populated by outdated data.

public yii\mongodb\ActiveRecord|array|null modify ( $update, $options = [], $db = null )
$update array

Update criteria
$options array

List of options in format: optionName => optionValue.
$db yii\mongodb\Connection

The Mongo connection used to execute the query.
return yii\mongodb\ActiveRecord|array|null

The original document, or the modified document when $options['new'] is set. Depending on the setting of asArray, the query result may be either an array or an ActiveRecord object. Null will be returned if the query results in nothing.

 

                public function modify($update, $options = [], $db = null)
{
    $row = parent::modify($update, $options, $db);
    if ($row !== null) {
        $models = $this->populate([$row]);
        return reset($models) ?: null;
    }
    return null;
}
one() public method

Executes query and returns a single row of result.

public yii\mongodb\ActiveRecord|array|null one ( $db = null )
$db yii\mongodb\Connection

The Mongo connection used to execute the query. If null, the Mongo connection returned by modelClass will be used.
return yii\mongodb\ActiveRecord|array|null

A single row of query result. Depending on the setting of asArray, the query result may be either an array or an ActiveRecord object. Null will be returned if the query results in nothing.

 

                public function one($db = null)
{
    $row = parent::one($db);
    if ($row !== false) {
        $models = $this->populate([$row]);
        return reset($models) ?: null;
    }
    return null;
}
options() public method

Defined in: yii\mongodb\Query::options()

Sets the cursor options.

See also addOptions().

public $this options ( $options )
$options array

Cursor options in format: optionName => optionValue
return $this

The query object itself

 

                public function options($options)
{
    $this->options = $options;
    return $this;
}
populate() public method

Converts the raw query results into the format as specified by this query.

This method is internally used to convert the data fetched from MongoDB into the format as required by this query.

public array populate ( $rows )
$rows array

The raw query result from MongoDB
return array

The converted query result

 

                public function populate($rows)
{
    if (empty($rows)) {
        return [];
    }
    $models = $this->createModels($rows);
    if (!empty($this->with)) {
        $this->findWith($this->with, $models);
    }
    if (!$this->asArray) {
        foreach ($models as $model) {
            $model->afterFind();
        }
    }
    return parent::populate($models);
}
prepare() public method (available since version 2.1.3)

Prepares for query building.

This method is called before actual query composition, e.g. building cursor, count etc. You may override this method to do some final preparation work before query execution.

public $this prepare ( )
return $this

A prepared query instance.

 

                public function prepare()
{
    if ($this->primaryModel !== null) {
        // lazy loading
        if ($this->via instanceof self) {
            // via pivot collection
            $viaModels = $this->via->findJunctionRows([$this->primaryModel]);
            $this->filterByModels($viaModels);
        } elseif (is_array($this->via)) {
            // via relation
            /* @var $viaQuery ActiveQuery */
            list($viaName, $viaQuery) = $this->via;
            if ($viaQuery->multiple) {
                $viaModels = $viaQuery->all();
                $this->primaryModel->populateRelation($viaName, $viaModels);
            } else {
                $model = $viaQuery->one();
                $this->primaryModel->populateRelation($viaName, $model);
                $viaModels = $model === null ? [] : [$model];
            }
            $this->filterByModels($viaModels);
        } else {
            $this->filterByModels([$this->primaryModel]);
        }
    }
    return parent::prepare();
}
scalar() public method (available since version 2.1.2)

Defined in: yii\mongodb\Query::scalar()

Returns the query result as a scalar value.

The value returned will be the first column in the first row of the query results. Column _id will be automatically excluded from select fields, if select() is not empty and _id is not selected explicitly.

public string|null|false scalar ( $db = null )
$db yii\mongodb\Connection

The MongoDB connection used to generate the query. If this parameter is not given, the mongodb application component will be used.
return string|null|false

The value of the first column in the first row of the query result. false is returned if the query result is empty.

 

                public function scalar($db = null)
{
    if (!empty($this->emulateExecution)) {
        return null;
    }
    $originSelect = (array)$this->select;
    if (!isset($originSelect['_id']) && array_search('_id', $originSelect, true) === false) {
        $this->select['_id'] = false;
    }
    $cursor = $this->buildCursor($db);
    $row = $this->fetchRows($cursor, false);
    if (empty($row)) {
        return false;
    }
    return reset($row);
}
select() public method

Defined in: yii\mongodb\Query::select()

Sets the list of fields of the results to return.

public $this select ( array $fields )
$fields array

Fields of the results to return.
return $this

The query object itself.

 

                public function select(array $fields)
{
    $this->select = $fields;
    return $this;
}
sum() public method

Defined in: yii\mongodb\Query::sum()

Returns the sum of the specified column values.

public integer sum ( $q, $db = null )
$q string

The column name. Make sure you properly quote column names in the expression.
$db yii\mongodb\Connection

The Mongo connection used to execute the query. If this parameter is not given, the mongodb application component will be used.
return integer

The sum of the specified column values

 

                public function sum($q, $db = null)
{
    if (!empty($this->emulateExecution)) {
        return 0;
    }
    return $this->aggregate($q, 'sum', $db);
}

Event Details

Hide inherited properties

EVENT_INIT event of type yii\mongodb\Event

An event that is triggered when the query is initialized via init().