phpDocumentor
Back to top  

Class responsible for writing the results of the Reflection to a single Intermediate Structure file in XML.

 Methods

Construct the object with the location where to write the structure file(s).

__construct(\phpDocumentor\Parser\Parser $parser) 
Inherited
inherited_from \phpDocumentor\Parser\Exporter\ExporterAbstract::__construct()

Parameters

$parser

\phpDocumentor\Parser\Parser

Dispatches a logging request to log a debug message.

debug(string $message) : void
Inherited
inherited_from \phpDocumentor\Parser\ParserAbstract::debug()
inherited_from \phpDocumentor\Parser\Exporter\ExporterAbstract::debug()

Parameters

$message

string

The message to log.

Renders the reflected file to a structure file.

export(\phpDocumentor\Reflection\FileReflector $file) : void

Parameters

$file

\phpDocumentor\Reflection\FileReflector

File to export.

Finalizes the processing and executing all post-processing actions.

finalize() : void

This method is responsible for extracting and manipulating the data that is global to the project, such as:

  • Package tree
  • Namespace tree
  • Marker list
  • Deprecated elements listing
  • Removal of objects related to visibility

Returns the XML contents of this export.

getContents() : string

Returns

string

Returns the DOMDocument for this exporter.

getDomDocument() : \DOMDocument

Returns

\DOMDocument

Returns whether to include the source code in the resulting files.

getIncludeSource() : boolean
Inherited
inherited_from \phpDocumentor\Parser\Exporter\ExporterAbstract::getIncludeSource()

Returns

boolean

Initializes this exporter.

initialize() : void

Dispatches a logging request.

log(string $message, int $priority) : void
Inherited
inherited_from \phpDocumentor\Parser\ParserAbstract::log()
inherited_from \phpDocumentor\Parser\Exporter\ExporterAbstract::log()

Parameters

$message

string

The message to log.

$priority

int

The logging priority, the lower,the more important. Ranges from 1 to 7

Sets whether to include the source in the structure files.

setIncludeSource(boolean $include_source) : void
Inherited
inherited_from \phpDocumentor\Parser\Exporter\ExporterAbstract::setIncludeSource()

Parameters

$include_source

boolean

Adds a node to the xml for deprecations and the count value

buildDeprecationList(\DOMDocument $dom) : void

Parameters

$dom

\DOMDocument

Markers are extracted and a summary inserted in this object.

Retrieves a list of all marker types and adds them to the XML for easy referencing.

buildMarkerList(\DOMDocument $dom) : void

Parameters

$dom

\DOMDocument

Markers are extracted and a summary inserted in this object.

Collects all namespaces and sub-namespaces, and adds a new section in the DOM to provide an overview.

buildNamespaceTree(\DOMDocument $dom) : void

Parameters

$dom

\DOMDocument

Namespaces are extracted and a summary inserted in this object.

Collects all packages and subpackages, and adds a new section in the DOM to provide an overview.

buildPackageTree(\DOMDocument $dom) : void

Parameters

$dom

\DOMDocument

Packages are extracted and a summary inserted in this object.

Filter the function visibility based on options used

filterVisibility(\DOMDocument $dom, array $visibility) : void

Parameters

$dom

\DOMDocument

Markers are extracted and a summary inserted in this object.

$visibility

array

The visibility we want to filter on

Recursive method to create a hierarchical set of nodes in the dom.

generateNamespaceElements(array[] $namespaces, \DOMElement $parent_element, string $node_name) : void

Parameters

$namespaces

array[]

the list of namespaces to process.

$parent_element

\DOMElement

the node to receive the children of the above list.

$node_name

string

the name of the summary element.

Generates a hierarchical array of namespaces with their singular name from a single level list of namespaces with their full name.

generateNamespaceTree(array $namespaces) : array

Parameters

$namespaces

array

the list of namespaces as retrieved from the xml.

Returns

array

Build a tag based query string and return result

getNodeListForTagBasedQuery(\DOMDocument $dom, string $marker) : \DOMNodeList

Parameters

$dom

\DOMDocument

Markers are extracted and a summary inserted in this object.

$marker

string

The marker we're searching for throughout xml

Returns

\DOMNodeList

 Properties

 

$include_source : bool
Inherited
inherited_from \phpDocumentor\Parser\Exporter\ExporterAbstract::$$include_source
 

$parser : \phpDocumentor\Parser\Parser
Inherited
inherited_from \phpDocumentor\Parser\Exporter\ExporterAbstract::$$parser
 

Document containing the collected data

$xml : \DOMDocument