Detailed explanation of the use of Yii2 paging and its extension methods

Below I have summarized some Yii paging methods and example codes commonly used in Yii. Here are ordinary paging and ajax paging. I hope this article will be helpful to everyone.

The first type: CListView paging for data in the form of objects

Controller:

public function actionAjax() { 
        $criteria = new CDbCriteria(); 
        //$criteria->order = 'news_id DESC'; 
        $criteria->condition = 'user_id = 1'; 
  
        $dataProvider = new CActiveDataProvider('News', array( 
                    'pagination' => array( 
                        'pageSize' => Yii::app()->params['pagesize'], 
                        'pageVar' => Yii::app()->params['pagevar'], 
                    ), 
                    'criteria' => $criteria, 
                )); 
  
  
        $this->render('view', array( 
            'dataProvider' => $dataProvider, 
        )); 
}

View:

<?php 
$this->widget(&#39;zii.widgets.CListView&#39;, array( 
    &#39;dataProvider&#39; => $dataProvider, //数据 
    &#39;itemView&#39; => &#39;_view&#39;, //显示的模版 
    &#39;id&#39; => Yii::app()->controller->id, 
    &#39;itemsTagName&#39; => &#39;ul&#39;, 
    &#39;ajaxVar&#39; => &#39;&#39;, //默认为page或ajax 去掉后url更简洁 
    &#39;htmlOptions&#39; => array(&#39;class&#39; => Yii::app()->controller->id), 
    &#39;loadingCssClass&#39; => &#39;loading&#39;, //默认为list-view-loading 
    //&#39;template&#39; => &#39;{summary}{sorter}{items}{pager}&#39;,//显示的顺序 
    //&#39;ajaxUpdate&#39; => false, //是否ajax分页  false或分页显示的容器id 
    //&#39;beforeAjaxUpdate&#39; => &#39;before_ajax_update&#39;,   //回调函数 在common.js里完成 
    //&#39;afterAjaxUpdate&#39; => &#39;after_ajax_update&#39;,   
    &#39;emptyText&#39; => &#39; 
<DIV class="alert alert-waning"> 
    暂无数据！ 
</DIV> 
&#39;, //无数据时显示内容 
                    &#39;pagerCssClass&#39; => &#39;pagination&#39;, //分页的class 
                    &#39;pager&#39; => array( 
                        &#39;selectedPageCssClass&#39; => &#39;active&#39;, //当前页的class 
                        &#39;hiddenPageCssClass&#39; => &#39;disabled&#39;, //禁用页的class 
                        &#39;header&#39; => &#39;&#39;, //分页前显示的内容 
                        &#39;maxButtonCount&#39; => 10, //显示分页数量 
                        &#39;htmlOptions&#39; => array(&#39;class&#39; => &#39;&#39;), 
                        &#39;firstPageLabel&#39; => &#39;首页&#39;, 
                        &#39;nextPageLabel&#39; => &#39;下一页&#39;, 
                        &#39;prevPageLabel&#39; => &#39;上一页&#39;, 
                        &#39;lastPageLabel&#39; => &#39;末页&#39;, 
                    ), 
                )); 
?>

The second type: CLinkPager for data paging in the form of arrays

Controller:

public function actionIndex() { 
  
        $criteria = new CDbCriteria(); 
        $criteria->order = 'news_id DESC'; 
        $criteria->condition = 'user_id = 1'; 
  
        $count = News::model()->count($criteria); 
        $pages = new CPagination($count); 
  
        $pages->pageSize = 10; 
        $pages->applyLimit($criteria); 
        $list = News::model()->findAll($criteria); 
  
        $this->render('index', array('list' => $list, 'pages' => $pages)); 
}

View:

<UL> 
    <?php foreach ($list as $item): ?> 
    <LI> 
          
        <DIV class=page-header> 
            <?php echo $item--->news_title; ?> 
        </DIV> 
  
        <DIV class=content> 
            <?php echo $item--->news_intro; ?> 
        </DIV> 
  
    </LI> 
<?php endforeach; ?> 
</UL> 
  
<DIV class=pagination> 
    <?php 
    $this--->widget(&#39;CLinkPager&#39;, array( 
        &#39;pages&#39; => $pages, 
        &#39;selectedPageCssClass&#39; => &#39;active&#39;, //当前页的class 
        &#39;hiddenPageCssClass&#39; => &#39;disabled&#39;, //禁用页的class 
        &#39;header&#39; => &#39;&#39;, //分页前显示的内容 
        &#39;maxButtonCount&#39; => 10, //显示分页数量 
        &#39;htmlOptions&#39; => array(&#39;class&#39; => &#39;&#39;), 
        &#39;firstPageLabel&#39; => &#39;首页&#39;, 
        &#39;nextPageLabel&#39; => &#39;下一页&#39;, 
        &#39;prevPageLabel&#39; => &#39;上一页&#39;, 
        &#39;lastPageLabel&#39; => &#39;末页&#39;, 
            ) 
    ); 
    ?> 
</DIV>

Three types: DAO implements paging.

Controller layer:

public function actionReport()
{
$sql = "select remitdate, sum(rate) sumrate from td_delivery 
group by remitdate 
order by remitdate desc";
$criteria=new CDbCriteria();
$result = Yii::app()->db->createCommand($sql)->query();
$pages=new CPagination($result->rowCount);
$pages->pageSize=2; 
$pages->applyLimit($criteria); 
$result=Yii::app()->db->createCommand($sql." LIMIT :offset,:limit"); 
$result->bindValue(':offset', $pages->currentPage*$pages->pageSize); 
$result->bindValue(':limit', $pages->pageSize); 
$posts=$result->query();
$this->render('report',array( 
'posts'=>$posts, 
'pages'=>$pages, 
));
}

View layer:

<?php foreach($posts as $row):?> 
 <?php echo CHtml::link($row["remitdate"],array(&#39;delivery/view&#39;,&#39;remitdate&#39;=>$row["sumrate"]));?>
 <?php echo $row["sumrate"]."<br />" ?>
 <?php endforeach;?>
 <?php 
 //分页widget代码: 
 $this->widget(&#39;CLinkPager&#39;,array(&#39;pages&#39;=>$pages));
?>

Advantages: DAO is highly efficient; Disadvantages: The view layer needs to write some styles by itself, which is a little troublesome

The fourth type: widget implements paging

model layer:

/**
* @var string attribute : 日运费 (统计用)
* 需要对新增加的字段做个声明
*/
public $dayrate;
/*
* 统计功能: 统计每日的运费
*/
public function statistics()
{
$criteria = new CDbCriteria;
$criteria->select = 'remitdate, sum(rate) AS dayrate';
$criteria->group = 'remitdate';
return new CActiveDataProvider(get_class($this), array(
'criteria'=>$criteria,
'sort'=>array(
// 表头设置点击排序的字段
'attributes'=>array(
'remitdate',
'dayrate'=>array(
'asc'=>'dayrate',
'desc'=>'dayrate DESC',
)
),
'defaultOrder'=>'remitdate desc',
),
)); 
}

Controller layer:

/**
* 运单统计功能:
* 按日期统计
*/
public function actionReport()
{
$model=new Delivery('statistics');
$model->unsetAttributes(); // clear any default values
  
$this->render('report',array(
'model'=>$model,
));
}

View layer:

<?php $this->widget(&#39;zii.widgets.grid.CGridView&#39;, array(
&#39;id&#39;=>&#39;delivery-grid&#39;,
&#39;dataProvider&#39;=>$model->statistics(),
&#39;filter&#39;=>$model,
&#39;columns&#39;=>array(
&#39;remitdate&#39;,
&#39;dayrate&#39;,
array(
&#39;class&#39;=>&#39;CButtonColumn&#39;,
),
),
));
?>

Advantages: You can use your own style; Disadvantages: Slightly less efficient.

Fifth type: Ajax paging

YII There are many ways to implement ajax paging. The more traditional one is to write JS in the view. It is roughly like this:
The approximate logic of js in the view is like this

$('#listview .yiiPager a').live('click',function(){
        $.ajax({
            url:$(this).attr('href'),
            success:function(html){
                $('#listview').html(html);
            }
        });
        return false;//阻止a标签
});

Then judge the ajax request in the controller, and then use the renderPartial method to render Partial List view, and then the partial view will be filled into the partially refreshed div by the ajax method in the view. The approximate logic of the controller is:

if (Yii::app()->request->isAjaxRequest) {
$this->renderPartial('_comments',array(
    'model' => $model,
    'comments' => $comments,//在局部视图中foreach得到每条数据
    'pages' => $pages,
   ));
    Yii::app()->end();
}

Later I found that CListview in YII is more convenient. It encapsulates paging, foreach displays the list, and also supports data sorting. Details can be found in the YII API manual. Ajax paging is used by default when using CListview. The usage method is as follows:

In the controller:

$criteria = new CDbCriteria();
$criteria->order = '`create_time` DESC';
$dataProvider = new CActiveDataProvider('Comments', array(
    'pagination'=>array(
      'pageSize'=>Yii::app()->params['commentsPerPage'],//设置分页条数以确定取出数据的条数
  ),
  'criteria'=>$criteria,
  ));
$this->render('comments',array(
         'model' => $model,
         'dataProvider' => $dataProvider,
));

Then in the view:

<?php $this->widget(&#39;zii.widgets.CListView&#39;, array(
  &#39;dataProvider&#39;=>$dataProvider,
  &#39;itemView&#39;=>&#39;_comments&#39;,
  //&#39;ajaxUpdate&#39;=> false,//这样就不会AJAX翻页
  &#39;pager&#39; => array(//pager 的配置信息。默认为<CODE>array(&#39;class&#39;=>&#39;CLinkPager&#39;)</CODE>.也可以自己配置
   &#39;nextPageLabel&#39; => &#39;下一页 »&#39;,
   &#39;prevPageLabel&#39; => &#39;« 上一页&#39;
  ),
//在这里还可以配置一些排序规则，具体可以查阅手册
));
?>

This way Ajax paging is implemented, which is very convenient.

I hope this article will be helpful to everyone’s PHP program design based on the Yii framework.

For more detailed explanations on the use of Yii2 paging and its extension methods, please pay attention to the PHP Chinese website!