ModuleValidate_EntityValidatorType
Package | engine.modules.validate |
---|---|
Inheritance | class ModuleValidate_EntityValidatorType » ModuleValidate_EntityValidator » Entity » LsObject |
Since | 1.0 |
Source Code | /engine/modules/validate/entity/ValidatorType.entity.class.php |
Валидатор типа данных
Для типа дата/время используется внешний валидатор DateTimeParser
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
allowEmpty | bool | Допускать или нет пустое значение | ModuleValidate_EntityValidatorType |
bSkipOnError | bool | Пропускать или нет ошибку | ModuleValidate_EntityValidator |
dateFormat | string | Допустимый формат даты, актуально при type = date | ModuleValidate_EntityValidatorType |
datetimeFormat | string | Допустимый формат даты со временем, актуально при type = datetime | ModuleValidate_EntityValidatorType |
fields | array | Список полей сущности для валидации | ModuleValidate_EntityValidator |
label | null|string | Название поля сущности для отображения в тексте ошибки | ModuleValidate_EntityValidator |
msg | null|string | Текст ошибки валидации, переопределяет текст валидатора | ModuleValidate_EntityValidator |
on | null|array | Список сценариев в которых участвует валидатор | ModuleValidate_EntityValidator |
timeFormat | string | Допустимый формат времени, актуально при type = time | ModuleValidate_EntityValidatorType |
type | string | Допустимый тип данных. | ModuleValidate_EntityValidatorType |
Protected Properties
Property | Type | Description | Defined By |
---|---|---|---|
_aData | array | Данные сущности, на этот массив мапятся методы set* и get* | Entity |
aValidateErrors | array | Список ошибок валидации в разрезе полей, например | Entity |
aValidateRules | array | Список правил валидации полей | Entity |
oEntityCurrent | null|Entity | Объект текущей сущности, которая проходит валидацию | ModuleValidate_EntityValidator |
sFieldCurrent | null|string | Объект текущей сущности, которая проходит валидацию | ModuleValidate_EntityValidator |
sPrimaryKey | null|string | Имя поля с первичным ключом в БД | Entity |
sValidateScenario | string | Сценарий валиадции полей | Entity |
Public Methods
Method | Description | Defined By |
---|---|---|
Init() | Метод инициализации сущности, вызывается при её создании | Entity |
_Validate() | Выполняет валидацию данных сущности | Entity |
__call() | Ставим хук на вызов неизвестного метода и считаем что хотели вызвать метод какого либо модуля | Entity |
__construct() | Если передать в конструктор ассоциативный массив свойств и их значений, то они автоматом загрузятся в сущность | Entity |
_addValidateError() | Добавляет для поля ошибку в список ошибок | Entity |
_clearValidateErrors() | Очищает список всех ошибок или для конкретного поля | Entity |
_createValidators() | Создает и возвращает список валидаторов для сущности | Entity |
_getData() | Получает массив данных сущности | Entity |
_getDataArray() | Рекурсивное преобразование объекта и вложенных объектов в массив | Entity |
_getDataOne() | Возвращает данные по конкретному полю | Entity |
_getPrimaryKey() | Получение первичного ключа сущности (ключ, а не значение!) | Entity |
_getPrimaryKeyValue() | Возвращает значение первичного ключа/поля | Entity |
_getValidateError() | Возвращает первую ошибку для поля или среди всех полей | Entity |
_getValidateErrors() | Возвращает список ошибок для всех полей или одного поля | Entity |
_getValidateScenario() | Возвращает текущий сценарий валидации | Entity |
_getValidators() | Возвращает список валидаторов с учетом текущего сценария | Entity |
_hasValidateErrors() | Проверяет есть ли ошибки валидации | Entity |
_setData() | Устанавливает данные сущности | Entity |
_setValidateScenario() | Устанавливает сценарий валидации | Entity |
applyTo() | Применять или нет сценарий к текущему валидатору | ModuleValidate_EntityValidator |
validate() | Запуск валидации | ModuleValidate_EntityValidatorType |
validateEntity() | Запускает валидацию полей сущности | ModuleValidate_EntityValidator |
validateEntityField() | Запускает валидацию конкретного поля сущности | ModuleValidate_EntityValidator |
Protected Methods
Method | Description | Defined By |
---|---|---|
getMessage() | Возвращает сообщение, используется для получения сообщения об ошибке валидатора | ModuleValidate_EntityValidator |
getValueOfCurrentEntity() | Возвращает значение поля текущей сущности | ModuleValidate_EntityValidator |
isEmpty() | Проверяет данные на пустое значение | ModuleValidate_EntityValidator |
setValueOfCurrentEntity() | Устанавливает значение поля текущей сущности | ModuleValidate_EntityValidator |
Property Details
allowEmpty
property
public bool $allowEmpty;
Допускать или нет пустое значение
dateFormat
property
public string $dateFormat;
Допустимый формат даты, актуально при type = date
datetimeFormat
property
public string $datetimeFormat;
Допустимый формат даты со временем, актуально при type = datetime
timeFormat
property
public string $timeFormat;
Допустимый формат времени, актуально при type = time
type
property
public string $type;
Допустимый тип данных. Допустимые значения: 'string', 'integer', 'float', 'array', 'date', 'time' и 'datetime'.
Method Details
validate()
method
public bool|string validate(mixed $sValue)
| ||
$sValue | mixed | Данные для валидации |
{return} | bool|string |
Source Code: /engine/modules/validate/entity/ValidatorType.entity.class.php#73 (show)
public function validate($sValue) {
if($this->allowEmpty && $this->isEmpty($sValue)) {
return true;
}
require_once(Config::Get('path.root.engine').'/lib/external/DateTime/DateTimeParser.php');
if($this->type==='integer') {
$bValid=preg_match('/^[-+]?[0-9]+$/',trim($sValue));
} else if($this->type==='float') {
$bValid=preg_match('/^[-+]?([0-9]*\.)?[0-9]+([eE][-+]?[0-9]+)?$/',trim($sValue));
} else if($this->type==='date') {
$bValid=DateTimeParser::parse($sValue,$this->dateFormat,array('month'=>1,'day'=>1,'hour'=>0,'minute'=>0,'second'=>0))!==false;
} else if($this->type==='time') {
$bValid=DateTimeParser::parse($sValue,$this->timeFormat)!==false;
} else if($this->type==='datetime') {
$bValid=DateTimeParser::parse($sValue,$this->datetimeFormat, array('month'=>1,'day'=>1,'hour'=>0,'minute'=>0,'second'=>0))!==false;
} else if($this->type==='array') {
$bValid=is_array($sValue);
} else {
return true;
}
if(!$bValid) {
return $this->getMessage($this->Lang_Get('validate_type_error',null,false),'msg',array('type'=>$this->type));
}
return true;
}
Запуск валидации