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

_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 необязательно []

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

Возвращает

Cake\View\Form\ContextInterface
Поставщик контекста.

Исключения

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 - boolean, указывает, должно ли поле добавляться в поля безопасности. Отключение поля с помощью параметра disabled, также исключит поле из хешируемого ключа.
• default - mixed - Значение, которое будет использоваться, если в контексте формы нет значения.
• disabled - mixed - Либо boolean, указывающий состояние отключения, либо строка в численно индексированном значении.
• id - mixed - Если true, он будет сгенерирован автоматически на основе имени поля.

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

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

Параметры

string $field

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

array $options optional []

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

Возвращает

array
Массив параметров для поля ввода.

_inputContainerTemplate()source protected

_inputContainerTemplate( array $options )

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

Параметры

array $options

Параметры для шаблона контейнера ввода.

Возвращает

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

_inputLabel()source protected

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

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

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

Параметры

string $fieldName

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

string $label

Текст метки.

array $options

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

Возвращает

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

_inputType()source protected

_inputType( string $fieldName , array $options )

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

Параметры

string $fieldName

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

array $options

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

Возвращает

string

_isDisabled()source protected

_isDisabled( array $options )

Определяет, отключено ли поле.

Параметры

array $options

Набор параметров.

Возвращает

boolean
Отключено ли поле.

_lastAction()source protected

_lastAction( string|array $url )

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

Параметры

string|array $url

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

_magicOptions()source protected

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

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

Параметры

string $fieldName

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

array $options

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

boolean $allowOverride

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

Возвращает

array

_optionsOptions()source protected

_optionsOptions( string $fieldName , array $options )

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

Параметры

string $fieldName

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

array $options

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

Возвращает

array

_parseOptions()source protected

_parseOptions( string $fieldName , array $options )

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

Параметры

string $fieldName

Имя поля, для которого нужно разобрать параметры.

array $options

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

Возвращает

array
Параметры

_secure()source protected

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

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

Параметры

boolean $lock

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

string|array $field

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

mixed $value optional null

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

_secureFieldName()source protected

_secureFieldName( string $name )

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

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

Параметры

string $name

Атрибут name полей формы.

Возвращает

array

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

_singleDatetime()source protected

_singleDatetime( array $options , string $keep )

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

Параметры

array $options

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

string $keep

Параметр, для отключения.

Возвращает

array

addContextProvider()source public

addContextProvider( string $type , callable $check )

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

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

Параметры

string $type

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

callable $check

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

addWidget()source public

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

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

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

Параметры

string $name

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

array|Cake\View\Widget\WidgetInterface $spec

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

allControls()source public

allControls( array $fields = [] , array $options = [] )

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

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

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

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

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

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

Параметры

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

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

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

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

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

Строка
Завершенные элементы управления формой.

Ссылка

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

allInputs()source public deprecated

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

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

Устаревшее

3.4.0 Используйте FormHelper::allControls() вместо этого.

Параметры

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

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

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

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

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

Строка
Завершенные элементы управления формой.

Ссылка

https://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.
• confirm - Сообщение подтверждения для отображения. Выполнение формы продолжится только после подтверждения.

Параметры

строка $title

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

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

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

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

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

Ссылка

https://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. Это позволяет устанавливать чекбоксы как выбранные, без необходимости проверки POST данных. Соответствующее значение POST данных перекроет значение по умолчанию.

Параметры

строка $fieldName

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

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

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

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

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

Ссылка

https://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 для получения.

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

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

contextFactory()source public

contextFactory( Cake\View\Form\ContextFactory $instance = null , array $contexts = [] )

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

Параметры

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

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

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

Массив поставщиков контекста.

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

Cake\View\Form\ContextFactory

control()source public

control( string $fieldName , array $options = [] )

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

Параметры

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

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

Параметры

строка $fieldName

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

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

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

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

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

Ссылка

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

controls()source public

controls( array $fields , array $options = [] )

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

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

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

Параметры

массив $fields

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

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

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

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

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

Ссылка

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

create()source public

create( mixed $context = null , array $options = [] )

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

Параметры:

• type Метод формы по умолчанию определяется автоматически в зависимости от контекста формы. Если метод isCreate() контекста формы возвращает false, будет выполнен запрос PUT.
• method Явно задать атрибут 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', позволяющий указать конкретный класс Table, на основе которого должна создаваться форма.
• idPrefix Префикс для атрибутов ID, генерируемых автоматически.
• valueSources Источники, из которых нужно считывать значения. См. FormHelper::setValueSources()
• templateVars Передать переменные шаблона для шаблона formStart.

Параметры

mixed $context необязательно null

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

array $options необязательно []

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

Возвращает

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

Ссылка

https://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 необязательно []

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

Возвращает

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

См. также

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

dateTime()source public

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

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

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

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

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

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

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

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

Параметры

строка $fieldName

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

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

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

Возвращает

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

Ссылка

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

Параметры

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

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

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

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

Возвращает

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

Ссылка

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

end()source public

end( array $secureAttributes = [] )

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

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

Параметры

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

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

Возвращает

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

Ссылка

https://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 - Нужно ли экранировать содержимое ошибки.

Параметры

строка $field

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

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

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

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

См. выше.

Возвращает

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

Ссылка

https://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.

Возвращает

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

Ссылка

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

getSourceValue()source public

getSourceValue( string $fieldname , array|null $options = [] )

Получает значение одного поля из доступных источников.

Параметры

строка $fieldname

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

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

Опции, содержащие значения по умолчанию.

Возвращает

строка|null
Значение поля, полученное из источников или значений по умолчанию.

getValueSources()source public

getValueSources( )

Получает источники значений.

Возвращает список, но по крайней мере один элемент, допустимых источников, таких как: 'context', 'data' и 'query'.

Возвращает

массив
Список источников значений.

getWidgetLocator()source public

getWidgetLocator( )

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

Возвращает

Cake\View\Widget\WidgetLocator
Текущая инстанция локатора

С момента

3.6.0

hidden()source public

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

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

Параметры

строка $fieldName

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

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

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

Возвращает

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

Ссылка

https://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 часов

Ссылка

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

implementedEvents()source public

implementedEvents( )

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

Возвращает

массив

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

Cake\View\Helper::implementedEvents()

input()source public deprecated

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

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

Устарело

3.4.0 Используйте FormHelper::control() вместо этого.

Параметры

строка $fieldName

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

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

Каждый тип ввода требует различных параметров.

Возвращает

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

Ссылка

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

inputs()source public deprecated

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

Генерирует набор элементов управления для $fields, заключённых в элемент fieldset.

Устарело

3.4.0 Используйте FormHelper::controls() вместо этого.

Параметры

массив $fields

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

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

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

Возвращает

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

Ссылка

https://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.

Ссылка

https://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().
• escape - Установите значение false для отключения экранирования текста метки. По умолчанию true.

Примеры:

Текст и атрибут 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>

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

Параметры

строка $fieldName

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

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

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

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

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

Возвращает

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

Ссылка

https://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 AM/PM

Ссылка

https://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 для минут.

Ссылка

https://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

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

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

Ссылка

https://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, чтобы удалить скрытое поле, которое гарантирует, что значение всегда отправляется.
• label - Либо false для отключения метки вокруг виджета, либо массив атрибутов для тега label. selected будет добавлен ко всем классам, например, 'class' => 'myclass' , где виджет отмечен

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

Параметры

строка $fieldName

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

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

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

массив $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.
• confirm - Сообщение подтверждения для отображения. Выполнение формы будет продолжено только после подтверждения.

Параметры

строка $title

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

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

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

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

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

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

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

Ссылка

https://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 />

Ссылка

https://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 для отключения метки вокруг виджета, либо массив атрибутов для тега label. selected будет добавлен ко всем классам, например, 'class' => 'myclass' , где виджет отмечен
• hiddenField - логическое значение, указывающее, хотите ли вы, чтобы результаты radio() включали скрытый ввод со значением ''. Это полезно для создания наборов радиокнопок, которые не являются непрерывными.
• disabled - Установите в true или disabled для отключения всех радио-кнопок. Используйте массив значений для отключения определённых радио-кнопок.
• empty - Установите в true для создания поля ввода со значением '' в качестве первого варианта. Когда true , метка радиокнопки будет 'пусто'. Установите эту опцию в строку, чтобы контролировать значение метки.

Параметры

строка $fieldName

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

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

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

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

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

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

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

Ссылка

https://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);

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

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

Параметры

строка $fieldName

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

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

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

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

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

Возвращает

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

См. также

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

Ссылка

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

setValueSources()source public

setValueSources( string|array $sources )

Устанавливает источники значений.

Допустимые значения: 'context', 'data' и 'query'. Вам нужно предоставить один допустимый контекст или несколько, как список строк. Порядок устанавливает приоритет.

Параметры

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

Строка или список строк, идентифицирующих источник.

Возвращает

$this

setWidgetLocator()source public

setWidgetLocator( Cake\View\Widget\WidgetLocator $instance )

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

Параметры

Cake\View\Widget\WidgetLocator $instance

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

Возвращает

$this

С тех пор

3.6.0

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 кнопка отправки

Ссылка

https://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 элемент текстового поля ввода

Ссылка

https://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, либо список полей.

Ссылка

https://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

Имя виджета. Например, «текст».

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

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

Возвращает

строка

widgetRegistry()source public deprecated

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

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

Устарело

3.6.0 Используйте FormHelper::widgetLocator() вместо этого.

Параметры

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 для года

Ссылка

https://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
Экземпляр помощника, если помощник с указанным именем существует

__set()source public

__set( string $name , mixed $value )

Магический setter для удаленных свойств.

Параметры

строка $name

Имя свойства.

смешанное $value

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

_cleanConfirmMessage()source protected

_cleanConfirmMessage( string $message )

Возвращает строку, предназначенную для использования в confirm()

Параметры

строка $message

Сообщение для очистки

Возвращает

смешанное

_confirm()source protected

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

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

Параметры

строка $message

Сообщение для отображения

строка $okCode

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

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

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

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

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

Возвращает

строка
код onclick JS

addClass()source public

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

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

Параметры

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

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

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

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

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

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

Возвращает

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

getView()source public

getView( )

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

Возвращает

Cake\View\View
Экземпляр привязанного представления.

initialize()source public

initialize( array $config )

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

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

Параметры

массив $config

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

_clearIds()source protected

_clearIds( )

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

_domId()source protected

_domId( string $value )

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

Параметры

строка $value

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

Возвращает

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

_id()source protected

_id( string $name , string $val )

Генерирует атрибут 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

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

Возвращает

строка

getTemplates()source public

getTemplates( string|null $template = null )

Получает используемые шаблоны или конкретный шаблон.

Параметры

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

Строка для чтения конкретного шаблона, null для всех.

Возвращает

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

setTemplates()source public

setTemplates( array $templates )

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

Параметры

массив $templates

Шаблоны для добавления.

Возвращает

$this

templater()source public

templater( )

Возвращает экземпляр templater.

Возвращает

Cake\View\StringTemplate

templates()source public deprecated

templates( string|null|array $templates = null )

Получение/установка шаблонов для использования.

Устаревший

3.4.0 Используйте setTemplates()/getTemplates() вместо этого.

Параметры

string|null|array $templates необязательный null

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

Возвращает

$this|string|array

_configDelete()source protected

_configDelete( string $key )

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

Параметры

string $key

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

Выбрасывает

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

_configRead()source protected

_configRead( string|null $key )

Считывает ключ конфигурации.

Параметры

string|null $key

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

Возвращает

mixed

_configWrite()source protected

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

Записывает ключ конфигурации.

Параметры

string|array $key

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

mixed $value

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

boolean|string $merge необязательный false

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

Выбрасывает

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

config()source public deprecated

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

Устаревший

3.4.0 используйте setConfig()/getConfig() вместо этого.

Параметры

string|array|null $key необязательный null

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

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

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

boolean $merge необязательный true

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

Возвращает

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

Выбрасывает

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

configShallow()source public

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

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

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

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

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

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

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

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

Параметры

string|array $key

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

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

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

Возвращает

$this

getConfig()source public

getConfig( string|null $key = null , mixed $default = null )

Возвращает конфигурацию.

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

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

$this->getConfig();

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

$this->getConfig('key');

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

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

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

string|null $key необязательный null

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

mixed $default необязательный null

Возвращаемое значение, когда ключ не существует.

Возвращает

mixed
Значение конфигурации, которое читается.

setConfig()source public

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

Устанавливает конфигурацию.

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

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

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

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

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

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

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

Параметры

string|array $key

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

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

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

boolean $merge необязательный true

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

Возвращает

$this

Выбрасывает

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

email( $fieldName , array $options = )

number( $fieldName , array $options = )

password( $fieldName , array $options = )

search( $fieldName , array $options = )

text( $fieldName , array $options = )

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

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

[
    'idPrefix' => null,
    'errorClass' => 'form-error',
    'typeMap' => [
        'string' => 'text',
        'text' => 'textarea',
        'uuid' => 'string',
        'datetime' => 'datetime',
        'timestamp' => 'datetime',
        'date' => 'date',
        'time' => 'time',
        'boolean' => 'checkbox',
        'float' => 'number',
        'integer' => 'number',
        'tinyinteger' => 'number',
        'smallinteger' => 'number',
        'decimal' => 'number',
        'binary' => 'file',
    ],
    'templates' => [
        // Used for button elements in button().
        'button' => '<button{{attrs}}>{{text}}</button>',
        // Used for checkboxes in checkbox() and multiCheckbox().
        'checkbox' => '<input type="checkbox" name="{{name}}" value="{{value}}"{{attrs}}>',
        // Input group wrapper for checkboxes created via control().
        'checkboxFormGroup' => '{{label}}',
        // Wrapper container for checkboxes.
        'checkboxWrapper' => '<div class="checkbox">{{label}}</div>',
        // Widget ordering for date/time/datetime pickers.
        'dateWidget' => '{{year}}{{month}}{{day}}{{hour}}{{minute}}{{second}}{{meridian}}',
        // Error message wrapper elements.
        'error' => '<div class="error-message">{{content}}</div>',
        // Container for error items.
        'errorList' => '<ul>{{content}}</ul>',
        // Error item wrapper.
        'errorItem' => '<li>{{text}}</li>',
        // File input used by file().
        'file' => '<input type="file" name="{{name}}"{{attrs}}>',
        // Fieldset element used by allControls().
        'fieldset' => '<fieldset{{attrs}}>{{content}}</fieldset>',
        // Open tag used by create().
        'formStart' => '<form{{attrs}}>',
        // Close tag used by end().
        'formEnd' => '</form>',
        // General grouping container for control(). Defines input/label ordering.
        'formGroup' => '{{label}}{{input}}',
        // Wrapper content used to hide other content.
        'hiddenBlock' => '<div style="display:none;">{{content}}</div>',
        // Generic input element.
        'input' => '<input type="{{type}}" name="{{name}}"{{attrs}}/>',
        // Submit input element.
        'inputSubmit' => '<input type="{{type}}"{{attrs}}/>',
        // Container element used by control().
        'inputContainer' => '<div class="input {{type}}{{required}}">{{content}}</div>',
        // Container element used by control() when a field has an error.
        'inputContainerError' => '<div class="input {{type}}{{required}} error">{{content}}{{error}}</div>',
        // Label element when inputs are not nested inside the label.
        'label' => '<label{{attrs}}>{{text}}</label>',
        // Label element used for radio and multi-checkbox inputs.
        'nestingLabel' => '{{hidden}}<label{{attrs}}>{{input}}{{text}}</label>',
        // Legends created by allControls()
        'legend' => '<legend>{{text}}</legend>',
        // Multi-Checkbox input set title element.
        'multicheckboxTitle' => '<legend>{{text}}</legend>',
        // Multi-Checkbox wrapping container.
        'multicheckboxWrapper' => '<fieldset{{attrs}}>{{content}}</fieldset>',
        // Option element used in select pickers.
        'option' => '<option value="{{value}}"{{attrs}}>{{text}}</option>',
        // Option group element used in select pickers.
        'optgroup' => '<optgroup label="{{label}}"{{attrs}}>{{content}}</optgroup>',
        // Select element,
        'select' => '<select name="{{name}}"{{attrs}}>{{content}}</select>',
        // Multi-select element,
        'selectMultiple' => '<select name="{{name}}[]" multiple="multiple"{{attrs}}>{{content}}</select>',
        // Radio input element,
        'radio' => '<input type="radio" name="{{name}}" value="{{value}}"{{attrs}}>',
        // Wrapping container for radio input/label,
        'radioWrapper' => '{{label}}',
        // Textarea input element,
        'textarea' => '<textarea name="{{name}}"{{attrs}}>{{value}}</textarea>',
        // Container for submit buttons.
        'submitContainer' => '<div class="submit">{{content}}</div>',
        //Confirm javascript template for postLink()
        'confirmJs' => '{{confirm}}',
    ],
    // set HTML5 validation message to custom required/empty messages
    'autoSetCustomValidity' => false,
]

[
    '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'],
]

['radio', 'multicheckbox', 'date', 'time', 'datetime']

''

[]

['context']

[]

['Url', 'Html']