Spec-Zone.ru › CakePHP 4.4

Класс FormHelper

Библиотека помощника для форм.

Автоматическое создание HTML-форм на основе заданных данных.

Пространство имён: Cake\View\Helper
Ссылка: https://book.cakephp.org/4/ru/views/helpers/form.html

Постоянные значения

  • string
    SECURE_SKIP
    'skip'

    Постоянная, используемая для пропуска процесса проверки безопасности, и не добавляющая поле в хеш или в поля без блокировки.

Краткое описание свойств

  • $Html public @property
    Cake\View\Helper\HtmlHelper
  • $Url public @property
    Cake\View\Helper\UrlHelper
  • $_View protected
    Cake\View\View

    Экземпляр View, к которому прикреплен данный помощник.

  • $_config protected
    array<string, mixed>

    Конфигурация во время выполнения.

  • $_configInitialized protected
    bool

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

  • $_context protected
    Cake\View\Form\ContextInterface|null

    Контекст текущей формы.

  • $_contextFactory protected
    Cake\View\Form\ContextFactory|null

    Фабрика контекста.

  • $_defaultConfig protected
    array<string, mixed>

    Конфигурация по умолчанию для помощника.

  • $_defaultWidgets protected
    array<string, array<string>>

    Значения по умолчанию виджетов.

  • $_groupedInputTypes protected
    array<string>

    Сгруппированные типы ввода.

  • $_helperMap protected
    array<string, array>

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

  • $_idPrefix protected
    string|null

    Префикс для атрибута id.

  • $_idSuffixes protected
    array<string>

    Список суффиксов id, используемых в текущем рендеринге.

  • $_lastAction protected
    string

    Значение атрибута action последней созданной формы. Используется для создания хешей, специфичных для формы/запроса, для защиты от подделки форм.

  • $_locator protected
    Cake\View\Widget\WidgetLocator

    Локатор для виджетов ввода.

  • $_templater protected
    Cake\View\StringTemplate|null

    Экземпляр StringTemplate.

  • $_valueSources protected
    array<string>

    Значения по умолчанию источников.

  • $formProtector protected
    Cake\Form\FormProtector|null

    Защитник формы.

  • $helpers protected
    array

    Другие помощники, используемые FormHelper.

  • $requestType public
    string|null

    Определяет тип создаваемой формы. Устанавливается FormHelper::create().

  • $supportedValueSources protected
    array<string>

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

Краткое описание методов

  • __call() public

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

  • __construct() public

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

  • __debugInfo() public

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

  • __get() public

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

  • _clearIds() protected

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

  • _configDelete() protected

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

  • _configRead() protected

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

  • _configWrite() protected

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

  • _confirm() protected

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

  • _csrfField() protected

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

  • _domId() protected

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

  • _extractOption() protected

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

  • _formUrl() protected

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

  • _getContext() protected

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

  • _getInput() protected

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

  • _getLabel() protected

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

  • _groupTemplate() protected

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

  • _id() protected

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

  • _idSuffix() protected

    Генерирует суффикс ID.

  • _initInputField() protected

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

  • _inputContainerTemplate() protected

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

  • _inputLabel() protected

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

  • _inputType() protected

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

  • _isDisabled() protected

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

  • _lastAction() protected

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

  • _magicOptions() protected

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

  • _optionsOptions() protected

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

  • _parseOptions() protected

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

  • addClass() public

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

  • addContextProvider() public

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

  • addWidget() public

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

  • allControls() public

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

  • button() public

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

  • checkbox() public

    Создаёт виджет чекбокса.

  • configShallow() public

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

  • context() public

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

  • contextFactory() public

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

  • control() public

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

  • controls() public

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

  • create() public

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

  • createFormProtector() protected

    Создать экземпляр FormProtector.

  • date() public

    Генерирует тег input с типом "date".

  • dateTime() public

    Генерирует тег input с типом "datetime-local".

  • email() public @method

    Создаёт элемент ввода типа email.

  • end() public

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

  • error() public

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

  • fieldset() public

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

  • file() public

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

  • formatTemplate() public

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

  • getConfig() public

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

  • getConfigOrFail() public

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

  • getFormProtector() public

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

  • getSourceValue() public

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

  • getTemplates() public

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

  • getValueSources() public

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

  • getView() public

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

  • getWidgetLocator() public

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

  • hidden() public

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

  • implementedEvents() public

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

  • initialize() public

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

  • isFieldError() public

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

  • label() public

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

  • month() public

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

  • multiCheckbox() public

    Создаёт набор флажков из вариантов.

  • number() public @method

    Создаёт поле ввода типа число.

  • password() public @method

    Создаёт поле ввода типа пароль.

  • postButton() public

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

  • postLink() public

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

  • radio() public

    Создаёт набор виджетов радио.

  • resetTemplates() public

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

  • search() public @method

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

  • secure() public

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

  • select() public

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

  • setConfig() public

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

  • setRequiredAndCustomValidity() protected

    Установить атрибут required и JS для пользовательской проверки.

  • setTemplates() public

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

  • setValueSources() public

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

  • setWidgetLocator() public

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

  • submit() public

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

  • templater() public

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

  • text() public @method

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

  • textarea() public

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

  • time() public

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

  • unlockField() public

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

  • validateValueSources() protected

    Проверить источники значений.

  • widget() public

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

  • year() public

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

Подробное описание методов

__call() public

__call(string $method, array $params): string

Обработчик отсутствующего метода — реализует различные простые типы ввода. Используется для создания вводов различных типов. Например, $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. Второй аргумент всегда должен быть массивом атрибутов для элемента ввода.

Параметры

string $method

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

array $params

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

Возвращает

string

Исключения

Cake\Core\Exception\CakeException
При отсутствии параметров для вызова метода.

__construct() public

__construct(Cake\View\View $view, array<string, mixed> $config = [])

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

Параметры

Cake\View\View $view

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

array<string, mixed> $config optional

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

__debugInfo() public

__debugInfo(): array<string, mixed>

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

Возвращает

array<string, mixed>

__get() public

__get(string $name): Cake\View\Helper|null|void

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

Параметры

string $name

Имя свойства, к которому происходит доступ.

Возвращает

Cake\View\Helper|null|void

_clearIds() protected

_clearIds(): void

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

Возвращает

void

_configDelete() protected

_configDelete(string $key): void

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

Параметры

string $key

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

Возвращает

void

Исключения

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

_configRead() protected

_configRead(string|null $key): mixed

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

Параметры

string|null $key

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

Возвращает

mixed

_configWrite() protected

_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void

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

Параметры

array<string, mixed>|string $key

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

mixed $value

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

string|bool $merge optional

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

Возвращает

void

Исключения

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

_confirm() protected

_confirm(string $okCode, string $cancelCode): string

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

Параметры

string $okCode

Код, выполняемый после выбора 'OK'

string $cancelCode

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

Возвращает

string

_csrfField() protected

_csrfField(): string

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

Возвращает

string

_domId() protected

_domId(string $value): string

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

Параметры

string $value

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

Возвращает

string

_extractOption() protected

_extractOption(string $name, array<string, mixed> $options, mixed $default = null): mixed

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

Параметры

string $name

Имя параметра для извлечения.

array<string, mixed> $options

Массив параметров для извлечения.

mixed $default optional

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

Возвращает

mixed

_formUrl() protected

_formUrl(Cake\View\Form\ContextInterface $context, array<string, mixed> $options): array|string

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

Параметры

Cake\View\Form\ContextInterface $context

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

array<string, mixed> $options

Массив параметров из create()

Возвращает

array|string

_getContext() protected

_getContext(mixed $data = []): Cake\View\Form\ContextInterface

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

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

Параметры

mixed $data optional

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

Возвращает

Cake\View\Form\ContextInterface

Исключения

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

_getInput() protected

_getInput(string $fieldName, array<string, mixed> $options): array|string

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

Параметры

string $fieldName

Имя поля.

array<string, mixed> $options

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

Возвращает

array|string

_getLabel() protected

_getLabel(string $fieldName, array<string, mixed> $options): string|false

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

Параметры

string $fieldName

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

array<string, mixed> $options

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

Возвращает

string|false

_groupTemplate() protected

_groupTemplate(array<string, mixed> $options): string

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

Параметры

array<string, mixed> $options

Параметры для шаблона группы.

Возвращает

string

_id() protected

_id(string $name, string $val): string

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

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

Параметры

string $name

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

string $val

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

Возвращает

string

_idSuffix() protected

_idSuffix(string $val): string

Генерирует суффикс ID.

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

Параметры

string $val

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

Возвращает

string

_initInputField() protected

_initInputField(string $field, array<string, mixed>|array<string> $options = []): array<string, mixed>

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

Параметры

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

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

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

Параметры

string $field

Имя поля для инициализации параметров.

array<string, mixed>|array<string> $options необязательно

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

Возвращает

array<string, mixed>

_inputContainerTemplate() protected

_inputContainerTemplate(array<string, mixed> $options): string

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

Параметры

array<string, mixed> $options

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

Возвращает

string

_inputLabel() protected

_inputLabel(string $fieldName, array<string, mixed>|string|null $label = null, array<string, mixed> $options = []): string

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

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

Параметры

string $fieldName

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

array<string, mixed>|string|null $label необязательно

Текст метки или массив с атрибутами метки.

array<string, mixed> $options необязательно

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

Возвращает

string

_inputType() protected

_inputType(string $fieldName, array<string, mixed> $options): string

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

Параметры

string $fieldName

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

array<string, mixed> $options

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

Возвращает

string

_isDisabled() protected

_isDisabled(array<string, mixed> $options): bool

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

Параметры

array<string, mixed> $options

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

Возвращает

bool

_lastAction() protected

_lastAction(array|string|null $url = null): void

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

Параметры

array|string|null $url необязательно

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

Возвращает

void

_magicOptions() protected

_magicOptions(string $fieldName, array<string, mixed> $options, bool $allowOverride): array<string, mixed>

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

Параметры

string $fieldName

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

array<string, mixed> $options

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

bool $allowOverride

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

Возвращает

array<string, mixed>

_optionsOptions() protected

_optionsOptions(string $fieldName, array<string, mixed> $options): array<string, mixed>

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

Параметры

string $fieldName

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

array<string, mixed> $options

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

Возвращает

array<string, mixed>

_parseOptions() protected

_parseOptions(string $fieldName, array<string, mixed> $options): array<string, mixed>

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

Параметры

string $fieldName

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

array<string, mixed> $options

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

Возвращает

array<string, mixed>

addClass() public

addClass(array<string, mixed> $options, string $class, string $key = 'class'): array<string, mixed>

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

Параметры

array<string, mixed> $options

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

string $class

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

string $key необязательно

ключ для использования класса. По умолчанию 'class'.

Возвращает

array<string, mixed>

addContextProvider() public

addContextProvider(string $type, callable $check): void

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

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

Параметры

string $type

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

callable $check

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

Возвращает

void

addWidget() public

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

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

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

Параметры

string $name

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

Cake\View\Widget\WidgetInterface|array $spec

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

Возвращает

void

allControls() public

allControls(array $fields = [], array<string, mixed> $options = []): string

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

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

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

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

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

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

Параметры

array $fields необязательно

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

array<string, mixed> $options необязательно

Массив параметров. Допустимые ключи:

Возвращает

string

Ссылки

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

button() public

button(string $title, array<string, mixed> $options = []): string

Создаёт тэг <button>.

Параметры:

  • type - Значение атрибута "type" для кнопки. По умолчанию "submit".
  • escapeTitle - Кодировать ли текст заголовка кнопки в HTML-сущности. По умолчанию true.
  • escape - Кодировать ли атрибуты тэга кнопки в HTML-сущности. По умолчанию true.
  • confirm - Сообщение подтверждения, которое будет отображено. Выполнение формы продолжится только после подтверждения.

Параметры

string $title

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

array<string, mixed> $options optional

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

Возвращает

string

Ссылки

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

checkbox() public

checkbox(string $fieldName, array<string, mixed> $options = []): array<string>|string

Создаёт виджет для чекбокса.

Параметры:

  • value - значение чекбокса
  • checked - булевое значение, указывающее, что этот чекбокс выбран.
  • hiddenField - boolean|string. Установите в false, чтобы отключить генерацию скрытого поля ввода. Передача строки определит значение скрытого поля ввода.
  • disabled - создать отключённый элемент ввода.
  • default - Установите значение по умолчанию для чекбокса. Это позволяет устанавливать чекбоксы по умолчанию, без необходимости проверки данных POST. Соответствующее значение данных POST перезапишет значение по умолчанию.

Параметры

string $fieldName

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

array<string, mixed> $options optional

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

Возвращает

array<string>|string

Ссылки

https://book.cakephp.org/4/ru/views/helpers/form.html#creating-checkboxes

configShallow() public

configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this

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

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

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

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

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

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

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

Параметры

array<string, mixed>|string $key

Ключ для установки или массив настроек.

mixed|null $value optional

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

Возвращает

$this

context() public

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

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

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

Параметры

Cake\View\Form\ContextInterface|null $context optional

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

Возвращает

Cake\View\Form\ContextInterface

contextFactory() public

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

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

Параметры

Cake\View\Form\ContextFactory|null $instance optional

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

array $contexts optional

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

Возвращает

Cake\View\Form\ContextFactory

control() public

control(string $fieldName, array<string, mixed> $options = []): string

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

Параметры

См. каждый метод типа поля для получения дополнительной информации. Любые параметры, являющиеся частью $attributes или $options для различных методов type, могут быть включены в $options для control(). Кроме того, все неизвестные ключи, которые не находятся в списке ниже или не являются частью параметров выбранного типа, будут обрабатываться как обычный атрибут 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' , где виджет отмечен

Параметры

string $fieldName

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

array<string, mixed> $options optional

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

Возвращает

string

Ссылки

https://book.cakephp.org/4/ru/views/helpers/form.html#creating-form-controls

controls() public

controls(array $fields, array<string, mixed> $options = []): string

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

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

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

Параметры

array $fields

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

array<string, mixed> $options optional

Массив параметров. Допустимые ключи:

Возвращает

string

Ссылки

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

create() public

create(mixed $context = null, array<string, mixed> $options = []): string

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

Параметры:

  • type Метод формы по умолчанию автоматически определяется на основе контекста формы. Если метод isCreate() контекста формы возвращает false, будет выполнен запрос PUT.
  • method Явно установите атрибут метода формы.
  • url URL, на который отправляется форма. Может быть строкой или массивом URL.
  • 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 optional

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

array<string, mixed> $options optional

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

Возвращает

string

Ссылки

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

createFormProtector() protected

createFormProtector(array<string, mixed> $formTokenData): Cake\Form\FormProtector

Создаёт экземпляр FormProtector.

Параметры

array<string, mixed> $formTokenData

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

Возвращает

Cake\Form\FormProtector

date() public

date(string $fieldName, array<string, mixed> $options = []): string

Создать тег ввода типа "date".

Options:

См. параметры dateTime().

Parameters

string $fieldName

Имя поля.

array<string, mixed> $options optional

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

Returns

string

dateTime() public

dateTime(string $fieldName, array<string, mixed> $options = []): string

Создать тег ввода типа "datetime-local".

Options:

  • value | default Значение по умолчанию, которое будет использоваться вводом. Если установлено значение true, будет использоваться текущая дата и время.

Parameters

string $fieldName

Имя поля.

array<string, mixed> $options optional

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

Returns

string

email() public @method

email(string $fieldName, array $options = []): string

Создает поле ввода типа email.

Parameters

string $fieldName
array $options optional

Returns

string

end() public

end(array<string, mixed> $secureAttributes = []): string

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

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

Parameters

array<string, mixed> $secureAttributes optional

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

Returns

string

Links

https://book.cakephp.org/4/en/views/helpers/form.html#closing-the-form

error() public

error(string $field, array|string|null $text = null, array<string, mixed> $options = []): string

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

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

Options:

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

Parameters

string $field

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

array|string|null $text optional

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

array<string, mixed> $options optional

См. выше.

Returns

string

Links

https://book.cakephp.org/4/en/views/helpers/form.html#displaying-and-checking-errors

fieldset() public

fieldset(string $fields = '', array<string, mixed> $options = []): string

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

Parameters

string $fields optional

Элементы формы для обертывания в fieldset

array<string, mixed> $options optional

Массив параметров. Допустимые ключи:

Returns

string

file() public

file(string $fieldName, array<string, mixed> $options = []): string

Создает виджет для загрузки файлов.

Parameters

string $fieldName

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

array<string, mixed> $options optional

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

Returns

string

Links

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

formatTemplate() public

formatTemplate(string $name, array<string, mixed> $data): string

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

Parameters

string $name

Имя шаблона.

array<string, mixed> $data

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

Returns

string

getConfig() public

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

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

Usage

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

$this->getConfig();

Чтение конкретного значения:

$this->getConfig('key');

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

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

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

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

Parameters

string|null $key optional

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

mixed $default optional

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

Returns

mixed

getConfigOrFail() public

getConfigOrFail(string $key): mixed

Возвращает конфигурацию для этого конкретного ключа.

Значение конфигурации для этого ключа должно существовать, оно никогда не может быть null.

Parameters

string $key

Ключ для получения.

Returns

mixed

Throws

InvalidArgumentException

getFormProtector() public

getFormProtector(): Cake\Form\FormProtector

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

Returns

Cake\Form\FormProtector

Throws

Cake\Core\Exception\CakeException

getSourceValue() public

getSourceValue(string $fieldname, array<string, mixed> $options = []): mixed

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

Parameters

string $fieldname

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

array<string, mixed> $options optional

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

Returns

mixed

getTemplates() public

getTemplates(string|null $template = null): array|string

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

Parameters

string|null $template optional

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

Returns

array|string

getValueSources() public

getValueSources(): array<string>

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

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

Returns

array<string>

getView() public

getView(): Cake\View\View

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

Returns

Cake\View\View

getWidgetLocator() public

getWidgetLocator(): Cake\View\Widget\WidgetLocator

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

Returns

Cake\View\Widget\WidgetLocator

hidden() public

hidden(string $fieldName, array<string, mixed> $options = []): string

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

Parameters

string $fieldName

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

array<string, mixed> $options optional

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

Returns

string

Links

https://book.cakephp.org/4/en/views/helpers/form.html#creating-hidden-inputs

implementedEvents() public

implementedEvents(): array<string, mixed>

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

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

Переопределите этот метод, если вам нужно добавить нестандартные обработчики событий. Или если вы хотите, чтобы помощники слушали нестандартные события.

Возвращает

array<string, mixed>

initialize() public

initialize(array<string, mixed> $config): void

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

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

Параметры

array<string, mixed> $config

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

Возвращает

void

isFieldError() public

isFieldError(string $field): bool

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

Параметры

string $field

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

Возвращает

bool

Ссылки

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

label() public

label(string $fieldName, string|null $text = null, array<string, mixed> $options = []): string

Возвращает отформатированный элемент 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 в метки, вам необходимо изменить шаблоны по умолчанию.

Параметры

string $fieldName

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

string|null $text optional

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

array<string, mixed> $options optional

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

Возвращает

string

Ссылки

https://book.cakephp.org/4/ru/views/helpers/form.html#creating-labels

month() public

month(string $fieldName, array<string, mixed> $options = []): string

Генерирует тег input с типом "month".

Параметры:

См. параметры dateTime().

Параметры

string $fieldName

Имя поля.

array<string, mixed> $options optional

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

Возвращает

string

multiCheckbox() public

multiCheckbox(string $fieldName, iterable $options, array<string, mixed> $attributes = []): string

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

Параметры

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

Может использоваться вместо выпадающего списка с атрибутом multiple.

Параметры

string $fieldName

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

iterable $options

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

array<string, mixed> $attributes optional

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

Возвращает

string

См. также

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

number() public @method

number(string $fieldName, array $options = []): string

Создает входные данные типа число.

Параметры

string $fieldName
array $options optional

Возвращает

string

password() public @method

password(string $fieldName, array $options = []): string

Создает входные данные типа пароль.

Параметры

string $fieldName
array $options optional

Возвращает

string

postButton() public

postButton(string $title, array|string $url, array<string, mixed> $options = []): string

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

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

Параметры:

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

Параметры

string $title

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

array|string $url

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

array<string, mixed> $options optional

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

Возвращает

string

Ссылки

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

postLink() public

postLink(string $title, array|string|null $url = null, array<string, mixed> $options = []): string

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

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

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

Параметры:

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

Параметры

string $title

Содержимое, которое будет заключено в теги .

array|string|null $url optional

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

array<string, mixed> $options optional

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

Возвращает

string

Ссылки

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

radio() public

radio(string $fieldName, iterable $options = [], array<string, mixed> $attributes = []): string

Создаёт набор виджетов радиокнопок.

Атрибуты:

  • value - Указывает значение, когда эта радиокнопка выбрана.
  • label - Либо false для отключения метки вокруг виджета, либо массив атрибутов для тега метки. selected будет добавлен ко всем классам, например 'class' => 'myclass', когда виджет выбран
  • hiddenField - boolean|string. Установите в false, чтобы не включать скрытый элемент ввода со значением ''. Также может быть строкой для установки значения скрытого элемента ввода. Это полезно для создания наборов радиокнопок, которые не являются непрерывными.
  • disabled - Установите в true или disabled для отключения всех радиокнопок. Используйте массив значений для отключения определённых радиокнопок.
  • empty - Установите в true для создания элемента ввода со значением '' в качестве первого варианта. Когда true, метка радиокнопки будет 'пустая'. Установите этот параметр в строку, чтобы управлять значением метки.

Параметры

string $fieldName

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

iterable $options optional

Массив вариантов радиокнопок.

array<string, mixed> $attributes optional

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

Возвращает

string

Ссылки

https://book.cakephp.org/4/en/views/helpers/form.html#creating-radio-buttons

resetTemplates() public

resetTemplates(): void

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

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

Возвращает

void

search() public @method

search(string $fieldName, array $options = []): string

Создаёт элемент ввода типа поиска.

Параметры

string $fieldName
array $options optional

Возвращает

string

secure() public

secure(array $fields = [], array<string, mixed> $secureAttributes = []): string

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

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

Параметры

array $fields optional

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

array<string, mixed> $secureAttributes optional

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

Возвращает

string

select() public

select(string $fieldName, iterable $options = [], array<string, mixed> $attributes = []): string

Возвращает отформатированный элемент 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'],
];

Параметры

string $fieldName

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

iterable $options optional

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

array<string, mixed> $attributes optional

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

Возвращает

string

См. также

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

Ссылки

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

setConfig() public

setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this

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

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

Устанавливает конкретное значение:

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

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

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

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

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

Параметры

array<string, mixed>|string $key

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

mixed|null $value optional

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

bool $merge optional

Если нужно рекурсивно объединить или перезаписать существующую конфигурацию, по умолчанию true.

Возвращает

$this

Выбрасывает

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

setRequiredAndCustomValidity() protected

setRequiredAndCustomValidity(string $fieldName, array<string, mixed> $options): array<string, mixed>

Устанавливает атрибут required и JS для проверки по умолчанию.

Параметры

string $fieldName

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

array<string, mixed> $options

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

Возвращает

array<string, mixed>

setTemplates() public

setTemplates(array<string> $templates): $this

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

Параметры

array<string> $templates

Добавляемые шаблоны.

Возвращает

$this

setValueSources() public

setValueSources(array<string>|string $sources): $this

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

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

Параметры

array<string>|string $sources

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

Возвращает

$this

Выбрасывает

InvalidArgumentException
Если список источников содержит недопустимое значение.

См. также

FormHelper::$supportedValueSources для допустимых значений.

setWidgetLocator() public

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

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

Параметры

Cake\View\Widget\WidgetLocator $instance

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

Возвращает

$this

submit() public

submit(string|null $caption = null, array<string, mixed> $options = []): string

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

Параметры

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

Параметры

string|null $caption optional

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

array<string, mixed> $options optional

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

Возвращает

string

Ссылки

https://book.cakephp.org/4/en/views/helpers/form.html#creating-buttons-and-submit-elements

templater() public

templater(): Cake\View\StringTemplate

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

Возвращает

Cake\View\StringTemplate

text() public @method

text(string $fieldName, array $options = []): string

Создаёт элемент ввода типа text.

Параметры

string $fieldName
array $options optional

Возвращает

string

textarea() public

textarea(string $fieldName, array<string, mixed> $options = []): string

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

Опции:

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

Параметры

string $fieldName

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

array<string, mixed> $options optional

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

Возвращает

string

Ссылки

https://book.cakephp.org/4/en/views/helpers/form.html#creating-textareas

time() public

time(string $fieldName, array<string, mixed> $options = []): string

Генерирует тег ввода типа "time".

Опции:

См. опции dateTime().

Параметры

string $fieldName

Имя поля.

array<string, mixed> $options optional

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

Возвращает

string

unlockField() public

unlockField(string $name): $this

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

Разблокированные поля не включаются в хэш защиты формы.

Параметры

string $name

Имя поля с использованием точки для разделения уровней.

Возвращает

$this

validateValueSources() protected

validateValueSources(array<string> $sources): void

Проверка источников значений.

Параметры

array<string> $sources

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

Возвращает

void

Исключения

InvalidArgumentException
Если список источников содержит недопустимое значение.

widget() public

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

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

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

Параметры

string $name

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

array $data optional

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

Возвращает

string

year() public

year(string $fieldName, array<string, mixed> $options = []): string

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

Атрибуты:

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

Параметры

string $fieldName

Имя поля.

array<string, mixed> $options optional

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

Возвращает

string

Ссылки

https://book.cakephp.org/4/en/views/helpers/form.html#creating-year-inputs

Подробное описание свойств

$Html public @property

Тип

Cake\View\Helper\HtmlHelper

$Url public @property

Тип

Cake\View\Helper\UrlHelper

$_View protected

Экземпляр View, к которому прикреплен этот помощник

Тип

Cake\View\View

$_config protected

Конфигурация выполнения

Тип

array<string, mixed>

$_configInitialized protected

Указатель, был ли объект config уже настроен по умолчанию

Тип

bool

$_context protected

Контекст для текущей формы.

Тип

Cake\View\Form\ContextInterface|null

$_contextFactory protected

Фабрика контекста.

Тип

Cake\View\Form\ContextFactory|null

$_defaultConfig protected

Конфигурация по умолчанию для помощника.

Тип

array<string, mixed>

$_defaultWidgets protected

Виджеты по умолчанию

Тип

array<string, array<string>>

$_groupedInputTypes protected

Сгруппированные типы ввода.

Тип

array<string>

$_helperMap protected

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

Тип

array<string, array>

$_idPrefix protected

Префикс для атрибута id.

Тип

string|null

$_idSuffixes protected

Список суффиксов id, используемых в текущем рендеринге.

Тип

array<string>

$_lastAction protected

Значение атрибута action последней созданной формы. Используется для создания форм/запросов, специфичных хешей для защиты от подделки форм.

Тип

string

$_locator protected

Локатор для виджетов ввода.

Тип

Cake\View\Widget\WidgetLocator

$_templater protected

Экземпляр StringTemplate.

Тип

Cake\View\StringTemplate|null

$_valueSources protected

Источники по умолчанию.

Тип

array<string>

$formProtector protected

Защитник форм

Тип

Cake\Form\FormProtector|null

$helpers protected

Другие помощники, используемые FormHelper

Тип

array

$requestType public

Определяет тип создаваемой формы. Устанавливается методом FormHelper::create().

Тип

string|null

$supportedValueSources protected

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

context - Соответствует экземплярам ContextInterface. data - Соответствует данным запроса (POST/PUT). query - Соответствует строке запроса.

Тип

array<string>

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/class-Cake.View.Helper.FormHelper.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API