InterfaceConverter

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.

package

Default

Methods

Initializes this converter with the DocBlock converter.

__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) 

Export the given reflected interface definition to the provided parent element.

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

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.

Arguments

$parent

\DOMElement

Element to augment.

$interface

\phpDocumentor\Descriptor\InterfaceDescriptor

Element to export.

Response

\DOMElement

Properties

object used to convert DocBlocks into their XML counterpart

docBlockConverter : \phpDocumentor\Plugin\Core\Transformer\Writer\Xml\DocBlockConverter
var

object used to convert DocBlocks into their XML counterpart

Type(s)

\phpDocumentor\Plugin\Core\Transformer\Writer\Xml\DocBlockConverter

object used to convert methods into their XML counterpart

methodConverter : \phpDocumentor\Plugin\Core\Transformer\Writer\Xml\MethodConverter
var

object used to convert methods into their XML counterpart

Type(s)

\phpDocumentor\Plugin\Core\Transformer\Writer\Xml\MethodConverter

object used to convert constants into their XML counterpart

constantConverter : \phpDocumentor\Plugin\Core\Transformer\Writer\Xml\ConstantConverter
var

object used to convert constants into their XML counterpart

Type(s)

\phpDocumentor\Plugin\Core\Transformer\Writer\Xml\ConstantConverter