Класс yii\grid\SerialColumn
| Наследование | yii\grid\SerialColumn » yii\grid\Column » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/grid/SerialColumn.php |
SerialColumn отображает столбец с номерами строк (с 1).
Чтобы добавить SerialColumn в yii\grid\GridView, добавьте его в конфигурацию columns следующим образом:
'columns' => [
// ...
[
'class' => 'yii\grid\SerialColumn',
// you may configure additional properties here
],
]
Для получения более подробной информации и руководства по использованию SerialColumn, см. статью руководства по виджетам данных.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $content | callable | Это вызываемый объект, который будет использоваться для генерации содержимого каждой ячейки. | yii\grid\Column |
| $contentOptions | массив|Closure | Атрибуты HTML для тега ячейки данных. | yii\grid\Column |
| $filterOptions | массив | Атрибуты HTML для тега ячейки фильтра. | yii\grid\Column |
| $footer | строка | Содержимое ячейки подвала. | yii\grid\Column |
| $footerOptions | массив | Атрибуты HTML для тега ячейки подвала. | yii\grid\Column |
| $grid | yii\grid\GridView | Объект представления таблицы, владеющий этим столбцом. | yii\grid\Column |
| $header | строка | Содержимое ячейки заголовка. | yii\grid\SerialColumn |
| $headerOptions | массив | Атрибуты HTML для тега ячейки заголовка. | yii\grid\Column |
| $options | массив | Атрибуты HTML для тега группы столбцов. | yii\grid\Column |
| $visible | boolean | Видимость этого столбца. | yii\grid\Column |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает метод, который не является методом класса. | yii\base\Object |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство (определено и не равно null). | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в значение null. | yii\base\Object |
| canGetProperty() | Возвращает значение, указывающее, можно ли прочитать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное имя этого класса. | yii\base\Object |
| hasMethod() | Возвращает значение, указывающее, определен ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\base\Object |
| renderDataCell() | Отображает ячейку данных. | yii\grid\Column |
| renderFilterCell() | Отображает ячейку фильтра. | yii\grid\Column |
| renderFooterCell() | Отображает ячейку подвала. | yii\grid\Column |
| renderHeaderCell() | Отображает ячейку заголовка. | yii\grid\Column |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| getHeaderCellLabel() | Возвращает метку ячейки заголовка. | yii\grid\Column |
| renderDataCellContent() | Отображает содержимое ячейки данных. | yii\grid\SerialColumn |
| renderFilterCellContent() | Отображает содержимое ячейки фильтра. | yii\grid\Column |
| renderFooterCellContent() | Отображает содержимое ячейки подвала. | yii\grid\Column |
| renderHeaderCellContent() | Отображает содержимое ячейки заголовка. | yii\grid\Column |
Подробности свойств
$header публичное свойство
Содержимое ячейки заголовка. Обратите внимание, что оно не будет закодировано в HTML.
public string $header = '#'
Подробности методов
renderDataCellContent() защищённый метод
Отображает содержимое ячейки данных.
| protected строка renderDataCellContent ( $model, $key, $index ) | ||
|---|---|---|
| $model | смешанный тип |
Модель данных |
| $key | смешанный тип |
Ключ, связанный с моделью данных |
| $index | целое число |
Индекс модели данных (с нуля) в массиве моделей, возвращаемом yii\grid\GridView::$dataProvider. |
| return | строка |
Результат рендеринга |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-grid-serialcolumn.html
