Commit bcc0cbeb by Qiang Xue

Added doc about BaseDataProvider::getPagination().

parent 3f883205
...@@ -157,6 +157,9 @@ abstract class BaseDataProvider extends Component implements DataProviderInterfa ...@@ -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()
......
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