Class app\widgets\DataColumn
| Inheritance | app\widgets\DataColumn » yii\grid\DataColumn » yii\grid\Column » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable |
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $attribute | string | The attribute name associated with this column. | yii\grid\DataColumn |
| $content | callable | This is a callable that will be used to generate the content of each cell. | yii\grid\Column |
| $contentOptions | array|Closure | The HTML attributes for the data cell tag. | yii\grid\Column |
| $enableSorting | boolean | Whether to allow sorting by this column. | yii\grid\DataColumn |
| $encodeLabel | boolean | Whether the header label should be HTML-encoded. | yii\grid\DataColumn |
| $filter | string|array|null|false | The HTML code representing a filter input (e.g. a text field, a dropdown list) that is used for this data column. | yii\grid\DataColumn |
| $filterAttribute | string | The attribute name of the yii\grid\GridView::$filterModel associated with this column. | yii\grid\DataColumn |
| $filterInputOptions | array | The HTML attributes for the filter input fields. | yii\grid\DataColumn |
| $filterOptions | array | The HTML attributes for the filter cell tag. | yii\grid\Column |
| $footer | string | The footer cell content. | yii\grid\Column |
| $footerOptions | array | The HTML attributes for the footer cell tag. | yii\grid\Column |
| $format | string|array|Closure | In which format should the value of each data model be displayed as (e.g. "raw", "text", "html",
['date', 'php:Y-m-d']). |
yii\grid\DataColumn |
| $grid | yii\grid\GridView | The grid view object that owns this column. | yii\grid\Column |
| $header | string | The header cell content. | yii\grid\Column |
| $headerOptions | array | The HTML attributes for the header cell tag. | yii\grid\Column |
| $label | string | Label to be displayed in the header cell and also to be used as the sorting link label when sorting is enabled for this column. | yii\grid\DataColumn |
| $options | array | The HTML attributes for the column group tag. | yii\grid\Column |
| $sortLinkOptions | array | The HTML attributes for the link tag in the header cell generated by yii\data\Sort::link() when sorting is enabled for this column. | yii\grid\DataColumn |
| $value | string|Closure | An anonymous function or a string that is used to determine the value to display in the current column. | yii\grid\DataColumn |
| $visible | boolean | Whether this column is visible. | yii\grid\Column |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\BaseObject |
| __construct() | Constructor. | yii\base\BaseObject |
| __get() | Returns the value of an object property. | yii\base\BaseObject |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\BaseObject |
| __set() | Sets value of an object property. | yii\base\BaseObject |
| __unset() | Sets an object property to null. | yii\base\BaseObject |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\BaseObject |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\BaseObject |
| className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
| getDataCellValue() | Returns the data cell value. | yii\grid\DataColumn |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\BaseObject |
| hasProperty() | Returns a value indicating whether a property is defined. | yii\base\BaseObject |
| init() | Initializes the object. | yii\base\BaseObject |
| renderDataCell() | Renders a data cell. | yii\grid\Column |
| renderFilterCell() | Renders the filter cell. | yii\grid\Column |
| renderFooterCell() | Renders the footer cell. | yii\grid\Column |
| renderHeaderCell() | Renders the header cell. | yii\grid\Column |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| getHeaderCellLabel() | Returns header cell label. | yii\grid\Column |
| renderDataCellContent() | Renders the data cell content. | yii\grid\Column |
| renderFilterCellContent() | app\widgets\DataColumn | |
| renderFooterCellContent() | Renders the footer cell content. | yii\grid\Column |
| renderHeaderCellContent() | Renders the header cell content. | yii\grid\Column |