Spec-Zone.ru › Yii 1.1

CListPager

Пакет system.web.widgets.pagers
Наследование class CListPager » CBasePager » CWidget » CBaseController » CComponent
С версии 1.0
Исходный код framework/web/widgets/pagers/CListPager.php
CListPager отображает выпадающий список, содержащий опции для перехода на разные страницы целевого ресурса.

Свойства общедоступные

Свойство Тип Описание Определено
actionPrefix строка префикс к идентификаторам действий. CWidget
controller CController Возвращает контроллер, к которому принадлежит этот виджет. CWidget
currentPage целое число индекс текущей страницы (нумерация с нуля). CBasePager
footer строка текст, отображаемый после кнопок страниц. CListPager
header строка текст, отображаемый перед кнопками страниц. CListPager
htmlOptions массив HTML-атрибуты для окружающего тега 'div'. CListPager
id строка Возвращает идентификатор виджета или генерирует новый, если запрошено. CWidget
itemCount целое число общее количество элементов. CBasePager
owner CBaseController Возвращает владельца/создателя этого виджета. CWidget
pageCount целое число количество страниц. CBasePager
pageSize целое число количество элементов на каждой странице. CBasePager
pageTextFormat строка форматирующая строка для генерации текста выбора страницы. CListPager
pages CPagination Возвращает информацию о постраничном отображении, используемую этим пейджером. CBasePager
promptText строка текст, отображаемый как опция подсказки в выпадающем списке. CListPager
skin смешанный тип имя используемой темы для этого виджета. CWidget
viewPath строка Возвращает директорию, содержащую файлы представлений для этого виджета. CWidget

Публичные методы

Метод Описание Определено в
__call() Вызывает метод с указанным именем, который не является методом класса. CComponent
__construct() Конструктор. CWidget
__get() Возвращает значение свойства, список обработчиков событий или поведение на основе его имени. CComponent
__isset() Проверяет, является ли значение свойства null. CComponent
__set() Устанавливает значение свойства компонента. CComponent
__unset() Устанавливает свойство компонента в null. CComponent
actions() Возвращает список действий, используемых этим виджетом. CWidget
asa() Возвращает объект поведения с указанным именем. CComponent
attachBehavior() Присоединяет поведение к этому компоненту. CComponent
attachBehaviors() Присоединяет список поведений к компоненту. CComponent
attachEventHandler() Присоединяет обработчик событий к событию. CComponent
beginCache() Начинает кэширование фрагмента. CBaseController
beginClip() Начинает запись клипа. CBaseController
beginContent() Начинает отображение содержимого, которое должно быть оформлено указанным представлением. CBaseController
beginWidget() Создает виджет и выполняет его. CBaseController
canGetProperty() Определяет, можно ли прочитать свойство. CComponent
canSetProperty() Определяет, можно ли установить свойство. CComponent
createWidget() Создает виджет и инициализирует его. CBaseController
detachBehavior() Отсоединяет поведение от компонента. CComponent
detachBehaviors() Отсоединяет все поведения от компонента. CComponent
detachEventHandler() Отсоединяет существующий обработчик событий. CComponent
disableBehavior() Отключает присоединенное поведение. CComponent
disableBehaviors() Отключает все присоединенные поведения к этому компоненту. CComponent
enableBehavior() Включает присоединенное поведение. CComponent
enableBehaviors() Включает все присоединенные к этому компоненту поведения. CComponent
endCache() Заканчивает кэширование фрагмента. CBaseController
endClip() Заканчивает запись клипа. CBaseController
endContent() Заканчивает отображение содержимого. CBaseController
endWidget() Заканчивает выполнение указанного виджета. CBaseController
evaluateExpression() Вычисляет выражение PHP или обратный вызов в контексте этого компонента. CComponent
getController() Возвращает контроллер, к которому принадлежит этот виджет. CWidget
getCurrentPage() Возвращает индекс текущей страницы, начиная с 0. По умолчанию 0. CBasePager
getEventHandlers() Возвращает список присоединенных обработчиков событий для события. CComponent
getId() Возвращает ID виджета или генерирует новый, если это требуется. CWidget
getItemCount() Возвращает общее количество элементов. CBasePager
getOwner() Возвращает владельца/создателя этого виджета. CWidget
getPageCount() Возвращает количество страниц. CBasePager
getPageSize() Возвращает количество элементов на каждой странице. CBasePager
getPages() Возвращает информацию о пагинации, используемую этим пейджером. CBasePager
getViewFile() Ищет файл скрипта представления по имени представления. CWidget
getViewPath() Возвращает каталог, содержащий файлы представлений для этого виджета. CWidget
hasEvent() Определяет, определено ли событие. CComponent
hasEventHandler() Проверяет, есть ли у указанного события присоединенные обработчики. CComponent
hasProperty() Определяет, определено ли свойство. CComponent
init() Инициализирует пейджер, установив некоторые значения свойств по умолчанию. CListPager
raiseEvent() Вызывает событие. CComponent
render() Отображает представление. CWidget
renderFile() Отображает файл представления. CBaseController
renderInternal() Отображает файл представления. CBaseController
run() Выполняет виджет. CListPager
setCurrentPage() Устанавливает индекс текущей страницы, начиная с 0. CBasePager
setId() Устанавливает ID виджета. CWidget
setItemCount() Устанавливает общее количество элементов. CBasePager
setPageSize() Устанавливает количество элементов на каждой странице. CBasePager
setPages() Устанавливает информацию о пагинации, используемую этим пейджером. CBasePager
widget() Создает виджет и выполняет его. CBaseController

Защищённые методы

Метод Описание Определён в
createPageUrl() Создаёт URL, подходящий для пагинации. CBasePager
createPages() Создаёт стандартную пагинацию. CBasePager
generatePageText() Генерирует элемент списка для указанной страницы. CListPager

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

footer свойство

public string $footer;

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

header свойство

public string $header;

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

htmlOptions свойство

public array $htmlOptions;

HTML-атрибуты для тега обертывающего "div".

pageTextFormat свойство

public string $pageTextFormat;

строка формата, используемая для генерации текста выбора страницы. Функция sprintf будет использована для форматирования.

promptText свойство

public string $promptText;

текст, отображаемый в качестве параметра выбора в выпадающем списке. По умолчанию null, что означает отсутствие параметра.

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

generatePageText() метод

protected string generatePageText(integer $page)
$page целое число номер страницы, начиная с нуля
{return} строка элемент списка для номера страницы
Исходный код: framework/web/widgets/pagers/CListPager.php#81 (показать)
protected function generatePageText($page)
{
    if(
$this->pageTextFormat!==null)
        return 
sprintf($this->pageTextFormat,$page+1);
    else
        return 
$page+1;
}

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

init() метод

public void init()
Исходный код: framework/web/widgets/pagers/CListPager.php#46 (показать)
public function init()
{
    if(
$this->header===null)
        
$this->header=Yii::t('yii','Go to page: ');
    if(!isset(
$this->htmlOptions['id']))
        
$this->htmlOptions['id']=$this->getId();
    if(
$this->promptText!==null)
        
$this->htmlOptions['prompt']=$this->promptText;
    if(!isset(
$this->htmlOptions['onchange']))
        
$this->htmlOptions['onchange']="if(this.value!='') {window.location=this.value;};";
}

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

run() метод

public void run()
Исходный код: framework/web/widgets/pagers/CListPager.php#62 (показать)
public function run()
{
    if((
$pageCount=$this->getPageCount())<=1)
        return;
    
$pages=array();
    for(
$i=0;$i<$pageCount;++$i)
        
$pages[$this->createPageUrl($i)]=$this->generatePageText($i);
    
$selection=$this->createPageUrl($this->getCurrentPage());
    echo 
$this->header;
    echo 
CHtml::dropDownList($this->getId(),$selection,$pages,$this->htmlOptions);
    echo 
$this->footer;
}

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

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CListPager

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API