CLinkPager

Подробное описание свойств

cssFile свойство

public mixed $cssFile;

файл CSS, используемый для виджета. По умолчанию null, что означает использование файла по умолчанию, включённого вместе с виджетом. Если false, файл CSS не будет использоваться. В противном случае, указанный файл CSS будет включён при использовании этого виджета.

firstPageCssClass свойство (доступно начиная с версии v1.1.11)

public string $firstPageCssClass;

класс CSS для кнопки первой страницы. По умолчанию 'first'.

firstPageLabel свойство

public string $firstPageLabel;

текстовая метка для кнопки первой страницы. По умолчанию '<< Первая'. Установка значения false отключит эту кнопку.

footer свойство

public string $footer;

текст, отображаемый после кнопок страниц.

header свойство

public string $header;

текст, отображаемый перед кнопками страниц. По умолчанию 'Перейти на страницу: '.

hiddenPageCssClass свойство (доступно начиная с версии v1.1.11)

public string $hiddenPageCssClass;

класс CSS для скрытых кнопок страниц. По умолчанию 'hidden'.

htmlOptions свойство

public array $htmlOptions;

HTML-атрибуты для тега контейнера навигатора.

internalPageCssClass свойство (доступно начиная с версии v1.1.11)

public string $internalPageCssClass;

класс CSS для внутренних кнопок страниц. По умолчанию 'page'.

lastPageCssClass свойство (доступно начиная с версии v1.1.11)

public string $lastPageCssClass;

класс CSS для кнопки последней страницы. По умолчанию 'last'.

lastPageLabel свойство

public string $lastPageLabel;

текстовая метка для кнопки последней страницы. По умолчанию 'Последняя >>'. Установка значения false отключит эту кнопку.

maxButtonCount свойство

public integer $maxButtonCount;

максимальное количество кнопок страниц, которые могут быть отображены. По умолчанию 10.

nextPageCssClass свойство (доступно начиная с версии v1.1.11)

public string $nextPageCssClass;

класс CSS для кнопки следующей страницы. По умолчанию 'next'.

nextPageLabel свойство

public string $nextPageLabel;

текстовая метка для кнопки следующей страницы. По умолчанию 'Следующая >'. Установка значения false отключит эту кнопку.

pageRange свойство только для чтения

protected array getPageRange()

начальная и конечная страницы, которые нужно отобразить.

prevPageLabel свойство

public string $prevPageLabel;

текстовая метка для кнопки предыдущей страницы. По умолчанию '< Предыдущая'. Установка значения false отключит эту кнопку.

previousPageCssClass свойство (доступно начиная с версии v1.1.11)

public string $previousPageCssClass;

класс CSS для кнопки предыдущей страницы. По умолчанию 'previous'.

selectedPageCssClass свойство (доступно начиная с версии v1.1.11)

public string $selectedPageCssClass;

класс CSS для выделенных кнопок страниц. По умолчанию 'selected'.

Подробное описание методов

createPageButton() метод

protected string createPageButton(string $label, integer $page, string $class, boolean $hidden, boolean $selected)

protected function createPageButton($label,$page,$class,$hidden,$selected)
{
    if($hidden || $selected)
        $class.=' '.($hidden ? $this->hiddenPageCssClass : $this->selectedPageCssClass);
    return '<li class="'.$class.'">'.CHtml::link($label,$this->createPageUrl($page)).'</li>';
}

Создаёт кнопку страницы. Вы можете переопределить этот метод для настройки кнопок страниц.

createPageButtons() метод

protected array createPageButtons()

protected function createPageButtons()
{
    if(($pageCount=$this->getPageCount())<=1)
        return array();

    list($beginPage,$endPage)=$this->getPageRange();
    $currentPage=$this->getCurrentPage(false); // currentPage is calculated in getPageRange()
    $buttons=array();
    
    // first page
    if ($this->firstPageLabel !== false) {
        $buttons[]=$this->createPageButton($this->firstPageLabel,0,$this->firstPageCssClass,$currentPage<=0,false);
    }
    // prev page
    if ($this->prevPageLabel !== false) {
        if(($page=$currentPage-1)<0)
            $page=0;
        $buttons[]=$this->createPageButton($this->prevPageLabel,$page,$this->previousPageCssClass,$currentPage<=0,false);
    }

    // internal pages
    for($i=$beginPage;$i<=$endPage;++$i)
        $buttons[]=$this->createPageButton($i+1,$i,$this->internalPageCssClass,false,$i==$currentPage);
    
    // next page
    if ($this->nextPageLabel !== false) {
        if(($page=$currentPage+1)>=$pageCount-1)
            $page=$pageCount-1;
        $buttons[]=$this->createPageButton($this->nextPageLabel,$page,$this->nextPageCssClass,$currentPage>=$pageCount-1,false);
    }
    // last page
    if ($this->lastPageLabel !== false) {
        $buttons[]=$this->createPageButton($this->lastPageLabel,$pageCount-1,$this->lastPageCssClass,$currentPage>=$pageCount-1,false);
    }

    return $buttons;
}

Создаёт кнопки страниц.

getPageRange() метод

protected array getPageRange()

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);
    }
    return array($beginPage,$endPage);
}

init() метод

public void init()

public function init()
{
    if($this->nextPageLabel===null)
        $this->nextPageLabel=Yii::t('yii','Next >');
    if($this->prevPageLabel===null)
        $this->prevPageLabel=Yii::t('yii','< Previous');
    if($this->firstPageLabel===null)
        $this->firstPageLabel=Yii::t('yii','<< First');
    if($this->lastPageLabel===null)
        $this->lastPageLabel=Yii::t('yii','Last >>');
    if($this->header===null)
        $this->header=Yii::t('yii','Go to page: ');

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

Инициализирует навигатор, задавая некоторые значения свойств по умолчанию.

registerClientScript() метод

public void registerClientScript()

public function registerClientScript()
{
    if($this->cssFile!==false)
        self::registerCssFile($this->cssFile);
}

Регистрирует необходимые скрипты клиента (в основном файл CSS).

registerCssFile() метод

public static void registerCssFile(string $url=NULL)

public static function registerCssFile($url=null)
{
    if($url===null)
        $url=CHtml::asset(Yii::getPathOfAlias('system.web.widgets.pagers.pager').'.css');
    Yii::app()->getClientScript()->registerCssFile($url);
}

Регистрирует необходимый файл CSS.

run() метод

public void run()

public function run()
{
    $this->registerClientScript();
    $buttons=$this->createPageButtons();
    if(empty($buttons))
        return;
    echo $this->header;
    echo CHtml::tag('ul',$this->htmlOptions,implode("\n",$buttons));
    echo $this->footer;
}

Выполняет виджет. Это переопределяет реализацию родительского класса, отображая сгенерированные кнопки страниц.