* @since 2.0 */ class Query extends Component implements QueryInterface { use QueryTrait; /** * @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 = []; /** * @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() */ public $from; /** * Returns the Mongo collection for this query. * @param Connection $db Mongo connection. * @return Collection collection instance. */ public function getCollection($db = null) { if ($db === null) { $db = Yii::$app->getComponent('mongo'); } return $db->getCollection($this->from); } /** * 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. */ public function select(array $fields) { $this->select = $fields; return $this; } /** * 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. */ public function from($collection) { $this->from = $collection; return $this; } /** * @param Connection $db the database connection used to execute the query. * @return \MongoCursor mongo cursor instance. */ protected function buildCursor($db = null) { // TODO: compose query $query = []; $selectFields = []; if (!empty($this->select)) { foreach ($this->select as $fieldName) { $selectFields[$fieldName] = true; } } $cursor = $this->getCollection($db)->find($query, $selectFields); if (!empty($this->orderBy)) { $sort = []; foreach ($this->orderBy as $fieldName => $sortOrder) { $sort[$fieldName] = $sortOrder === SORT_DESC ? \MongoCollection::DESCENDING : \MongoCollection::ASCENDING; } $cursor->sort($this->orderBy); } $cursor->limit($this->limit); $cursor->skip($this->offset); return $cursor; } /** * Executes the query and returns all results as an array. * @param Connection $db the database connection used to execute the query. * If this parameter is not given, the `db` application component 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); if ($this->indexBy === null) { return iterator_to_array($cursor); } else { $result = []; foreach ($cursor as $row) { if (is_string($this->indexBy)) { $key = $row[$this->indexBy]; } else { $key = call_user_func($this->indexBy, $row); } $result[$key] = $row; } } return $result; } /** * Executes the query and returns a single row of result. * @param Connection $db the database connection used to execute the query. * If this parameter is not given, the `db` application component will be used. * @return array|boolean the first row (in terms of an array) of the query result. False is returned if the query * results in nothing. */ public function one($db = null) { $cursor = $this->buildCursor($db); return $cursor->getNext(); } /** * Returns the number of records. * @param string $q the COUNT expression. Defaults to '*'. * @param Connection $db the database connection used to execute the query. * If this parameter is not given, the `db` application component will be used. * @return integer number of records */ public function count($q = '*', $db = null) { $cursor = $this->buildCursor($db); return $cursor->count(); } /** * Returns a value indicating whether the query result contains any row of data. * @param Connection $db the database connection used to execute the query. * If this parameter is not given, the `db` application component will be used. * @return boolean whether the query result contains any row of data. */ public function exists($db = null) { return $this->one($db) !== null; } }