Fix #90: Add method itemsFromValues() to widgets RadioList and `C…

…heckboxList` that set items with labels equal to values
yiisoft · Oct 20, 2021 · 8347945 · 8347945
1 parent 95729b0
commit 8347945
Show file tree

Hide file tree

Showing 5 changed files with 145 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,8 +1,9 @@
 # Yii HTML Change Log
 
+## 2.2.0 under development
 
-## 2.1.1 under development
-
+- New #90: Add method `itemsFromValues()` to widgets `RadioList` and `CheckboxList` that set items with labels equal
+  to values (vjik)
 - New #92: A third optional argument `$attributes` containing tag attributes in terms of name-value pairs has been
   added to methods `Html::textInput()`, `Html::hiddenInput()`, `Html::passwordInput()`, `Html::fileInput()`,
   `Html::radio()`, `Html::checkbox()`, `Html::textarea()` (vjik)

diff --git a/src/Widget/CheckboxList/CheckboxList.php b/src/Widget/CheckboxList/CheckboxList.php
@@ -130,6 +130,22 @@ public function items(array $items, bool $encodeLabels = true): self
         return $new;
     }
 
+    /**
+     * Fills items from an array provided. Array values are used for both input labels and input values.
+     *
+     * @param bool[]|float[]|int[]|string[]|\Stringable[] $values
+     * @param bool $encodeLabels Whether labels should be encoded.
+     */
+    public function itemsFromValues(array $values, bool $encodeLabels = true): self
+    {
+        $values = array_map('\strval', $values);
+
+        return $this->items(
+            array_combine($values, $values),
+            $encodeLabels
+        );
+    }
+
     /**
      * @param scalar|\Stringable ...$value
      */
@@ -192,7 +208,7 @@ public function disabled(bool $disabled = true): self
     public function uncheckValue($value): self
     {
         $new = clone $this;
-        $new->uncheckValue = $value === null ? null : (string)$value;
+        $new->uncheckValue = $value === null ? null : (string) $value;
         return $new;
     }
 
@@ -205,6 +221,7 @@ public function separator(string $separator): self
 
     /**
      * @param Closure|null $formatter
+     *
      * @psalm-param Closure(CheckboxItem):string|null $formatter
      */
     public function itemFormatter(?Closure $formatter): self

diff --git a/src/Widget/RadioList/RadioList.php b/src/Widget/RadioList/RadioList.php
@@ -111,6 +111,7 @@ public function replaceIndividualInputAttributes(array $attributes): self
 
     /**
      * @param string[] $items
+     * @param bool $encodeLabels Whether labels should be encoded.
      */
     public function items(array $items, bool $encodeLabels = true): self
     {
@@ -120,13 +121,29 @@ public function items(array $items, bool $encodeLabels = true): self
         return $new;
     }
 
+    /**
+     * Fills items from an array provided. Array values are used for both input labels and input values.
+     *
+     * @param bool[]|float[]|int[]|string[]|\Stringable[] $values
+     * @param bool $encodeLabels Whether labels should be encoded.
+     */
+    public function itemsFromValues(array $values, bool $encodeLabels = true): self
+    {
+        $values = array_map('\strval', $values);
+
+        return $this->items(
+            array_combine($values, $values),
+            $encodeLabels
+        );
+    }
+
     /**
      * @param bool|float|int|string|\Stringable|null $value
      */
     public function value($value): self
     {
         $new = clone $this;
-        $new->value = $value === null ? null : (string)$value;
+        $new->value = $value === null ? null : (string) $value;
         return $new;
     }
 
@@ -166,7 +183,7 @@ public function disabled(bool $disabled = true): self
     public function uncheckValue($value): self
     {
         $new = clone $this;
-        $new->uncheckValue = $value === null ? null : (string)$value;
+        $new->uncheckValue = $value === null ? null : (string) $value;
         return $new;
     }
 
@@ -179,6 +196,7 @@ public function separator(string $separator): self
 
     /**
      * @param Closure|null $formatter
+     *
      * @psalm-param Closure(RadioItem):string|null $formatter
      */
     public function itemFormatter(?Closure $formatter): self

diff --git a/tests/common/Widget/CheckboxListTest.php b/tests/common/Widget/CheckboxListTest.php
@@ -255,6 +255,56 @@ public function testItemsWithoutEncodeLabel(): void
         );
     }
 
+    public function dataItemsFromValues(): array
+    {
+        return [
+            [
+                '<label><input type="checkbox" name="test[]" value="1"> 1</label>' . "\n" .
+                '<label><input type="checkbox" name="test[]" value="2"> 2</label>',
+                [1, 2],
+            ],
+            [
+                '<label><input type="checkbox" name="test[]" value="One"> One</label>' . "\n" .
+                '<label><input type="checkbox" name="test[]" value="&lt;b&gt;Two&lt;/b&gt;"> &lt;b&gt;Two&lt;/b&gt;</label>',
+                ['One', '<b>Two</b>'],
+            ],
+            [
+                '<label><input type="checkbox" name="test[]" value="1"> 1</label>' . "\n" .
+                '<label><input type="checkbox" name="test[]" value></label>',
+                [true, false],
+            ],
+        ];
+    }
+
+    /**
+     * @dataProvider dataItemsFromValues
+     */
+    public function testItemsFromValues(string $expected, array $values): void
+    {
+        $this->assertSame(
+            $expected,
+            CheckboxList::create('test')
+                ->itemsFromValues($values)
+                ->withoutContainer()
+                ->render(),
+        );
+    }
+
+    public function testItemsFromValuesWithoutEncodeLabel(): void
+    {
+        $this->assertSame(
+            '<label><input type="checkbox" name="test[]" value="One"> One</label>' . "\n" .
+            '<label><input type="checkbox" name="test[]" value="&lt;b&gt;Two&lt;/b&gt;"> <b>Two</b></label>',
+            CheckboxList::create('test')
+                ->itemsFromValues([
+                    'One',
+                    '<b>Two</b>',
+                ], false)
+                ->withoutContainer()
+                ->render(),
+        );
+    }
+
     public function dataValue(): array
     {
         return [
@@ -577,7 +627,7 @@ public function testStringable(): void
     {
         $this->assertSame(
             "<div>\n</div>",
-            (string)CheckboxList::create('test'),
+            (string) CheckboxList::create('test'),
         );
     }
 
@@ -592,6 +642,7 @@ public function testImmutability(): void
         $this->assertNotSame($widget, $widget->individualInputAttributes([]));
         $this->assertNotSame($widget, $widget->replaceIndividualInputAttributes([]));
         $this->assertNotSame($widget, $widget->items([]));
+        $this->assertNotSame($widget, $widget->itemsFromValues([]));
         $this->assertNotSame($widget, $widget->value());
         $this->assertNotSame($widget, $widget->values([]));
         $this->assertNotSame($widget, $widget->form(''));

diff --git a/tests/common/Widget/RadioListTest.php b/tests/common/Widget/RadioListTest.php
@@ -252,6 +252,56 @@ public function testItemsWithoutEncodeLabel(): void
         );
     }
 
+    public function dataItemsFromValues(): array
+    {
+        return [
+            [
+                '<label><input type="radio" name="test" value="1"> 1</label>' . "\n" .
+                '<label><input type="radio" name="test" value="2"> 2</label>',
+                [1, 2],
+            ],
+            [
+                '<label><input type="radio" name="test" value="One"> One</label>' . "\n" .
+                '<label><input type="radio" name="test" value="&lt;b&gt;Two&lt;/b&gt;"> &lt;b&gt;Two&lt;/b&gt;</label>',
+                ['One', '<b>Two</b>'],
+            ],
+            [
+                '<label><input type="radio" name="test" value="1"> 1</label>' . "\n" .
+                '<label><input type="radio" name="test" value></label>',
+                [true, false],
+            ],
+        ];
+    }
+
+    /**
+     * @dataProvider dataItemsFromValues
+     */
+    public function testItemsFromValues(string $expected, array $values): void
+    {
+        $this->assertSame(
+            $expected,
+            RadioList::create('test')
+                ->itemsFromValues($values)
+                ->withoutContainer()
+                ->render(),
+        );
+    }
+
+    public function testItemsFromValuesWithoutEncodeLabel(): void
+    {
+        $this->assertSame(
+            '<label><input type="radio" name="test" value="One"> One</label>' . "\n" .
+            '<label><input type="radio" name="test" value="&lt;b&gt;Two&lt;/b&gt;"> <b>Two</b></label>',
+            RadioList::create('test')
+                ->itemsFromValues([
+                    'One',
+                    '<b>Two</b>',
+                ], false)
+                ->withoutContainer()
+                ->render(),
+        );
+    }
+
     public function dataValue(): array
     {
         return [
@@ -547,7 +597,7 @@ public function testStringable(): void
     {
         $this->assertSame(
             "<div>\n</div>",
-            (string)RadioList::create('test'),
+            (string) RadioList::create('test'),
         );
     }
 
@@ -562,6 +612,7 @@ public function testImmutability(): void
         $this->assertNotSame($widget, $widget->individualInputAttributes([]));
         $this->assertNotSame($widget, $widget->replaceIndividualInputAttributes([]));
         $this->assertNotSame($widget, $widget->items([]));
+        $this->assertNotSame($widget, $widget->itemsFromValues([]));
         $this->assertNotSame($widget, $widget->value(null));
         $this->assertNotSame($widget, $widget->form(''));
         $this->assertNotSame($widget, $widget->readonly());