PHTTPConfig Class Reference

#include <httpform.h>

Inheritance diagram for PHTTPConfig:

PHTTPForm PConfigPage PRegisterPage List of all members.

Public Member Functions

 PHTTPConfig (const PURL &url, const PString &section)
 PHTTPConfig (const PURL &url, const PString &section, const PHTTPAuthority &auth)
 PHTTPConfig (const PURL &url, const PString &section, const PString &html)
 PHTTPConfig (const PURL &url, const PString &section, const PString &html, const PHTTPAuthority &auth)
virtual void OnLoadedText (PHTTPRequest &request, PString &text)
virtual BOOL Post (PHTTPRequest &request, const PStringToString &data, PHTML &replyMessage)
void LoadFromConfig ()
const PStringGetConfigSection () const
void SetConfigSection (const PString &sect)
PHTTPFieldAddSectionField (PHTTPField *sectionFld, const char *prefix=NULL, const char *suffix=NULL)
void AddNewKeyFields (PHTTPField *keyFld, PHTTPField *valFld)

Protected Attributes

PString section
PString sectionPrefix
PString sectionSuffix
PHTTPFieldsectionField
PHTTPFieldkeyField
PHTTPFieldvalField

Constructor & Destructor Documentation

PHTTPConfig::PHTTPConfig ( const PURL url,
const PString section 
)

PHTTPConfig::PHTTPConfig ( const PURL url,
const PString section,
const PHTTPAuthority &  auth 
)

PHTTPConfig::PHTTPConfig ( const PURL url,
const PString section,
const PString html 
)

PHTTPConfig::PHTTPConfig ( const PURL url,
const PString section,
const PString html,
const PHTTPAuthority &  auth 
)


Member Function Documentation

virtual void PHTTPConfig::OnLoadedText ( PHTTPRequest &  request,
PString text 
) [virtual]

Parameters:
request  Information on this request.
text  Data used in reply.

Reimplemented from PHTTPForm.

Reimplemented in PConfigPage, and PRegisterPage.

virtual BOOL PHTTPConfig::Post ( PHTTPRequest &  request,
const PStringToString data,
PHTML replyMessage 
) [virtual]

Parameters:
request  Information on this request.
data  Variables in the POST data.
replyMessage  Reply message for post.

Reimplemented from PHTTPForm.

Reimplemented in PConfigPage, and PRegisterPage.

void PHTTPConfig::LoadFromConfig (  ) 

Load all of the values for the resource from the configuration.

const PString& PHTTPConfig::GetConfigSection (  )  const [inline]

Get the configuration file section that the page will alter.

Returns:
String for config file section.

void PHTTPConfig::SetConfigSection ( const PString sect  )  [inline]

Parameters:
sect  New section for the config page.

PHTTPField* PHTTPConfig::AddSectionField ( PHTTPField sectionFld,
const char *  prefix = NULL,
const char *  suffix = NULL 
)

Add a field that will determine the name opf the secontion into which the other fields are to be added as keys. The section is not created and and error generated if the section already exists.

Parameters:
sectionFld  Field to set as the section name
prefix  String to attach before the field value
suffix  String to attach after the field value

void PHTTPConfig::AddNewKeyFields ( PHTTPField keyFld,
PHTTPField valFld 
)

Add fields to the HTTP form for adding a new key to the config file section.

Parameters:
keyFld  Field for the key to be added.
valFld  Field for the value of the key yto be added.


Member Data Documentation

PString PHTTPConfig::section [protected]

PString PHTTPConfig::sectionPrefix [protected]

PString PHTTPConfig::sectionSuffix [protected]

PHTTPField* PHTTPConfig::sectionField [protected]

PHTTPField* PHTTPConfig::keyField [protected]

PHTTPField* PHTTPConfig::valField [protected]


The documentation for this class was generated from the following file:
Generated on Fri Mar 7 06:25:05 2008 for PTLib by  doxygen 1.5.1