Yiisoft\Form\Field\Hidden

Complexity

Total Complexity

4

Size/Duplication

Total Lines	16
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	generateInput()	0	11	4

<?php

declare(strict_types=1);

namespace Yiisoft\Form\Field;

use InvalidArgumentException;
use Yiisoft\Form\Field\Base\InputField;
use Yiisoft\Html\Html;

use function is_string;

/**
 * Represents `<input>` element of type "hidden" are let web developers include data that cannot be seen or modified by
 * users when a form is submitted
 *
 * @link https://html.spec.whatwg.org/multipage/input.html#hidden-state-(type=hidden)
 * @link https://developer.mozilla.org/docs/Web/HTML/Element/input/hidden
 */
final class Hidden extends InputField
{
    protected bool $useContainer = false;
    protected string $template = '{input}';

    protected function generateInput(): string
    {
        $value = $this->getValue();

        if (!is_string($value) && !is_numeric($value) && $value !== null) {
            throw new InvalidArgumentException('Hidden widget requires a string, numeric or null value.');
        }

        $inputAttributes = $this->getInputAttributes();

        return Html::hiddenInput($this->getName(), $value, $inputAttributes)->render();
    }
}