phpDocumentor
\
phpDocumentor
Compiler
Linker
Pass
Configuration
Definition
Exception
Console
Command
Project
DependencyInjection
Descriptor
Builder
Reflector
Docblock
Tags
Cache
DocBlock
Example
Exception
Filter
Interfaces
ProjectDescriptor
Query
TableOfContents
Tag
BaseTypes
Traits
Validation
ValueObjects
Event
Guides
DependencyInjection
Handlers
References
Resolver
Php
Parser
Cache
Event
Exception
Middleware
Pipeline
Stage
Cache
Parser
Transformer
Event
Router
Template
Writer
Exception
Graph
Twig
LinkRenderer

\phpDocumentor\Transformer\WriterGraph

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

Summary

Methods
Properties
Constants
getName()
checkRequirements()
transform()
__toString()
__construct()
getDefaultSettings()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
getDestinationPath()
$classDiagramGenerator
$plantumlClassDiagram
N/A

Properties

$classDiagramGenerator

$classDiagramGenerator : \phpDocumentor\Transformer\Writer\Graph\GraphVizClassDiagram

Type

\phpDocumentor\Transformer\Writer\Graph\GraphVizClassDiagram —

$plantumlClassDiagram

$plantumlClassDiagram : \phpDocumentor\Transformer\Writer\Graph\PlantumlClassDiagram

Type

\phpDocumentor\Transformer\Writer\Graph\PlantumlClassDiagram —

Methods

getName()

getName() : string

Name of this writer, used to identify this writer.

This name is also used in {@see \phpDocumentor\Transformer\Writer\Collection} as key and should match the name provided in the template definitions' transformations.

Returns

string —

checkRequirements()

checkRequirements() : void

This method verifies whether PHP has all requirements needed to run this writer.

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.

transform()

transform(\phpDocumentor\Descriptor\ProjectDescriptor  $project, \phpDocumentor\Transformer\Transformation  $transformation) : void

Generates a UML class diagram using PlantUML or our native GraphViz integration.

Parameters

\phpDocumentor\Descriptor\ProjectDescriptor $project

Document containing the structure.
\phpDocumentor\Transformer\Transformation $transformation

Transformation to execute.

__toString()

__toString() : string

Returns

string —

__construct()

__construct(\phpDocumentor\Transformer\Writer\Graph\GraphVizClassDiagram  $classDiagramGenerator, \phpDocumentor\Transformer\Writer\Graph\PlantumlClassDiagram  $plantumlClassDiagram) : mixed

Parameters

\phpDocumentor\Transformer\Writer\Graph\GraphVizClassDiagram $classDiagramGenerator
\phpDocumentor\Transformer\Writer\Graph\PlantumlClassDiagram $plantumlClassDiagram

Returns

mixed —

getDefaultSettings()

getDefaultSettings() : array<string,bool>

Returns

array —

getDestinationPath()

getDestinationPath(\phpDocumentor\Transformer\Transformation  $transformation) : string

Parameters

\phpDocumentor\Transformer\Transformation $transformation

Returns

string —