$tagConverter
$tagConverter : \phpDocumentor\Plugin\Core\Transformer\Writer\Xml\TagConverter
Converter used to create an XML Element representing a DocBlock and its tags.
In order to convert the tags to their XML representation this class requires the respective converter.
$tagConverter : \phpDocumentor\Plugin\Core\Transformer\Writer\Xml\TagConverter
$router : \phpDocumentor\Transformer\Router\RouterAbstract
__construct(\phpDocumentor\Plugin\Core\Transformer\Writer\Xml\TagConverter $tagConverter, \phpDocumentor\Transformer\Router\RouterAbstract $router)
Stores the converter for tags on this converter.
| \phpDocumentor\Plugin\Core\Transformer\Writer\Xml\TagConverter | $tagConverter | |
| \phpDocumentor\Transformer\Router\RouterAbstract | $router |
convert(\DOMElement $parent, \phpDocumentor\Descriptor\DescriptorAbstract $element) : \DOMElement
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\DescriptorAbstract | $element | The data source. |
addSummary(\DOMElement $node, \phpDocumentor\Descriptor\DescriptorAbstract $element) : void
Adds the short description of $docblock to the given node as description field.
| \DOMElement | $node | |
| \phpDocumentor\Descriptor\DescriptorAbstract | $element |
addDescription(\DOMElement $node, \phpDocumentor\Descriptor\DescriptorAbstract $element) : void
Adds the DocBlock's long description to the $child element,
| \DOMElement | $node | |
| \phpDocumentor\Descriptor\DescriptorAbstract | $element |
addTags(\DOMElement $docBlock, \phpDocumentor\Descriptor\DescriptorAbstract $descriptor) : void
Adds each tag to the XML Node representing the DocBlock.
The Descriptor contains an array of tag groups (that are tags grouped by their name), which in itself contains an array of the individual tags.
| \DOMElement | $docBlock | |
| \phpDocumentor\Descriptor\DescriptorAbstract | $descriptor |
addInheritedFromTag(\DOMElement $docBlock, \phpDocumentor\Descriptor\DescriptorAbstract $descriptor) : void
Adds the 'inherited_from' tag when a Descriptor inherits from another Descriptor.
| \DOMElement | $docBlock | |
| \phpDocumentor\Descriptor\DescriptorAbstract | $descriptor |