ChoiceControl, MultiChoiceControl: added checkDefaultValue() as replacement for $checkAllowedValues (#151)

Author: dakorpar

src/Forms/Controls/ChoiceControl.php

@@ -20,7 +20,10 @@
  */
 abstract class ChoiceControl extends BaseControl
 {
-	/** @var bool */
+	/**
+	 * @var bool
+	 * @deprecated use checkDefaultValue()
+	 */
 	public $checkAllowedValues = true;
 
 	/** @var array */
@@ -147,4 +150,14 @@ public function setDisabled($value = true)
 		}
 		return $this;
 	}
+
+
+	/**
+	 * @return static
+	 */
+	public function checkDefaultValue(bool $value = true)
+	{
+		$this->checkAllowedValues = $value;
+		return $this;
+	}
 }

src/Forms/Controls/MultiChoiceControl.php

@@ -20,7 +20,10 @@
  */
 abstract class MultiChoiceControl extends BaseControl
 {
-	/** @var bool */
+	/**
+	 * @var bool
+	 * @deprecated use checkDefaultValue()
+	 */
 	public $checkAllowedValues = true;
 
 	/** @var array */
@@ -159,4 +162,14 @@ public function getHtmlName(): string
 	{
 		return parent::getHtmlName() . '[]';
 	}
+
+
+	/**
+	 * @return static
+	 */
+	public function checkDefaultValue(bool $value = true)
+	{
+		$this->checkAllowedValues = $value;
+		return $this;
+	}
 }

tests/Forms/Controls.ChoiceControl.loadData.phpt

@@ -154,10 +154,10 @@ test(function () use ($series) { // setValue() and invalid argument
 });
 
 
-test(function () use ($series) { // setValue() and disabled $checkAllowedValues
+test(function () use ($series) { // setValue() and disabled checkDefaultValue()
 	$form = new Form;
 	$input = $form['select'] = new ChoiceControl(null, $series);
-	$input->checkAllowedValues = false;
+	$input->checkDefaultValue(false);
 	$input->setValue('unknown');
 	Assert::null($input->getValue());
 });

tests/Forms/Controls.MultiChoiceControl.loadData.phpt

@@ -175,10 +175,10 @@ test(function () use ($series) { // setValue() and invalid argument
 });
 
 
-test(function () use ($series) { // setValue() and disabled $checkAllowedValues
+test(function () use ($series) { // setValue() and disabled checkDefaultValue()
 	$form = new Form;
 	$input = $form['select'] = new MultiChoiceControl(null, $series);
-	$input->checkAllowedValues = false;
+	$input->checkDefaultValue(false);
 	$input->setValue('unknown');
 	Assert::same([], $input->getValue());