Класс RadioWidget
Класс виджета ввода для генерации набора радиокнопок.
Этот класс предназначен как внутренняя деталь реализации Cake\View\Helper\FormHelper и не предназначен для непосредственного использования.
- Cake\View\Widget\RadioWidget реализует Cake\View\Widget\WidgetInterface использует Cake\View\Helper\IdGeneratorTrait
Краткое описание свойств
- Экземпляр метки.
$_labelprotected - Экземпляр шаблона.
$_templatesprotected
Наследованные свойства
Краткое описание методов
- __construct() publicКонструктор
- _isDisabled() protectedОпределение атрибута disabled.
- _renderInput() protectedОтображает одну радиокнопку и метку.
- _renderLabel() protectedОтображает элемент метки для заданной радиокнопки.
- render() publicОтображает набор радиокнопок.
- secureFields() public
Возвращает список полей, которые необходимо защитить для этого виджета. Поля имеют формат Model[field][suffix]
Подробное описание методов
__construct()source public
__construct( Cake\View\StringTemplate $templates , Cake\View\Widget\LabelWidget $label )
Конструктор
Этот класс использует несколько шаблонов:
-
radioИспользуется для генерации ввода для радиокнопки. Может использовать следующие переменныеname,value,attrs. -
radioWrapperИспользуется для генерации контейнерного элемента для радиокнопки + элемента ввода. Может использовать переменныеinputиlabel.
Параметры
-
Cake\View\StringTemplate$templates - Список шаблонов.
-
Cake\View\Widget\LabelWidget$label - Экземпляр виджета метки.
_isDisabled()source protected
_isDisabled( array $radio , array|null|true $disabled )
Определение атрибута disabled.
Параметры
- массив
$radio - Информация о радиокнопке.
- массив|null|true
$disabled - Значения disabled.
Возвращает
boolean_renderInput()source protected
_renderInput( string|integer $val , string|array $text , array $data , Cake\View\Form\ContextInterface $context )
Отображает одну радиокнопку и метку.
Параметры
- строка|целое число
$val - Значение радиокнопки.
- строка|массив
$text - Текст метки или сложный тип радиокнопки.
- массив
$data - Дополнительные параметры для генерации ввода.
-
Cake\View\Form\ContextInterface$context - Контекст формы
Возвращает
строка_renderLabel()source protected
_renderLabel( array $radio , false|string|array $label , string $input , Cake\View\Form\ContextInterface $context , boolean $escape )
Отображает элемент метки для заданной радиокнопки.
В будущем это может быть переработано в отдельный виджет, так как другим типам ввода (многозначным чекбоксам) также понадобятся сгенерированные метки.
Параметры
- массив
$radio - Свойства ввода.
- false|строка|массив
$label - Свойства для метки.
- строка
$input - Виджет ввода.
-
Cake\View\Form\ContextInterface$context - Контекст формы.
- булево
$escape - Нужно ли HTML-экранировать метку.
Возвращает
строка|булевоСгенерированная метка.
render()source public
render( array $data , Cake\View\Form\ContextInterface $context )
Отображает набор радиокнопок.
Данные поддерживают следующие ключи:
-
name- Установить имя ввода. -
options- Массив параметров. См. ниже для получения дополнительной информации. -
disabled- Либо true, либо массив входов для отключения. При true элемент select будет отключён. -
val- Строка опции, которая нужно отметить как выбранную. -
label- Либо false для отключения генерации меток, либо массив атрибутов для всех меток. -
required- Установите в true, чтобы добавить атрибут required ко всем сгенерированным радиокнопкам. -
idPrefixПрефикс для сгенерированных атрибутов ID.
Параметры
- массив
$data - Данные для создания радиокнопок.
-
Cake\View\Form\ContextInterface$context - Текущий контекст формы.
Возвращает
строкаРеализация
Cake\View\Widget\WidgetInterface::render() secureFields()source public
secureFields( array $data )
Возвращает список полей, которые необходимо защитить для этого виджета. Поля имеют формат Model[field][suffix]
Параметры
- массив
$data - Данные для отображения.
Возвращает
массивМассив полей для защиты.
Реализация
Cake\View\Widget\WidgetInterface::secureFields() Методы, используемые из Cake\View\Helper\IdGeneratorTrait
_domId()source protected
_domId( string $value )
Сгенерировать ID, подходящий для использования в атрибуте ID.
Параметры
- строка
$value - Значение для преобразования в ID.
Возвращает
строкаСгенерированный id.
_id()source protected
_id( string $name , string $val )
Сгенерировать атрибут ID для элемента.
Обеспечивает уникальность ID для заданного набора полей.
Параметры
- строка
$name - Имя атрибута ID.
- строка
$val - Значение атрибута ID.
Возвращает
строкаСгенерированный id.
Подробное описание свойств
© 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