Spec-Zone.ru › CakePHP 3.1

Класс DateTimeWidget

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

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

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

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

__constructsource public

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

Конструктор

Параметры

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

_adjustValuesource protected

_adjustValue( integer $value , array $options )

Настройка $value на основе параметров округления.

Параметры

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

Возвращает

integer
Величина для корректировки $value.

_daySelectsource protected

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

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

Параметры

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

Возвращает

string
строка

_deconstructDatesource protected

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

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

Параметры

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

Возвращает

array
массив

_generateNumberssource protected

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

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

Параметры

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

Параметры

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

Возвращает

array
массив

_getMonthNamessource protected

_getMonthNames( boolean $leadingZero false )

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

Параметры

логическое $leadingZero необязательно false
Указывает, нужно ли генерировать ключи месяцев с ведущим нулём.

Возвращает

array
массив

_hourSelectsource protected

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

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

Параметры

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

Возвращает

string
строка

_meridianSelectsource protected

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

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

Параметры

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

Возвращает

string
строка

_minuteSelectsource protected

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

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

Параметры

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

Возвращает

string
строка

_monthSelectsource protected

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

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

Параметры

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

Возвращает

string
строка

_normalizeDatasource protected

_normalizeData( array $data )

Нормализация данных.

Параметры

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

Возвращает

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

_secondSelectsource protected

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

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

Параметры

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

Возвращает

string
строка

_yearSelectsource protected

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

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

Параметры

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

Возвращает

string
строка
END_OF_DOCUMENT_MARKER

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

Параметры

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

Возвращает

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

Исключение

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

Реализация

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

secureFieldssource public

secureFields( array $data )

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

Когда элемент ввода часа находится в режиме 24 часов (null или format=24), элемент ввода мердиана будет опущен.

Параметры

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

Возвращает

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

Реализация

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–2016 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.
http://api.cakephp.org/3.1/class-Cake.View.Widget.DateTimeWidget.html

Spec-Zone.ru

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