Класс yii\grid\DataColumn

DataColumn — это тип столбца по умолчанию для виджета yii\grid\GridView.

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

Простое определение столбца данных относится к атрибуту в модели данных поставщика данных GridView. Название атрибута указывается с помощью $attribute.

Указав $value и $label, можно настроить заголовок и содержимое ячеек.

Столбец данных различает значение ячейки данных и содержимое ячейки данных. Значение ячейки — это неформатированное значение, которое может использоваться для вычислений, а фактическое содержимое ячейки — это форматированная версия этого значения, которая может содержать HTML-разметку.

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

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

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

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

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

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

Имя атрибута, связанное с этим столбцом. Когда ни $content, ни $value не указаны, значение указанного атрибута извлекается из каждой модели данных и отображается.

Также, если $label не указан, отображается метка, связанная с атрибутом.

public string $attribute = null

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

Разрешить сортировку по этому столбцу. Если true и $attribute найден в определении сортировки yii\grid\GridView::$dataProvider, то ячейка заголовка этого столбца будет содержать ссылку, которая может активировать сортировку при нажатии.

public boolean $enableSorting = true

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

Необходимо ли кодировать метку заголовка в HTML.

См. также $label.

public boolean $encodeLabel = true

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

HTML-код, представляющий элемент ввода фильтра (например, текстовое поле, выпадающий список), используемый для этого столбца данных. Это свойство эффективно только при установке yii\grid\GridView::$filterModel.

• Если это свойство не установлено, будет сгенерировано текстовое поле как элемент ввода фильтра;
• Если это свойство является массивом, будет сгенерирован выпадающий список, который использует значения этого свойства в качестве вариантов списка.
• Если для этого столбца данных не нужен фильтр, установите это значение в false.

public string|array|null|false $filter = null

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

Атрибуты HTML для полей ввода фильтра. Это свойство используется в сочетании со свойством $filter. Когда $filter не установлен или является массивом, это свойство будет использоваться для рендеринга атрибутов HTML для сгенерированных полей ввода фильтра.

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

public array $filterInputOptions = ['class' => 'form-control', 'id' => null]

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

В каком формате должно отображаться значение каждой модели данных (например, "raw", "text", "html", ['date', 'php:Y-m-d']). Поддерживаемые форматы определяются используемым форматер для yii\grid\GridView. По умолчанию формат «text», который отформатирует значение как HTML-кодированный простой текст, когда yii\i18n\Formatter используется в качестве форматера GridView.

public string|array $format = 'text'

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

Метка, отображаемая в ячейке заголовка, а также используемая в качестве метки ссылки сортировки, когда сортировка включена для этого столбца. Если она не установлена и модели, предоставляемые провайдером данных GridView, являются экземплярами yii\db\ActiveRecord, метка будет определяться с помощью yii\db\ActiveRecord::getAttributeLabel(). В противном случае для получения метки будет использоваться yii\helpers\Inflector::camel2words().

public string $label = null

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

Атрибуты HTML для тега ссылки в ячейке заголовка, сгенерированной yii\data\Sort::link(), когда сортировка включена для этого столбца.

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

public array $sortLinkOptions = []

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

Анонимная функция или строка, используемая для определения значения, которое следует отобразить в текущем столбце.

Если это анонимная функция, она будет вызываться для каждой строки, и возвращаемое значение будет использоваться в качестве значения для отображения для каждой модели данных. Подпись этой функции должна быть: function ($model, $key, $index, $column). Где $model, $key, и $index относятся к модели, ключу и индексу текущей отображаемой строки, а $column — ссылка на объект yii\grid\DataColumn.

Вы также можете установить это свойство в строку, представляющую имя атрибута, которое следует отобразить в этом столбце. Это может быть использовано, когда отображаемый атрибут отличается от $attribute, который используется для сортировки и фильтрации.

Если это не установлено, $model[$attribute] будет использоваться для получения значения, где $attribute — значение $attribute.

public string|Closure $value = null

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