BringYourOwnIdeas\Maintenance\Forms\GridFieldDropdownFilter
GridFieldDropdownFilter provides a dropdown that can be used to filter a GridField arbitrarily
Synopsis
class GridFieldDropdownFilter
implements
GridField_HTMLProvider,GridField_ActionProvider,GridField_DataManipulator
{
- // constants
- const DEFAULT_OPTION_VALUE = '_all';
- // members
- protected $name;
- protected $targetFragment;
- protected SS_List $filterOptions;
- protected $defaultOption;
- // methods
- public void __construct()
- public $this addFilterOption()
- public $this removeFilterOption()
- public void getActions()
- public void handleAction()
- public void getManipulatedData()
- public void getHTMLFragments()
Hierarchy
Implements
- SilverStripe\Forms\GridField\GridField_HTMLProvider
- SilverStripe\Forms\GridField\GridField_ActionProvider
- SilverStripe\Forms\GridField\GridField_DataManipulator
Constants
Name | Value |
---|---|
DEFAULT_OPTION_VALUE | '_all' |
Members
protected
- $defaultOption — string
- $filterOptions — SilverStripe\ORM\SS_List
- $name — string
- $targetFragment — string
Methods
public
- __construct()
- addFilterOption() — Add an option to the dropdown that provides a filter
- getActions() — {@inheritdoc}
- getHTMLFragments() — {@inheritdoc}
- getManipulatedData() — {@inheritdoc}
- handleAction() — {@inheritdoc}
- removeFilterOption() — Remove a filter option with the given name