Filter
class Filter extends JsonConfig (View source)
Filter Parent Class
The base class for the individual filter objects, providing common functions to the child objects.
Methods
Builds a new Filter Object Takes either a column label or a column index to filter. The options object will be created internally, so no need to set defaults. The child filter objects will set them.
Shortcut method to set the value of an option and return $this.
Parses the config array by passing the values through each method to check validity against if the option exists.
Returns the Filter type.
The column of the datatable the filter should operate upon.
The label of the column the filter should operate upon.
Details
at line 50
__construct(
Options $options,
array $columnLabelOrIndex,
array $config = array())
Builds a new Filter Object Takes either a column label or a column index to filter. The options object will be created internally, so no need to set defaults. The child filter objects will set them.
in
JsonConfig at line 64
mixed
__get(
string $option)
Get the value of a set option via magic method.
in
JsonConfig at line 75
Options
getOptions()
Gets the Options object for the JsonConfig
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.
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.
in
JsonConfig at line 275
array
jsonSerialize()
Custom serialization of the JsonConfig object.
at line 82
string
getType()
Returns the Filter type.
at line 97
Filter
filterColumnIndex(
integer $columnIndex)
The column of the datatable the filter should operate upon.
It is mandatory to provide either this option or filterColumnLabel. If both present, this option takes precedence.
at line 111
Filter
filterColumnLabel(
string $columnLabel)
The label of the column the filter should operate upon.
It is mandatory to provide either this option or filterColumnIndex. If both present, filterColumnIndex takes precedence.
at line 122
Filter
ui(
array $uiConfig)
Assigns custom attributes to the controls that the filter is attached to.