WIP: improve column count default handling, allow owner class to set its own default

Author: JamesDPC

src/Extensions/ElementChildGridExtension.php

@@ -3,6 +3,7 @@
 namespace NSWDPC\GridHelper\Extensions;
 
 use NSWDPC\GridHelper\Models\Configuration;
+use SilverStripe\Core\Config\Config;
 use Silverstripe\Core\Injector\Injector;
 use Silverstripe\ORM\DataExtension;
 use Silverstripe\Forms\FieldList;
@@ -22,15 +23,7 @@ class ElementChildGridExtension extends DataExtension
      * @var array
      */
     private static $db = [
-        'CardColumns' => 'Int(4)' // grid columns at lg breakpoint
-    ];
-
-    /**
-     * Default values
-     * @var array
-     */
-    private static $defaults = [
-        'CardColumns' => 4 // at lg breakpoint
+        'CardColumns' => 'Int' // grid columns at lg breakpoint
     ];
 
     /**
@@ -66,6 +59,21 @@ public function updateCMSFields(FieldList $fields)
 
     }
 
+    /**
+     * Ensure default column count is written if not set
+     * Allow the owner class to set it's own default via configuration
+     */
+    public function onBeforeWrite() {
+        if(!$this->owner->CardColumns) {
+            $defaultLargeColumnCount = Configuration::config()->get('default_lg_column_count');
+            $ownerDefaultCount = Config::inst()->get( get_class($this->owner), 'grid_default_lg_column_count');
+            if($ownerDefaultCount) {
+                $defaultLargeColumnCount = $ownerDefaultCount;
+            }
+            $this->owner->CardColumns = $defaultLargeColumnCount;
+        }
+    }
+
     /**
      * This method is retained for BC
      */

src/Models/Configuration.php

@@ -49,6 +49,12 @@ class Configuration {
         '6' => '6'
     ];
 
+    /**
+     * Default "lg" viewport number of columns
+     * @var int
+     */
+    private static $default_lg_column_count = 4;
+
     /**
      * @var bool
      * When true, grid columns > than the supplied desktop columns value

tests/.gitkeep

@@ -0,0 +1,27 @@
+<?php
+
+namespace NSWDPC\GridHelper\Tests;
+
+use NSWDPC\GridHelper\Extensions\ElementChildGridExtension;
+use SilverStripe\Dev\TestOnly;
+use SilverStripe\ORM\DataObject;
+
+/**
+ * Model to test column count handling
+ * @author James
+ */
+class ColumnCountModel extends DataObject implements TestOnly {
+
+    /**
+     * @inheritdoc
+     */
+    private static $table_name = "ColumnCountModel";
+
+    /**
+     * @inheritdoc
+     */
+    private static $db = [
+        'Title' => 'Varchar(255)'
+    ];
+
+}

tests/ColumnCountModel.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace NSWDPC\GridHelper\Tests;
+
+use NSWDPC\GridHelper\Extensions\ElementChildGridExtension;
+use NSWDPC\GridHelper\Models\Configuration;
+use SilverStripe\Core\Config\Config;
+use SilverStripe\Dev\SapphireTest;
+
+/**
+ * Provide tests for a single gallery video
+ */
+class ColumnCountTest extends SapphireTest {
+
+    protected $usesDatabase =  true;
+
+    /**
+     * @inheritdoc
+     */
+    protected static $extra_dataobjects = [
+        ColumnCountModel::class
+    ];
+
+    /**
+     * @inheritdoc
+     */
+    protected static $required_extensions = [
+        ColumnCountModel::class => [
+            ElementChildGridExtension::class
+        ]
+    ];
+
+    public function testColumnCount() {
+        $defaultLargeColumnCount = Configuration::config()->get('default_lg_column_count');
+
+        $obj = ColumnCountModel::create([
+            'Title' => 'Test model'
+        ]);
+        $obj->write();
+
+        var_dump($obj->CardColumns);
+
+        $this->assertEquals($defaultLargeColumnCount, 4);
+    }
+
+}