class CssClassNames extends JsonConfig (View source)

CssClassNames Properties Object

An object containing all the values for the cssClassNames which can be passed into the Table's options.

Constants

TYPE

Type of JsonConfig object

Methods

__construct( array $config = array())

Builds the CssClassNames object when passed an array of options.

mixed
__get( string $option)

Get the value of a set option via magic method.

from  JsonConfig
getOptions()

Gets the Options object for the JsonConfig

from  JsonConfig
setOption( string $option, mixed $value)

Shortcut method to set the value of an option and return $this.

from  JsonConfig
setOptions( array $config)

Parses the config array by passing the values through each method to check validity against if the option exists.

from  JsonConfig
array
jsonSerialize()

Custom serialization of the JsonConfig object.

from  JsonConfig
headerRow( string $headerRow)

Assigns a class name to the table header row ( element).

tableRow( string $tableRow)

Assigns a class name to the non-header rows ( elements).

oddTableRow( string $oddTableRow)

Assigns a class name to odd table rows ( elements). Note: the alternatingRowStyle option must be set to true.

selectedTableRow( string $selectedTableRow)

Assigns a class name to the selected table row ( element).

hoverTableRow( string $hoverTableRow)

Assigns a class name to the hovered table row ( element).

headerCell( string $headerCell)

Assigns a class name to all cells in the header row ( element).

tableCell( string $tableCell)

Assigns a class name to all non-header table cells ( element).

rowNumberCell( string $rowNumberCell)

Assigns a class name to the cells in the row number column ( element).

Details

at line 55
__construct( array $config = array())

Builds the CssClassNames object when passed an array of options.

Parameters

array $config

Exceptions

InvalidConfigValue

in JsonConfig at line 64
mixed __get( string $option)

Get the value of a set option via magic method.

Parameters

string $option Name of option.

Return Value

mixed

Exceptions

InvalidConfigProperty

in JsonConfig at line 75
Options getOptions()

Gets the Options object for the JsonConfig

Return Value

Options

in JsonConfig at line 90
JsonConfig setOption( string $option, mixed $value)

Shortcut method to set the value of an option and return $this.

In order to maintain backwards compatibility, ConfigObjects will be unwrapped.

Parameters

string $option Option to set.
mixed $value Value of the option.

Return Value

JsonConfig

in JsonConfig at line 106
setOptions( array $config)

Parses the config array by passing the values through each method to check validity against if the option exists.

Parameters

array $config

Exceptions

InvalidConfigValue
InvalidConfigProperty

in JsonConfig at line 275
array jsonSerialize()

Custom serialization of the JsonConfig object.

Return Value

array

at line 69
CssClassNames headerRow( string $headerRow)

Assigns a class name to the table header row ( element).

Parameters

string $headerRow

Return Value

CssClassNames

at line 82
CssClassNames tableRow( string $tableRow)

Assigns a class name to the non-header rows ( elements).

Parameters

string $tableRow

Return Value

CssClassNames

at line 95
CssClassNames oddTableRow( string $oddTableRow)

Assigns a class name to odd table rows ( elements). Note: the alternatingRowStyle option must be set to true.

Parameters

string $oddTableRow

Return Value

CssClassNames

at line 108
CssClassNames selectedTableRow( string $selectedTableRow)

Assigns a class name to the selected table row ( element).

Parameters

string $selectedTableRow

Return Value

CssClassNames

at line 121
CssClassNames hoverTableRow( string $hoverTableRow)

Assigns a class name to the hovered table row ( element).

Parameters

string $hoverTableRow

Return Value

CssClassNames

at line 134
CssClassNames headerCell( string $headerCell)

Assigns a class name to all cells in the header row ( element).

Parameters

string $headerCell

Return Value

CssClassNames

at line 147
CssClassNames tableCell( string $tableCell)

Assigns a class name to all non-header table cells ( element).

Parameters

string $tableCell

Return Value

CssClassNames

at line 160
CssClassNames rowNumberCell( string $rowNumberCell)

Assigns a class name to the cells in the row number column ( element).

Parameters

string $rowNumberCell

Return Value

CssClassNames