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