InputParser Class Reference

Inheritance diagram for InputParser:

Public Member Functions
	__construct ($name, $masterCache)
	cacheCheck ()
	generateContent ()
	getParam ($param)
	getInput ($master, $param, $options)
Public Member Functions inherited from Page
	addVariant ($value)
	getVariants ()
	__construct ($cache=null)
	mayCompress ()
	mayValidate ()
	startCompression ()
	generateContent ()
	cacheCheck ()
	genPage ()
	display ()

Static Public Member Functions
static	getFiles ($doc, $options)

Additional Inherited Members
Protected Member Functions inherited from Page
	setCache ($cache)
	getCache ()

Detailed Description

Functionality for translating an XML configuration document into a webpage

Constructor & Destructor Documentation

InputParser::__construct	(		$name,
			$masterCache
	)

Constructs a new InputParser object

Parameters

$name	name of file to read configuration from
$masterCache	CacheTimeCheck cache object to use as parent for this inputParsercache

Member Function Documentation

InputParser::generateContent

(

)

Generate an appropriate response for this page, eg. 302 NOT MODIFIED or the actual page

static InputParser::getFiles (   $doc,   $options  )

static

This is the last processing stage for generating a file.

Parameters

$doc	the document to be worked upon
$options	an Options object for this file.

Returns

This is the same as the input document, fully processed

InputParser::getInput	(		$master,
			$param,
			$options
	)

Follows all include directives recursively for the specified $param an generates an xml file.

This function may be used to generate a file which has all the necessary information to determine wether or not we may cache.

Parameters

$master	The master document to be processed
$param	the input tag to resolve
$options	the options object for this file

InputParser::getParam

(

$param

)

Extracts data from a <param> tag.

Parameters

$param

the param tag

Returns

if the type is array, return an array, otherwise return a scalar

---

The documentation for this class was generated from the following file:

• InputParser.inc