\AbcGridFieldConfig
Encapsulates a collection of components following the {@link GridFieldComponent} interface.
While the itself has some configuration in the form of setters,
most of the details are dealt with through components.
For example, you would add a component to enable
pagination on the listed records, and configure it through .
In order to reduce the amount of custom code required, the framework provides
some default configurations for common use cases:
- (added by default to GridField)
- -
Synopsis
class AbcGridFieldConfig
extends GridFieldConfig
{
- // members
- protected ArrayList $components = NULL;
- // methods
- public static GridFieldConfig create()
- public void __construct()
- public void addComponent()
- public void addComponents()
- public GridFieldConfig removeComponent()
- public GridFieldConfig removeComponentsByType()
- public ArrayList getComponents()
- public ArrayList getComponentsByType()
- public GridFieldComponent getComponentByType()
Hierarchy
Extends
- GridFieldConfig
Members
protected
- $components — ArrayList
Methods
public
- __construct()
- addComponent()
- addComponents()
- create()
- getComponentByType() — Returns the first available component with the given class or interface.
- getComponents()
- getComponentsByType() — Returns all components extending a certain class, or implementing a certain interface.
- removeComponent()
- removeComponentsByType()