Класс FormHelper

__call()source 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

Параметры вызова метода

Возвращает

строка
Отформатированный метод ввода.

Выбрасывает

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

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

Cake\View\Helper::__call()

__construct()source public

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

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

Параметры

Cake\View\View $View

Вид, к которому прикрепляется помощник.

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

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

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

Cake\View\Helper::__construct()

_addDefaultContextProviders()source protected

_addDefaultContextProviders( )

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

_csrfField()source protected

_csrfField( )

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

Возвращает

строка

_datetimeOptions()source protected

_datetimeOptions( array $options )

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

Параметры

массив $options

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

Возвращает

массив
Преобразованные опции.

_extractOption()source protected

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

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

Параметры

строка $name

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

массив $options

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

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

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

Возвращает

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

_formUrl()source protected

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

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

Параметры

Cake\View\Form\ContextInterface $context

Объект контекста, который нужно использовать.

массив $options

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

Возвращает

строка
Атрибут action для формы.

_getContext()source protected

_getContext( mixed $data [] )

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

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

Параметры

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

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

Возвращает

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

Выбрасывает

RuntimeException

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

_getInput()source protected

_getInput( string $fieldName , array $options )

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

Параметры

строка $fieldName

имя поля

массив $options

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

Возвращает

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

_getLabel()source protected

_getLabel( string $fieldName , array $options )

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

Параметры

строка $fieldName

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

массив $options

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

Возвращает

булево|строка
false или сгенерированный элемент метки

_groupTemplate()source protected

_groupTemplate( array $options )

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

Параметры

массив $options

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

Возвращает

строка
Сгенерированный шаблон группы

_initInputField()source protected

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

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

Опции

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

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

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

Параметры

строка $field

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

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

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

Возвращает

массив
Массив опций для ввода.

_inputContainerTemplate()source protected

_inputContainerTemplate( array $options )

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

Параметры

массив $options

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

Возвращает

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

_inputLabel()source protected

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

Генерирует метку для вызова input().

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

Параметры

строка $fieldName

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

строка $label

Текст метки.

массив $options

Параметры для элемента метки.

Возвращает

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

_inputType()source protected

_inputType( string $fieldName , array $options )

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

Параметры

строка $fieldName

Имя поля, для которого необходимо определить тип.

массив $options

Параметры, переданные методу input.

Возвращает

строка

_isRequiredField()source protected

_isRequiredField( Cake\Validation\ValidationSet $validationRules )

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

Параметры

Cake\Validation\ValidationSet $validationRules

Установленные правила валидации.

Возвращает

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

_lastAction()source protected

_lastAction( string|array $url )

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

Параметры

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

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

_magicOptions()source protected

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

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

Параметры

строка $fieldName

Имя поля, для которого генерируются параметры.

массив $options

Список параметров.

логическое значение $allowOverride

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

Возвращает

массив

_optionsOptions()source protected

_optionsOptions( string $fieldName , array $options )

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

Параметры

строка $fieldName

Имя поля, для которого необходимо найти параметры.

массив $options

Список параметров.

Возвращает

массив

_parseOptions()source protected

_parseOptions( string $fieldName , array $options )

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

Параметры

строка $fieldName

Имя поля, для которого разбор параметров.

массив $options

Список параметров.

Возвращает

массив
Параметры

_secure()source protected

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

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

Параметры

логическое значение $lock

Должно ли это поле быть частью валидации или исключено как часть unlockedFields.

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

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

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

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

_secureFieldName()source protected

_secureFieldName( string $name )

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

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

Параметры

строка $name

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

Возвращает

массив

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

_singleDatetime()source protected

_singleDatetime( array $options , string $keep )

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

Параметры

массив $options

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

строка $keep

Параметр, который не следует отключать.

Возвращает

массив

addContextProvider()source public

addContextProvider( string $type , callable $check )

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

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

Параметры

строка $type

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

вызов $check

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

addWidget()source public

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

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

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

Параметры

строка $name

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

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

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

allInputs()source 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. Если вы передадите пустой массив, fieldset будет включен - legend Установите в false, чтобы отключить подпись для сгенерированного набора элементов ввода. Или передайте строку для настройки текста подписи.

Возвращает

строка
Завершенные элементы ввода формы.

Ссылка

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

button()source public

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

Создаёт элемент <button>.

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

Параметры:

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

Параметры

строка $title

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

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

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

Возвращает

строка
Тег HTML кнопки.

Ссылка

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

checkbox()source public

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

Создаёт виджет ввода типа флажок.

Параметры:

• value - значение флажка
• checked - логическое значение, указывающее, что флажок установлен.
• hiddenField - логическое значение, указывающее, нужно ли включать скрытый элемент ввода со значением ''.
• disabled - создать отключенный элемент ввода.
• default - Установите значение по умолчанию для флажка. Это позволяет устанавливать флажки по умолчанию, не проверяя данные POST. Соответствующее значение POST перезапишет значение по умолчанию.

Параметры

строка $fieldName

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

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

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

Возвращает

строка|массив
Элемент ввода HTML типа текст.

Ссылка

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

context()source public

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

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

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

Параметры

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

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

Возвращает

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

create()source public

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

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

Параметры:

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

Параметры

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

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

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

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

Возвращает

строка
Форматированный открывающий тег FORM.

Ссылка

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

date()source public

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

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

Параметры:

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

Параметры

строка $fieldName

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

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

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

Возвращает

строка
Сгенерированный набор выпадающих списков для выбранных форматов времени.

См.

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

dateTime()source public

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

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

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

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

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

• empty - Если true, отображается пустой элемент выбора. Если строка,
• 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 необязательно []

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

Возвращает

строка
Сгенерированный набор выпадающих списков для выбранных форматов даты и времени.

Ссылка

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

day()source public

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

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

Параметры:

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

Параметры

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

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

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

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

Возвращает

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

Ссылка

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

end()source public

end( array $secureAttributes [] )

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

Параметры

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

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

Возвращает

строка
Закрыващий тег FORM.

Ссылка

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

error()source public

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

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

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

Параметры:

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

Параметры

строка $field

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

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

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

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

См. выше.

Возвращает

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

Ссылка

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

fieldset()source public

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

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

Параметры

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

элементы формы для обёртки в поле fieldset

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

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

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

строка
Заполненные элементы формы.

file()source public

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

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

Параметры

строка $fieldName

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

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

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

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

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

Ссылка

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

hidden()source public

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

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

Параметры

строка $fieldName

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

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

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

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

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

Ссылка

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

hour()source public

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

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

Атрибуты:

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

Параметры

строка $fieldName

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

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

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

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

строка
Заполненный элемент select для выбора часов

Ссылка

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

implementedEvents()source public

implementedEvents( )

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

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

массив

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

Cake\View\Helper::implementedEvents()

input()source public

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

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

Опции

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

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

Параметры

строка $fieldName

Должно быть "имя_модели.имя_поля"

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

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

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

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

Ссылка

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

inputs()source public

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

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

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

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

Параметры

массив $fields

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

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

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

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

строка
Заполненные элементы формы.

Ссылка

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

isFieldError()source public

isFieldError( string $field )

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

Параметры

строка $field

Должно быть "имя_модели.имя_поля"

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

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

Ссылка

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

label()source public

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

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

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

Опции

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

Примеры:

Текст и атрибут for генерируются на основе имени поля

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>

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

Параметры

строка $fieldName

Должно быть "имя_модели.имя_поля"

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

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

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

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

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

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

Ссылка

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

meridian()source public

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

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

Атрибуты:

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

Параметры

строка $fieldName

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

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

Массив опций

Возвращает

строка
Завершенный элемент ввода select meridian

Ссылка

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

minute()source public

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

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

Атрибуты:

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

Параметры

строка $fieldName

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

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

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

Возвращает

строка
Завершенный элемент ввода select минут.

Ссылка

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

month()source public

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

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

Опции:

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

Параметры

строка $fieldName

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

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

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

Возвращает

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

Ссылка

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

multiCheckbox()source public

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

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

Опции

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

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

Параметры

строка $fieldName

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

массив|Перебираемый $options

Массив элементов OPTION (как пары 'значение'=>'Текст'), используемые в элементе чекбоксов.

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

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

Возвращает

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

См.

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

postButton()source public

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

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

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

Опции:

• data - Массив с ключом/значением для передачи скрытых полей ввода
• method - Метод запроса для использования. Установите 'delete' или другие значения для имитации запроса HTTP/1.1 DELETE (или других). По умолчанию 'post'.
• form - Массив с любыми опциями, которые может принимать FormHelper::create()
• Другие опции аналогичны методу button.

Параметры

строка $title

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

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

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

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

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

Возвращает

строка
Тег HTML кнопки.

Ссылка

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

postLink()source public

postLink( string $title , string|array|null $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

Содержимое, которое должно быть обернуто тегами .

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

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

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

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

Возвращает

строка
Элемент <a />

Ссылка

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

radio()source public

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

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

Атрибуты:

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

Параметры

строка $fieldName

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

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

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

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

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

Возвращает

строка
Завершенный набор радио-элементов.

Ссылка

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

resetTemplates()source public

resetTemplates( )

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

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

secure()source public

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

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

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

Параметры

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

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

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

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

Возвращает

строка

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

select()source public

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

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

Атрибуты:

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

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

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

$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);

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

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

Параметры

строка $fieldName

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

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

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

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

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

Возвращает

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

См. также

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

Ссылка

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

submit()source public

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

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

Опции

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

Параметры

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

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

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

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

Возвращает

строка
HTML кнопка отправки

Ссылка

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

textarea()source public

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

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

Опции:

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

Параметры

строка $fieldName

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

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

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

Возвращает

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

Ссылка

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

time()source public

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

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

Опции:

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

Параметры

строка $fieldName

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

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

Массив опций

Возвращает

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

См. также

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

unlockField()source public

unlockField( string|null $name null )

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

Параметры

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

Имя поля с точками.

Возвращает

массив|null
Либо null, либо список полей.

Ссылка

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

widget()source public

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

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

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

Параметры

строка $name

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

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

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

Возвращает

строка

widgetRegistry()source public

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

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

Параметры

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

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

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

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

Возвращает

Cake\View\Widget\WidgetRegistry

year()source public

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

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

Атрибуты:

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

Параметры

строка $fieldName

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

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

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

Возвращает

строка
Заполненный элемент select года

Ссылка

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

__debugInfo()source public

__debugInfo( )

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

Возвращает

массив

__get()source public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

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

_confirm()source protected

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

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

Параметры

строка $message

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

строка $okCode

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

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

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

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

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

Возвращает

строка
JS-код onclick

addClass()source public

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

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

Параметры

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

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

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

Имя добавляемого класса.

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

Ключ, используемый для класса.

Возвращает

массив
Массив параметров с установленным ключом $key.

initialize()source public

initialize( array $config )

Метод обработчик конструктора.

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

Параметры

массив $config

Настройки конфигурации, предоставленные этому помощнику.

_clearIds()source protected

_clearIds( )

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

_domId()source protected

_domId( string $value )

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

Параметры

строка $value

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

Возвращает

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

_id()source protected

_id( string $name , string $val )

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

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

Параметры

строка $name

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

строка $val

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

Возвращает

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

_buildFieldToken()source protected

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

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

Параметры

строка $url

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

массив $fields

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

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

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

Возвращает

массив
Данные токена.

_configDelete()source protected

_configDelete( string $key )

Удалить один ключ конфигурации

Параметры

строка $key

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

Выбрасывает

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

_configRead()source protected

_configRead( string|null $key )

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

Параметры

строка|null $key

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

Возвращает

смешанный

_configWrite()source protected

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

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

Параметры

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

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

смешанный $value

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

булево|строка $merge необязательно false

Истинно для рекурсивного объединения, «поверхностное» для простого объединения, ложно для перезаписи, по умолчанию ложно.

Выбрасывает

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

config()source 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']);

Параметры

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

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

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

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

булево $merge необязательно true

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

Возвращает

смешанный
Значение конфигурации, считываемое или сам объект при операциях записи.

Выбрасывает

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

configShallow()source 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']);

Параметры

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

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

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

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

Возвращает

$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>',
        'multicheckboxTitle' => '<legend>{{text}}</legend>',
        'multicheckboxWrapper' => '<fieldset{{attrs}}>{{content}}</fieldset>',
        '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' => ['Button'],
    'checkbox' => ['Checkbox'],
    'file' => ['File'],
    'label' => ['Label'],
    'nestingLabel' => ['NestingLabel'],
    'multicheckbox' => ['MultiCheckbox', 'nestingLabel'],
    'radio' => ['Radio', 'nestingLabel'],
    'select' => ['SelectBox'],
    'textarea' => ['Textarea'],
    'datetime' => ['DateTime', 'select'],
    '_default' => ['Basic'],
]

''

[]

[]

['Url', 'Html']

null