\phpDocumentor\Transformer\WriterRenderGuide

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

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

__toString()

__toString() : string

Returns

__construct()

__construct(\Psr\Log\LoggerInterface  $logger, \League\Tactician\CommandBus  $commandBus, \phpDocumentor\Parser\FlySystemFactory  $flySystemFactory, \phpDocumentor\Transformer\Writer\Twig\EnvironmentFactory  $environmentFactory, \phpDocumentor\Guides\Twig\EnvironmentBuilder  $environmentBuilder) : mixed

Parameters

Returns

getDefaultSettings()

getDefaultSettings() : array<string,bool|string>

Returns

renderDocumentationSet()

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

Parameters

startRenderingSetMessage()

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

Parameters

Returns

completedRenderingSetMessage()

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

Parameters