Field::renderField() - Code Metrics - Inspection of "Enhacements." - yiisoft/form - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed
Pull Request — master (#160)

by Wilmer
created 2022-01-06 20:14 UTC
Field::renderField() A

↳ Parent: Field
Complexity

Conditions	6
Paths	24
Size

Total Lines	24
Code Lines	12
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	13
CRAP Score	6
Importance

Changes
Metric	Value
cc	6
eloc	12
c	0
b	0
f	0
nc	24
nop	0
dl	0
loc	24
ccs	13
cts	13
cp	1
crap	6
rs	9.2222
<?php

declare(strict_types=1);

namespace Yiisoft\Form\Widget;

use Yiisoft\Arrays\ArrayHelper;
use Yiisoft\Definitions\Exception\CircularReferenceException;
use Yiisoft\Definitions\Exception\InvalidConfigException;
use Yiisoft\Definitions\Exception\NotInstantiableException;
use Yiisoft\Factory\NotFoundException;
use Yiisoft\Form\FormModelInterface;
use Yiisoft\Form\Widget\Attribute\ButtonAttributes;
use Yiisoft\Form\Widget\Attribute\FieldAttributes;
use Yiisoft\Form\Widget\Attribute\InputAttributes;
use Yiisoft\Form\Widget\Attribute\PlaceholderInterface;
use Yiisoft\Form\Widget\Attribute\WidgetAttributes;
use Yiisoft\Form\Widget\FieldPart\Error;
use Yiisoft\Form\Widget\FieldPart\Hint;
use Yiisoft\Form\Widget\FieldPart\Label;
use Yiisoft\Html\Html;
use Yiisoft\Html\Tag\Div;
use Yiisoft\Widget\Widget;

use function strtr;

/**
 * Renders the field widget along with label and hint tag (if any) according to template.
 *
 * @psalm-suppress MissingConstructor
 */
final class Field extends FieldAttributes
{
    /** @psalm-var ButtonAttributes[] */
    private array $buttons = [];
    private array $containerAttributes = [];

    private WidgetAttributes $widget;

    /**
     * Renders a checkbox.
     *
     * This method will generate the `checked` tag attribute according to the model attribute value.
     *
     * @param FormModelInterface $formModel The model object.
     * @param string $attribute The attribute name or expression.
     * @param array $config The configuration array for widget factory.
     * Available methods:
     * [
     *     'enclosedByLabel()' => [false],
     *     'label()' => ['test-text-label'],
     *     'labelAttributes()' => [['class' => 'test-class']],
     *     'uncheckValue()' => ['0'],
     * ]
     *
     * @throws CircularReferenceException|InvalidConfigException|NotFoundException|NotInstantiableException
     *
     * @return static the field widget instance.
     */
    public function checkbox(FormModelInterface $formModel, string $attribute, array $config = []): self
    {
        $new = clone $this;

        /** @var array */
        $enclosedByLabel = $config['enclosedByLabel()'] ?? [true];

        if ($enclosedByLabel === [true]) {
            $new->parts['{label}'] = '';
        }

        $new->widget = Checkbox::widget($config)->for($formModel, $attribute);
        $new->widget = Checkbox::widget($config)->/** @scrutinizer ignore-call */ for($formModel, $attribute);
        return $new;
    }

    /**
     * Renders a list of checkboxes.
     *
     * A checkbox list allows multiple selection, As a result, the corresponding submitted value is an array.
     *
     * The selection of the checkbox list is taken from the value of the model attribute.
     *
     * @param FormModelInterface $formModel The model object.
     * @param string $attribute The attribute name or expression.
     * @param array $config the configuration array for widget factory.
     * Available methods:
     * [
     *     'containerAttributes()' => [['class' => 'test-class']],
     *     'containerTag()' => ['span'],
     *     'individualItemsAttributes()' => [[1 => ['disabled' => true], 2 => ['class' => 'test-class']],
     *     'items()' => [[1 => 'Female', 2 => 'Male']],
     *     'itemsAttributes()' => [['disabled' => true],
     *     'itemsFormatter()' => [
     *         static function (CheckboxItem $item) {
     *             return $item->checked
     *                 ? "<label><input type='checkbox' name='$item->name' value='$item->value' checked> $item->label</label>"
     *                 : "<label><input type='checkbox' name='$item->name' value='$item->value'> $item->label</label>";
     *         },
     *     ],
     *     'itemsFromValues()' => [[1 => 'Female', 2 => 'Male']],
     *     'separator()' => ['&#9866;'],
     * ]
     *
     * @throws CircularReferenceException|InvalidConfigException|NotFoundException|NotInstantiableException
     *
     * @return static the field widget instance.
     */
    public function checkboxList(FormModelInterface $formModel, string $attribute, array $config = []): self
    {
        $new = clone $this;
        $new->widget = CheckboxList::widget($config)->for($formModel, $attribute);
        return $new;
    }

    /**
     * Renders a date widget.
     *
     * @param FormModelInterface $formModel The model object.
     * @param string $attribute The attribute name or expression.
     * @param array $config the configuration array for widget factory.
     *
     * @throws CircularReferenceException|InvalidConfigException|NotFoundException|NotInstantiableException
     *
     * @return static the field widget instance.
     */
    public function date(FormModelInterface $formModel, string $attribute, array $config = []): self
    {
        $new = clone $this;
        $new->widget = Date::widget($config)->for($formModel, $attribute);
        return $new;
    }

    /**
     * Renders a date time widget.
     *
     * @param FormModelInterface $formModel The model object.
     * @param string $attribute The attribute name or expression.
     * @param array $config the configuration array for widget factory.
     *
     * @throws CircularReferenceException|InvalidConfigException|NotFoundException|NotInstantiableException
     *
     * @return static the field widget instance.
     */
    public function dateTime(FormModelInterface $formModel, string $attribute, array $config = []): self
    {
        $new = clone $this;
        $new->widget = DateTime::widget($config)->for($formModel, $attribute);
        return $new;
    }

    /**
     * Renders a date time local widget.
     *
     * @param FormModelInterface $formModel The model object.
     * @param string $attribute The attribute name or expression.
     * @param array $config the configuration array for widget factory.
     *
     * @throws CircularReferenceException|InvalidConfigException|NotFoundException|NotInstantiableException
     *
     * @return static the field widget instance.
     */
    public function dateTimeLocal(FormModelInterface $formModel, string $attribute, array $config = []): self
    {
        $new = clone $this;
        $new->widget = DateTimeLocal::widget($config)->for($formModel, $attribute);
        return $new;
    }

    /**
     * Renders a email widget.
     *
     * @param FormModelInterface $formModel The model object.
     * @param string $attribute The attribute name or expression.
     * @param array $config the configuration array for widget factory.
     *
     * @throws CircularReferenceException|InvalidConfigException|NotFoundException|NotInstantiableException
     *
     * @return static the field widget instance.
     */
    public function email(FormModelInterface $formModel, string $attribute, array $config = []): self
    {
        $new = clone $this;
        $new->widget = Email::widget($config)->for($formModel, $attribute);
        return $new;
    }

    /**
     * Renders a file widget.
     *
     * @param FormModelInterface $formModel The model object.
     * @param string $attribute The attribute name or expression.
     * @param array $config the configuration array for widget factory.
     * Available methods:
     * [
     *     'hiddenAttributes()' => [['id' => 'test-id']],
     *     'uncheckValue()' => ['0'],
     *
     * ]
     *
     * @throws CircularReferenceException|InvalidConfigException|NotFoundException|NotInstantiableException
     *
     * @return static the field widget instance.
     */
    public function file(FormModelInterface $formModel, string $attribute, array $config = []): self
    {
        $new = clone $this;
        $new->widget = File::widget($config)->for($formModel, $attribute);
        return $new;
    }

    /**
     * Renders a hidden widget.
     *
     * @param FormModelInterface $formModel The model object.
     * @param string $attribute The attribute name or expression.
     * @param array $config the configuration array for widget factory.
     *
     * @throws CircularReferenceException|InvalidConfigException|NotFoundException|NotInstantiableException
     *
     * @return static the field widget instance.
     */
    public function hidden(FormModelInterface $formModel, string $attribute, array $config = []): self
    {
        $new = clone $this;
        $new->parts['{label}'] = '';
        $new->parts['{hint}'] = '';
        $new->parts['{error}'] = '';
        $new->widget = Hidden::widget($config)->for($formModel, $attribute);
        return $new;
    }

    /**
     * Renders an image widget.
     *
     * @param array $config the configuration array for widget factory.
     * @param array $attributes the HTML attributes for the widget.
     * Most used attributes:
     * [
     *     'alt' => 'test-alt',
     *     'height' => '100%',
     *     'src' => 'test-src',
     *     'width' => '100%',
     * ]
     *
     * @throws CircularReferenceException|InvalidConfigException|NotFoundException|NotInstantiableException
     *
     * @return static the field object itself.
     *
     * @psalm-suppress InvalidPropertyAssignmentValue
     */
    public function image(array $config = [], array $attributes = []): self
    {
        $new = clone $this;
        $new->parts['{label}'] = '';
        $new->parts['{hint}'] = '';
        $new->parts['{error}'] = '';
        $new->widget = Image::widget($config)->attributes($attributes);
        return $new;
    }

    /**
     * Renders a number widget.
     *
     * @param FormModelInterface $formModel The model object.
     * @param string $attribute The attribute name or expression.
     * @param array $config the configuration array for widget factory.
     *
     * @throws CircularReferenceException|InvalidConfigException|NotFoundException|NotInstantiableException
     *
     * @return static the field object itself.
     */
    public function number(FormModelInterface $formModel, string $attribute, array $config = []): self
    {
        $new = clone $this;
        $new->widget = Number::widget($config)->for($formModel, $attribute);
        return $new;
    }

    /**
     * Renders a password widget.
     *
     * @param FormModelInterface $formModel The model object.
     * @param string $attribute The attribute name or expression.
     * @param array $config the configuration array for widget factory.
     *
     * @throws CircularReferenceException|InvalidConfigException|NotFoundException|NotInstantiableException
     *
     * @return static the field object itself.
     */
    public function password(FormModelInterface $formModel, string $attribute, array $config = []): self
    {
        $new = clone $this;
        $new->widget = Password::widget($config)->for($formModel, $attribute);
        return $new;
    }

    /**
     * Renders a radio widget.
     *
     * @param FormModelInterface $formModel The model object.
     * @param string $attribute The attribute name or expression.
     * @param array $config the configuration array for widget factory.
     * Available methods:
     * [
     *     'enclosedByLabel()' => [false],
     *     'label()' => ['Email:'],
     *     'labelAttributes()' => [['class' => 'test-class']]
     *     'uncheckValue()' => ['0'],
     * ]
     *
     * @throws CircularReferenceException|InvalidConfigException|NotFoundException|NotInstantiableException
     *
     * @return static the field object itself.
     */
    public function radio(FormModelInterface $formModel, string $attribute, array $config = []): self
    {
        $new = clone $this;

        /** @var array */
        $enclosedByLabel = $config['enclosedByLabel()'] ?? [true];

        if ($enclosedByLabel === [true]) {
            $new->parts['{label}'] = '';
        }

        $new->widget = Radio::widget($config)->for($formModel, $attribute);
        return $new;
    }

    /**
     * Renders a radio list widget.
     *
     * @param FormModelInterface $formModel The model object.
     * @param string $attribute The attribute name or expression.
     * @param array $config the configuration array for widget factory.
     * Available methods:
     * [
     *     'containerAttributes()' => [['class' => 'test-class']],
     *     'containerTag()' => ['span'],
     *     'items()' => [[1 => 'Female', 2 => 'Male']],
     *     'itemsAttributes()' => [['class' => 'test-class']],
     *     'individualItemsAttributes()' => [[1 => ['disabled' => true], 2 => ['class' => 'test-class']]],
     *     'itemsFormatter()' => [
     *         static function (RadioItem $item) {
     *             return $item->checked
     *                 ? "<label><input type='checkbox' name='$item->name' value='$item->value' checked> $item->label</label>"
     *                 : "<label><input type='checkbox' name='$item->name' value='$item->value'> $item->label</label>";
     *         },
     *     ],
     *     'itemsFromValues()' => [[1 => 'Female', 2 => 'Male']],
     *     'separator()' => [PHP_EOL],
     *     'uncheckValue()' => ['0'],
     * ]
     *
     * @throws CircularReferenceException|InvalidConfigException|NotFoundException|NotInstantiableException
     *
     * @return static the field object itself.
     */
    public function radioList(FormModelInterface $formModel, string $attribute, array $config = []): self
    {
        $new = clone $this;
        $new->widget = RadioList::widget($config)->for($formModel, $attribute);
        return $new;
    }

    /**
     * Renders a range widget.
     *
     * @param FormModelInterface $formModel The model object.
     * @param string $attribute The attribute name or expression.
     * @param array $config the configuration array for widget factory.
     * Available methods:
     * [
     *     'outputTag()' => ['p'],
     *     'outputAttributes()' => [['class' => 'test-class']],
     * ]
     *
     * @throws CircularReferenceException|InvalidConfigException|NotFoundException|NotInstantiableException
     *
     * @return static the field object itself.
     */
    public function range(FormModelInterface $formModel, string $attribute, array $config = []): self
    {
        $new = clone $this;
        $new->widget = Range::widget($config)->for($formModel, $attribute);
        return $new;
    }

    /**
     * Renders a reset button widget.
     *
     * @param array $config the configuration array for widget factory.
     * @param array $attributes the HTML attributes for the widget.
     *
     * @throws CircularReferenceException|InvalidConfigException|NotFoundException|NotInstantiableException
     *
     * @return static the field object itself.
     */
    public function resetButton(array $config = [], array $attributes = []): self
    {
        $new = clone $this;
        $new->buttons[] = ResetButton::widget($config)->attributes($attributes);
        return $new;
    }

    /**
     * Renders a select widget.
     *
     * @param FormModelInterface $formModel The model object.
     * @param string $attribute The attribute name or expression.
     * @param array $config The configuration array for widget factory.
     * Available methods:
     * [
     *     'encode()' => [true],
     *     'groups()' => [['1' => ['2' => 'Moscu', '3' => 'San Petersburg']]],
     *     'items()' => [['1' => 'Moscu', '2' => 'San Petersburg']],
     *     'itemsAttributes()' => [['2' => ['disabled' => true]],
     *     'optionsData()' => [['1' => '<b>Moscu</b>', '2' => 'San Petersburg']],
     *     'prompt()' => [['text' => 'Select City Birth', 'attributes' => ['value' => '0', 'selected' => 'selected']]],
     *     'unselectValue()' => ['0'],
     * ]
     *
     * @throws CircularReferenceException|InvalidConfigException|NotFoundException|NotInstantiableException
     *
     * @return static the field object itself.
     */
    public function select(FormModelInterface $formModel, string $attribute, array $config = []): self
    {
        $new = clone $this;
        $new->widget = Select::widget($config)->for($formModel, $attribute);
        return $new;
    }

    /**
     * Renders a submit button widget.
     *
     * @param array $config the configuration array for widget factory.
     * @param array $attributes the HTML attributes for the widget.
     *
     * @throws CircularReferenceException|InvalidConfigException|NotFoundException|NotInstantiableException
     *
     * @return static the field object itself.
     */
    public function submitButton(array $config = [], array $attributes = []): self
    {
        $new = clone $this;
        $new->buttons[] = SubmitButton::widget($config)->attributes($attributes);
        return $new;
    }

    /**
     * Renders a text widget.
     *
     * @param FormModelInterface $formModel The model object.
     * @param string $attribute The attribute name or expression.
     * @param array $config the configuration array for widget factory.
     *
     * @throws CircularReferenceException|InvalidConfigException|NotFoundException|NotInstantiableException
     *
     * @return static the field widget instance.
     */
    public function telephone(FormModelInterface $formModel, string $attribute, array $config = []): self
    {
        $new = clone $this;
        $new->widget = Telephone::widget($config)->for($formModel, $attribute);
        return $new;
    }

    /**
     * Renders a text widget.
     *
     * @param FormModelInterface $formModel The model object.
     * @param string $attribute The attribute name or expression.
     * @param array $config the configuration array for widget factory.
     *
     * @throws CircularReferenceException|InvalidConfigException|NotFoundException|NotInstantiableException
     *
     * @return static the field widget instance.
     */
    public function text(FormModelInterface $formModel, string $attribute, array $config = []): self
    {
        $new = clone $this;
        $new->widget = Text::widget($config)->for($formModel, $attribute);
        return $new;
    }

    /**
     * Renders a text area widget.
     *
     * @param FormModelInterface $formModel The model object.
     * @param string $attribute The attribute name or expression.
     * @param array $config the configuration array for widget factory.
     *
     * @throws CircularReferenceException|InvalidConfigException|NotFoundException|NotInstantiableException
     *
     * @return static the field widget instance.
     */
    public function textArea(FormModelInterface $formModel, string $attribute, array $config = []): self
    {
        $new = clone $this;
        $new->widget = TextArea::widget($config)->for($formModel, $attribute);
        return $new;
    }

    /**
     * Renders a url widget.
     *
     * @param FormModelInterface $formModel The model object.
     * @param string $attribute The attribute name or expression.
     * @param array $config the configuration array for widget factory.
     *
     * @throws CircularReferenceException|InvalidConfigException|NotFoundException|NotInstantiableException
     *
     * @return static the field widget instance.
     */
    public function url(FormModelInterface $formModel, string $attribute, array $config = []): self
    {
        $new = clone $this;
        $new->widget = Url::widget($config)->for($formModel, $attribute);
        return $new;
    }

    /**
     * Renders the whole field.
     *
     * This method will generate the label, input tag and hint tag (if any), and assemble them into HTML according to
     * {@see template}.
     *
     * If (not set), the default methods will be called to generate the label and input tag, and use them as the
     * content.
     *
     * @throws CircularReferenceException|InvalidConfigException|NotFoundException|NotInstantiableException
     *
     * @return string the rendering result.
     */
    protected function run(): string
    {
        $content = '';

        $div = Div::tag();

        if ($this->getContainerClass() !== '') {
            $div = $div->class($this->getContainerClass());
        }

        if ($this->getContainerAttributes() !== []) {
            $div = $div->attributes($this->getContainerAttributes());
        }

        if (!empty($this->widget)) {
            $content .= $this->renderField();
        }

        $renderButtons = $this->renderButtons();

        if ($renderButtons !== '') {
            $content .= $renderButtons;
        }

        return $this->getContainer() ? $div->content(PHP_EOL . $content . PHP_EOL)->encode(false)->render() : $content;
    }

    private function buildField(): self
    {
        $new = clone $this;

        // Set ariadescribedby.
        if ($new->getAriaDescribedBy() === true && $new->widget instanceof InputAttributes) {
            $new->widget = $new->widget->ariaDescribedBy($new->widget->getAttribute() . 'Help');
            $new->widget = $new->widget->ariaDescribedBy($new->widget->getAttribute() . 'Help');
        }

        // Set encode.
        $new->widget = $new->widget->encode($new->getEncode());

        // Set input class.
        if ($new->inputClass !== '') {
            $new->widget = $new->widget->class($new->inputClass);
        }

        // Set label settings for the radio and checkbox fields.
        if ($new->widget instanceof Radio || $new->widget instanceof Checkbox) {
            $new->widget = $new->widget->label($new->getLabel())->labelAttributes($new->getLabelAttributes());
        }

        // Set placeholder.
        $new->placeholder ??= $new->widget->getAttributePlaceHolder();

        if ($new->widget instanceof PlaceholderInterface && $new->placeholder !== '') {
            $new->widget = $new->widget->attributes(['placeholder' => $new->placeholder]);
        }

        // Set valid class and invalid class.
        if ($new->invalidClass !== '' && $new->widget->hasError()) {
            $new->widget = $new->widget->class($new->invalidClass);
        } elseif ($new->validClass !== '' && $new->widget->isValidated()) {
            $new->widget = $new->widget->class($new->validClass);
        }

        return $new;
    }

    private function renderButtons(): string
    {
        $buttons = '';

        foreach ($this->buttons as $key => $button) {
            $buttonsAttributes = $this->getButtonsIndividualAttributes((string) $key) ?? $this->attributes;

            // Set input class.
            if ($this->inputClass !== '') {
                $button = $button->class($this->inputClass);
            }

            $buttons .= $button->attributes($buttonsAttributes)->render();
        }

        return $buttons;
    }

    /**
     * @throws CircularReferenceException|InvalidConfigException|NotFoundException|NotInstantiableException
     */
    private function renderError(): string
    {
        $errorAttributes = $this->getErrorAttributes();
        $errorClass = $this->getErrorIndividualClass($this->type) ?? $this->getErrorClass();

        if ($errorClass !== '') {
            Html::addCssClass($errorAttributes, $errorClass);
        }

        return Error::widget()
            ->attributes($errorAttributes)
            ->encode($this->getEncode())
            ->for($this->widget->getFormModel(), $this->widget->getAttribute())
            ->message($this->getError() ?? '')
            ->messageCallback($this->getErrorMessageCallback())
            ->tag($this->getErrorTag())
            ->render();
    }

    /**
     * @throws CircularReferenceException|InvalidConfigException|NotFoundException|NotInstantiableException
     */
    private function renderField(): string
    {
        $new = clone $this;

        $new = $new->buildField();
        $new->widget = $new->widget->attributes($this->attributes);

        if (!array_key_exists('{input}', $new->parts)) {
            $new->parts['{input}'] = $new->widget->render();
        }

        if (!array_key_exists('{error}', $new->parts)) {
            $new->parts['{error}'] = $this->getError() !== null ? $new->renderError() : '';
        }

        if (!array_key_exists('{hint}', $new->parts)) {
            $new->parts['{hint}'] = $new->renderHint();
        }

        if (!array_key_exists('{label}', $new->parts)) {
            $new->parts['{label}'] = $new->renderLabel();
        }

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

    /**
     * @throws CircularReferenceException|InvalidConfigException|NotFoundException|NotInstantiableException
     */
    private function renderHint(): string
    {
        $hintAttributes = $this->getHintAttributes();
        $hintClass = $this->getHintIndividualClass($this->type) ?? $this->getHintClass();

        if ($hintClass !== '') {
            Html::addCssClass($hintAttributes, $hintClass);
        }

        if ($this->getAriaDescribedBy() === true) {
            $hintAttributes['id'] = $this->widget->getInputId();
        }

        return Hint::widget()
            ->attributes($hintAttributes)
            ->encode($this->getEncode())
            ->for($this->widget->getFormModel(), $this->widget->getAttribute())
            ->hint($this->getHint())
            ->tag($this->getHintTag())
            ->render();
    }

    /**
     * @throws CircularReferenceException|InvalidConfigException|NotFoundException|NotInstantiableException
     */
    private function renderLabel(): string
    {
        $labelAttributes = $this->getLabelAttributes();
        $labelClass = $this->getLabelIndividualClass($this->type) ?? $this->getLabelClass();

        if (!array_key_exists('for', $labelAttributes)) {
            /** @var string */
            $labelAttributes['for'] = ArrayHelper::getValue($this->attributes, 'id', $this->widget->getInputId());
        }

        if ($labelClass !== '') {
            Html::addCssClass($labelAttributes, $labelClass);
        }

        return Label::widget()
            ->attributes($labelAttributes)
            ->encode($this->getEncode())
            ->for($this->widget->getFormModel(), $this->widget->getAttribute())
            ->label($this->getLabel())
            ->render();
    }
}

yiisoft / form

Pull Request — master (#160)

Field::renderField() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
