Spec-Zone.ru › CakePHP 4.4

Класс DateTimeWidget

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

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

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

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

  • $_templates protected
    Cake\View\StringTemplate

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

  • $defaultStep protected
    array<string, mixed>

    Размер шага для различных типов ввода.

  • $defaults protected
    array<string, mixed>

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

  • $formatMap protected
    array<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(DateTime|string|int|null $value, array<string, mixed> $options): string

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

Параметры

DateTime|string|int|null $value

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

array<string, mixed> $options

Параметры преобразования.

Возвращает

string

Исключения

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

mergeDefaults() protected 

mergeDefaults(array<string, mixed> $data, Cake\View\Form\ContextInterface $context): array<string, mixed>

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

Параметры

array<string, mixed> $data

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

Cake\View\Form\ContextInterface $context

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

Возвращает

array<string, mixed>

render() public 

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

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

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

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

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

Параметры

array<string, mixed> $data

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

Cake\View\Form\ContextInterface $context

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

Возвращает

string

secureFields() public 

secureFields(array<string, mixed> $data): array<string>

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

Параметры

array<string, mixed> $data

Возвращает

array<string>

setMaxLength() protected 

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

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

Параметры

array<string, mixed> $data

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

Cake\View\Form\ContextInterface $context

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

string $fieldName

Имя поля.

Возвращает

array<string, mixed>

setRequired() protected 

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

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

Параметры

array<string, mixed> $data

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

Cake\View\Form\ContextInterface $context

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

string $fieldName

Имя поля.

Возвращает

array<string, mixed>

setStep() protected 

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

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

Параметры

array<string, mixed> $data

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

Cake\View\Form\ContextInterface $context

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

string $fieldName

Имя поля.

Возвращает

array<string, mixed>

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

$_templates protected

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

Тип

Cake\View\StringTemplate

$defaultStep protected

Размер шага для различных типов ввода.

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

Тип

array<string, mixed>

$defaults protected

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

Тип

array<string, mixed>

$formatMap protected

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

Тип

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.Widget.DateTimeWidget.html

Spec-Zone.ru

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