Query.php 10.2 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

use yii\base\Component;
use yii\db\QueryInterface;
12
use yii\db\QueryTrait;
13
use yii\helpers\Json;
14
use Yii;
15 16

/**
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
 * Query represents Mongo "find" operation.
 *
 * Query provides a set of methods to facilitate the specification of "find" command.
 * These methods can be chained together.
 *
 * For example,
 *
 * ~~~
 * $query = new Query;
 * // compose the query
 * $query->select(['name', 'status'])
 *     ->from('customer')
 *     ->limit(10);
 * // execute the query
 * $rows = $query->all();
 * ~~~
33
 *
Qiang Xue committed
34 35
 * @property Collection $collection Collection instance. This property is read-only.
 *
36 37 38 39 40
 * @author Paul Klimov <klimov.paul@gmail.com>
 * @since 2.0
 */
class Query extends Component implements QueryInterface
{
41
	use QueryTrait;
42 43

	/**
44 45 46
	 * @var array the fields of the results to return. For example, `['name', 'group_id']`.
	 * The "_id" field is always returned. If not set, if means selecting all columns.
	 * @see select()
47
	 */
48
	public $select = [];
49
	/**
50 51 52 53
	 * @var string|array the collection to be selected from. If string considered as  the name of the collection
	 * inside the default database. If array - first element considered as the name of the database,
	 * second - as name of collection inside that database
	 * @see from()
54
	 */
55
	public $from;
56 57

	/**
58 59 60
	 * Returns the Mongo collection for this query.
	 * @param Connection $db Mongo connection.
	 * @return Collection collection instance.
61
	 */
62
	public function getCollection($db = null)
63
	{
64
		if ($db === null) {
65
			$db = Yii::$app->getComponent('mongodb');
66 67
		}
		return $db->getCollection($this->from);
68 69 70
	}

	/**
71 72 73
	 * Sets the list of fields of the results to return.
	 * @param array $fields fields of the results to return.
	 * @return static the query object itself.
74
	 */
75
	public function select(array $fields)
76
	{
77 78
		$this->select = $fields;
		return $this;
79 80 81
	}

	/**
82 83 84 85 86
	 * Sets the collection to be selected from.
	 * @param string|array the collection to be selected from. If string considered as  the name of the collection
	 * inside the default database. If array - first element considered as the name of the database,
	 * second - as name of collection inside that database
	 * @return static the query object itself.
87
	 */
88
	public function from($collection)
89
	{
90 91
		$this->from = $collection;
		return $this;
92 93 94
	}

	/**
95
	 * Builds the Mongo cursor for this query.
96 97
	 * @param Connection $db the database connection used to execute the query.
	 * @return \MongoCursor mongo cursor instance.
98
	 */
99
	protected function buildCursor($db = null)
100
	{
101
		if ($this->where === null) {
102
			$where = [];
103 104
		} else {
			$where = $this->where;
105
		}
106 107 108 109 110 111
		$selectFields = [];
		if (!empty($this->select)) {
			foreach ($this->select as $fieldName) {
				$selectFields[$fieldName] = true;
			}
		}
112
		$cursor = $this->getCollection($db)->find($where, $selectFields);
113 114 115
		if (!empty($this->orderBy)) {
			$sort = [];
			foreach ($this->orderBy as $fieldName => $sortOrder) {
116
				$sort[$fieldName] = $sortOrder === SORT_DESC ? \MongoCollection::DESCENDING : \MongoCollection::ASCENDING;
117
			}
118
			$cursor->sort($sort);
119 120 121 122
		}
		$cursor->limit($this->limit);
		$cursor->skip($this->offset);
		return $cursor;
123 124
	}

125
	/**
126
	 * Fetches rows from the given Mongo cursor.
127 128
	 * @param \MongoCursor $cursor Mongo cursor instance to fetch data from.
	 * @param boolean $all whether to fetch all rows or only first one.
129 130 131 132
	 * @param string|callable $indexBy the column name or PHP callback,
	 * by which the query results should be indexed by.
	 * @throws Exception on failure.
	 * @return array|boolean result.
133
	 */
134
	protected function fetchRows($cursor, $all = true, $indexBy = null)
135
	{
136
		$token = 'find(' . Json::encode($cursor->info()) . ')';
137 138 139
		Yii::info($token, __METHOD__);
		try {
			Yii::beginProfile($token, __METHOD__);
140
			$result = $this->fetchRowsInternal($cursor, $all, $indexBy);
141 142 143 144 145 146 147 148
			Yii::endProfile($token, __METHOD__);
			return $result;
		} catch (\Exception $e) {
			Yii::endProfile($token, __METHOD__);
			throw new Exception($e->getMessage(), (int)$e->getCode(), $e);
		}
	}

149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
	/**
	 * @param \MongoCursor $cursor Mongo cursor instance to fetch data from.
	 * @param boolean $all whether to fetch all rows or only first one.
	 * @param string|callable $indexBy value to index by.
	 * @return array|boolean result.
	 * @see Query::fetchRows()
	 */
	protected function fetchRowsInternal($cursor, $all, $indexBy)
	{
		$result = [];
		if ($all) {
			foreach ($cursor as $row) {
				if ($indexBy !== null) {
					if (is_string($indexBy)) {
						$key = $row[$indexBy];
					} else {
						$key = call_user_func($indexBy, $row);
					}
					$result[$key] = $row;
				} else {
					$result[] = $row;
				}
			}
		} else {
			if ($cursor->hasNext()) {
				$result = $cursor->getNext();
			} else {
				$result = false;
			}
		}
		return $result;
	}

182
	/**
183
	 * Executes the query and returns all results as an array.
184
	 * @param Connection $db the Mongo connection used to execute the query.
185
	 * If this parameter is not given, the `mongodb` application component will be used.
186
	 * @return array the query results. If the query results in nothing, an empty array will be returned.
187
	 */
188
	public function all($db = null)
189
	{
190
		$cursor = $this->buildCursor($db);
191
		return $this->fetchRows($cursor, true, $this->indexBy);
192 193 194
	}

	/**
195
	 * Executes the query and returns a single row of result.
196
	 * @param Connection $db the Mongo connection used to execute the query.
197
	 * If this parameter is not given, the `mongodb` application component will be used.
198 199
	 * @return array|boolean the first row (in terms of an array) of the query result. False is returned if the query
	 * results in nothing.
200
	 */
201
	public function one($db = null)
202
	{
203
		$cursor = $this->buildCursor($db);
204
		return $this->fetchRows($cursor, false);
205 206 207
	}

	/**
208
	 * Returns the number of records.
209
	 * @param string $q kept to match [[QueryInterface]], its value is ignored.
210
	 * @param Connection $db the Mongo connection used to execute the query.
211
	 * If this parameter is not given, the `mongodb` application component will be used.
212
	 * @return integer number of records
213
	 * @throws Exception on failure.
214
	 */
215
	public function count($q = '*', $db = null)
216
	{
217
		$cursor = $this->buildCursor($db);
218
		$token = 'find.count(' . Json::encode($cursor->info()) . ')';
219 220 221 222 223 224 225 226 227 228
		Yii::info($token, __METHOD__);
		try {
			Yii::beginProfile($token, __METHOD__);
			$result = $cursor->count();
			Yii::endProfile($token, __METHOD__);
			return $result;
		} catch (\Exception $e) {
			Yii::endProfile($token, __METHOD__);
			throw new Exception($e->getMessage(), (int)$e->getCode(), $e);
		}
229 230 231
	}

	/**
232
	 * Returns a value indicating whether the query result contains any row of data.
233
	 * @param Connection $db the Mongo connection used to execute the query.
234
	 * If this parameter is not given, the `mongodb` application component will be used.
235
	 * @return boolean whether the query result contains any row of data.
236
	 */
237
	public function exists($db = null)
238
	{
239
		return $this->one($db) !== null;
240
	}
241 242 243

	/**
	 * Returns the sum of the specified column values.
244
	 * @param string $q the column name.
245 246
	 * Make sure you properly quote column names in the expression.
	 * @param Connection $db the Mongo connection used to execute the query.
247
	 * If this parameter is not given, the `mongodb` application component will be used.
248 249 250 251 252 253 254 255 256
	 * @return integer the sum of the specified column values
	 */
	public function sum($q, $db = null)
	{
		return $this->aggregate($q, 'sum', $db);
	}

	/**
	 * Returns the average of the specified column values.
257
	 * @param string $q the column name.
258 259
	 * Make sure you properly quote column names in the expression.
	 * @param Connection $db the Mongo connection used to execute the query.
260
	 * If this parameter is not given, the `mongodb` application component will be used.
261 262 263 264 265 266 267 268 269
	 * @return integer the average of the specified column values.
	 */
	public function average($q, $db = null)
	{
		return $this->aggregate($q, 'avg', $db);
	}

	/**
	 * Returns the minimum of the specified column values.
270
	 * @param string $q the column name.
271 272 273 274 275 276 277 278 279 280 281 282
	 * Make sure you properly quote column names in the expression.
	 * @param Connection $db the database connection used to generate the SQL statement.
	 * 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);
	}

	/**
	 * Returns the maximum of the specified column values.
283
	 * @param string $q the column name.
284 285
	 * Make sure you properly quote column names in the expression.
	 * @param Connection $db the Mongo connection used to execute the query.
286
	 * If this parameter is not given, the `mongodb` application component will be used.
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
	 * @return integer the maximum of the specified column values.
	 */
	public function max($q, $db = null)
	{
		return $this->aggregate($q, 'max', $db);
	}

	/**
	 * Performs the aggregation for the given column.
	 * @param string $column column name.
	 * @param string $operator aggregation operator.
	 * @param Connection $db the database connection used to execute the query.
	 * @return integer aggregation result.
	 */
	protected function aggregate($column, $operator, $db)
	{
		$collection = $this->getCollection($db);
		$pipelines = [];
		if ($this->where !== null) {
			$pipelines[] = ['$match' => $collection->buildCondition($this->where)];
		}
		$pipelines[] = [
			'$group' => [
				'_id' => '1',
				'total' => [
					'$' . $operator => '$' . $column
				],
			]
		];
		$result = $collection->aggregate($pipelines);
317 318
		if (array_key_exists(0, $result)) {
			return $result[0]['total'];
319 320 321 322 323 324 325 326 327
		} else {
			return 0;
		}
	}

	/**
	 * Returns a list of distinct values for the given column across a collection.
	 * @param string $q column to use.
	 * @param Connection $db the Mongo connection used to execute the query.
328
	 * If this parameter is not given, the `mongodb` application component will be used.
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
	 * @return array array of distinct values
	 */
	public function distinct($q, $db = null)
	{
		$collection = $this->getCollection($db);
		if ($this->where !== null) {
			$condition = $this->where;
		} else {
			$condition = [];
		}
		$result = $collection->distinct($q, $condition);
		if ($result === false) {
			return [];
		} else {
			return $result;
		}
	}
346
}