• 홈
• yii
• data
• Pagination

PHP 클래스 yii\data\Pagination

When data needs to be rendered in multiple pages, Pagination can be used to represent information such as [[totalCount|total item count]], [[pageSize|page size]], [[page|current page]], etc. These information can be passed to [[yii\widgets\Pager|pagers]] to render pagination buttons or links. The following example shows how to create a pagination object and feed it to a pager. Controller action: ~~~ function actionIndex() { $query = Article::find()->where(['status' => 1]); $countQuery = clone $query; $pages = new Pagination(['totalCount' => $countQuery->count()]); $models = $query->offset($pages->offset) ->limit($pages->limit) ->all(); return $this->render('index', [ 'models' => $models, 'pages' => $pages, ]); } ~~~ View: ~~~ foreach ($models as $model) { display $model here } display pagination echo LinkPager::widget([ 'pagination' => $pages, ]); ~~~ 파일 보기 프로젝트 열기: yiisoft/yii2 1 사용 예제들

공개 프로퍼티들

프로퍼티	타입	설명
$defaultPageSize		the default page size. This property will be returned by [[pageSize]] when page size cannot be determined by [[pageSizeParam]] from [[params]].
$forcePageParam		whether to always have the page parameter in the URL created by Pagination::createUrl. If false and [[page]] is 0, the page parameter will not be put in the URL.
$pageParam		name of the parameter storing the current page index.
$pageSizeLimit		the page size limits. The first array element stands for the minimal page size, and the second the maximal page size. If this is false, it means [[pageSize]] should always return the value of [[defaultPageSize]].
$pageSizeParam		name of the parameter storing the page size.
$params		parameters (name => value) that should be used to obtain the current page number and to create new pagination URLs. If not set, all parameters from $_GET will be used instead. In order to add hash to all links use array_merge($_GET, ['#' => 'my-hash']). The array element indexed by [[pageParam]] is considered to be the current page number (defaults to 0); while the element indexed by [[pageSizeParam]] is treated as the page size (defaults to [[defaultPageSize]]).
$route		the route of the controller action for displaying the paged contents. If not set, it means using the currently requested route.
$totalCount		total number of items.
$urlManager		the URL manager used for creating pagination URLs. If not set, the "urlManager" application component will be used.
$validatePage		whether to check if [[page]] is within valid range. When this property is true, the value of [[page]] will always be between 0 and ([[pageCount]]-1). Because [[pageCount]] relies on the correct value of [[totalCount]] which may not be available in some cases (e.g. MongoDB), you may want to set this property to be false to disable the page number validation. By doing so, [[page]] will return the value indexed by [[pageParam]] in [[params]].

공개 메소드들

메소드	설명
createUrl ( integer $page, integer $pageSize = null, boolean $absolute = false ) : string	Creates the URL suitable for pagination with the specified page number.
getLimit ( ) : integer
getLinks ( boolean $absolute = false ) : array	Returns a whole set of links for navigating to the first, last, next and previous pages.
getOffset ( ) : integer
getPage ( boolean $recalculate = false ) : integer	Returns the zero-based current page number.
getPageCount ( ) : integer
getPageSize ( ) : integer	Returns the number of items per page.
setPage ( integer $value, boolean $validatePage = false )	Sets the current page number.
setPageSize ( integer $value, boolean $validatePageSize = false )

보호된 메소드들

메소드	설명
getQueryParam ( string $name, string $defaultValue = null ) : string	Returns the value of the specified query parameter.

메소드 상세

프로퍼티 상세