Spec-Zone.ru › CakePHP 3.8

Класс RadioWidget

Класс виджета ввода для генерации набора радиокнопок.

Этот класс предназначен как внутренняя реализация детали Cake\View\Helper\FormHelper и не предназначен для прямого использования.

Cake\View\Widget\RadioWidget реализует Cake\View\Widget\WidgetInterface использует Cake\View\Helper\IdGeneratorTrait
Пространство имён: Cake\View\Widget
Расположение: View/Widget/RadioWidget.php

Краткое описание свойств

  • $_label protected
    Cake\View\Widget\LabelWidget
    Экземпляр метки.
  • $_templates protected
    Cake\View\StringTemplate
    Экземпляр шаблона.

Унаследованные свойства

  • _idPrefix, _idSuffixes

Краткое описание методов

  • __construct() public
    Конструктор
  • _isDisabled() protected
    Определение атрибута «отключено».
  • _renderInput() protected
    Отображает один элемент ввода радиокнопки и метку.
  • _renderLabel() protected
    Отображает элемент метки для данной радиокнопки.
  • render() public
    Отображение набора радиокнопок.
  • secureFields() public

    Возвращает список полей, которые необходимо защитить для данного виджета. Поля представлены в формате Model[поле][суффикс]

Подробное описание методов

__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 )

Определение атрибута «отключено».

Параметры

массив $radio
Информация о радиокнопке.
массив|null|true $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 элемент выбора будет отключен.
  • 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[поле][суффикс]

Параметры

массив $data
Данные для отображения.

Возвращает

массив
Массив полей для защиты.

Реализация

Cake\View\Widget\WidgetInterface::secureFields()

Методы, используемые из Cake\View\Helper\IdGeneratorTrait

_clearIds()source protected

_clearIds( )

Очистка сохранённых суффиксов ID.

_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.

_idSuffix()source protected

_idSuffix( string $val )

Генерация суффикса ID.

Обеспечивает уникальность ID для заданного набора полей.

Параметры

строка $val
Значение атрибута ID.

Возвращает

строка
Сгенерированный суффикс id.

Подробное описание свойств

$_labelsource

protected Cake\View\Widget\LabelWidget

Экземпляр метки.

$_templatessource

protected Cake\View\StringTemplate

Экземпляр шаблона.

© 2005–present 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.8/class-Cake.View.Widget.RadioWidget.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API