Class isp api::BaseConnection

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

Класс isp_api::BaseConnection

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

Базовый класс описывающий соединение

#include <connection.h> 

Описание:

class isp_api::BaseConnection

Содержит набор методов для доступа к параметрам соединения. В большинстве случаев доступен только для чтения. Это сделно потому, что запрос в любой момент может быть выполнен повторно и предыдущая попытка выполнения не должна никак влиять на последующие

Потомки:


Содержание

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

BaseConnection ()

Конструктор


virtual  ~BaseConnection ()

Деструктор


void Init ()

Инициализация соединения


virtual string env ( const string &name )

Получить значение переменной окружения


virtual string postdata () const

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


virtual string param ( const string &name )

Получить значение параметра


virtual bool has_param ( const string &name )

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


virtual string file ( const string &name )

Получить содержимое файла переданного POST запросом


virtual string authId () const

Получить Id сессии


virtual string theme () const

Получить имя темы оформления


virtual string lang () const

Получить язык


virtual const OutputFormat & format () const

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


virtual bool hasCookie () const

Были ли переданы COOKIE.


virtual bool isAdmin () const

Был ли запрос получен из доверенного источника (доступного только администратору сервера)


virtual bool isInternal () const

Был ли это внутренний запрос


virtual void GetEnv ( StringVector &res )

Получить список имен переменных окружения


virtual void GetParams ( StringVector &res )
virtual string GetQueryString ( const string &func = "" )

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


virtual double GetLangWeight ( const string &lang )

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


string param ( const string &name , const string &def )

Получить значение параметра или значение по умолчанию, если параметр не передан


void set_env ( const string &name , const string &value )

Установить значение переменной окружения


void set_postdata ( const string & )

Задать данные POST запроса


void set_param ( const string &name , const string &value )
void set_in_param ( const string &name , const string &value )

Установить параметр соединения игнорируя параметры имеющие префикс INTERNAL_PREFIX


void del_param ( const string &name )

Удалить параметр запроса


void set_file ( const string &name , const string &data )

Задать содержимое файла переданного POST запросом


void set_authId ( const string & )

Задать Id сессии


void set_theme ( const string & )

Задать имя темы оформления


void set_lang ( const string & , bool manual = false )

задать язык, при manual = true, языку присваивается высший приоритет


void set_format ( const OutputFormat & )

задать формат вывода результата


void set_hasCookie ( bool )

Задать признак наличия COOKIE в запросе


int inc_restart_count ()

Увеличить счетчик попыток выполнения, возвращает количетво оставшихся попыток

void ParseQueryString ( const string & )

Разбор параметров переданных стандартными для HTTP методами

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

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

BaseConnection ()

Конструктор

virtual ~BaseConnection ()

Деструктор

Методы

void ParseQueryString ( const string & )

Разбор параметров переданных стандартными для HTTP методами

ParseQueryString разбирает строку в формате QUERY_STRING, ParseMultipart разбирает параметры переданные POST запросом с CONTENT_TYPE равным multipart/form-data. В противном случае формат POST запроса ничем не отличается от QUERY_STRING. Значения с одинаковыми именами в рамках одного вызова складываются в одну строку через запятую, при последовательных вызовах функций значения более поздних вызовов будут замещать собой значения от предыдущих

void Init ()

Инициализация соединения

Вызывается перед каждой попыткой выполнить запрос. Увеличивает значение счетчика попыток и вызывает RealInit

virtual string env ( const string &name )

Получить значение переменной окружения

virtual string postdata () const

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

virtual string param ( const string &name )

Получить значение параметра

virtual bool has_param ( const string &name )

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

virtual string file ( const string &name )

Получить содержимое файла переданного POST запросом

virtual string authId () const

Получить Id сессии

virtual string theme () const

Получить имя темы оформления

virtual string lang () const

Получить язык

virtual const OutputFormat &format () const

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

virtual bool hasCookie () const

Были ли переданы COOKIE.

virtual bool isAdmin () const

Был ли запрос получен из доверенного источника (доступного только администратору сервера)

virtual bool isInternal () const

Был ли это внутренний запрос

virtual void GetEnv ( StringVector &res )

Получить список имен переменных окружения

virtual void GetParams ( StringVector &res )

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

virtual string GetQueryString ( const string &func = "" )

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

virtual double GetLangWeight ( const string &lang )

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

string param ( const string &name , const string &def )

Данная функция/метод является inline функцией

Получить значение параметра или значение по умолчанию, если параметр не передан

void set_env ( const string &name , const string &value )

Установить значение переменной окружения

void set_postdata ( const string & )

Задать данные POST запроса

void set_param ( const string &name , const string &value )

Установить значение параметра запроса

void set_in_param ( const string &name , const string &value )

Установить параметр соединения игнорируя параметры имеющие префикс INTERNAL_PREFIX

void del_param ( const string &name )

Удалить параметр запроса

void set_file ( const string &name , const string &data )

Задать содержимое файла переданного POST запросом

void set_authId ( const string & )

Задать Id сессии

void set_theme ( const string & )

Задать имя темы оформления

void set_lang ( const string & , bool manual = false )

задать язык, при manual = true, языку присваивается высший приоритет

void set_format ( const OutputFormat & )

задать формат вывода результата

void set_hasCookie ( bool )

Задать признак наличия COOKIE в запросе

int inc_restart_count ()

Увеличить счетчик попыток выполнения, возвращает количетво оставшихся попыток