Класс 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

Объект контекста, используемый для создания URL.

массив $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 )

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

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

Параметры

строка $fieldName

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

строка $label

Текст метки.

массив $options

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

Возвращает

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

_groupTemplate()source protected

_groupTemplate( array $options )

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

Параметры

массив $options

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

Возвращает

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

_initInputField()source protected

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

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

Опции

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

Этот метод преобразует численно индексированное «disabled» в ассоциативное значение массива. Внутренние механизмы 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

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

массив $options

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

Возвращает

строка

_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[поле], возвращается массив имен частей поля, например ['Model', 'поле'].

Параметры

строка $name

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

Возвращает

массив

Массив параметров имени поля, например ['Model.поле'] или ['Model', 'поле'] для массивов полей или пустой массив, если $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. Если вы передаете пустой массив, поле ввода будет включено - 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

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

массив $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 [] )

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

Опции:

• value - значение checkbox
• checked - булево значение, указывающее, что этот checkbox выбран.
• hiddenField - булево значение, указывающее, нужно ли включать скрытый элемент ввода со значением ''.
• disabled - создать отключённый элемент.
• default - установить значение по умолчанию для checkbox. Это позволяет устанавливать checkbox по умолчанию, без необходимости проверки 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 optional null

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

Возвращает

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

create()source public

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

Возвращает элемент HTML-формы.

Параметры:

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

Параметры

mixed $model optional null

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

array $options optional []

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

Возвращает

string
Форматированный открывающий тег 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() для параметров дат.

Параметры

string $fieldName

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

array $options optional []

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

Возвращает

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

См. также

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

dateTime()source public

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

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

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

• empty - Если true, отображается пустой элемент выбора. Если строка, эта строка отображается как пустой элемент.
• value | default Значение по умолчанию для ввода. Значение, соответствующее имени поля в $this->data, переопределит это значение. Если значение по умолчанию не указано, используется time().
• monthNames Если false, будут использоваться двузначные числа вместо текста. Если массив, будет использоваться переданный массив.
• 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}}

Параметры

string $fieldName

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

array $options optional []

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

Возвращает

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

Ссылка

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 Выбранное значение ввода.

Параметры

string|null $fieldName optional null

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

array $options optional []

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

Возвращает

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

Ссылка

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

end()source public

end( array $secureAttributes [] )

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

Параметры

array $secureAttributes optional []

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

Возвращает

string
Закрывающий тег 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 boolean - Нужно ли html-экранировать содержимое ошибки.

Параметры

string $field

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

string|array|null $text optional null

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

array $options optional []

См. выше.

Возвращает

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

Ссылка

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

fieldset()source public

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

Оборачивает набор входов в область fieldset

Параметры

string $fields optional ''

Входы формы для обёртки в fieldset

array $options optional []

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

Возвращает

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

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, пустой элемент списка выбора отображается. Если строка, эта строка отображается как пустой элемент.
• value — Выбранное значение элемента ввода.
• format — Установите в 12 или 24 для использования 12-часового или 24-часового формата. По умолчанию 24.

Параметры

строка $fieldName

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

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

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

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

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

Ссылка

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 — Для виджетов, которые принимают опции (например, radio, select).
• error — Управление сообщением об ошибке. Установите в false для отключения любого вида отчёта об ошибках (ошибка поля и сообщения об ошибках).
• empty — Строка или булево значение для включения пустых вариантов списка выбора.
• nestedInput — Используется с элементами ввода checkbox и radio. Установите в false, чтобы отобразить элементы управления вне элементов метки. Может быть установлен в true для любого элемента ввода, чтобы поместить элемент ввода в метку. Если вы включите этот параметр для радиокнопок, вам также потребуется изменить шаблон по умолчанию radioWrapper.
• templates — Шаблоны, которые вы хотите использовать для этого элемента ввода. Любые шаблоны будут объединены поверх уже загруженных шаблонов. Этот параметр может быть именем файла в /config, содержащим загружаемые шаблоны, или массивом используемых шаблонов.
• labelOptions — Либо false для отключения метки вокруг вложенных виджетов (например, радио, многократного выбора), или массив атрибутов для тега метки. selected будет добавлен к любым классам, например class => 'myclass' когда виджет выбран.

Параметры

строка $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. Также можно передать массив параметров, которые будут применяться как атрибуты тега 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

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

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

boolean
Если есть ошибки, этот метод возвращает 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>

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

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, пустой элемент списка выбора отображается. Если строка, эта строка отображается как пустой элемент.
• value — Выбранное значение элемента ввода.

Параметры

строка $fieldName

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

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

Массив опций

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

строка
Завершенный элемент выбора AM/PM

Ссылка

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

Параметры

строка $fieldName

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

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

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

Возвращает

строка
Заполненный элемент выбора минут.

Ссылка

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, пустой элемент выбора отображается. Если строка, то эта строка отображается как пустой элемент.
• 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 — При использовании multiple = checkbox имя класса, которое следует применить к div. По умолчанию 'checkbox'.
• disabled — Управление атрибутом disabled. При создании чекбоксов, true отключит все чекбоксы. Также можно задать disabled список значений, которые нужно отключить при создании чекбоксов.
• hiddenField — Установите в false, чтобы удалить скрытое поле, которое гарантирует, что значение всегда отправляется.
• label — Либо false для отключения метки вокруг виджета, либо массив атрибутов для тега метки. selected будет добавлен ко всем классам, например, 'class' => 'myclass', где виджет отмечен

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

Параметры

строка $fieldName

Атрибут name элемента 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 — Либо false для отключения метки вокруг виджета, либо массив атрибутов для тега метки. selected будет добавлен ко всем классам, например, 'class' => 'myclass' где виджет выбран
• hiddenField — Булево значение, указывающее, хотите ли вы, чтобы результаты radio() включали скрытый ввод со значением ''. Это полезно для создания наборов радио-кнопок, которые не являются непрерывными.
• 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, отображается пустая опция выбора. Если строка, эта строка отображается как пустой элемент.
• 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 (как пары 'value'=>'Текст') для использования в элементе 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

Имя поля в формате "modelname.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 опционально []

Массив опций

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

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

См. также

\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, отображается пустая опция выбора. Если строка, эта строка отображается как пустой элемент.
• orderYear — Порядок значений года в опциях выбора. Возможные значения 'asc', 'desc'. По умолчанию 'desc'
• value Выбранное значение ввода.
• maxYear Максимальный год, который должен отображаться в элементе выбора.
• minYear Минимальный год, который должен отображаться в элементе выбора.

Параметры

строка $fieldName

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

массив $options опционально []

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

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

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

Ссылка

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

Код, который будет выполнен после того, как пользователь выбрал 'OK'

строка $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, подходящий для использования в атрибуте ID.

Параметры

строка $value

Значение, которое нужно преобразовать в ID.

Возвращает

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

_id()source protected

_id( string $name , string $val )

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

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

Параметры

строка $name

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

строка $val

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

Возвращает

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

_buildFieldToken()source protected

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

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

Параметры

строка $url

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

массив $fields

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

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

Список полей, исключаемых из проверки валидации поля.

Возвращает

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

formatTemplate()source public

formatTemplate( string $name , array $data )

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

Параметры

строка $name

Имя шаблона.

массив $data

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

Возвращает

строка

templater()source public

templater( )

templater

Возвращает

Cake\View\StringTemplate

templates()source public

templates( string|null|array $templates null )

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

Параметры

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

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

Возвращает

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

_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

True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию 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

Рекурсивное слияние или перезапись существующей конфигурации, по умолчанию 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