Spec-Zone.ru › Yii 2.0

Класс yii\jui\DatePicker

Все классы | Свойства | Методы | События
Наследование yii\jui\DatePicker » yii\jui\InputWidget » yii\jui\Widget » yii\base\Widget » yii\base\Component » yii\base\Object
Реализует yii\base\Configurable, yii\base\ViewContextInterface
Доступно с версии 2.0
Исходный код https://github.com/yiisoft/yii2-jui/blob/master/DatePicker.php

DatePicker отображает datepicker виджет jQuery UI.

Например, чтобы использовать datepicker с моделью:

echo DatePicker::widget([
    'model' => $model,
    'attribute' => 'from_date',
    //'language' => 'ru',
    //'dateFormat' => 'yyyy-MM-dd',
]);

В следующем примере будет использовано свойство name:

echo DatePicker::widget([
    'name'  => 'from_date',
    'value'  => $value,
    //'language' => 'ru',
    //'dateFormat' => 'yyyy-MM-dd',
]);

Вы также можете использовать этот виджет в ActiveForm с помощью метода widget(), например, так:

<?= $form->field($model, 'from_date')->widget(\yii\jui\DatePicker::classname(), [
    //'language' => 'ru',
    //'dateFormat' => 'yyyy-MM-dd',
]) ?>

Обратите внимание, что пустая строка ('') и null приведут к пустому текстовому полю, в то время как 0 будет интерпретироваться как временная метка UNIX и приведет к отображению даты как 1970-01-01. Рекомендуется добавить фильтр валидации в вашу модель, который устанавливает значение в null в случае, если дата не была введена:

[['from_date'], 'default', 'value' => null],

См. также http://api.jqueryui.com/datepicker/.

Публичные свойства

Свойство Тип Описание Определено
$attribute строка Атрибут модели, к которому связан этот виджет. yii\jui\DatePicker
$autoIdPrefix строка Префикс для автоматически сгенерированных идентификаторов виджета. yii\base\Widget
$behaviors yii\base\Behavior[] Список поведений, прикрепленных к этому компоненту yii\base\Component
$clientEvents массив Обработчики событий для базового виджета jQuery UI. yii\jui\Widget
$clientOptions массив Параметры для базового виджета jQuery UI. yii\jui\Widget
$containerOptions массив Атрибуты HTML для тега контейнера. yii\jui\DatePicker
$counter целое число Счетчик, используемый для генерации $id для виджетов. yii\base\Widget
$dateFormat строка Форматная строка, используемая для форматирования значения даты. yii\jui\DatePicker
$id строка Идентификатор виджета. yii\base\Widget
$inline логическое значение Если true, отображает виджет как встроенный календарь, а поле ввода как скрытое поле. yii\jui\DatePicker
$language строка Идентификатор локали (например, 'fr', 'de', 'en-GB') для языка, который будет использоваться виджетом выбора даты. yii\jui\DatePicker
$model yii\base\Model Модель данных, с которой связан этот виджет. yii\jui\InputWidget
$name строка Имя поля ввода. yii\jui\InputWidget
$options массив Атрибуты HTML для тега контейнера виджета. yii\jui\Widget
$stack yii\base\Widget[] Виджеты, которые в данный момент отображаются (не завершены). yii\base\Widget
$value строка Значение поля ввода. yii\jui\DatePicker
$view yii\web\View Объект представления, который можно использовать для отображения представлений или файлов представления. yii\base\Widget
$viewPath строка Директория, содержащая файлы представления для этого виджета. yii\base\Widget

Защищенные свойства

Свойство Тип Описание Определено
$clientEventMap массив Названия событий, сопоставленные с тем, что должно быть указано в `. yii\jui\Widget

Публичные методы

Метод Описание Определено в
__call() Вызывает именованный метод, который не является методом класса. yii\base\Object
__clone() Этот метод вызывается после создания объекта путем клонирования существующего. yii\base\Component
__construct() Конструктор. yii\base\Object
__get() Возвращает значение свойства объекта. yii\base\Object
__isset() Проверяет, установлено ли свойство, т.е. определено и не равно null. yii\base\Object
__set() Устанавливает значение свойства объекта. yii\base\Object
__unset() Устанавливает свойство объекта в значение null. yii\base\Object
afterRun() Этот метод вызывается сразу после выполнения виджета. yii\base\Widget
attachBehavior() Прикрепляет поведение к этому компоненту. yii\base\Component
attachBehaviors() Прикрепляет список поведений к компоненту. yii\base\Component
beforeRun() Этот метод вызывается сразу перед выполнением виджета. yii\base\Widget
begin() Начинает работу виджета. yii\base\Widget
behaviors() Возвращает список поведений, по которым должен вести себя этот компонент. yii\base\Component
canGetProperty() Возвращает значение, указывающее, может ли свойство быть прочитано. yii\base\Object
canSetProperty() Возвращает значение, указывающее, может ли свойство быть установлено. yii\base\Object
className() Возвращает полное квалифицированное имя этого класса. yii\base\Object
detachBehavior() Отсоединяет поведение от компонента. yii\base\Component
detachBehaviors() Отсоединяет все поведения от компонента. yii\base\Component
end() Заканчивает работу виджета. yii\base\Widget
ensureBehaviors() Убеждается, что поведения, объявленные в behaviors(), прикреплены к этому компоненту. yii\base\Component
getBehavior() Возвращает объект именованного поведения. yii\base\Component
getBehaviors() Возвращает все прикрепленные к этому компоненту поведения. yii\base\Component
getId() Возвращает идентификатор виджета. yii\base\Widget
getView() Возвращает объект представления, который можно использовать для рендеринга представлений или файлов представлений. yii\base\Widget
getViewPath() Возвращает каталог, содержащий файлы представлений для этого виджета. yii\base\Widget
hasEventHandlers() Возвращает значение, указывающее, есть ли обработчики, прикрепленные к указанному событию. yii\base\Component
hasMethod() Возвращает значение, указывающее, определен ли метод. yii\base\Object
hasProperty() Возвращает значение, указывающее, определено ли свойство. yii\base\Object
init() Инициализирует виджет. yii\jui\DatePicker
off() Отсоединяет существующий обработчик событий от этого компонента. yii\base\Component
on() Прикрепляет обработчик событий к событию. yii\base\Component
render() Рендерит представление. yii\base\Widget
renderFile() Рендерит файл представления. yii\base\Widget
run() Рендерит виджет. yii\jui\DatePicker
setId() Устанавливает идентификатор виджета. yii\base\Widget
setView() Устанавливает объект представления, который будет использоваться этим виджетом. yii\base\Widget
trigger() Вызывает событие. yii\base\Component
widget() Создает экземпляр виджета и запускает его. yii\base\Widget

Защищенные методы

Метод Описание Определено в
hasModel() yii\jui\InputWidget
registerClientEvents() Регистрирует определённые события виджета jQuery UI. yii\jui\Widget
registerClientOptions() Регистрирует определённые параметры виджета jQuery UI. yii\jui\Widget
registerWidget() Регистрирует определённый активный пакет виджета jQuery UI, инициализирует его с параметрами клиента и регистрирует связанные события. yii\jui\Widget
renderWidget() Рендерит виджет DatePicker. yii\jui\DatePicker

События

Событие Тип Описание Определено в
EVENT_AFTER_RUN yii\base\WidgetEvent Событие, поднимаемое сразу после выполнения виджета. (доступно начиная с версии 2.0.11) yii\base\Widget
EVENT_BEFORE_RUN yii\base\WidgetEvent Событие, поднимаемое сразу перед выполнением виджета. (доступно начиная с версии 2.0.11) yii\base\Widget
EVENT_INIT yii\base\Event Событие, которое срабатывает при инициализации виджета через init(). (доступно начиная с версии 2.0.11) yii\base\Widget

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

$attribute общедоступное свойство

Атрибут модели, с которым связан этот виджет. Значение атрибута будет преобразовано с помощью `Yii::$app->formatter->asDate()` с $dateFormat, если он не равен null.

public string $attribute = null

$containerOptions общедоступное свойство

Атрибуты HTML для тега контейнера. Используется только тогда, когда $inline имеет значение true.

См. также yii\helpers\Html::renderTagAttributes() для получения подробной информации о том, как рендерятся атрибуты.

public array $containerOptions = []

$dateFormat общедоступное свойство

Строка формата, используемая для форматирования значения даты. Этот параметр будет использован для заполнения clientOption dateFormat. Значение может быть одним из "short", "medium", "long" или "full", представляющих предопределённые форматы различной длины.

Также может быть пользовательским форматом, как указано в руководстве ICU. В качестве альтернативы, это может быть строка, префикс которой php:, представляющая формат, распознаваемый функцией PHP date().

Например:

'MM/dd/yyyy' // date in ICU format
'php:m/d/Y' // the same date in PHP format

Если не задано, значение по умолчанию будет взято из Yii::$app->formatter->dateFormat.

public string $dateFormat = null

$inline public свойство

Если true, отображает виджет как инлайновый календарь, а поле ввода — как скрытое поле.

public boolean $inline = false

$language public свойство

Идентификатор региона (например, 'fr', 'de', 'en-GB') для языка, который будет использоваться виджетом выбора даты. Если это свойство пустое, будет использован текущий язык приложения.

С версии 2.0.2 используется резервное копирование, если язык приложения включает локаль (например, de-DE) и файл языка не существует, оно будет переходить на использование de.

public string $language = null

$value public свойство

Значение ввода. Это значение будет преобразовано с помощью `Yii::$app->formatter->asDate()` с $dateFormat, если он не равен null.

public string $value = null

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

init() public метод

Инициализирует виджет.

Если вы переопределяете этот метод, убедитесь, что сначала вызывается родительская реализация.

public void init ( )

renderWidget() protected метод

Отображает виджет DatePicker.

protected string renderWidget ( )
return string

Результат отображения.

run() public метод

Отображает виджет.

public void run ( )

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-jui-datepicker.html

Spec-Zone.ru

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