GraphVizClassDiagram
in package
implements
Generator
FinalYes
Table of Contents
Interfaces
Properties
- $namespaceCache : array<string|int, Graph>
- $nodeCache : array<string, Node|null>
Methods
- create() : void
- Creates a class inheritance diagram.
- buildNamespaceTree() : void
- Builds a tree of namespace subgraphs with their classes associated.
- checkIfGraphVizIsInstalled() : void
- Checks whether GraphViz is installed and throws an Exception otherwise.
- createEdge() : Edge|null
- Creates a GraphViz Edge between two nodes.
- createEmptyNode() : Node|null
- createGraphForNamespace() : Graph
- createNamespaceGraph() : Graph|null
Properties
$namespaceCache
private
array<string|int, Graph>
$namespaceCache
= []
$nodeCache
private
array<string, Node|null>
$nodeCache
= []
a cache where nodes for classes, interfaces and traits are stored for reference
Methods
create()
Creates a class inheritance diagram.
public
create(DocumentationSetDescriptor $documentationSet, string $filename) : void
Parameters
- $documentationSet : DocumentationSetDescriptor
- $filename : string
buildNamespaceTree()
Builds a tree of namespace subgraphs with their classes associated.
private
buildNamespaceTree(Graph $graph, NamespaceInterface $namespace) : void
Parameters
- $graph : Graph
- $namespace : NamespaceInterface
checkIfGraphVizIsInstalled()
Checks whether GraphViz is installed and throws an Exception otherwise.
private
checkIfGraphVizIsInstalled() : void
Tags
createEdge()
Creates a GraphViz Edge between two nodes.
private
createEdge(string $fromName, string|ClassDescriptor|InterfaceDescriptor|TraitDescriptor $to) : Edge|null
Parameters
- $fromName : string
- $to : string|ClassDescriptor|InterfaceDescriptor|TraitDescriptor
Return values
Edge|nullcreateEmptyNode()
private
createEmptyNode(string $name, Graph|null $graph) : Node|null
Parameters
- $name : string
- $graph : Graph|null
Return values
Node|nullcreateGraphForNamespace()
private
createGraphForNamespace(string $fullNamespaceName, string $label) : Graph
Parameters
- $fullNamespaceName : string
- $label : string
Return values
GraphcreateNamespaceGraph()
private
createNamespaceGraph(string $fqcn) : Graph|null
Parameters
- $fqcn : string