Класс FormHelper

__callsource public

__call( string $method , array $params )

Обработчик отсутствующего метода — реализует различные простые типы ввода. Используется для создания элементов ввода различных типов. Например, $this->Form->text(); создаст <input type="text" />, а $this->Form->range(); создаст <input type="range" />

Использование

$this->Form->search('User.query', ['value' => 'test']);

Создаст элемент ввода, подобный:

<input type="search" id="UserQuery" name="User[query]" value="test" />

Первый аргумент типа ввода всегда должен быть именем поля в формате Model.field. Второй аргумент всегда должен быть массивом атрибутов для элемента ввода.

Параметры

строка $method

Имя метода/тип ввода для создания.

массив $params

Параметры для вызова метода.

Возвращает

string
Метод форматированного элемента ввода.

Вызывает исключение

Cake\Core\Exception\Exception
Когда нет параметров для вызова метода.

Переопределяет

Cake\View\Helper::__call()

__constructsource public

__construct( Cake\View\View $View , array $config [] )

Создаёт виджеты и связывает поставщиков контекста по умолчанию.

Параметры

Cake\View\View $View

Представление, к которому прикреплён помощник.

массив $config необязательно []

Настройки конфигурации помощника.

Переопределяет

Cake\View\Helper::__construct()

_addDefaultContextProviderssource protected

_addDefaultContextProviders( )

Добавляет стандартный набор поставщиков контекста, предоставляемых CakePHP.

_csrfFieldsource protected

_csrfField( )

Возвращает элемент CSRF, если данные запроса присутствуют. Используется для защиты форм в сочетании с CsrfComponent и SecurityComponent.

Возвращает

string
строка

_datetimeOptionssource protected

_datetimeOptions( array $options )

Вспомогательный метод для преобразования данных опций FormHelper в формат виджета.

Параметры

массив $options

Опции для преобразования.

Возвращает

array
Преобразованные параметры.

_extractOptionsource protected

_extractOption( string $name , array $options , mixed $default null )

Извлекает одну опцию из массива опций.

Параметры

строка $name

Имя опции, которую нужно извлечь.

массив $options

Массив опций, из которого нужно извлечь.

смешанный $default необязательно null

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

Возвращает

mixed
Содержимое опции или значение по умолчанию.

_formUrlsource protected

_formUrl( Cake\View\Form\ContextInterface $context , array $options )

Создаёт URL для формы на основе опций.

Параметры

Cake\View\Form\ContextInterface $context

Объект контекста для использования.

массив $options

Массив опций из create()

Возвращает

string
Атрибут action для формы.

_getContextsource protected

_getContext( mixed $data [] )

Находит соответствующего поставщика контекста для данных.

Если тип не может быть сопоставлен, будет возвращён NullContext.

Параметры

смешанный $data необязательно []

Данные для поиска поставщика контекста.

Возвращает

mixed
Поставщик контекста.

Вызывает исключение

RuntimeException
если класс контекста не реализует ContextInterface.

_getInputsource protected

_getInput( string $fieldName , array $options )

Генерирует элемент ввода.

Параметры

строка $fieldName

Имя поля.

массив $options

Опции для элемента ввода.

Возвращает

string
Сгенерированный элемент ввода.

_getLabelsource protected

_getLabel( string $fieldName , array $options )

Генерирует метку для элемента ввода.

Параметры

строка $fieldName

Имя поля для генерации метки.

массив $options

Список опций.

Возвращает

boolean|string
false или сгенерированный элемент метки.

_groupTemplatesource protected

_groupTemplate( array $options )

Генерирует элемент шаблона группы.

Параметры

массив $options

Опции для шаблона группы.

Возвращает

string
Сгенерированный шаблон группы.

_initInputFieldsource protected

_initInputField( string $field , array $options [] )

Устанавливает значения по умолчанию для поля и добавляет поле в хеш ввода для защиты формы. Также добавит класс ошибки, если поле содержит ошибки валидации.

Опции

• secure - логическое значение, указывающее, следует ли добавлять поле в поля безопасности. Отключение поля с помощью опции disabled, также исключит поле из хэшированного ключа.
• default - смешанный тип - значение, которое нужно использовать, если в контексте формы нет значения.
• disabled - смешанный тип - логическое значение, указывающее на состояние отключения, или строка в численно индексированном значении.

Этот метод преобразует численно индексированное «disabled» в ассоциативное значение массива. Внутренние компоненты FormHelper ожидают ассоциативные опции.

Результат этой функции — более полный набор атрибутов ввода, которые можно передать виджету формы для генерации фактического элемента ввода.

Параметры

строка $field

Имя поля для инициализации опций.

массив $options необязательно []

Массив опций для добавления дополнительных опций.

Возвращает

array
Массив опций для элемента ввода.

_inputContainerTemplatesource protected

_inputContainerTemplate( array $options )

Генерирует шаблон контейнера ввода.

Параметры

массив $options

Опции для шаблона контейнера ввода.

Возвращает

string
Сгенерированный шаблон контейнера ввода.

_inputLabelsource protected

_inputLabel( string $fieldName , string $label , array $options )

Создать метку для вызова input().

$options может содержать хэш с переопределениями id. Эти переопределения будут использованы вместо сгенерированных значений, если они присутствуют.

Параметры

строка $fieldName

Имя поля, для которого нужно сгенерировать метку.

строка $label

Текст метки.

массив $options

Опции для элемента метки.

Возвращает

string
Сгенерированный элемент метки

_inputTypesource protected

_inputType( string $fieldName , array $options )

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

Параметры

строка $fieldName

имя поля, для которого нужно определить тип

массив $options

опции, переданные методу input

Возвращает

string
строка

_isRequiredFieldsource protected

_isRequiredField( Cake\Validation\ValidationSet $validationRules )

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

Параметры

Cake\Validation\ValidationSet $validationRules

Набор правил валидации.

Возвращает

boolean
true, если поле обязательно для заполнения, false в противном случае

_lastActionsource protected

_lastAction( string|array $url )

Правильно сохраняет URL последнего действия формы.

Параметры

строка|массив $url

URL последней формы.

_magicOptionssource protected

_magicOptions( string $fieldName , array $options , boolean $allowOverride )

Магически устанавливает тип опции и соответствующие опции.

Параметры

строка $fieldName

Имя поля, для которого нужно сгенерировать опции.

массив $options

Список опций.

boolean $allowOverride

Разрешено ли этому методу перезаписывать ключ 'type' в массиве опций.

Возвращает

array
массив

_optionsOptionssource protected

_optionsOptions( string $fieldName , array $options )

Выбирает переменную, содержащую опции для поля select, если она присутствует, и устанавливает значение в ключ 'options' в массиве опций.

Параметры

строка $fieldName

Имя поля, для которого нужно найти опции.

массив $options

Список опций.

Возвращает

array
массив

_parseOptionssource protected

_parseOptions( string $fieldName , array $options )

Генерирует массив опций ввода.

Параметры

строка $fieldName

Имя поля, для которого нужно проанализировать опции.

массив $options

Список опций.

Возвращает

array
Опции

_securesource protected

_secure( boolean $lock , string|array $field , mixed $value null )

Определяет, какие поля формы следует использовать для хэша. Заполняет $this->fields.

Параметры

boolean $lock

Является ли это поле частью валидации или исключено как часть unlockedFields.

строка|массив $field

Ссылка на поле, которое нужно защитить. Может быть строкой с точкой для обозначения вложенности или массивом имен частей поля.

смешанное $value необязательно null

Значение поля, если значение не должно изменяться.

_secureFieldNamesource protected

_secureFieldName( string $name )

Получить имя поля для использования с _secure().

Анализирует атрибут name, чтобы создать имя со знаками разделения точкой для использования в хэше защищённых полей. Если имя файла имеет форму Model[field], возвращается массив частей имени, таких как ['Model', 'field'].

Параметры

строка $name

Атрибут name элементов формы.

Возвращает

array
Массив параметров имени поля, таких как ['Model.field'] или ['Model', 'field'] для полей массива, или пустой массив, если $name пустой.

_singleDatetimesource protected

_singleDatetime( array $options , string $keep )

Вспомогательный метод для различных методов компонента single datetime.

Параметры

массив $options

Массив опций.

строка $keep

Опция, которую не нужно отключать.

Возвращает

array
массив

addContextProvidersource public

addContextProvider( string $type , callable $check )

Добавить новый тип контекста.

Типы контекстов Form позволяют FormHelper взаимодействовать с поставщиками данных, которые поступают извне CakePHP. Например, если вы хотите использовать альтернативную ORM, например Doctrine, вы можете создать и подключить новый класс контекста, чтобы FormHelper мог читать метаданные из Doctrine.

Параметры

строка $type

Тип контекста. Этот ключ можно использовать для перезаписи существующих поставщиков.

вызываемый объект $check

Вызываемый объект, который возвращает объект при совпадении типа контекста формы.

addWidgetsource public

addWidget( string $name , array|Cake\View\Widget\WidgetInterface $spec )

Добавить новый виджет в FormHelper.

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

Параметры

строка $name

Имя виджета. Например, 'text'.

массив|Cake\View\Widget\WidgetInterface $spec

Имя класса строки или объект, реализующий WidgetInterface.

allInputssource public

allInputs( array $fields [] , array $options [] )

Создать набор полей ввода для $fields. Если $fields пустой, будут использоваться поля текущей модели.

Вы можете настроить отдельные поля через $fields.

$this->Form->allInputs([
  'name' => ['label' => 'custom label']
]);

Вы можете исключить поля, указав их как false:

$this->Form->allInputs(['title' => false]);

В приведенном выше примере поле для поля title не будет сгенерировано.

Параметры

массив $fields необязательно []

Массив настроек для полей, которые будут сгенерированы. Этот массив позволяет задавать пользовательские типы, метки или другие параметры.

массив $options необязательно []

Массив опций. Допустимые ключи: - fieldset Установите в значение false, чтобы отключить поле для набора полей. Также можно передать массив параметров для применения в качестве атрибутов HTML тега fieldset. Если вы передадите пустой массив, поле для набора полей будет включено - legend Установите в значение false, чтобы отключить легенду для сгенерированного набора полей ввода. Или укажите строку, чтобы настроить текст легенды.

Возвращает

string
Заполненные поля формы.

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/form.html#generating-entire-forms

buttonsource public

button( string $title , array $options [] )

Создает тег <button>.

Атрибут type по умолчанию равен type="submit". Вы можете изменить его на другое значение, используя $options['type'].

Опции:

• escape - кодировать HTML-сущности в $title кнопки. По умолчанию false.

Параметры

строка $title

Подпись кнопки. Не кодируется автоматически.

массив $options необязательно []

Массив опций и атрибутов HTML.

Возвращает

string
Тег HTML кнопки.

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/form.html#creating-button-elements

checkboxsource public

checkbox( string $fieldName , array $options [] )

Создаёт виджет ввода типа checkbox.

Параметры:

• value - значение checkbox
• checked - boolean, указывает, что checkbox выбран.
• hiddenField - boolean, указывает, нужно ли включать скрытый input с значением ''.
• disabled - создать отключённый input.
• default - Установить значение по умолчанию для checkbox. Это позволяет по умолчанию устанавливать checkboxes как выбранные, без необходимости проверки данных POST. Соответствующее значение в POST перезапишет значение по умолчанию.

Параметры

строка $fieldName

Имя поля, например "modelname.fieldname"

массив $options необязательно []

Массив HTML атрибутов.

Возвращаемое значение

string|array
Элемент HTML input типа текст.

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/form.html#creating-checkboxes

contextsource public

context( Cake\View\Form\ContextInterface|null $context null )

Получить экземпляр контекста для текущей формы.

Если активной формы нет, вернётся null.

Параметры

Cake\View\Form\ContextInterface|null $context необязательно null

Новый контекст при установке, или null для получения.

Возвращаемое значение

null|Cake\View\Form\ContextInterface
Контекст формы.

createsource public

create( mixed $model null , array $options [] )

Возвращает элемент HTML FORM.

Параметры:

• type Метод формы по умолчанию определяется автоматически на основе контекста формы. Если метод isCreate() контекста формы возвращает false, будет выполнен запрос PUT.
• action Действие контроллера, к которому отправляется форма (необязательно). Используйте этот параметр, если не нужно изменять контроллер по сравнению с текущим.
• url URL, к которому отправляется форма. Может быть строкой или массивом URL. Если используется 'url', 'action' следует оставить неопределённым.
• encoding Установка кодировки accept-charset для формы. По умолчанию Configure::read('App.encoding')
• templates Шаблоны, которые нужно использовать для этой формы. Любые шаблоны будут слиты поверх уже загруженных шаблонов. Этот параметр может быть либо именем файла в /config, содержащим шаблоны для загрузки, либо массивом шаблонов для использования.
• context Дополнительные параметры для класса контекста. Например, EntityContext принимает параметр 'table', который позволяет задать конкретный класс таблицы, на основе которого должна создаваться форма.
• idPrefix Префикс для сгенерированных атрибутов ID.

Параметры

смешанный $model необязательно null

Контекст, для которого определяется форма. Может быть сущностью ORM, набором результатов ORM или массивом метаданных. Можно использовать false или null для создания формы без модели.

массив $options необязательно []

Массив HTML атрибутов и параметров.

Возвращаемое значение

string
Открывающий тег FORM в формате.

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/form.html#Cake\View\Helper\FormHelper::create

datesource public

date( string $fieldName , array $options [] )

Генерирует поля ввода даты.

Параметры:

См. dateTime() для параметров даты.

Параметры

строка $fieldName

Префикс имени для элемента SELECT

массив $options необязательно []

Массив параметров

Возвращаемое значение

string
Сгенерированный набор элементов select для форматов времени.

См. также

Cake\View\Helper\FormHelper::dateTime() для параметров шаблона.

dateTimesource public

dateTime( string $fieldName , array $options [] )

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

Параметры даты:

• empty - Если true, пустой элемент select отображается. Если строка, эта строка отображается как пустой элемент.
• value | default Значение по умолчанию для поля ввода. Значение в $this->data, соответствующее имени поля, переопределяет это значение. Если значение по умолчанию не задано, используется time().
• monthNames Если false, будут использоваться 2-значные числа вместо текста. Если массив, используется предоставленный массив.
• minYear Наименьший год для использования в списке выбора года.
• maxYear Максимальный год для использования в списке выбора года.
• orderYear - Порядок значений года в элементах select. Возможные значения 'asc', 'desc'. По умолчанию 'desc'.

Параметры времени:

• empty - Если true, пустой элемент select отображается. Если строка,
• value | default Значение по умолчанию для поля ввода. Значение в $this->data, соответствующее имени поля, переопределяет это значение. Если значение по умолчанию не задано, используется time().
• timeFormat Формат времени для использования, либо 12, либо 24.
• interval Интервал для выбора минут. По умолчанию 1.
• round - Установите в up или down для принудительного округления в любом направлении. По умолчанию null.
• second Установите в true для включения выпадающего списка секунд.

Чтобы контролировать порядок элементов ввода и любой контент между ними, можно переопределить шаблон dateWidget. По умолчанию используется шаблон dateWidget.

{{month}}{{day}}{{year}}{{hour}}{{minute}}{{second}}{{meridian}}

Параметры

строка $fieldName

Префикс имени для элемента SELECT

массив $options необязательно []

Массив параметров

Возвращаемое значение

string
Сгенерированный набор элементов select для форматов даты и времени.

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/form.html#creating-date-and-time-inputs

daysource public

day( string $fieldName null , array $options [] )

Возвращает элемент SELECT для дней.

Параметры:

• empty - Если true, пустой элемент select отображается. Если строка, эта строка отображается как пустой элемент.
• value Выбранное значение поля ввода.

Параметры

строка $fieldName необязательно null

Префикс имени для элемента SELECT

массив $options необязательно []

Параметры и HTML атрибуты для элемента select

Возвращаемое значение

string
Сгенерированный выпадающий список дней.

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/form.html#creating-day-inputs

endsource public

end( array $secureAttributes [] )

Закрывает форму HTML, очищает значения, установленные FormHelper::create(), и записывает скрытые поля ввода, если необходимо.

Параметры

массив $secureAttributes необязательно []

Безопасные атрибуты, которые будут переданы в качестве HTML атрибутов в скрытые элементы input, сгенерированные для компонента Security.

Возвращаемое значение

string
Закрывающее тег FORM.

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/form.html#closing-the-form

errorsource public

error( string $field , string|array $text null , array $options [] )

Возвращает отформатированное сообщение об ошибке для заданного поля формы, '' если ошибок нет.

Использует шаблоны error, errorList и errorItem. Шаблоны errorList и errorItem используются для форматирования нескольких сообщений об ошибках на поле.

Параметры:

• escape boolean - Нужно ли экранировать содержимое ошибки.

Параметры

строка $field

Имя поля, например "modelname.fieldname"

строка|массив $text необязательно null

Сообщение об ошибке в виде строки или массива сообщений. Если массив, он должен быть словарем, где ключи - имена, а значения - сообщения.

массив $options необязательно []

См. выше.

Возвращаемое значение

string
Отформатированные ошибки или ''.

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/form.html#displaying-and-checking-errors

fieldsetsource public

fieldset( string $fields '' , array $options [] )

Оборачивает набор элементов ввода в поле fieldset

Параметры

строка $fields необязательно ''

элементы формы, которые нужно обернуть в fieldset

массив $options необязательно []

Массив опций. Допустимые ключи: - fieldset Установите в false, чтобы отключить fieldset. Также можно передать массив параметров, которые будут применены в качестве атрибутов тега fieldset. Если передать пустой массив, fieldset будет включен - legend Установите в false, чтобы отключить легенду для набора сгенерированных элементов ввода. Или укажите строку, чтобы настроить текст легенды.

Возвращает

string
Завершенные элементы формы.

filesource public

file( string $fieldName , array $options [] )

Создаёт элемент ввода файла.

Параметры

строка $fieldName

Имя поля в формате "modelname.fieldname"

массив $options необязательно []

Массив HTML-атрибутов.

Возвращает

string
Сгенерированный элемент ввода файла.

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/form.html#creating-file-inputs

hiddensource public

hidden( string $fieldName , array $options [] )

Создаёт скрытое поле ввода.

Параметры

строка $fieldName

Имя поля в формате "modelname.fieldname"

массив $options необязательно []

Массив HTML-атрибутов.

Возвращает

string
Сгенерированное скрытое поле ввода.

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/form.html#creating-hidden-inputs

hoursource public

hour( string $fieldName , array $options [] )

Возвращает элемент SELECT для часов.

Атрибуты:

• empty - Если true, пустой элемент выбора отображается. Если строка, эта строка отображается как пустой элемент.
• value Выбранное значение элемента ввода.
• format Установите в 12 или 24 для использования 12-часового или 24-часового формата. По умолчанию 24.

Параметры

строка $fieldName

Префикс имени для элемента SELECT

массив $options необязательно []

Список HTML-атрибутов

Возвращает

string
Завершенный элемент выбора часов.

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/form.html#creating-hour-inputs

implementedEventssource public

implementedEvents( )

Обработчики событий.

Возвращает

array
массив

Переопределяет

Cake\View\Helper::implementedEvents()

inputsource public

input( string $fieldName , array $options [] )

Генерирует элемент ввода формы, включая метку и контейнер div

Опции

См. каждый метод типа поля для получения дополнительной информации. Любые опции, которые являются частью $attributes или $options для различных методов type, можно включить в $options для input(). Кроме того, любые неизвестные ключи, которые не находятся в списке ниже или не являются частью опций выбранного типа, будут обрабатываться как обычный HTML-атрибут для сгенерированного элемента ввода.

• type - Принудительно устанавливает тип виджета. Например, type => 'select'
• label - Либо текстовая метка, либо массив опций для метки. См. FormHelper::label().
• options - Для виджетов, которые принимают опции, например, радиокнопки, списки.
• error - Управление сообщением об ошибке, которое генерируется. Установите в false чтобы отключить любой вид сообщения об ошибке (ошибки поля и сообщения об ошибках).
• empty - Строка или булево значение для включения пустых опций выпадающего списка.
• nestedInput - Используется с флажками и радиокнопками. Установите в false, чтобы отображать элементы ввода вне элементов метки. Можно установить в true для любого элемента ввода, чтобы принудительно поместить элемент ввода в метку. Если вы включите эту опцию для радиокнопок, вам также потребуется изменить шаблон radioWrapper по умолчанию.
• templates - Шаблоны, которые необходимо использовать для этого элемента ввода. Любые шаблоны будут объединены поверх уже загруженных шаблонов. Эта опция может быть именем файла в /config, содержащим шаблоны, которые нужно загрузить, или массивом шаблонов для использования.

Параметры

строка $fieldName

Должно быть "modelname.fieldname"

массив $options необязательно []

Каждый тип ввода принимает разные опции.

Возвращает

string
Завершенный виджет формы.

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/form.html#creating-form-inputs

inputssource public

inputs( array $fields , array $options [] )

Генерирует набор элементов ввода для $fields, обернутых в элемент fieldset.

Вы можете настроить отдельные элементы ввода через $fields.

$this->Form->inputs([
  'name' => ['label' => 'custom label'],
  'email'
]);

Параметры

массив $fields

Массив полей для генерации. Этот массив позволяет устанавливать пользовательские типы, метки или другие опции.

массив $options необязательно []

Массив опций. Допустимые ключи: - fieldset Установите в false, чтобы отключить fieldset. Также можно передать массив параметров, которые будут применены в качестве атрибутов тега fieldset. Если передать пустой массив, fieldset будет включен - legend Установите в false, чтобы отключить легенду для набора сгенерированных элементов ввода. Или укажите строку, чтобы настроить текст легенды.

Возвращает

string
Завершенные элементы формы.

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/form.html#generating-entire-forms

isFieldErrorsource public

isFieldError( string $field )

Возвращает true, если для заданного поля есть ошибка, в противном случае false

Параметры

строка $field

Должно быть "modelname.fieldname"

Возвращает

boolean
Если есть ошибки, этот метод возвращает true, иначе false.

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/form.html#displaying-and-checking-errors

labelsource public

label( string $fieldName , string $text null , array $options [] )

Возвращает отформатированный элемент LABEL для HTML-форм.

Автоматически сгенерирует атрибут for , если он не задан.

Опции

• for - Установите атрибут for, если он не определён, атрибут for будет сгенерирован из параметра $fieldName с помощью FormHelper::_domId().

Примеры:

Текст и атрибут for генерируются из fieldname

echo $this->Form->label('published');
<label for="PostPublished">Published</label>

Пользовательский текст:

echo $this->Form->label('published', 'Publish');
<label for="published">Publish</label>

Пользовательские атрибуты:

echo $this->Form->label('published', 'Publish', [
  'for' => 'post-publish'
]);
<label for="post-publish">Publish</label>

Вложение тега input:

echo $this->Form->label('published', 'Publish', [
  'for' => 'published',
  'input' => $this->text('published'),
]);
<label for="post-publish">Publish <input type="text" name="published"></label>

Если вы хотите вкладывать элементы input в метки, вам необходимо изменить шаблоны по умолчанию.

Параметры

строка $fieldName

Должно быть "modelname.fieldname"

строка $text необязательно null

Текст, который будет отображаться в поле метки. Если $text не определён, текст будет получен из fieldName.

массив $options необязательно []

Массив HTML-атрибутов.

Возвращает

string
Отформатированный элемент LABEL.

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/form.html#creating-labels

meridiansource public

meridian( string $fieldName , array $options [] )

Возвращает элемент SELECT для AM или PM.

Атрибуты:

• empty — Если true, пустой элемент select отображается. Если строка, эта строка отображается как пустой элемент.
• value Выбранное значение ввода.

Параметры

строка $fieldName

Префикс имени для элемента SELECT

массив $options необязательно []

Массив опций

Возвращаемое значение

string
Заполненный элемент ввода select для меридиана

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/form.html#creating-meridian-inputs

minutesource public

minute( string $fieldName , array $options [] )

Возвращает элемент SELECT для минут.

Атрибуты:

• empty — Если true, пустой элемент select отображается. Если строка, эта строка отображается как пустой элемент.
• value Выбранное значение ввода.
• interval Интервал, с которым должны создаваться варианты минут.
• round Как вы хотите округлить значение, если оно не попадает точно в интервал. Принимает 'up', 'down' и null.

Параметры

строка $fieldName

Префикс имени для элемента SELECT

массив $options необязательно []

Массив опций.

Возвращаемое значение

string
Заполненный элемент ввода select для минут.

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/form.html#creating-minute-inputs

monthsource public

month( string $fieldName , array $options [] )

Возвращает элемент SELECT для месяцев.

Опции:

• monthNames — Если false, будут использоваться 2-значные числа вместо текста. Если массив, будет использоваться заданный массив.
• empty — Если true, пустой элемент select отображается. Если строка, эта строка отображается как пустой элемент.
• value Выбранное значение ввода.

Параметры

строка $fieldName

Префикс имени для элемента SELECT

массив $options необязательно []

Атрибуты для элемента select

Возвращаемое значение

string
Сгенерированный выпадающий список выбора месяца.

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/form.html#creating-month-inputs

multiCheckboxsource public

multiCheckbox( string $fieldName , array|Traversable $options , array $attributes [] )

Создаёт набор чекбоксов из опций.

Опции

• escape — Если true, содержимое опций будет закодировано в HTML-сущности. По умолчанию true.
• val Выбранное значение ввода.
• class — При использовании multiple=checkbox имя класса, которое следует применять к div. По умолчанию 'checkbox'.
• disabled — Управляет атрибутом disabled. При создании чекбоксов, true отключит все чекбоксы. Вы также можете установить disabled в список значений, которые вы хотите отключить при создании чекбоксов.
• hiddenField — Установите в false, чтобы удалить скрытое поле, гарантирующее, что значение всегда отправляется.

Может использоваться вместо поля select с атрибутом multiple.

Параметры

строка $fieldName

Атрибут name элемента SELECT

массив/перечислимый объект $options

Массив элементов OPTION (в виде пар 'value'=>'Текст') для использования в элементе checkboxes.

массив $attributes необязательно []

HTML атрибуты элемента select.

Возвращаемое значение

string
Отформатированный элемент SELECT

См. также

\Cake\View\Helper\FormHelper::select() для поддерживаемых форматов опций.

postButtonsource public

postButton( string $title , string|array $url , array $options [] )

Создаёт тег <button> с окружающим тегом <form> для отправки через POST.

Этот метод создаёт элемент <form>. Поэтому не используйте этот метод в уже открытой форме. Вместо этого используйте FormHelper::submit() или FormHelper::button() для создания кнопок внутри открытых форм.

Опции:

• data — Массив с ключом/значением для передачи в скрытое поле ввода
• Другие опции такие же, как у метода button.

Параметры

строка $title

Текст кнопки. Не кодируется автоматически в HTML.

строка/массив $url

URL как строка или массив

массив $options необязательно []

Массив опций и HTML атрибутов.

Возвращаемое значение

string
HTML тег кнопки.

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/form.html#creating-standalone-buttons-and-post-links

postLinksource public

postLink( string $title , string|array $url null , array $options [] )

Создаёт HTML ссылку, но обращается к URL с указанным методом (по умолчанию POST). Требует, чтобы JavaScript был включён в браузере.

Этот метод создаёт элемент <form>. Если вы хотите использовать этот метод внутри существующей формы, вы должны использовать опцию block для того, чтобы новая форма была помещена в блок представления, который может быть рендерирован вне основной формы.

Если вам нужна только кнопка для отправки формы, используйте FormHelper::button() или FormHelper::submit() вместо этого.

Опции:

• data — Массив с ключом/значением для передачи в скрытое поле ввода
• method — Метод запроса для использования. Установите в 'delete', чтобы имитировать HTTP/1.1 DELETE запрос. По умолчанию 'post'.
• confirm — Сообщение подтверждения для показа.
• block — Установите в true, чтобы добавить форму в блок представления "postLink" или укажите имя пользовательского блока.
• Другие опции такие же, как у метода HtmlHelper::link().
• Опция onclick будет заменена.

Параметры

строка $title

Содержимое, которое будет обернуто тегами <a>.

строка/массив $url необязательно null

URL с относительным адресом относительно Cake или массив параметров URL, или внешний URL (начинается с http://)

массив $options необязательно []

Массив HTML атрибутов.

Возвращаемое значение

string
Элемент <a />

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/form.html#creating-standalone-buttons-and-post-links

radiosource public

radio( string $fieldName , array|Traversable $options [] , array $attributes [] )

Создаёт набор радио-элементов.

Атрибуты:

• value — Указывает значение, когда этот радио-кнопка выбрана.
• label — boolean, указывающий, должны ли отображаться метки для виджетов.
• hiddenField — boolean, указывающий, нужно ли добавлять скрытое поле с значением '' в результаты radio(). Это полезно для создания наборов радио-кнопок, которые не являются непрерывными.
• disabled — Установите в true или disabled, чтобы отключить все радио-кнопки.
• empty — Установите в true для создания ввода со значением '' в качестве первого варианта. Когда true метка радио-кнопки будет 'пустая'. Установите эту опцию в строку для управления значением метки.

Параметры

строка $fieldName

Имя поля, например "modelname.fieldname"

массив/перечислимый объект $options необязательно []

Массив опций радио-кнопок.

массив $attributes необязательно []

Массив атрибутов.

Возвращаемое значение

string
Заполненный набор радио-виджетов.

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/form.html#creating-radio-buttons

resetTemplatessource public

resetTemplates( )

Восстанавливает значения по умолчанию, встроенные в FormHelper.

Этот метод не сбросит шаблоны, установленные в пользовательских виджетах.

securesource public

secure( array $fields [] , array $secureAttributes [] )

Генерирует скрытое поле с хэш-кодом безопасности, основанным на полях, используемых в форме.

Если задан $secureAttributes, эти атрибуты HTML будут объединены с скрытыми тегами ввода, сгенерированными для компонента Security. Это особенно полезно для установки атрибутов HTML5, таких как 'form'.

Параметры

массив $fields необязательно []

Если задано, определяет список полей, которые следует использовать при генерации хэш-кода, в противном случае используется $this->fields.

массив $secureAttributes необязательно []

будет передан в качестве атрибутов HTML в скрытые элементы ввода, сгенерированные для компонента Security.

Возвращаемое значение

string|null
Скрытое поле ввода с хэш-кодом безопасности

selectsource public

select( string $fieldName , array|Traversable $options [] , array $attributes [] )

Возвращает отформатированный элемент SELECT.

Атрибуты:

• multiple - отобразить поле множественного выбора. Если установлено в 'checkbox', вместо этого будут созданы несколько флажков.
• empty - Если true, отображается пустой элемент списка выбора. Если строка, эта строка отображается как пустой элемент.
• escape - Если true, содержимое опций будет закодировано как HTML-сущности. По умолчанию true.
• val - Выбранное значение ввода.
• disabled - Управление атрибутом disabled. При создании поля списка выбора, установите в true, чтобы отключить список выбора. Установите в массив, чтобы отключить определенные элементы списка.

Использование опций

Простой массив создаст обычные опции:

$options = [1 => 'one', 2 => 'two'];
$this->Form->select('Model.field', $options));

В то время как вложенный массив опций создаст группы опций с опциями внутри них.

$options = [
 1 => 'bill',
    'fred' => [
        2 => 'fred',
        3 => 'fred jr.'
    ]
];
$this->Form->select('Model.field', $options);

Если у вас есть несколько опций, которым нужно задать одинаковое значение атрибута value, вы можете использовать массив массивов для этого:

$options = [
    ['text' => 'United states', 'value' => 'USA'],
    ['text' => 'USA', 'value' => 'USA'],
];

Параметры

строка $fieldName

Атрибут имени SELECT

массив|Перечисляемый $options необязательно []

Массив элементов OPTION (в виде пар 'значение'=>'Текст') для использования в элементе SELECT

массив $attributes необязательно []

Атрибуты HTML элемента select.

Возвращаемое значение

string
Отформатированный элемент SELECT

См. также

\Cake\View\Helper\FormHelper::multiCheckbox() для создания нескольких флажков.

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/form.html#creating-select-pickers

submitsource public

submit( string $caption null , array $options [] )

Создаёт элемент кнопки отправки. Этот метод сгенерирует <input /> элементы, которые могут использоваться для отправки и сброса форм с помощью $options. Кнопки с изображением можно создать, указав путь к изображению для $caption.

Опции

• type - Установите в 'reset' для элементов сброса. По умолчанию 'submit'
• templateVars - Дополнительные переменные шаблона для элемента ввода и его контейнера.
• Другие атрибуты будут присвоены элементу ввода.

Параметры

строка $caption необязательно null

Метка, отображаемая на кнопке ИЛИ если строка содержит :// или расширение .jpg, .jpe, .jpeg, .gif, .png, использует изображение, если расширение существует, И первый символ является /, изображение относительно webroot, ИЛИ если первый символ не является /, изображение относительно webroot/img.

массив $options необязательно []

Массив опций. См. выше.

Возвращаемое значение

string
Элемент HTML кнопки отправки

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/form.html#creating-buttons-and-submit-elements

textareasource public

textarea( string $fieldName , array $options [] )

Создаёт виджет textarea.

Опции:

• escape - Нужно ли кодировать содержимое textarea. По умолчанию true.

Параметры

строка $fieldName

Имя поля в формате "имя_модели.имя_поля"

массив $options необязательно []

Массив атрибутов HTML и специальных опций, описанных выше.

Возвращаемое значение

string
Сгенерированный элемент ввода текста HTML

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/form.html#creating-textareas

timesource public

time( string $fieldName , array $options [] )

Генерирует поля времени.

Опции:

См. dateTime() для опций времени.

Параметры

строка $fieldName

Префикс имени для элемента SELECT

массив $options необязательно []

Массив опций

Возвращаемое значение

string
Сгенерированный набор полей выбора для форматов времени.

См. также

Cake\View\Helper\FormHelper::dateTime() для опций шаблонизации.

unlockFieldsource public

unlockField( string|null $name null )

Добавляет или получает список полей, которые в данный момент разблокированы. Разблокированные поля не включаются в хэш поля, используемый SecurityComponent. Разблокировка поля после добавления в список защищенных полей удалит его из списка полей.

Параметры

строка|null $name необязательно null

Имя поля с разделителем «точка».

Возвращаемое значение

array|null
Либо null, либо список полей.

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/form.html#working-with-securitycomponent

widgetsource public

widget( string $name , array $data [] )

Отобразить виджет с заданным именем.

Это метод более низкого уровня. Для встроенных виджетов вы должны использовать методы, такие как text, hidden, и radio. Если вы используете дополнительные виджеты, вы должны использовать этот метод для отображения виджета без метки или обертывающей div.

Параметры

строка $name

Имя виджета. Например, 'text'.

массив $data необязательно []

Данные для отображения.

Возвращаемое значение

string
строка

widgetRegistrysource public

widgetRegistry( Cake\View\Widget\WidgetRegistry $instance null , array $widgets [] )

Установить реестр виджетов, который будет использовать помощник.

Параметры

Cake\View\Widget\WidgetRegistry $instance необязательно null

Экземпляр реестра для установки.

массив $widgets необязательно []

Массив виджетов

Возвращаемое значение

Cake\View\Widget\WidgetRegistry
\Cake\View\Widget\WidgetRegistry

yearsource public

year( string $fieldName , array $options [] )

Возвращает элемент SELECT для годов

Атрибуты:

• empty - Если true, отображается пустой элемент списка выбора. Если строка, эта строка отображается как пустой элемент.
• orderYear - Порядок значений года в элементах списка выбора. Возможные значения 'asc', 'desc'. По умолчанию 'desc'
• value - Выбранное значение ввода.
• maxYear - Максимальный год, который должен отображаться в элементе списка выбора.
• minYear - Минимальный год, который должен отображаться в элементе списка выбора.

Параметры

строка $fieldName

Префикс имени для элемента SELECT

массив $options необязательно []

Опции и атрибуты для элементов select.

Возвращаемое значение

string
Завершенный элемент ввода года.

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/form.html#creating-year-inputs

__debugInfosource public

__debugInfo( )

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

Возвращаемое значение

array
массив

__getsource public

__get( string $name )

Ленично загружает помощники.

Параметры

string $name

Имя свойства, к которому осуществляется доступ.

Возвращает

Cake\View\Helper|null
Экземпляр помощника, если помощник с заданным именем существует

_confirmsource protected

_confirm( string $message , string $okCode , string $cancelCode '' , array $options [] )

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

Параметры

string $message

Сообщение, которое будет отображено

string $okCode

Код, который будет выполнен после выбора пользователем «ОК»

string $cancelCode optional ''

Код, который будет выполнен после выбора пользователем «Отмена»

array $options optional []

Массив параметров

Возвращает

string
JS-код onclick

addClasssource public

addClass( array $options [] , string $class null , string $key 'class' )

Добавляет заданный класс к параметрам элемента.

Параметры

array $options optional []

Массив параметров/атрибутов для добавления класса

string $class optional null

Имя класса, который добавляется.

string $key optional 'class'

ключ для использования класса.

Возвращает

array
Массив параметров с заданным $key.

_clearIdssource protected

_clearIds( )

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

_domIdsource protected

_domId( string $value )

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

Параметры

string $value

Значение, которое необходимо преобразовать в идентификатор.

Возвращает

string
Сгенерированный идентификатор.

_idsource protected

_id( string $name , string $val )

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

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

Параметры

string $name

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

string $val

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

Возвращает

string
Сгенерированный идентификатор.

_buildFieldTokensource protected

_buildFieldToken( string $url , array $fields , array $unlockedFields [] )

Генерирует данные токена для указанных входных данных.

Параметры

string $url

URL, на который отправляется форма.

array $fields

Если установлено, указывает список полей, используемых при генерации хеша.

array $unlockedFields optional []

Список полей, исключённых из проверки валидности полей.

Возвращает

array
Данные токена.

formatTemplatesource public

formatTemplate( string $name , array $data )

Форматирует строку шаблона с данными $data

Параметры

string $name

Имя шаблона.

array $data

Данные для вставки.

Возвращает

string
строка

templatersource public

templater( )

templater

Возвращает

Cake\View\StringTemplate
\Cake\View\StringTemplate

templatessource public

templates( string|null|array $templates null )

Получить/установить используемые шаблоны.

Параметры

string|null|array $templates optional null

null или строка для чтения шаблонов. Массив позволяет добавлять шаблоны.

Возвращает

mixed
$this|строка|массив

_configDeletesource protected

_configDelete( string $key )

Удалить единственный ключ конфигурации

Параметры

string $key

Ключ для удаления.

Выбрасывает

Cake\Core\Exception\Exception
если пытаетесь заменить существующую конфигурацию

_configReadsource protected

_configRead( string|null $key )

Прочитать переменную конфигурации

Параметры

string|null $key

Ключ для чтения.

Возвращает

mixed
смешанный тип

_configWritesource protected

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Записать переменную конфигурации

Параметры

string|array $key

Ключ для записи.

mixed $value

Значение для записи.

boolean|string $merge optional false

True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Выбрасывает

Cake\Core\Exception\Exception
если пытаетесь заменить существующую конфигурацию

configsource public

config( string|array|null $key null , mixed|null $value null , boolean $merge true )

Использование

Чтение всей конфигурации:

$this->config();

Чтение определённого значения:

$this->config('key');

Чтение вложенного значения:

$this->config('some.nested.key');

Установка определённого значения:

$this->config('key', $value);

Установка вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких параметров конфигурации одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Параметры

string|array|null $key optional null

Ключ для получения/установки или полный массив конфигураций.

mixed|null $value optional null

Значение для установки.

boolean $merge optional true

Выполнять рекурсивное слияние или перезапись существующей конфигурации, по умолчанию true.

Возвращает

mixed
Значение конфигурации для чтения или сам объект при операциях записи.

Выбрасывает

Cake\Core\Exception\Exception
При попытке установить недействительный ключ.

configShallowsource public

configShallow( string|array $key , mixed|null $value null )

Объединяет предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), которая выполняет рекурсивное слияние вложенных ключей, этот метод выполняет простое слияние.

Установка определённого значения:

$this->config('key', $value);

Установка вложенного значения:

$this->config('some.nested.key', $value);

Обновление нескольких параметров конфигурации одновременно:

$this->config(['one' => 'value', 'another' => 'value']);

Параметры

string|array $key

Ключ для установки или полный массив конфигураций.

mixed|null $value optional null

Значение для установки.

Возвращает

mixed
Сам объект $this.

[]

[
    'interval', 'round', 'monthNames', 'minYear', 'maxYear',
    'orderYear', 'timeFormat', 'second'
]

['year', 'month', 'day', 'hour', 'minute', 'second', 'meridian']

[
    'idPrefix' => null,
    'errorClass' => 'form-error',
    'typeMap' => [
        'string' => 'text', 'datetime' => 'datetime', 'boolean' => 'checkbox',
        'timestamp' => 'datetime', 'text' => 'textarea', 'time' => 'time',
        'date' => 'date', 'float' => 'number', 'integer' => 'number',
        'decimal' => 'number', 'binary' => 'file', 'uuid' => 'string'
    ],
    'templates' => [
        'button' => '<button{{attrs}}>{{text}}</button>',
        'checkbox' => '<input type="checkbox" name="{{name}}" value="{{value}}"{{attrs}}>',
        'checkboxFormGroup' => '{{label}}',
        'checkboxWrapper' => '<div class="checkbox">{{label}}</div>',
        'dateWidget' => '{{year}}{{month}}{{day}}{{hour}}{{minute}}{{second}}{{meridian}}',
        'error' => '<div class="error-message">{{content}}</div>',
        'errorList' => '<ul>{{content}}</ul>',
        'errorItem' => '<li>{{text}}</li>',
        'file' => '<input type="file" name="{{name}}"{{attrs}}>',
        'fieldset' => '<fieldset{{attrs}}>{{content}}</fieldset>',
        'formStart' => '<form{{attrs}}>',
        'formEnd' => '</form>',
        'formGroup' => '{{label}}{{input}}',
        'hiddenBlock' => '<div style="display:none;">{{content}}</div>',
        'input' => '<input type="{{type}}" name="{{name}}"{{attrs}}/>',
        'inputSubmit' => '<input type="{{type}}"{{attrs}}/>',
        'inputContainer' => '<div class="input {{type}}{{required}}">{{content}}</div>',
        'inputContainerError' => '<div class="input {{type}}{{required}} error">{{content}}{{error}}</div>',
        'label' => '<label{{attrs}}>{{text}}</label>',
        'nestingLabel' => '{{hidden}}<label{{attrs}}>{{input}}{{text}}</label>',
        'legend' => '<legend>{{text}}</legend>',
        'option' => '<option value="{{value}}"{{attrs}}>{{text}}</option>',
        'optgroup' => '<optgroup label="{{label}}"{{attrs}}>{{content}}</optgroup>',
        'select' => '<select name="{{name}}"{{attrs}}>{{content}}</select>',
        'selectMultiple' => '<select name="{{name}}[]" multiple="multiple"{{attrs}}>{{content}}</select>',
        'radio' => '<input type="radio" name="{{name}}" value="{{value}}"{{attrs}}>',
        'radioWrapper' => '{{label}}',
        'textarea' => '<textarea name="{{name}}"{{attrs}}>{{value}}</textarea>',
        'submitContainer' => '<div class="submit">{{content}}</div>',
    ]
]

[
    'button' => ['Cake\View\Widget\ButtonWidget'],
    'checkbox' => ['Cake\View\Widget\CheckboxWidget'],
    'file' => ['Cake\View\Widget\FileWidget'],
    'label' => ['Cake\View\Widget\LabelWidget'],
    'nestingLabel' => ['Cake\View\Widget\NestingLabelWidget'],
    'multicheckbox' => ['Cake\View\Widget\MultiCheckboxWidget', 'nestingLabel'],
    'radio' => ['Cake\View\Widget\RadioWidget', 'nestingLabel'],
    'select' => ['Cake\View\Widget\SelectBoxWidget'],
    'textarea' => ['Cake\View\Widget\TextareaWidget'],
    'datetime' => ['Cake\View\Widget\DateTimeWidget', 'select'],
    '_default' => ['Cake\View\Widget\BasicWidget'],
]

''

[]

[]

['Url', 'Html']

null

[]

[]

null

null

[]

null

[]

false

null

[]