ModuleValidate_EntityValidatorString

Package engine.modules.validate
Inheritance class ModuleValidate_EntityValidatorString » ModuleValidate_EntityValidator » Entity » LsObject
Since 1.0
Source Code /engine/modules/validate/entity/ValidatorString.entity.class.php
Валидатор текстовых данных на длину

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
allowEmpty bool Допускать или нет пустое значение ModuleValidate_EntityValidatorString
bSkipOnError bool Пропускать или нет ошибку ModuleValidate_EntityValidator
fields array Список полей сущности для валидации ModuleValidate_EntityValidator
is int Конкретное значение длины строки ModuleValidate_EntityValidatorString
label null|string Название поля сущности для отображения в тексте ошибки ModuleValidate_EntityValidator
max int Максимальня длина строки ModuleValidate_EntityValidatorString
min int Минимальная длина строки ModuleValidate_EntityValidatorString
msg null|string Текст ошибки валидации, переопределяет текст валидатора ModuleValidate_EntityValidator
msgTooLong string Кастомное сообщение об ошибке при слишком длинной строке ModuleValidate_EntityValidatorString
msgTooShort string Кастомное сообщение об ошибке при короткой строке ModuleValidate_EntityValidatorString
on null|array Список сценариев в которых участвует валидатор ModuleValidate_EntityValidator

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined 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

Hide inherited methods

MethodDescriptionDefined 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_EntityValidatorString
validateEntity() Запускает валидацию полей сущности ModuleValidate_EntityValidator
validateEntityField() Запускает валидацию конкретного поля сущности ModuleValidate_EntityValidator

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
getMessage() Возвращает сообщение, используется для получения сообщения об ошибке валидатора ModuleValidate_EntityValidator
getValueOfCurrentEntity() Возвращает значение поля текущей сущности ModuleValidate_EntityValidator
isEmpty() Проверяет данные на пустое значение ModuleValidate_EntityValidator
setValueOfCurrentEntity() Устанавливает значение поля текущей сущности ModuleValidate_EntityValidator

Property Details

allowEmpty property
public bool $allowEmpty;

Допускать или нет пустое значение

is property
public int $is;

Конкретное значение длины строки

max property
public int $max;

Максимальня длина строки

min property
public int $min;

Минимальная длина строки

msgTooLong property
public string $msgTooLong;

Кастомное сообщение об ошибке при слишком длинной строке

msgTooShort property
public string $msgTooShort;

Кастомное сообщение об ошибке при короткой строке

Method Details

validate() method
public bool|string validate(mixed $sValue)
$sValue mixed Данные для валидации
{return} bool|string
Source Code: /engine/modules/validate/entity/ValidatorString.entity.class.php#77 (show)
public function validate($sValue) {
    if (
is_array($sValue)) {
        return 
$this->getMessage($this->Lang_Get('validate_string_too_short',null,false),'msgTooShort',array('min'=>$this->min));
    }
    if(
$this->allowEmpty && $this->isEmpty($sValue)) {
        return 
true;
    }

    
$iLength=mb_strlen($sValue'UTF-8');

    if(
$this->min!==null && $iLength<$this->min) {
        return 
$this->getMessage($this->Lang_Get('validate_string_too_short',null,false),'msgTooShort',array('min'=>$this->min));
    }
    if(
$this->max!==null && $iLength>$this->max) {
        return 
$this->getMessage($this->Lang_Get('validate_string_too_long',null,false),'msgTooLong',array('max'=>$this->max));
    }
    if(
$this->is!==null && $iLength!==$this->is) {
        return 
$this->getMessage($this->Lang_Get('validate_string_no_lenght',null,false),'msg',array('length'=>$this->is));
    }
    return 
true;
}

Запуск валидации