ListColumn
class ListColumn
List Columns definition A translation of the list column configuration
Adapted from october\backend\classes\ListColumn
Properties
| string | $columnName | ||
| string | $label | ||
| string | $type | ||
| bool | $searchable | ||
| bool | $invisible | ||
| bool | $sortable | ||
| bool | $editable | ||
| string | $valueFrom | ||
| string | $defaults | ||
| string | $sqlSelect | ||
| string | $relation | ||
| string | $width | ||
| string | $cssClass | ||
| array | $attributes | ||
| string | $format | ||
| string | $path | ||
| string | $formatter | ||
| string | $iconCssClass | ||
| array | $config |
Methods
__construct(string $columnName, string $label)
Constructor.
$this
displayAs(string $type, $config)
Specifies a list column rendering mode. Supported modes are:
- text - text column, aligned left
- number - numeric column, aligned right
array
evalConfig(array $config)
Process options and apply them to this object.
string
getName()
Returns a HTML valid name for the column name.
string
getId(string $suffix = null)
Returns a value suitable for the column id property.
Details
at line 118
__construct(string $columnName, string $label)
Constructor.
at line 134
$this
displayAs(string $type, $config)
Specifies a list column rendering mode. Supported modes are:
- text - text column, aligned left
- number - numeric column, aligned right
at line 149
protected array
evalConfig(array $config)
Process options and apply them to this object.
at line 203
string
getName()
Returns a HTML valid name for the column name.
at line 215
string
getId(string $suffix = null)
Returns a value suitable for the column id property.