Merge pull request #338 from creative-commoners/pulls/3/php81

emteknetnz · web-flow · commit 71d60b0734b6 · 2022-04-22T16:48:56.000+12:00
ENH PHP 8.1 compatibility
diff --git a/src/Extensions/GridFieldDetailFormItemRequestExtension.php b/src/Extensions/GridFieldDetailFormItemRequestExtension.php
@@ -47,7 +47,7 @@ private function getHTMLFragment(GridFieldAddNewMultiClass $component)
 
         $classes = $component->getClasses($grid);
 
-        if (!count($classes)) {
+        if (!count($classes ?? [])) {
             return false;
         }
 
diff --git a/src/GridFieldAddNewInlineButton.php b/src/GridFieldAddNewInlineButton.php
@@ -118,7 +118,7 @@ public function getHTMLFragments($grid)
     private function getRowTemplate(GridField $grid, GridFieldEditableColumns $editable)
     {
         $columns = ArrayList::create();
-        $handled = array_keys($editable->getDisplayFields($grid));
+        $handled = array_keys($editable->getDisplayFields($grid) ?? []);
 
         if ($grid->getList()) {
             $record = Injector::inst()->create($grid->getModelClass());
@@ -129,7 +129,7 @@ private function getRowTemplate(GridField $grid, GridFieldEditableColumns $edita
         $fields = $editable->getFields($grid, $record);
 
         foreach ($grid->getColumns() as $column) {
-            if (in_array($column, $handled)) {
+            if (in_array($column, $handled ?? [])) {
                 $field = $fields->dataFieldByName($column);
                 $field->setName(sprintf(
                     '%s[%s][{%%=o.num%%}][%s]',
@@ -149,7 +149,7 @@ private function getRowTemplate(GridField $grid, GridFieldEditableColumns $edita
                 $content = str_replace(
                     sprintf('[%s][0]', GridFieldEditableColumns::POST_KEY),
                     sprintf('[%s][{%%=o.num%%}]', self::POST_KEY),
-                    $content
+                    $content ?? ''
                 );
             }
 
@@ -215,7 +215,7 @@ public function handleSave(GridField $grid, DataObjectInterface $record)
             }
 
             if ($list instanceof ManyManyList) {
-                $extra = array_intersect_key($form->getData(), (array) $list->getExtraFields());
+                $extra = array_intersect_key($form->getData() ?? [], (array) $list->getExtraFields());
             }
 
             $item->write(false, false, false, true);
diff --git a/src/GridFieldAddNewMultiClass.php b/src/GridFieldAddNewMultiClass.php
@@ -124,7 +124,7 @@ public function getClasses(GridField $grid)
         $result = array();
 
         if (is_null($this->classes)) {
-            $classes = array_values(ClassInfo::subclassesFor($grid->getModelClass()));
+            $classes = array_values(ClassInfo::subclassesFor($grid->getModelClass()) ?? []);
             sort($classes);
         } else {
             $classes = $this->classes;
@@ -135,7 +135,7 @@ public function getClasses(GridField $grid)
             if (!is_string($class)) {
                 $class = $title;
             }
-            if (!class_exists($class)) {
+            if (!class_exists($class ?? '')) {
                 continue;
             }
             $is_abstract = (($reflection = new ReflectionClass($class)) && $reflection->isAbstract());
@@ -216,7 +216,7 @@ public function handleAdd($grid, $request)
             throw new Exception('The add new multi class component requires the detail form component.');
         }
 
-        if (!$class || !array_key_exists($class, $classes)) {
+        if (!$class || !array_key_exists($class, $classes ?? [])) {
             throw new HTTPResponse_Exception(400);
         }
 
@@ -241,7 +241,7 @@ public function getHTMLFragments($grid)
     {
         $classes = $this->getClasses($grid);
 
-        if (!count($classes)) {
+        if (!count($classes ?? [])) {
             return array();
         }
 
@@ -293,7 +293,7 @@ public function setItemRequestClass($class)
      */
     protected function sanitiseClassName($class)
     {
-        return str_replace('\\', '-', $class);
+        return str_replace('\\', '-', $class ?? '');
     }
 
     /**
@@ -304,6 +304,6 @@ protected function sanitiseClassName($class)
      */
     protected function unsanitiseClassName($class)
     {
-        return str_replace('-', '\\', $class);
+        return str_replace('-', '\\', $class ?? '');
     }
 }
diff --git a/src/GridFieldAddNewMultiClassHandler.php b/src/GridFieldAddNewMultiClassHandler.php
@@ -31,6 +31,6 @@ public function Link($action = null)
      */
     protected function sanitiseClassName($class)
     {
-        return str_replace('\\', '-', $class);
+        return str_replace('\\', '-', $class ?? '');
     }
 }
diff --git a/src/GridFieldConfigurablePaginator.php b/src/GridFieldConfigurablePaginator.php
@@ -171,7 +171,7 @@ public function setPageSizes(array $pageSizes)
         $this->pageSizes = $pageSizes;
 
         // Reset items per page
-        $this->setItemsPerPage(current($pageSizes));
+        $this->setItemsPerPage(current($pageSizes ?? []));
 
         return $this;
     }
@@ -356,7 +356,7 @@ public function getHTMLFragments($gridField)
             return array(
                 'footer' => $forTemplate->renderWith(
                     __CLASS__,
-                    array('Colspan' => count($gridField->getColumns()))
+                    array('Colspan' => count($gridField->getColumns() ?? []))
                 )
             );
         }
diff --git a/src/GridFieldEditableColumns.php b/src/GridFieldEditableColumns.php
@@ -61,7 +61,7 @@ public function getColumnContent($grid, $record, $col)
         if (!$this->displayFields) {
             // If setDisplayFields() not used, utilize $summary_fields
             // in a way similar to base class
-            $colRelation = explode('.', $col);
+            $colRelation = explode('.', $col ?? '');
             $value = $grid->getDataFieldValue($record, $colRelation[0]);
             $field = $fields->fieldByName($colRelation[0]);
             if (!$field || $field->isReadonly() || $field->isDisabled()) {
@@ -82,7 +82,7 @@ public function getColumnContent($grid, $record, $col)
 
             // Fall back to previous logic
             if (!$field) {
-                $rel = (strpos($col, '.') === false); // field references a relation value
+                $rel = (strpos($col ?? '', '.') === false); // field references a relation value
                 $field = ($rel) ? clone $fields->fieldByName($col) : ReadonlyField::create($col);
             }
 
@@ -91,7 +91,7 @@ public function getColumnContent($grid, $record, $col)
             }
         }
 
-        if (array_key_exists($col, $this->fieldCasting)) {
+        if (array_key_exists($col, $this->fieldCasting ?? [])) {
             $value = $grid->getCastedValue($value, $this->fieldCasting[$col]);
         }
 
@@ -157,7 +157,7 @@ public function handleSave(GridField $grid, DataObjectInterface $record)
             }
 
             if ($list instanceof ManyManyList) {
-                $extra = array_intersect_key($form->getData(), (array) $list->getExtraFields());
+                $extra = array_intersect_key($form->getData() ?? [], (array) $list->getExtraFields());
             }
 
             $item->write(false, false, false, true);
@@ -244,7 +244,7 @@ public function getFields(GridField $grid, DataObjectInterface $record)
             if (!$field && $list instanceof ManyManyList) {
                 $extra = $list->getExtraFields();
 
-                if ($extra && array_key_exists($col, $extra)) {
+                if ($extra && array_key_exists($col, $extra ?? [])) {
                     $field = Injector::inst()->create($extra[$col], $col)->scaffoldFormField();
                 }
             }
@@ -259,7 +259,7 @@ public function getFields(GridField $grid, DataObjectInterface $record)
                     // revert to looking good in cases where the field isn't
                     // available or is readonly
                     //
-                    $colRelation = explode('.', $col);
+                    $colRelation = explode('.', $col ?? '');
                     if ($class && $obj = DataObject::singleton($class)->dbObject($colRelation[0])) {
                         $field = $obj->scaffoldFormField();
                     } else {
diff --git a/src/GridFieldExternalLink.php b/src/GridFieldExternalLink.php
@@ -19,7 +19,7 @@ class GridFieldExternalLink extends GridFieldDataColumns
      */
     public function augmentColumns($gridField, &$columns)
     {
-        if (!in_array('Actions', $columns)) {
+        if (!in_array('Actions', $columns ?? [])) {
             $columns[] = 'Actions';
         }
     }
diff --git a/src/GridFieldOrderableRows.php b/src/GridFieldOrderableRows.php
@@ -205,7 +205,7 @@ public function validateSortField(SS_List $list)
         if ($list instanceof ManyManyList) {
             $extra = $list->getExtraFields();
 
-            if ($extra && array_key_exists($field, $extra)) {
+            if ($extra && array_key_exists($field, $extra ?? [])) {
                 return;
             }
         } elseif ($list instanceof ManyManyThroughList) {
@@ -239,7 +239,7 @@ public function getSortTable(SS_List $list)
         if ($list instanceof ManyManyList) {
             $extra = $list->getExtraFields();
             $table = $list->getJoinTable();
-            if ($extra && array_key_exists($field, $extra)) {
+            if ($extra && array_key_exists($field, $extra ?? [])) {
                 return $table;
             }
         } elseif ($list instanceof ManyManyThroughList) {
@@ -277,8 +277,8 @@ public function getHTMLFragments($field)
 
     public function augmentColumns($grid, &$cols)
     {
-        if (!in_array('Reorder', $cols) && $grid->getState()->GridFieldOrderableRows->enabled) {
-            array_splice($cols, $this->reorderColumnNumber, 0, 'Reorder');
+        if (!in_array('Reorder', $cols ?? []) && $grid->getState()->GridFieldOrderableRows->enabled) {
+            array_splice($cols, $this->reorderColumnNumber ?? 0, 0, 'Reorder');
         }
     }
 
@@ -308,7 +308,7 @@ public function getColumnContent($grid, $record, $col)
             // if it exists, not directly from the record
             $throughListSorts = $this->getSortValuesFromManyManyThroughList($list, $this->getSortField());
 
-            if (array_key_exists($record->ID, $throughListSorts)) {
+            if (array_key_exists($record->ID, $throughListSorts ?? [])) {
                 $currentSortValue = $throughListSorts[$record->ID];
             }
         }
@@ -408,8 +408,8 @@ public function handleReorder($grid, $request)
 
         // Get records from the `GridFieldEditableColumns` column
         $gridFieldName = $grid->getName();
-        if (strpos($gridFieldName, '.') !== false) {
-            $gridFieldName = str_replace('.', '_', $gridFieldName);
+        if (strpos($gridFieldName ?? '', '.') !== false) {
+            $gridFieldName = str_replace('.', '_', $gridFieldName ?? '');
         }
 
         $data = $request->postVar($gridFieldName);
@@ -549,7 +549,7 @@ protected function executeReorder(GridField $grid, $sortedIDs)
         $items = $list->filter('ID', $sortedIDs)->sort($sortterm);
 
         // Ensure that each provided ID corresponded to an actual object.
-        if (count($items) != count($sortedIDs)) {
+        if (count($items ?? []) != count($sortedIDs ?? [])) {
             return false;
         }
 
@@ -720,7 +720,7 @@ protected function populateSortValues(DataList $list)
     protected function getSortTableClauseForIds(DataList $list, $ids)
     {
         if (is_array($ids)) {
-            $value = 'IN (' . implode(', ', array_map('intval', $ids)) . ')';
+            $value = 'IN (' . implode(', ', array_map('intval', $ids ?? [])) . ')';
         } else {
             $value = '= ' . (int) $ids;
         }
@@ -734,7 +734,7 @@ protected function getSortTableClauseForIds(DataList $list, $ids)
             $foreignKey = $this->getManyManyInspectorForeignKey($introspector);
             $foreignID  = (int) $list->getForeignID();
 
-            if ($extra && array_key_exists($this->getSortField(), $extra)) {
+            if ($extra && array_key_exists($this->getSortField(), $extra ?? [])) {
                 return sprintf(
                     '"%s" %s AND "%s" = %d',
                     $key,
diff --git a/tests/GridFieldOrderableRowsTest.php b/tests/GridFieldOrderableRowsTest.php
@@ -69,7 +69,7 @@ public function testReorderItems($fixtureID, $relationName, $sortName)
         $config = new GridFieldConfig_RelationEditor();
         $config->addComponent($orderable);
 
-        list($parentClass, $parentInstanceID) = explode('.', $fixtureID);
+        list($parentClass, $parentInstanceID) = explode('.', $fixtureID ?? '');
         $parent = $this->objFromFixture($parentClass, $parentInstanceID);
 
         $grid = new GridField(
@@ -83,7 +83,7 @@ public function testReorderItems($fixtureID, $relationName, $sortName)
         $desiredOrder = [];
 
         // Make order non-contiguous, and 1-based
-        foreach (array_reverse($originalOrder) as $index => $id) {
+        foreach (array_reverse($originalOrder ?? []) as $index => $id) {
             $desiredOrder[$index * 2 + 1] = $id;
         }
 
@@ -183,7 +183,7 @@ public function testSortableChildClass()
         );
 
         $originalOrder = $parent->Children()->column('ID');
-        $desiredOrder = array_reverse($originalOrder);
+        $desiredOrder = array_reverse($originalOrder ?? []);
 
         $this->assertNotEquals($originalOrder, $desiredOrder);
 
@@ -270,7 +270,7 @@ public function testReorderItemsSubclassVersioned()
         $desiredOrder = [];
 
         // Make order non-contiguous, and 1-based
-        foreach (array_reverse($originalOrder) as $index => $id) {
+        foreach (array_reverse($originalOrder ?? []) as $index => $id) {
             $desiredOrder[$index * 2 + 1] = $id;
         }
 
diff --git a/tests/OrderableRowsThroughVersionedTest.php b/tests/OrderableRowsThroughVersionedTest.php
@@ -80,11 +80,11 @@ public function testReorderingSavesAndPublishes()
         $originalOrder = $parent->$relationName()->sort($sortName)->column('ID');
         // Ring (un)shift by one, e.g. 3,2,1 becomes 1,3,2.
         // then string key our new order starting at 1
-        $desiredOrder = array_values($originalOrder);
+        $desiredOrder = array_values($originalOrder ?? []);
         array_unshift($desiredOrder, array_pop($desiredOrder));
         $desiredOrder = array_combine(
-            range('1', count($desiredOrder)),
-            $desiredOrder
+            range('1', count($desiredOrder ?? [])),
+            $desiredOrder ?? []
         );
         $this->assertNotEquals($originalOrder, $desiredOrder);
 
diff --git a/tests/Stub/StubA.php b/tests/Stub/StubA.php
@@ -9,7 +9,7 @@ class StubA implements TestOnly
     public function i18n_singular_name()
     {
         $class = get_class($this);
-        return substr($class, -1);
+        return substr($class ?? '', -1);
     }
 
     public function canCreate()

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ private function getHTMLFragment(GridFieldAddNewMultiClass $component)`
`47`	`47`
`48`	`48`	`$classes = $component->getClasses($grid);`
`49`	`49`
`50`		`- if (!count($classes)) {`
	`50`	`+ if (!count($classes ?? [])) {`
`51`	`51`	`return false;`
`52`	`52`	`}`
`53`	`53`
Original file line number	Diff line number	Diff line change
`@@ -124,7 +124,7 @@ public function getClasses(GridField $grid)`
`124`	`124`	`$result = array();`
`125`	`125`
`126`	`126`	`if (is_null($this->classes)) {`
`127`		`- $classes = array_values(ClassInfo::subclassesFor($grid->getModelClass()));`
	`127`	`+ $classes = array_values(ClassInfo::subclassesFor($grid->getModelClass()) ?? []);`
`128`	`128`	`sort($classes);`
`129`	`129`	`} else {`
`130`	`130`	`$classes = $this->classes;`
`@@ -135,7 +135,7 @@ public function getClasses(GridField $grid)`
`135`	`135`	`if (!is_string($class)) {`
`136`	`136`	`$class = $title;`
`137`	`137`	`}`
`138`		`- if (!class_exists($class)) {`
	`138`	`+ if (!class_exists($class ?? '')) {`
`139`	`139`	`continue;`
`140`	`140`	`}`
`141`	`141`	`$is_abstract = (($reflection = new ReflectionClass($class)) && $reflection->isAbstract());`
`@@ -216,7 +216,7 @@ public function handleAdd($grid, $request)`
`216`	`216`	`throw new Exception('The add new multi class component requires the detail form component.');`
`217`	`217`	`}`
`218`	`218`
`219`		`- if (!$class \|\| !array_key_exists($class, $classes)) {`
	`219`	`+ if (!$class \|\| !array_key_exists($class, $classes ?? [])) {`
`220`	`220`	`throw new HTTPResponse_Exception(400);`
`221`	`221`	`}`
`222`	`222`
`@@ -241,7 +241,7 @@ public function getHTMLFragments($grid)`
`241`	`241`	`{`
`242`	`242`	`$classes = $this->getClasses($grid);`
`243`	`243`
`244`		`- if (!count($classes)) {`
	`244`	`+ if (!count($classes ?? [])) {`
`245`	`245`	`return array();`
`246`	`246`	`}`
`247`	`247`
`@@ -293,7 +293,7 @@ public function setItemRequestClass($class)`
`293`	`293`	`*/`
`294`	`294`	`protected function sanitiseClassName($class)`
`295`	`295`	`{`
`296`		`- return str_replace('\\', '-', $class);`
	`296`	`+ return str_replace('\\', '-', $class ?? '');`
`297`	`297`	`}`
`298`	`298`
`299`	`299`	`/**`
`@@ -304,6 +304,6 @@ protected function sanitiseClassName($class)`
`304`	`304`	`*/`
`305`	`305`	`protected function unsanitiseClassName($class)`
`306`	`306`	`{`
`307`		`- return str_replace('-', '\\', $class);`
	`307`	`+ return str_replace('-', '\\', $class ?? '');`
`308`	`308`	`}`
`309`	`309`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,6 @@ public function Link($action = null)`
`31`	`31`	`*/`
`32`	`32`	`protected function sanitiseClassName($class)`
`33`	`33`	`{`
`34`		`- return str_replace('\\', '-', $class);`
	`34`	`+ return str_replace('\\', '-', $class ?? '');`
`35`	`35`	`}`
`36`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -171,7 +171,7 @@ public function setPageSizes(array $pageSizes)`
`171`	`171`	`$this->pageSizes = $pageSizes;`
`172`	`172`
`173`	`173`	`// Reset items per page`
`174`		`- $this->setItemsPerPage(current($pageSizes));`
	`174`	`+ $this->setItemsPerPage(current($pageSizes ?? []));`
`175`	`175`
`176`	`176`	`return $this;`
`177`	`177`	`}`
`@@ -356,7 +356,7 @@ public function getHTMLFragments($gridField)`
`356`	`356`	`return array(`
`357`	`357`	`'footer' => $forTemplate->renderWith(`
`358`	`358`	`__CLASS__,`
`359`		`- array('Colspan' => count($gridField->getColumns()))`
	`359`	`+ array('Colspan' => count($gridField->getColumns() ?? []))`
`360`	`360`	`)`
`361`	`361`	`);`
`362`	`362`	`}`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ public function getColumnContent($grid, $record, $col)`
`61`	`61`	`if (!$this->displayFields) {`
`62`	`62`	`// If setDisplayFields() not used, utilize $summary_fields`
`63`	`63`	`// in a way similar to base class`
`64`		`- $colRelation = explode('.', $col);`
	`64`	`+ $colRelation = explode('.', $col ?? '');`
`65`	`65`	`$value = $grid->getDataFieldValue($record, $colRelation[0]);`
`66`	`66`	`$field = $fields->fieldByName($colRelation[0]);`
`67`	`67`	`if (!$field \|\| $field->isReadonly() \|\| $field->isDisabled()) {`
`@@ -82,7 +82,7 @@ public function getColumnContent($grid, $record, $col)`
`82`	`82`
`83`	`83`	`// Fall back to previous logic`
`84`	`84`	`if (!$field) {`
`85`		`- $rel = (strpos($col, '.') === false); // field references a relation value`
	`85`	`+ $rel = (strpos($col ?? '', '.') === false); // field references a relation value`
`86`	`86`	`$field = ($rel) ? clone $fields->fieldByName($col) : ReadonlyField::create($col);`
`87`	`87`	`}`
`88`	`88`
`@@ -91,7 +91,7 @@ public function getColumnContent($grid, $record, $col)`
`91`	`91`	`}`
`92`	`92`	`}`
`93`	`93`
`94`		`- if (array_key_exists($col, $this->fieldCasting)) {`
	`94`	`+ if (array_key_exists($col, $this->fieldCasting ?? [])) {`
`95`	`95`	`$value = $grid->getCastedValue($value, $this->fieldCasting[$col]);`
`96`	`96`	`}`
`97`	`97`
`@@ -157,7 +157,7 @@ public function handleSave(GridField $grid, DataObjectInterface $record)`
`157`	`157`	`}`
`158`	`158`
`159`	`159`	`if ($list instanceof ManyManyList) {`
`160`		`- $extra = array_intersect_key($form->getData(), (array) $list->getExtraFields());`
	`160`	`+ $extra = array_intersect_key($form->getData() ?? [], (array) $list->getExtraFields());`
`161`	`161`	`}`
`162`	`162`
`163`	`163`	`$item->write(false, false, false, true);`
`@@ -244,7 +244,7 @@ public function getFields(GridField $grid, DataObjectInterface $record)`
`244`	`244`	`if (!$field && $list instanceof ManyManyList) {`
`245`	`245`	`$extra = $list->getExtraFields();`
`246`	`246`
`247`		`- if ($extra && array_key_exists($col, $extra)) {`
	`247`	`+ if ($extra && array_key_exists($col, $extra ?? [])) {`
`248`	`248`	`$field = Injector::inst()->create($extra[$col], $col)->scaffoldFormField();`
`249`	`249`	`}`
`250`	`250`	`}`
`@@ -259,7 +259,7 @@ public function getFields(GridField $grid, DataObjectInterface $record)`
`259`	`259`	`// revert to looking good in cases where the field isn't`
`260`	`260`	`// available or is readonly`
`261`	`261`	`//`
`262`		`- $colRelation = explode('.', $col);`
	`262`	`+ $colRelation = explode('.', $col ?? '');`
`263`	`263`	`if ($class && $obj = DataObject::singleton($class)->dbObject($colRelation[0])) {`
`264`	`264`	`$field = $obj->scaffoldFormField();`
`265`	`265`	`} else {`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ class GridFieldExternalLink extends GridFieldDataColumns`
`19`	`19`	`*/`
`20`	`20`	`public function augmentColumns($gridField, &$columns)`
`21`	`21`	`{`
`22`		`- if (!in_array('Actions', $columns)) {`
	`22`	`+ if (!in_array('Actions', $columns ?? [])) {`
`23`	`23`	`$columns[] = 'Actions';`
`24`	`24`	`}`
`25`	`25`	`}`