\phpDocumentor\Transformer\WriterRenderGuide

Base class for the actual transformation business logic (writers).

Summary

Methods
Properties
Constants
getName()
checkRequirements()
transform()
__toString()
__construct()
getDefaultSettings()
No public properties found
FEATURE_FLAG
No protected methods found
No protected properties found
N/A
renderDocumentationSet()
startRenderingSetMessage()
completedRenderingSetMessage()
$logger
$commandBus
$renderer
$flySystemFactory
N/A

Constants

FEATURE_FLAG

FEATURE_FLAG = 'guides.enabled'

Properties

$logger

$logger : \Psr\Log\LoggerInterface

Type

\Psr\Log\LoggerInterface —

$commandBus

$commandBus : \League\Tactician\CommandBus

Type

\League\Tactician\CommandBus —

$renderer

$renderer : \phpDocumentor\Guides\Renderer

Type

\phpDocumentor\Guides\Renderer —

$flySystemFactory

$flySystemFactory : \phpDocumentor\Parser\FlySystemFactory

Type

FlySystemFactory

Methods

getName()

getName() : string

Name of this writer, used to identify this writer.

This name is also used in {@see} 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

Abstract definition of the transformation method.

Parameters

\phpDocumentor\Descriptor\ProjectDescriptor $project

Document containing the structure.

\phpDocumentor\Transformer\Transformation $transformation

Transformation to execute.

__toString()

__toString() : string

Returns

string —

__construct()

__construct(\phpDocumentor\Guides\Renderer  $renderer, \Psr\Log\LoggerInterface  $logger, \League\Tactician\CommandBus  $commandBus, \phpDocumentor\Parser\FlySystemFactory  $flySystemFactory) : mixed

Parameters

\phpDocumentor\Guides\Renderer $renderer
\Psr\Log\LoggerInterface $logger
\League\Tactician\CommandBus $commandBus
\phpDocumentor\Parser\FlySystemFactory $flySystemFactory

Returns

mixed —

getDefaultSettings()

getDefaultSettings() : array<string,bool>

Returns

array

renderDocumentationSet()

renderDocumentationSet(\phpDocumentor\Descriptor\GuideSetDescriptor  $documentationSet, \phpDocumentor\Descriptor\ProjectDescriptor  $project, \phpDocumentor\Transformer\Transformation  $transformation) : void

Parameters

\phpDocumentor\Descriptor\GuideSetDescriptor $documentationSet
\phpDocumentor\Descriptor\ProjectDescriptor $project
\phpDocumentor\Transformer\Transformation $transformation

startRenderingSetMessage()

startRenderingSetMessage(\phpDocumentor\Dsn  $dsn) : \Symfony\Component\Stopwatch\Stopwatch

Parameters

\phpDocumentor\Dsn $dsn

Returns

\Symfony\Component\Stopwatch\Stopwatch —

completedRenderingSetMessage()

completedRenderingSetMessage(\Symfony\Component\Stopwatch\Stopwatch  $stopwatch, \phpDocumentor\Dsn  $dsn) : void

Parameters

\Symfony\Component\Stopwatch\Stopwatch $stopwatch
\phpDocumentor\Dsn $dsn