Graph
in package
extends WriterAbstract
Implements
WithCustomSettings
Writer responsible for generating various graphs.
The Graph writer is capable of generating a Graph (as provided using the 'source' parameter) at the location provided using the artifact parameter.
Currently supported:
- 'class' (default), a Class Diagram generated using GraphViz
Interfaces, Classes & Used Traits
- WithCustomSettings
- Declares that the service implementing this interface yields its own settings.
Properties
$classDiagramGenerator Line 35
private$classDiagramGenerator : \phpDocumentor\Transformer\Writer\Graph\GraphVizClassDiagram
$plantumlClassDiagram Line 38
private$plantumlClassDiagram : \phpDocumentor\Transformer\Writer\Graph\PlantumlClassDiagram
Methods
checkRequirements() inherited
This method verifies whether PHP has all requirements needed to run this writer.
publiccheckRequirements() : void
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.
Throws
- \phpDocumentor\Transformer\Writer\Exception\RequirementMissing
When a requirements is missing stating which one.
- Inherited from
- \phpDocumentor\Transformer\Writer\WriterAbstract
transform() Line 60
Generates a UML class diagram using PlantUML or our native GraphViz integration.
publictransform(ProjectDescriptor $project, Transformation $transformation) : void
Parameters
Document containing the structure.
Transformation to execute.