0 follower

Final Class Yiisoft\Form\Field\RadioList

InheritanceYiisoft\Form\Field\RadioList » Yiisoft\Form\Field\Base\PartsField » Yiisoft\Form\Field\Base\BaseField » Yiisoft\Widget\Widget
ImplementsYiisoft\Form\Field\Base\ValidationClass\ValidationClassInterface
Uses TraitsYiisoft\Form\Field\Base\InputData\InputDataWithCustomNameAndValueTrait, Yiisoft\Form\Field\Base\ValidationClass\ValidationClassTrait

See also \Yiisoft\Html\Widget\RadioList\RadioList.

Public Methods

Hide inherited methods

Method Description Defined By
__construct() Yiisoft\Form\Field\RadioList
addContainerAttributes() Yiisoft\Form\Field\Base\BaseField
addContainerClass() Add one or more CSS classes to the container tag. Yiisoft\Form\Field\Base\BaseField
addErrorAttributes() Yiisoft\Form\Field\Base\PartsField
addErrorClass() Add one or more CSS classes to the error tag. Yiisoft\Form\Field\Base\PartsField
addHintAttributes() Yiisoft\Form\Field\Base\PartsField
addHintClass() Add one or more CSS classes to the hint tag. Yiisoft\Form\Field\Base\PartsField
addIndividualInputAttributes() Yiisoft\Form\Field\RadioList
addInputContainerAttributes() Yiisoft\Form\Field\Base\PartsField
addInputContainerClass() Add one or more CSS classes to the input container tag. Yiisoft\Form\Field\Base\PartsField
addLabelAttributes() Yiisoft\Form\Field\Base\PartsField
addLabelClass() Add one or more CSS classes to the label tag. Yiisoft\Form\Field\Base\PartsField
addRadioAttributes() Yiisoft\Form\Field\RadioList
addRadioLabelAttributes() Yiisoft\Form\Field\RadioList
addRadioWrapClass() Yiisoft\Form\Field\RadioList
afterInput() Yiisoft\Form\Field\Base\PartsField
beforeInput() Yiisoft\Form\Field\Base\PartsField
begin() Yiisoft\Form\Field\Base\BaseField
containerAttributes() Yiisoft\Form\Field\Base\BaseField
containerClass() Replace container tag CSS classes with a new set of classes. Yiisoft\Form\Field\Base\BaseField
containerId() Set container tag ID. Yiisoft\Form\Field\Base\BaseField
containerTag() Yiisoft\Form\Field\Base\BaseField
disabled() Yiisoft\Form\Field\RadioList
error() Yiisoft\Form\Field\Base\PartsField
errorAttributes() Yiisoft\Form\Field\Base\PartsField
errorClass() Replace error tag CSS classes with a new set of classes. Yiisoft\Form\Field\Base\PartsField
errorConfig() Yiisoft\Form\Field\Base\PartsField
errorId() Set error tag ID. Yiisoft\Form\Field\Base\PartsField
form() 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. Yiisoft\Form\Field\RadioList
hideLabel() Yiisoft\Form\Field\Base\PartsField
hint() Yiisoft\Form\Field\Base\PartsField
hintAttributes() Yiisoft\Form\Field\Base\PartsField
hintClass() Replace hint tag CSS classes with a new set of classes. Yiisoft\Form\Field\Base\PartsField
hintConfig() Yiisoft\Form\Field\Base\PartsField
hintId() Set hint tag ID. Yiisoft\Form\Field\Base\PartsField
individualInputAttributes() Yiisoft\Form\Field\RadioList
inputContainerAttributes() Yiisoft\Form\Field\Base\PartsField
inputContainerClass() Replace input container tag CSS classes with a new set of classes. Yiisoft\Form\Field\Base\PartsField
inputContainerTag() Yiisoft\Form\Field\Base\PartsField
inputData() Yiisoft\Form\Field\Base\InputData\InputDataWithCustomNameAndValueTrait
inputInvalidClass() Set invalid CSS class for input tag. Yiisoft\Form\Field\Base\ValidationClass\ValidationClassTrait
inputValidClass() Set valid CSS class for input tag. Yiisoft\Form\Field\Base\ValidationClass\ValidationClassTrait
invalidClass() Set invalid CSS class. Yiisoft\Form\Field\Base\ValidationClass\ValidationClassTrait
itemFormatter() Yiisoft\Form\Field\RadioList
items() Yiisoft\Form\Field\RadioList
itemsFromValues() Fills items from an array provided. Array values are used for both input labels and input values. Yiisoft\Form\Field\RadioList
label() Yiisoft\Form\Field\Base\PartsField
labelAttributes() Yiisoft\Form\Field\Base\PartsField
labelClass() Replace label tag CSS classes with a new set of classes. Yiisoft\Form\Field\Base\PartsField
labelConfig() Yiisoft\Form\Field\Base\PartsField
labelId() Set label tag ID. Yiisoft\Form\Field\Base\PartsField
name() Yiisoft\Form\Field\Base\InputData\InputDataWithCustomNameAndValueTrait
prepareValue() Yiisoft\Form\Field\Base\InputData\InputDataWithCustomNameAndValueTrait
radioAttributes() Yiisoft\Form\Field\RadioList
radioLabelAttributes() Yiisoft\Form\Field\RadioList
radioLabelWrap() Yiisoft\Form\Field\RadioList
radioWrapAttributes() Yiisoft\Form\Field\RadioList
radioWrapClass() Yiisoft\Form\Field\RadioList
radioWrapTag() Yiisoft\Form\Field\RadioList
render() Yiisoft\Form\Field\Base\BaseField
separator() Yiisoft\Form\Field\RadioList
template() Set layout template for render a field. Yiisoft\Form\Field\Base\PartsField
templateBegin() Yiisoft\Form\Field\Base\PartsField
templateEnd() Yiisoft\Form\Field\Base\PartsField
token() Yiisoft\Form\Field\Base\PartsField
tokens() Yiisoft\Form\Field\Base\PartsField
uncheckValue() Yiisoft\Form\Field\RadioList
useContainer() Yiisoft\Form\Field\Base\BaseField
validClass() Set valid CSS class. Yiisoft\Form\Field\Base\ValidationClass\ValidationClassTrait
value() Yiisoft\Form\Field\Base\InputData\InputDataWithCustomNameAndValueTrait

Constants

Hide inherited constants

Constant Value Description Defined By
BUILTIN_TOKENS [ '{input}', '{label}', '{hint}', '{error}', ] Yiisoft\Form\Field\Base\PartsField

Method Details

Hide inherited methods

__construct() public method

public mixed __construct ( )

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

            
addContainerAttributes() public method
public Yiisoft\Form\Field\RadioList addContainerAttributes ( array $attributes )
$attributes array

                final public function addContainerAttributes(array $attributes): static
{
    $new = clone $this;
    $new->containerAttributes = array_merge($new->containerAttributes, $attributes);
    return $new;
}

            
addContainerClass() public method

Defined in: Yiisoft\Form\Field\Base\BaseField::addContainerClass()

Add one or more CSS classes to the container tag.

public Yiisoft\Form\Field\RadioList addContainerClass ( string|null $class )
$class string|null

One or many CSS classes.

                final public function addContainerClass(?string ...$class): static
{
    $new = clone $this;
    Html::addCssClass($new->containerAttributes, $class);
    return $new;
}

            
addErrorAttributes() public method
public Yiisoft\Form\Field\RadioList addErrorAttributes ( array $attributes )
$attributes array

                final public function addErrorAttributes(array $attributes): static
{
    $new = clone $this;
    $new->errorAttributes = array_merge($new->errorAttributes, $attributes);
    return $new;
}

            
addErrorClass() public method

Defined in: Yiisoft\Form\Field\Base\PartsField::addErrorClass()

Add one or more CSS classes to the error tag.

public Yiisoft\Form\Field\RadioList addErrorClass ( string|null $class )
$class string|null

One or many CSS classes.

                final public function addErrorClass(?string ...$class): static
{
    $new = clone $this;
    Html::addCssClass($new->errorAttributes, $class);
    return $new;
}

            
addHintAttributes() public method
public Yiisoft\Form\Field\RadioList addHintAttributes ( array $attributes )
$attributes array

                final public function addHintAttributes(array $attributes): static
{
    $new = clone $this;
    $new->hintAttributes = array_merge($new->hintAttributes, $attributes);
    return $new;
}

            
addHintClass() public method

Defined in: Yiisoft\Form\Field\Base\PartsField::addHintClass()

Add one or more CSS classes to the hint tag.

public Yiisoft\Form\Field\RadioList addHintClass ( string|null $class )
$class string|null

One or many CSS classes.

                final public function addHintClass(?string ...$class): static
{
    $new = clone $this;
    Html::addCssClass($new->hintAttributes, $class);
    return $new;
}

            
addIndividualInputAttributes() public method

public self addIndividualInputAttributes ( array[] $attributes )
$attributes array[]

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

            
addInputContainerAttributes() public method
public Yiisoft\Form\Field\RadioList addInputContainerAttributes ( array $attributes )
$attributes array

                final public function addInputContainerAttributes(array $attributes): static
{
    $new = clone $this;
    $new->inputContainerAttributes = array_merge($new->inputContainerAttributes, $attributes);
    return $new;
}

            
addInputContainerClass() public method

Defined in: Yiisoft\Form\Field\Base\PartsField::addInputContainerClass()

Add one or more CSS classes to the input container tag.

public Yiisoft\Form\Field\RadioList addInputContainerClass ( string|null $class )
$class string|null

One or many CSS classes.

                final public function addInputContainerClass(?string ...$class): static
{
    $new = clone $this;
    Html::addCssClass($new->inputContainerAttributes, $class);
    return $new;
}

            
addInputValidationClassToAttributes() protected method
protected void addInputValidationClassToAttributes ( array &$attributes, Yiisoft\Form\Field\Base\InputData\InputDataInterface $inputData, boolean|null $hasCustomError null )
$attributes array
$inputData Yiisoft\Form\Field\Base\InputData\InputDataInterface
$hasCustomError boolean|null

                protected function addInputValidationClassToAttributes(
    array &$attributes,
    InputDataInterface $inputData,
    ?bool $hasCustomError = null,
): void {
    $this->addClassesToAttributes(
        $attributes,
        $inputData,
        $hasCustomError,
        $this->inputInvalidClass,
        $this->inputValidClass,
    );
}

            
addLabelAttributes() public method
public Yiisoft\Form\Field\RadioList addLabelAttributes ( array $attributes )
$attributes array

                final public function addLabelAttributes(array $attributes): static
{
    $new = clone $this;
    $new->labelAttributes = array_merge($new->labelAttributes, $attributes);
    return $new;
}

            
addLabelClass() public method

Defined in: Yiisoft\Form\Field\Base\PartsField::addLabelClass()

Add one or more CSS classes to the label tag.

public Yiisoft\Form\Field\RadioList addLabelClass ( string|null $class )
$class string|null

One or many CSS classes.

                final public function addLabelClass(?string ...$class): static
{
    $new = clone $this;
    Html::addCssClass($new->labelAttributes, $class);
    return $new;
}

            
addRadioAttributes() public method

public self addRadioAttributes ( array $attributes )
$attributes array

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

            
addRadioLabelAttributes() public method

public self addRadioLabelAttributes ( array $attributes )
$attributes array

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

            
addRadioWrapClass() public method

public self addRadioWrapClass ( string|null $class )
$class string|null

                public function addRadioWrapClass(?string ...$class): self
{
    $new = clone $this;
    $new->widget = $this->widget->addRadioWrapClass(...$class);
    return $new;
}

            
addValidationClassToAttributes() protected method
protected void addValidationClassToAttributes ( array &$attributes, Yiisoft\Form\Field\Base\InputData\InputDataInterface $inputData, boolean|null $hasCustomError null )
$attributes array
$inputData Yiisoft\Form\Field\Base\InputData\InputDataInterface
$hasCustomError boolean|null

                protected function addValidationClassToAttributes(
    array &$attributes,
    InputDataInterface $inputData,
    ?bool $hasCustomError = null,
): void {
    $this->addClassesToAttributes(
        $attributes,
        $inputData,
        $hasCustomError,
        $this->invalidClass,
        $this->validClass,
    );
}

            
afterInput() public method
public Yiisoft\Form\Field\RadioList afterInput ( string|\Stringable $content )
$content string|\Stringable

                final public function afterInput(string|Stringable $content): static
{
    $new = clone $this;
    $new->afterInput = $content;
    return $new;
}

            
beforeInput() public method
public Yiisoft\Form\Field\RadioList beforeInput ( string|\Stringable $content )
$content string|\Stringable

                final public function beforeInput(string|Stringable $content): static
{
    $new = clone $this;
    $new->beforeInput = $content;
    return $new;
}

            
beforeRender() protected method
protected void beforeRender ( )

                protected function beforeRender(): void
{
}

            
begin() public method
public string|null begin ( )

                final public function begin(): ?string
{
    parent::begin();
    $this->isStartedByBegin = true;
    $this->beforeRender();
    $content = $this->generateBeginContent();
    return $this->renderOpenContainerAndContent($content);
}

            
containerAttributes() public method
public Yiisoft\Form\Field\RadioList containerAttributes ( array $attributes )
$attributes array

                final public function containerAttributes(array $attributes): static
{
    $new = clone $this;
    $new->containerAttributes = $attributes;
    return $new;
}

            
containerClass() public method

Defined in: Yiisoft\Form\Field\Base\BaseField::containerClass()

Replace container tag CSS classes with a new set of classes.

public Yiisoft\Form\Field\RadioList containerClass ( string|null $class )
$class string|null

One or many CSS classes.

                final public function containerClass(?string ...$class): static
{
    $new = clone $this;
    $new->containerAttributes['class'] = array_filter($class, static fn ($c) => $c !== null);
    return $new;
}

            
containerId() public method

Defined in: Yiisoft\Form\Field\Base\BaseField::containerId()

Set container tag ID.

public Yiisoft\Form\Field\RadioList containerId ( string|null $id )
$id string|null

Container tag ID.

                final public function containerId(?string $id): static
{
    $new = clone $this;
    $new->containerAttributes['id'] = $id;
    return $new;
}

            
containerTag() public method
public Yiisoft\Form\Field\RadioList containerTag ( string $tag )
$tag string

                final public function containerTag(string $tag): static
{
    if ($tag === '') {
        throw new InvalidArgumentException('Tag name cannot be empty.');
    }
    $new = clone $this;
    $new->containerTag = $tag;
    return $new;
}

            
disabled() public method

public self disabled ( boolean $disabled true )
$disabled boolean

Whether radio buttons is disabled.

                public function disabled(bool $disabled = true): self
{
    $new = clone $this;
    $new->widget = $this->widget->disabled($disabled);
    return $new;
}

            
error() public method
public Yiisoft\Form\Field\RadioList error ( string|null $message, string $messages )
$message string|null
$messages string

                final public function error(?string $message, string ...$messages): static
{
    $new = clone $this;
    $new->errorConfig['message()'] = [$message, ...$messages];
    return $new;
}

            
errorAttributes() public method
public Yiisoft\Form\Field\RadioList errorAttributes ( array $attributes )
$attributes array

                final public function errorAttributes(array $attributes): static
{
    $new = clone $this;
    $new->errorAttributes = $attributes;
    $new->replaceErrorAttributes = true;
    return $new;
}

            
errorClass() public method

Defined in: Yiisoft\Form\Field\Base\PartsField::errorClass()

Replace error tag CSS classes with a new set of classes.

public Yiisoft\Form\Field\RadioList errorClass ( string|null $class )
$class string|null

One or many CSS classes.

                final public function errorClass(?string ...$class): static
{
    $new = clone $this;
    $new->errorAttributes['class'] = $class;
    $new->replaceErrorClass = true;
    return $new;
}

            
errorConfig() public method
public Yiisoft\Form\Field\RadioList errorConfig ( array $config )
$config array

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

            
errorId() public method

Defined in: Yiisoft\Form\Field\Base\PartsField::errorId()

Set error tag ID.

public Yiisoft\Form\Field\RadioList errorId ( string|null $id )
$id string|null

Error tag ID.

                final public function errorId(?string $id): static
{
    $new = clone $this;
    $new->errorAttributes['id'] = $id;
    return $new;
}

            
form() public method

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.

public self form ( string|null $formId )
$formId string|null

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

            
generateBeginContent() protected method
protected string generateBeginContent ( )

                final protected function generateBeginContent(): string
{
    $parts = [
        '{input}' => $this->generateBeginInput(),
        '{label}' => ($this->hideLabel ?? $this->shouldHideLabel()) ? '' : $this->generateLabel(),
        '{hint}' => $this->generateHint(),
        '{error}' => $this->generateError(),
    ];
    return $this->makeContent($this->templateBegin, $parts);
}

            
generateBeginInput() protected method
protected string generateBeginInput ( )

                protected function generateBeginInput(): string
{
    return '';
}

            
generateContent() protected method
protected string|null generateContent ( )

                final protected function generateContent(): ?string
{
    $parts = [
        '{input}' => $this->generateInputContainerBegin()
            . $this->beforeInput
            . $this->generateInput()
            . $this->afterInput
            . $this->generateInputContainerEnd(),
        '{label}' => ($this->hideLabel ?? $this->shouldHideLabel()) ? '' : $this->generateLabel(),
        '{hint}' => $this->generateHint(),
        '{error}' => $this->generateError(),
    ];
    return $this->makeContent($this->template, $parts);
}

            
generateEndContent() protected method
protected string generateEndContent ( )

                final protected function generateEndContent(): string
{
    $parts = [
        '{input}' => $this->generateEndInput(),
        '{label}' => ($this->hideLabel ?? $this->shouldHideLabel()) ? '' : $this->generateLabel(),
        '{hint}' => $this->generateHint(),
        '{error}' => $this->generateError(),
    ];
    return $this->makeContent($this->templateEnd, $parts);
}

            
generateEndInput() protected method
protected string generateEndInput ( )

                protected function generateEndInput(): string
{
    return '';
}

            
generateInput() protected method

protected string generateInput ( )

                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)
        && !$value instanceof Stringable
        && !is_numeric($value)
        && $value !== null
    ) {
        throw new InvalidArgumentException(
            '"RadioList" field requires a string, Stringable, numeric, bool 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();
}

            
getInputData() protected method
protected Yiisoft\Form\Field\Base\InputData\InputDataInterface getInputData ( )

                final protected function getInputData(): InputDataInterface
{
    if ($this->inputData === null) {
        $this->inputData = new InputData();
    }
    return $this->inputData;
}

            
getName() protected method
protected string|null getName ( )

                final protected function getName(): ?string
{
    return $this->useCustomName
        ? $this->customName
        : $this->getInputData()->getName();
}

            
getThemeConfig() protected static method
protected static array getThemeConfig ( string|null $theme )
$theme string|null

                final protected static function getThemeConfig(?string $theme): array
{
    return ThemeContainer::getTheme($theme)?->getFieldConfig(static::class) ?? [];
}

            
getValue() protected method
protected mixed getValue ( )

                final protected function getValue(): mixed
{
    $value = $this->useCustomValue
        ? $this->customValue
        : $this->getInputData()->getValue();
    return $this->prepareValueCallback === null
        ? $value
        : ($this->prepareValueCallback)($value);
}

            
hasCustomError() protected method
protected boolean hasCustomError ( )

                final protected function hasCustomError(): bool
{
    return isset($this->errorConfig['message()']);
}

            
hideLabel() public method
public Yiisoft\Form\Field\RadioList hideLabel ( boolean|null $hide true )
$hide boolean|null

                final public function hideLabel(?bool $hide = true): static
{
    $new = clone $this;
    $new->hideLabel = $hide;
    return $new;
}

            
hint() public method
public Yiisoft\Form\Field\RadioList hint ( string|null $content )
$content string|null

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

            
hintAttributes() public method
public Yiisoft\Form\Field\RadioList hintAttributes ( array $attributes )
$attributes array

                final public function hintAttributes(array $attributes): static
{
    $new = clone $this;
    $new->hintAttributes = $attributes;
    $new->replaceHintAttributes = true;
    return $new;
}

            
hintClass() public method

Defined in: Yiisoft\Form\Field\Base\PartsField::hintClass()

Replace hint tag CSS classes with a new set of classes.

public Yiisoft\Form\Field\RadioList hintClass ( string|null $class )
$class string|null

One or many CSS classes.

                final public function hintClass(?string ...$class): static
{
    $new = clone $this;
    $new->hintAttributes['class'] = $class;
    $new->replaceHintClass = true;
    return $new;
}

            
hintConfig() public method
public Yiisoft\Form\Field\RadioList hintConfig ( array $config )
$config array

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

            
hintId() public method

Defined in: Yiisoft\Form\Field\Base\PartsField::hintId()

Set hint tag ID.

public Yiisoft\Form\Field\RadioList hintId ( string|null $id )
$id string|null

Hint tag ID.

                final public function hintId(?string $id): static
{
    $new = clone $this;
    $new->hintAttributes['id'] = $id;
    return $new;
}

            
individualInputAttributes() public method

public self individualInputAttributes ( array[] $attributes )
$attributes array[]

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

            
inputContainerAttributes() public method
public Yiisoft\Form\Field\RadioList inputContainerAttributes ( array $attributes )
$attributes array

                final public function inputContainerAttributes(array $attributes): static
{
    $new = clone $this;
    $new->inputContainerAttributes = $attributes;
    return $new;
}

            
inputContainerClass() public method

Defined in: Yiisoft\Form\Field\Base\PartsField::inputContainerClass()

Replace input container tag CSS classes with a new set of classes.

public Yiisoft\Form\Field\RadioList inputContainerClass ( string|null $class )
$class string|null

One or many CSS classes.

                final public function inputContainerClass(?string ...$class): static
{
    $new = clone $this;
    $new->inputContainerAttributes['class'] = array_filter($class, static fn ($c) => $c !== null);
    return $new;
}

            
inputContainerTag() public method
public Yiisoft\Form\Field\RadioList inputContainerTag ( string|null $tag )
$tag string|null

                final public function inputContainerTag(?string $tag): static
{
    if ($tag === '') {
        throw new InvalidArgumentException('Tag name cannot be empty.');
    }
    $new = clone $this;
    $new->inputContainerTag = $tag;
    return $new;
}

            
inputData() public method
public Yiisoft\Form\Field\RadioList inputData ( Yiisoft\Form\Field\Base\InputData\InputDataInterface $inputData )
$inputData Yiisoft\Form\Field\Base\InputData\InputDataInterface

                final public function inputData(InputDataInterface $inputData): static
{
    $new = clone $this;
    $new->inputData = $inputData;
    $new->useCustomName = false;
    $new->useCustomValue = false;
    return $new;
}

            
inputInvalidClass() public method
public self inputInvalidClass ( string|null $class )
$class string|null

                public function inputInvalidClass(?string $class): self
{
    $new = clone $this;
    $new->inputInvalidClass = $class;
    return $new;
}

            
inputValidClass() public method
public self inputValidClass ( string|null $class )
$class string|null

                public function inputValidClass(?string $class): self
{
    $new = clone $this;
    $new->inputValidClass = $class;
    return $new;
}

            
invalidClass() public method
public self invalidClass ( string|null $class )
$class string|null

                public function invalidClass(?string $class): self
{
    $new = clone $this;
    $new->invalidClass = $class;
    return $new;
}

            
itemFormatter() public method

public self itemFormatter ( Closure|null $formatter )
$formatter Closure|null

                public function itemFormatter(?Closure $formatter): self
{
    $new = clone $this;
    $new->widget = $this->widget->itemFormatter($formatter);
    return $new;
}

            
items() public method

public self items ( string[] $items, boolean $encodeLabels true )
$items string[]
$encodeLabels boolean

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;
}

            
itemsFromValues() public method

Fills items from an array provided. Array values are used for both input labels and input values.

public self itemsFromValues ( boolean[]|float[]|integer[]|string[]|\Stringable[] $values, boolean $encodeLabels true )
$values boolean[]|float[]|integer[]|string[]|\Stringable[]
$encodeLabels boolean

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;
}

            
label() public method
public Yiisoft\Form\Field\RadioList label ( string|null $content )
$content string|null

                final public function label(?string $content): static
{
    $new = clone $this;
    $new->label = $content;
    return $new;
}

            
labelAttributes() public method
public Yiisoft\Form\Field\RadioList labelAttributes ( array $attributes )
$attributes array

                final public function labelAttributes(array $attributes): static
{
    $new = clone $this;
    $new->labelAttributes = $attributes;
    $new->replaceLabelAttributes = true;
    return $new;
}

            
labelClass() public method

Defined in: Yiisoft\Form\Field\Base\PartsField::labelClass()

Replace label tag CSS classes with a new set of classes.

public Yiisoft\Form\Field\RadioList labelClass ( string|null $class )
$class string|null

One or many CSS classes.

                final public function labelClass(?string ...$class): static
{
    $new = clone $this;
    $new->labelAttributes['class'] = $class;
    $new->replaceLabelClass = true;
    return $new;
}

            
labelConfig() public method
public Yiisoft\Form\Field\RadioList labelConfig ( array $config )
$config array

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

            
labelId() public method

Defined in: Yiisoft\Form\Field\Base\PartsField::labelId()

Set label tag ID.

public Yiisoft\Form\Field\RadioList labelId ( string|null $id )
$id string|null

Label tag ID.

                final public function labelId(?string $id): static
{
    $new = clone $this;
    $new->labelAttributes['id'] = $id;
    return $new;
}

            
name() public method
public Yiisoft\Form\Field\RadioList name ( string|null $name )
$name string|null

                final public function name(?string $name): static
{
    $new = clone $this;
    $new->customName = $name;
    $new->useCustomName = true;
    return $new;
}

            
prepareContainerAttributes() protected method

protected void prepareContainerAttributes ( array &$attributes )
$attributes array

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

            
prepareValue() public method
public Yiisoft\Form\Field\RadioList prepareValue ( callable|null $callback )
$callback callable|null

                final public function prepareValue(?callable $callback): static
{
    $new = clone $this;
    $new->prepareValueCallback = $callback;
    return $new;
}

            
radioAttributes() public method

public self radioAttributes ( array $attributes )
$attributes array

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

            
radioLabelAttributes() public method

public self radioLabelAttributes ( array $attributes )
$attributes array

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

            
radioLabelWrap() public method

public self radioLabelWrap ( boolean $wrap )
$wrap boolean

                public function radioLabelWrap(bool $wrap): self
{
    $new = clone $this;
    $new->widget = $this->widget->radioLabelWrap($wrap);
    return $new;
}

            
radioWrapAttributes() public method

public self radioWrapAttributes ( array $attributes )
$attributes array

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

            
radioWrapClass() public method

public self radioWrapClass ( string|null $class )
$class string|null

                public function radioWrapClass(?string ...$class): self
{
    $new = clone $this;
    $new->widget = $this->widget->radioWrapClass(...$class);
    return $new;
}

            
radioWrapTag() public method

public self radioWrapTag ( string|null $name )
$name string|null

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

            
render() public method
public string render ( )

                final public function render(): string
{
    if ($this->isStartedByBegin) {
        $this->isStartedByBegin = false;
        return $this->renderEnd();
    }
    $this->beforeRender();
    $content = $this->generateContent();
    if ($content === null) {
        $this->enrichment = [];
        return '';
    }
    $result = $this->renderOpenContainerAndContent($content);
    if ($this->useContainer) {
        $result .= "\n" . Html::closeTag($this->containerTag);
    }
    $this->enrichment = [];
    return $result;
}

            
renderError() protected method

protected string renderError ( Yiisoft\Form\Field\Part\Error $error )
$error Yiisoft\Form\Field\Part\Error

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

            
renderHint() protected method

protected string renderHint ( Yiisoft\Form\Field\Part\Hint $hint )
$hint Yiisoft\Form\Field\Part\Hint

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

            
renderLabel() protected method

protected string renderLabel ( Yiisoft\Form\Field\Part\Label $label )
$label Yiisoft\Form\Field\Part\Label

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

            
separator() public method

public self separator ( string $separator )
$separator string

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

            
shouldHideLabel() protected method
protected boolean shouldHideLabel ( )

                protected function shouldHideLabel(): bool
{
    return false;
}

            
template() public method

Defined in: Yiisoft\Form\Field\Base\PartsField::template()

Set layout template for render a field.

public Yiisoft\Form\Field\RadioList template ( string $template )
$template string

                final public function template(string $template): static
{
    $new = clone $this;
    $new->template = $template;
    return $new;
}

            
templateBegin() public method
public Yiisoft\Form\Field\RadioList templateBegin ( string $template )
$template string

                final public function templateBegin(string $template): static
{
    $new = clone $this;
    $new->templateBegin = $template;
    return $new;
}

            
templateEnd() public method
public Yiisoft\Form\Field\RadioList templateEnd ( string $template )
$template string

                final public function templateEnd(string $template): static
{
    $new = clone $this;
    $new->templateEnd = $template;
    return $new;
}

            
token() public method
public Yiisoft\Form\Field\RadioList token ( string $token, string|\Stringable $value )
$token string
$value string|\Stringable

                final public function token(string $token, string|Stringable $value): static
{
    $this->validateToken($token);
    $new = clone $this;
    $new->extraTokens[$token] = $value;
    return $new;
}

            
tokens() public method
public Yiisoft\Form\Field\RadioList tokens ( array $tokens )
$tokens array

                final public function tokens(array $tokens): static
{
    $new = clone $this;
    foreach ($tokens as $token => $value) {
        if (!is_string($token)) {
            throw new InvalidArgumentException(
                sprintf(
                    'Token should be string. %s given.',
                    get_debug_type($token),
                )
            );
        }
        if (!is_string($value) && !$value instanceof Stringable) {
            throw new InvalidArgumentException(
                sprintf(
                    'Token value should be string or Stringable. %s given.',
                    get_debug_type($value),
                )
            );
        }
        $this->validateToken($token);
        $new->extraTokens[$token] = $value;
    }
    return $new;
}

            
uncheckValue() public method

public self uncheckValue ( boolean|float|integer|string|\Stringable|null $value )
$value boolean|float|integer|string|\Stringable|null

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

            
useContainer() public method
public Yiisoft\Form\Field\RadioList useContainer ( boolean $use )
$use boolean

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

            
validClass() public method
public self validClass ( string|null $class )
$class string|null

                public function validClass(?string $class): self
{
    $new = clone $this;
    $new->validClass = $class;
    return $new;
}

            
value() public method
public Yiisoft\Form\Field\RadioList value ( mixed $value )
$value mixed

                final public function value(mixed $value): static
{
    $new = clone $this;
    $new->customValue = $value;
    $new->useCustomValue = true;
    return $new;
}