DataTableColumn
in package
Class DataTableColumn
Tags
Table of Contents
- $field : string
- Database field (can also be a concatenated string).
- $name : string
- Table column slug name.
- $options : array<string|int, mixed>
- Option Entries
- $source : string
- Options Source URL
- $title : string
- Title do be displayed on the table.
- $type : string
- One of the available table column types.
- getField() : string
- DbColumn Getter
- getName() : string
- Name Getter
- getOptions() : string
- Options Getter
- getSource() : string
- Source Getter
- getTitle() : string
- Title Getter
- getType() : string
- Type Getter
- setField() : DataTableColumn
- DbColumn Setter
- setName() : DataTableColumn
- Name Setter
- setOptions() : DataTableColumn
- Options Setter
- setSource() : DataTableColumn
- Source Setter
- setTitle() : DataTableColumn
- Title Setter
- setType() : DataTableColumn
- Type Setter
Properties
$field
Database field (can also be a concatenated string).
protected
string
$field
= ''
$name
Table column slug name.
protected
string
$name
= ''
$options
Option Entries
protected
array<string|int, mixed>
$options
= []
Provide [value, text] options in this array and they will be added to the multi-select widget used for the record filtering. This is an alternative to providing a source URL.
$source
Options Source URL
protected
string
$source
= ''
Applied only to STRING columns which are served with a multi-select filtering widget that will take its options from the source URL.
$title
Title do be displayed on the table.
protected
string
$title
= ''
$type
One of the available table column types.
protected
string
$type
= ''
Tags
Methods
getField()
DbColumn Getter
public
getField() : string
Return values
string —getName()
Name Getter
public
getName() : string
Return values
string —getOptions()
Options Getter
public
getOptions() : string
Return values
string —getSource()
Source Getter
public
getSource() : string
Return values
string —getTitle()
Title Getter
public
getTitle() : string
Return values
string —getType()
Type Getter
public
getType() : string
Return values
string —setField()
DbColumn Setter
public
setField(StringType $field) : DataTableColumn
Parameters
- $field : StringType
Return values
DataTableColumn —Object instance for chained calls.
setName()
Name Setter
public
setName(StringType $name) : DataTableColumn
Parameters
- $name : StringType
Return values
DataTableColumn —Object instance for chained calls.
setOptions()
Options Setter
public
setOptions(array<string|int, mixed> $options) : DataTableColumn
Parameters
- $options : array<string|int, mixed>
Return values
DataTableColumn —Object instance for chained calls.
setSource()
Source Setter
public
setSource(StringType $source) : DataTableColumn
Parameters
- $source : StringType
Return values
DataTableColumn —Object instance for chained calls.
setTitle()
Title Setter
public
setTitle(StringType $title) : DataTableColumn
Parameters
- $title : StringType
Return values
DataTableColumn —Object instance for chained calls.
setType()
Type Setter
public
setType(DataTableColumnType $type) : DataTableColumn
Parameters
- $type : DataTableColumnType
Return values
DataTableColumn —Object instance for chained calls.