PHTTPConfig Class Reference

#include <httpform.h>

Inheritance diagram for PHTTPConfig:


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 PBoolean	Post (PHTTPRequest &request, const PStringToString &data, PHTML &replyMessage)
void	LoadFromConfig ()
const PString &	GetConfigSection () const
void	SetConfigSection (const PString &sect)
PHTTPField *	AddSectionField (PHTTPField sectionFld, const char prefix=NULL, const char *suffix=NULL)
void	AddNewKeyFields (PHTTPField keyFld, PHTTPField valFld)
Protected Attributes
PString	section
PString	sectionPrefix
PString	sectionSuffix
PHTTPField *	sectionField
PHTTPField *	keyField
PHTTPField *	valField

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]`

This is called after the text has been loaded and may be used to customise or otherwise mangle a loaded piece of text. Typically this is used with HTML responses.

The default action for this function is to do nothing.

Parameters:

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

Reimplemented from PHTTPForm.

Reimplemented in PConfigPage, and PRegisterPage.

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

Get a block of data (eg HTML) that the resource contains.

The default action for this function is to do nothing and return success.

Returns:: PTrue if the connection may persist, PFalse if the connection must close

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: