yii\data\BaseDataProvider::getPagination PHP Method

getPagination() public method

Note that you should call BaseDataProvider::prepare or BaseDataProvider::getModels first to get correct values of [[Pagination::totalCount]] and [[Pagination::pageCount]].
public getPagination ( ) : Pagination | false
return Pagination | false the pagination object. If this is false, it means the pagination is disabled.
    public function getPagination()
    {
        if ($this->_pagination === null) {
            $this->setPagination([]);
        }
        return $this->_pagination;
    }

Usage Example

 /**
  * Constructor.
  * @param BaseDataProvider $dataProvider the data provider to iterate over
  * @param integer $pageSize pageSize to use for iteration. This is the number of objects loaded into memory at the same time.
  */
 public function __construct(BaseDataProvider $dataProvider, $pageSize = null)
 {
     $this->_dataProvider = $dataProvider;
     $this->_totalItemCount = $dataProvider->getTotalCount();
     if (($pagination = $this->_dataProvider->getPagination()) === false) {
         $this->_dataProvider->setPagination($pagination = new Pagination());
     }
     if ($pageSize !== null) {
         $pagination->pageSize = $pageSize;
     }
 }
All Usage Examples Of yii\data\BaseDataProvider::getPagination