Spec-Zone.ru › CakePHP 3.1

Класс RadioWidget

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

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

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

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

__constructsource 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
Экземпляр виджета метки.

_isDisabledsource protected

_isDisabled( array $radio , array|null|true $disabled )

Определение атрибута disabled.

Параметры

массив $radio
Информация о радиокнопке.
массив|null|true $disabled
Значения disabled.

Возвращает

boolean
bool

_renderInputsource protected

_renderInput( string|integer $val , string|array $text , array $data , Cake\View\Form\ContextInterface $context )

Отображает одиночный элемент ввода радио и метки.

Параметры

строка|целое число $val
Значение элемента ввода радио.
строка|массив $text
Текст метки или сложный тип радио.
массив $data
Дополнительные параметры для генерации элементов ввода.
Cake\View\Form\ContextInterface $context
Контекст формы

Возвращает

string
строка

_renderLabelsource 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-экранирование метки.

Возвращает

string
Сгенерированная метка.

rendersource 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
Текущий контекст формы.

Возвращает

string
строка

Реализация

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

secureFieldssource public

secureFields( array $data )

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

Параметры

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

Возвращает

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

Реализация

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

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

_clearIdssource protected

_clearIds( )

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

_domIdsource protected

_domId( string $value )

Генерирует ID, подходящий для использования в атрибуте ID.

Параметры

строка $value
Значение для преобразования в ID.

Возвращает

string
Сгенерированный id.

_idsource protected

_id( string $name , string $val )

Генерирует атрибут ID для элемента.

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

Параметры

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

Возвращает

string
Сгенерированный id.

Резюме свойств

$_labelsource

protected Cake\View\Widget\LabelWidget

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

$_templatessource

protected Cake\View\StringTemplate

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

Свойства, используемые из Cake\View\Helper\IdGeneratorTrait

$_idPrefixsource

protected строка

Префикс для атрибута id.

null

$_idSuffixessource

protected массив

Список суффиксов 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.1/class-Cake.View.Widget.RadioWidget.html

Spec-Zone.ru

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