Packageindex Classtrees Modulegroups Elementlist Report XML Files

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

PhpdocXMLClassExporter

PhpdocObject
   |
  +-- PhpdocXMLExporter
     |
    +-- PhpdocXMLDocumentExporter
       |
      +-- PhpdocXMLClassExporter

Exports the data of a class as an xml file.

 

private class PhpdocXMLClassExporter extends PhpdocXMLDocumentExporter

Exports the data of a class as an xml file.

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

 

Methods inherited from PhpdocXMLDocumentExporter

filenamexml, constsxml, usesxml, functionsxml, docxml, globalsxml, throwsxml, returnxml, paramsxml, authorxml, linkxml, seexml

Methods inherited from PhpdocXMLExporter

phpdocxmlexporter, setpath, export, getattributes, setresult

Methods inherited from PhpdocObject

setflagoutput, out, nametourl, outl, introspection

Public Method Summary

void

PhpdocXMLClassExporter()

Private Method Summary

void

inheritedOverridenXML(array $data, string $tag)

Handles inherited and overriden elements.
void

pathXML( $path)

Writes the "path" (inheritance chain) of an element.
void

baseclassXML(string $base)

Adds a baseclass container to the generated xml.
void

subclassesXML( $subclasses)

Adds a list of subclasses to the generated xml.
void

variablesXML( $variables)

Writes class variables to
void

create()

Fields inherited from PhpdocXMLDocumentExporter

$doctags, $seeattributes, $linkattributes, $authorattributes, $inheritedoverridenattributes, $constattributes, $usesattributes, $functionattributes, $returnattributes, $globalattributes, $paramattributes

Fields inherited from PhpdocXMLExporter

$path, $result, $xmlwriter

Fields inherited from PhpdocObject

$err, $flag_output, $application, $warn

Private Field Summary

array

$variableAttributes

Variable container attributes.
array

$classAttributes

Class container attributes.
string

$fileprefix

Filename prefix for the generated xml document.

Public Method Details

PhpdocXMLClassExporter

public void PhpdocXMLClassExporter( )

 

Returns void


Private Method Details

inheritedOverridenXML

private void inheritedOverridenXML( array $data, string $tag )

  Handles inherited and overriden elements.

Parameter
array $data
Array of inherited or overriden elements
string $tag
Container used when saving the elements
Returns void


pathXML

private void pathXML( $path )

  Writes the "path" (inheritance chain) of an element.

Parameter
$path
Returns void


baseclassXML

private void baseclassXML( string $base )

  Adds a baseclass container to the generated xml.

Parameter
string $base
Name of the baseclass
Returns void


subclassesXML

private void subclassesXML( $subclasses )

  Adds a list of subclasses to the generated xml.

Parameter
$subclasses
Returns void


variablesXML

private void variablesXML( $variables )

  Writes class variables to

Parameter
$variables
Returns void


create

private void create( )

 

Returns void


Private Field Details

$variableAttributes

private array $variableAttributes

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


$classAttributes

private array $classAttributes

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


$fileprefix

private string $fileprefix

>>"class_"<<



Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta