ActiveQuery.php 3.21 KB
Newer Older
1 2 3 4 5 6 7
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

8
namespace yii\mongodb;
9 10 11 12 13

use yii\db\ActiveQueryInterface;
use yii\db\ActiveQueryTrait;

/**
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
 * ActiveQuery represents a Mongo query associated with an Active Record class.
 *
 * 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:
 *
 * ~~~
 * $customers = Customer::find()->with('orders')->asArray()->all();
 * ~~~
31
 *
Qiang Xue committed
32 33
 * @property Collection $collection Collection instance. This property is read-only.
 *
34 35 36 37 38 39
 * @author Paul Klimov <klimov.paul@gmail.com>
 * @since 2.0
 */
class ActiveQuery extends Query implements ActiveQueryInterface
{
	use ActiveQueryTrait;
40 41 42

	/**
	 * Executes query and returns all results as an array.
43 44
	 * @param Connection $db the Mongo connection used to execute the query.
	 * If null, the Mongo connection returned by [[modelClass]] will be used.
45 46 47 48 49
	 * @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);
50
		$rows = $this->fetchRows($cursor);
51
		if (!empty($rows)) {
Carsten Brandt committed
52
			$models = $this->createModels($rows);
53 54
			if (!empty($this->with)) {
				$this->findWith($this->with, $models);
Carsten Brandt committed
55 56 57 58
			}
			if (!$this->asArray) {
				foreach($models as $model) {
					$model->afterFind();
59
				}
60
			}
Carsten Brandt committed
61
			return $models;
62 63 64 65 66 67 68
		} else {
			return [];
		}
	}

	/**
	 * Executes query and returns a single row of result.
69 70
	 * @param Connection $db the Mongo connection used to execute the query.
	 * If null, the Mongo connection returned by [[modelClass]] will be used.
71 72 73 74 75 76 77 78 79 80 81 82 83
	 * @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) {
			if ($this->asArray) {
				$model = $row;
			} else {
				/** @var ActiveRecord $class */
				$class = $this->modelClass;
Carsten Brandt committed
84
				$model = $class::create($row);
85 86 87 88 89 90
			}
			if (!empty($this->with)) {
				$models = [$model];
				$this->findWith($this->with, $models);
				$model = $models[0];
			}
91 92 93
			if (!$this->asArray) {
				$model->afterFind();
			}
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
			return $model;
		} 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 ActiveRecord $modelClass */
		$modelClass = $this->modelClass;
		if ($db === null) {
			$db = $modelClass::getDb();
		}
		if ($this->from === null) {
			$this->from = $modelClass::collectionName();
		}
		return $db->getCollection($this->from);
	}
117
}