Класс yii\widgets\ListView

Виджет ListView используется для отображения данных из поставщика данных. Каждая модель данных отображается с помощью указанного представления.

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

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

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

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

События

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

$afterItem общественное свойство (доступно с версии 2.0.11)

Анонимная функция, вызываемая один раз ПОСЛЕ рендеринга каждой модели данных.

Она должна иметь ту же сигнатуру, что и $beforeItem.

Результат работы функции будет рендериться непосредственно. Примечание: если функция возвращает null, ничего не будет рендериться после элемента.

См. также renderAfterItem().

public Closure $afterItem = null

$beforeItem общественное свойство (доступно с версии 2.0.11)

Анонимная функция, вызываемая один раз ДО рендеринга каждой модели данных. Она должна иметь следующую сигнатуру:

function ($model, $key, $index, $widget)

• $model: текущая модель данных, подлежащая рендерингу
• $key: значение ключа, связанного с текущей моделью данных
• $index: нулевой индекс модели данных в массиве моделей, возвращаемом $dataProvider
• $widget: объект ListView

Результат работы функции будет рендериться непосредственно. Примечание: если функция возвращает null, ничего не будет рендериться перед элементом.

См. также renderBeforeItem().

public Closure $beforeItem = null

$itemOptions общественное свойство

Атрибуты HTML для контейнера результата рендеринга каждой модели данных. Это может быть либо массив, определяющий общие атрибуты HTML для рендеринга каждого элемента, либо анонимная функция, возвращающая массив атрибутов HTML. Анонимная функция будет вызываться один раз для каждой модели данных, возвращаемой $dataProvider. Элемент "tag" определяет имя тега контейнерного элемента и по умолчанию равен "div". Если "tag" равен false, контейнерный элемент не будет рендериться.

Если это свойство задано как анонимная функция, она должна иметь следующую сигнатуру:

function ($model, $key, $index, $widget)

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

public array|Closure $itemOptions = []

$itemView общественное свойство

Имя представления для рендеринга каждого элемента данных или обратный вызов (например, анонимная функция) для рендеринга каждого элемента данных. Если указано имя представления, в представлении будут доступны следующие переменные:

• $model: mixed, модель данных
• $key: mixed, значение ключа, связанное с элементом данных
• $index: integer, нулевой индекс элемента данных в массиве элементов, возвращаемом $dataProvider.
• $widget: ListView, экземпляр этого виджета

Обратите внимание, что имя представления преобразуется в файл представления текущим контекстом объекта $view.

Если это свойство задано как обратный вызов, оно должно иметь следующую сигнатуру:

function ($model, $key, $index, $widget)

public string|callable $itemView = null

$options общественное свойство

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

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

public array $options = ['class' => 'list-view']

$separator общественное свойство

Код HTML, отображаемый между любыми двумя последовательными элементами.

public string $separator = "\n"

$viewParams общественное свойство

Дополнительные параметры, которые будут переданы в $itemView при его рендеринге. Это свойство используется только тогда, когда $itemView является строкой, представляющей имя представления.

public array $viewParams = []

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