class Column implements JsonSerializable (View source)

Column Object

The Column object is used to define the different columns for a DataTable.

Methods

__construct( string $type, string $label = '', Format $format = null, string $role = '')

Creates a new Column with the defined label.

string
getType()

Returns the type of column.

string
getLabel()

Returns the column label.

getFormat()

Returns the column formatter.

boolean
isFormatted()

Returns the status of if the column is formatted.

string
getRole()

Returns the column role.

array
jsonSerialize()

Custom json serialization of the column.

Details

at line 63
__construct( string $type, string $label = '', Format $format = null, string $role = '')

Creates a new Column with the defined label.

Parameters

string $type Type of Column
string $label Column label (optional).
Format $format
string $role Column role (optional).

at line 77
string getType()

Returns the type of column.

Return Value

string Column type.

at line 88
string getLabel()

Returns the column label.

Return Value

string Column label.

at line 99
Format getFormat()

Returns the column formatter.

Return Value

Format

at line 110
boolean isFormatted()

Returns the status of if the column is formatted.

Return Value

boolean

at line 121
string getRole()

Returns the column role.

Return Value

string

at line 132
array jsonSerialize()

Custom json serialization of the column.

Return Value

array