Класс DateTimeWidget
Класс виджета для генерации виджета ввода даты и времени.
Этот класс предназначен как внутренняя деталь реализации Cake\View\Helper\FormHelper и не предназначен для прямого использования.
- Cake\View\Widget\DateTimeWidget реализует Cake\View\Widget\WidgetInterface
Краткое описание свойств
- Виджет выпадающего списка.
$_selectprotected -
$_selectsprotectedСписок элементов ввода, которые можно отобразитьarray - Экземпляр шаблона.
$_templatesprotected
Краткое описание методов
- __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 - Экземпляр виджета 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 - Конец диапазона чисел для генерации
- массив
$optionsoptional [] - Список параметров.
Возвращаемое значение
массив_getMonthNames()source protected
_getMonthNames( boolean $leadingZero false )
Возвращает переведённый список имён месяцев
Параметры
- логическое
$leadingZerooptional 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 )
Генерирует список выбора для секунд
Параметры
- array
$options - Параметры для генерации списка выбора для секунд
-
Cake\View\Form\ContextInterface$context - Текущий контекст формы.
Возвращает
string_yearSelect()source protected
_yearSelect( array $options , Cake\View\Form\ContextInterface $context )
Генерирует список выбора для года
Параметры
- array
$options - Список параметров.
-
Cake\View\Form\ContextInterface$context - Текущий контекст формы.
Возвращает
stringrender()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, чтобы включить поле ввода формата. По умолчанию false. Формат будет автоматически включен, если выбран 12-часовой формат.
Параметр year принимает параметры start и end. Они позволяют контролировать диапазон лет, который генерируется. По умолчанию это +/- 5 лет от текущей даты.
Параметр month принимает параметр name, который позволяет получить названия месяцев вместо номеров.
Параметр hour позволяет установить следующие параметры:
-
formatпараметр, принимающий значения 12 или 24, позволяющий указать желаемый формат часов. -
startЧас, с которого начинаются значения. -
endЧас, до которого заканчиваются значения.
Начальные и конечные значения зависят от используемого формата. Если значение выходит за пределы диапазона, оно не будет включено.
Параметр minute позволяет определить следующие параметры:
-
intervalИнтервал для округления значений. -
roundПринимает значенияupилиdown. Определяет, в какую сторону должно быть округлено текущее значение, чтобы соответствовать значениям в списке выбора.
Параметры
- array
$data - Данные для отображения.
-
Cake\View\Form\ContextInterface$context - Текущий контекст формы.
Возвращает
stringСгенерированный список выбора.
Использует
RuntimeExceptionПри невалидных данных параметров.
Реализация
Cake\View\Widget\WidgetInterface::render() secureFields()source public
secureFields( array $data )
Возвращает список полей, которые необходимо защитить для этого виджета.
Когда поле ввода часа в 24-часовом формате (null или format=24), поле ввода формата будет опущено.
Параметры
- array
$data - Данные для отображения.
Возвращает
arrayМассив полей для защиты.
Реализация
Cake\View\Widget\WidgetInterface::secureFields() Подробное описание свойств
$_selectssource
protected array
Список элементов ввода, которые могут быть отображены
[
'year',
'month',
'day',
'hour',
'minute',
'second',
'meridian',
]
© 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.4/class-Cake.View.Widget.DateTimeWidget.html