Spec-Zone.ru › CakePHP 3.3

Класс DateTimeWidget

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

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

Cake\View\Widget\DateTimeWidget реализует Cake\View\Widget\WidgetInterface
Пространство имён: Cake\View\Widget
Расположение: View/Widget/DateTimeWidget.php

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

  • $_select protected
    Cake\View\Widget\SelectBoxWidget
    Виджет выпадающего списка.
  • $_selects protected
    array
    Список входов, которые можно отобразить
  • $_templates protected
    Cake\View\StringTemplate
    Экземпляр шаблона.

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

  • __construct() public
    Конструктор
  • _adjustValue() protected
    Корректирует $value на основе настроек округления.
  • _daySelect() protected
    Генерирует выбор дня
  • _deconstructDate() protected
    Декомпонует переданное значение даты во все единицы времени
  • _generateNumbers() protected
    Генерирует диапазон чисел
  • _getMonthNames() protected
    Возвращает переведённый список имён месяцев
  • _hourSelect() protected
    Генерирует выбор часа
  • _meridianSelect() protected
    Генерирует выбор меридиана
  • _minuteSelect() protected
    Генерирует выбор минуты
  • _monthSelect() protected
    Генерирует выбор месяца
  • _normalizeData() protected
    Нормализует данные.
  • _secondSelect() protected
    Генерирует выбор секунды
  • _yearSelect() protected
    Генерирует выбор года
  • render() public
    Отображает виджет даты и времени
  • secureFields() public
    Возвращает список полей, которые нужно защитить для данного виджета.

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

__construct()source public

__construct( Cake\View\StringTemplate $templates , Cake\View\Widget\SelectBoxWidget $selectBox )

Конструктор

Параметры

Cake\View\StringTemplate $templates
Список шаблонов.
Cake\View\Widget\SelectBoxWidget $selectBox
Экземпляр виджета выпадающего списка.

_adjustValue()source protected

_adjustValue( integer $value , array $options )

Корректирует $value на основе настроек округления.

Параметры

целое число $value
Значение, которое нужно скорректировать.
массив $options
Параметры, содержащие интервал и, возможно, округление.

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

целое число
Количество, на которое нужно скорректировать $value.

_daySelect()source protected

_daySelect( array $options , Cake\View\Form\ContextInterface $context )

Генерирует выбор дня

Параметры

массив $options
Параметры для генерации выбора дня.
Cake\View\Form\ContextInterface $context
Текущий контекст формы.

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

строка

_deconstructDate()source protected

_deconstructDate( string|integer|array|DateTime|null $value , array $options )

Декомпонует переданное значение даты во все единицы времени

Параметры

строка|целое число|массив|DateTime|null $value
Значение для декомпоновки.
массив $options
Параметры для преобразования.

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

массив

_generateNumbers()source protected

_generateNumbers( integer $start , integer $end , array $options [] )

Генерирует диапазон чисел

Параметры

  • leadingZeroKey - Установить в true, чтобы добавить ведущий 0 к однозначным ключам.
  • leadingZeroValue - Установить в true, чтобы добавить ведущий 0 к однозначным значениям.
  • interval - Интервал для генерации чисел. По умолчанию 1.

Параметры

целое число $start
Начало диапазона чисел для генерации
целое число $end
Конец диапазона чисел для генерации
массив $options optional []
Список параметров.

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

массив

_getMonthNames()source protected

_getMonthNames( boolean $leadingZero false )

Возвращает переведённый список имён месяцев

Параметры

boolean $leadingZero optional false
Нужно ли генерировать ключи месяцев с ведущим нулём.

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

массив

_hourSelect()source protected

_hourSelect( array $options , Cake\View\Form\ContextInterface $context )

Генерирует выбор часа

Параметры

массив $options
Параметры для генерации выбора часа
Cake\View\Form\ContextInterface $context
Текущий контекст формы.

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

строка

_meridianSelect()source protected

_meridianSelect( array $options , Cake\View\Form\ContextInterface $context )

Генерирует выбор меридиана

Параметры

массив $options
Параметры для генерации выбора меридиана.
Cake\View\Form\ContextInterface $context
Текущий контекст формы.

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

строка

_minuteSelect()source protected

_minuteSelect( array $options , Cake\View\Form\ContextInterface $context )

Генерирует выбор минуты

Параметры

массив $options
Параметры для генерации выбора минуты.
Cake\View\Form\ContextInterface $context
Текущий контекст формы.

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

строка

_monthSelect()source protected

_monthSelect( array $options , Cake\View\Form\ContextInterface $context )

Генерирует выбор месяца

Параметры

массив $options
Параметры для построения выбора месяца
Cake\View\Form\ContextInterface $context
Текущий контекст формы.

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

строка

_normalizeData()source protected

_normalizeData( array $data )

Нормализует данные.

Параметры

массив $data
Данные для нормализации.

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

массив
Нормализованные данные.

_secondSelect()source protected

_secondSelect( array $options , Cake\View\Form\ContextInterface $context )

Генерирует выбор секунды

Параметры

массив $options
Параметры для генерации выбора секунды
Cake\View\Form\ContextInterface $context
Текущий контекст формы.

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

строка
END_OF_DOCUMENT_MARKER

_yearSelect()source protected

_yearSelect( array $options , Cake\View\Form\ContextInterface $context )

Генерирует список годов

Параметры

массив $options
Список опций.
Cake\View\Form\ContextInterface $context
Текущий контекст формы.

Возвращает

строка

render()source public

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

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

  • name - Установить имя поля ввода.
  • disabled - true или массив опций для отключения.
  • val - Строка даты и времени, целое число или объект DateTime
  • empty - Установить в true, чтобы добавить пустую опцию вверху элементов списка. Установить в строку, чтобы определить отображаемое значение пустой опции.

В дополнение к вышеперечисленным опциям следующие опции позволяют управлять тем, какие элементы ввода генерируются. Установив любую опцию в false, вы можете отключить соответствующий элемент выбора. Кроме того, каждый элемент выбора позволяет устанавливать дополнительные опции, которые задаются в качестве свойств HTML.

  • year - Массив опций для выпадающего списка годов.
  • month - Массив опций для выпадающего списка месяцев.
  • day - Массив опций для выпадающего списка дней.
  • hour - Массив опций для выпадающего списка часов.
  • minute - Массив опций для выпадающего списка минут.
  • second - Установить в true, чтобы включить поле ввода секунд. По умолчанию false.
  • meridian - Установить в true, чтобы включить поле ввода периода (AM/PM). По умолчанию false. Период автоматически включится, если вы выберете 12-часовой формат.

Опция year принимает опции start и end. Они позволяют управлять диапазоном годов, которые генерируются. По умолчанию +-5 лет от текущей даты.

Опция month принимает опцию name, которая позволяет получить названия месяцев вместо номеров.

Опция hour позволяет установить следующие опции:

  • format опция, принимающая 12 или 24, позволяющая указать желаемый формат часов.
  • start Час, с которого начинаются опции.
  • end Час, на котором заканчиваются опции.

Начальные и конечные значения зависят от используемого формата. Если значение выходит за пределы диапазона, оно не будет включено.

Опция minute позволяет определить следующие опции:

  • interval Интервал округления опций.
  • round Принимает up или down. Определяет направление округления текущего значения для соответствия опциям списка.

Параметры

массив $data
Данные для отображения.
Cake\View\Form\ContextInterface $context
Текущий контекст формы.

Возвращает

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

Исключения

RuntimeException
При некорректных данных опций.

Реализация

Cake\View\Widget\WidgetInterface::render()

secureFields()source public

secureFields( array $data )

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

Когда выбор часов находится в 24-часовом формате (null или format=24), выбор периода (AM/PM) будет опущен.

Параметры

массив $data
Данные для отображения.

Возвращает

массив
Массив полей для защиты.

Реализация

Cake\View\Widget\WidgetInterface::secureFields()

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

$_selectsource

protected Cake\View\Widget\SelectBoxWidget

Виджет выпадающего списка.

$_selectssource

protected массив

Список элементов ввода, которые могут быть отображены

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

$_templatessource

protected Cake\View\StringTemplate

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

© 2005–2017 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/3.3/class-Cake.View.Widget.DateTimeWidget.html

Spec-Zone.ru

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