Spec-Zone.ru › CakePHP 4.2

Класс DateTimeWidget

Класс виджета для генерации виджета ввода даты и времени.

Этот класс обычно используется внутренне Cake\View\Helper\FormHelper, но может использоваться для генерации автономных вводов даты и времени.

Пространство имён: Cake\View\Widget

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

  • $_templates protected
    Cake\View\StringTemplate

    Экземпляр шаблона.

  • $defaultStep protected
    array

    Шаг для различных типов ввода.

  • $defaults protected
    array

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

  • $formatMap protected
    string[]

    Форматы для различных типов ввода.

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

  • __construct() public

    Конструктор.

  • formatDateTime() protected

    Форматирует переданное значение даты/времени в требуемый строковый формат.

  • mergeDefaults() protected

    Объединяет значения по умолчанию с переданными данными.

  • render() public

    Отображает виджет формы даты/времени.

  • secureFields() public

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

  • setMaxLength() protected

    Устанавливает значение атрибута "maxlength", если применимо.

  • setRequired() protected

    Устанавливает значение атрибута "required", если применимо.

  • setStep() protected

    Устанавливает значение атрибута "step", если применимо.

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

__construct() public 

__construct(Cake\View\StringTemplate $templates)

Конструктор.

Параметры

Cake\View\StringTemplate $templates

Список шаблонов.

formatDateTime() protected 

formatDateTime(string|intDateTime|null $value, array $options): string

Форматирует переданное значение даты/времени в требуемый строковый формат.

Параметры

string|intDateTime|null $value

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

array $options

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

Возвращает

string

Исключения

InvalidArgumentException
Если передан неверный тип ввода.

mergeDefaults() protected 

mergeDefaults(array $data, Cake\View\Form\ContextInterface $context): array

Объединяет значения по умолчанию с переданными данными.

Параметры

array $data

Массив данных

Cake\View\Form\ContextInterface $context

Экземпляр контекста.

Возвращает

array

render() public 

render(array $data, Cake\View\Form\ContextInterface $context): string

Отображает виджет формы даты/времени.

Данные поддерживают следующие ключи:

  • name Атрибут имени.
  • val Атрибут значения.
  • escape Установите в false, чтобы отключить экранирование всех атрибутов.
  • type Действительный HTML-тип ввода даты/времени. По умолчанию "datetime-local".
  • timezone Часовой пояс, в который должно быть преобразовано значение ввода.
  • step Атрибут "step". По умолчанию 1 для типов ввода "time" и "datetime-local". Вы можете установить его в null или false, чтобы предотвратить добавление явного атрибута step в HTML.
  • format Строка формата даты/времени, совместимая с функцией date(). По умолчанию виджет будет использовать подходящий формат на основе типа ввода и типа базы данных для контекста. Если явный формат задан, значение по умолчанию для атрибута step не будет установлено, и его необходимо явно установить, если требуется.

Все остальные ключи будут преобразованы в атрибуты HTML.

Параметры

array $data

Данные для создания элемента ввода файла.

Cake\View\Form\ContextInterface $context

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

Возвращает

string

secureFields() public 

secureFields(array $data): string[]

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

Параметры

array $data

Возвращает

string[]

setMaxLength() protected 

setMaxLength(array $data, Cake\View\Form\ContextInterface $context, string $fieldName): array

Устанавливает значение атрибута "maxlength", если применимо.

Параметры

array $data

Массив данных

Cake\View\Form\ContextInterface $context

Экземпляр контекста.

string $fieldName

Имя поля.

Возвращает

array

setRequired() protected 

setRequired(array $data, Cake\View\Form\ContextInterface $context, string $fieldName): array

Устанавливает значение атрибута "required", если применимо.

Параметры

array $data

Массив данных

Cake\View\Form\ContextInterface $context

Экземпляр контекста.

string $fieldName

Имя поля.

Возвращает

array

setStep() protected 

setStep(array $data, Cake\View\Form\ContextInterface $context, string $fieldName): array

Устанавливает значение атрибута "step", если применимо.

Параметры

array $data

Массив данных

Cake\View\Form\ContextInterface $context

Экземпляр контекста.

string $fieldName

Имя поля.

Возвращает

array

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

$_templates protected

Экземпляр шаблона.

Тип

Cake\View\StringTemplate

$defaultStep protected

Шаг для различных типов ввода.

Если не задано, по умолчанию используется значение по умолчанию браузера.

Тип

array

$defaults protected

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

Тип

array

$formatMap protected

Форматы для различных типов ввода.

Тип

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.2/class-Cake.View.Widget.DateTimeWidget.html

Spec-Zone.ru

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