$xml
$xml : \DOMDocument
Converts the structural information of phpDocumentor into an XML file.
$translator : \phpDocumentor\Translator\Translator
checkRequirements() : void
This method verifies whether PHP has all requirements needed to run this writer.
If one of the requirements is missing for this Writer then an exception of type RequirementMissing should be thrown; this indicates to the calling process that this writer will not function.
when a requirements is missing stating which one.
transform(\phpDocumentor\Descriptor\ProjectDescriptor $project, \phpDocumentor\Transformer\Transformation $transformation) : void
This method generates the AST output
| \phpDocumentor\Descriptor\ProjectDescriptor | $project | Document containing the structure. |
| \phpDocumentor\Transformer\Transformation | $transformation | Transformation to execute. |
__construct(\phpDocumentor\Transformer\Router\RouterAbstract $router)
| \phpDocumentor\Transformer\Router\RouterAbstract | $router |
getTranslator() : \phpDocumentor\Translator\Translator
Returns an instance of the object responsible for translating content.
setTranslator(\phpDocumentor\Translator\Translator $translator) : void
Sets a new object capable of translating strings on this writer.
| \phpDocumentor\Translator\Translator | $translator |
buildFunction(\DOMElement $parent, \phpDocumentor\Descriptor\FunctionDescriptor $function, \DOMElement $child = null) : void
Export this function definition to the given parent DOMElement.
| \DOMElement | $parent | Element to augment. |
| \phpDocumentor\Descriptor\FunctionDescriptor | $function | Element to export. |
| \DOMElement | $child | if supplied this element will be augmented instead of freshly added. |
buildClass(\DOMElement $parent, \phpDocumentor\Descriptor\ClassDescriptor $class, \DOMElement $child = null) : void
Exports the given reflection object to the parent XML element.
This method creates a new child element on the given parent XML element and takes the properties of the Reflection argument and sets the elements and attributes on the child.
If a child DOMElement is provided then the properties and attributes are set on this but the child element is not appended onto the parent. This is the responsibility of the invoker. Essentially this means that the $parent argument is ignored in this case.
| \DOMElement | $parent | The parent element to augment. |
| \phpDocumentor\Descriptor\ClassDescriptor | $class | The data source. |
| \DOMElement | $child | Optional: child element to use instead of creating a new one on the $parent. |
buildPartials(\DOMElement $parent, \phpDocumentor\Descriptor\ProjectDescriptor $project)
| \DOMElement | $parent | |
| \phpDocumentor\Descriptor\ProjectDescriptor | $project |
buildFile(\DOMElement $parent, \phpDocumentor\Descriptor\FileDescriptor $file, \phpDocumentor\Transformer\Transformer $transformer)
| \DOMElement | $parent | |
| \phpDocumentor\Descriptor\FileDescriptor | $file | |
| \phpDocumentor\Transformer\Transformer | $transformer |
createErrorEntry(\phpDocumentor\Descriptor\Validator\Error $error, \DOMElement $parse_errors) : void
Creates an entry in the ParseErrors collection of a file for a given error.
| \phpDocumentor\Descriptor\Validator\Error | $error | |
| \DOMElement | $parse_errors |
getDestinationPath(\phpDocumentor\Transformer\Transformation $transformation) : string
Retrieves the destination location for this artifact.
| \phpDocumentor\Transformer\Transformation | $transformation |
finalize(\phpDocumentor\Descriptor\ProjectDescriptor $projectDescriptor) : void
Finalizes the processing and executing all post-processing actions.
This method is responsible for extracting and manipulating the data that is global to the project, such as:
| \phpDocumentor\Descriptor\ProjectDescriptor | $projectDescriptor |
getNodeListForTagBasedQuery(\DOMDocument $dom, string $marker) : \DOMNodeList
Build a tag based query string and return result
| \DOMDocument | $dom | Markers are extracted and a summary inserted in this object. |
| string | $marker | The marker we're searching for throughout xml |
generateNamespaceElements(array<mixed,array> $namespaces, \DOMElement $parent_element, string $node_name = 'namespace') : void
Recursive method to create a hierarchical set of nodes in the dom.
| array<mixed,array> | $namespaces | the list of namespaces to process. |
| \DOMElement | $parent_element | the node to receive the children of the above list. |
| string | $node_name | the name of the summary element. |