SilverCart\Admin\Forms\GridField\GridFieldBatchController
Similar to {@link GridFieldConfig}, but adds some static helper methods.
- Author: Sebastian Diel <sdiel@pixeltricks.de>
- Copyright: 2017 pixeltricks GmbH
- License: see license file in modules root directory
Synopsis
class GridFieldBatchController
implements
GridField_HTMLProvider,GridField_ActionProvider,GridField_URLHandler,GridField_ColumnProvider
{
- // members
- protected $targetBatchActions = NULL;
- protected $targetBatchActionObjects = NULL;
- protected $targetFragment;
- protected $targetClassName;
- protected $URLHandlers = NULL;
- public static array $batchActions = ;
- // methods
- public void __construct()
- public string getTargetFragment()
- public void setTargetFragment()
- public string getTargetClassName()
- public void setTargetClassName()
- public array getTargetBatchActions()
- public array getTargetBatchActionObjects()
- public string getDropdownName()
- public string getCheckboxName()
- public array getHTMLFragments()
- public array getActions()
- public string handleAction()
- public static string handleBatchCallback()
- public array getURLHandlers()
- public void augmentColumns()
- public array getColumnsHandled()
- public string getColumnContent()
- public array getColumnAttributes()
- public array getColumnMetadata()
- public static void addBatchActionFor()
- public static boolean hasBatchActionsFor()
- public static boolean hasBatchActionFor()
- public static array getBatchActionsFor()
Hierarchy
Implements
- SilverStripe\Forms\GridField\GridField_HTMLProvider
- SilverStripe\Forms\GridField\GridField_ActionProvider
- SilverStripe\Forms\GridField\GridField_URLHandler
- SilverStripe\Forms\GridField\GridField_ColumnProvider
Members
protected
- $URLHandlers
—
array
URL handlers - $targetBatchActionObjects
—
string
Batch action objects for the given class name - $targetBatchActions
—
string
Batch actions for the given class name - $targetClassName
—
string
Class name to add actions for - $targetFragment
—
string
Fragment to write the batch actions to
public
- $batchActions
—
array
Mapping of all batch actions in relation to a DataObject
Methods
public
- __construct() — Sets the defaults.
- addBatchActionFor() — Adds a single Batch Action for the given Class Name.
- augmentColumns() — Modify the list of columns displayed in the table.
- getActions() — Returns the actions handled by this component.
- getBatchActionsFor() — Returns the batch actions for the given class name
- getCheckboxName() — Returns checkbox name
- 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.
- getDropdownName() — Returns dropdown name
- getHTMLFragments() — Adds the form fields for the batch actions
- getTargetBatchActionObjects() — Returns the batch action objects for the given class name.
- getTargetBatchActions() — Returns the batch actions for the given class name
- getTargetClassName() — Returns the class name to add actions for
- getTargetFragment() — Returns the fragment to write the batch actions to
- getURLHandlers() — Returns the URL handlers for the batch actions.
- handleAction() — Handles the given action context.
- handleBatchCallback() — Handles a batch call back action.
- hasBatchActionFor() — Checks whether the DataObject with the given class name has the given batch action.
- hasBatchActionsFor() — Checks whether the DataObject with the given class name has batch actions.
- setTargetClassName() — Sets the class name to add actions for
- setTargetFragment() — Sets the fragment to write the batch actions to