mirror of
https://github.com/yiisoft/yii2.git
synced 2025-11-04 22:57:40 +08:00
228 lines
7.9 KiB
PHP
228 lines
7.9 KiB
PHP
<?php
|
|
/**
|
|
* @link http://www.yiiframework.com/
|
|
* @copyright Copyright (c) 2008 Yii Software LLC
|
|
* @license http://www.yiiframework.com/license/
|
|
*/
|
|
|
|
namespace yii\mongodb;
|
|
|
|
use yii\db\ActiveQueryInterface;
|
|
use yii\db\ActiveQueryTrait;
|
|
use yii\db\ActiveRelationTrait;
|
|
|
|
/**
|
|
* ActiveQuery represents a Mongo query associated with an Active Record class.
|
|
*
|
|
* An ActiveQuery can be a normal query or be used in a relational context.
|
|
*
|
|
* ActiveQuery instances are usually created by [[ActiveRecord::find()]].
|
|
* Relational queries are created by [[ActiveRecord::hasOne()]] and [[ActiveRecord::hasMany()]].
|
|
*
|
|
* Normal Query
|
|
* ------------
|
|
*
|
|
* ActiveQuery instances are usually created by [[ActiveRecord::find()]].
|
|
*
|
|
* Because ActiveQuery extends from [[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:
|
|
*
|
|
* ```php
|
|
* $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 tables; and the multiplicity of the relation is indicated by [[multiple]].
|
|
*
|
|
* If a relation involves a junction table, 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.
|
|
*
|
|
* @property Collection $collection Collection instance. This property is read-only.
|
|
*
|
|
* @author Paul Klimov <klimov.paul@gmail.com>
|
|
* @since 2.0
|
|
*/
|
|
class ActiveQuery extends Query implements ActiveQueryInterface
|
|
{
|
|
use ActiveQueryTrait;
|
|
use ActiveRelationTrait;
|
|
|
|
/**
|
|
* @event Event an event that is triggered when the query is initialized via [[init()]].
|
|
*/
|
|
const EVENT_INIT = 'init';
|
|
|
|
|
|
/**
|
|
* Constructor.
|
|
* @param array $modelClass the model class associated with this query
|
|
* @param array $config configurations to be applied to the newly created query object
|
|
*/
|
|
public function __construct($modelClass, $config = [])
|
|
{
|
|
$this->modelClass = $modelClass;
|
|
parent::__construct($config);
|
|
}
|
|
|
|
/**
|
|
* 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 function init()
|
|
{
|
|
parent::init();
|
|
$this->trigger(self::EVENT_INIT);
|
|
}
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
protected function buildCursor($db = null)
|
|
{
|
|
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::buildCursor($db);
|
|
}
|
|
|
|
/**
|
|
* Executes query and returns all results as an array.
|
|
* @param Connection $db the Mongo connection used to execute the query.
|
|
* If null, the Mongo connection returned by [[modelClass]] will be used.
|
|
* @return array the query results. If the query results in nothing, an empty array will be returned.
|
|
*/
|
|
public function all($db = null)
|
|
{
|
|
$cursor = $this->buildCursor($db);
|
|
$rows = $this->fetchRows($cursor);
|
|
|
|
return $this->populate($rows);
|
|
}
|
|
|
|
/**
|
|
* Executes query and returns a single row of result.
|
|
* @param Connection $db the Mongo connection used to execute the query.
|
|
* If null, the Mongo connection returned by [[modelClass]] will be used.
|
|
* @return 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;
|
|
} else {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
* @param array $update update criteria
|
|
* @param array $options list of options in format: optionName => optionValue.
|
|
* @param Connection $db the Mongo connection used to execute the query.
|
|
* @return 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;
|
|
} else {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the Mongo collection for this query.
|
|
* @param Connection $db Mongo connection.
|
|
* @return 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);
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
* @param array $rows 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 $models;
|
|
}
|
|
}
|