Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: /home/cch/www/pear/PHPDoc/xmlexporter/PhpdocXMLDocumentExporter.php
PEAR Repository - PHPDoc

PhpdocXMLDocumentExporter

PhpdocObject
   |
  +-- PhpdocXMLExporter
     |
    +-- PhpdocXMLDocumentExporter

Base of the class and module exporter.

 

private class PhpdocXMLDocumentExporter extends PhpdocXMLExporter

Base of the class and module exporter.

AuthorsUlf Wendel <ulf.wendel@phpdoc.de>
Version1.0

 
Direct known subclasses: PhpdocXMLClassExporter, PhpdocXMLModuleExporter

Methods inherited from PhpdocXMLExporter

phpdocxmlexporter, setpath, export, getattributes, setresult

Methods inherited from PhpdocObject

setflagoutput, out, nametourl, outl, introspection

Private Method Summary

void

filenameXML(string $file)

Writes a <file> container.
boolean

constsXML(array $consts)

Adds all constants (define(), @const) to the xml document.
void

usesXML( $uses)

void

functionsXML( $functions)

void

docXML( $data)

void

globalsXML( $globals)

void

throwsXML( $exceptions)

void

returnXML( $return)

void

paramsXML( $params)

void

authorXML( $authors)

void

linkXML( $links)

void

seeXML( $see)

Fields inherited from PhpdocXMLExporter

$fileprefix, $path, $result, $xmlwriter

Fields inherited from PhpdocObject

$err, $flag_output, $application, $warn

Private Field Summary

array

$docTags

Mapping from internal result array index name to xml tag name.
array

$seeAttributes

Attributes of the <see> container.
array

$linkAttributes

Attributes of the <link> container.
array

$authorAttributes

Attributes of the <author> container.
array

$inheritedOverridenAttributes

Attributes of <inherited> and <overriden> container.
array

$constAttributes

Attributes of the <constant> container.
array

$usesAttributes

Attribues of the <uses> container.
array

$functionAttributes

Attribues of the <function> container.
array

$returnAttributes

Attributes of the <return> container.
array

$globalAttributes

Attributes of the <global> container.
array

$paramAttributes

Attributes of the <param> container.

Private Method Details

filenameXML

private void filenameXML( string $file )

  Writes a <file> container.

Parameter
string $file
filename
Returns void


constsXML

private boolean constsXML( array $consts )

  Adds all constants (define(),

Parameter
array $consts
Array of constants
Returns boolean

Returns false on failure otherwise true


usesXML

private void usesXML( $uses )

 

Parameter
$uses
Returns void


functionsXML

private void functionsXML( $functions )

 

Parameter
$functions
Returns void


docXML

private void docXML( $data )

 

Parameter
$data
Returns void


globalsXML

private void globalsXML( $globals )

 

Parameter
$globals
Returns void


throwsXML

private void throwsXML( $exceptions )

 

Parameter
$exceptions
Returns void


returnXML

private void returnXML( $return )

 

Parameter
$return
Returns void


paramsXML

private void paramsXML( $params )

 

Parameter
$params
Returns void


authorXML

private void authorXML( $authors )

 

Parameter
$authors
Returns void


linkXML

private void linkXML( $links )

 

Parameter
$links
Returns void


seeXML

private void seeXML( $see )

 

Parameter
$see
Returns void


Private Field Details

$docTags

private array $docTags

>>array( "desc" => "description", "sdesc" => "shortdescription", "version" => "version", "since" => "since", "version" => "version", "deprec" => "deprecated", "copyright" => "copyright", "exclude" => "exclude", "brother" => "brother", "magic" => "magic" )<<


$seeAttributes

private array $seeAttributes

>>array( "type" => "CDATA", "group" => "CDATA" )<<


$linkAttributes

private array $linkAttributes

>>array( "url" => "CDATA" )<<


$authorAttributes

private array $authorAttributes

>>array( "email" => "CDATA" )<<


$inheritedOverridenAttributes

private array $inheritedOverridenAttributes

>>array( "src" => "CDATA", "type" => "CDATA" )<<


$constAttributes

private array $constAttributes

>>array( "name" => "CDATA", "undoc" => "Boolean", "access" => "CDATA", "case" => "CDATA" )<<


$usesAttributes

private array $usesAttributes

>>array( "type" => "CDATA", "file" => "CDATA", "undoc" => "Boolean" )<<


$functionAttributes

private array $functionAttributes

>>array( "name" => "CDATA", "undoc" => "Boolean", "access" => "CDATA", "abstract" => "Boolean", "static" => "CDATA" )<<


$returnAttributes

private array $returnAttributes

>>array( "name" => "CDATA", "type" => "CDATA" )<<


$globalAttributes

private array $globalAttributes

>>array( "name" => "CDATA", "type" => "CDATA" )<<


$paramAttributes

private array $paramAttributes

>>array( "name" => "CDATA", "default" => "CDATA", "type" => "CDATA", "undoc" => "Boolean" )<<



Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta