AbstractField::run() - Code Metrics - Inspection of "Big refactoring of field widgets" - yiisoft/form - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#159)

by Sergei
created 2022-01-06 17:52 UTC
AbstractField::run() A

↳ Parent: AbstractField
Complexity

Conditions	3
Paths	3
Size

Total Lines	16
Code Lines	10
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	11
CRAP Score	3
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	3
eloc	10
nc	3
nop	0
dl	0
loc	16
ccs	11
cts	11
cp	1
crap	3
rs	9.9332
c	1
b	0
f	0
<?php

declare(strict_types=1);

namespace Yiisoft\Form\Field\Base;

use InvalidArgumentException;
use Yiisoft\Form\Field\Part\Error;
use Yiisoft\Form\Field\Part\Hint;
use Yiisoft\Form\Field\Part\Label;
use Yiisoft\Form\Helper\HtmlForm;
use Yiisoft\Html\Tag\CustomTag;
use Yiisoft\Widget\Widget;

use function in_array;

/**
 * @psalm-import-type HtmlAttributes from \Yiisoft\Html\Html
 */
abstract class AbstractField extends Widget
{
    use FormAttributeTrait;

    /**
     * @psalm-var non-empty-string
     */
    private string $containerTag = 'div';
    private array $containerTagAttributes = [];
    private bool $useContainer = true;

    private string $template = "{label}\n{input}\n{hint}\n{error}";

    private ?string $inputId = null;
    private ?string $inputIdFromTag = null;
    private bool $setInputIdAttribute = true;

    /**
     * @psalm-var HtmlAttributes
     */
    private array $formElementTagAttributes = [];

    private array $labelConfig = [];
    private array $hintConfig = [];
    private array $errorConfig = [];

    /**
     * @return static
     */
    final public function containerTag(string $tag): self
    {
        if ($tag === '') {
            throw new InvalidArgumentException('Tag name cannot be empty.');
        }

        $new = clone $this;
        $new->containerTag = $tag;
        return $new;
    }

    /**
     * @return static
     */
    final public function containerTagAttributes(array $attributes): self
    {
        $new = clone $this;
        $new->containerTagAttributes = $attributes;
        return $new;
    }

    final public function useContainer(bool $use): self
    {
        $new = clone $this;
        $new->useContainer = $use;
        return $new;
    }

    /**
     * Set layout template for render a field.
     *
     * @param string $template
     *
     * @return static
     */
    final public function template(string $template): self
    {
        $new = clone $this;
        $new->template = $template;
        return $new;
    }

    /**
     * @return static
     */
    final public function inputId(?string $inputId): self
    {
        $new = clone $this;
        $new->inputId = $inputId;
        return $new;
    }

    /**
     * @return static
     */
    final public function setInputIdAttribute(bool $value): self
    {
        $new = clone $this;
        $new->setInputIdAttribute = $value;
        return $new;
    }

    /**
     * @psalm-param HtmlAttributes $attributes
     */
    final public function formElementTagAttributes(array $attributes): self
    {
        $new = clone $this;
        $new->formElementTagAttributes = $attributes;
        return $new;
    }

    /**
     * @return static
     */
    final public function labelConfig(array $config): self
    {
        $new = clone $this;
        $new->labelConfig = $config;
        return $new;
    }

    /**
     * @return static
     */
    final public function label(?string $content): self
    {
        $new = clone $this;
        $new->labelConfig['content()'] = [$content];
        return $new;
    }

    /**
     * @return static
     */
    final public function hintConfig(array $config): self
    {
        $new = clone $this;
        $new->hintConfig = $config;
        return $new;
    }

    final public function hint(?string $content): self
    {
        $new = clone $this;
        $new->hintConfig['content()'] = [$content];
        return $new;
    }

    /**
     * @return static
     */
    final public function errorConfig(array $config): self
    {
        $new = clone $this;
        $new->errorConfig = $config;
        return $new;
    }

    final protected function getInputName(): string
    {
        return HtmlForm::getInputName($this->getFormModel(), $this->attribute);
    }

    /**
     * @psalm-return HtmlAttributes
     */
    final protected function getFormElementTagAttributes(): array
    {
        $attributes = $this->formElementTagAttributes;

        $this->prepareIdInFormElementTagAttributes($attributes);

        if ($this->isUsePlaceholder()) {
            /** @psalm-suppress UndefinedMethod */
            $this->preparePlaceholderInFormElementTagAttributes($attributes);
                   preparePlaceholderInFormElementTagAttributes($attributes);
        }

        /** @psalm-var HtmlAttributes $attributes */

        return $attributes;
    }

    final protected function prepareIdInFormElementTagAttributes(array &$attributes): void
    {
        /** @var mixed $idFromTag */
        $idFromTag = $attributes['id'] ?? null;
        if ($idFromTag !== null) {
            $this->inputIdFromTag = (string) $idFromTag;
        }

        if ($this->setInputIdAttribute) {
            if ($this->inputId !== null) {
                $attributes['id'] = $this->inputId;
            } elseif ($idFromTag === null) {
                $attributes['id'] = $this->getInputId();
            }
        }
    }

    final protected function run(): string
    {
        if (!$this->useContainer) {
            return $this->generateContent();
        }

        $containerTag = CustomTag::name($this->containerTag);
        if ($this->containerTagAttributes !== []) {
            $containerTag = $containerTag->attributes($this->containerTagAttributes);
        }

        return $containerTag->open()
            . PHP_EOL
            . $this->generateContent()
            . PHP_EOL
            . $containerTag->close();
    }

    abstract protected function generateInput(): string;

    private function generateContent(): string
    {
        $parts = [
            '{input}' => $this->generateInput(),
            '{label}' => $this->generateLabel(),
            '{hint}' => $this->generateHint(),
            '{error}' => $this->generateError(),
        ];

        return preg_replace('/^\h*\v+/m', '', trim(strtr($this->template, $parts)));
    }

    private function generateLabel(): string
    {
        $label = Label::widget($this->labelConfig)
            ->attribute($this->getFormModel(), $this->attribute);
            ->/** @scrutinizer ignore-call */ attribute($this->getFormModel(), $this->attribute);

        if ($this->setInputIdAttribute === false) {
            $label = $label->useInputIdAttribute(false);
        }

        if ($this->inputId !== null) {
            $label = $label->forId($this->inputId);
        } elseif ($this->inputIdFromTag !== null) {
            $label = $label->forId($this->inputIdFromTag);
        }

        return $label->render();
    }

    private function generateHint(): string
    {
        return Hint::widget($this->hintConfig)
            ->attribute($this->getFormModel(), $this->attribute)
            ->render();
    }

    private function generateError(): string
    {
        return Error::widget($this->errorConfig)
            ->attribute($this->getFormModel(), $this->attribute)
            ->render();
    }

    private function isUsePlaceholder(): bool
    {
        $traits = class_uses($this);
        return in_array(PlaceholderTrait::class, $traits, true);
    }
}

yiisoft / form

Pull Request — master (#159)

AbstractField::run() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
