lagdo / ui-builder

src/Component/HtmlElement.php

<?php

namespace Lagdo\UiBuilder\Component;

use Lagdo\UiBuilder\Builder\Engine\Engine;
use Lagdo\UiBuilder\Component\Html\Element;

use function array_filter;
use function array_keys;
use function htmlspecialchars;
use function implode;
use function is_bool;
use function is_numeric;
use function is_string;
use function sprintf;
use function trim;

/**
 * The HTML tags finally generated for a given component
 *
 * @method static setId(string $id, bool $escape = true)
 * @method static setClass(string $class, bool $escape = true)
 * @method static setFor(string $for, bool $escape = true)
 * @method static setName(string $name, bool $escape = true)
 * @method static setValue(string $value, bool $escape = true)
 * @method static setType(string $type, bool $escape = true)
 * @method static setTitle(string $type, bool $escape = true)
 * @method static setStyle(string $type, bool $escape = true)
 */
class HtmlElement extends Element
{
    /**
     * @var bool
     */
    private $isShort = false;

    /**
     * @var bool
     */
    private $isOpened = false;

    /**
     * @var array
     */
    private $attributes = [];

    /**
     * @var array
     */
    private $escapes = [];

    /**
     * @var array
     */
    private $baseClasses = []; // The component classes.

    /**
     * @var array
     */
    private $classes = []; // The additional classes.

    /**
     * @var array<Element>
     */
    private $children = [];

    /**
     * @param Engine $engine
     * @param string $tag
     * @param array $attributes
     */
    public function __construct(private Engine $engine, private string $tag, array $attributes = [])
    {
        $this->setAttributes($attributes);
    }

    /**
     * @param string $method
     * @param array $arguments
     *
     * @return static
     */
    public function __call(string $method, array $arguments): static
    {
        $this->engine->callElementHelper($this, $method, $arguments);
        return $this;
    }

    /**
     * @return string
     */
    public function tag(): string
    {
        return $this->tag;
    }

    /**
     * @param string $tag
     *
     * @return void
     */
    public function setTag(string $tag): void
    {
        $this->tag = $tag;
    }

    /**
     * @param array<Element> $children
     *
     * @return void
     */
    public function setChildren(array $children): void
    {
        $this->children = $children;
    }

    /**
     * @param array<Element> $children
     *
     * @return void
     */
    public function addChildren(array $children): void
    {
        $this->children = [...$this->children, ...$children];

It seems like array($this->children, $children) of type array<integer,Lagdo\UiBuilder\Component\Html\Element[]> is incompatible with the declared type Lagdo\UiBuilder\Component\Html\Element[] of property $children.

    }

    /**
     * @param Element $child
     *
     * @return void
     */
    public function addChild(Element $child): void
    {
        $this->children[] = $child;
    }

    /**
     * @param string $class
     *
     * @return void
     */
    public function addBaseClass(string $class): void
    {
        $this->baseClasses[] = trim($class);
    }

    /**
     * @param int $index
     * @param string $class
     *
     * @return void
     */
    public function setBaseClass(int $index, string $class): void
    {
       $this->baseClasses[$index] = trim($class);
    }

    /**
     * @param string $class
     *
     * @return void
     */
    public function addClass(string $class): void
    {
        $this->classes[trim($class)] = true;
    }

    /**
     * @param string $class
     *
     * @return void
     */
    public function setClass(string $class): void
    {
        // Actually appends the class.
        $this->addClass($class);
    }

    /**
     * @param string $class
     *
     * @return void
     */
    public function removeClass(string $class): void
    {
        $this->classes[trim($class)] = false;
    }

    /**
     * @param string $class
     *
     * @return bool
     */
    public function hasClass(string $class): bool
    {
        return ($this->classes[trim($class)] ?? false) === true;
    }

    /**
     * @param bool $isShort
     *
     * @return void
     */
    public function setShort($isShort): void
    {
        $this->isShort = $isShort;
    }

    /**
     * @param bool $isOpened
     *
     * @return void
     */
    public function setOpened($isOpened): void
    {
        $this->isOpened = $isOpened;
    }

    /**
     * @param string $name
     * @param string|bool $value
     * @param bool $escape
     *
     * @return static
     */
    public function setAttribute(string $name, string|bool $value = true, bool $escape = true): void
    {
        $this->attributes[$name] = $value;
        $this->escapes[$name] = $escape;
    }

    /**
     * @param array $attributes
     * @param bool $escape
     *
     * @return void
     */
    public function setAttributes(array $attributes, bool $escape = true): void
    {
        foreach ($attributes as $name => $value) {
            switch (true) {
            case is_numeric($name):
                $this->setAttribute($value);
                break;
            case is_string($value):
            case is_bool($value):
                $this->setAttribute($name, $value, $escape);
                break;
            default: // Any other values are ignored.
            }
        }
    }

    /**
     * @param string $name
     *
     * @return bool
     */
    public function hasAttribute(string $name): bool
    {
        return isset($this->attributes[$name]) && $this->attributes[$name] !== false;
    }

    /**
     * @param string $name
     *
     * @return string|bool
     */
    public function getAttribute(string $name): string|bool
    {
        return $this->attributes[$name] ?? false;
    }

    /**
     * @param string $name
     *
     * @return void
     */
    public function removeAttribute(string $name): void
    {
        $this->attributes[$name] = false;
    }

    /**
     * @return string
     */
    private function renderAttributes(): string
    {
        // Merge the classes.
        $classes = array_keys(array_filter($this->classes, fn($active) => $active === true));
        $classes = [...$this->baseClasses, ...$classes];
        if (isset($this->attributes['class'])) {
            $classes[] = $this->attributes['class'];
        }
        if (($class = trim(implode(' ', $classes))) !== '') {
            $this->attributes['class'] = $class;
        }

        $attributes = [];
        foreach ($this->attributes as $name => $value) {
            // Attributes with false as value are ignored.
            if ($value !== false) {
                $name = $this->escape($name);
                if ($value === true) {
                    $attributes[] = $name;
                    continue;
                }

                if (($this->escapes[$name] ?? true) === true) {
                    $value = $this->escape($value);
                }
                $attributes[] = "$name=\"$value\"";
            }
        }

        return !$attributes ? '' : ' ' . implode(' ', $attributes);
    }

    /**
     * @return string
     */
    private function renderShort(): string
    {
        return sprintf('<%s%s />', $this->tag, $this->renderAttributes());
    }

    /**
     * @return string
     */
    private function renderOpened(): string
    {
        return sprintf('<%s%s>', $this->tag, $this->renderAttributes());
    }

    /**
     * @return string
     */
    private function renderTag(): string
    {
        $children = implode('', $this->children);
        return sprintf('%s%s</%s>', $this->renderOpened(), $children, $this->tag);
    }

    /**
     * @param $value
     *
     * @return string
     */
    private function escape($value): string
    {
        return htmlspecialchars($value, ENT_COMPAT);
    }

    /**
     * @inheritDoc
     */
    protected function render(): string
    {
        return match(true) {
            $this->isShort => $this->renderShort(),
            $this->isOpened => $this->renderOpened(),
            default => $this->renderTag(),
        };
    }
}