From 4f5f5bb691552b26b3058a20d9f13860e2904b99 Mon Sep 17 00:00:00 2001 From: Paul Klimov Date: Wed, 27 Nov 2013 14:29:05 +0200 Subject: [PATCH] Mongo Query implemented as draft. --- extensions/mongo/Query.php | 269 +++++++++++------------------- tests/unit/extensions/mongo/QueryTest.php | 65 ++++++++ 2 files changed, 163 insertions(+), 171 deletions(-) create mode 100644 tests/unit/extensions/mongo/QueryTest.php diff --git a/extensions/mongo/Query.php b/extensions/mongo/Query.php index e2cc622..1bdaf40 100644 --- a/extensions/mongo/Query.php +++ b/extensions/mongo/Query.php @@ -8,8 +8,9 @@ namespace yii\mongo; use yii\base\Component; -use yii\db\Connection; use yii\db\QueryInterface; +use yii\db\QueryTrait; +use Yii; /** * Class Query @@ -19,219 +20,145 @@ use yii\db\QueryInterface; */ class Query extends Component implements QueryInterface { + use QueryTrait; /** - * 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) - { - // TODO: Implement all() method. - } - - /** - * 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. + * @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 function one($db = null) - { - // TODO: Implement one() method. - } - - /** - * 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) - { - // TODO: Implement count() method. - } - + public $select = []; /** - * 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. + * @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 function exists($db = null) - { - // TODO: Implement exists() method. - } + public $from; /** - * Sets the [[indexBy]] property. - * @param string|callable $column the name of the column by which the query results should be indexed by. - * This can also be a callable (e.g. anonymous function) that returns the index value based on the given - * row data. The signature of the callable should be: - * - * ~~~ - * function ($row) - * { - * // return the index value corresponding to $row - * } - * ~~~ - * - * @return static the query object itself + * Returns the Mongo collection for this query. + * @param Connection $db Mongo connection. + * @return Collection collection instance. */ - public function indexBy($column) + public function getCollection($db = null) { - // TODO: Implement indexBy() method. + if ($db === null) { + $db = Yii::$app->getComponent('mongo'); + } + return $db->getCollection($this->from); } /** - * Sets the WHERE part of the query. - * - * The method requires a $condition parameter. - * - * The $condition parameter should be an array in one of the following two formats: - * - * - hash format: `['column1' => value1, 'column2' => value2, ...]` - * - operator format: `[operator, operand1, operand2, ...]` - * - * A condition in hash format represents the following SQL expression in general: - * `column1=value1 AND column2=value2 AND ...`. In case when a value is an array, - * an `IN` expression will be generated. And if a value is null, `IS NULL` will be used - * in the generated expression. Below are some examples: - * - * - `['type' => 1, 'status' => 2]` generates `(type = 1) AND (status = 2)`. - * - `['id' => [1, 2, 3], 'status' => 2]` generates `(id IN (1, 2, 3)) AND (status = 2)`. - * - `['status' => null] generates `status IS NULL`. - * - * A condition in operator format generates the SQL expression according to the specified operator, which - * can be one of the followings: - * - * - `and`: the operands should be concatenated together using `AND`. For example, - * `['and', 'id=1', 'id=2']` will generate `id=1 AND id=2`. If an operand is an array, - * it will be converted into a string using the rules described here. For example, - * `['and', 'type=1', ['or', 'id=1', 'id=2']]` will generate `type=1 AND (id=1 OR id=2)`. - * The method will NOT do any quoting or escaping. - * - * - `or`: similar to the `and` operator except that the operands are concatenated using `OR`. - * - * - `between`: operand 1 should be the column name, and operand 2 and 3 should be the - * starting and ending values of the range that the column is in. - * For example, `['between', 'id', 1, 10]` will generate `id BETWEEN 1 AND 10`. - * - * - `not between`: similar to `between` except the `BETWEEN` is replaced with `NOT BETWEEN` - * in the generated condition. - * - * - `in`: operand 1 should be a column or DB expression, and operand 2 be an array representing - * the range of the values that the column or DB expression should be in. For example, - * `['in', 'id', [1, 2, 3]]` will generate `id IN (1, 2, 3)`. - * The method will properly quote the column name and escape values in the range. - * - * - `not in`: similar to the `in` operator except that `IN` is replaced with `NOT IN` in the generated condition. - * - * - `like`: operand 1 should be a column or DB expression, and operand 2 be a string or an array representing - * the values that the column or DB expression should be like. - * For example, `['like', 'name', '%tester%']` will generate `name LIKE '%tester%'`. - * When the value range is given as an array, multiple `LIKE` predicates will be generated and concatenated - * using `AND`. For example, `['like', 'name', ['%test%', '%sample%']]` will generate - * `name LIKE '%test%' AND name LIKE '%sample%'`. - * The method will properly quote the column name and escape values in the range. - * - * - `or like`: similar to the `like` operator except that `OR` is used to concatenate the `LIKE` - * predicates when operand 2 is an array. - * - * - `not like`: similar to the `like` operator except that `LIKE` is replaced with `NOT LIKE` - * in the generated condition. - * - * - `or not like`: similar to the `not like` operator except that `OR` is used to concatenate - * the `NOT LIKE` predicates. - * - * @param array $condition the conditions that should be put in the WHERE part. - * @return static the query object itself - * @see andWhere() - * @see orWhere() + * 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 where($condition) + public function select(array $fields) { - // TODO: Implement where() method. + $this->select = $fields; + return $this; } /** - * Adds an additional WHERE condition to the existing one. - * The new condition and the existing one will be joined using the 'AND' operator. - * @param string|array $condition the new WHERE condition. Please refer to [[where()]] - * on how to specify this parameter. - * @return static the query object itself - * @see where() - * @see orWhere() + * 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 andWhere($condition) + public function from($collection) { - // TODO: Implement andWhere() method. + $this->from = $collection; + return $this; } /** - * Adds an additional WHERE condition to the existing one. - * The new condition and the existing one will be joined using the 'OR' operator. - * @param string|array $condition the new WHERE condition. Please refer to [[where()]] - * on how to specify this parameter. - * @return static the query object itself - * @see where() - * @see andWhere() + * @param Connection $db the database connection used to execute the query. + * @return \MongoCursor mongo cursor instance. */ - public function orWhere($condition) + protected function buildCursor($db = null) { - // TODO: Implement orWhere() method. + // 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 ? -1 : 1; + } + $cursor->sort($this->orderBy); + } + $cursor->limit($this->limit); + $cursor->skip($this->offset); + return $cursor; } /** - * Sets the ORDER BY part of the query. - * @param string|array $columns the columns (and the directions) to be ordered by. - * Columns can be specified in either a string (e.g. "id ASC, name DESC") or an array - * (e.g. `['id' => SORT_ASC, 'name' => SORT_DESC]`). - * The method will automatically quote the column names unless a column contains some parenthesis - * (which means the column contains a DB expression). - * @return static the query object itself - * @see addOrderBy() + * 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 orderBy($columns) + public function all($db = null) { - // TODO: Implement orderBy() method. + $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; } /** - * Adds additional ORDER BY columns to the query. - * @param string|array $columns the columns (and the directions) to be ordered by. - * Columns can be specified in either a string (e.g. "id ASC, name DESC") or an array - * (e.g. `['id' => SORT_ASC, 'name' => SORT_DESC]`). - * The method will automatically quote the column names unless a column contains some parenthesis - * (which means the column contains a DB expression). - * @return static the query object itself - * @see orderBy() + * 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 addOrderBy($columns) + public function one($db = null) { - // TODO: Implement addOrderBy() method. + $cursor = $this->buildCursor($db); + return $cursor->getNext(); } /** - * Sets the LIMIT part of the query. - * @param integer $limit the limit. Use null or negative value to disable limit. - * @return static the query object itself + * 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 limit($limit) + public function count($q = '*', $db = null) { - // TODO: Implement limit() method. + $cursor = $this->buildCursor($db); + return $cursor->count(); } /** - * Sets the OFFSET part of the query. - * @param integer $offset the offset. Use null or negative value to disable offset. - * @return static the query object itself + * 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 offset($offset) + public function exists($db = null) { - // TODO: Implement offset() method. + return $this->one($db) !== null; } } \ No newline at end of file diff --git a/tests/unit/extensions/mongo/QueryTest.php b/tests/unit/extensions/mongo/QueryTest.php new file mode 100644 index 0000000..0fce3fa --- /dev/null +++ b/tests/unit/extensions/mongo/QueryTest.php @@ -0,0 +1,65 @@ +select($select); + $this->assertEquals($select, $query->select); + + $query = new Query; + $select = ['name', 'something']; + $query->select($select); + $this->assertEquals($select, $query->select); + } + + public function testFrom() + { + $query = new Query; + $from = 'customer'; + $query->from($from); + $this->assertEquals($from, $query->from); + + $query = new Query; + $from = ['', 'customer']; + $query->from($from); + $this->assertEquals($from, $query->from); + } + + public function testOrder() + { + $query = new Query; + $query->orderBy('team'); + $this->assertEquals(['team' => SORT_ASC], $query->orderBy); + + $query->addOrderBy('company'); + $this->assertEquals(['team' => SORT_ASC, 'company' => SORT_ASC], $query->orderBy); + + $query->addOrderBy('age'); + $this->assertEquals(['team' => SORT_ASC, 'company' => SORT_ASC, 'age' => SORT_ASC], $query->orderBy); + + $query->addOrderBy(['age' => SORT_DESC]); + $this->assertEquals(['team' => SORT_ASC, 'company' => SORT_ASC, 'age' => SORT_DESC], $query->orderBy); + + $query->addOrderBy('age ASC, company DESC'); + $this->assertEquals(['team' => SORT_ASC, 'company' => SORT_DESC, 'age' => SORT_ASC], $query->orderBy); + } + + public function testLimitOffset() + { + $query = new Query; + $query->limit(10)->offset(5); + $this->assertEquals(10, $query->limit); + $this->assertEquals(5, $query->offset); + } +} \ No newline at end of file