ENH Make all GridField components injectable (using abstract class) (#10204)

* ENH Make all GridField components injectable.

Some components were already injectable, but all GridField components shipped in silverstripe should be injectable.
This makes it a LOT easier to make global project-specific changes to a given component.
The new AbstractGridFieldComponent also makes it easy to make similar wide-spread changes in the future.

* DOCS Encourage injection for GridField and GridFieldComponents.
This commit is contained in:
GuySartorelli 2022-02-02 11:14:33 +13:00 committed by GitHub
parent 21c279ba57
commit 5c54276b6f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
33 changed files with 129 additions and 121 deletions

View File

@ -13,7 +13,7 @@ tabular data in a format that is easy to view and modify. It can be thought of a
```php
use SilverStripe\Forms\GridField\GridField;
$field = new GridField($name, $title, $list);
$field = GridField::create($name, $title, $list);
```
[hint]
@ -45,7 +45,7 @@ class Page extends SiteTree
$fields = parent::getCMSFields();
$fields->addFieldToTab('Root.Pages',
new GridField('Pages', 'All pages', SiteTree::get())
GridField::create('Pages', 'All pages', SiteTree::get())
);
return $fields;
@ -81,7 +81,7 @@ class Page extends SiteTree
$fields = parent::getCMSFields();
$fields->addFieldToTab('Root.Pages',
$grid = new GridField('Pages', 'All pages', SiteTree::get())
$grid = GridField::create('Pages', 'All pages', SiteTree::get())
);
// GridField configuration
@ -115,7 +115,7 @@ use SilverStripe\Forms\GridField\GridFieldDataColumns;
$config = GridFieldConfig::create();
// add a component
$config->addComponent(new GridFieldDataColumns());
$config->addComponent(GridFieldDataColumns::create());
// Update the GridField with our custom configuration
$gridField->setConfig($config);
@ -128,7 +128,7 @@ before another component by passing the second parameter.
use SilverStripe\Forms\GridField\GridFieldFilterHeader;
use SilverStripe\Forms\GridField\GridFieldDataColumns;
$config->addComponent(new GridFieldFilterHeader(), GridFieldDataColumns::class);
$config->addComponent(GridFieldFilterHeader::create(), GridFieldDataColumns::class);
```
We can add multiple components in one call.
@ -136,8 +136,8 @@ We can add multiple components in one call.
```php
$config->addComponents(
new GridFieldDataColumns(),
new GridFieldToolbarHeader()
GridFieldDataColumns::create(),
GridFieldToolbarHeader::create()
);
```
@ -191,12 +191,12 @@ $config = GridFieldConfig_Base::create();
$gridField->setConfig($config);
// Is the same as adding the following components..
// .. new GridFieldToolbarHeader()
// .. new GridFieldSortableHeader()
// .. new GridFieldFilterHeader()
// .. new GridFieldDataColumns()
// .. new GridFieldPageCount('toolbar-header-right')
// .. new GridFieldPaginator($itemsPerPage)
// .. GridFieldToolbarHeader::create()
// .. GridFieldSortableHeader::create()
// .. GridFieldFilterHeader::create()
// .. GridFieldDataColumns::create()
// .. GridFieldPageCount::create('toolbar-header-right')
// .. GridFieldPaginator::create($itemsPerPage)
```
### GridFieldConfig_RecordViewer
@ -223,8 +223,8 @@ $config = GridFieldConfig_RecordViewer::create();
$gridField->setConfig($config);
// Same as GridFieldConfig_Base with the addition of
// .. new GridFieldViewButton(),
// .. new GridFieldDetailForm()
// .. GridFieldViewButton::create(),
// .. GridFieldDetailForm::create()
```
### GridFieldConfig_RecordEditor
@ -248,9 +248,9 @@ $config = GridFieldConfig_RecordEditor::create();
$gridField->setConfig($config);
// Same as GridFieldConfig_RecordViewer with the addition of
// .. new GridFieldAddNewButton(),
// .. new GridFieldEditButton(),
// .. new GridFieldDeleteAction()
// .. GridFieldAddNewButton::create(),
// .. GridFieldEditButton::create(),
// .. GridFieldDeleteAction::create()
```
### GridFieldConfig_RelationEditor
@ -287,9 +287,9 @@ $config = GridFieldConfig::create();
$config->addComponent();
$config->addComponents(
new GridFieldDataColumns(),
new GridFieldEditButton(),
new GridField_ActionMenu()
GridFieldDataColumns::create(),
GridFieldEditButton::create(),
GridField_ActionMenu::create()
);
// Update the GridField with our custom configuration
@ -308,8 +308,8 @@ The `GridFieldDetailForm` component drives the record viewing and editing form.
use SilverStripe\Forms\GridField\GridFieldDetailForm;
$form = $gridField->getConfig()->getComponentByType(GridFieldDetailForm::class);
$form->setFields(new FieldList(
new TextField('Title')
$form->setFields(FieldList::create(
TextField::create('Title')
));
```
@ -369,13 +369,13 @@ class Player extends DataObject
$teamFields->addFieldToTab(
'Root.Main',
// The "ManyMany[<extradata-name>]" convention
new TextField('ManyMany[Position]', 'Current Position')
TextField::create('ManyMany[Position]', 'Current Position')
);
$config = GridFieldConfig_RelationEditor::create();
$config->getComponentByType(GridFieldDetailForm::class)->setFields($teamFields);
$gridField = new GridField('Teams', 'Teams', $this->Teams(), $config);
$gridField = GridField::create('Teams', 'Teams', $this->Teams(), $config);
$fields->findOrMakeTab('Root.Teams')->replaceField('Teams', $gridField);
}
@ -405,8 +405,8 @@ bottom right of the table.
use SilverStripe\Forms\GridField\GridFieldButtonRow;
use SilverStripe\Forms\GridField\GridFieldPrintButton;
$config->addComponent(new GridFieldButtonRow('after'));
$config->addComponent(new GridFieldPrintButton('buttons-after-right'));
$config->addComponent(GridFieldButtonRow::create('after'));
$config->addComponent(GridFieldPrintButton::create('buttons-after-right'));
```
### Creating your own Fragments
@ -417,9 +417,10 @@ create an area rendered before the table wrapped in a simple `<div>`.
```php
use SilverStripe\Forms\GridField\AbstractGridFieldComponent;
use SilverStripe\Forms\GridField\GridField_HTMLProvider;
class MyAreaComponent implements GridField_HTMLProvider
class MyAreaComponent extends AbstractGridFieldComponent implements GridField_HTMLProvider
{
public function getHTMLFragments($gridField)
@ -442,9 +443,10 @@ Now you can add other components into this area by returning them as an array fr
```php
use SilverStripe\Forms\GridField\AbstractGridFieldComponent;
use SilverStripe\Forms\GridField\GridField_HTMLProvider;
class MyShareLinkComponent implements GridField_HTMLProvider
class MyShareLinkComponent extends AbstractGridFieldComponent implements GridField_HTMLProvider
{
public function getHTMLFragments($gridField)
@ -461,7 +463,7 @@ Your new area can also be used by existing components, e.g. the [GridFieldPrintB
```php
new GridFieldPrintButton('my-area');
GridFieldPrintButton::create('my-area');
```
## Creating a Custom GridFieldComponent

View File

@ -3,7 +3,9 @@ title: Create a GridField Component
summary: Customise your GridField with a variety of add-ons.
icon: table
---
A single component often uses a number of interfaces.
A single component often uses a number of interfaces. It is good practice for your custom
components to subclass the `AbstractGridFieldComponent` class to ensure they behave the same
way as built-in components (e.g. are `Injectable`).
### GridField_HTMLProvider

View File

@ -32,13 +32,14 @@ below:
```php
use SilverStripe\Forms\GridField\AbstractGridFieldComponent;
use SilverStripe\Forms\GridField\GridField_ColumnProvider;
use SilverStripe\Forms\GridField\GridField_ActionProvider;
use SilverStripe\Forms\GridField\GridField_FormAction;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Control\Controller;
class GridFieldCustomAction implements GridField_ColumnProvider, GridField_ActionProvider
class GridFieldCustomAction extends AbstractGridFieldComponent implements GridField_ColumnProvider, GridField_ActionProvider
{
public function augmentColumns($gridField, &$columns)
@ -114,12 +115,12 @@ manipulating the `GridFieldConfig` instance if required.
```php
// option 1: creating a new GridField with the CustomAction
$config = GridFieldConfig::create();
$config->addComponent(new GridFieldCustomAction());
$config->addComponent(GridFieldCustomAction::create());
$gridField = new GridField('Teams', 'Teams', $this->Teams(), $config);
$gridField = GridField::create('Teams', 'Teams', $this->Teams(), $config);
// option 2: adding the CustomAction to an existing GridField
$gridField->getConfig()->addComponent(new GridFieldCustomAction());
$gridField->getConfig()->addComponent(GridFieldCustomAction::create());
```
For documentation on adding a Component to a `GridField` created by `ModelAdmin`
@ -177,13 +178,14 @@ For an action to be included in the action menu dropdown, which appears on each
## Basic GridFieldCustomAction boilerplate implementing GridField_ActionMenuItem
```php
use SilverStripe\Forms\GridField\AbstractGridFieldComponent;
use SilverStripe\Forms\GridField\GridField_ColumnProvider;
use SilverStripe\Forms\GridField\GridField_ActionProvider;
use SilverStripe\Forms\GridField\GridField_ActionMenuItem;
use SilverStripe\Forms\GridField\GridField_FormAction;
use SilverStripe\Control\Controller;
class GridFieldCustomAction implements GridField_ColumnProvider, GridField_ActionProvider, GridField_ActionMenuItem
class GridFieldCustomAction extends AbstractGridFieldComponent implements GridField_ColumnProvider, GridField_ActionProvider, GridField_ActionMenuItem
{
public function getTitle($gridField, $record, $columnName)

View File

@ -299,7 +299,7 @@ class MyAdmin extends ModelAdmin
$context = parent::getSearchContext();
if($this->modelClass == 'Product') {
$context->getFields()->push(new CheckboxField('q[ExpensiveOnly]', 'Only expensive stuff'));
$context->getFields()->push(CheckboxField::create('q[ExpensiveOnly]', 'Only expensive stuff'));
}
return $context;
@ -362,7 +362,7 @@ class MyAdmin extends ModelAdmin
{
$config = parent::getGridFieldConfig();
$config->addComponent(new GridFieldFilterHeader());
$config->addComponent(GridFieldFilterHeader::create());
return $config;
}
@ -397,7 +397,7 @@ class MyAdmin extends ModelAdmin
// modify the list view.
if ($this->modelClass === Product::class) {
$config->addComponent(new GridFieldFilterHeader());
$config->addComponent(GridFieldFilterHeader::create());
}
return $config;
@ -425,7 +425,7 @@ class ModelAdminExtension extends Extension
{
public function updateGridFieldConfig(GridFieldConfig &$config)
{
$config->addComponent(new GridFieldFilterHeader());
$config->addComponent(GridFieldFilterHeader::create());
}
}
```
@ -470,7 +470,7 @@ class MyAdmin extends ModelAdmin
$gridField = $form->Fields()->fieldByName($gridFieldName);
// modify the list view.
$gridField->getConfig()->addComponent(new GridFieldFilterHeader());
$gridField->getConfig()->addComponent(GridFieldFilterHeader::create());
return $form;
}

View File

@ -142,7 +142,7 @@ SilverStripe\Forms\GridField\GridFieldDetailForm_ItemRequest:
You can also override this for a specific `GridField` instance when using the `GridFieldConfig_RecordEditor` constructor:
```php
$grid = new GridField(
$grid = GridField::create(
"pages",
"All Pages",
SiteTree::get(),

View File

@ -0,0 +1,10 @@
<?php
namespace SilverStripe\Forms\GridField;
use SilverStripe\Core\Injector\Injectable;
abstract class AbstractGridFieldComponent implements GridFieldComponent
{
use Injectable;
}

View File

@ -259,7 +259,7 @@ class GridField extends FormField
// If the edit button has been removed, replace it with a view button
if ($hadEditButton && !$copyConfig->getComponentByType(GridFieldViewButton::class)) {
$copyConfig->addComponent(new GridFieldViewButton);
$copyConfig->addComponent(GridFieldViewButton::create());
}
return $copy;
@ -295,7 +295,7 @@ class GridField extends FormField
$this->config = $config;
if (!$this->config->getComponentByType(GridState_Component::class)) {
$this->config->addComponent(new GridState_Component());
$this->config->addComponent(GridState_Component::create());
}
return $this;

View File

@ -33,7 +33,7 @@ use SilverStripe\ORM\Filters\SearchFilter;
* For easier setup, have a look at a sample configuration in
* {@link GridFieldConfig_RelationEditor}.
*/
class GridFieldAddExistingAutocompleter implements GridField_HTMLProvider, GridField_ActionProvider, GridField_DataManipulator, GridField_URLHandler
class GridFieldAddExistingAutocompleter extends AbstractGridFieldComponent implements GridField_HTMLProvider, GridField_ActionProvider, GridField_DataManipulator, GridField_URLHandler
{
/**

View File

@ -15,7 +15,7 @@ use SilverStripe\View\SSViewer;
* Only returns a button if {@link DataObject->canCreate()} for this record
* returns true.
*/
class GridFieldAddNewButton implements GridField_HTMLProvider
class GridFieldAddNewButton extends AbstractGridFieldComponent implements GridField_HTMLProvider
{
protected $targetFragment;

View File

@ -14,7 +14,7 @@ use SilverStripe\View\SSViewer;
* This row provides two new HTML fragment spaces: 'toolbar-header-left' and
* 'toolbar-header-right'.
*/
class GridFieldButtonRow implements GridField_HTMLProvider
class GridFieldButtonRow extends AbstractGridFieldComponent implements GridField_HTMLProvider
{
protected $targetFragment;

View File

@ -15,13 +15,13 @@ class GridFieldConfig_Base extends GridFieldConfig
public function __construct($itemsPerPage = null)
{
parent::__construct();
$this->addComponent(new GridFieldToolbarHeader());
$this->addComponent(new GridFieldButtonRow('before'));
$this->addComponent($sort = new GridFieldSortableHeader());
$this->addComponent($filter = new GridFieldFilterHeader());
$this->addComponent(new GridFieldDataColumns());
$this->addComponent(new GridFieldPageCount('toolbar-header-right'));
$this->addComponent($pagination = new GridFieldPaginator($itemsPerPage));
$this->addComponent(GridFieldToolbarHeader::create());
$this->addComponent(GridFieldButtonRow::create('before'));
$this->addComponent($sort = GridFieldSortableHeader::create());
$this->addComponent($filter = GridFieldFilterHeader::create());
$this->addComponent(GridFieldDataColumns::create());
$this->addComponent(GridFieldPageCount::create('toolbar-header-right'));
$this->addComponent($pagination = GridFieldPaginator::create($itemsPerPage));
$sort->setThrowExceptionOnBadDataType(false);
$filter->setThrowExceptionOnBadDataType(false);

View File

@ -17,18 +17,18 @@ class GridFieldConfig_RecordEditor extends GridFieldConfig
{
parent::__construct();
$this->addComponent(new GridFieldButtonRow('before'));
$this->addComponent(new GridFieldAddNewButton('buttons-before-left'));
$this->addComponent(new GridFieldToolbarHeader());
$this->addComponent($sort = new GridFieldSortableHeader());
$this->addComponent($filter = new GridFieldFilterHeader());
$this->addComponent(new GridFieldDataColumns());
$this->addComponent(new GridFieldEditButton());
$this->addComponent(new GridFieldDeleteAction());
$this->addComponent(new GridField_ActionMenu());
$this->addComponent(new GridFieldPageCount('toolbar-header-right'));
$this->addComponent($pagination = new GridFieldPaginator($itemsPerPage));
$this->addComponent(new GridFieldDetailForm(null, $showPagination, $showAdd));
$this->addComponent(GridFieldButtonRow::create('before'));
$this->addComponent(GridFieldAddNewButton::create('buttons-before-left'));
$this->addComponent(GridFieldToolbarHeader::create());
$this->addComponent($sort = GridFieldSortableHeader::create());
$this->addComponent($filter = GridFieldFilterHeader::create());
$this->addComponent(GridFieldDataColumns::create());
$this->addComponent(GridFieldEditButton::create());
$this->addComponent(GridFieldDeleteAction::create());
$this->addComponent(GridField_ActionMenu::create());
$this->addComponent(GridFieldPageCount::create('toolbar-header-right'));
$this->addComponent($pagination = GridFieldPaginator::create($itemsPerPage));
$this->addComponent(GridFieldDetailForm::create(null, $showPagination, $showAdd));
$sort->setThrowExceptionOnBadDataType(false);
$filter->setThrowExceptionOnBadDataType(false);

View File

@ -12,8 +12,8 @@ class GridFieldConfig_RecordViewer extends GridFieldConfig_Base
{
parent::__construct($itemsPerPage);
$this->addComponent(new GridFieldViewButton());
$this->addComponent(new GridFieldDetailForm());
$this->addComponent(GridFieldViewButton::create());
$this->addComponent(GridFieldDetailForm::create());
$this->removeComponentsByType(GridFieldFilterHeader::class);
$this->extend('updateConfig');

View File

@ -29,19 +29,19 @@ class GridFieldConfig_RelationEditor extends GridFieldConfig
{
parent::__construct();
$this->addComponent(new GridFieldButtonRow('before'));
$this->addComponent(new GridFieldAddNewButton('buttons-before-left'));
$this->addComponent(new GridFieldAddExistingAutocompleter('buttons-before-right'));
$this->addComponent(new GridFieldToolbarHeader());
$this->addComponent($sort = new GridFieldSortableHeader());
$this->addComponent($filter = new GridFieldFilterHeader());
$this->addComponent(new GridFieldDataColumns());
$this->addComponent(new GridFieldEditButton());
$this->addComponent(new GridFieldDeleteAction(true));
$this->addComponent(new GridField_ActionMenu());
$this->addComponent(new GridFieldPageCount('toolbar-header-right'));
$this->addComponent($pagination = new GridFieldPaginator($itemsPerPage));
$this->addComponent(new GridFieldDetailForm());
$this->addComponent(GridFieldButtonRow::create('before'));
$this->addComponent(GridFieldAddNewButton::create('buttons-before-left'));
$this->addComponent(GridFieldAddExistingAutocompleter::create('buttons-before-right'));
$this->addComponent(GridFieldToolbarHeader::create());
$this->addComponent($sort = GridFieldSortableHeader::create());
$this->addComponent($filter = GridFieldFilterHeader::create());
$this->addComponent(GridFieldDataColumns::create());
$this->addComponent(GridFieldEditButton::create());
$this->addComponent(GridFieldDeleteAction::create(true));
$this->addComponent(GridField_ActionMenu::create());
$this->addComponent(GridFieldPageCount::create('toolbar-header-right'));
$this->addComponent($pagination = GridFieldPaginator::create($itemsPerPage));
$this->addComponent(GridFieldDetailForm::create());
$sort->setThrowExceptionOnBadDataType(false);
$filter->setThrowExceptionOnBadDataType(false);

View File

@ -9,7 +9,7 @@ use SilverStripe\ORM\DataObject;
/**
* @see GridField
*/
class GridFieldDataColumns implements GridField_ColumnProvider
class GridFieldDataColumns extends AbstractGridFieldComponent implements GridField_ColumnProvider
{
/**

View File

@ -16,13 +16,13 @@ use SilverStripe\ORM\ValidationException;
* Use the {@link $removeRelation} property set in the constructor.
*
* <code>
* $action = new GridFieldDeleteAction(); // delete objects permanently
* $action = GridFieldDeleteAction::create(); // delete objects permanently
*
* // removes the relation to object instead of deleting
* $action = new GridFieldDeleteAction(true);
* $action = GridFieldDeleteAction::create(true);
* </code>
*/
class GridFieldDeleteAction implements GridField_ColumnProvider, GridField_ActionProvider, GridField_ActionMenuItem
class GridFieldDeleteAction extends AbstractGridFieldComponent implements GridField_ColumnProvider, GridField_ActionProvider, GridField_ActionMenuItem
{
/**

View File

@ -11,7 +11,6 @@ use SilverStripe\Control\HTTPStreamResponse;
use SilverStripe\Control\RequestHandler;
use SilverStripe\Core\ClassInfo;
use SilverStripe\Core\Extensible;
use SilverStripe\Core\Injector\Injectable;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\Validator;
@ -32,10 +31,10 @@ use SilverStripe\ORM\Filterable;
* - <FormURL>/field/<GridFieldName>/item/<RecordID>
* - <FormURL>/field/<GridFieldName>/item/<RecordID>/edit
*/
class GridFieldDetailForm implements GridField_URLHandler
class GridFieldDetailForm extends AbstractGridFieldComponent implements GridField_URLHandler
{
use Extensible, Injectable, GridFieldStateAware;
use Extensible, GridFieldStateAware;
/**
* @var string

View File

@ -3,7 +3,6 @@
namespace SilverStripe\Forms\GridField;
use SilverStripe\Control\Controller;
use SilverStripe\Core\Injector\Injectable;
use SilverStripe\ORM\DataObject;
use SilverStripe\View\ArrayData;
use SilverStripe\View\SSViewer;
@ -18,9 +17,9 @@ use SilverStripe\View\SSViewer;
* The default routing applies to the {@link GridFieldDetailForm} component,
* which has to be added separately to the {@link GridField} configuration.
*/
class GridFieldEditButton implements GridField_ColumnProvider, GridField_ActionProvider, GridField_ActionMenuLink
class GridFieldEditButton extends AbstractGridFieldComponent implements GridField_ColumnProvider, GridField_ActionProvider, GridField_ActionMenuLink
{
use Injectable, GridFieldStateAware;
use GridFieldStateAware;
/**
* HTML classes to be added to GridField edit buttons

View File

@ -12,7 +12,7 @@ use SilverStripe\ORM\DataObject;
/**
* Adds an "Export list" button to the bottom of a {@link GridField}.
*/
class GridFieldExportButton implements GridField_HTMLProvider, GridField_ActionProvider, GridField_URLHandler
class GridFieldExportButton extends AbstractGridFieldComponent implements GridField_HTMLProvider, GridField_ActionProvider, GridField_URLHandler
{
/**
* @var array Map of a property name on the exported objects, with values being the column title in the CSV file.

View File

@ -26,7 +26,7 @@ use SilverStripe\View\SSViewer;
*
* @see GridField
*/
class GridFieldFilterHeader implements GridField_URLHandler, GridField_HTMLProvider, GridField_DataManipulator, GridField_ActionProvider, GridField_StateProvider
class GridFieldFilterHeader extends AbstractGridFieldComponent implements GridField_URLHandler, GridField_HTMLProvider, GridField_DataManipulator, GridField_ActionProvider, GridField_StateProvider
{
/**
* See {@link setThrowExceptionOnBadDataType()}

View File

@ -18,7 +18,7 @@ use SilverStripe\View\SSViewer;
* The purpose of this class is to have a footer that can round off
* {@link GridField} without having to use pagination.
*/
class GridFieldFooter implements GridField_HTMLProvider
class GridFieldFooter extends AbstractGridFieldComponent implements GridField_HTMLProvider
{
/**

View File

@ -2,15 +2,12 @@
namespace SilverStripe\Forms\GridField;
use SilverStripe\Core\Injector\Injectable;
use SilverStripe\Forms\Form;
use SilverStripe\View\ArrayData;
use SilverStripe\View\SSViewer;
class GridFieldImportButton implements GridField_HTMLProvider
class GridFieldImportButton extends AbstractGridFieldComponent implements GridField_HTMLProvider
{
use Injectable;
/**
* Fragment to write the button to
*/

View File

@ -14,7 +14,7 @@ use SilverStripe\ORM\SS_List;
*
* @see GridField
*/
class GridFieldLazyLoader implements GridField_DataManipulator, GridField_HTMLProvider
class GridFieldLazyLoader extends AbstractGridFieldComponent implements GridField_DataManipulator, GridField_HTMLProvider
{
/**

View File

@ -2,7 +2,6 @@
namespace SilverStripe\Forms\GridField;
use SilverStripe\Core\Injector\Injectable;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\FieldType\DBField;
use SilverStripe\ORM\Hierarchy\Hierarchy;
@ -15,10 +14,8 @@ use SilverStripe\View\SSViewer;
* hierarchical data. Requires the managed record to have a "getParent()"
* method or has_one relationship called "Parent".
*/
class GridFieldLevelup implements GridField_HTMLProvider
class GridFieldLevelup extends AbstractGridFieldComponent implements GridField_HTMLProvider
{
use Injectable;
/**
* @var integer - the record id of the level up to
*/

View File

@ -12,7 +12,7 @@ use LogicException;
*
* Depends on {@link GridFieldPaginator} being added to the {@link GridField}.
*/
class GridFieldPageCount implements GridField_HTMLProvider
class GridFieldPageCount extends AbstractGridFieldComponent implements GridField_HTMLProvider
{
use Configurable;

View File

@ -14,7 +14,7 @@ use LogicException;
* GridFieldPaginator paginates the {@link GridField} list and adds controls
* to the bottom of the {@link GridField}.
*/
class GridFieldPaginator implements GridField_HTMLProvider, GridField_DataManipulator, GridField_ActionProvider, GridField_StateProvider
class GridFieldPaginator extends AbstractGridFieldComponent implements GridField_HTMLProvider, GridField_DataManipulator, GridField_ActionProvider, GridField_StateProvider
{
use Configurable;

View File

@ -16,7 +16,7 @@ use SilverStripe\View\Requirements;
/**
* Adds an "Print" button to the bottom or top of a GridField.
*/
class GridFieldPrintButton implements GridField_HTMLProvider, GridField_ActionProvider, GridField_URLHandler
class GridFieldPrintButton extends AbstractGridFieldComponent implements GridField_HTMLProvider, GridField_ActionProvider, GridField_URLHandler
{
use Extensible;

View File

@ -18,7 +18,7 @@ use LogicException;
*
* @see GridField
*/
class GridFieldSortableHeader implements GridField_HTMLProvider, GridField_DataManipulator, GridField_ActionProvider, GridField_StateProvider
class GridFieldSortableHeader extends AbstractGridFieldComponent implements GridField_HTMLProvider, GridField_DataManipulator, GridField_ActionProvider, GridField_StateProvider
{
/**

View File

@ -10,7 +10,7 @@ use SilverStripe\View\SSViewer;
*
* The header serves to display the name of the data the GridField is showing.
*/
class GridFieldToolbarHeader implements GridField_HTMLProvider
class GridFieldToolbarHeader extends AbstractGridFieldComponent implements GridField_HTMLProvider
{
/**

View File

@ -11,7 +11,7 @@ use SilverStripe\View\SSViewer;
* disabled by default and intended for use in readonly {@link GridField}
* instances.
*/
class GridFieldViewButton implements GridField_ColumnProvider, GridField_ActionMenuLink
class GridFieldViewButton extends AbstractGridFieldComponent implements GridField_ColumnProvider, GridField_ActionMenuLink
{
/**
* @inheritdoc

View File

@ -8,7 +8,7 @@ use SilverStripe\View\SSViewer;
/**
* Groups exiting actions in the Actions column in to a menu
*/
class GridField_ActionMenu implements GridField_ColumnProvider, GridField_ActionProvider
class GridField_ActionMenu extends AbstractGridFieldComponent implements GridField_ColumnProvider, GridField_ActionProvider
{
public function augmentColumns($gridField, &$columns)
{

View File

@ -5,7 +5,7 @@ namespace SilverStripe\Forms\GridField;
/**
* @see GridState
*/
class GridState_Component implements GridField_HTMLProvider
class GridState_Component extends AbstractGridFieldComponent implements GridField_HTMLProvider
{
public function getHTMLFragments($gridField)

View File

@ -159,11 +159,11 @@ class Group extends DataObject
if ($this->ID) {
$group = $this;
$config = GridFieldConfig_RelationEditor::create();
$config->addComponent(new GridFieldButtonRow('after'));
$config->addComponents(new GridFieldExportButton('buttons-after-left'));
$config->addComponents(new GridFieldPrintButton('buttons-after-left'));
$config->addComponent(GridFieldButtonRow::create('after'));
$config->addComponents(GridFieldExportButton::create('buttons-after-left'));
$config->addComponents(GridFieldPrintButton::create('buttons-after-left'));
$config->removeComponentsByType(GridFieldDeleteAction::class);
$config->addComponent(new GridFieldGroupDeleteAction($this->ID), GridFieldPageCount::class);
$config->addComponent(GridFieldGroupDeleteAction::create($this->ID), GridFieldPageCount::class);
/** @var GridFieldAddExistingAutocompleter $autocompleter */
$autocompleter = $config->getComponentByType(GridFieldAddExistingAutocompleter::class);