Browse Source
this allows us to implement other activerecord implementations based on NoSQL dbmstags/2.0.0-beta
Carsten Brandt
11 years ago
13 changed files with 369 additions and 154 deletions
@ -0,0 +1,59 @@
|
||||
<?php |
||||
/** |
||||
* @link http://www.yiiframework.com/ |
||||
* @copyright Copyright (c) 2008 Yii Software LLC |
||||
* @license http://www.yiiframework.com/license/ |
||||
*/ |
||||
|
||||
namespace yii\ar; |
||||
use yii\db\QueryInterface; |
||||
|
||||
/** |
||||
* ActiveQueryInterface defines the common interface to be implemented by active record relation classes. |
||||
* |
||||
* A class implementing this interface should also use [[ActiveQueryTrait]]. |
||||
* |
||||
* @author Qiang Xue <qiang.xue@gmail.com> |
||||
* @author Carsten Brandt <mail@cebe.cc> |
||||
* @since 2.0 |
||||
*/ |
||||
interface ActiveQueryInterface extends QueryInterface |
||||
{ |
||||
/** |
||||
* Sets the [[asArray]] property. |
||||
* @param boolean $value whether to return the query results in terms of arrays instead of Active Records. |
||||
* @return static the query object itself |
||||
*/ |
||||
public function asArray($value = true); |
||||
|
||||
/** |
||||
* Specifies the relations with which this query should be performed. |
||||
* |
||||
* The parameters to this method can be either one or multiple strings, or a single array |
||||
* of relation names and the optional callbacks to customize the relations. |
||||
* |
||||
* A relation name can refer to a relation defined in [[modelClass]] |
||||
* or a sub-relation that stands for a relation of a related record. |
||||
* For example, `orders.address` means the `address` relation defined |
||||
* in the model class corresponding to the `orders` relation. |
||||
* |
||||
* The followings are some usage examples: |
||||
* |
||||
* ~~~ |
||||
* // find customers together with their orders and country |
||||
* Customer::find()->with('orders', 'country')->all(); |
||||
* // find customers together with their orders and the orders' shipping address |
||||
* Customer::find()->with('orders.address')->all(); |
||||
* // find customers together with their country and orders of status 1 |
||||
* Customer::find()->with([ |
||||
* 'orders' => function($query) { |
||||
* $query->andWhere('status = 1'); |
||||
* }, |
||||
* 'country', |
||||
* ])->all(); |
||||
* ~~~ |
||||
* |
||||
* @return static the query object itself |
||||
*/ |
||||
public function with(); |
||||
} |
||||
@ -0,0 +1,36 @@
|
||||
<?php |
||||
/** |
||||
* @link http://www.yiiframework.com/ |
||||
* @copyright Copyright (c) 2008 Yii Software LLC |
||||
* @license http://www.yiiframework.com/license/ |
||||
*/ |
||||
|
||||
namespace yii\ar; |
||||
|
||||
/** |
||||
* ActiveRelationInterface defines the common interface to be implemented by active record relation classes. |
||||
* |
||||
* @author Qiang Xue <qiang.xue@gmail.com> |
||||
* @author Carsten Brandt <mail@cebe.cc> |
||||
* @since 2.0 |
||||
*/ |
||||
interface ActiveRelationInterface extends ActiveQueryInterface |
||||
{ |
||||
/** |
||||
* Specifies the relation associated with the pivot table. |
||||
* @param string $relationName the relation name. This refers to a relation declared in [[primaryModel]]. |
||||
* @param callable $callable a PHP callback for customizing the relation associated with the pivot table. |
||||
* Its signature should be `function($query)`, where `$query` is the query to be customized. |
||||
* @return static the relation object itself. |
||||
*/ |
||||
public function via($relationName, $callable = null); |
||||
|
||||
/** |
||||
* Finds the related records and populates them into the primary models. |
||||
* This method is internally used by [[ActiveQuery]]. Do not call it directly. |
||||
* @param string $name the relation name |
||||
* @param array $primaryModels primary models |
||||
* @return array the related models |
||||
*/ |
||||
public function findWith($name, &$primaryModels); |
||||
} |
||||
@ -0,0 +1,205 @@
|
||||
<?php |
||||
/** |
||||
* @link http://www.yiiframework.com/ |
||||
* @copyright Copyright (c) 2008 Yii Software LLC |
||||
* @license http://www.yiiframework.com/license/ |
||||
*/ |
||||
|
||||
namespace yii\db; |
||||
|
||||
/** |
||||
* The QueryInterface defines the minimum set of methods to be implemented by a database query. |
||||
* |
||||
* The default implementation of this interface is provided by [[QueryTrait]]. |
||||
* |
||||
* It has support for getting [[one]] instance or [[all]]. |
||||
* Allows pagination via [[limit]] and [[offset]]. |
||||
* Sorting is supported via [[orderBy]] and items can be limited to match some conditions using [[where]]. |
||||
* |
||||
* By calling [[createCommand()]], we can get a [[Command]] instance which can be further |
||||
* used to perform/execute the DB query against a database. |
||||
* |
||||
* @author Qiang Xue <qiang.xue@gmail.com> |
||||
* @author Carsten Brandt <mail@cebe.cc> |
||||
* @since 2.0 |
||||
*/ |
||||
interface QueryInterface |
||||
{ |
||||
/** |
||||
* 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); |
||||
|
||||
/** |
||||
* 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); |
||||
|
||||
/** |
||||
* Returns the number of records. |
||||
* @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($db = null); |
||||
|
||||
/** |
||||
* 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); |
||||
|
||||
/** |
||||
* 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 |
||||
*/ |
||||
public function indexBy($column); |
||||
|
||||
/** |
||||
* 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() |
||||
*/ |
||||
public function where($condition); |
||||
|
||||
/** |
||||
* 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() |
||||
*/ |
||||
public function andWhere($condition); |
||||
|
||||
/** |
||||
* 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() |
||||
*/ |
||||
public function orWhere($condition); |
||||
|
||||
/** |
||||
* 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() |
||||
*/ |
||||
public function orderBy($columns); |
||||
|
||||
/** |
||||
* 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() |
||||
*/ |
||||
public function addOrderBy($columns); |
||||
|
||||
/** |
||||
* 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 |
||||
*/ |
||||
public function limit($limit); |
||||
|
||||
/** |
||||
* 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 |
||||
*/ |
||||
public function offset($offset); |
||||
} |
||||
Loading…
Reference in new issue