Class yii\jui\DatePicker

All Classes | Properties | Methods

Inheritance	yii\jui\DatePicker » yii\jui\InputWidget » yii\jui\Widget » yii\base\Widget
Available since version	2.0

DatePicker renders a datepicker jQuery UI widget.

For example to use the datepicker with a \yii\base\Model:

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

The following example will use the name property instead:

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

You can also use this widget in an \yii\widgets\ActiveForm using the \yii\widgets\ActiveField::widget() method, for example like this:

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

Note that and empty string ('') and null will result in an empty text field while 0 will be interpreted as a UNIX timestamp and result in a date displayed as 1970-01-01. It is recommended to add a validation filter in your model that sets the value to null in case when no date has been entered:

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

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$attribute	string	The model attribute that this widget is associated with.	yii\jui\DatePicker
$clientEvents	array	The event handlers for the underlying jQuery UI widget.	yii\jui\Widget
$clientOptions	array	The options for the underlying jQuery UI widget.	yii\jui\Widget
$containerOptions	array	The HTML attributes for the container tag.	yii\jui\DatePicker
$dateFormat	string	The format string to be used for formatting the date value.	yii\jui\DatePicker
$inline	boolean	If true, shows the widget as an inline calendar and the input as a hidden field.	yii\jui\DatePicker
$language	string	The locale ID (e.g. 'fr', 'de', 'en-GB') for the language to be used by the date picker.	yii\jui\DatePicker
$model	\yii\base\Model	The data model that this widget is associated with.	yii\jui\InputWidget
$name	string	The input name.	yii\jui\InputWidget
$options	array	The HTML attributes for the widget container tag.	yii\jui\Widget
$value	string	The input value.	yii\jui\DatePicker

Protected Properties

Hide inherited properties

Property	Type	Description	Defined By
$clientEventMap	array	Event names mapped to what should be specified in `.	yii\jui\Widget

Public Methods

Hide inherited methods

Method	Description	Defined By
init()	Initializes the widget.	yii\jui\DatePicker
run()	Renders the widget.	yii\jui\DatePicker

Protected Methods

Hide inherited methods

Method	Description	Defined By
hasModel()		yii\jui\InputWidget
registerClientEvents()	Registers a specific jQuery UI widget events	yii\jui\Widget
registerClientOptions()	Registers a specific jQuery UI widget options	yii\jui\Widget
registerWidget()	Registers a specific jQuery UI widget asset bundle, initializes it with client options and registers related events	yii\jui\Widget
renderWidget()	Renders the DatePicker widget.	yii\jui\DatePicker

Property Details

$attribute public property

The model attribute that this widget is associated with. The value of the attribute will be converted using \yii\i18n\Formatter::asDate() with the $dateFormat if it is not null.

public string $attribute = null

$containerOptions public property

The HTML attributes for the container tag. This is only used when $inline is true.

See also \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $containerOptions = []

$dateFormat public property

The format string to be used for formatting the date value. This option will be used to populate the clientOption dateFormat. The value can be one of "short", "medium", "long", or "full", which represents a preset format of different lengths.

It can also be a custom format as specified in the ICU manual. Alternatively this can be a string prefixed with php: representing a format that can be recognized by the PHP date()-function.

For example:

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

If not set the default value will be taken from Yii::$app->formatter->dateFormat.

public string $dateFormat = null

$inline public property

If true, shows the widget as an inline calendar and the input as a hidden field.

public boolean $inline = false

$language public property

The locale ID (e.g. 'fr', 'de', 'en-GB') for the language to be used by the date picker. If this property is empty, then the current application language will be used.

Since version 2.0.2 a fallback is used if the application language includes a locale part (e.g. de-DE) and the language file does not exist, it will fall back to using de.

public string $language = null

$value public property

The input value. This value will be converted using \yii\i18n\Formatter::asDate() with the $dateFormat if it is not null.

public string $value = null

Method Details

init() public method

Initializes the widget.

If you override this method, make sure you call the parent implementation first.

public void init ( )

renderWidget() protected method

Renders the DatePicker widget.

protected string renderWidget ( )
return	string	The rendering result.

run() public method

Renders the widget.

public void run ( )