micschk\GroupableGridfield\GridFieldGroupable
Class GridFieldGroupable
Synopsis
class GridFieldGroupable
extends RequestHandler
implements
GridField_HTMLProvider,GridField_ColumnProvider,GridField_URLHandler
{
- // members
- private static array $allowed_actions = ;
- protected $groupUnassignedName;
- protected $groupFieldLabel;
- protected $groupField;
- protected $groupsAvailable;
- // methods
- public void __construct()
- public GridFieldGroupable setOption()
- public mixed getOption()
- public static void include_requirements()
- public void getURLHandlers()
- public void getHTMLFragments()
- public HTTPResponse|string handleGroupAssignment()
- public string getGroupTable()
- protected void getGroupTableClauseForIds()
- public void augmentColumns()
- public array getColumnsHandled()
- public string getColumnContent()
- public array getColumnAttributes()
- public array getColumnMetadata()
Hierarchy
Extends
- SilverStripe\Control\RequestHandler
Implements
- SilverStripe\Forms\GridField\GridField_HTMLProvider
- SilverStripe\Forms\GridField\GridField_ColumnProvider
- SilverStripe\Forms\GridField\GridField_URLHandler
Members
private
- $allowed_actions — array
protected
- $groupField
—
string
The database field which specifies the sort, defaults to "Sort". - $groupFieldLabel
—
string
The database field which specifies the sort, defaults to "Sort". - $groupUnassignedName
—
string
The database field which specifies the sort, defaults to "Sort". - $groupsAvailable
—
string
The database field which specifies the sort, defaults to "Sort".
Methods
protected
public
- __construct()
- augmentColumns() — Modify the list of columns displayed in the table.
- getColumnAttributes() — Attributes for the element containing the content returned by {@link getColumnContent()}.
- getColumnContent() — HTML for the column, content of the <td> element.
- getColumnMetadata() — Additional metadata about the column which can be used by other components, e.g. to set a title for a search column header.
- getColumnsHandled() — Names of all columns which are affected by this component.
- getGroupTable() — Gets the table which contains the group field.
- getHTMLFragments()
- getOption()
- getURLHandlers()
- handleGroupAssignment() — Handles requests to assign a new block area to a block item
- include_requirements() — Convenience function to have the requirements included
- setOption() — Sets a config option.