Класс yii\widgets\LinkPager
| Наследование | yii\widgets\LinkPager » yii\base\Widget » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable, yii\base\ViewContextInterface |
| Доступна с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/widgets/LinkPager.php |
LinkPager отображает список гиперссылок, ведущих к различным страницам целевого ресурса.
LinkPager работает с объектом yii\data\Pagination, который определяет общее количество страниц и номер текущей страницы.
Обратите внимание, что LinkPager генерирует только необходимые HTML-разметки. Для того, чтобы он выглядел как настоящий пагинатор, вам необходимо предоставить некоторые CSS-стили. С использованием стандартной конфигурации LinkPager должен хорошо отображаться с использованием фреймворка Twitter Bootstrap.
Для получения более подробной информации и инструкций по использованию LinkPager, см. статью руководства по пагинации.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $activePageCssClass | string | CSS-класс для кнопки активной (выбранной) страницы. | yii\widgets\LinkPager |
| $autoIdPrefix | string | Префикс к автоматически сгенерированному ID виджета. | yii\base\Widget |
| $behaviors | yii\base\Behavior[] | Список присоединённых к этому компоненту поведений. | yii\base\Component |
| $counter | integer | Счётчик, используемый для генерации $id для виджетов. | yii\base\Widget |
| $disableCurrentPageButton | boolean | Определяет, нужно ли отображать кнопку текущей страницы как отключённую. | yii\widgets\LinkPager |
| $disabledListItemSubTagOptions | array | Опции для отключённого тега, генерируемого внутри элемента отключённого списка. | yii\widgets\LinkPager |
| $disabledPageCssClass | string | CSS-класс для отключённых кнопок страниц. | yii\widgets\LinkPager |
| $firstPageCssClass | string | CSS-класс для кнопки "первой" страницы. | yii\widgets\LinkPager |
| $firstPageLabel | string|boolean | Текст метки для кнопки "первой" страницы. | yii\widgets\LinkPager |
| $hideOnSinglePage | boolean | Скрыть виджет, когда существует только одна страница. | yii\widgets\LinkPager |
| $id | string | ID виджета. | yii\base\Widget |
| $lastPageCssClass | string | CSS-класс для кнопки "последней" страницы. | yii\widgets\LinkPager |
| $lastPageLabel | string|boolean | Текст метки для кнопки "последней" страницы. | yii\widgets\LinkPager |
| $linkOptions | array | Атрибуты HTML для ссылки в контейнере пагинатора. | yii\widgets\LinkPager |
| $maxButtonCount | integer | Максимальное количество кнопок страниц, которые могут быть отображены. | yii\widgets\LinkPager |
| $nextPageCssClass | string | CSS-класс для кнопки "следующей" страницы. | yii\widgets\LinkPager |
| $nextPageLabel | string|boolean | Метка для кнопки "следующей" страницы. | yii\widgets\LinkPager |
| $options | array | Атрибуты HTML для тега контейнера пагинатора. | yii\widgets\LinkPager |
| $pageCssClass | string | CSS-класс для каждой кнопки страницы. | yii\widgets\LinkPager |
| $pagination | yii\data\Pagination | Объект пагинации, с которым связан этот пагинатор. | yii\widgets\LinkPager |
| $prevPageCssClass | string | CSS-класс для кнопки "предыдущей" страницы. | yii\widgets\LinkPager |
| $prevPageLabel | string|boolean | Текст метки для кнопки предыдущей страницы. | yii\widgets\LinkPager |
| $registerLinkTags | boolean | Определяет, нужно ли регистрировать теги ссылок в заголовке HTML для страниц назад, вперёд, первой и последней. | yii\widgets\LinkPager |
| $stack | yii\base\Widget[] | Виджеты, которые в данный момент отображаются (не завершены). | yii\base\Widget |
| $view | yii\web\View | Объект представления, который можно использовать для отображения представлений или файлов представлений. | yii\base\Widget |
| $viewPath | string | Директория, содержащая файлы представлений для этого виджета. | yii\base\Widget |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Object |
| __clone() | Этот метод вызывается после создания объекта путем клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т. е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в null. | yii\base\Object |
| afterRun() | Этот метод вызывается сразу после выполнения виджета. | yii\base\Widget |
| attachBehavior() | Присоединяет поведение к данному компоненту. | yii\base\Component |
| attachBehaviors() | Присоединяет список поведений к компоненту. | yii\base\Component |
| beforeRun() | Этот метод вызывается непосредственно перед выполнением виджета. | yii\base\Widget |
| begin() | Начинает выполнение виджета. | yii\base\Widget |
| behaviors() | Возвращает список поведений, по которым должен вести себя данный компонент. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, может ли свойство быть прочитано. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, может ли свойство быть установлено. | yii\base\Object |
| className() | Возвращает полное имя этого класса. | yii\base\Object |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| end() | Заканчивает работу виджета. | yii\base\Widget |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту. | yii\base\Component |
| getBehavior() | Возвращает объект именованного поведения. | yii\base\Component |
| getBehaviors() | Возвращает все поведения, присоединенные к этому компоненту. | yii\base\Component |
| getId() | Возвращает идентификатор виджета. | yii\base\Widget |
| getView() | Возвращает объект представления, который можно использовать для рендеринга представлений или файлов представлений. | yii\base\Widget |
| getViewPath() | Возвращает каталог, содержащий файлы представлений для этого виджета. | yii\base\Widget |
| hasEventHandlers() | Возвращает значение, указывающее, прикреплен ли какой-либо обработчик к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определен ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует страницу. | yii\widgets\LinkPager |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| render() | Рендерит представление. | yii\base\Widget |
| renderFile() | Рендерит файл представления. | yii\base\Widget |
| run() | Выполняет виджет. | yii\widgets\LinkPager |
| setId() | Устанавливает идентификатор виджета. | yii\base\Widget |
| setView() | Устанавливает объект представления, который будет использоваться этим виджетом. | yii\base\Widget |
| trigger() | Вызывает событие. | yii\base\Component |
| widget() | Создает экземпляр виджета и запускает его. | yii\base\Widget |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| getPageRange() | yii\widgets\LinkPager | |
| registerLinkTags() | Регистрирует реляционные теги ссылок в заголовке html для предыдущей, следующей, первой и последней страницы. | yii\widgets\LinkPager |
| renderPageButton() | Рендерит кнопку страницы. | yii\widgets\LinkPager |
| renderPageButtons() | Рендерит кнопки страниц. | yii\widgets\LinkPager |
События
| Событие | Тип | Описание | Определено в |
|---|---|---|---|
| EVENT_AFTER_RUN | yii\base\WidgetEvent | Событие, поднимаемое сразу после выполнения виджета. (доступно начиная с версии 2.0.11) | yii\base\Widget |
| EVENT_BEFORE_RUN | yii\base\WidgetEvent | Событие, поднимаемое непосредственно перед выполнением виджета. (доступно начиная с версии 2.0.11) | yii\base\Widget |
| EVENT_INIT | yii\base\Event | Событие, которое срабатывает, когда виджет инициализируется через init(). (доступно начиная с версии 2.0.11) | yii\base\Widget |
Подробное описание свойств
$activePageCssClass общедоступное свойство
Класс CSS для активной (текущей) кнопки страницы.
public string $activePageCssClass = 'active'
$disableCurrentPageButton общедоступное свойство (доступно начиная с версии 2.0.12)
Указывает, следует ли отображать кнопку текущей страницы как отключенную.
public boolean $disableCurrentPageButton = false
$disabledListItemSubTagOptions общедоступное свойство (доступно начиная с версии 2.0.11)
Параметры для тега отключения, который должен быть сгенерирован внутри отключенного элемента списка. Для настройки тега html используйте ключ тега.
$disabledListItemSubTagOptions = ['tag' => 'div', 'class' => 'disabled-div'];
public array $disabledListItemSubTagOptions = []
$disabledPageCssClass общедоступное свойство
Класс CSS для кнопок отключенных страниц.
public string $disabledPageCssClass = 'disabled'
$firstPageCssClass общедоступное свойство
Класс CSS для кнопки "первой" страницы.
public string $firstPageCssClass = 'first'
$firstPageLabel общественное свойство
Текст метки кнопки "первой" страницы. Обратите внимание, что он НЕ будет кодироваться в HTML. Если он задан как true, номер страницы будет использоваться в качестве метки. По умолчанию false, что означает, что кнопка "первой" страницы не будет отображаться.
public string|boolean $firstPageLabel = false
$hideOnSinglePage общественное свойство
Скрыть виджет, когда существует только одна страница.
public boolean $hideOnSinglePage = true
$lastPageCssClass общественное свойство
Класс CSS для кнопки "последней" страницы.
public string $lastPageCssClass = 'last'
$lastPageLabel общественное свойство
Текст метки кнопки "последней" страницы. Обратите внимание, что он НЕ будет кодироваться в HTML. Если он задан как true, номер страницы будет использоваться в качестве метки. По умолчанию false, что означает, что кнопка "последней" страницы не будет отображаться.
public string|boolean $lastPageLabel = false
$linkOptions общественное свойство
Атрибуты HTML для ссылки в контейнере тега страницы.
См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как рендерятся атрибуты.
public array $linkOptions = []
$maxButtonCount общественное свойство
Максимальное количество кнопок страниц, которые могут быть отображены. По умолчанию 10.
public integer $maxButtonCount = 10
$nextPageCssClass общественное свойство
Класс CSS для кнопки "следующей" страницы.
public string $nextPageCssClass = 'next'
$nextPageLabel общественное свойство
Метка для кнопки "следующей" страницы. Обратите внимание, что это НЕ будет кодироваться в HTML. Если это свойство ложно, кнопка "следующей" страницы не будет отображаться.
public string|boolean $nextPageLabel = '»'
$options общественное свойство
Атрибуты HTML для тега контейнера страницы.
См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как рендерятся атрибуты.
public array $options = ['class' => 'pagination']
$pageCssClass общественное свойство (доступно начиная с версии 2.0.7)
Класс CSS для каждой кнопки страницы.
public string $pageCssClass = null
$pagination общественное свойство
Объект постраничной навигации, с которым связан этот виджет. Вы должны установить это свойство, чтобы LinkPager работал.
public yii\data\Pagination $pagination = null
$prevPageCssClass общественное свойство
Класс CSS для кнопки "предыдущей" страницы.
public string $prevPageCssClass = 'prev'
$prevPageLabel общественное свойство
Текст метки кнопки предыдущей страницы. Обратите внимание, что он НЕ будет кодироваться в HTML. Если это свойство ложно, кнопка "предыдущей" страницы не будет отображаться.
public string|boolean $prevPageLabel = '«'
$registerLinkTags общественное свойство
Следует ли регистрировать теги ссылок в заголовке HTML для страниц со знаками "предыдущая", "следующая", "первая" и "последняя". По умолчанию false, чтобы избежать конфликтов при использовании нескольких виджетов постраничной навигации на одной странице.
См. также:
public boolean $registerLinkTags = false
Подробное описание методов
getPageRange() защищенный метод
| защищенный массив getPageRange ( ) | ||
|---|---|---|
| возвращает | массив |
Начальная и конечная страницы, которые необходимо отобразить. |
init() общественный метод
Инициализирует виджет постраничной навигации.
| общественный void init ( ) |
|---|
registerLinkTags() защищенный метод
Регистрирует теги реляционных ссылок в заголовке HTML для страниц со знаками "предыдущая", "следующая", "первая" и "последняя".
Эти ссылки генерируются с помощью yii\data\Pagination::getLinks().
См. также http://www.w3.org/TR/html401/struct/links.html#h-12.1.2.
| защищенный void registerLinkTags ( ) |
|---|
renderPageButton() защищенный метод
Отображает кнопку страницы.
Вы можете переопределить этот метод, чтобы настроить генерацию кнопок страниц.
| защищенный строка renderPageButton ( $label, $page, $class, $disabled, $active ) | ||
|---|---|---|
| $label | строка |
Текст метки кнопки. |
| $page | целое число |
Номер страницы. |
| $class | строка |
Класс CSS для кнопки страницы. |
| $disabled | логическое значение |
Является ли эта кнопка страницы отключенной. |
| $active | логическое значение |
Является ли эта кнопка страницы активной. |
| возвращает | строка |
Результат рендеринга. |
renderPageButtons() защищенный метод
Отображает кнопки страниц.
| защищенный строка renderPageButtons ( ) | ||
|---|---|---|
| возвращает | строка |
Результат рендеринга. |
run() общественный метод
Выполняет виджет.
Это переопределяет реализацию родительского класса, отображая сгенерированные кнопки страниц.
| общественный void run ( ) |
|---|
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-widgets-linkpager.html
