phpDocumentor
Back to top  

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

category phpDocumentor
package Parser\Exporter\Xml
author Mike van Riel
license MIT
link http://phpdoc.org

 Methods

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

__construct(phpDocumentor_Parser $parser) 
Inherited

inherited_from \phpDocumentor_Parser_Exporter_Abstract::__construct()

Parameters

$parser

\phpDocumentor_Parser

Dispatches a logging request to log a debug message.

debug(string $message) : void
Inherited

inherited_from \phpDocumentor_Parser_Abstract::debug()
inherited_from \phpDocumentor_Parser_Exporter_Abstract::debug()

Parameters

$message

string

The message to log.

Dispatches an event to the Event Dispatcher.

dispatch(string $name, \string[] $arguments) : mixed | null
Inherited

This method tries to dispatch an event; if no Event Dispatcher has been set than this method will explicitly not fail and return null. By not failing we make the Event Dispatcher optional and is it easier for people to re-use this component in their own application.

inherited_from \phpDocumentor_Parser_Abstract::dispatch()
inherited_from \phpDocumentor_Parser_Exporter_Abstract::dispatch()

Parameters

$name

string

Name of the event to dispatch.

$arguments

\string[]

Arguments for this event.

Exceptions

\phpDocumentor_Parser_Exception if there is a dispatcher but it is not of type sfEventDispatcher

Returns

mixednull

Renders the reflected file to a structure file.

export(phpDocumentor_Reflection_File $file) : void

Parameters

$file

\phpDocumentor_Reflection_File

File to export.

Finalizes this exporter; performs cleaning operations.

finalize() : void

Returns the XML contents of this export.

getContents() : string

Returns

string

Returns the DOMDocument for this exporter.

getDomDocument() : \DOMDocument

Returns

\DOMDocument

Initializes this exporter.

initialize() : void

Dispatches a logging request.

log(string $message, int $priority) : void
Inherited

inherited_from \phpDocumentor_Parser_Abstract::log()
inherited_from \phpDocumentor_Parser_Exporter_Abstract::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) 
Inherited

inherited_from \phpDocumentor_Parser_Exporter_Abstract::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, string $visibility) : void

Parameters

$dom

\DOMDocument

Markers are extracted and a summary inserted in this object.

$visibility

string

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 are searching for throughout xml

Returns

\DOMNodeList

 Properties

 

The event dispatcher object, may be null to not dispatch events.

$event_dispatcher : \sfEventDispatcher | null
Inherited

inherited_from \phpDocumentor_Parser_Abstract::$$event_dispatcher
inherited_from \phpDocumentor_Parser_Exporter_Abstract::$$event_dispatcher
 

<p>Whether to include the file's source in the export</p> 

$include_source : bool
Inherited

inherited_from \phpDocumentor_Parser_Exporter_Abstract::$$include_source
 

$parser

$parser : \phpDocumentor_Parser
Inherited

inherited_from \phpDocumentor_Parser_Exporter_Abstract::$$parser
 

<p>Document containing the collected data</p>

$xml : \DOMDocument