Merge pull request #4223 from kinglozzer/pulls/3923-groupeddropdownfield-validation

Add validation for GroupedDropdownField, validate against disabled items (closes #3923)

forms/DropdownField.php

@@ -314,7 +314,9 @@ class DropdownField extends FormField {
 	 */
 	public function validate($validator) {
 		$source = $this->getSourceAsArray();
-		if (!array_key_exists($this->value, $source)) {
+		$disabled = $this->getDisabledItems();
+
+		if (!array_key_exists($this->value, $source) || in_array($this->value, $disabled)) {
 			if ($this->getHasEmptyDefault() && !$this->value) {
 				return true;
 			}

forms/GroupedDropdownField.php

@@ -89,11 +89,46 @@ class GroupedDropdownField extends DropdownField {
 	}
 
 	/**
-	 * @todo Implement DropdownField::validate() with group validation support
+	 * Validate this field
+	 *
+	 * @param Validator $validator
+	 * @return bool
 	 */
 	public function validate($validator) {
+		$valid = false;
+		$source = $this->getSourceAsArray();
+		$disabled = $this->getDisabledItems();
+
+		if ($this->value) {
+			foreach ($source as $value => $title) {
+				if (is_array($title) && array_key_exists($this->value, $title)) {
+					// Check that the set value is not in the list of disabled items
+					if (!isset($disabled[$value]) || !in_array($this->value, $disabled[$value])) {
+						$valid = true;
+					}
+				// Check that the value matches and is not disabled
+				} elseif($this->value == $value && !in_array($this->value, $disabled)) {
+					$valid = true;
+				}
+			}
+		} elseif ($this->getHasEmptyDefault()) {
+			$valid = true;
+		}
+
+		if (!$valid) {
+			$validator->validationError(
+				$this->name,
+				_t(
+					'DropdownField.SOURCE_VALIDATION',
+					"Please select a value within the list provided. {value} is not a valid option",
+					array('value' => $this->value)
+				),
+				"validation"
+			);
+			return false;
+		}
+
 		return true;
 	}
 
 }
-

tests/forms/DropdownFieldTest.php

@@ -313,7 +313,8 @@ class DropdownFieldTest extends SapphireTest {
 	public function testValidation() {
 		$field = DropdownField::create('Test', 'Testing', array(
 			"One" => "One",
-			"Two" => "Two"
+			"Two" => "Two",
+			"Five" => "Five"
 		));
 		$validator = new RequiredFields();
 		$form = new Form($this, 'Form', new FieldList($field), new FieldList(), $validator);
@@ -331,6 +332,10 @@ class DropdownFieldTest extends SapphireTest {
 		$field->setEmptyString('Empty String');
 		$field->setValue('');
 		$this->assertTrue($field->validate($validator));
+		//disabled items shouldn't validate
+		$field->setDisabledItems(array('Five'));
+		$field->setValue('Five');
+		$this->assertFalse($field->validate($validator));
 	}
 
 }

tests/forms/GroupedDropdownFieldTest.php

@@ -0,0 +1,54 @@
+<?php
+
+/**
+ * @package framework
+ * @subpackage tests
+ */
+class GroupedDropdownFieldTest extends SapphireTest {
+
+	public function testValidation() {
+		$field = GroupedDropdownField::create('Test', 'Testing', array(
+			"1" => "One",
+			"Group One" => array(
+				"2" => "Two",
+				"3" => "Three"
+			),
+			"Group Two" => array(
+				"4" => "Four"
+			)
+		));
+
+		$validator = new RequiredFields();
+
+		$field->setValue("1");
+		$this->assertTrue($field->validate($validator));
+
+		//test grouped values
+		$field->setValue("3");
+		$this->assertTrue($field->validate($validator));
+
+		//non-existent value should make the field invalid
+		$field->setValue("Over 9000");
+		$this->assertFalse($field->validate($validator));
+
+		//empty string shouldn't validate
+		$field->setValue('');
+		$this->assertFalse($field->validate($validator));
+
+		//empty field should validate after being set
+		$field->setEmptyString('Empty String');
+		$field->setValue('');
+		$this->assertTrue($field->validate($validator));
+
+		//disabled items shouldn't validate
+		$field->setDisabledItems(array('1'));
+		$field->setValue('1');
+		$this->assertFalse($field->validate($validator));
+
+		//grouped disabled items shouldn't validate
+		$field->setDisabledItems(array("Group One" => array("2")));
+		$field->setValue('2');
+		$this->assertFalse($field->validate($validator));
+	}
+
+}