Skip to content
PHP Ecosystem
Explore

RadioList

API reference › HTML › Form › RadioList

final classUIAwesome\Html\Form\RadioList
ExtendsAbstractChoiceList » UIAwesome\Html\Core\Element\BaseBlock » UIAwesome\Html\Core\Base\BaseTag
ImplementsUIAwesome\Html\Contracts\Form\CheckedStateInterface, UIAwesome\Html\Contracts\Form\ChoiceListInterface, UIAwesome\Html\Contracts\Form\FormControlInterface, UIAwesome\Html\Contracts\Attribute\AttributesInterface, UIAwesome\Html\Contracts\Element\BlockInterface, UIAwesome\Html\Contracts\Element\ClearableContentInterface, UIAwesome\Html\Contracts\RenderableInterface
Uses traitsUIAwesome\Html\Attribute\HasName, UIAwesome\Html\Attribute\Global\CanBeAutofocus, UIAwesome\Html\Attribute\Global\CanBeHidden, UIAwesome\Html\Attribute\Global\HasAccesskey, UIAwesome\Html\Attribute\Global\HasAria, UIAwesome\Html\Mixin\HasAttributes, UIAwesome\Html\Attribute\Global\HasClass, UIAwesome\Html\Mixin\HasContent, UIAwesome\Html\Attribute\Global\HasContentEditable, UIAwesome\Html\Attribute\Global\HasData, UIAwesome\Html\Attribute\Global\HasDir, UIAwesome\Html\Attribute\Global\HasDraggable, UIAwesome\Html\Attribute\Global\HasEvents, UIAwesome\Html\Attribute\Global\HasId, UIAwesome\Html\Attribute\Global\HasLang, UIAwesome\Html\Attribute\Global\HasMicroData, UIAwesome\Html\Attribute\Global\HasRole, UIAwesome\Html\Attribute\Global\HasSpellcheck, UIAwesome\Html\Attribute\Global\HasStyle, UIAwesome\Html\Attribute\Global\HasTabindex, UIAwesome\Html\Attribute\Global\HasTitle, UIAwesome\Html\Attribute\Global\HasTranslate, UIAwesome\Html\Core\Event\HasAfterRun, UIAwesome\Html\Core\Event\HasBeforeRun
Sourcesrc/Form/RadioList.php

Renders a list of <input type="radio"> controls sharing one name.

Every item input keeps the plain list name so the browser submits a single value.

See also: https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input/radio (AbstractChoiceList for the base implementation.).

PropertyTypeDescriptionDefined by
$attributes protectedmixed[]HTML attributes array used by the implementing class. Default: [].UIAwesome\Html\Mixin\HasAttributes
$content protectedstringContent string assigned to the element. Default: ''.UIAwesome\Html\Mixin\HasContent
MethodDescriptionDefined by
__construct() finalInitializes a new tag instance.UIAwesome\Html\Core\Base\BaseTag
__toString()Returns the rendered tag string.UIAwesome\Html\Core\Base\BaseTag
accesskey()Sets the accesskey attribute.UIAwesome\Html\Attribute\Global\HasAccesskey
addAriaAttribute()Sets an aria-* attribute.UIAwesome\Html\Attribute\Global\HasAria
addAttribute()Adds or updates a single HTML attribute for the element.UIAwesome\Html\Mixin\HasAttributes
addDataAttribute()Sets a data-* attribute.UIAwesome\Html\Attribute\Global\HasData
addEvent()Sets an on* event attribute.UIAwesome\Html\Attribute\Global\HasEvents
ariaAttributes()Sets multiple aria-* attributes.UIAwesome\Html\Attribute\Global\HasAria
attributes()Adds or updates multiple HTML attributes for the element.UIAwesome\Html\Mixin\HasAttributes
autofocus()Sets the autofocus attribute.UIAwesome\Html\Attribute\Global\CanBeAutofocus
begin() finalStarts begin/end rendering for this instance.UIAwesome\Html\Core\Element\BaseBlock
checked()Sets the values determining which items are checked.AbstractChoiceList
class()Sets the class attribute.UIAwesome\Html\Attribute\Global\HasClass
clearContent()Clears encoded and raw content without changing other component state.UIAwesome\Html\Mixin\HasContent
config()Applies application-scoped config recipes to this tag.UIAwesome\Html\Core\Base\BaseTag
content()Appends encoded content.UIAwesome\Html\Mixin\HasContent
contentEditable()Sets the contenteditable attribute.UIAwesome\Html\Attribute\Global\HasContentEditable
dataAttributes()Sets multiple data-* attributes.UIAwesome\Html\Attribute\Global\HasData
dir()Sets the dir attribute.UIAwesome\Html\Attribute\Global\HasDir
draggable()Sets the draggable attribute.UIAwesome\Html\Attribute\Global\HasDraggable
enclosedByLabel()Configures whether every item input and its text are enclosed by the item label.AbstractChoiceList
end() static finalEnds the most recent begin/end rendering block for the current class.UIAwesome\Html\Core\Element\BaseBlock
events()Sets multiple on* event attributes.UIAwesome\Html\Attribute\Global\HasEvents
getAttribute()Returns the value of a single HTML attribute.UIAwesome\Html\Mixin\HasAttributes
getAttributes()Returns the array of HTML attributes for the element.UIAwesome\Html\Mixin\HasAttributes
getContent()Returns the content assigned to the element.UIAwesome\Html\Mixin\HasContent
hidden()Sets the hidden attribute.UIAwesome\Html\Attribute\Global\CanBeHidden
html()Appends trusted raw HTML content without encoding or sanitizing it.UIAwesome\Html\Mixin\HasContent
id()Sets the id attribute.UIAwesome\Html\Attribute\Global\HasId
isList()Identifies this control as a list so field wrappers render a group label instead of a for label.AbstractChoiceList
itemAttributes()Sets attributes applied to every item input.AbstractChoiceList
itemContainerAttributes()Sets attributes applied to the container enclosing every item input and label.AbstractChoiceList
itemContainerClass()Adds CSS classes to the container enclosing every item input and label.AbstractChoiceList
itemContainerTag()Sets the tag enclosing every item input and label.AbstractChoiceList
itemId()Sets the itemid attribute.UIAwesome\Html\Attribute\Global\HasMicroData
itemLabelAttributes()Sets default attributes applied to every item label.AbstractChoiceList
itemLabelClass()Adds CSS classes to every item label.AbstractChoiceList
itemProp()Sets the itemprop attribute.UIAwesome\Html\Attribute\Global\HasMicroData
itemRef()Sets the itemref attribute.UIAwesome\Html\Attribute\Global\HasMicroData
items()Replaces the items rendered by the list.AbstractChoiceList
itemScope()Sets the itemscope attribute.UIAwesome\Html\Attribute\Global\HasMicroData
itemType()Sets the itemtype attribute.UIAwesome\Html\Attribute\Global\HasMicroData
lang()Sets the lang attribute.UIAwesome\Html\Attribute\Global\HasLang
name()Sets the name attribute.UIAwesome\Html\Attribute\HasName
removeAriaAttribute()Removes an aria-* attribute.UIAwesome\Html\Attribute\Global\HasAria
removeAttribute()Removes a specific HTML attribute from the element.UIAwesome\Html\Mixin\HasAttributes
removeDataAttribute()Removes a data-* attribute.UIAwesome\Html\Attribute\Global\HasData
removeEvent()Removes an on* event attribute.UIAwesome\Html\Attribute\Global\HasEvents
render() finalRenders the tag with lifecycle hooks.UIAwesome\Html\Core\Base\BaseTag
replaceAttributes()Replaces all HTML attributes for the element.UIAwesome\Html\Mixin\HasAttributes
role()Sets the role attribute.UIAwesome\Html\Attribute\Global\HasRole
spellcheck()Sets the spellcheck attribute.UIAwesome\Html\Attribute\Global\HasSpellcheck
style()Sets the style attribute.UIAwesome\Html\Attribute\Global\HasStyle
tabIndex()Sets the tabindex attribute.UIAwesome\Html\Attribute\Global\HasTabindex
tag() staticCreates and configures a new tag instance.UIAwesome\Html\Core\Base\BaseTag
title()Sets the title attribute.UIAwesome\Html\Attribute\Global\HasTitle
translate()Sets the translate attribute.UIAwesome\Html\Attribute\Global\HasTranslate
uncheckedValue()Sets the value submitted when no list item is selected.AbstractChoiceList
afterRun() protectedPost-processes rendered output.UIAwesome\Html\Core\Event\HasAfterRun
beforeRun() protectedValidates state before rendering.UIAwesome\Html\Core\Event\HasBeforeRun
createInput() protectedCreates the atomic input used for each item.RadioList
getTag() protectedReturns the tag enumeration for the list container.AbstractChoiceList
isBeginExecuted() protectedIndicates whether this instance has an open or closing operation in the current context.UIAwesome\Html\Core\Element\BaseBlock
loadDefault() protectedReturns class-level default definitions.UIAwesome\Html\Core\Base\BaseTag
run() protectedRenders the list container with its content, the unchecked input, and every item.AbstractChoiceList
runBegin() protectedReturns the opening tag for begin/end rendering.AbstractChoiceList
usesArrayName() protectedReturns whether item names use array notation.RadioList
protected function createInput(): UIAwesome\Html\Form\InputRadio

Creates the atomic input used for each item.

Returns

InputRadio: Radio input element instance.

protected function usesArrayName(): false

Returns whether item names use array notation.

Returns

false: Always false, so every item input keeps the plain list name.