ENH Prefer dependency injection for GridFieldComponents.

GridFieldComponents packaged with silverstripe/framework are injectable as of 4.11.0 Explicitly invoking the injector here instead of using `create()` allows backwards compatability with framework < 4.11.0 while ensuring dependency injection is still used from 4.11.0 onwards.
silverstripe · Feb 12, 2022 · c85b99d · c85b99d
1 parent 375c319
commit c85b99d
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 10 deletions.
diff --git a/code/Report.php b/code/Report.php
@@ -389,12 +389,12 @@ public function getReportField()
         $items = $this->sourceRecords($params, null, null);
 
         $gridFieldConfig = GridFieldConfig::create()->addComponents(
-            new GridFieldButtonRow('before'),
-            new GridFieldPrintButton('buttons-before-left'),
-            new GridFieldExportButton('buttons-before-left'),
-            new GridFieldSortableHeader(),
-            new GridFieldDataColumns(),
-            new GridFieldPaginator()
+            Injector::inst()->createWithArgs(GridFieldButtonRow::class, ['before']),
+            Injector::inst()->createWithArgs(GridFieldPrintButton::class, ['buttons-before-left']),
+            Injector::inst()->createWithArgs(GridFieldExportButton::class, ['buttons-before-left']),
+            Injector::inst()->create(GridFieldSortableHeader::class),
+            Injector::inst()->create(GridFieldDataColumns::class),
+            Injector::inst()->create(GridFieldPaginator::class)
         );
         /** @var GridField $gridField */
         $gridField = GridField::create('Report', null, $items, $gridFieldConfig);

diff --git a/code/ReportAdmin.php b/code/ReportAdmin.php
@@ -4,6 +4,7 @@
 
 use SilverStripe\Admin\LeftAndMain;
 use SilverStripe\Control\Controller;
+use SilverStripe\Core\Injector\Injector;
 use SilverStripe\Forms\FieldList;
 use SilverStripe\Forms\Form;
 use SilverStripe\Forms\GridField\GridField;
@@ -230,11 +231,11 @@ public function getEditForm($id = null, $fields = null)
             // List all reports
             $fields = new FieldList();
             $gridFieldConfig = GridFieldConfig::create()->addComponents(
-                new GridFieldSortableHeader(),
-                new GridFieldDataColumns(),
-                new GridFieldFooter()
+                Injector::inst()->create(GridFieldSortableHeader::class),
+                Injector::inst()->create(GridFieldDataColumns::class),
+                Injector::inst()->create(GridFieldFooter::class)
             );
-            $gridField = new GridField('Reports', false, $this->Reports(), $gridFieldConfig);
+            $gridField = GridField::create('Reports', false, $this->Reports(), $gridFieldConfig);
             /** @var GridFieldDataColumns $columns */
             $columns = $gridField->getConfig()->getComponentByType('SilverStripe\\Forms\\GridField\\GridFieldDataColumns');
             $columns->setDisplayFields(array(