Docs For Class XMLDataListDocument

## Class XMLDataListDocument

Description

This class is for generating a complete XML document based off of a DataListSource child class.

- author: Walter A. Boring IV <waboring@newsblob.com>

Located in /widgets/xml/XMLDataListDocument.inc (line 21)

Variable Summary
mixed $data_source
mixed $orderby
mixed $root_name
mixed $row_name
mixed $xml
Method Summary
XMLDataListDocument XMLDataListDocument (string $root_name, string $row_name, [string $sort_column = NULL])
none build_rows ()
none build_xml_document ()
void data_prefetch ()
none get_data_source ()
void render ()
void set_data_source (DataListSource &$datasource)
Variables
mixed $data_source = NULL (line 51)

The datalist source we will use

mixed $orderby = NULL (line 45)

The column we want to orderby in

the DataListSource

mixed $root_name = 'list' (line 26)

The root xml node name

mixed $row_name = 'row' (line 39)

The name we want for the xml tag for each row we fetch from the DB.

mixed $xml = NULL (line 32)

The xml document class

Methods
Constructor XMLDataListDocument (line 62)

The constructor

XMLDataListDocument XMLDataListDocument (string $root_name, string $row_name, [string $sort_column = NULL])

- string $root_name: the root xml tag's name
- string $row_name: the name of the xml tag for each row pulled from the DataListSource
- string $sort_column: the column to sort by in the DataListSource

build_rows (line 136)

This method is used to pull each row from the DataListSource and then create the xml tags based upon the columns returned and their values

none build_rows ()
build_xml_document (line 112)

This method builds the XMLDocumentClass that is used to render the output.

none build_xml_document ()
data_prefetch (line 123)

This method calls the DataListSource's query to execute the

query, just as the DataList class does

void data_prefetch ()
get_data_source (line 92)

You can override this to call set_data_source() that this class will use. This method gets called from within render().

none get_data_source ()
render (line 73)
void render ()
set_data_source (line 101)

This function is used to set the DataListSource object for this instance

void set_data_source (DataListSource &$datasource)

- DataListSource &$datasource: object

Documentation generated on Thu, 1 Sep 2005 17:06:40 -0700 by phpDocumentor 1.3.0RC3