Input widget class for generating a set of radio buttons.
This class is intended as an internal implementation detail of Cake\View\Helper\FormHelper and is not intended for direct use.
$_label
protected $_templates
protected Returns a list of fields that need to be secured for this widget. Fields are in the form of Model[field][suffix]
__construct( Cake\View\StringTemplate $templates , Cake\View\Widget\LabelWidget $label )
Constructor
This class uses a few templates:
radio
Used to generate the input for a radio button. Can use the following variables name
, value
, attrs
.radioWrapper
Used to generate the container element for the radio + input element. Can use the input
and label
variables.Cake\View\StringTemplate
$templates
Cake\View\Widget\LabelWidget
$label
_isDisabled( array $radio , array|null|true $disabled )
Disabled attribute detection.
$radio
$disabled
_renderInput( string|integer $val , string|array $text , array $data , Cake\View\Form\ContextInterface $context )
Renders a single radio input and label.
$val
$text
$data
Cake\View\Form\ContextInterface
$context
_renderLabel( array $radio , false|string|array $label , string $input , Cake\View\Form\ContextInterface $context , boolean $escape )
Renders a label element for a given radio button.
In the future this might be refactored into a separate widget as other input types (multi-checkboxes) will also need labels generated.
$radio
$label
$input
Cake\View\Form\ContextInterface
$context
$escape
render( array $data , Cake\View\Form\ContextInterface $context )
Render a set of radio buttons.
Data supports the following keys:
name
- Set the input name.options
- An array of options. See below for more information.disabled
- Either true or an array of inputs to disable. When true, the select element will be disabled.val
- A string of the option to mark as selected.label
- Either false to disable label generation, or an array of attributes for all labels.required
- Set to true to add the required attribute on all generated radios.idPrefix
Prefix for generated ID attributes.$data
Cake\View\Form\ContextInterface
$context
Cake\View\Widget\WidgetInterface::render()
secureFields( array $data )
Returns a list of fields that need to be secured for this widget. Fields are in the form of Model[field][suffix]
$data
Cake\View\Widget\WidgetInterface::secureFields()
_domId( string $value )
Generate an ID suitable for use in an ID attribute.
$value
_id( string $name , string $val )
Generate an ID attribute for an element.
Ensures that id's for a given set of fields are unique.
$name
$val
© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.4/class-Cake.View.Widget.RadioWidget.html