RadioList::separator() - Code Metrics - yiisoft/form - Measure and Improve Code Quality continuously with Scrutinizer

RadioList::separator() A
last analyzed 2024-02-27 12:09 UTC

↳ Parent: RadioList

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	3
c	1
b	0
f	0
nc	1
nop	1
dl	0
loc	5
ccs	4
cts	4
cp	1
crap	1
rs	10

<?php

declare(strict_types=1);

namespace Yiisoft\Form\Field;

use Closure;
use InvalidArgumentException;
use LogicException;
use Stringable;
use Yiisoft\Form\Field\Base\InputData\InputDataWithCustomNameAndValueTrait;
use Yiisoft\Form\Field\Base\PartsField;
use Yiisoft\Form\Field\Base\ValidationClass\ValidationClassInterface;
use Yiisoft\Form\Field\Base\ValidationClass\ValidationClassTrait;
use Yiisoft\Form\Field\Part\Error;
use Yiisoft\Form\Field\Part\Hint;
use Yiisoft\Form\Field\Part\Label;
use Yiisoft\Html\Widget\RadioList\RadioItem;
use Yiisoft\Html\Widget\RadioList\RadioList as RadioListWidget;

/**
 * @see RadioListWidget
 */
final class RadioList extends PartsField implements ValidationClassInterface
{
    use InputDataWithCustomNameAndValueTrait;
    use ValidationClassTrait;

    private RadioListWidget $widget;
    private array $radioAttributes = [];

    public function __construct()
    {
        $this->widget = RadioListWidget::create('');
    }

    public function radioAttributes(array $attributes): self
    {
        $new = clone $this;
        $new->radioAttributes = $attributes;
        return $new;
    }

    public function addRadioAttributes(array $attributes): self
    {
        $new = clone $this;
        $new->radioAttributes = array_merge($new->radioAttributes, $attributes);
        return $new;
    }

    public function radioLabelAttributes(array $attributes): self
    {
        $new = clone $this;
        $new->widget = $this->widget->radioLabelAttributes($attributes);
        return $new;
    }

    public function addRadioLabelAttributes(array $attributes): self
    {
        $new = clone $this;
        $new->widget = $this->widget->addRadioLabelAttributes($attributes);
        return $new;
    }

    /**
     * @param array[] $attributes
     */
    public function individualInputAttributes(array $attributes): self
    {
        $new = clone $this;
        $new->widget = $this->widget->individualInputAttributes($attributes);
        return $new;
    }

    /**
     * @param array[] $attributes
     */
    public function addIndividualInputAttributes(array $attributes): self
    {
        $new = clone $this;
        $new->widget = $this->widget->addIndividualInputAttributes($attributes);
        return $new;
    }

    /**
     * @param string[] $items
     * @param bool $encodeLabels Whether labels should be encoded.
     */
    public function items(array $items, bool $encodeLabels = true): self
    {
        $new = clone $this;
        $new->widget = $this->widget->items($items, $encodeLabels);
        return $new;
    }

    /**
     * Fills items from an array provided. Array values are used for both input labels and input values.
     *
     * @param bool[]|float[]|int[]|string[]|Stringable[] $values
     * @param bool $encodeLabels Whether labels should be encoded.
     */
    public function itemsFromValues(array $values, bool $encodeLabels = true): self
    {
        $new = clone $this;
        $new->widget = $this->widget->itemsFromValues($values, $encodeLabels);
        return $new;
    }

    /**
     * Specifies the form element the tag input element belongs to. The value of this attribute must be the ID
     * attribute of a form element in the same document.
     *
     * @link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fae-form
     */
    public function form(?string $formId): self
    {
        $new = clone $this;
        $new->widget = $this->widget->form($formId);
        return $new;
    }

    /**
     * @param bool $disabled Whether radio buttons is disabled.
     *
     * @link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-disabled
     */
    public function disabled(bool $disabled = true): self
    {
        $new = clone $this;
        $new->widget = $this->widget->disabled($disabled);
        return $new;
    }

    public function uncheckValue(bool|float|int|string|Stringable|null $value): self
    {
        $new = clone $this;
        $new->widget = $this->widget->uncheckValue($value);
        return $new;
    }

    public function separator(string $separator): self
    {
        $new = clone $this;
        $new->widget = $this->widget->separator($separator);
        return $new;
    }

    /**
     * @psalm-param Closure(RadioItem):string|null $formatter
     */
    public function itemFormatter(?Closure $formatter): self
    {
        $new = clone $this;
        $new->widget = $this->widget->itemFormatter($formatter);
        return $new;
    }

    protected function generateInput(): string
    {
        $name = $this->getName();
        if (empty($name)) {
            throw new LogicException('"RadioList" field requires non-empty name.');
        }

        $value = $this->getValue();

        if (!is_bool($value)
            && !is_string($value)
            && !is_numeric($value)
            && $value !== null
            && (!is_object($value) || !method_exists($value, '__toString'))
        ) {
            throw new InvalidArgumentException(
                '"RadioList" field requires a string, numeric, bool, Stringable or null value.'
            );
        }
        /** @psalm-var Stringable|scalar $value */

        $radioAttributes = $this->radioAttributes;
        $this->addInputValidationClassToAttributes(
            $radioAttributes,
            $this->getInputData(),
            $this->hasCustomError() ? true : null,
        );

        return $this->widget
            ->name($name)
            ->value($value)
            ->addRadioAttributes($radioAttributes)
            ->render();
    }

    protected function renderLabel(Label $label): string
    {
        return $label
            ->inputData($this->getInputData())
            ->useInputId(false)
            ->render();
    }

    protected function renderHint(Hint $hint): string
    {
        return $hint
            ->inputData($this->getInputData())
            ->render();
    }

    protected function renderError(Error $error): string
    {
        return $error
            ->inputData($this->getInputData())
            ->render();
    }

    protected function prepareContainerAttributes(array &$attributes): void
    {
        $this->addValidationClassToAttributes(
            $attributes,
            $this->getInputData(),
            $this->hasCustomError() ? true : null,
        );
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Form\Field;
6
7		use Closure;
8		use InvalidArgumentException;
9		use LogicException;
10		use Stringable;
11		use Yiisoft\Form\Field\Base\InputData\InputDataWithCustomNameAndValueTrait;
12		use Yiisoft\Form\Field\Base\PartsField;
13		use Yiisoft\Form\Field\Base\ValidationClass\ValidationClassInterface;
14		use Yiisoft\Form\Field\Base\ValidationClass\ValidationClassTrait;
15		use Yiisoft\Form\Field\Part\Error;
16		use Yiisoft\Form\Field\Part\Hint;
17		use Yiisoft\Form\Field\Part\Label;
18		use Yiisoft\Html\Widget\RadioList\RadioItem;
19		use Yiisoft\Html\Widget\RadioList\RadioList as RadioListWidget;
20
21		/**
22		* @see RadioListWidget
23		*/
24		final class RadioList extends PartsField implements ValidationClassInterface
25		{
26		use InputDataWithCustomNameAndValueTrait;
27		use ValidationClassTrait;
28
29		private RadioListWidget $widget;
30		private array $radioAttributes = [];
31
32	37	public function __construct()
33		{
34	37	$this->widget = RadioListWidget::create('');
35		}
36
37	7	public function radioAttributes(array $attributes): self
38		{
39	7	$new = clone $this;
40	7	$new->radioAttributes = $attributes;
41	7	return $new;
42		}
43
44	2	public function addRadioAttributes(array $attributes): self
45		{
46	2	$new = clone $this;
47	2	$new->radioAttributes = array_merge($new->radioAttributes, $attributes);
48	2	return $new;
49		}
50
51	2	public function radioLabelAttributes(array $attributes): self
52		{
53	2	$new = clone $this;
54	2	$new->widget = $this->widget->radioLabelAttributes($attributes);
55	2	return $new;
56		}
57
58	2	public function addRadioLabelAttributes(array $attributes): self
59		{
60	2	$new = clone $this;
61	2	$new->widget = $this->widget->addRadioLabelAttributes($attributes);
62	2	return $new;
63		}
64
65		/**
66		* @param array[] $attributes
67		*/
68	3	public function individualInputAttributes(array $attributes): self
69		{
70	3	$new = clone $this;
71	3	$new->widget = $this->widget->individualInputAttributes($attributes);
72	3	return $new;
73		}
74
75		/**
76		* @param array[] $attributes
77		*/
78	3	public function addIndividualInputAttributes(array $attributes): self
79		{
80	3	$new = clone $this;
81	3	$new->widget = $this->widget->addIndividualInputAttributes($attributes);
82	3	return $new;
83		}
84
85		/**
86		* @param string[] $items
87		* @param bool $encodeLabels Whether labels should be encoded.
88		*/
89	24	public function items(array $items, bool $encodeLabels = true): self
90		{
91	24	$new = clone $this;
92	24	$new->widget = $this->widget->items($items, $encodeLabels);
93	24	return $new;
94		}
95
96		/**
97		* Fills items from an array provided. Array values are used for both input labels and input values.
98		*
99		* @param bool[]\|float[]\|int[]\|string[]\|Stringable[] $values
100		* @param bool $encodeLabels Whether labels should be encoded.
101		*/
102	11	public function itemsFromValues(array $values, bool $encodeLabels = true): self
103		{
104	11	$new = clone $this;
105	11	$new->widget = $this->widget->itemsFromValues($values, $encodeLabels);
106	11	return $new;
107		}
108
109		/**
110		* Specifies the form element the tag input element belongs to. The value of this attribute must be the ID
111		* attribute of a form element in the same document.
112		*
113		* @link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fae-form
114		*/
115	3	public function form(?string $formId): self
116		{
117	3	$new = clone $this;
118	3	$new->widget = $this->widget->form($formId);
119	3	return $new;
120		}
121
122		/**
123		* @param bool $disabled Whether radio buttons is disabled.
124		*
125		* @link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-disabled
126		*/
127	3	public function disabled(bool $disabled = true): self
128		{
129	3	$new = clone $this;
130	3	$new->widget = $this->widget->disabled($disabled);
131	3	return $new;
132		}
133
134	8	public function uncheckValue(bool\|float\|int\|string\|Stringable\|null $value): self
135		{
136	8	$new = clone $this;
137	8	$new->widget = $this->widget->uncheckValue($value);
138	8	return $new;
139		}
140
141	2	public function separator(string $separator): self
142		{
143	2	$new = clone $this;
144	2	$new->widget = $this->widget->separator($separator);
145	2	return $new;
146		}
147
148		/**
149		* @psalm-param Closure(RadioItem):string\|null $formatter
150		*/
151	2	public function itemFormatter(?Closure $formatter): self
152		{
153	2	$new = clone $this;
154	2	$new->widget = $this->widget->itemFormatter($formatter);
155	2	return $new;
156		}
157
158	36	protected function generateInput(): string
159		{
160	36	$name = $this->getName();
161	36	if (empty($name)) {
162	2	throw new LogicException('"RadioList" field requires non-empty name.');
163		}
164
165	34	$value = $this->getValue();
166
167	34	if (!is_bool($value)
168	34	&& !is_string($value)
169	34	&& !is_numeric($value)
170	34	&& $value !== null
171	34	&& (!is_object($value) \|\| !method_exists($value, '__toString'))
172		) {
173	1	throw new InvalidArgumentException(
174	1	'"RadioList" field requires a string, numeric, bool, Stringable or null value.'
175	1	);
176		}
177		/** @psalm-var Stringable\|scalar $value */
178
179	33	$radioAttributes = $this->radioAttributes;
180	33	$this->addInputValidationClassToAttributes(
181	33	$radioAttributes,
182	33	$this->getInputData(),
183	33	$this->hasCustomError() ? true : null,
184	33	);
185
186	33	return $this->widget
187	33	->name($name)
188	33	->value($value)
189	33	->addRadioAttributes($radioAttributes)
190	33	->render();
191		}
192
193	9	protected function renderLabel(Label $label): string
194		{
195	9	return $label
196	9	->inputData($this->getInputData())
197	9	->useInputId(false)
198	9	->render();
199		}
200
201	33	protected function renderHint(Hint $hint): string
202		{
203	33	return $hint
204	33	->inputData($this->getInputData())
205	33	->render();
206		}
207
208	33	protected function renderError(Error $error): string
209		{
210	33	return $error
211	33	->inputData($this->getInputData())
212	33	->render();
213		}
214
215	9	protected function prepareContainerAttributes(array &$attributes): void
216		{
217	9	$this->addValidationClassToAttributes(
218	9	$attributes,
219	9	$this->getInputData(),
220	9	$this->hasCustomError() ? true : null,
221	9	);
222		}
223		}
224

yiisoft / form

RadioList::separator() A last analyzed 2024-02-27 12:09 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

RadioList::separator() A
last analyzed 2024-02-27 12:09 UTC