Класс yii\mongodb\validators\MongoIdValidator
| Наследование | yii\mongodb\validators\MongoIdValidator » yii\validators\Validator » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0.4 |
| Исходный код | https://github.com/yiisoft/yii2-mongodb/blob/master/validators/MongoIdValidator.php |
MongoIdValidator проверяет, является ли атрибут валидным идентификатором Mongo.
Атрибут считается валидным, если он является экземпляром \MongoId или его строковым значением.
Пример использования:
class Customer extends yii\mongodb\ActiveRecord
{
...
public function rules()
{
return [
['_id', 'yii\mongodb\validators\MongoIdValidator']
];
}
}
Этот валидатор также может выполнять функцию фильтра, позволяя преобразовывать значение идентификатора Mongo в обычную строку или в экземпляр \MongoId. Вы можете включить эту функцию через $forceFormat.
Публичные свойства
| Свойство | Тип | Описание | Определено |
|---|---|---|---|
| $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 |
| $forceFormat | строка|null | Указывает формат, в который должно быть преобразовано значение проверенного атрибута в случае успешной проверки. | yii\mongodb\validators\MongoIdValidator |
| $isEmpty | вызываемый элемент PHP | Вызываемый элемент PHP, который заменяет стандартную реализацию isEmpty(). | yii\validators\Validator |
| $message | строка | Пользовательское сообщение об ошибке. | yii\validators\Validator |
| $on | массив|строка | Сценарии, для которых валидатор может применяться. | yii\validators\Validator |
| $skipOnEmpty | логическое значение | Пропустить эту проверку, если значение атрибута равно null или пустая строка. | yii\validators\Validator |
| $skipOnError | логическое значение | Пропустить эту проверку, если у валидируемого атрибута уже есть ошибка проверки по некоторым предыдущим правилам. | yii\validators\Validator |
| $when | вызываемый элемент PHP | Вызываемый элемент 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\mongodb\validators\MongoIdValidator |
| 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\MongoIdValidator |
| validateAttributes() | Проверяет указанный объект. | yii\validators\Validator |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| formatMessage() | Форматирует сообщение с использованием I18N или простым strtr, если \Yii::$app недоступен. | yii\validators\Validator |
| validateValue() | Проверяет значение. | yii\mongodb\validators\MongoIdValidator |
Подробности свойств
$forceFormat общедоступное свойство
Указывает формат, в который должно быть преобразовано значение атрибута, если проверка прошла успешно. Допустимые значения:
- 'string' — принудительно преобразовать значение в обычную строку.
- 'object' — принудительно преобразовать значение в экземпляр \MongoId. Если не задано — преобразование не будет выполнено, и значение атрибута останется неизменным.
public string|null $forceFormat = null
Подробности методов
init() public method
Инициализирует объект.
Этот метод вызывается в конце конструктора после инициализации объекта заданными настройками.
| public void init ( ) |
|---|
validateAttribute() public method
Проверяет одно атрибут.
Подклассы должны реализовывать этот метод для обеспечения фактической логики проверки.
| public void validateAttribute ( $model, $attribute ) | ||
|---|---|---|
| $model | yii\base\Model |
Модель данных, подлежащая проверке |
| $attribute | string |
Имя атрибута, подлежащего проверке. |
validateValue() protected method
Проверяет значение.
Класс валидатора может реализовать этот метод для поддержки проверки данных вне контекста модели данных.
| protected array|null validateValue ( $value ) | ||
|---|---|---|
| $value | mixed |
Значение данных, подлежащее проверке. |
| return | array|null |
Сообщение об ошибке и параметры, которые необходимо вставить в сообщение об ошибке. Следует вернуть Null, если данные валидны. |
| throws | yii\base\NotSupportedException |
если валидатор не поддерживает проверку данных без модели |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-mongodb-validators-mongoidvalidator.html
