Add support null value. (#137)

yiisoft · Nov 2, 2021 · e7aac20 · e7aac20
1 parent a191c04
commit e7aac20
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 42 deletions.
diff --git a/src/Widget/CheckboxList.php b/src/Widget/CheckboxList.php
@@ -218,8 +218,8 @@ protected function run(): string
         /** @var iterable<int, scalar|Stringable>|scalar|Stringable|null */
         $value = HtmlForm::getAttributeValue($new->getFormModel(), $new->attribute);
 
-        if (!is_iterable($value)) {
-            throw new InvalidArgumentException('CheckboxList widget value must always be an array.');
+        if (!is_iterable($value) && null !== $value) {
+            throw new InvalidArgumentException('CheckboxList widget must be a array or null value.');
         }
 
         /** @var string */
@@ -241,14 +241,17 @@ protected function run(): string
             $checkboxList = $checkboxList->separator($new->separator);
         }
 
+        if ($value !== null) {
+            $checkboxList = $checkboxList->values($value);
+        }
+
         return $checkboxList
             ->checkboxAttributes($new->attributes)
             ->containerAttributes($new->containerAttributes)
             ->containerTag($new->containerTag)
             ->individualInputAttributes($new->individualItemsAttributes)
             ->itemFormatter($new->itemsFormatter)
             ->replaceCheckboxAttributes($new->itemsAttributes)
-            ->values($value)
             ->render();
     }
 }
diff --git a/tests/TestSupport/Form/TypeForm.php b/tests/TestSupport/Form/TypeForm.php
@@ -8,7 +8,7 @@
 
 final class TypeForm extends FormModel
 {
-    private array $array = [];
+    private ?array $array = [];
     private bool $bool = false;
     private float $float = 0;
     private int $int = 0;

diff --git a/tests/Widget/CheckboxListTest.php b/tests/Widget/CheckboxListTest.php
@@ -23,11 +23,10 @@ final class CheckboxListTest extends TestCase
 
     public function testContainerAttributes(): void
     {
-        $this->formModel->setAttribute('array', [2]);
         $expected = <<<'HTML'
         <div id="typeform-array" class="test-class">
         <label><input type="checkbox" name="TypeForm[array][]" value="1"> Female</label>
-        <label><input type="checkbox" name="TypeForm[array][]" value="2" checked> Male</label>
+        <label><input type="checkbox" name="TypeForm[array][]" value="2"> Male</label>
         </div>
         HTML;
         $html = CheckboxList::widget()
@@ -40,10 +39,9 @@ public function testContainerAttributes(): void
 
     public function testContainerTag(): void
     {
-        $this->formModel->setAttribute('array', [1]);
         $expected = <<<'HTML'
         <span id="typeform-array">
-        <label><input type="checkbox" name="TypeForm[array][]" value="1" checked> Female</label>
+        <label><input type="checkbox" name="TypeForm[array][]" value="1"> Female</label>
         <label><input type="checkbox" name="TypeForm[array][]" value="2"> Male</label>
         </span>
         HTML;
@@ -57,9 +55,8 @@ public function testContainerTag(): void
 
     public function testContainerTagWithNull(): void
     {
-        $this->formModel->setAttribute('array', [1]);
         $expected = <<<'HTML'
-        <label><input type="checkbox" name="TypeForm[array][]" value="1" checked> Female</label>
+        <label><input type="checkbox" name="TypeForm[array][]" value="1"> Female</label>
         <label><input type="checkbox" name="TypeForm[array][]" value="2"> Male</label>
         HTML;
         $html = CheckboxList::widget()
@@ -84,11 +81,10 @@ public function testDisabled(): void
 
     public function testIndividualItemsAttributes(): void
     {
-        $this->formModel->setAttribute('array', [2]);
         $expected = <<<'HTML'
         <div id="typeform-array">
         <label><input type="checkbox" name="TypeForm[array][]" value="1" disabled> Female</label>
-        <label><input type="checkbox" class="test-class" name="TypeForm[array][]" value="2" checked> Male</label>
+        <label><input type="checkbox" class="test-class" name="TypeForm[array][]" value="2"> Male</label>
         </div>
         HTML;
         $html = CheckboxList::widget()
@@ -101,11 +97,10 @@ public function testIndividualItemsAttributes(): void
 
     public function testItemsAttributes(): void
     {
-        $this->formModel->setAttribute('array', [2]);
         $expected = <<<'HTML'
         <div id="typeform-array">
         <label><input type="checkbox" class="test-class" name="TypeForm[array][]" value="1"> Female</label>
-        <label><input type="checkbox" class="test-class" name="TypeForm[array][]" value="2" checked> Male</label>
+        <label><input type="checkbox" class="test-class" name="TypeForm[array][]" value="2"> Male</label>
         </div>
         HTML;
         $html = CheckboxList::widget()
@@ -118,11 +113,10 @@ public function testItemsAttributes(): void
 
     public function testItemFormater(): void
     {
-        $this->formModel->setAttribute('array', [2]);
         $expected = <<<'HTML'
         <div id="typeform-array">
         <label><input type='checkbox' name='TypeForm[array][]' value='1'> Female</label>
-        <label><input type='checkbox' name='TypeForm[array][]' value='2' checked> Male</label>
+        <label><input type='checkbox' name='TypeForm[array][]' value='2'> Male</label>
         </div>
         HTML;
         $html = CheckboxList::widget()
@@ -171,11 +165,10 @@ public function testItemsFromValues(): void
 
     public function testReadOnly(): void
     {
-        $this->formModel->setAttribute('array', [2]);
         $expected = <<<'HTML'
         <div id="typeform-array">
         <label><input type="checkbox" name="TypeForm[array][]" value="1" readonly> Female</label>
-        <label><input type="checkbox" name="TypeForm[array][]" value="2" checked readonly> Male</label>
+        <label><input type="checkbox" name="TypeForm[array][]" value="2" readonly> Male</label>
         </div>
         HTML;
         $this->assertEqualsWithoutLE(
@@ -186,10 +179,9 @@ public function testReadOnly(): void
 
     public function testRender(): void
     {
-        $this->formModel->setAttribute('array', [1]);
         $expected = <<<'HTML'
         <div id="typeform-array">
-        <label><input type="checkbox" name="TypeForm[array][]" value="1" checked> Female</label>
+        <label><input type="checkbox" name="TypeForm[array][]" value="1"> Female</label>
         <label><input type="checkbox" name="TypeForm[array][]" value="2"> Male</label>
         </div>
         HTML;
@@ -201,10 +193,9 @@ public function testRender(): void
 
     public function testSeparator(): void
     {
-        $this->formModel->setAttribute('array', [2]);
         $expected = <<<'HTML'
         <div id="typeform-array">
-        <label><input type="checkbox" name="TypeForm[array][]" value="1"> Female</label>&#9866;<label><input type="checkbox" name="TypeForm[array][]" value="2" checked> Male</label>
+        <label><input type="checkbox" name="TypeForm[array][]" value="1"> Female</label>&#9866;<label><input type="checkbox" name="TypeForm[array][]" value="2"> Male</label>
         </div>
         HTML;
         $html = CheckboxList::widget()
@@ -217,6 +208,19 @@ public function testSeparator(): void
 
     public function testValue(): void
     {
+        // value null
+        $this->formModel->setAttribute('array', null);
+        $expected = <<<'HTML'
+        <div id="typeform-array">
+        <label><input type="checkbox" name="TypeForm[array][]" value="1"> Female</label>
+        <label><input type="checkbox" name="TypeForm[array][]" value="2"> Male</label>
+        </div>
+        HTML;
+        $this->assertEqualsWithoutLE(
+            $expected,
+            CheckboxList::widget()->config($this->formModel, 'array')->items($this->sex)->render(),
+        );
+
         // value iterable
         $this->formModel->setAttribute('array', [2]);
         $expected = <<<'HTML'
@@ -235,7 +239,7 @@ public function testValueException(): void
     {
         $this->formModel->setAttribute('int', 1);
         $this->expectException(InvalidArgumentException::class);
-        $this->expectExceptionMessage('CheckboxList widget value must always be an array');
+        $this->expectExceptionMessage('CheckboxList widget must be a array or null value.');
         CheckboxList::widget()->config($this->formModel, 'int')->render();
     }
 

diff --git a/tests/Widget/FieldCheckBoxListTest.php b/tests/Widget/FieldCheckBoxListTest.php
@@ -24,13 +24,12 @@ final class FieldCheckBoxListTest extends TestCase
 
     public function testContainerAttributes(): void
     {
-        $this->formModel->setAttribute('array', [2]);
         $expected = <<<'HTML'
         <div>
         <label for="typeform-array">Array</label>
         <div id="typeform-array" class="test-class">
         <label><input type="checkbox" name="TypeForm[array][]" value="1"> Female</label>
-        <label><input type="checkbox" name="TypeForm[array][]" value="2" checked> Male</label>
+        <label><input type="checkbox" name="TypeForm[array][]" value="2"> Male</label>
         </div>
         </div>
         HTML;
@@ -43,12 +42,11 @@ public function testContainerAttributes(): void
 
     public function testContainerTag(): void
     {
-        $this->formModel->setAttribute('array', [1]);
         $expected = <<<'HTML'
         <div>
         <label for="typeform-array">Array</label>
         <span id="typeform-array">
-        <label><input type="checkbox" name="TypeForm[array][]" value="1" checked> Female</label>
+        <label><input type="checkbox" name="TypeForm[array][]" value="1"> Female</label>
         <label><input type="checkbox" name="TypeForm[array][]" value="2"> Male</label>
         </span>
         </div>
@@ -62,11 +60,10 @@ public function testContainerTag(): void
 
     public function testContainerTagWithNull(): void
     {
-        $this->formModel->setAttribute('array', [1]);
         $expected = <<<'HTML'
         <div>
         <label for="typeform-array">Array</label>
-        <label><input type="checkbox" name="TypeForm[array][]" value="1" checked> Female</label>
+        <label><input type="checkbox" name="TypeForm[array][]" value="1"> Female</label>
         <label><input type="checkbox" name="TypeForm[array][]" value="2"> Male</label>
         </div>
         HTML;
@@ -97,13 +94,12 @@ public function testDisabled(): void
 
     public function testIndividualItemsAttributes(): void
     {
-        $this->formModel->setAttribute('array', [2]);
         $expected = <<<'HTML'
         <div>
         <label for="typeform-array">Array</label>
         <div id="typeform-array">
         <label><input type="checkbox" name="TypeForm[array][]" value="1" disabled> Female</label>
-        <label><input type="checkbox" class="test-class" name="TypeForm[array][]" value="2" checked> Male</label>
+        <label><input type="checkbox" class="test-class" name="TypeForm[array][]" value="2"> Male</label>
         </div>
         </div>
         HTML;
@@ -121,13 +117,12 @@ public function testIndividualItemsAttributes(): void
 
     public function testItemsAttributes(): void
     {
-        $this->formModel->setAttribute('array', [2]);
         $expected = <<<'HTML'
         <div>
         <label for="typeform-array">Array</label>
         <div id="typeform-array">
         <label><input type="checkbox" class="test-class" name="TypeForm[array][]" value="1"> Female</label>
-        <label><input type="checkbox" class="test-class" name="TypeForm[array][]" value="2" checked> Male</label>
+        <label><input type="checkbox" class="test-class" name="TypeForm[array][]" value="2"> Male</label>
         </div>
         </div>
         HTML;
@@ -140,13 +135,12 @@ public function testItemsAttributes(): void
 
     public function testItemFormater(): void
     {
-        $this->formModel->setAttribute('array', [2]);
         $expected = <<<'HTML'
         <div>
         <label for="typeform-array">Array</label>
         <div id="typeform-array">
         <label><input type='checkbox' name='TypeForm[array][]' value='1'> Female</label>
-        <label><input type='checkbox' name='TypeForm[array][]' value='2' checked> Male</label>
+        <label><input type='checkbox' name='TypeForm[array][]' value='2'> Male</label>
         </div>
         </div>
         HTML;
@@ -187,13 +181,12 @@ public function testItemsFromValues(): void
 
     public function testReadOnly(): void
     {
-        $this->formModel->setAttribute('array', [2]);
         $expected = <<<'HTML'
         <div>
         <label for="typeform-array">Array</label>
         <div id="typeform-array">
         <label><input type="checkbox" name="TypeForm[array][]" value="1" readonly> Female</label>
-        <label><input type="checkbox" name="TypeForm[array][]" value="2" checked readonly> Male</label>
+        <label><input type="checkbox" name="TypeForm[array][]" value="2" readonly> Male</label>
         </div>
         </div>
         HTML;
@@ -208,12 +201,11 @@ public function testReadOnly(): void
 
     public function testRender(): void
     {
-        $this->formModel->setAttribute('array', [1]);
         $expected = <<<'HTML'
         <div>
         <label for="typeform-array">Array</label>
         <div id="typeform-array">
-        <label><input type="checkbox" name="TypeForm[array][]" value="1" checked> Female</label>
+        <label><input type="checkbox" name="TypeForm[array][]" value="1"> Female</label>
         <label><input type="checkbox" name="TypeForm[array][]" value="2"> Male</label>
         </div>
         </div>
@@ -226,12 +218,11 @@ public function testRender(): void
 
     public function testSeparator(): void
     {
-        $this->formModel->setAttribute('array', [2]);
         $expected = <<<'HTML'
         <div>
         <label for="typeform-array">Array</label>
         <div id="typeform-array">
-        <label><input type="checkbox" name="TypeForm[array][]" value="1"> Female</label>&#9866;<label><input type="checkbox" name="TypeForm[array][]" value="2" checked> Male</label>
+        <label><input type="checkbox" name="TypeForm[array][]" value="1"> Female</label>&#9866;<label><input type="checkbox" name="TypeForm[array][]" value="2"> Male</label>
         </div>
         </div>
         HTML;
@@ -244,6 +235,22 @@ public function testSeparator(): void
 
     public function testValue(): void
     {
+        // value null
+        $this->formModel->setAttribute('array', null);
+        $expected = <<<'HTML'
+        <div>
+        <label for="typeform-array">Array</label>
+        <div id="typeform-array">
+        <label><input type="checkbox" name="TypeForm[array][]" value="1"> Female</label>
+        <label><input type="checkbox" name="TypeForm[array][]" value="2"> Male</label>
+        </div>
+        </div>
+        HTML;
+        $this->assertEqualsWithoutLE(
+            $expected,
+            Field::widget()->config($this->formModel, 'array')->checkboxList([], $this->sex)->render(),
+        );
+
         // value iterable
         $this->formModel->setAttribute('array', [2]);
         $expected = <<<'HTML'
@@ -265,7 +272,7 @@ public function testValueException(): void
     {
         $this->formModel->setAttribute('object', new StdClass());
         $this->expectException(InvalidArgumentException::class);
-        $this->expectExceptionMessage('CheckboxList widget value must always be an array');
+        $this->expectExceptionMessage('CheckboxList widget must be a array or null value.');
         Field::widget()->config($this->formModel, 'object')->checkboxList()->render();
     }