Sample code sharing for PHP rewriting pager CLinkPager

php Rewrite the pager CLinkPager instance

1. Where is the custom pager class placed?

There are two places to put it.

The first one is to put it in protected/extensions. When using it, import it, or in Import in the config file;

The second type is placed in protected/components and exists as a component. There is no need to import

2. It is best to use the derived method The

class MyPager extends CLinkPager

The entry function is: public function run(). When the pager is displayed, run() is called, and the output inside will be displayed in the corresponding position;

Others are completely customizable. If you don’t know the previous page, next page, first page, last page, total number of pages, current page number and other information, you can refer to the source code of CLinkPager, yii/frameworks/web/widgets/pagers/CLinkPager .php

<?php

class MyPager extends CLinkPager
{
  const CSS_FIRST_PAGE=&#39;first&#39;;
  const CSS_LAST_PAGE=&#39;last&#39;;
  const CSS_PREVIOUS_PAGE=&#39;previous&#39;;
  const CSS_NEXT_PAGE=&#39;next&#39;;
  const CSS_INTERNAL_PAGE=&#39;page&#39;;
  const CSS_HIDDEN_PAGE=&#39;hidden&#39;;
  const CSS_SELECTED_PAGE=&#39;selected&#39;;

  /**
   * @var string the CSS class for the first page button. Defaults to &#39;first&#39;.
   * @since 1.1.11
   */
  public $firstPageCssClass=self::CSS_FIRST_PAGE;
  /**
   * @var string the CSS class for the last page button. Defaults to &#39;last&#39;.
   * @since 1.1.11
   */
  public $lastPageCssClass=self::CSS_LAST_PAGE;
  /**
   * @var string the CSS class for the previous page button. Defaults to &#39;previous&#39;.
   * @since 1.1.11
   */
  public $previousPageCssClass=self::CSS_PREVIOUS_PAGE;
  /**
   * @var string the CSS class for the next page button. Defaults to &#39;next&#39;.
   * @since 1.1.11
   */
  public $nextPageCssClass=self::CSS_NEXT_PAGE;
  /**
   * @var string the CSS class for the internal page buttons. Defaults to &#39;page&#39;.
   * @since 1.1.11
   */
  public $internalPageCssClass=self::CSS_INTERNAL_PAGE;
  /**
   * @var string the CSS class for the hidden page buttons. Defaults to &#39;hidden&#39;.
   * @since 1.1.11
   */
  public $hiddenPageCssClass=self::CSS_HIDDEN_PAGE;
  /**
   * @var string the CSS class for the selected page buttons. Defaults to &#39;selected&#39;.
   * @since 1.1.11
   */
  public $selectedPageCssClass=self::CSS_SELECTED_PAGE;
  /**
   * @var integer maximum number of page buttons that can be displayed. Defaults to 10.
   */
  public $maxButtonCount=10;
  /**
   * @var string the text label for the next page button. Defaults to &#39;Next >&#39;.
   */
  public $nextPageLabel;
  /**
   * @var string the text label for the previous page button. Defaults to &#39;< Previous&#39;.
   */
  public $prevPageLabel;
  /**
   * @var string the text label for the first page button. Defaults to &#39;<< First&#39;.
   */
  public $firstPageLabel;
  /**
   * @var string the text label for the last page button. Defaults to &#39;Last >>&#39;.
   */
  public $lastPageLabel;
  /**
   * @var string the text shown before page buttons. Defaults to &#39;Go to page: &#39;.
   */
  public $header;
  /**
   * @var string the text shown after page buttons.
   */
  public $footer=&#39;&#39;;
  /**
   * @var mixed the CSS file used for the widget. Defaults to null, meaning
   * using the default CSS file included together with the widget.
   * If false, no CSS file will be used. Otherwise, the specified CSS file
   * will be included when using this widget.
   */
  public $cssFile;
  /**
   * @var array HTML attributes for the pager container tag.
   */
  public $htmlOptions=array();

  /**
   * Initializes the pager by setting some default property values.
   */
  public function init()
  {
    if($this->nextPageLabel===null)
      $this->nextPageLabel=Yii::t(&#39;yii&#39;,&#39;Next >&#39;);
    if($this->prevPageLabel===null)
      $this->prevPageLabel=Yii::t(&#39;yii&#39;,&#39;< Previous&#39;);
    //if($this->firstPageLabel===null)
    // $this->firstPageLabel=Yii::t(&#39;yii&#39;,&#39;<< First&#39;);
    //if($this->lastPageLabel===null)
    // $this->lastPageLabel=Yii::t(&#39;yii&#39;,&#39;Last >>&#39;);
    if($this->header===null)
      $this->header=Yii::t(&#39;yii&#39;,&#39;Go to page: &#39;);

    if(!isset($this->htmlOptions[&#39;id&#39;]))
      $this->htmlOptions[&#39;id&#39;]=$this->getId();
    if(!isset($this->htmlOptions[&#39;class&#39;]))
      $this->htmlOptions[&#39;class&#39;]=&#39;yiiPager&#39;;
  }

  /**
   * Executes the widget.
   * This overrides the parent implementation by displaying the generated page buttons.
   */
  public function run()
  {
    $this->registerClientScript();
    $buttons=$this->createPageButtons();
    if(empty($buttons))
      return;
    echo $this->header;
//   echo CHtml::tag(&#39;ul&#39;,$this->htmlOptions,implode("\n",$buttons));
    echo implode("\n",$buttons);
    echo $this->footer;
  }

  /**
   * Creates the page buttons.
   * @return array a list of page buttons (in HTML code).
   */
  protected function createPageButtons()
  {
    if(($pageCount=$this->getPageCount())<=1)
      return array();

    list($beginPage,$endPage,$ellipsis)=$this->getPageRange();

    $currentPage=$this->getCurrentPage(false); // currentPage is calculated in getPageRange()
    $buttons=array();

    // first page
    //$buttons[]=$this->createPageButton($this->firstPageLabel,0,$this->firstPageCssClass,$currentPage<=0,false);

    // prev page
    if(($page=$currentPage-1)<0)
      $page=0;
    if($currentPage == 0){
      $buttons[] = "<span style=&#39;background:#a3a3a3&#39;><上一頁</span>";
    }else{
      $buttons[]=$this->createPageButton($this->prevPageLabel,$page,$this->previousPageCssClass,$currentPage<=0,false);
    }
    // internal pages start
    // first
    $buttons[]=$this->createPageButton(1,0,$this->internalPageCssClass,false,$i==$currentPage);
    //middle
    if($ellipsis == &#39;both&#39;){
      $buttons[] = "<span style=&#39;background:#a3a3a3&#39;>...</span>";
    }
    for($i=$beginPage;$i<=$endPage;++$i){
      if($ellipsis == &#39;left&#39; && $i == $beginPage){
        $buttons[] = "<span style=&#39;background:#a3a3a3&#39;>...</span>";
      }
      $buttons[]=$this->createPageButton($i+1,$i,$this->internalPageCssClass,false,$i==$currentPage);
      if($ellipsis == &#39;right&#39; && $i == $endPage){
        $buttons[] = "<span style=&#39;background:#a3a3a3&#39;>...</span>";
      }
    }  
    if($ellipsis == &#39;both&#39;){
      $buttons[] = "<span style=&#39;background:#a3a3a3&#39;>...</span>";
    }
    // last
    $buttons[]=$this->createPageButton($pageCount,$pageCount - 1,$this->internalPageCssClass,false,$i==$currentPage);
    // internal pages end
    // next page
    if(($page=$currentPage+1)>=$pageCount-1)
      $page=$pageCount-1;
    if($currentPage == ($pageCount-1)){
      $buttons[] = "<span style=&#39;background:#a3a3a3&#39;>下一頁></span>";
    }else{
      $buttons[]=$this->createPageButton($this->nextPageLabel,$page,$this->nextPageCssClass,$currentPage>=$pageCount-1,false);
    }
    // last page
    //$buttons[]=$this->createPageButton($this->lastPageLabel,$pageCount-1,$this->lastPageCssClass,$currentPage>=$pageCount-1,false);

    return $buttons;
  }

  /**
   * Creates a page button.
   * You may override this method to customize the page buttons.
   * @param string $label the text label for the button
   * @param integer $page the page number
   * @param string $class the CSS class for the page button.
   * @param boolean $hidden whether this page button is visible
   * @param boolean $selected whether this page button is selected
   * @return string the generated button
   */
  protected function createPageButton($label,$page,$class,$hidden,$selected)
  {
    if($hidden || $selected)
      $class.=&#39; &#39;.($hidden ? $this->hiddenPageCssClass : $this->selectedPageCssClass);
    if ($selected) {
      $result = "<span>" . ++$page . "</span>";
    } else {
      $result = CHtml::link($label,$this->createPageUrl($page));
    }
    return $result;
  }

  /**
   * @return array the begin and end pages that need to be displayed.
   */
  protected function getPageRange()
  {
    $currentPage=$this->getCurrentPage();
    $pageCount=$this->getPageCount();
    /*$beginPage=max(0, $currentPage-(int)($this->maxButtonCount/2));
    if(($endPage=$beginPage+$this->maxButtonCount-1)>=$pageCount)
    {
      $endPage=$pageCount-1;
      $beginPage=max(0,$endPage-$this->maxButtonCount+1);
    }*/
    if($pageCount > $this->maxButtonCount){
      if($currentPage > 4 && $currentPage < ($pageCount - 4)){
        // print_r(&#39;a&#39;);
        $beginPage = $currentPage - 2;
        $endPage = $currentPage + 2;
        $ellipsis = &#39;both&#39;;
      }else{
        $beginPage=max(1, $currentPage-(int)($this->maxButtonCount/2));
        if($beginPage == 1){
          $ellipsis = &#39;right&#39;;
        }else{
          $ellipsis = &#39;left&#39;;
        }
        if(($endPage=$beginPage+$this->maxButtonCount-1)>=$pageCount)
        {
          // print_r(&#39;b&#39;);
          $endPage=$pageCount-2;
          $beginPage=max(1,$endPage-$this->maxButtonCount+1);
        }elseif(($endPage=$beginPage+$this->maxButtonCount-1)>=$pageCount-2){
          // print_r(&#39;c&#39;);
          $endPage=$pageCount-2;
        }

      }
    }else{
      $beginPage=max(1, $currentPage-(int)($this->maxButtonCount/2));
      if(($endPage=$beginPage+$this->maxButtonCount-1)>=$pageCount)
      {
        $endPage=$pageCount-2;
        $beginPage=max(1,$endPage-$this->maxButtonCount+1);
      }
    }

    return array($beginPage,$endPage, $ellipsis);
  }

  /**
   * Registers the needed client scripts (mainly CSS file).
   */
  public function registerClientScript()
  {
    if($this->cssFile!==false)
      self::registerCssFile($this->cssFile);
  }

  /**
   * Registers the needed CSS file.
   * @param string $url the CSS URL. If null, a default CSS URL will be used.
   */
  public static function registerCssFile($url=null)
  {
    if($url===null)
      $url=CHtml::asset(Yii::getPathOfAlias(&#39;system.web.widgets.pagers.pager&#39;).&#39;.css&#39;);
    Yii::app()->getClientScript()->registerCssFile($url);
  }
}

3. Calling method

In the corresponding widget in View, define the pager class as the custom pager class name. Reference:

$this->widget('zii.widgets.CListView', array(
  'dataProvider'=>$dataProvider,
  'itemView'=>'_view_t',
  'pager'=>array(
  'class'=>'MyPager',
 )
));

The above is the detailed content of Sample code sharing for PHP rewriting pager CLinkPager. For more information, please follow other related articles on the PHP Chinese website!