-
Notifications
You must be signed in to change notification settings - Fork 21
Русская документация (Russian)
Библиотека содержит 3 вида форм:
- Вертикальная -
Twitter_Bootstrap3_Form_Horizontal - Горизонтальная -
Twitter_Bootstrap3_Form_Horizontal - Строчная -
Twitter_Bootstrap3_Form_Inline
| название | описание | видимость | тип | по умолчанию |
|---|---|---|---|---|
$_disposition |
Расположение формы | protected |
string |
* |
$_elementsSuccessClass |
Класс элементов со статусом "хорошо" по умолчанию | protected |
string |
has-success |
$_elementsWarningClass |
Класс элементов со статусом "предупреждение" по умолчанию | protected |
string |
has-warning |
$_elementsErrorClass |
Класс элементов со статусом "ошибка" по умолчанию | protected |
string |
has-error |
$_renderElementsStateIcons |
Отображать иконки статусов в элементах по умолчанию? | protected |
bool |
true |
$_elementsSuccessIcon |
Класс иконки элементов со статусом "хорошо" по умолчанию | protected |
string |
glyphicon glyphicon-ok |
$_elementsWarningIcon |
Класс иконки элементов со статусом "предупреждение" по умолчанию | protected |
string |
glyphicon glyphicon-warning-sign |
$_elementsErrorIcon |
Класс иконки элементов со статусом "ошибка" по умолчанию | protected |
string |
glyphicon glyphicon-remove |
| *зависит от вида формы: |
- для вертикальной -
Twitter_Bootstrap3_Form::DISPOSITION_VERTICAL - для горизонтальной -
Twitter_Bootstrap3_Form::DISPOSITION_HORIZONTAL - для строчных -
Twitter_Bootstrap3_Form::DISPOSITION_INLINE
Возвратить массив декораторов для элементов типов: Text, Password, DateTime, DateTimeLocal, Date, Month, Time, Week, Number, Email, Url, Search, Tel, Color, Note, Static, Select, Multiselect, File, Textarea, Radio и MultiCheckbox. Для элементов типов Note, Static, Select, Multiselect, File, Textarea, Radio и MultiCheckbox пропускается декоратор Feedback_State из возвращенных методом.
Возвратить массив декораторов для элементов типа Captcha.
Возвратить массив декораторов для элементов типа Checkbox.
Возвратить массив декораторов для элементов типов: Button, Submit и Reset.
Возвратить массив декораторов для элементов типа Image.
Добавить класс к форме.
Библиотека поддерживает оформление по правилам Bootstrap для всех стандартных элементов форм Zend и дополняет их несколькими элементами форм, поддерживаемыми Bootstrap. Ниже приведены все добавленные и дополненные элементы форм.
Основанные на теге <input> Datetime, Datetime-Local, Date, Month, Time, Week, Number, Email, Url, Search, Tel и Color
Элементы основаны на элементе Text.
Представление элементов использует переопределенное представление элемента Text, в котором атрибут type тега <input> вынесен в параметр.
Представление элементов дополнено обязательным классом btn.
| название | описание | тип | обязательность | по умолчанию | пример |
|---|---|---|---|---|---|
class |
Дополнительные классы (кроме обязательного btn) |
string |
нет | btn-default |
btn-warning |
noBtnClass |
Отключить обязательный класс btn? |
bool |
нет | false |
true |
Представление элемента дополнено обязательным классом btn.
| название | описание | тип | обязательность | по умолчанию | пример |
|---|---|---|---|---|---|
class |
Дополнительные классы (кроме обязательного btn) |
string |
нет | btn-primary |
btn-default |
noBtnClass |
Отключить обязательный класс btn? |
bool |
нет | false |
true |
Элемент Note является псевдонимом элемента Static.
Параметры начинающиеся с wrapper_ применяются к обертке элемента.
Параметры начинающиеся с label_ применяются к этикеткам элемента.
| название | описание | тип | обязательность | по умолчанию | пример |
|---|---|---|---|---|---|
inline |
В строку выводить элементы? | bool |
нет | false |
true |
Библиотека содержит ряд декораторов переопределяющих и дополняющих стандартные декораторы Zend функциональностью Bootstrap.
Декоратор дополнений (add-ons) для строчных элементов форм.
ВАЖНО: в элемент может быть добавлена только одно дополнение с каждой из сторон.
Параметры могут быть указаны для декоратора или элемента форм.
| название | описание | тип | обязательность | по умолчанию | пример |
|---|---|---|---|---|---|
prependAddon |
Дополнение перед элементом | string |
нет | $ |
|
appendAddon |
Дополнение после элемента | string |
нет | .00 |
В ближайшее время библиотека получит поддержку активных дополнений строчных элементов форм (флажки, радио-переключатели, кнопки). Интерфейс дополнений при этом будет дополнен с сохранением обратной совместимости.
Декоратор обертки элемента флажка.
Декоратор основан на декораторе Zend_Form_Decorator_HtmlTag.
Декоратор этикетки (label) элемента флажка.
Декоратор основан на декораторе Zend_Form_Decorator_HtmlTag.
Декоратор контейнера элемента формы со всеми сопутствующими тегами.
Декоратор основан на декораторе Zend_Form_Decorator_HtmlTag.
| название | описание | тип | обязательность | по умолчанию | пример |
|---|---|---|---|---|---|
dimension |
Ширина контейнера | string |
нет | lg-4,sm-6 |
|
beforeContent |
HTML-вставка перед содержимым | `string | array` | нет | |
afterContent |
HTML-вставка после содержимого | `string | array` | нет | |
noState |
Флаг запрета отображения статуса элемента | bool |
нет | true |
false |
Добавляет HTML-вставку для размещения перед основным содержимым контейнера. Может быть добавлено неограниченное число вставок.
Добавляет HTML-вставку для размещения после основного содержимого контейнера. Может быть добавлено неограниченное число вставок.
Удаляет все HTML-вставки для размещения перед основным содержимым контейнера.
Удаляет все HTML-вставки для размещения после основного содержимого контейнера.
Декоратор предназначен для добавления иконок в основанные на теге элементы формы.
ВАЖНО: в элемент может быть добавлена только одна иконка с каждой из сторон.
| название | описание | тип | обязательность | по умолчанию | пример |
|---|---|---|---|---|---|
icon |
Позволяет указать класс иконки | string |
да | glyphicon glyphicon-ok |
|
align |
Сторона (правая или левая) | string |
нет | right |
left |
Параметр align может принимать только одно из двух значений left или right. |
Декоратор предназначен для добавления иконок состояния в основанные на теге <input> элементы формы.
| название | описание | тип | обязательность | по умолчанию | пример |
|---|---|---|---|---|---|
renderIcon |
Рендерить иконку? | bool |
нет | true |
false |
successIcon |
Класс иконки состояния "хорошо" | string |
нет | glyphicon glyphicon-ok |
|
warningIcon |
Класс иконки состояния "предупреждение" | string |
нет | glyphicon glyphicon-warning-sign |
|
errorIcon |
Класс иконки состояния "ошибка" | string |
нет | glyphicon glyphicon-remove |
Декоратор для указания размеров элемента формы.
| название | описание | тип | обязательность | по умолчанию | пример |
|---|---|---|---|---|---|
dimension |
Ширина контейнера | string |
нет | lg-4,sm-6 |
|
noAttribs |
Отображать атрибуты? | bool |
нет | true |
false |
Если параметр noAttribs указан как false и параметр dimension не указан, то контейнер не рендерится (используется входящий контент без изменений).
Декоратор предназначен для отображения контейнера элемента в горизонтальных формах.
Декоратор основан на декораторе Zend_Form_Decorator_HtmlTag.
| название | описание | тип | обязательность | по умолчанию | пример |
|---|---|---|---|---|---|
dimension |
Ширина контейнера с контроллами | string |
нет | sm-10 |
lg-4,sm-6 |
dimensionLabel |
Ширина этикетки | string |
нет | sm-2 |
lg-4,sm-6 |
noLabel |
Отображается этикетка? | bool |
нет | false |
true |
Если параметр noLabel установлен в значение true, то контейнер с контроллами получает отстуты с шириной, указанной для этикетки (label).
Декоратор предназначен для отображения этикетки в горизонтальных формах.
Декоратор основан на декораторе Zend_Form_Decorator_Label.
| название | описание | тип | обязательность | по умолчанию | пример |
|---|---|---|---|---|---|
dimension |
Ширина | string |
нет | sm-2 |
lg-4,sm-6 |
Переопределение декоратора ViewHelper отфильтровывает атрибуты декораторов.
В Bootstrap нету описания как должны отображаться сообщения об ошибках в элементах форм.
Одним из принципов библиотеки является реализация только стандартного форматирования Bootstrap, по этому отображение ошибок было модифицировано только дополнением классом help-block, предписанным справочной информации по элементу.
Вывод ошибок в виде списка сохранено.
В репозитории Zend1-Bootstrap3 Skeleton приведен пример переопределения вывода ошибок, когда сообщения об ошибках выглядят как последовательные абзацы, начинаемые со значка ошибки.