GridFieldFilterHeader
class GridFieldFilterHeader implements GridField_URLHandler, GridField_HTMLProvider, GridField_DataManipulator, GridField_ActionProvider (View source)
GridFieldFilterHeader alters the {@link GridField} with some filtering fields in the header of each column.
Properties
| bool | $useLegacyFilterHeader | Indicates that this component should revert to displaying it's legacy table header style rather than the react driven search box |
|
| static private bool | $force_legacy | Forces all filter components to revert to displaying the legacy table header style rather than the react driven search box |
Methods
No description
Determine what happens when this component is used with a list that isn't {@link SS_Filterable}.
See {@link setThrowExceptionOnBadDataType()}
If the GridField has a filterable datalist, return an array of actions
If the GridField has a filterable datalist, return an array of actions
Returns whether this {@link GridField} has any columns to filter on at all
Generate a search context based on the model class of the of the GridField
Generate fields for the legacy filter header row
Either returns the legacy filter header or the search button and field
Details
array
getURLHandlers(GridField $gridField)
__construct(bool $useLegacy = false, callable $updateSearchContext = null, callable $updateSearchForm = null)
setThrowExceptionOnBadDataType(bool $throwExceptionOnBadDataType)
Determine what happens when this component is used with a list that isn't {@link SS_Filterable}.
- true: An exception is thrown
- false: This component will be ignored - it won't make any changes to the GridField.
By default, this is set to true so that it's clearer what's happening, but the predefined {@link GridFieldConfig} subclasses set this to false for flexibility.
getThrowExceptionOnBadDataType()
See {@link setThrowExceptionOnBadDataType()}
array
getActions($gridField)
If the GridField has a filterable datalist, return an array of actions
handleAction(GridField $gridField, string $actionName, array $arguments, array $data)
If the GridField has a filterable datalist, return an array of actions
bool
canFilterAnyColumns(GridField $gridField)
Returns whether this {@link GridField} has any columns to filter on at all
SearchContext
getSearchContext(GridField $gridField)
Generate a search context based on the model class of the of the GridField
string
getSearchFieldSchema(GridField $gridField)
Returns the search field schema for the component
HTTPResponse
getSearchFormSchema(GridField $gridField)
Returns the search form schema for the component
ArrayList|null
getLegacyFilterHeader(GridField $gridField)
deprecated
deprecated
Generate fields for the legacy filter header row
array
getHTMLFragments(GridField $gridField)
Either returns the legacy filter header or the search button and field