Refactor DropdownImageField for improved clarity

Author: wilr

src/DropdownImageField.php

@@ -3,128 +3,119 @@
 namespace FullscreenInteractive\DropdownImageField;
 
 use SilverStripe\Forms\DropdownField;
-use SilverStripe\ORM\SS_List;
-use SilverStripe\Forms\FormField;
 use SilverStripe\Model\ArrayData;
 use SilverStripe\Model\List\ArrayList;
 
 class DropdownImageField extends DropdownField
 {
+    protected string $keyField = 'ID';
 
-    protected $keyField = 'ID';
+    protected string $labelField = 'Title';
 
-    protected $labelField = 'Title';
+    protected string $imageField = 'Image';
 
-    protected $imageField = 'Image';
+    protected ArrayList $sourceList;
+
+    public function __construct($name, $title = null, $source = [], $value = null)
+    {
+        parent::__construct($name, $title, $source, $value);
+
+        $this->addExtraClass('dropdown');
+    }
 
-    protected $sourceObject;
 
-    public function __construct($name, $title, $sourceObject, $keyField = 'ID', $labelField = 'Title', $imageField = 'Image', $value = '', $form = null)
+    public function setSourceList(ArrayList $sourceList)
     {
+        $this->sourceList = $sourceList;
 
-        $this->keyField = $keyField;
-        $this->labelField = $labelField;
-        $this->imageField = $imageField;
+        return $this;
+    }
 
-        parent::__construct($name, ($title === null) ? $name : $title, $sourceObject, $value, $form);
 
-        $this->addExtraClass('dropdown');
-        $this->sourceObject = $sourceObject;
+    public function setKeyField(string $field)
+    {
+        $this->keyField = $field;
+
+        return $this;
     }
 
-    public function setSourceObject($source)
+    public function setLabelField(string $field)
     {
-        $this->sourceObject = $source;
+        $this->labelField = $field;
 
         return $this;
     }
 
+
     public function setImageField($field)
     {
         $this->imageField = $field;
 
         return $this;
     }
 
-    public function Field($properties = [])
+
+    public function getSourceList()
     {
-        $source = $this->sourceObject;
-        $options = array();
-
-        if ($source) {
-            if (is_object($source) && $this->hasEmptyDefault) {
-                $options[] = ArrayData::create([
-                    'Value' => '',
-                    'Title' => $this->emptyString,
-                    'Image' => ''
-                ]);
-            }
+        return $this->sourceList;
+    }
 
-            foreach ($source as $k => $item) {
-                if (is_object($item)) {
-                    $value = $item->{$this->keyField};
-                    if (empty($this->labelField)) {
-                        $title = '--nbsp';
-                    } else {
-                        $title = $item->{$this->labelField};
-                    }
 
-                    $image = $item->{$this->imageField}();
+    public function getSourceEmpty()
+    {
+        $source = [];
+
+        foreach ($this->getSourceList() as $k => $item) {
+            if ($item instanceof ArrayData) {
+                $value = $item->{$this->keyField};
+
+                if (empty($this->labelField)) {
+                    $title = '--nbsp';
                 } else {
-                    $value = $k;
-                    $image = null;
-                    $title = $item;
+                    $title = $item->{$this->labelField};
                 }
-
-                $selected = false;
-                if ($value === '' && ($this->value === '' || $this->value === null)) {
-                    $selected = true;
+                if (method_exists($item, $this->imageField)) {
+                    $image = $item->{$this->imageField}();
                 } else {
-                    // check against value, fallback to a type check comparison when !value
-                    if ($value) {
-                        $selected = ($value == $this->value);
-                    } else {
-                        $selected = ($value === $this->value) || (((string) $value) === ((string) $this->value));
-                    }
-
-                    $this->isSelected = $selected;
+                    $image = $item->{$this->imageField};
                 }
+            } else {
+                $value = $k;
+                $image = null;
+                $title = $item;
+            }
 
-                $disabled = false;
-                if (in_array($value, $this->disabledItems) && $title != $this->emptyString) {
-                    $disabled = 'disabled';
-                }
+            $source[$value] = $title . ' (image: ' . $image . ')';
+        }
 
-                $options[] = ArrayData::create([
-                    'Title' => $title,
-                    'Value' => $value,
-                    'Image' => $image,
-                    'Selected' => $selected,
-                    'Disabled' => $disabled,
-                ]);
-            }
+        return $source;
+    }
+
+
+
+    /**
+     * @param array $properties
+     * @return string
+     */
+    public function Field($properties = [])
+    {
+        $options = [];
+
+        // Add all options
+        foreach ($this->getSourceEmpty() as $value => $title) {
+            $options[] = $this->getFieldOption($value, $title);
         }
 
         $properties = array_merge($properties, [
             'Options' => ArrayList::create($options)
         ]);
 
-        return FormField::Field($properties);
+        return parent::Field($properties);
     }
 
-    /**
-     * Get the source of this field as an array
-     * Transform the source DataList to an key => value array
-     *
-     * @return array
-     */
-    public function getSourceAsArray()
-    {
-        $source = $this->getSource();
-        if (is_array($source)) {
-            return $source;
-        }
 
-        return $source->map($this->keyField, $this->labelField)->toArray();
+    public function getSourceValues()
+    {
+        return array_keys($this->getSourceEmpty());
     }
 }