Класс: FormFieldBuilder¶
Краткое содержание:¶
Fluent-строитель одного поля формы в цепочке FormSchemaBuilder.
Свойства¶
- private $description
- private $filter
- private $columns
Методы¶
- public __construct()
- public description()
- public options()
- public filter()
- public default()
- public columns()
- public metro()
- public text()
- public number()
- public select()
- public multi()
- public checkbox()
- public textarea()
- public hidden()
- public section()
- public build()
- public toField()
Подробности¶
- Путь:
devcraft/src/classes/Form/FormFieldBuilder.php
Детали¶
Свойства¶
$description¶
Описание поля.
$filter¶
Битовая маска фильтра DLE.
$columns¶
Число колонок сетки.
Методы¶
__construct()¶
Создаёт строитель поля в контексте секции и схемы.
С версии: 200.4.0
Параметры: - $sectionBuilder — Родительская секция. - $schemaBuilder — Корневая схема. - $id — Идентификатор поля. - $type — Тип поля. - $label — Подпись поля. - $description — Описание поля. - $filter — Битовая маска фильтра DLE. - $default — Значение по умолчанию. - $columns — Число колонок сетки.
description()¶
Задаёт описание поля.
С версии: 200.4.0
Параметры: - $description — Текст подсказки.
Возвращает: self — Текущий строитель для цепочки.
options()¶
Задаёт варианты выбора для select или multi.
С версии: 200.4.0
Возвращает: self — Текущий строитель.
filter()¶
Задаёт битовую маску фильтра DLE для поля.
С версии: 200.4.0
Параметры: - $filter — Маска фильтра.
Возвращает: self — Текущий строитель.
default()¶
Задаёт значение по умолчанию.
С версии: 200.4.0
Параметры: - $default — Значение по умолчанию.
Возвращает: self — Текущий строитель.
columns()¶
Задаёт ширину поля в колонках сетки Metro.
С версии: 200.4.0
Параметры: - $columns — Число колонок (1–12).
Возвращает: self — Текущий строитель.
metro()¶
Задаёт дополнительные атрибуты Metro UI.
С версии: 200.4.0
Возвращает: self — Текущий строитель.
text()¶
Начинает описание текстового поля в текущей секции.
С версии: 200.4.0
Параметры: - $id — Идентификатор поля. - $label — Подпись.
Возвращает: self — Новый строитель text-поля.
number()¶
Начинает описание числового поля.
С версии: 200.4.0
Параметры: - $id — Идентификатор поля. - $label — Подпись.
Возвращает: self — Новый строитель number-поля.
select()¶
Начинает описание поля select.
С версии: 200.4.0
Параметры: - $id — Идентификатор поля. - $label — Подпись.
Возвращает: self — Новый строитель select-поля.
multi()¶
Начинает описание поля множественного выбора.
С версии: 200.4.0
Параметры: - $id — Идентификатор поля. - $label — Подпись.
Возвращает: self — Новый строитель multi-поля.
checkbox()¶
Начинает описание чекбокса.
С версии: 200.4.0
Параметры: - $id — Идентификатор поля. - $label — Подпись.
Возвращает: self — Новый строитель checkbox-поля.
textarea()¶
Начинает описание многострочного поля.
С версии: 200.4.0
Параметры: - $id — Идентификатор поля. - $label — Подпись.
Возвращает: self — Новый строитель textarea-поля.
hidden()¶
Начинает описание скрытого поля.
С версии: 200.4.0
Параметры: - $id — Идентификатор поля. - $label — Подпись (может быть пустой).
Возвращает: self — Новый строитель hidden-поля.
section()¶
Фиксирует текущее поле и открывает новую секцию.
С версии: 200.4.0
Параметры: - $title — Заголовок новой секции.
Возвращает: FormSectionBuilder — Строитель новой секции.
build()¶
Фиксирует поле и возвращает готовую схему формы.
С версии: 200.4.0
Возвращает: \DevCraft\Types\FormSchema — Собранная схема.
toField()¶
Преобразует накопленные параметры в объект FormField.
С версии: 200.4.0
Возвращает: FormField — Immutable-описание поля.