Class isp api::CheckValue

Материал из ISPWiki
Перейти к: навигация, поиск

Класс isp_api::CheckValue

Класс для валидации значений

#include <action.h> 

Описание:

class isp_api::CheckValue

class CheckUsername : public CheckValue { 
public: 
    CheckUsername() : CheckValue("username") {} 
    bool Check(string &value, const string &) const { 
        value = str::Trim(value); 
 
        return test::EmptyOr<test::UnixUserName>(value); 
    } 
}; 
 
MODULE_INIT(check, "") { 
    new CheckNumeric(); 
    new CheckUsername(); 
} 

Родители:


Классы

class isp_api::CheckValue::Result

Открытые члены (кратко)

CheckValue ( const string &name , bool trim = true , AccessMask accessMask = AccessAll )

Конструктор класса


virtual void Execute ( Session &ses )

Метод, вызываемый при выполнении действия

virtual bool Check ( string &value , const string &args )

Вызывается при валидации значения

Приватные члены (кратко)

virtual bool IsModify ( const Session &ses )

Изменит ли эта функция какие-нибудь данные


virtual string type () const

Возвращает тип реализуемой функции

Конструкторы

CheckValue ( const string &name , bool trim = true , AccessMask accessMask = AccessAll )

Конструктор класса

Аргументы:
[in] - name Имя валидатора
[in] - trim Обрезать пробелы вначале и в конце строки. Если получится пустое значение, оно считается валидным
[in] - accessMask Уровень доступа
See also: mgr_access::AccessMask

Методы

virtual bool Check ( string &value , const string &args )

Вызывается при валидации значения

Аргументы:
[in] - value Значение для валидации
[in] - args Дополнительные аргументы
[in] - eargs Параметры ошибки, если значение не прошло проверку
Returned: Должен возвращать true в случае успешной валидации, в противном случае - false Второй вариант возвращает пару, где первый bool сигнализирует об успешности проверки, а второй - содержит имя сообщения, которое необходимо показать, если проверка провалилась

virtual void Execute ( Session &ses )

Метод, вызываемый при выполнении действия

Метод должен быть реализован в классе-потомке

Аргументы:
[in/out] ses Текущая сессия
See also: isp_api::Session

virtual bool IsModify ( const Session &ses )

Данный метод является приватным

Изменит ли эта функция какие-нибудь данные

По умолчанию считается, что изменит. Если функция возвращает false при ее вызове игнорируется REFERER запроса

virtual string type () const

Данный метод является приватным

Возвращает тип реализуемой функции

Может переопределяться в дочерних классах для сообщения типа реализуемой функции, например: "list", "form"

Returned: Должен возвращать тип функции в строковом виде (например: "list", "form")