Graph
extends WriterAbstract
in package
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
Table of Contents
Interfaces
- WithCustomSettings
- Declares that the service implementing this interface yields its own settings.
Properties
Methods
- __construct() : mixed
- __toString() : string
- checkRequirements() : void
- This method verifies whether PHP has all requirements needed to run this writer.
- getDefaultSettings() : array<string, bool>
- getName() : string
- Name of this writer, used to identify this writer.
- transform() : void
- Generates a UML class diagram using PlantUML or our native GraphViz integration.
- getDestinationPath() : string
Properties
$plantumlClassDiagram read-only
private
Generator
$plantumlClassDiagram
Methods
__construct()
public
__construct(Generator $plantumlClassDiagram) : mixed
Parameters
- $plantumlClassDiagram : Generator
__toString()
public
__toString() : string
Return values
stringcheckRequirements()
This method verifies whether PHP has all requirements needed to run this writer.
public
checkRequirements() : 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.
Tags
getDefaultSettings()
public
getDefaultSettings() : array<string, bool>
Return values
array<string, bool>getName()
Name of this writer, used to identify this writer.
public
getName() : string
This name is also used in Collection as key and should match the name provided in the template definitions' transformations.
Return values
stringtransform()
Generates a UML class diagram using PlantUML or our native GraphViz integration.
public
transform(Transformation $transformation, ProjectDescriptor $project, DocumentationSetDescriptor $documentationSet) : void
Parameters
- $transformation : Transformation
-
Transformation to execute.
- $project : ProjectDescriptor
-
Document containing the structure.
- $documentationSet : DocumentationSetDescriptor
getDestinationPath()
private
getDestinationPath(Transformation $transformation) : string
Parameters
- $transformation : Transformation