Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: c:/www/apache/doc2//xmlexporter/PhpdocXMLClassExporter.php
PHPDOC 2000/12/03 - 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>
Version$Id: $

 

Methods inherited from PhpdocXMLDocumentExporter

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

Methods inherited from PhpdocXMLExporter

phpdocxmlexporter, setpath, export, setresult, getattributes

Methods inherited from PhpdocObject

setflagoutput, out, nametourl, outl, introspection

Public Method Summary

void

PhpdocXMLClassExporter()

Warning: documentation is missing.

Private Method Summary

void

inheritedOverridenXML(array $data, string $tag)

Handles inherited and overriden elements.
void

pathXML(array $path)

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

baseclassXML(string $base)

Adds a baseclass container to the generated xml.
void

subclassesXML(array $subclasses)

Adds a list of subclasses to the generated xml.
void

variablesXML(array $variables)

Adds class variables to the XMl document.
void

create()

Warning: documentation is missing.

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, $application, $warn, $flag_output

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( )

 

Warning: documentation is missing.

Returns void


Private Method Details

inheritedOverridenXML

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

  Handles inherited and overriden elements.

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


pathXML

private void pathXML( array $path )

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

Parameter
array $path
Returns void


baseclassXML

private void baseclassXML( string $base )

  Adds a baseclass container to the generated xml.

Parameter
string $base
of the baseclass
Returns void


subclassesXML

private void subclassesXML( array $subclasses )

  Adds a list of subclasses to the generated xml.

Parameter
array $subclasses
Returns void


variablesXML

private void variablesXML( array $variables )

  Adds class variables to the XMl document.

Parameter
array $variables
Returns void


create

private void create( )

 

Warning: documentation is missing.

Returns void


Private Field Details

$variableAttributes

private array $variableAttributes

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

Variable container attributes.


$classAttributes

private array $classAttributes

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

Class container attributes.


$fileprefix

private string $fileprefix

>>"class_"<<

Filename prefix for the generated xml document.
This class variable must be overriden by all derived classes.PHPDoc uses the filename prefix to detect the content ofthe file.



Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta