Commit e27c3872 by Carsten Brandt

doc improvements

parent abceccfd
...@@ -50,8 +50,8 @@ defined('YII_ENABLE_ERROR_HANDLER') or define('YII_ENABLE_ERROR_HANDLER', true); ...@@ -50,8 +50,8 @@ defined('YII_ENABLE_ERROR_HANDLER') or define('YII_ENABLE_ERROR_HANDLER', true);
/** /**
* BaseYii is the core helper class for the Yii framework. * BaseYii is the core helper class for the Yii framework.
* *
* Do not use BaseYii directly. Instead, use its child class [[\Yii]] where * Do not use BaseYii directly. Instead, use its child class [[\Yii]] which you can replace to
* you can customize methods of BaseYii. * customize methods of BaseYii.
* *
* @author Qiang Xue <qiang.xue@gmail.com> * @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0 * @since 2.0
......
...@@ -561,7 +561,7 @@ class QueryBuilder extends \yii\base\Object ...@@ -561,7 +561,7 @@ class QueryBuilder extends \yii\base\Object
* @param array $columns * @param array $columns
* @param boolean $distinct * @param boolean $distinct
* @param string $selectOption * @param string $selectOption
* @return string the SELECT clause built from [[query]]. * @return string the SELECT clause built from [[Query::$select]].
*/ */
public function buildSelect($columns, $distinct = false, $selectOption = null) public function buildSelect($columns, $distinct = false, $selectOption = null)
{ {
...@@ -595,7 +595,7 @@ class QueryBuilder extends \yii\base\Object ...@@ -595,7 +595,7 @@ class QueryBuilder extends \yii\base\Object
/** /**
* @param array $tables * @param array $tables
* @return string the FROM clause built from [[query]]. * @return string the FROM clause built from [[Query::$from]].
*/ */
public function buildFrom($tables) public function buildFrom($tables)
{ {
...@@ -623,7 +623,7 @@ class QueryBuilder extends \yii\base\Object ...@@ -623,7 +623,7 @@ class QueryBuilder extends \yii\base\Object
/** /**
* @param string|array $joins * @param string|array $joins
* @param array $params the binding parameters to be populated * @param array $params the binding parameters to be populated
* @return string the JOIN clause built from [[query]]. * @return string the JOIN clause built from [[Query::$join]].
* @throws Exception if the $joins parameter is not in proper format * @throws Exception if the $joins parameter is not in proper format
*/ */
public function buildJoin($joins, &$params) public function buildJoin($joins, &$params)
...@@ -663,7 +663,7 @@ class QueryBuilder extends \yii\base\Object ...@@ -663,7 +663,7 @@ class QueryBuilder extends \yii\base\Object
/** /**
* @param string|array $condition * @param string|array $condition
* @param array $params the binding parameters to be populated * @param array $params the binding parameters to be populated
* @return string the WHERE clause built from [[query]]. * @return string the WHERE clause built from [[Query::$where]].
*/ */
public function buildWhere($condition, &$params) public function buildWhere($condition, &$params)
{ {
...@@ -683,7 +683,7 @@ class QueryBuilder extends \yii\base\Object ...@@ -683,7 +683,7 @@ class QueryBuilder extends \yii\base\Object
/** /**
* @param string|array $condition * @param string|array $condition
* @param array $params the binding parameters to be populated * @param array $params the binding parameters to be populated
* @return string the HAVING clause built from [[query]]. * @return string the HAVING clause built from [[Query::$having]].
*/ */
public function buildHaving($condition, &$params) public function buildHaving($condition, &$params)
{ {
...@@ -693,7 +693,7 @@ class QueryBuilder extends \yii\base\Object ...@@ -693,7 +693,7 @@ class QueryBuilder extends \yii\base\Object
/** /**
* @param array $columns * @param array $columns
* @return string the ORDER BY clause built from [[query]]. * @return string the ORDER BY clause built from [[Query::$orderBy]].
*/ */
public function buildOrderBy($columns) public function buildOrderBy($columns)
{ {
...@@ -715,7 +715,7 @@ class QueryBuilder extends \yii\base\Object ...@@ -715,7 +715,7 @@ class QueryBuilder extends \yii\base\Object
/** /**
* @param integer $limit * @param integer $limit
* @param integer $offset * @param integer $offset
* @return string the LIMIT and OFFSET clauses built from [[query]]. * @return string the LIMIT and OFFSET clauses built from [[Query::$limit]].
*/ */
public function buildLimit($limit, $offset) public function buildLimit($limit, $offset)
{ {
...@@ -732,7 +732,7 @@ class QueryBuilder extends \yii\base\Object ...@@ -732,7 +732,7 @@ class QueryBuilder extends \yii\base\Object
/** /**
* @param array $unions * @param array $unions
* @param array $params the binding parameters to be populated * @param array $params the binding parameters to be populated
* @return string the UNION clause built from [[query]]. * @return string the UNION clause built from [[Query::$union]].
*/ */
public function buildUnion($unions, &$params) public function buildUnion($unions, &$params)
{ {
......
...@@ -16,9 +16,6 @@ namespace yii\db; ...@@ -16,9 +16,6 @@ namespace yii\db;
* Allows pagination via [[limit]] and [[offset]]. * Allows pagination via [[limit]] and [[offset]].
* Sorting is supported via [[orderBy]] and items can be limited to match some conditions using [[where]]. * 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 Qiang Xue <qiang.xue@gmail.com>
* @author Carsten Brandt <mail@cebe.cc> * @author Carsten Brandt <mail@cebe.cc>
* @since 2.0 * @since 2.0
......
...@@ -50,7 +50,7 @@ trait QueryTrait ...@@ -50,7 +50,7 @@ trait QueryTrait
/** /**
* @var string|callable $column the name of the column by which the query results should be indexed by. * @var 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 * This can also be a callable (e.g. anonymous function) that returns the index value based on the given
* row data. For more details, see [[indexBy()]]. This property is only used by [[all()]]. * row data. For more details, see [[indexBy()]]. This property is only used by [[QueryInterface::all()|all()]].
*/ */
public $indexBy; public $indexBy;
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment