|
|
|
File: c:/www/apache/doc2//xmlexporter/PhpdocXMLDocumentExporter.php
PHPDOC 2000/12/03 - PHPDoc
PhpdocXMLDocumentExporter
PhpdocObject
|
+-- PhpdocXMLExporter
|
+-- PhpdocXMLDocumentExporter
Base of the class and module exporter.
|
private class PhpdocXMLDocumentExporter extends PhpdocXMLExporter
Base of the class and module exporter.
|
| |
|
Direct known subclasses: PhpdocXMLClassExporter, PhpdocXMLModuleExporter
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Private Method Details |
filenameXML |
|
private void filenameXML( string $file )
|
| |
Writes a <file> container.
|
| Parameter |
|
|
| Returns |
void |
|
constsXML |
|
private boolean constsXML( array $consts )
|
| |
Adds all constants (define(), const) to the xml document.
|
| Parameter |
|
| array |
$consts |
|
|
of constants |
|
| Returns |
boolean Returns false on failure otherwise true |
|
usesXML |
|
private void usesXML( array $uses )
|
| |
Adds a list of used files (include, require...) to the xml document.
|
| Parameter |
|
|
| Returns |
void |
|
functionsXML |
|
private void functionsXML( array $functions )
|
| |
Adds a list of functions to the xml file.
|
| Parameter |
|
|
| Returns |
void |
|
docXML |
|
private void docXML( array $data )
|
| |
Adds a documentation block (author, links, see, params...) to the xml document
|
| Parameter |
|
|
| Returns |
void |
|
globalsXML |
|
private void globalsXML( array $globals )
|
| |
Adds <global> container to the xml document.
|
| Parameter |
|
|
| Returns |
void |
|
throwsXML |
|
private void throwsXML( array $exceptions )
|
| |
Adds <throws> container to the xml document.
|
| Parameter |
|
|
| Returns |
void |
|
returnXML |
|
private void returnXML( array $return )
|
| |
Adds <return> container to the xml document.
|
| Parameter |
|
|
| Returns |
void |
|
paramsXML |
|
private void paramsXML( array $params )
|
| |
Adds <parameter> container to the xml document.
|
| Parameter |
|
|
| Returns |
void |
|
authorXML |
|
private void authorXML( array $authors )
|
| |
Adds <author> container to the xml document.
|
| Parameter |
|
|
| Returns |
void |
|
linkXML |
|
private void linkXML( array $links )
|
| |
Adds <link> container to the xml document.
|
| Parameter |
|
|
| Returns |
void |
|
seeXML |
|
private void seeXML( array $see )
|
| |
Adds <see> container to the xml document.
|
| Parameter |
|
|
| 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"
)<<
Mapping from internal result array index name to xml tag name.
|
|
$seeAttributes |
|
private array $seeAttributes
>>array(
"type" => "CDATA",
"group" => "CDATA"
)<<
Attributes of the <see> container.
|
|
$linkAttributes |
|
private array $linkAttributes
>>array( "url" => "CDATA" )<<
Attributes of the <link> container.
|
|
$authorAttributes |
|
private array $authorAttributes
>>array( "email" => "CDATA" )<<
Attributes of the <author> container.
|
|
$inheritedOverridenAttributes |
|
private array $inheritedOverridenAttributes
>>array(
"src" => "CDATA",
"type" => "CDATA"
)<<
Attributes of <inherited> and <overriden> container.
|
|
$constAttributes |
|
private array $constAttributes
>>array(
"name" => "CDATA",
"undoc" => "Boolean",
"access" => "CDATA",
"case" => "CDATA"
)<<
Attributes of the <constant> container.
|
|
$usesAttributes |
|
private array $usesAttributes
>>array(
"type" => "CDATA",
"file" => "CDATA",
"undoc" => "Boolean"
)<<
Attribues of the <uses> container.
|
|
$functionAttributes |
|
private array $functionAttributes
>>array(
"name" => "CDATA",
"undoc" => "Boolean",
"access" => "CDATA",
"abstract" => "Boolean",
"static" => "CDATA"
)<<
Attribues of the <function> container.
|
|
$returnAttributes |
|
private array $returnAttributes
>>array(
"name" => "CDATA",
"type" => "CDATA"
)<<
Attributes of the <return> container.
|
|
$globalAttributes |
|
private array $globalAttributes
>>array(
"name" => "CDATA",
"type" => "CDATA"
)<<
Attributes of the <global> container.
|
|
$paramAttributes |
|
private array $paramAttributes
>>array(
"name" => "CDATA",
"default" => "CDATA",
"type" => "CDATA",
"undoc" => "Boolean"
)<<
Attributes of the <param> container.
|
|
|
|
|
|
| PHPDoc 1.0beta |