Class isp api::BaseHistory

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

Класс isp_api::BaseHistory

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

Базовый абстракный класс для отображения истории изменений

#include <dbhistory.h> 

Описание:

class isp_api::BaseHistory

Содержит набор методов для упрощения отображения истории изменений сформированных средствами mgr_db

Warning: Если история формируется для списка реализованного наследником класса TableIdListAction Используйте класс HistoryAction
See also: mgr_db::TableDesc::FieldDesc::save_history

Родители:


Потомки:


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

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

virtual mgr_db::QueryPtr GetHistory ( Session &ses )

получить историю изменений


virtual bool FieldAccessible ( Session &ses , const string &name )

проверить доступ пользователя к значению поля таблицы


virtual void List ( Session &ses )

Формирует список на основании данных полученных методом GetHistory


virtual string DefReader ( Session &ses , const string &name , mgr_db::QueryPtr query )

Метод, используемый по умолчанию для перевода записи в таблице истории в удобочитаемый вид


virtual string GetHumanDesc ( Session &ses , const string &field , mgr_db::QueryPtr query )

Перевести запись из таблицы истории в удобочитаемый вид. Вызывается для каждого измененного поля отдельно


virtual string GetHumanAction ( const string &lang , const string &short_name )

Получить локализованное имя функции (берется сообщение title из одноименной секции messages)


void AddReader ( const string &name , Reader reader )

Добавить метод для перевода записи в таблице истории в удобочитаемый вид для указанного имени


void AddConverter ( const string &name , Converter converter )

Добавить метод для перевода значения в удобочитаемую форму

Методы

virtual mgr_db::QueryPtr GetHistory ( Session &ses )

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

получить историю изменений

Метод должен проверить доступ пользователя к соответствующему элементу и вернуть список изменений. Реализация этого метода вынесена в шаблон HistoryAction

virtual bool FieldAccessible ( Session &ses , const string &name )

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

проверить доступ пользователя к значению поля таблицы

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

Returned: true - если поле доступно (по умолчанию доступны все поля)

virtual void List ( Session &ses )

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

Формирует список на основании данных полученных методом GetHistory

virtual string DefReader ( Session &ses , const string &name , mgr_db::QueryPtr query )

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

Метод, используемый по умолчанию для перевода записи в таблице истории в удобочитаемый вид

Вызывается из метода GetHumanDesc для каждого измененного поля. Из секции history берется сообщение с именем 'desc_' + имя поля или, если первое не найдено, сообщение desc__default. В него вместо old подставляется старое значение поля, вместо new - новое, вместо name - сообщение, имя которого совпадает с именем поля

Warning: Сообщения берутся из соответствующей имени функции секции messages. Если такой секции нет используются сообщения секции history. Это же касается и метаданных.
See also: AddReader

virtual string GetHumanDesc ( Session &ses , const string &field , mgr_db::QueryPtr query )

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

Перевести запись из таблицы истории в удобочитаемый вид. Вызывается для каждого измененного поля отдельно

virtual string GetHumanAction ( const string &lang , const string &short_name )

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

Получить локализованное имя функции (берется сообщение title из одноименной секции messages)

void AddReader ( const string &name , Reader reader )

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

Добавить метод для перевода записи в таблице истории в удобочитаемый вид для указанного имени

void AddConverter ( const string &name , Converter converter )

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

Добавить метод для перевода значения в удобочитаемую форму