Spec-Zone.ru › CakePHP 4.3

Класс RadioWidget

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

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

Пространство имен: Cake\View\Widget

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

  • $_idPrefix protected
    string|null

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

  • $_idSuffixes protected
    array<string>

    Список суффиксов id, используемых в текущем рендеринге.

  • $_label protected
    Cake\View\Widget\LabelWidget

    Экземпляр Label.

  • $_templates protected
    Cake\View\StringTemplate

    Экземпляр StringTemplate.

  • $defaults protected
    array<string, mixed>

    Значения по умолчанию.

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

  • __construct() public

    Конструктор

  • _clearIds() protected

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

  • _domId() protected

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

  • _id() protected

    Сгенерировать атрибут ID для элемента.

  • _idSuffix() protected

    Сгенерировать суффикс ID.

  • _isDisabled() protected

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

  • _renderInput() protected

    Отображает один элемент ввода радиокнопки и метку.

  • _renderLabel() protected

    Отображает элемент метки для данной радиокнопки.

  • mergeDefaults() protected

    Объединить значения по умолчанию с предоставленными данными.

  • render() public

    Отобразить набор радиокнопок.

  • secureFields() public

    Возвращает список полей, которые необходимо защитить для этого виджета.

  • setMaxLength() protected

    Установить значение для атрибута "maxlength", если применимо.

  • setRequired() protected

    Установить значение для атрибута "required", если применимо.

  • setStep() protected

    Установить значение для атрибута "step", если применимо.

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

__construct() 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

Экземпляр виджета метки.

_clearIds() protected 

_clearIds(): void

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

Возвращает

void

_domId() protected 

_domId(string $value): string

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

Параметры

string $value

Значение для преобразования в ID.

Возвращает

string

_id() protected 

_id(string $name, string $val): string

Сгенерировать атрибут ID для элемента.

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

Параметры

string $name

Имя атрибута ID.

string $val

Значение атрибута ID.

Возвращает

string

_idSuffix() protected 

_idSuffix(string $val): string

Сгенерировать суффикс ID.

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

Параметры

string $val

Значение атрибута ID.

Возвращает

string

_isDisabled() protected 

_isDisabled(array<string, mixed> $radio, array|true|null $disabled): bool

Обнаружение атрибута disabled.

Параметры

array<string, mixed> $radio

Информация о радиокнопке.

array|true|null $disabled

Значения disabled.

Возвращает

bool

_renderInput() protected 

_renderInput(string|int $val, array<string, mixed>|string $text, array<string, mixed> $data, Cake\View\Form\ContextInterface $context): string

Отображает отдельную радиокнопку и метку.

Параметры

string|int $val

Значение радиокнопки.

array<string, mixed>|string $text

Текст метки или сложный тип радиокнопки.

array<string, mixed> $data

Дополнительные параметры для генерации входного элемента.

Cake\View\Form\ContextInterface $context

Контекст формы.

Возвращает

string

_renderLabel() protected 

_renderLabel(array<string, mixed> $radio, array<string, mixed>|string|false $label, string $input, Cake\View\Form\ContextInterface $context, bool $escape): string|false

Отображает элемент метки для заданной радиокнопки.

В будущем это может быть переработано в отдельный виджет, так как другим типам ввода (много выборов) также понадобятся сгенерированные метки.

Параметры

array<string, mixed> $radio

Свойства входного элемента.

array<string, mixed>|string|false $label

Свойства метки.

string $input

Виджет входного элемента.

Cake\View\Form\ContextInterface $context

Контекст формы.

bool $escape

Нужно ли экранировать метку HTML.

Возвращает

string|false

mergeDefaults() protected 

mergeDefaults(array<string, mixed> $data, Cake\View\Form\ContextInterface $context): array<string, mixed>

Объединить значения по умолчанию с предоставленными данными.

Параметры

array<string, mixed> $data

Массив данных.

Cake\View\Form\ContextInterface $context

Экземпляр контекста.

Возвращает

array<string, mixed>

render() public 

render(array<string, mixed> $data, Cake\View\Form\ContextInterface $context): string

Отобразить набор радиокнопок.

Данные поддерживают следующие ключи:

  • name - Установить имя входного элемента.
  • options - Массив вариантов. Подробнее см. ниже.
  • disabled - Либо true, либо массив входных элементов для отключения. Если true, элемент select будет отключён.
  • val - Строка варианта, который нужно отметить как выбранный.
  • label - Либо false для отключения генерации метки, либо массив атрибутов для всех меток.
  • required - Установить в true, чтобы добавить атрибут required ко всем сгенерированным радиокнопкам.
  • idPrefix Префикс для сгенерированных атрибутов ID.

Параметры

array<string, mixed> $data

Данные для создания радиокнопок.

Cake\View\Form\ContextInterface $context

Текущий контекст формы.

Возвращает

string

secureFields() public 

secureFields(array<string, mixed> $data): array<string>

Возвращает список полей, которые нужно защитить для этого виджета.

Параметры

array<string, mixed> $data

Возвращает

array<string>

setMaxLength() protected 

setMaxLength(array<string, mixed> $data, Cake\View\Form\ContextInterface $context, string $fieldName): array<string, mixed>

Установить значение атрибута "maxlength", если применимо.

Параметры

array<string, mixed> $data

Массив данных.

Cake\View\Form\ContextInterface $context

Экземпляр контекста.

string $fieldName

Имя поля.

Возвращает

array<string, mixed>

setRequired() protected 

setRequired(array<string, mixed> $data, Cake\View\Form\ContextInterface $context, string $fieldName): array<string, mixed>

Установить значение атрибута "required", если применимо.

Параметры

array<string, mixed> $data

Массив данных.

Cake\View\Form\ContextInterface $context

Экземпляр контекста.

string $fieldName

Имя поля.

Возвращает

array<string, mixed>

setStep() protected 

setStep(array<string, mixed> $data, Cake\View\Form\ContextInterface $context, string $fieldName): array<string, mixed>

Установить значение атрибута "step", если применимо.

Параметры

array<string, mixed> $data

Массив данных.

Cake\View\Form\ContextInterface $context

Экземпляр контекста.

string $fieldName

Имя поля.

Возвращает

array<string, mixed>

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

$_idPrefix protected

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

Тип

string|null

$_idSuffixes protected

Список суффиксов ID, используемых в текущем отображении.

Тип

array<string>

$_label protected

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

Тип

Cake\View\Widget\LabelWidget

$_templates protected

Экземпляр StringTemplate.

Тип

Cake\View\StringTemplate

$defaults protected

Значения по умолчанию для данных.

Тип

array<string, mixed>

© 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/4.3/class-Cake.View.Widget.RadioWidget.html

Spec-Zone.ru

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