Merge pull request #51 from Icinga/feature/more-strict-interfaces-23

More strict interfaces
Icinga · Jun 22, 2021 · c49325e · c49325e
2 parents e23c2f5 + fddcdde
commit c49325e
Show file tree

Hide file tree

Showing 15 changed files with 296 additions and 124 deletions.
diff --git a/src/Attributes.php b/src/Attributes.php
@@ -111,6 +111,22 @@ public function getAttributes()
         return $this->attributes;
     }
 
+    /**
+     * Merge the given attributes
+     *
+     * @param Attributes $attributes
+     *
+     * @return $this
+     */
+    public function merge(Attributes $attributes)
+    {
+        foreach ($attributes as $attribute) {
+            $this->addAttribute($attribute);
+        }
+
+        return $this;
+    }
+
     /**
      * Return true if the attribute with the given name exists, false otherwise
      *

diff --git a/src/BaseHtmlElement.php b/src/BaseHtmlElement.php
@@ -301,26 +301,11 @@ protected function registerAttributeCallbacks(Attributes $attributes)
     {
     }
 
-    public function add($content)
+    public function addHtml(ValidHtml ...$content)
     {
         $this->ensureAssembled();
 
-        parent::add($content);
-
-        return $this;
-    }
-
-    public function setContent($content)
-    {
-        // setContent() calls $this->add() which would assemble the element and that does not make any sense here
-        // Plus, this allows subclasses of BaseHtmlElement to add content before assemble() --
-        // in the constructor for example
-
-        $this->hasBeenAssembled = true;
-
-        parent::setContent($content);
-
-        $this->hasBeenAssembled = false;
+        parent::addHtml(...$content);
 
         return $this;
     }

diff --git a/src/Error.php b/src/Error.php
@@ -41,7 +41,7 @@ public static function show($error)
 
         $result = static::renderErrorMessage($msg);
         if (static::showTraces()) {
-            $result->add(Html::tag('pre', $error->getTraceAsString()));
+            $result->addHtml(Html::tag('pre', $error->getTraceAsString()));
         }
 
         return $result;
@@ -101,7 +101,7 @@ protected static function createMessageForException($exception)
     protected static function renderErrorMessage($message)
     {
         $output = new HtmlDocument();
-        $output->add(
+        $output->addHtml(
             Html::tag('div', ['class' => 'exception'], [
                 Html::tag('h1', [
                     Html::tag('i', ['class' => 'icon-bug']),

diff --git a/src/Form.php b/src/Form.php
@@ -346,11 +346,11 @@ protected function onError()
                 $message = $message->getMessage();
             }
 
-            $errors->add(Html::tag('li', $message));
+            $errors->addHtml(Html::tag('li', $message));
         }
 
         if (! $errors->isEmpty()) {
-            $this->prepend($errors);
+            $this->prependHtml($errors);
         }
     }
 

diff --git a/src/FormDecorator/DdDtDecorator.php b/src/FormDecorator/DdDtDecorator.php
@@ -5,6 +5,7 @@
 use ipl\Html\BaseHtmlElement;
 use ipl\Html\FormElement\BaseFormElement;
 use ipl\Html\Html;
+use ipl\Html\ValidHtml;
 
 class DdDtDecorator extends BaseHtmlElement implements DecoratorInterface
 {
@@ -92,19 +93,19 @@ protected function renderErrors()
         return null;
     }
 
-    public function add($content)
+    public function addHtml(ValidHtml ...$content)
     {
         // TODO: is this required?
-        if ($content !== $this->wrappedElement) {
-            parent::add($content);
+        if (! in_array($this->wrappedElement, $content, true)) {
+            parent::addHtml(...$content);
         }
 
         return $this;
     }
 
     protected function assemble()
     {
-        $this->add([$this->dt(), $this->dd()]);
+        $this->addHtml($this->dt(), $this->dd());
         $this->ready = true;
     }
 

diff --git a/src/FormDecorator/DivDecorator.php b/src/FormDecorator/DivDecorator.php
@@ -10,6 +10,7 @@
 use ipl\Html\FormElement\HiddenElement;
 use ipl\Html\Html;
 use ipl\Html\HtmlElement;
+use ipl\Html\Text;
 
 /**
  * Form element decorator based on div elements
@@ -84,10 +85,12 @@ protected function assembleElement()
 
     protected function assembleErrors()
     {
-        $errors = new HtmlElement('ul', ['class' => static::ERROR_CLASS]);
+        $errors = new HtmlElement('ul', Attributes::create(['class' => static::ERROR_CLASS]));
 
         foreach ($this->formElement->getMessages() as $message) {
-            $errors->add(new HtmlElement('li', ['class' => static::ERROR_CLASS], $message));
+            $errors->addHtml(
+                new HtmlElement('li', Attributes::create(['class' => static::ERROR_CLASS]), Text::create($message))
+            );
         }
 
         if (! $errors->isEmpty()) {
@@ -119,7 +122,7 @@ protected function assemble()
             $this->getAttributes()->add('class', static::ERROR_HINT_CLASS);
         }
 
-        $this->add(array_filter([
+        $this->addHtml(...Html::wantHtmlList([
             $this->assembleLabel(),
             $this->assembleElement(),
             $this->assembleDescription(),

diff --git a/src/FormElement/FormElements.php b/src/FormElement/FormElements.php
@@ -124,7 +124,7 @@ public function addElement($typeOrElement, $name = null, $options = null)
         $this
             ->registerElement($element) // registerElement() must be called first because of the name check
             ->decorate($element)
-            ->add($element);
+            ->addHtml($element);
 
         return $this;
     }

diff --git a/src/FormElement/SelectElement.php b/src/FormElement/SelectElement.php
@@ -111,7 +111,7 @@ protected function makeOption($value, $label)
         if (is_array($label)) {
             $grp = Html::tag('optgroup', ['label' => $value]);
             foreach ($label as $option => $val) {
-                $grp->add($this->makeOption($option, $val));
+                $grp->addHtml($this->makeOption($option, $val));
             }
 
             return $grp;
@@ -134,8 +134,6 @@ protected function makeOption($value, $label)
 
     protected function assemble()
     {
-        foreach ($this->optionContent as $value => $option) {
-            $this->add($option);
-        }
+        $this->addHtml(...array_values($this->optionContent));
     }
 }
diff --git a/src/Html.php b/src/Html.php
@@ -26,17 +26,32 @@ abstract class Html
      */
     public static function tag($name, $attributes = null, $content = null)
     {
-        if ($attributes instanceof ValidHtml || is_scalar($attributes)) {
-            $content = $attributes;
+        if ($content !== null) {
+            // If not null, it's html content, no question
+            $content = static::wantHtmlList($content);
+        } elseif ($attributes instanceof ValidHtml || is_scalar($attributes)) {
+            // Otherwise $attributes may be $content, but only if definitely **NOT** attributes
+            $content = static::wantHtmlList($attributes);
             $attributes = null;
-        } elseif (is_iterable($attributes)) {
-            if (is_int(iterable_key_first($attributes))) {
-                $content = $attributes;
+        }
+
+        if ($attributes !== null) {
+            if (! is_iterable($attributes) || ! is_int(iterable_key_first($attributes))) {
+                // Not an array (e.g. instance of Attributes) or an associative array
+                $attributes = Attributes::wantAttributes($attributes);
+            } elseif (is_iterable($attributes)) {
+                // $attributes may still be $content, in case of a sequenced array
+                if ($content !== null) {
+                    // But not if there's already $content
+                    throw new InvalidArgumentException('Value of argument $attributes are no attributes');
+                }
+
+                $content = static::wantHtmlList($attributes);
                 $attributes = null;
             }
         }
 
-        return new HtmlElement($name, $attributes, $content);
+        return new HtmlElement($name, $attributes, ...($content ?: []));
     }
 
     /**
@@ -104,7 +119,7 @@ public static function wrapEach($list, $wrapper)
         $result = new HtmlDocument();
         foreach ($list as $name => $value) {
             if (is_string($wrapper)) {
-                $result->add(Html::tag($wrapper, $value));
+                $result->addHtml(Html::tag($wrapper, $value));
             } elseif (is_callable($wrapper)) {
                 $result->add($wrapper($name, $value));
             } else {
@@ -139,7 +154,7 @@ public static function wantHtml($any)
             $html = new HtmlDocument();
             foreach ($any as $el) {
                 if ($el !== null) {
-                    $html->add(static::wantHtml($el));
+                    $html->addHtml(static::wantHtml($el));
                 }
             }
 
@@ -152,6 +167,32 @@ public static function wantHtml($any)
         }
     }
 
+    /**
+     * Accept any input and return it as list of ValidHtml
+     *
+     * @param mixed $content
+     *
+     * @return ValidHtml[]
+     */
+    public static function wantHtmlList($content)
+    {
+        $list = [];
+
+        if ($content === null) {
+            return $list;
+        } elseif (! is_iterable($content)) {
+            $list[] = static::wantHtml($content);
+        } elseif ($content instanceof ValidHtml) {
+            $list[] = $content;
+        } else {
+            foreach ($content as $part) {
+                $list = array_merge($list, static::wantHtmlList($part));
+            }
+        }
+
+        return $list;
+    }
+
     /**
      * Get whether the given variable be rendered as a string
      *

diff --git a/src/HtmlDocument.php b/src/HtmlDocument.php
@@ -83,7 +83,24 @@ public function getContent()
     public function setContent($content)
     {
         $this->content = [];
-        $this->add($content);
+        $this->setHtmlContent(...Html::wantHtmlList($content));
+
+        return $this;
+    }
+
+    /**
+     * Set content
+     *
+     * @param ValidHtml ...$content
+     *
+     * @return $this
+     */
+    public function setHtmlContent(ValidHtml ...$content)
+    {
+        $this->content = [];
+        foreach ($content as $element) {
+            $this->addIndexedContent($element);
+        }
 
         return $this;
     }
@@ -144,12 +161,22 @@ public function getFirst($tag)
      */
     public function add($content)
     {
-        if (is_iterable($content) && ! $content instanceof ValidHtml) {
-            foreach ($content as $c) {
-                $this->add($c);
-            }
-        } elseif ($content !== null) {
-            $this->addIndexedContent(Html::wantHtml($content));
+        $this->addHtml(...Html::wantHtmlList($content));
+
+        return $this;
+    }
+
+    /**
+     * Add content
+     *
+     * @param ValidHtml ...$content
+     *
+     * @return $this
+     */
+    public function addHtml(ValidHtml ...$content)
+    {
+        foreach ($content as $element) {
+            $this->addIndexedContent($element);
         }
 
         return $this;
@@ -211,16 +238,24 @@ public function contains(ValidHtml $element)
      */
     public function prepend($content)
     {
-        if (is_iterable($content) && ! $content instanceof ValidHtml) {
-            foreach (array_reverse(is_array($content) ? $content : iterator_to_array($content)) as $c) {
-                $this->prepend($c);
-            }
-        } elseif ($content !== null) {
-            $pos = 0;
-            $html = Html::wantHtml($content);
+        $this->prependHtml(...Html::wantHtmlList($content));
+
+        return $this;
+    }
+
+    /**
+     * Prepend content
+     *
+     * @param ValidHtml ...$content
+     *
+     * @return $this
+     */
+    public function prependHtml(ValidHtml ...$content)
+    {
+        foreach (array_reverse($content) as $html) {
             array_unshift($this->content, $html);
             $this->incrementIndexKeys();
-            $this->addObjectPosition($html, $pos);
+            $this->addObjectPosition($html, 0);
         }
 
         return $this;

diff --git a/src/HtmlElement.php b/src/HtmlElement.php
@@ -12,34 +12,32 @@ class HtmlElement extends BaseHtmlElement
     /**
      * Create a new HTML element from the given tag, attributes and content
      *
-     * @param string                 $tag        The tag for the element
-     * @param Attributes|array       $attributes The HTML attributes for the element
-     * @param ValidHtml|string|array $content    The content of the element
+     * @param string     $tag        The tag for the element
+     * @param Attributes $attributes The HTML attributes for the element
+     * @param ValidHtml  ...$content The content of the element
      */
-    public function __construct($tag, $attributes = null, $content = null)
+    public function __construct($tag, Attributes $attributes = null, ValidHtml ...$content)
     {
         $this->tag = $tag;
 
         if ($attributes !== null) {
-            $this->getAttributes()->add($attributes);
+            $this->getAttributes()->merge($attributes);
         }
 
-        if ($content !== null) {
-            $this->setContent($content);
-        }
+        $this->setHtmlContent(...$content);
     }
 
     /**
      * Create a new HTML element from the given tag, attributes and content
      *
-     * @param string                 $tag        The tag for the element
-     * @param Attributes|array       $attributes The HTML attributes for the element
-     * @param ValidHtml|string|array $content    The content of the element
+     * @param string $tag        The tag for the element
+     * @param mixed  $attributes The HTML attributes for the element
+     * @param mixed  $content    The content of the element
      *
      * @return static
      */
     public static function create($tag, $attributes = null, $content = null)
     {
-        return new static($tag, $attributes, $content);
+        return new static($tag, Attributes::wantAttributes($attributes), ...Html::wantHtmlList($content));
     }
 }