CBasePager
| Пакет | system.web.widgets.pagers |
|---|---|
| Наследование | абстрактный класс CBasePager » CWidget » CBaseController » CComponent |
| Подклассы | CLinkPager, CListPager |
| С версии | 1.0 |
| Исходный код | framework/web/widgets/pagers/CBasePager.php |
CBasePager — базовый класс для всех пейджеров.
Он обеспечивает вычисление количества страниц и сохранение текущей страницы.
Он обеспечивает вычисление количества страниц и сохранение текущей страницы.
Общедоступные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| actionPrefix | строка | префикс к идентификаторам действий. | CWidget |
| controller | CController | Возвращает контроллер, к которому принадлежит этот виджет. | CWidget |
| currentPage | целое число | индекс текущей страницы (нумерация с 0). | CBasePager |
| id | строка | Возвращает идентификатор виджета или генерирует новый, если запрошено. | CWidget |
| itemCount | целое число | общее количество элементов. | CBasePager |
| owner | CBaseController | Возвращает владельца/создателя этого виджета. | CWidget |
| pageCount | целое число | количество страниц | CBasePager |
| pageSize | целое число | количество элементов на странице. | CBasePager |
| pages | CPagination | Возвращает информацию о постраничном отображении, используемую этим пейджером. | CBasePager |
| skin | смешанный тип | имя используемой темы для этого виджета. | CWidget |
| viewPath | строка | Возвращает каталог, содержащий файлы представления для этого виджета. | CWidget |
Общедоступные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | CComponent |
| __construct() | Конструктор. | CWidget |
| __get() | Возвращает значение свойства, список обработчиков событий или поведение на основе его имени. | CComponent |
| __isset() | Проверяет, является ли значение свойства нулевым. | 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() | Возвращает идентификатор виджета или генерирует новый, если запрошено. | CWidget |
| getItemCount() | Возвращает общее количество элементов. | CBasePager |
| getOwner() | Возвращает владельца/создателя этого виджета. | CWidget |
| getPageCount() | Возвращает количество страниц | CBasePager |
| getPageSize() | Возвращает количество элементов на каждой странице. | CBasePager |
| getPages() | Возвращает информацию о постраничном отображении, используемую этим постраничным отображением. | CBasePager |
| getViewFile() | Ищет файл сценария представления в соответствии с именем представления. | CWidget |
| getViewPath() | Возвращает каталог, содержащий файлы представлений для этого виджета. | CWidget |
| hasEvent() | Определяет, определено ли событие. | CComponent |
| hasEventHandler() | Проверяет, есть ли присоединённые обработчики для указанного события. | CComponent |
| hasProperty() | Определяет, определено ли свойство. | CComponent |
| init() | Инициализирует виджет. | CWidget |
| raiseEvent() | Вызывает событие. | CComponent |
| render() | Отображает представление. | CWidget |
| renderFile() | Отображает файл представления. | CBaseController |
| renderInternal() | Отображает файл представления. | CBaseController |
| run() | Выполняет виджет. | CWidget |
| setCurrentPage() | Устанавливает индекс текущей страницы (нумерация с 0). | CBasePager |
| setId() | Устанавливает идентификатор виджета. | CWidget |
| setItemCount() | Устанавливает общее количество элементов. | CBasePager |
| setPageSize() | Устанавливает количество элементов на каждой странице | CBasePager |
| setPages() | Устанавливает информацию о постраничном отображении, используемую этим постраничным отображением. | CBasePager |
| widget() | Создаёт виджет и выполняет его. | CBaseController |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| createPageUrl() | Создаёт URL, подходящий для постраничной навигации. | CBasePager |
| createPages() | Создаёт стандартную постраничную навигацию. | CBasePager |
Подробное описание свойств
currentPage свойство
public integer getCurrentPage(boolean $recalculate=true)
public void setCurrentPage(integer $value)
Индекс текущей страницы (нумерация с нуля). По умолчанию 0.
См. также
itemCount свойство
public integer getItemCount()
public void setItemCount(integer $value)
Общее количество элементов.
См. также
pageCount свойство только для чтения
public integer getPageCount()
Количество страниц
См. также
pageSize свойство
public integer getPageSize()
public void setPageSize(integer $value)
Количество элементов на странице.
См. также
pages свойство
public CPagination getPages()
public void setPages(CPagination $pages)
Возвращает информацию о постраничной навигации, используемую этим обьектом.
Подробное описание методов
createPageUrl() метод
protected string createPageUrl(integer $page) | ||
| $page | целое число | номер страницы, на которую должен указывать URL. |
| {return} | строка | созданный URL |
Исходный код: framework/web/widgets/pagers/CBasePager.php#130 (показать)
protected function createPageUrl($page)
{
return $this->getPages()->createPageUrl($this->getController(),$page);
}
Создаёт URL, подходящий для постраничной навигации.
См. также
createPages() метод
protected CPagination createPages() | ||
| {return} | CPagination | экземпляр стандартной постраничной навигации. |
Исходный код: framework/web/widgets/pagers/CBasePager.php#55 (показать)
protected function createPages()
{
return new CPagination;
}
Создаёт стандартную постраничную навигацию. Вызывается методом getPages, если постраничная навигация не была задана ранее.
getCurrentPage() метод
public integer getCurrentPage(boolean $recalculate=true) | ||
| $recalculate | boolean | пересчитывать текущую страницу на основе размера страницы и общего количества элементов. |
| {return} | целое число | индекс текущей страницы (нумерация с нуля). По умолчанию 0. |
Исходный код: framework/web/widgets/pagers/CBasePager.php#110 (показать)
public function getCurrentPage($recalculate=true)
{
return $this->getPages()->getCurrentPage($recalculate);
}
См. также
getItemCount() метод
public integer getItemCount() | ||
| {return} | целое число | общее количество элементов. |
Исходный код: framework/web/widgets/pagers/CBasePager.php#82 (показать)
public function getItemCount()
{
return $this->getPages()->getItemCount();
}
См. также
getPageCount() метод
public integer getPageCount() | ||
| {return} | целое число | количество страниц |
Исходный код: framework/web/widgets/pagers/CBasePager.php#100 (показать)
public function getPageCount()
{
return $this->getPages()->getPageCount();
}
См. также
getPageSize() метод
public integer getPageSize() | ||
| {return} | целое число | количество элементов на каждой странице. |
Исходный код: framework/web/widgets/pagers/CBasePager.php#64 (показать)
public function getPageSize()
{
return $this->getPages()->getPageSize();
}
См. также
getPages() метод
public CPagination getPages() | ||
| {return} | CPagination | информация о постраничной навигации |
Исходный код: framework/web/widgets/pagers/CBasePager.php#34 (показать)
public function getPages()
{
if($this->_pages===null)
$this->_pages=$this->createPages();
return $this->_pages;
}
Возвращает информацию о постраничной навигации, используемую этим обьектом.
setCurrentPage() метод
public void setCurrentPage(integer $value) | ||
| $value | целое число | индекс текущей страницы (нумерация с нуля). |
Исходный код: framework/web/widgets/pagers/CBasePager.php#119 (показать)
public function setCurrentPage($value)
{
$this->getPages()->setCurrentPage($value);
}
См. также
setItemCount() метод
public void setItemCount(integer $value) | ||
| $value | целое число | общее количество элементов. |
Исходный код: framework/web/widgets/pagers/CBasePager.php#91 (показать)
public function setItemCount($value)
{
$this->getPages()->setItemCount($value);
}
См. также
setPageSize() метод
public void setPageSize(integer $value) | ||
| $value | целое число | количество элементов на каждой странице. |
Исходный код: framework/web/widgets/pagers/CBasePager.php#73 (показать)
public function setPageSize($value)
{
$this->getPages()->setPageSize($value);
}
См. также
setPages() метод
public void setPages(CPagination $pages) | ||
| $pages | CPagination | информация о постраничной навигации |
Исходный код: framework/web/widgets/pagers/CBasePager.php#45 (показать)
public function setPages($pages)
{
$this->_pages=$pages;
}
Устанавливает информацию о постраничной навигации для этого обьекта.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CBasePager