DebugDataColumn
API reference › Debug › widgets › DebugDataColumn
Applies accessible defaults to debug GridView data columns.
Properties
Section titled “Properties”| Property | Type | Description | Defined by |
|---|---|---|---|
$attribute | string | The attribute name associated with this column. Default: null. | yii\ |
$content | callable | This is a callable that will be used to generate the content of each cell. Default: null. | yii\ |
$contentOptions | array|Closure | The HTML attributes for the data cell tag. Default: []. | yii\ |
$enableSorting | bool | Whether to allow sorting by this column. Default: true. | yii\ |
$encodeLabel | bool | Whether the header label should be HTML-encoded. Default: true. Available since 2.0.1. | yii\ |
$filter | string| | The HTML code representing a filter input (e.g. a text field, a dropdown list) that is used for this data column. Default: null. | yii\ |
$filterAttribute | string| | The attribute name of the GridView::$filterModel associated with this column. Default: null. Available since 2.0.41. | yii\ |
$filterInputOptions | array | The HTML attributes for the filter input fields. Default: ['id' => null]. | yii\ |
$filterOptions | array | The HTML attributes for the filter cell tag. Default: []. | yii\ |
$footer | string | The footer cell content. Default: null. | yii\ |
$footerOptions | array | The HTML attributes for the footer cell tag. Default: []. | yii\ |
$format | string|Closure | In which format should the value of each data model be displayed as (e.g. "raw", "text", "html", ['date',). Default: 'text'. | yii\ |
$grid | yii\ | The grid view object that owns this column. Default: null. | yii\ |
$header | string| | The header cell content. Default: null. | yii\ |
$headerOptions | array | The HTML attributes for the header cell tag. Default: []. | yii\ |
$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. Default: null. | yii\ |
$options | array | The HTML attributes for the column group tag. Default: []. | yii\ |
$sortLinkOptions | array | The HTML attributes for the link tag in the header cell generated by Sort::link() when sorting is enabled for this column. Default: []. | yii\ |
$value | string|Closure| | An anonymous function or a string that is used to determine the value to display in the current column. Default: null. | yii\ |
$visible | bool | Whether this column is visible. Default: true. | yii\ |
Methods
Section titled “Methods”| Method | Description | Defined by |
|---|---|---|
__construct() | Constructor. | yii\ |
__call() | Calls the named method which is not a class method. | yii\ |
__get() | Returns the value of an object property. | yii\ |
__isset() | Checks if a property is set, i.e. defined and not null. | yii\ |
__set() | Sets value of an object property. | yii\ |
__unset() | Sets an object property to null. | yii\ |
canGetProperty() | Returns a value indicating whether a property can be read. | yii\ |
canSetProperty() | Returns a value indicating whether a property can be set. | yii\ |
className() static | Returns the fully qualified name of this class. | yii\ |
getDataCellValue() | Returns the data cell value. | yii\ |
hasMethod() | Returns a value indicating whether a method is defined. | yii\ |
hasProperty() | Returns a value indicating whether a property is defined. | yii\ |
init() | Marks the header cell as a column scope and gives the filter input an accessible name derived from its header label. | DebugDataColumn |
renderDataCell() | Renders a data cell. | yii\ |
renderFilterCell() | Renders the filter cell. | yii\ |
renderFooterCell() | Renders the footer cell. | yii\ |
renderHeaderCell() | Renders the header cell. | yii\ |
getHeaderCellLabel() protected | Returns header cell label. | yii\ |
renderDataCellContent() protected | Renders the data cell content. | yii\ |
renderFilterCellContent() protected | Renders the filter cell content. | yii\ |
renderFooterCellContent() protected | Renders the footer cell content. | yii\ |
renderHeaderCellContent() protected | Renders the header cell content. | yii\ |
Method details
Section titled “Method details”init()
Section titled “init() ”public function init(): voidMarks the header cell as a column scope and gives the filter input an accessible name derived from its header label.