Class isp api::RightsCallback

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

Класс isp_api::RightsCallback

Класс для работы с правами доступа

#include <rights.h> 

Описание:

class isp_api::RightsCallback

Представляет набор методов для упрощения реализации обработчиков события userrights.user.

Родители:


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

RightsCallback ( int level , const string &action , const string &col_name , const string &col_id = "" , const string &xpath = "/doc/elem/" )

Конструктор


virtual void BeforeExecute ( Session & )

Выполняется перед вызовом заданной функции (действия)


virtual void GetLevels ( Session &ses )

Получить список уровней доступа


virtual string GetNameById ( Session &ses , const string &id )

Получить имя пользователя по идентификатору


virtual void GetList ( Session &ses )

Получить список пользователей

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

RightsCallback ( int level , const string &action , const string &col_name , const string &col_id = "" , const string &xpath = "/doc/elem/" )

Конструктор

В большинстве случаев вам достаточно просто создать экземпляр класса, чтобы получить весь необходимый функционал

Аргументы:
[level] уровень доступа, который описывает данный класс
[action] имя функции, которая возвращает список пользователя с указанным уровнем доступа
[col_name] имя столбца в выводе функции [action] содержащего имя пользователя
[col_id] имя столбца в выводе функции [action] содержащего идентификатор пользователя
[xpath] XPath выражение для получения списка пользователей, вы можете передать собственное выражение, если вам необходимо исключить некоторые записи из вывода функции [action]

Методы

virtual void BeforeExecute ( Session & )

Выполняется перед вызовом заданной функции (действия)

virtual void GetLevels ( Session &ses )

Получить список уровней доступа

По умолчанию возвращает один уровень доступа, переданный в конструкторе

virtual string GetNameById ( Session &ses , const string &id )

Получить имя пользователя по идентификатору

Аргументы:
[id] идентификатор пользователя
Returned: имя пользователя

virtual void GetList ( Session &ses )

Получить список пользователей

По умолчанию вызывает [action] и выбирает элементы используя [xpath] и [col_name]