php/yii2
1
0
Fork 0
mirror of https://github.com/yiisoft/yii2.git synced 2025-11-20 08:27:21 +08:00
Code Issues Packages Projects Releases Wiki Activity

added note about differing property types

Browse Source
This commit is contained in:
Carsten Brandt
2013-08-28 15:18:13 +02:00
parent ca69ef09d4
commit c582e589d2
8 changed files with 26 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
framework/yii/data/DataProvider.php
View File

@@ -17,9 +17,11 @@ use yii\base\InvalidParamException;
* It implements the [[getPagination()]] and [[getSort()]] methods as specified by the [[IDataProvider]] interface.
*
* @property integer $count The number of data models in the current page. This property is read-only.
* @property Pagination $pagination The pagination object. If this is false, it means the pagination is
* disabled.
* @property Sort $sort The sorting object. If this is false, it means the sorting is disabled.
* @property Pagination|boolean $pagination The pagination object. If this is false, it means the pagination
* is disabled. Note that the type of this property differs in getter and setter. See [[getPagination()]] and
* [[setPagination()]] for details.
* @property Sort|boolean $sort The sorting object. If this is false, it means that sorting is disabled. Note
* that the type of this property differs in getter and setter. See [[getSort()]] and [[setSort()]] for details.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
@@ -37,7 +39,7 @@ abstract class DataProvider extends Component implements IDataProvider
private $_pagination;
/**
* @return Pagination the pagination object. If this is false, it means the pagination is disabled.
* @return Pagination|boolean the pagination object. If this is false, it means the pagination is disabled.
*/
public function getPagination()
{
@@ -80,7 +82,7 @@ abstract class DataProvider extends Component implements IDataProvider
}
/**
* @return Sort the sorting object. If this is false, it means the sorting is disabled.
* @return Sort|boolean the sorting object. If this is false, it means the sorting is disabled.
*/
public function getSort()
{