Added field MultipleChoiceField

Author: srtab

src/Fields/ChoiceField.php

@@ -30,7 +30,7 @@ public function setChoices(array $choices)
         $this->widget->setChoices($choices);
     }
 
-    public function isEmpty($value)
+    protected function isEmpty($value)
     {
         return empty($value) && $value != "0";
     }
@@ -44,13 +44,24 @@ public function validate($value)
     {
         parent::validate($value);
 
-        if ($this->isEmpty($value) || !array_key_exists($value, $this->choices)) {
+        if ($this->isEmpty($value) || !$this->validValue($value)) {
             $error_message = PHPFormConfig::getIMessage("INVALID_CHOICE");
+
+            if (is_array($value)) {
+                $value_diff = array_diff($value, array_keys($this->choices));
+                $value = implode(', ', $value_diff);
+            }
+
             $message = Formatter::format($error_message, array(
-                'choice' => $value
+                'choice' => $value,
             ));
 
             throw new ValidationError($message, 'invalid');
         }
     }
+
+    protected function validValue($value)
+    {
+        return array_key_exists($value, $this->choices);
+    }
 }

src/Fields/Field.php

@@ -167,6 +167,16 @@ public function getHelpText()
         return $this->help_text;
     }
 
+    /**
+     * Check emptiness of $value
+     * @param  mixed   $value
+     * @return boolean
+     */
+    protected function isEmpty($value)
+    {
+        return empty($value);
+    }
+
     /**
     * Tranforms $value into a native php object type.
     *
@@ -188,7 +198,7 @@ public function toNative($value)
     */
     public function validate($value)
     {
-        if (empty($value) && $this->required) {
+        if ($this->isEmpty($value) && $this->required) {
             throw new ValidationError($this->error_messages['required'], 'required');
         }
     }
@@ -202,7 +212,7 @@ public function validate($value)
     */
     public function runValidators($value)
     {
-        if (empty($value)) {
+        if ($this->isEmpty($value)) {
             return;
         }
 

src/Fields/MultipleChoiceField.php

@@ -0,0 +1,42 @@
+<?php
+/**
+ * MultipleChoiceField Class
+ */
+namespace PHPForm\Fields;
+
+use Fleshgrinder\Core\Formatter;
+
+use PHPForm\Exceptions\ValidationError;
+use PHPForm\PHPFormConfig;
+use PHPForm\Widgets\SelectMultiple;
+
+class MultipleChoiceField extends ChoiceField
+{
+    protected $widget = SelectMultiple::class;
+
+    public function isEmpty($value)
+    {
+        return empty($value);
+    }
+
+    public function toNative($value)
+    {
+        if ($this->isEmpty($value)) {
+            return [];
+        }
+
+        if (!is_array($value)) {
+            $error_message = PHPFormConfig::getIMessage("INVALID_LIST");
+            throw new ValidationError($error_message, 'invalid_list');
+        }
+
+        return array_map('strval', $value);
+    }
+
+    protected function validValue($value)
+    {
+        $keys = array_keys($this->choices);
+
+        return count(array_intersect($value, $keys)) == count($value);
+    }
+}

src/messages.php

@@ -3,6 +3,7 @@
 return array(
     "REQUIRED" => 'This field is required.',
     "INVALID_CHOICE" => 'Select a valid choice. "{choice}" is not one of the available choices.',
+    "INVALID_LIST" => 'Enter a list of values.',
     "INVALID_DATE" => 'Enter a valid date.',
     "INVALID_DATETIME" => 'Enter a valid date/time.',
     "INVALID_NUMBER" => 'Enter a whole number.',

tests/unit/Fields/MultipleChoiceFieldTest.php

@@ -0,0 +1,65 @@
+<?php
+namespace PHPForm\Unit\Fields;
+
+use PHPUnit\Framework\TestCase;
+
+use PHPForm\Exceptions\ValidationError;
+use PHPForm\Fields\MultipleChoiceField;
+use PHPForm\Widgets\SelectMultiple;
+
+class MultipleChoiceFieldTest extends TestCase
+{
+    public function setUp()
+    {
+        $this->choices = array(
+            "option1" => "Option 1",
+            "option2" => "Option 2",
+            "option3" => "Option 3"
+        );
+
+        $this->field = new MultipleChoiceField(["choices" => $this->choices, "required" => true]);
+    }
+
+    public function testConstruct()
+    {
+        $this->assertInstanceOf(SelectMultiple::class, $this->field->getWidget());
+    }
+
+    public function testToNative()
+    {
+        $this->assertEquals([], $this->field->toNative(false));
+        $this->assertEquals(["1", "2", "3", "4"], $this->field->toNative([1, 2, 3, 4]));
+    }
+
+    /**
+     * @expectedException PHPForm\Exceptions\ValidationError
+     * @expectedExceptionMessage Enter a list of values.
+     */
+    public function testToNativeNonArray()
+    {
+        $this->field->toNative("invalid value");
+    }
+
+    public function testValidateChoiceExistent()
+    {
+        $this->assertNull($this->field->validate(["option1", "option2"]));
+    }
+
+    /**
+     * @expectedException PHPForm\Exceptions\ValidationError
+     * @expectedExceptionMessage This field is required.
+     */
+    public function testValidateEmptyArray()
+    {
+        $this->field->validate([]);
+    }
+
+    /**
+     * @expectedException PHPForm\Exceptions\ValidationError
+     * @expectedExceptionMessage Select a valid choice. "option5" is not one of the available choices.
+     */
+    public function testValidateChoiceUnexistent()
+    {
+        $this->field->validate(["option1", "option5"]);
+    }
+}