\phpDocumentor\Plugin\Core\Transformer\Writer\XmlInterfaceConverter

Converter used to create an XML Element representing the interface and its Constants, Methods and DocBlock.

In order to convert the DocBlock to its XML representation this class requires the respective converter.

Summary

Methods
Properties
Constants
__construct()
convert()
No public properties found
No constants found
No protected methods found
$docBlockConverter
$methodConverter
$constantConverter
N/A
No private methods found
No private properties found
N/A

Properties

Methods

__construct()

__construct(\phpDocumentor\Plugin\Core\Transformer\Writer\Xml\DocBlockConverter  $docBlockConverter, \phpDocumentor\Plugin\Core\Transformer\Writer\Xml\MethodConverter  $methodConverter, \phpDocumentor\Plugin\Core\Transformer\Writer\Xml\ConstantConverter  $constantConverter) 

Initializes this converter with the DocBlock converter.

Parameters

\phpDocumentor\Plugin\Core\Transformer\Writer\Xml\DocBlockConverter $docBlockConverter
\phpDocumentor\Plugin\Core\Transformer\Writer\Xml\MethodConverter $methodConverter
\phpDocumentor\Plugin\Core\Transformer\Writer\Xml\ConstantConverter $constantConverter

convert()

convert(\DOMElement  $parent, \phpDocumentor\Descriptor\InterfaceDescriptor  $interface) : \DOMElement

Export the given reflected interface definition to the provided parent 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.

Parameters

\DOMElement $parent

Element to augment.

\phpDocumentor\Descriptor\InterfaceDescriptor $interface

Element to export.

Returns

\DOMElement