CategoryFilter
class CategoryFilter extends Filter (View source)
Category Filter Class
A picker to choose one or more between a set of defined values.
Constants
| TYPE |
Type of Filter.
|
Methods
Creates the new Filter object to filter the given column label or index.
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.
The column of the datatable the filter should operate upon.
The label of the column the filter should operate upon.
Assigns custom attributes to the controls that the filter is attached to.
Selects whether to use the DataTable values or the formatted values.
List of values to choose from.
Details
at line 50
__construct(
array $columnLabelOrIndex,
array $config = array())
Creates the new Filter object to filter the given column label or index.
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.
in
Filter at line 82
string
getType()
Returns the Filter type.
in
Filter 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.
in
Filter 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.
in
Filter at line 122
Filter
ui(
array $uiConfig)
Assigns custom attributes to the controls that the filter is attached to.
at line 68
Category
useFormattedValue(
boolean $useFormattedValue)
Selects whether to use the DataTable values or the formatted values.
When populating the list of selectable values automatically from the DataTable column this filter operates on, whether to use the actual cell values or their formatted values.
at line 83
Category
values(
array $values)
List of values to choose from.
If an array of Objects is used, they should have a suitable toString() representation for display to the user. If null or undefined, the list of values will be automatically computed from the values present in the DataTable column this control operates on.