Pelzini

This is the code documentation for the Pelzini project

Page options:

Inherited members

class XmlOutputter

Outputs the tree to an xml file

Authors

Variables

NameVisibilityDescription
$dom 
$filename 
$root 

Functions

NameVisibilityDescription
__constructpublicSets the full filename to output to
check_layoutpublicDoes nothing; there is no layout to check
create_description_nodeprivateCreates a description node, and appends it to the specified node
get_extpublicReturns the file extension of the outputted file (e.g. 'xml')
get_mimetypepublicReturns the mimetype of the outputted file (e.g. 'text/xml')
outputpublicDoes the actual outputting of the file objects (and their sub-objects)
process_argumentprivateProcesses a function argument
process_classprivateProcesses a class
process_documentprivateProcesses a document
process_fileprivateProcesses a file
process_functionprivateProcesses a function
process_returnprivateProcesses a function argument
set_filenamepublicSets the full filename to output to

public __construct (from MetadataOutputter)

void $MetadataOutputter->__construct ( mixed $filename );

Sets the full filename to output to

public check_layout (from MetadataOutputter)

void $MetadataOutputter->check_layout ( );

Does nothing; there is no layout to check

private create_description_node

void $XmlOutputter->create_description_node ( mixed $node , mixed $description );

Creates a description node, and appends it to the specified node

public get_ext

unknown $XmlOutputter->get_ext ( );

Returns the file extension of the outputted file (e.g. 'xml')

public get_mimetype

unknown $XmlOutputter->get_mimetype ( );

Returns the mimetype of the outputted file (e.g. 'text/xml')

public output

boolean $XmlOutputter->output ( array $parser_items , Config $config );

Does the actual outputting of the file objects (and their sub-objects)

private process_argument

void $XmlOutputter->process_argument ( mixed $parent_node , mixed $item );

Processes a function argument

private process_class

void $XmlOutputter->process_class ( mixed $parent_node , mixed $item );

Processes a class

private process_document

void $XmlOutputter->process_document ( mixed $item );

Processes a document

private process_file

void $XmlOutputter->process_file ( mixed $item );

Processes a file

private process_function

void $XmlOutputter->process_function ( mixed $parent_node , mixed $item );

Processes a function

private process_return

void $XmlOutputter->process_return ( mixed $parent_node , mixed $item );

Processes a function argument

public set_filename (from MetadataOutputter)

void $MetadataOutputter->set_filename ( mixed $filename );

Sets the full filename to output to