StringFilter
class StringFilter extends Filter (View source)
String Filter Class
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.
What type of string the control should match.
Whether matching should be case sensitive or not.
Whether the control should match against cell formatted values or against actual values.
Details
at line 49
__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 69
StringFilter
matchType(
string $matchType)
What type of string the control should match.
Allowed types: - exact : Match exact values only - prefix : Prefixes starting from the beginning of the value ('prefix') - any : Any substring
at line 87
StringFilter
caseSensitive(
boolean $caseSensitive)
Whether matching should be case sensitive or not.
at line 99
StringFilter
useFormattedValue(
boolean $useFormattedValue)
Whether the control should match against cell formatted values or against actual values.