Class isp api::ModuleAction

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

Класс isp_api::ModuleAction

Данный класс является абстрактным

Класс для работы с модулем

#include <action.h> 

Описание:

class isp_api::ModuleAction

Базовый класс для реализации action'ов. Производит загрузку из xml метаданных, сообщений action'а. Также производит проверку уровня доступа пользователя к элементам метаданных.

class ActionDashboard : public Action { 
public: 
    ActionDashboard() : Action("dashboard", MinLevel(lvRegistered)), save(this) {} 
private: 
    class ActionDashboardSave : public ModuleAction { 
    public: 
        ActionDashboardSave(ActionDashboard *parent) 
            : ModuleAction("save", MinLevel(lvRegistered), parent) { } 
 
        virtual void ModuleExecute(Session &ses) const {...} 
    } save; 
}; 
 
MODULE_INIT(dashboard, "") { 
    new ActionDashboard(); 
} 

Родители:


Потомки:


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

ModuleAction ( const string &name , AccessMask accessMask , const Action * parent = nullptr )

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

Защищённые члены (кратко)

virtual void Execute ( Session &ses )

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


virtual void ModuleExecute ( Session &ses )

Вызывается при выполнении модуля


virtual bool Authorize ( const Authen & )

Проверка авторизации

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

ModuleAction ( const string &name , AccessMask accessMask , const Action * parent = nullptr )

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

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

Методы

virtual void Execute ( Session &ses )

Данный метод является защищённым

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

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

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

virtual void ModuleExecute ( Session &ses )

Данный метод является защищённым

Вызывается при выполнении модуля

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

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

virtual bool Authorize ( const Authen & )

Данный метод является защищённым

Проверка авторизации

Стандартная реализация выполняет проверку уровня пользователя и вызывает метод CheckAccess()

Returned: Возвращает true в случае успеха, иначе возвращает false