Класс yii\grid\GridView

Виджет GridView используется для отображения данных в виде таблицы.

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

Пример базового использования:

<?= GridView::widget([
    'dataProvider' => $dataProvider,
    'columns' => [
        'id',
        'name',
        'created_at:datetime',
        // ...
    ],
]) ?>

Столбцы таблицы сетки настраиваются с помощью классов yii\grid\Column, которые настраиваются через $columns.

Внешний вид сетки может быть настроен с помощью большого количества свойств.

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

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

Общедоступные методы

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

События

Константы

Подробности свойств

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

Анонимная функция, вызываемая после отрисовки каждой модели данных. Она должна иметь подобную сигнатуру, как $rowOptions. Результат выполнения функции будет отображен непосредственно.

public Closure $afterRow = null

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

Анонимная функция, вызываемая перед отрисовкой каждой модели данных. Она должна иметь подобную сигнатуру, как $rowOptions. Результат выполнения функции будет отображен непосредственно.

public Closure $beforeRow = null

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

Заголовок таблицы грида

См. также $captionOptions.

public string $caption = null

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

Атрибуты HTML для элемента заголовка.

См. также:

• yii\helpers\Html::renderTagAttributes() для деталей по отрисовке атрибутов.
• $caption

public array $captionOptions = []

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

Конфигурация колонок грида. Каждый элемент массива представляет конфигурацию одной колонки. Например,

[
    ['class' => SerialColumn::className()],
    [
        'class' => DataColumn::className(), // this line is optional
        'attribute' => 'name',
        'format' => 'text',
        'label' => 'Name',
    ],
    ['class' => CheckboxColumn::className()],
]

Если колонка класса yii\grid\DataColumn, элемент "class" можно опустить.

В качестве сокращения, может быть использована строка для указания конфигурации колонки, содержащей только атрибут, формат и/или метку: "attribute:format:label". Например, вышеуказанная колонка "имя" также может быть указана как: "name:text:Name". "Формат" и "метка" являются необязательными. Они примут значения по умолчанию, если отсутствуют.

Использование сокращённого формата для конфигурации колонок в простых случаях будет выглядеть так:

[
    'id',
    'amount:currency:Total Amount',
    'created_at:datetime',
]

При использовании $dataProvider с активными записями, можно отображать значения из связанных записей, например, атрибут name отношения author:

// shortcut syntax
'author.name',
// full syntax
[
    'attribute' => 'author.name',
    // ...
]

public array $columns = []

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

Класс колонки данных по умолчанию, если имя класса не указано явно при конфигурировании колонки. По умолчанию 'yii\grid\DataColumn'.

public string $dataColumnClass = null

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

HTML отображение, когда содержимое ячейки пустое. Это свойство используется для отображения ячеек без определённого содержимого, например, пустые ячейки подвала или фильтра.

Обратите внимание, что это не используется yii\grid\DataColumn, если элемент данных является null. В этом случае используется свойство nullDisplay свойства $formatter для обозначения пустого значения данных.

public string $emptyCell = ' '

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

Опции для отображения каждого сообщения об ошибке фильтра. Это в основном используется yii\helpers\Html::error() при отображении сообщения об ошибке рядом с каждым полем ввода фильтра.

public array $filterErrorOptions = ['class' => 'help-block']

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

Опции для отображения сводки ошибок фильтра. См. yii\helpers\Html::errorSummary() для получения дополнительной информации об указании опций.

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

public array $filterErrorSummaryOptions = ['class' => 'error-summary']

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

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

Обратите внимание, что для отображения поля ввода для фильтрации, колонка должна иметь свойство yii\grid\DataColumn::$attribute, установленное и атрибут должен быть активным в текущей ситуации $filterModel или иметь yii\grid\DataColumn::$filter установленным в качестве HTML кода поля ввода.

Когда это свойство не установлено (null), функция фильтрации отключена.

public yii\base\Model $filterModel = null

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

Определяет, должны ли фильтры отображаться в гриде. Допустимые значения:

• FILTER_POS_HEADER: фильтры будут отображаться над ячейкой заголовка каждой колонки.
• FILTER_POS_BODY: фильтры будут отображаться под ячейкой заголовка каждой колонки.
• FILTER_POS_FOOTER: фильтры будут отображаться под ячейкой подвала каждой колонки.

public string $filterPosition = self::FILTER_POS_BODY

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

Атрибуты HTML для элемента строки фильтра.

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

public array $filterRowOptions = ['class' => 'filters']

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

Дополнительный jQuery селектор для выбора полей ввода фильтра.

public string $filterSelector = null

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

URL для возвращения результата фильтрации. yii\helpers\Url::to() будет вызван для нормализации URL. Если не задан, будет использоваться текущий action контроллера. Когда пользователь вносит изменения в любое поле фильтра, текущие данные фильтра будут добавлены в качестве параметров GET к этому URL.

public string|array $filterUrl = null

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

Атрибуты HTML для строки подвала таблицы.

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

public array $footerRowOptions = []

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

Форматтер, используемый для форматирования значений атрибутов модели в отображаемые тексты. Это может быть либо экземпляр yii\i18n\Formatter, либо конфигурационный массив для создания экземпляра yii\i18n\Formatter. Если это свойство не установлено, будет использован компонент "форматтер" приложения.

public array|yii\i18n\Formatter $formatter = null

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

Атрибуты HTML для строки заголовка таблицы.

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

public array $headerRowOptions = []

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

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

• {summary}: раздел сводки. См. renderSummary().
• {errors}: сводка ошибок модели фильтра. См. renderErrors().
• {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 = ['class' => 'grid-view']

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

Атрибуты HTML для строк тела таблицы. Это может быть либо массив, определяющий общие атрибуты HTML для всех строк тела, либо анонимная функция, которая возвращает массив атрибутов HTML. Анонимная функция будет вызываться один раз для каждой модели данных, возвращаемой $dataProvider. Она должна иметь следующий вид:

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

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

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

public array|Closure $rowOptions = []

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

Определяет, отображать ли секцию подвала таблицы сетки.

public boolean $showFooter = false

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

Определяет, отображать ли секцию заголовка таблицы сетки.

public boolean $showHeader = true

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

Определяет, отображать ли представление сетки, если $dataProvider не возвращает данных.

public boolean $showOnEmpty = true

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

Атрибуты HTML для элемента таблицы сетки.

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

public array $tableOptions = ['class' => 'table table-striped table-bordered']

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