Query.php 11.6 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 47 48 49
    /**
     * @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()
     */
    public $select = [];
    /**
50
     * @var string|array the collection to be selected from. If string considered as the name of the collection
51 52 53 54 55
     * 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()
     */
    public $from;
56

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

68 69
        return $db->getCollection($this->from);
    }
70

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

80 81
        return $this;
    }
82

83 84
    /**
     * Sets the collection to be selected from.
85
     * @param string|array the collection to be selected from. If string considered as the name of the collection
86 87 88 89 90 91 92
     * 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.
     */
    public function from($collection)
    {
        $this->from = $collection;
93

94 95
        return $this;
    }
96

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

126 127
        return $cursor;
    }
128

129 130
    /**
     * Fetches rows from the given Mongo cursor.
131 132 133 134 135 136
     * @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 the column name or PHP callback,
     * by which the query results should be indexed by.
     * @throws Exception on failure.
     * @return array|boolean result.
137 138 139 140 141 142 143 144 145
     */
    protected function fetchRows($cursor, $all = true, $indexBy = null)
    {
        $token = 'find(' . Json::encode($cursor->info()) . ')';
        Yii::info($token, __METHOD__);
        try {
            Yii::beginProfile($token, __METHOD__);
            $result = $this->fetchRowsInternal($cursor, $all, $indexBy);
            Yii::endProfile($token, __METHOD__);
146

147 148 149 150 151 152
            return $result;
        } catch (\Exception $e) {
            Yii::endProfile($token, __METHOD__);
            throw new Exception($e->getMessage(), (int) $e->getCode(), $e);
        }
    }
153

154
    /**
155 156 157 158
     * @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.
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
     * @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;
            }
        }
184

185 186
        return $result;
    }
187

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

198 199
        return $this->fetchRows($cursor, true, $this->indexBy);
    }
200

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

212 213 214 215 216
        return $this->fetchRows($cursor, false);
    }

    /**
     * Returns the number of records.
217 218 219 220 221
     * @param string $q kept to match [[QueryInterface]], its value is ignored.
     * @param Connection $db 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 Exception on failure.
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
     */
    public function count($q = '*', $db = null)
    {
        $cursor = $this->buildCursor($db);
        $token = 'find.count(' . Json::encode($cursor->info()) . ')';
        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);
        }
    }

    /**
     * Returns a value indicating whether the query result contains any row of data.
242 243 244
     * @param Connection $db 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.
245 246 247 248 249 250 251 252
     */
    public function exists($db = null)
    {
        return $this->one($db) !== null;
    }

    /**
     * Returns the sum of the specified column values.
253 254 255 256 257
     * @param string $q the column name.
     * Make sure you properly quote column names in the expression.
     * @param Connection $db 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
258 259 260 261 262 263 264 265
     */
    public function sum($q, $db = null)
    {
        return $this->aggregate($q, 'sum', $db);
    }

    /**
     * Returns the average of the specified column values.
266 267 268 269 270
     * @param string $q the column name.
     * Make sure you properly quote column names in the expression.
     * @param Connection $db 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.
271 272 273 274 275 276 277 278
     */
    public function average($q, $db = null)
    {
        return $this->aggregate($q, 'avg', $db);
    }

    /**
     * Returns the minimum of the specified column values.
279 280 281 282 283
     * @param string $q the column name.
     * 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.
284 285 286 287 288 289 290 291
     */
    public function min($q, $db = null)
    {
        return $this->aggregate($q, 'min', $db);
    }

    /**
     * Returns the maximum of the specified column values.
292 293 294 295 296
     * @param string $q the column name.
     * Make sure you properly quote column names in the expression.
     * @param Connection $db the Mongo 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.
297 298 299 300 301 302 303 304
     */
    public function max($q, $db = null)
    {
        return $this->aggregate($q, 'max', $db);
    }

    /**
     * Performs the aggregation for the given column.
305 306 307 308
     * @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.
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
     */
    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);
        if (array_key_exists(0, $result)) {
            return $result[0]['total'];
        } else {
            return 0;
        }
    }

    /**
     * Returns a list of distinct values for the given column across a collection.
335 336 337 338
     * @param string $q column to use.
     * @param Connection $db the Mongo 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
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
     */
    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;
        }
    }
AlexGx committed
355
}