phpDocumentor

GraphVizClassDiagram
in package
implements Generator

FinalYes

Table of Contents

Interfaces

Generator

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

$nodeCache

private array<string, Node|null> $nodeCache = []

a cache where nodes for classes, interfaces and traits are stored for reference

Methods

checkIfGraphVizIsInstalled()

Checks whether GraphViz is installed and throws an Exception otherwise.

private checkIfGraphVizIsInstalled() : void
Tags
throws
RuntimeException

If graphviz is not found.

createEmptyNode()

private createEmptyNode(string $name, Graph|null $graph) : Node|null
Parameters
$name : string
$graph : Graph|null
Return values
Node|null

createGraphForNamespace()

private createGraphForNamespace(string $fullNamespaceName, string $label) : Graph
Parameters
$fullNamespaceName : string
$label : string
Return values
Graph

createNamespaceGraph()

private createNamespaceGraph(string $fqcn) : Graph|null
Parameters
$fqcn : string
Return values
Graph|null

        
On this page

Search results