kalanis\kw_forms\Controls\TWrappers

Complexity

Total Complexity

25

Size/Duplication

Total Lines	210
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	wrapIt()	0	15	4
A	wrappersError()	0	3	1
A	addWrapperLabel()	0	3	1
A	wrappers()	0	3	1
A	wrappersChildren()	0	3	1
A	addWrapperChild()	0	3	1
A	wrappersLabel()	0	3	1
A	addWrapperChildren()	0	3	1
A	resetWrappers()	0	9	1
A	addWrapperErrors()	0	3	1
A	addWrapper()	0	3	1
A	wrappersInput()	0	3	1
A	addWrapperInput()	0	3	1
A	addWrapperToStack()	0	14	6
A	wrappersErrors()	0	3	1
A	addWrapperError()	0	3	1
A	wrappersChild()	0	3	1

<?php

namespace kalanis\kw_forms\Controls;


use kalanis\kw_forms\Exceptions\RenderException;
use kalanis\kw_templates\HtmlElement;
use kalanis\kw_templates\Interfaces\IHtmlElement;


/**
 * Wrapper trait for form inputs
 * @author Petr Plsek
 * @author Adam Dornak
 * @author Petr Bolehovsky
 */
trait TWrappers
{
    use TTemplateError;

    /** @var IHtmlElement[] */
    protected array $wrappers = [];
    /** @var IHtmlElement[] */
    protected array $wrappersLabel = [];
    /** @var IHtmlElement[] */
    protected array $wrappersInput = [];
    /** @var IHtmlElement[] */
    protected array $wrappersChild = [];
    /** @var IHtmlElement[] */
    protected array $wrappersChildren = [];
    /** @var IHtmlElement[] */
    protected array $wrappersError = [];
    /** @var IHtmlElement[] */
    protected array $wrappersErrors = [];
    protected string $errorMustBeAnInstance = 'Wrapper must be an instance of IHtmlElement or array of its instances';

    /**
     * Pack string into preset html element
     * @param string $string
     * @param IHtmlElement|IHtmlElement[] $wrappers
     * @throws RenderException
     * @return string
     */
    protected function wrapIt(string $string, $wrappers): string
    {
        $return = $string;
        if (is_array($wrappers)) {
            foreach ($wrappers as $wrapper) {
                $return = $this->wrapIt($return, $wrapper);
            }
        } elseif ($wrappers instanceof IHtmlElement) {

$wrappers is always a sub-type of kalanis\kw_templates\Interfaces\IHtmlElement.

            $wrappers->addChild($return);
            $return = $wrappers->render();
        } else {
            throw new RenderException($this->errorMustBeAnInstance);
        }

        return $return;
    }

    /**
     * Add wrapper into predefined stack
     * @param IHtmlElement[] $stack
     * @param IHtmlElement|IHtmlElement[]|string|string[] $wrapper
     * @param array<string, string> $attributes
     */
    protected function addWrapperToStack(array &$stack, $wrapper, array $attributes = []): void
    {
        if (is_array($wrapper)) {
            foreach ($wrapper as $_wrapper) {
                $this->addWrapperToStack($stack, $_wrapper);
            }
        } else {
            if (!($wrapper instanceof IHtmlElement)) {
                $wrapper = HtmlElement::init($wrapper, $attributes);
            } elseif (!empty($attributes)) {
                $wrapper->setAttributes($attributes);
            }
            if (!in_array($wrapper, $stack)) {
                $stack[] = $wrapper;
            }
        }
    }

    /**
     * Add wrapper for the whole object
     * @param string|string[]|IHtmlElement|IHtmlElement[] $wrapper
     * @param array<string, string> $attributes
     * @see AControl::render
     */
    public function addWrapper($wrapper, array $attributes = []): void
    {
        $this->addWrapperToStack($this->wrappers, $wrapper, $attributes);
    }

    /**
     * Add wrapper for each child
     * @param string|string[]|IHtmlElement|IHtmlElement[] $wrapper
     * @param array<string, string> $attributes
     * @see AControl::renderChild
     */
    public function addWrapperChild($wrapper, array $attributes = []): void
    {
        $this->addWrapperToStack($this->wrappersChild, $wrapper, $attributes);
    }

    /**
     * Add wrapper for labels
     * @param string|string[]|IHtmlElement|IHtmlElement[] $wrapper
     * @param array<string, string> $attributes
     * @see AControl::renderLabel
     */
    public function addWrapperLabel($wrapper, array $attributes = []): void
    {
        $this->addWrapperToStack($this->wrappersLabel, $wrapper, $attributes);
    }

    /**
     * Add wrapper for inputs
     * @param string|string[]|IHtmlElement|IHtmlElement[] $wrapper
     * @param array<string, string> $attributes
     * @see AControl::renderInput
     */
    public function addWrapperInput($wrapper, array $attributes = []): void
    {
        $this->addWrapperToStack($this->wrappersInput, $wrapper, $attributes);
    }

    /**
     * Add wrapper for content of children
     * @param string|string[]|IHtmlElement|IHtmlElement[] $wrapper
     * @param array<string, string> $attributes
     * @see AControl::renderChildren
     */
    public function addWrapperChildren($wrapper, array $attributes = []): void
    {
        $this->addWrapperToStack($this->wrappersChildren, $wrapper, $attributes);
    }

    /**
     * Add wrapper for error messages
     * @param string|string[]|IHtmlElement|IHtmlElement[] $wrapper
     * @param array<string, string> $attributes
     * @see AControl::renderErrors
     */
    public function addWrapperError($wrapper, array $attributes = []): void
    {
        $this->addWrapperToStack($this->wrappersError, $wrapper, $attributes);
    }

    /**
     * Add wrapper for error messages
     * @param string|string[]|IHtmlElement|IHtmlElement[] $wrapper
     * @param array<string, string> $attributes
     * @see AControl::renderErrors
     */
    public function addWrapperErrors($wrapper, array $attributes = []): void
    {
        $this->addWrapperToStack($this->wrappersErrors, $wrapper, $attributes);
    }

    /**
     * @return IHtmlElement[]
     */
    public function wrappers(): array
    {
        return $this->wrappers;
    }

    /**
     * @return IHtmlElement[]
     */
    public function wrappersLabel(): array
    {
        return $this->wrappersLabel;
    }

    /**
     * @return IHtmlElement[]
     */
    public function wrappersInput(): array
    {
        return $this->wrappersInput;
    }

    /**
     * @return IHtmlElement[]
     */
    public function wrappersChild(): array
    {
        return $this->wrappersChild;
    }

    /**
     * @return IHtmlElement[]
     */
    public function wrappersChildren(): array
    {
        return $this->wrappersChildren;
    }

    /**
     * @return IHtmlElement[]
     */
    public function wrappersError(): array
    {
        return $this->wrappersError;
    }

    /**
     * @return IHtmlElement[]
     */
    public function wrappersErrors(): array
    {
        return $this->wrappersErrors;
    }

    public function resetWrappers(): void
    {
        $this->wrappers = [];
        $this->wrappersLabel = [];
        $this->wrappersInput = [];
        $this->wrappersChild = [];
        $this->wrappersChildren = [];
        $this->wrappersError = [];
        $this->wrappersErrors = [];
    }
}