Enjoyzz / forms

src/Traits/Container.php

<?php

declare(strict_types=1);

namespace Enjoys\Forms\Traits;

use Enjoys\Forms\Element;
use Enjoys\Forms\Elements;
use Enjoys\Forms\Interfaces\CaptchaInterface;
use Enjoys\Forms\Interfaces\ElementInterface;
use Webmozart\Assert\Assert;

/**
 * @method Elements\Text text(string $name, null|string $label = null)
 * @method Elements\Hidden hidden(string $name, null|string $value = null)
 * @method Elements\Password password(string $name, null|string $label = null)
 * @method Elements\Submit submit(null|string $name = null, null|string $title = null)
 * @method Elements\Header header(null|string $title = null)
 * @method Elements\Color color(string $name, null|string $label = null)
 * @method Elements\Date date(string $name, null|string $label = null)
 * @method Elements\Datetime datetime(string $name, null|string $label = null)
 * @method Elements\Datetimelocal datetimelocal(string $name, null|string $label = null)
 * @method Elements\Email email(string $name, null|string $label = null)
 * @method Elements\Number number(string $name, null|string $label = null)
 * @method Elements\Range range(string $name, null|string $label = null)
 * @method Elements\Search search(string $name, null|string $label = null)
 * @method Elements\Tel tel(string $name, null|string $label = null)
 * @method Elements\Time time(string $name, null|string $label = null)
 * @method Elements\Url url(string $name, null|string $label = null)
 * @method Elements\Month month(string $name, null|string $label = null)
 * @method Elements\Week week(string $name, null|string $label = null)
 * @method Elements\Textarea textarea(string $name, null|string $label = null)
 * @method Elements\Select select(string $name, null|string $label = null)
 * @method Elements\Button button(string $name, null|string $title = null)
 * @method Elements\Datalist datalist(string $name, null|string $label = null)
 * @method Elements\Checkbox checkbox(string $name, null|string $label = null)
 * @method Elements\Image image(string $name, null|string $src = null)
 * @method Elements\Radio radio(string $name, null|string $title = null)
 * @method Elements\Reset reset(string $name, null|string $title = null)
 * @method Elements\Captcha captcha(CaptchaInterface $captcha)
 * @method Elements\Group group(null|string $title = null)
 * @method Elements\File file(string $name, null|string $label = null)
 * @method Elements\Csrf csrf()
 * @method Elements\Html html(string $html)
 *
 * @author Enjoys
 */
trait Container
{
    /**
     * @var Element[]
     */
    private array $elements = [];


    public function __call(string $name, array $arguments): Element
    {
        $className = '\Enjoys\\Forms\\Elements\\' . ucfirst($name);
        Assert::classExists($className);
        /** @var class-string<ElementInterface> $className */
        $element = new $className(...$arguments);

        /** @var Element $element */
        $this->addElement($element);
        return $element;
    }

    /**
     * @psalm-suppress MixedPropertyTypeCoercion
     */
    public function addElement(Element $element, ?string $before = null, ?string $after = null): static
    {
        $element->setRequest($this->getRequest());

$this->getRequest() of type Enjoys\Forms\Element is incompatible with the type Psr\Http\Message\ServerRequestInterface|null expected by parameter $request of Enjoys\Forms\Element::setRequest().

The method getRequest() does not exist on Enjoys\Forms\Traits\Container. Since you implemented __call, consider adding a @method annotation.

        if ($element->prepare() === true) {

The condition $element->prepare() === true is always false.

            return $this;
        }


        if (
            $element->isAllowSameNames() === false
            && false !== $key = $this->getElementKey($element)
        ) {
            $this->elements[$key] = $element;
            return $this;
        }

        if ($after !== null) {
            $this->elements = array_insert_after($this->elements, $this->getElementKey($after), $element);
            return $this;
        }

        if ($before !== null) {
            $this->elements = array_insert_before($this->elements, $this->getElementKey($before), $element);
            return $this;
        }

        $this->elements[] = $element;
        return $this;
    }


    /**
     * @return Element[]
     */
    public function getElements(): array
    {
        return $this->elements;
    }

    public function getElement(string $name): ?Element
    {
        if (false !== $key = $this->getElementKey($name)) {
            return $this->elements[$key];
        }

        return null;
    }

    public function removeElement(?Element $element = null): static
    {
        if (null === $element) {
            return $this;
        }

        if (false !== $key = $this->getElementKey($element)) {
            unset($this->elements[$key]);
        }
        return $this;
    }

    private function getElementKey(string|Element $element): int|false
    {
        $name = ($element instanceof Element) ? $element->getName() : $element;

        foreach ($this->elements as $key => $el) {
            if ($el->getName() === $name) {
                /** @var int $key */
                return $key;
            }
        }
        return false;
    }
}