Класс yii\validators\DateValidator

DateValidator проверяет, представляет ли атрибут дату, время или дату и время в правильном $формате.

Он также может анализировать интернационализированные даты в определённом $языке, например 12 мая 2014, когда $формат настроен для использования шаблона времени в формате ICU.

Кроме того, можно ограничить дату определённым диапазоном, используя $min и $max.

Помимо проверки даты, он также может экспортировать разобранную метку времени в удобочитаемый для машины формат, который можно настроить с помощью $timestampAttribute. Для значений, включающих информацию о времени (а не только дату), часовой пояс также будет скорректирован. Предполагается, что часовой пояс входного значения указан свойством $timeZone, а целевой часовой пояс будет UTC, когда $timestampAttributeFormat равен null (экспорт как метка времени Unix) или $timestampAttributeTimeZone в противном случае. Если вы хотите избежать преобразования часового пояса, убедитесь, что $timeZone и $timestampAttributeTimeZone одинаковы.

Общедоступные свойства

Общедоступные методы

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

Константы

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

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

Формат даты, которому должно соответствовать проверяемое значение. Это может быть шаблон даты и времени, как описано в руководстве ICU.

В качестве альтернативы это может быть строка, начинающаяся с php: и представляющая формат, распознаваемый классом PHP DateTime. См. http://php.net/manual/en/datetime.createfromformat.php для поддерживаемых форматов.

Если это свойство не задано, значение по умолчанию будет получено из Yii::$app->formatter->dateFormat, см. yii\i18n\Formatter::$dateFormat для получения подробностей. С версии 2.0.8 значение по умолчанию определяется из различных форматов класса форматировщика, в зависимости от значения $type:

• если тип TYPE_DATE, значение по умолчанию будет взято из yii\i18n\Formatter::$dateFormat,
• если тип TYPE_DATETIME, оно будет взято из yii\i18n\Formatter::$datetimeFormat,
• а если тип TYPE_TIME, оно будет yii\i18n\Formatter::$timeFormat.

Вот некоторые примеры значений:

'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

Примечание: используемые подлежащие парсеры дат различаются в зависимости от формата. Если вы используете формат ICU, и расширение PHP intl установлено, используется IntlDateFormatter для разбора входного значения. Во всех остальных случаях используется класс PHP DateTime. IntlDateFormatter имеет преимущество, что может анализировать международные даты, такие как 12. Mai 2015 или 12 мая 2014, в то время как PHP-парсер ограничен только английским языком. Однако PHP-парсер более строг в отношении входного формата, так как не примет 12.05.05 для формата php:d.m.Y, но IntlDateFormatter примет его для формата dd.MM.yyyy. Если вам необходимо использовать IntlDateFormatter, вы можете избежать этой проблемы, указав минимальную дату.

public string $format = null

$locale общественное свойство

Идентификатор языка, используемый для локализации разбора даты. Это эффективно только при установке расширения PHP intl. Если не задано, будет использован язык форматера. См. также yii\i18n\Formatter::$locale.

public string $locale = null

$max общественное свойство (доступно с версии 2.0.4)

Верхний предел даты. По умолчанию равен null, что означает отсутствие верхнего предела. Это может быть метка времени Unix или строка, представляющая значение даты и времени. Если это свойство является строкой, $format будет использоваться для его анализа.

См. также $tooBig для настраиваемого сообщения, используемого при превышении максимального значения даты.

public integer|string $max = null

$maxString общественное свойство (доступно с версии 2.0.4)

Пользовательское значение верхнего предела для отображения в сообщении об ошибке. Если это свойство равно null, будет использоваться значение $max (перед анализом).

public string $maxString = null

$min общественное свойство (доступно с версии 2.0.4)

Нижний предел даты. По умолчанию равен null, что означает отсутствие нижнего предела. Это может быть метка времени Unix или строка, представляющая значение даты и времени. Если это свойство является строкой, $format будет использоваться для его анализа.

См. также $tooSmall для настраиваемого сообщения, используемого при превышении минимального значения даты.

public integer|string $min = null

$minString общественное свойство (доступно с версии 2.0.4)

Пользовательское значение нижнего предела для отображения в сообщении об ошибке. Если это свойство равно null, будет использоваться значение $min (перед анализом).

public string $minString = null

$timeZone общественное свойство

Часовой пояс для разбора значений даты и времени. Это может быть любое значение, которое может быть передано в date_default_timezone_set(), например UTC, Europe/Berlin или America/Chicago. Обратитесь к справочнику php для доступных часовых поясов. Если это свойство не задано, будет использован часовой пояс yii\base\Application::$timeZone.

public string $timeZone = null

$timestampAttribute общественное свойство

Имя атрибута, который получит результат разбора. Когда это свойство не равно null и валидация успешна, указанный атрибут получит результат разбора.

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

Обратите внимание, что при использовании этого свойства входное значение будет преобразовано в метку времени Unix, которая по определению находится в UTC, поэтому будет выполнено преобразование из входного часового пояса в UTC. При определении $timestampAttributeFormat вы можете контролировать преобразование, задав $timestampAttributeTimeZone на другое значение, отличное от 'UTC'.

См. также:

• $timestampAttributeFormat
• $timestampAttributeTimeZone

public string $timestampAttribute = null

$timestampAttributeFormat общественное свойство (доступно с версии 2.0.4)

Формат, используемый при заполнении $timestampAttribute. Формат может быть указан так же, как и для $format.

Если не задано, $timestampAttribute получит метку времени Unix. Если $timestampAttribute не задан, это свойство будет проигнорировано.

См. также:

• $format
• $timestampAttribute

public string $timestampAttributeFormat = null

$timestampAttributeTimeZone общественное свойство (доступно с версии 2.0.4)

Часовой пояс, используемый при заполнении $timestampAttribute. По умолчанию UTC.

Это может быть любое значение, которое может быть передано в date_default_timezone_set(), например UTC, Europe/Berlin или America/Chicago. Обратитесь к справочнику php для доступных часовых поясов.

Если $timestampAttributeFormat не задан, это свойство будет проигнорировано.

См. также $timestampAttributeFormat.

public string $timestampAttributeTimeZone = 'UTC'

$tooBig общественное свойство (доступно с версии 2.0.4)

Определяемое пользователем сообщение об ошибке, используемое, когда значение больше, чем $max.

public string $tooBig = null

$tooSmall общественное свойство (доступно с версии 2.0.4)

Определяемое пользователем сообщение об ошибке, используемое, когда значение меньше, чем $min.

public string $tooSmall = null

$type общественное свойство (доступно с версии 2.0.8)

Тип валидатора. Указывает, должно ли проверяться значение даты, времени или даты и времени. Это свойство влияет на значение по умолчанию $format и также устанавливает правильное поведение, когда $format является одним из коротких форматов intl, short, medium, long, или full.

Это эффективно только при установке расширения PHP intl.

Это свойство может быть установлено в следующие значения:

• TYPE_DATE - (по умолчанию) для проверки только значений даты, это означает, что только значения, не включающие диапазон времени, являются допустимыми.
• TYPE_DATETIME - для проверки значений даты и времени, содержащих как часть даты, так и часть времени.
• TYPE_TIME - для проверки значений времени, не содержащих информации о дате.

public string $type = self::TYPE_DATE

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