Spec-Zone.ru › Yii 2.0

Класс yii\mongodb\validators\MongoDateValidator

Все классы | Свойства | Методы | Константы
Наследование yii\mongodb\validators\MongoDateValidator » yii\validators\DateValidator » yii\validators\Validator » yii\base\Component » yii\base\Object
Реализует yii\base\Configurable
Доступно с версии 2.0.4
Исходный код https://github.com/yiisoft/yii2-mongodb/blob/master/validators/MongoDateValidator.php

MongoDateValidator — это улучшенная версия yii\validators\DateValidator, которая поддерживает значения \MongoDate.

Пример использования:

class Customer extends yii\mongodb\ActiveRecord
{
    ...
    public function rules()
    {
        return [
            ['date', 'yii\mongodb\validators\MongoDateValidator', 'format' => 'MM/dd/yyyy']
        ];
    }
}

См. также yii\validators\DateValidator.

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

Свойство Тип Описание Определено в
$attributeNames массив Имена атрибутов. yii\validators\Validator
$attributes массив|строка Атрибуты, которые должны быть проверены этим валидатором. yii\validators\Validator
$behaviors yii\base\Behavior[] Список поведений, присоединённых к этому компоненту yii\base\Component
$builtInValidators массив Список встроенных валидаторов (имя => класс или конфигурация) yii\validators\Validator
$enableClientValidation логическое значение Включить проверку на стороне клиента для этого валидатора. yii\validators\Validator
$except массив|строка Сценарии, для которых валидатор не должен применяться. yii\validators\Validator
$format строка Формат даты, которому должно соответствовать проверяемое значение. yii\validators\DateValidator
$isEmpty вызов PHP-вызов, заменяющий стандартную реализацию isEmpty(). yii\validators\Validator
$locale строка Идентификатор региона, используемый для локализации разбора даты. yii\validators\DateValidator
$max целое число|строка Максимальное значение даты. yii\validators\DateValidator
$maxString строка Наглядное значение максимального значения для отображения в сообщении об ошибке. yii\validators\DateValidator
$message строка Определяемое пользователем сообщение об ошибке. yii\validators\Validator
$min целое число|строка Минимальное значение даты. yii\validators\DateValidator
$minString строка Наглядное значение минимального значения для отображения в сообщении об ошибке. yii\validators\DateValidator
$mongoDateAttribute строка Имя атрибута, который получит результат разбора как экземпляр \MongoDate. yii\mongodb\validators\MongoDateValidator
$on массив|строка Сценарии, для которых валидатор может быть применён. yii\validators\Validator
$skipOnEmpty логическое значение Пропустить проверку, если значение атрибута равно null или пустой строке. yii\validators\Validator
$skipOnError логическое значение Пропустить проверку, если у проверяемого атрибута уже есть ошибка проверки по предыдущим правилам. yii\validators\Validator
$timeZone строка Часовой пояс для разбора значений даты и времени. yii\validators\DateValidator
$timestampAttribute строка Имя атрибута, который получит результат разбора. yii\validators\DateValidator
$timestampAttributeFormat строка Формат для заполнения $timestampAttribute. yii\validators\DateValidator
$timestampAttributeTimeZone строка Часовой пояс для заполнения $timestampAttribute. yii\validators\DateValidator
$tooBig строка Определяемое пользователем сообщение об ошибке, если значение больше, чем $max. yii\validators\DateValidator
$tooSmall строка Определяемое пользователем сообщение об ошибке, если значение меньше, чем $min. yii\validators\DateValidator
$type строка Тип валидатора. yii\validators\DateValidator
$when вызов PHP-вызов, значение которого определяет, должен ли применяться этот валидатор. yii\validators\Validator
$whenClient строка Имя JavaScript-функции, значение которой определяет, должен ли применяться этот валидатор на стороне клиента. yii\validators\Validator

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

Метод Описание Определено в
__call() Вызывает именованный метод, который не является методом класса. yii\base\Component
__clone() Этот метод вызывается после создания объекта путём клонирования существующего. yii\base\Component
__construct() Конструктор. yii\base\Object
__get() Возвращает значение свойства компонента. yii\base\Component
__isset() Проверяет, установлено ли свойство, т.е. определено и не равно null. yii\base\Component
__set() Устанавливает значение свойства компонента. yii\base\Component
__unset() Устанавливает свойство компонента в null. yii\base\Component
addError() Добавляет ошибку о заданном атрибуте в объект модели. yii\validators\Validator
attachBehavior() Прикрепляет поведение к этому компоненту. yii\base\Component
attachBehaviors() Прикрепляет список поведений к компоненту. yii\base\Component
behaviors() Возвращает список поведений, которые этот компонент должен использовать. yii\base\Component
canGetProperty() Возвращает значение, указывающее, можно ли прочитать свойство. yii\base\Component
canSetProperty() Возвращает значение, указывающее, можно ли установить свойство. yii\base\Component
className() Возвращает полное имя этого класса. yii\base\Object
clientValidateAttribute() Возвращает JavaScript, необходимый для выполнения проверки на стороне клиента. yii\validators\Validator
createValidator() Создаёт объект валидатора. yii\validators\Validator
detachBehavior() Открепляет поведение от компонента. yii\base\Component
detachBehaviors() Открепляет все поведения от компонента. yii\base\Component
ensureBehaviors() Убеждается, что поведения, объявленные в behaviors(), прикреплены к этому компоненту. yii\base\Component
getAttributeNames() Возвращает очищенные имена атрибутов без символа ! в начале yii\validators\Validator
getBehavior() Возвращает объект именованного поведения. yii\base\Component
getBehaviors() Возвращает все присоединенные к этому компоненту поведения. yii\base\Component
getClientOptions() Возвращает параметры проверки на стороне клиента. yii\validators\Validator
hasEventHandlers() Возвращает значение, указывающее, есть ли обработчик, присоединенный к названному событию. yii\base\Component
hasMethod() Возвращает значение, указывающее, определен ли метод. yii\base\Component
hasProperty() Возвращает значение, указывающее, определено ли свойство для этого компонента. yii\base\Component
init() Инициализирует объект. yii\validators\DateValidator
isActive() Возвращает значение, указывающее, активен ли валидатор для данного сценария и атрибута. yii\validators\Validator
isEmpty() Проверяет, пустое ли заданное значение. yii\validators\Validator
off() Открепляет существующий обработчик событий от этого компонента. yii\base\Component
on() Прикрепляет обработчик событий к событию. yii\base\Component
trigger() Вызывает событие. yii\base\Component
validate() Проверяет заданное значение. yii\validators\Validator
validateAttribute() Проверяет отдельный атрибут. yii\mongodb\validators\MongoDateValidator
validateAttributes() Проверяет указанный объект. yii\validators\Validator

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

Метод Описание Определено в
formatMessage() Форматирует сообщение с использованием I18N или просто strtr, если \Yii::$app недоступен. yii\validators\Validator
parseDateValue() Преобразует строку даты в временную метку UNIX yii\mongodb\validators\MongoDateValidator
validateValue() Проверяет значение. yii\validators\DateValidator

Константы

Константа Значение Описание Определено в
TYPE_DATE 'date' Константа для указания валидации $type как значения даты, используемая для проверки с помощью intl краткого формата. yii\validators\DateValidator
TYPE_DATETIME 'datetime' Константа для указания валидации $type как значения даты и времени, используемая для проверки с помощью intl краткого формата. yii\validators\DateValidator
TYPE_TIME 'time' Константа для указания валидации $type как значения времени, используемая для проверки с помощью intl краткого формата. yii\validators\DateValidator

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

$mongoDateAttribute публичное свойство

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

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

public string $mongoDateAttribute = null

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

parseDateValue() защищённый метод

Преобразует строку даты в метку времени UNIX

защищённый целое число|false parseDateValue ( $value )
$value строка

Строка, представляющая дату

return целое число|false

Метка времени UNIX или false в случае ошибки.

validateAttribute() публичный метод

Проверяет одно атрибут.

Дочерние классы должны реализовать этот метод, чтобы обеспечить фактическую логику проверки.

публичный void validateAttribute ( $model, $attribute )
$model yii\base\Model

Модель данных для проверки

$attribute строка

Имя проверяемого атрибута.

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

Spec-Zone.ru

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