Class yii\validators\DateValidator

The default timezone used for parsing when no time parts are provided in the format. See $timestampAttributeTimeZone for more description.

The date format that the value being validated should follow. This can be a date time pattern as described in the ICU manual.

Alternatively this can be a string prefixed with php: representing a format that can be recognized by the PHP Datetime class. Please refer to https://secure.php.net/manual/en/datetime.createfromformat.php on supported formats.

If this property is not set, the default value will be obtained from Yii::$app->formatter->dateFormat, see yii\i18n\Formatter::$dateFormat for details. Since version 2.0.8 the default value will be determined from different formats of the formatter class, dependent on the value of $type:

• if type is TYPE_DATE, the default value will be taken from yii\i18n\Formatter::$dateFormat,
• if type is TYPE_DATETIME, it will be taken from yii\i18n\Formatter::$datetimeFormat,
• and if type is TYPE_TIME, it will be yii\i18n\Formatter::$timeFormat.

Here are some example values:

'MM/dd/yyyy' // date in ICU format
'php:m/d/Y' // the same date in PHP format
'MM/dd/yyyy HH:mm' // not only dates but also times can be validated

Note: the underlying date parsers being used vary dependent on the format. If you use the ICU format and the PHP intl extension is installed, the IntlDateFormatter is used to parse the input value. In all other cases the PHP DateTime class is used. The IntlDateFormatter has the advantage that it can parse international dates like 12. Mai 2015 or 12 мая 2014, while the PHP parser is limited to English only. The PHP parser however is more strict about the input format as it will not accept 12.05.05 for the format php:d.m.Y, but the IntlDateFormatter will accept it for the format dd.MM.yyyy. If you need to use the IntlDateFormatter you can avoid this problem by specifying a minimum date.

The locale ID that is used to localize the date parsing. This is only effective when the PHP intl extension is installed. If not set, the locale of the formatter will be used. See also yii\i18n\Formatter::$locale.

Upper limit of the date. Defaults to null, meaning no upper limit. This can be a unix timestamp or a string representing a date time value. If this property is a string, $format will be used to parse it.

See also $tooBig for the customized message used when the date is too big.

User friendly value of upper limit to display in the error message. If this property is null, the value of $max will be used (before parsing).

Lower limit of the date. Defaults to null, meaning no lower limit. This can be a unix timestamp or a string representing a date time value. If this property is a string, $format will be used to parse it.

See also $tooSmall for the customized message used when the date is too small.

User friendly value of lower limit to display in the error message. If this property is null, the value of $min will be used (before parsing).

Set this parameter to true if you need strict date format validation (e.g. only such dates pass validation for the following format 'yyyy-MM-dd': '0011-03-25', '2019-04-30' etc. and not '18-05-15', '2017-Mar-14' etc. which pass validation if this parameter is set to false)

The timezone to use for parsing date and time values. This can be any value that may be passed to date_default_timezone_set() e.g. UTC, Europe/Berlin or America/Chicago. Refer to the php manual for available timezones. If this property is not set, yii\base\Application::$timeZone will be used.

The name of the attribute to receive the parsing result. When this property is not null and the validation is successful, the named attribute will receive the parsing result.

This can be the same attribute as the one being validated. If this is the case, the original value will be overwritten with the timestamp value after successful validation.

Note, that when using this property, the input value will be converted to a unix timestamp, which by definition is in default UTC time zone, so a conversion from the input time zone to the default one will be performed. If you want to change the default time zone, set the $defaultTimeZone property. When defining $timestampAttributeFormat you can further control the conversion by setting $timestampAttributeTimeZone to a different value than 'UTC'.

See also:

• $timestampAttributeFormat
• $timestampAttributeTimeZone

The format to use when populating the $timestampAttribute. The format can be specified in the same way as for $format.

If not set, $timestampAttribute will receive a UNIX timestamp. If $timestampAttribute is not set, this property will be ignored.

See also:

• $format
• $timestampAttribute

The timezone to use when populating the $timestampAttribute with $timestampAttributeFormat. Defaults to UTC.

This can be any value that may be passed to date_default_timezone_set() e.g. UTC, Europe/Berlin or America/Chicago. Refer to the php manual for available timezones.

If $timestampAttributeFormat is not set, this property will be ignored.

See also $timestampAttributeFormat.

User-defined error message used when the value is bigger than $max.

User-defined error message used when the value is smaller than $min.

The type of the validator. Indicates, whether a date, time or datetime value should be validated. This property influences the default value of $format and also sets the correct behavior when $format is one of the intl short formats, short, medium, long, or full.

This is only effective when the PHP intl extension is installed.

This property can be set to the following values:

• TYPE_DATE - (default) for validating date values only, that means only values that do not include a time range are valid.
• TYPE_DATETIME - for validating datetime values, that contain a date part as well as a time part.
• TYPE_TIME - for validating time values, that contain no date information.