php/yii2
1
0
Fork 0
mirror of https://github.com/yiisoft/yii2.git synced 2025-08-23 12:10:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

Added doc about BaseDataProvider::getPagination().

Browse Source
This commit is contained in:
Qiang Xue
2013-10-02 08:29:52 -04:00
parent 3f88320595
commit bcc0cbeba8
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
framework/yii/data/BaseDataProvider.php
View File

@ -157,6 +157,9 @@ abstract class BaseDataProvider extends Component implements DataProviderInterfa
} }
/** /**
* Returns the pagination object used by this data provider.
* Note that you should call [[prepare()]] or [[getModels()]] first to get correct values
* of [[Pagination::totalCount]] and [[Pagination::pageCount]].
* @return Pagination|boolean 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() public function getPagination()