YiiのCJuiTabsで、CListViewを使う際の注意

Categories: php

YiiのCJuiTabsで、CListViewを使う際の注意

YiiのCJuiTabsでタブを用意し、タブ内でajaxを使って、CListViewのデータを表示しようとしたとき、ページネーションがうまくいかなかったので、注意点を書いておきます。

まず、タブを表示するCjuiTabsのwidgetは以下のような感じにします。

<?php 
$gcode=(isset($gcode) && !empty($gcode)) ? $gcode: null;

$this->widget('zii.widgets.jui.CJuiTabs', array(
  'tabs' => array(
    'お勧め' => array('ajax' => $this->createUrl('search/rec',array('mc'=>$gcode))),
    'まもなく' => array('ajax' => $this->createUrl('search/soon',array('mc'=>$gcode))),
    '人気' => array('ajax' => $this->createUrl('search/pop',array('mc'=>$gcode))),
    '新着' => array('ajax' => $this->createUrl('search/new',array('mc'=>$gcode))),
    'メンバー' => array('ajax' => $this->createUrl('search/member',array('mc'=>$gcode))),
    'レッスン' => array('ajax' => $this->createUrl('search/lesson',array('mc'=>$gcode))),
  ),
  // additional javascript options for the tabs plugin
  'options' => array(
    'collapsible' => true,
  ),
  // set id for this widgets
  'id'=>'dataTabs',
));

動作ですが、「お勧め」や「新着」などのタブをクリックすると、SearchController.phpのactionRecやactionNewがajaxで呼び出されるという感じです。

CjuiTabsの使い方やリファレンスは
http://www.yiiframework.com/doc/api/1.1/CJuiTabs/
を参考にしてください。

呼び出されるactionRecやactionNew関数は以下のような感じです。
両方共、ほぼ処理が同じなので、内部で_getData関数を呼び出しています。

動作としては、モデルからdataProviderを用意し、ajax経由の場合は、renderPartialで書きだす、それ以外はrenderで書きだすという感じです。

private  _getData($cssid,$order=null,$mc=null,$top=true,$soon=false)
{
  $this->cn=new CNumberFormatter('ja');
  $view=$top ? 'view4top' : 'view4detail';
  if($mc && !Category::mcategory($mc))
  {
    if (Yii::app()->request->isAjaxRequest)
    {
      Yii::app()->end(200, true);
    }
    else
      throw new CHttpException(404,'The requested page does not exist.');
  }

  $event=new Event();
  $dataProvider = $event->cache(Search::SEARCH_CACHE_SECONDS)->load4Top($order,$mc,$top,null,true,$soon);

  if (Yii::app()->request->isAjaxRequest)
  {
    $this->renderPartial($view, array('dataProvider'=>$dataProvider,'dispCategory'=>($mc?false:true),'cssid'=>$cssid), false, true);
    Yii::app()->end(200, true);
  }
  else
    $this->render($view,array('dataProvider'=>$dataProvider,'dispCategory'=>($mc?false:true),'cssid'=>$cssid));
}

public  actionNew($mc=null,$top=true)
{
  $cssid='new_'.($mc?$mc:'0').'_'.($top?'1':'0');
  $this->_getData($cssid,'t.id desc',$mc,$top);
}

public  actionRec($mc=null,$top=true)
{
  $cssid='rec_'.($mc?$mc:'0').'_'.($top?'1':'0');
  $this->_getData($cssid,'t.rank desc, t.use_ej asc,t.id desc',$mc,$top);
}

まず、ここで、注意するのは、

$this->renderPartial($view, array('dataProvider'=>$dataProvider,'dispCategory'=>($mc?false:true),'cssid'=>$cssid), false, true);

の４番目の引数のtrueです。これを設定していないとページネーションの際にajaxとして動作しません。（設定していると、actionNewなどを呼び出した際に、Yii::app()->clientScript->registerScriptで登録したスクリプトや動的に生成されたスクリプトを適切な場所に出力してくれます）

renderPartialのリファレンスは
http://www.yiiframework.com/doc/api/1.1/CController/#renderPartial-detail
です。

ついで、actionRecやactionNewで呼び出されるview4topなどのビューについてです。

<?php $this->widget('bootstrap.widgets.TbListView', array(
  'id'=>'lview_'.$cssid,
  'dataProvider' => $dataProvider,
  'itemView' => '_search4top',
  'viewData'=>array('dispCategory'=>$dispCategory),
  'template'=>'{items} {pager}',
)); ?>

ここで２つ目の注意点です。注意するのは以下のようにidを設定するということです。