Add RadioList and CheckboxList classes. (#172)

php-forge · Dec 22, 2023 · 0c5272b · 0c5272b
1 parent fc90d04
commit 0c5272b
Show file tree

Hide file tree

Showing 18 changed files with 929 additions and 10 deletions.
diff --git a/src/Attribute/Custom/HasSeparator.php b/src/Attribute/Custom/HasSeparator.php
@@ -9,8 +9,6 @@
  */
 trait HasSeparator
 {
-    protected string $separator = PHP_EOL;
-
     /**
      * Set the separator.
      *

diff --git a/src/Attribute/Input/HasValue.php b/src/Attribute/Input/HasValue.php
@@ -9,6 +9,18 @@
  */
 trait HasValue
 {
+    /**
+     * Get the value content attribute gives the default value of the field.
+     *
+     * @return mixed The value of the widget.
+     *
+     * @link https://html.spec.whatwg.org/multipage/input.html#attr-input-value
+     */
+    public function getValue(): mixed
+    {
+        return $this->attributes['value'] ?? null;
+    }
+
     /**
      * set the value content attribute gives the default value of the field.
      *

diff --git a/src/Base/AbstractSelect.php b/src/Base/AbstractSelect.php
@@ -47,7 +47,7 @@ protected function run(): string
         $attributes = $this->attributes;
         $multiple = false;
         /** @psalm-var array<int, \Stringable|scalar>|scalar|object|null $value */
-        $value = $attributes['value'] ?? [];
+        $value = $this->getValue();
 
         $items = match ($this->prompt) {
             '' => PHP_EOL . Tag::widget()->content('Select an option')->tagName('option')->render(),

diff --git a/src/Input/Base/AbstractChoice.php b/src/Input/Base/AbstractChoice.php
@@ -6,6 +6,7 @@
 
 use InvalidArgumentException;
 use PHPForge\Html\Attribute;
+use PHPForge\Html\Input\CheckedValueInterface;
 use PHPForge\Html\Input\Hidden;
 use PHPForge\Html\Input\LabelInterface;
 use PHPForge\Html\Label;
@@ -15,11 +16,12 @@
 use function is_iterable;
 use function is_object;
 
-abstract class AbstractChoice extends AbstractInput implements LabelInterface
+abstract class AbstractChoice extends AbstractInput implements CheckedValueInterface, LabelInterface
 {
     use Attribute\Custom\HasCheckedValue;
     use Attribute\Custom\HasContainer;
     use Attribute\Custom\HasLabel;
+    use Attribute\Custom\HasSeparator;
     use Attribute\Custom\HasUnchecked;
     use Attribute\Input\CanBeChecked;
     use Attribute\Input\CanBeRequired;
@@ -28,11 +30,12 @@ abstract class AbstractChoice extends AbstractInput implements LabelInterface
     protected bool $container = false;
     protected string $containerTag = 'div';
     protected string $type = '';
+    protected string $separator = PHP_EOL;
 
     protected function run(): string
     {
         $attributes = $this->attributes;
-        $value = $attributes['value'] ?? null;
+        $value = $this->getValue();
 
         /**
          * @link https://www.w3.org/TR/2012/WD-html-markup-20120329/input.checkbox.html#input.checkbox.attrs.value
@@ -92,7 +95,13 @@ private function renderLabelTag(Tag $inputCheckboxTag): Label|Tag
 
         return Label::widget()
             ->attributes($this->labelAttributes)
-            ->content(PHP_EOL, $inputCheckboxTag, PHP_EOL, $this->labelContent, PHP_EOL)
+            ->content(
+                $this->separator,
+                $inputCheckboxTag,
+                $this->separator,
+                $this->labelContent,
+                $this->separator,
+            )
             ->for($inputCheckboxTag->getId());
     }
 }
diff --git a/src/Input/Base/AbstractChoiceList.php b/src/Input/Base/AbstractChoiceList.php
@@ -0,0 +1,114 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPForge\Html\Input\Base;
+
+use InvalidArgumentException;
+use PHPForge\Html\Attribute;
+use PHPForge\Html\Input\Checkbox;
+use PHPForge\Html\Input\InputInterface;
+use PHPForge\Html\Input\LabelInterface;
+use PHPForge\Html\Input\Radio;
+use PHPForge\Html\Label;
+use PHPForge\Html\Tag;
+use PHPForge\Widget\Element;
+
+abstract class AbstractChoiceList extends Element implements InputInterface, LabelInterface
+{
+    use Attribute\Aria\HasAriaDescribedBy;
+    use Attribute\Aria\HasAriaLabel;
+    use Attribute\CanBeAutofocus;
+    use Attribute\Custom\HasAttributes;
+    use Attribute\Custom\HasContainer;
+    use Attribute\Custom\HasLabel;
+    use Attribute\Custom\HasSeparator;
+    use Attribute\HasClass;
+    use Attribute\HasId;
+    use Attribute\HasTabindex;
+    use Attribute\Input\CanBeChecked;
+    use Attribute\Input\CanBeRequired;
+    use Attribute\Input\HasName;
+    use Attribute\Input\HasValue;
+
+    protected array $attributes = [];
+    protected bool $container = true;
+    protected string $containerTag = 'div';
+    /**
+     * @psalm-var Checkbox[]|Radio[] $items
+     */
+    protected array $items = [];
+    protected string $separator = '';
+
+    public function items(Checkbox|Radio ...$items): static
+    {
+        $new = clone $this;
+        $new->items = $items;
+
+        return $new;
+    }
+
+    protected function run(): string
+    {
+        $attributes = $this->attributes;
+        $containerAttributes = $this->containerAttributes;
+        $id = $this->generateId('choice-');
+        $items = $this->items;
+        $labelTag = '';
+        $listItems = [];
+        $value = $this->getValue();
+
+        /**
+         * @link https://www.w3.org/TR/2012/WD-html-markup-20120329/input.checkbox.html#input.checkbox.attrs.value
+         */
+        if (is_iterable($value) || is_object($value)) {
+            throw new InvalidArgumentException(
+                sprintf('%s::class widget must be a scalar value.', static::class)
+            );
+        }
+
+        unset($attributes['value']);
+
+        if (array_key_exists('autofocus', $attributes) && is_bool($attributes['autofocus'])) {
+            $containerAttributes['autofocus'] = $attributes['autofocus'];
+
+            unset($attributes['autofocus']);
+        }
+
+        if (array_key_exists('tabindex', $attributes) && is_int($attributes['tabindex'])) {
+            $containerAttributes['tabindex'] = $attributes['tabindex'];
+
+            unset($attributes['tabindex']);
+        }
+
+        foreach ($items as $item) {
+            $listItems[] = $item
+                ->attributes($attributes)
+                ->checked($value === $item->getValue())
+                ->id(null)
+                ->separator($this->separator)
+                ->labelFor(null);
+        }
+
+        $listTagItems = implode(PHP_EOL, $listItems);
+
+        if ($this->labelContent !== '') {
+            $labelTag = Label::widget()
+                ->attributes($this->labelAttributes)
+                ->content($this->labelContent)
+                ->for($id)
+                ->render() . PHP_EOL;
+        }
+
+        return match ($this->container) {
+            true => $labelTag .
+                Tag::widget()
+                    ->attributes($containerAttributes)
+                    ->content($listTagItems)
+                    ->id($id)
+                    ->tagName($this->containerTag)
+                    ->render(),
+            default => $listTagItems,
+        };
+    }
+}
diff --git a/src/Input/Base/AbstractColor.php b/src/Input/Base/AbstractColor.php
@@ -19,7 +19,7 @@ abstract class AbstractColor extends AbstractInput
     protected function run(): string
     {
         $attributes = $this->attributes;
-        $value = $attributes['value'] ?? null;
+        $value = $this->getValue();
 
         /**
          * @link https://www.w3.org/TR/2012/WD-html-markup-20120329/input.color.html#input.color.attrs.value

diff --git a/src/Input/Base/AbstractControl.php b/src/Input/Base/AbstractControl.php
@@ -20,7 +20,7 @@ abstract class AbstractControl extends AbstractInput
     protected function run(): string
     {
         $attributes = $this->attributes;
-        $value = $attributes['value'] ?? null;
+        $value = $this->getValue();
 
         /**
          * @link https://www.w3.org/TR/2012/WD-html-markup-20120329/input.date.html#input.date.attrs.value

diff --git a/src/Input/Base/AbstractHidden.php b/src/Input/Base/AbstractHidden.php
@@ -29,7 +29,7 @@ abstract class AbstractHidden extends Element implements HiddenInterface
     protected function run(): string
     {
         $attributes = $this->attributes;
-        $value = $attributes['value'] ?? null;
+        $value = $this->getValue();
 
         /**
          * @link https://www.w3.org/TR/2012/WD-html-markup-20120329/input.hidden.html#input.hidden.attrs.value

diff --git a/src/Input/Base/AbstractText.php b/src/Input/Base/AbstractText.php
@@ -25,7 +25,7 @@ abstract class AbstractText extends AbstractInput implements PlaceholderInterfac
     protected function run(): string
     {
         $attributes = $this->attributes;
-        $value = $attributes['value'] ?? null;
+        $value = $this->getValue();
 
         /**
          * @link https://www.w3.org/TR/2012/WD-html-markup-20120329/input.text.html#input.text.attrs.value

diff --git a/src/Input/CheckedValueInterface.php b/src/Input/CheckedValueInterface.php
@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPForge\Html\Input;
+
+/**
+ * Provide methods for handling HTML checked value-related attributes and properties.
+ */
+interface CheckedValueInterface
+{
+    /**
+     * Set the value that determines when the checkbox should be checked.
+     *
+     * @param mixed $checkedValue The value that, when matched with the checkbox value, will mark the checkbox as checked.
+     *
+     * @return static Returns a new instance of the class with the updated checked value.
+     */
+    public function checkedValue(mixed $checkedValue): static;
+}
diff --git a/src/Input/ChoiceList.php b/src/Input/ChoiceList.php
@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPForge\Html\Input;
+
+/*
+ * Generates a list of checkboxes.
+ *
+ * A checkbox or radio list allows many selections.
+ */
+final class ChoiceList extends Base\AbstractChoiceList
+{
+}
diff --git a/src/Input/RuleHtmlByAttributeInterface.php b/src/Input/RuleHtmlByAttributeInterface.php
@@ -4,6 +4,9 @@
 
 namespace PHPForge\Html\Input;
 
+/**
+ * Provide methods for handling HTML rule-related attributes from validators.
+ */
 interface RuleHtmlByAttributeInterface
 {
 }
diff --git a/tests/Attribute/Custom/HasSeparatorTest.php b/tests/Attribute/Custom/HasSeparatorTest.php
@@ -13,6 +13,8 @@ public function testImmutability(): void
     {
         $instance = new class () {
             use HasSeparator;
+
+            protected string $separator = ',';
         };
 
         $this->assertNotSame($instance, $instance->separator('foo'));

diff --git a/tests/Attribute/Input/HasValueTest.php b/tests/Attribute/Input/HasValueTest.php
@@ -9,6 +9,17 @@
 
 final class HasValueTest extends TestCase
 {
+    public function testGetValue(): void
+    {
+        $instance = new class () {
+            use HasValue;
+
+            protected array $attributes = ['value' => 'foo'];
+        };
+
+        $this->assertSame('foo', $instance->getValue());
+    }
+
     public function testImmutability(): void
     {
         $instance = new class () {