Класс yii\grid\Column
| Наследование | yii\grid\Column » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Подклассы | yii\grid\ActionColumn, yii\grid\CheckboxColumn, yii\grid\DataColumn, yii\grid\RadioButtonColumn, yii\grid\SerialColumn |
| Доступен с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/grid/Column.php |
Column — базовый класс всех классов столбцов yii\grid\GridView.
Для получения более подробной информации и руководства по использованию Column, см. статью руководства по виджетам данных.
Общедоступные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $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\Column |
| $headerOptions | массив | Атрибуты HTML для тега ячейки заголовка. | yii\grid\Column |
| $options | массив | Атрибуты HTML для тега группы столбцов. | yii\grid\Column |
| $visible | булево | Видимость этого столбца. | 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\Column |
| renderFilterCellContent() | Отображает содержимое ячейки фильтра. | yii\grid\Column |
| renderFooterCellContent() | Отображает содержимое ячейки подвала. | yii\grid\Column |
| renderHeaderCellContent() | Отображает содержимое ячейки заголовка. | yii\grid\Column |
Подробное описание свойств
$content общедоступное свойство
Это вызываемый объект, который будет использоваться для генерации содержимого каждой ячейки. Подпись функции должна быть следующей: function ($model, $key, $index, $column). Где $model, $key, и $index относятся к модели, ключу и индексу строки, которая в данный момент отображается, а $column — ссылка на объект yii\grid\Column.
public callable $content = null
$contentOptions общедоступное свойство
Атрибуты HTML для тега ячейки данных. Это может быть либо массив атрибутов, либо анонимная функция (Closure), которая возвращает такой массив. Подпись функции должна быть следующей: function ($model, $key, $index, $column). Где $model, $key, и $index относятся к модели, ключу и индексу строки, которая в данный момент отображается, а $column — ссылка на объект yii\grid\Column. Функция может использоваться для назначения различных атрибутов различным строкам на основе данных в этой строке.
См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как отображаются атрибуты.
public array|Closure $contentOptions = []
$filterOptions общедоступное свойство
Атрибуты HTML для тега ячейки фильтра.
См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как отображаются атрибуты.
public array $filterOptions = []
$footer общедоступное свойство
Содержимое ячейки подвала. Обратите внимание, что оно не будет кодироваться HTML.
public string $footer = null
$footerOptions общедоступное свойство
Атрибуты HTML для тега ячейки подвала.
См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как отображаются атрибуты.
public array $footerOptions = []
$grid общедоступное свойство
Объект представления таблицы, владеющий этим столбцом.
public yii\grid\GridView $grid = null
$header общественное свойство
Содержимое ячейки заголовка. Обратите внимание, что оно не будет кодироваться в HTML.
public string $header = null
$headerOptions общественное свойство
Атрибуты HTML для тега ячейки заголовка.
См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как атрибуты отображаются.
public array $headerOptions = []
$options общественное свойство
Атрибуты HTML для тега группы столбцов.
См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как атрибуты отображаются.
public array $options = []
$visible общественное свойство
Видимость этого столбца. По умолчанию true.
public boolean $visible = true
Подробное описание методов
getHeaderCellLabel() защищённый метод (доступен с версии 2.0.8)
Возвращает метку ячейки заголовка.
Этот метод может быть переопределён для настройки метки ячейки заголовка.
| защищённый string getHeaderCellLabel ( ) | ||
|---|---|---|
| return | string |
Метка |
renderDataCell() общественный метод
Отображает ячейку данных.
| общественный string renderDataCell ( $model, $key, $index ) | ||
|---|---|---|
| $model | смешанный тип |
Модель данных, которая отображается |
| $key | смешанный тип |
Ключ, связанный с моделью данных |
| $index | целое число |
Индекс элемента данных, начиная с нуля, в массиве элементов, возвращённом yii\grid\GridView::$dataProvider. |
| return | string |
Результат отображения |
renderDataCellContent() защищённый метод
Отображает содержимое ячейки данных.
| защищённый string renderDataCellContent ( $model, $key, $index ) | ||
|---|---|---|
| $model | смешанный тип |
Модель данных |
| $key | смешанный тип |
Ключ, связанный с моделью данных |
| $index | целое число |
Индекс элемента данных, начиная с нуля, в массиве моделей, возвращённом yii\grid\GridView::$dataProvider. |
| return | string |
Результат отображения |
renderFilterCell() общественный метод
Отображает ячейку фильтра.
| общественный void renderFilterCell ( ) |
|---|
renderFilterCellContent() защищённый метод
Отображает содержимое ячейки фильтра.
По умолчанию просто отображает пробел. Этот метод может быть переопределён для настройки отображения ячейки фильтра (если она есть).
| защищённый string renderFilterCellContent ( ) | ||
|---|---|---|
| return | string |
Результат отображения |
renderFooterCell() общественный метод
Отображает ячейку подвала.
| общественный void renderFooterCell ( ) |
|---|
renderFooterCellContent() защищённый метод
Отображает содержимое ячейки подвала.
По умолчанию просто отображает $footer. Этот метод может быть переопределён для настройки отображения ячейки подвала.
| защищённый string renderFooterCellContent ( ) | ||
|---|---|---|
| return | string |
Результат отображения |
renderHeaderCell() общественный метод
Отображает ячейку заголовка.
| общественный void renderHeaderCell ( ) |
|---|
renderHeaderCellContent() защищённый метод
Отображает содержимое ячейки заголовка.
По умолчанию просто отображает $header. Этот метод может быть переопределён для настройки отображения ячейки заголовка.
| защищённый string renderHeaderCellContent ( ) | ||
|---|---|---|
| return | string |
Результат отображения |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-grid-column.html
