Spec-Zone.ru › Yii 2.0

Абстрактный класс yii\widgets\BaseListView

Все классы | Свойства | Методы | События
Наследование yii\widgets\BaseListView » yii\base\Widget » yii\base\Component » yii\base\Object
Реализует yii\base\Configurable, yii\base\ViewContextInterface
Подклассы yii\grid\GridView, yii\widgets\ListView
Доступен с версии 2.0
Исходный код https://github.com/yiisoft/yii2/blob/master/framework/widgets/BaseListView.php

BaseListView — базовый класс для виджетов, отображающих данные из поставщика данных, таких как ListView и GridView.

Он предоставляет такие возможности, как сортировка, постраничная навигация и также фильтрация данных.

Для получения более подробной информации и использования BaseListView, см. статью руководства по виджетам данных.

Публичные свойства

Свойство Тип Описание Определено в
$autoIdPrefix строка Префикс для автоматически сгенерированных идентификаторов виджета. yii\base\Widget
$behaviors yii\base\Behavior[] Список поведений, прикрепленных к этому компоненту yii\base\Component
$counter целое число Счетчик, используемый для генерации $id для виджетов. yii\base\Widget
$dataProvider yii\data\DataProviderInterface Поставщик данных для представления. yii\widgets\BaseListView
$emptyText строка|false Содержимое HTML, отображаемое, когда $dataProvider не имеет данных. yii\widgets\BaseListView
$emptyTextOptions массив Атрибуты HTML для emptyText представления списка. yii\widgets\BaseListView
$id строка Идентификатор виджета. yii\base\Widget
$layout строка Макет, определяющий, как должны быть организованы различные разделы представления списка. yii\widgets\BaseListView
$options массив Атрибуты HTML для контейнерного тега представления списка. yii\widgets\BaseListView
$pager массив Настройка виджета навигации по страницам. yii\widgets\BaseListView
$showOnEmpty булево Отображать ли пустое представление списка, если $dataProvider возвращает данные. yii\widgets\BaseListView
$sorter массив Настройка виджета сортировки. yii\widgets\BaseListView
$stack yii\base\Widget[] Виджеты, которые в данный момент отображаются (не завершены). yii\base\Widget
$summary строка Содержимое HTML, отображаемое в качестве сводки представления списка. yii\widgets\BaseListView
$summaryOptions массив Атрибуты HTML для сводки представления списка. yii\widgets\BaseListView
$view yii\web\View Объект представления, который можно использовать для отображения представлений или файлов представлений. yii\base\Widget
$viewPath строка Путь к представлению, который может быть префиксом к относительному имени представления. yii\base\ViewContextInterface

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

Метод Описание Определено в
__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\ViewContextInterface
hasEventHandlers() Возвращает значение, указывающее, есть ли обработчики событий, прикреплённые к указанному событию. yii\base\Component
hasMethod() Возвращает значение, указывающее, определён ли метод. yii\base\Object
hasProperty() Возвращает значение, указывающее, определено ли свойство. yii\base\Object
init() Инициализирует представление. yii\widgets\BaseListView
off() Отсоединяет существующего обработчика событий от этого компонента. yii\base\Component
on() Присоединяет обработчик событий к событию. yii\base\Component
render() Рендерит представление. yii\base\Widget
renderEmpty() Рендерит HTML-контент, указывающий, что в списке представлений нет данных. yii\widgets\BaseListView
renderFile() Рендерит файл представления. yii\base\Widget
renderItems() Рендерит модели данных. yii\widgets\BaseListView
renderPager() Рендерит постраничную навигацию. yii\widgets\BaseListView
renderSection() Рендерит секции указанного имени. yii\widgets\BaseListView
renderSorter() Рендерит сортировку. yii\widgets\BaseListView
renderSummary() Рендерит текстовый сводку. yii\widgets\BaseListView
run() Запускает виджет. yii\widgets\BaseListView
setId() Устанавливает идентификатор виджета. yii\base\Widget
setView() Устанавливает объект представления, который будет использоваться этим виджетом. yii\base\Widget
trigger() Вызывает событие. yii\base\Component
widget() Создаёт экземпляр виджета и запускает его. yii\base\Widget

События

Событие Тип Описание Определено в
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

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

$dataProvider свойство public

Источник данных для представления. Это свойство обязательно.

public yii\data\DataProviderInterface $dataProvider = null

$emptyText свойство public

HTML-контент, отображаемый, когда у $dataProvider нет данных. Когда это установлено в false , дополнительный HTML-контент не будет генерироваться. Значение по умолчанию — текст "Результатов не найдено.", который будет переведён на язык текущего приложения.

См. также:

  • $showOnEmpty
  • $emptyTextOptions
public string|false $emptyText = null

$emptyTextOptions свойство public

Атрибуты HTML для пустого текста списка. Элемент "tag" задаёт имя тега для элемента пустого текста и по умолчанию равен "div".

См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как атрибуты выводятся на экран.

public array $emptyTextOptions = ['class' => 'empty']

$layout общедоступное свойство

Макет, определяющий, как различные разделы списка должны быть организованы. Следующие токены будут заменены соответствующим содержимым раздела:

  • {summary}: раздел сводки. См. renderSummary().
  • {items}: элементы списка. См. renderItems().
  • {sorter}: сортировка. См. renderSorter().
  • {pager}: постраничный вывод. См. renderPager().
public string $layout = "{summary}\n{items}\n{pager}"

$options общедоступное свойство

Атрибуты HTML для тега контейнера списка. Элемент "tag" задаёт имя тега контейнера и по умолчанию равен "div".

См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как атрибуты выводятся на экран.

public array $options = []

$pager общедоступное свойство

Настройка виджета постраничного вывода. По умолчанию для вывода постраничного вывода используется yii\widgets\LinkPager. Вы можете использовать другой класс виджета, настроив элемент "class". Обратите внимание, что виджет должен поддерживать свойство pagination, которое будет заполнено значением pagination свойства $dataProvider.

public array $pager = []

$showOnEmpty общедоступное свойство

Определяет, будет ли отображаться пустой список, если $dataProvider не возвращает данных. Значение по умолчанию — false, что отображает элемент согласно свойствам $emptyText и $emptyTextOptions.

public boolean $showOnEmpty = false

$sorter общедоступное свойство

Настройка виджета сортировки. По умолчанию для вывода сортировки используется yii\widgets\LinkSorter. Вы можете использовать другой класс виджета, настроив элемент "class". Обратите внимание, что виджет должен поддерживать свойство sort, которое будет заполнено значением sort свойства $dataProvider.

public array $sorter = []

$summary общедоступное свойство

Содержимое HTML, отображаемое в качестве сводки списка. Если вы не хотите отображать сводку, вы можете установить её пустой строкой.

Следующие токены будут заменены соответствующими значениями:

  • {begin}: номер начальной строки (основан на 1) в текущем отображении
  • {end}: номер конечной строки (основан на 1) в текущем отображении
  • {count}: количество строк в текущем отображении
  • {totalCount}: общее количество строк
  • {page}: номер страницы (основан на 1) текущего отображения
  • {pageCount}: количество доступных страниц
public string $summary = null

$summaryOptions общедоступное свойство

Атрибуты HTML для сводки списка. Элемент "tag" задаёт имя тега для элемента сводки и по умолчанию равен "div".

См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как атрибуты выводятся на экран.

public array $summaryOptions = ['class' => 'summary']

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

init() общедоступный метод

Инициализирует представление.

public void init ( )

renderEmpty() общедоступный метод

Отображает HTML-содержимое, указывающее, что в представлении списка нет данных.

См. также $emptyText.

public string renderEmpty ( )
return string

Результат рендеринга

renderItems() абстрактный общедоступный метод

Отображает модели данных.

public abstract string renderItems ( )
return string

Результат рендеринга.

renderPager() общедоступный метод

Отображает постраничный вывод.

public string renderPager ( )
return string

Результат рендеринга

renderSection() общедоступный метод

Отображает раздел с указанным именем.

Если раздел с указанным именем не поддерживается, возвращается false.

public string|boolean renderSection ( $name )
$name string

Имя раздела, например, {summary}, {items}.

return string|boolean

Результат рендеринга раздела или false, если раздел с указанным именем не поддерживается.

renderSorter() общедоступный метод

Отображает сортировку.

public string renderSorter ( )
return string

Результат рендеринга

renderSummary() общедоступный метод

Отображает сводку.

public void renderSummary ( )

run() общедоступный метод

Запускает виджет.

public void run ( )

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-widgets-baselistview.html

Spec-Zone.ru

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