RenderGuide
extends WriterAbstract
in package
implements
WithCustomSettings
Base class for the actual transformation business logic (writers).
Tags
Interfaces, Classes and Traits
- WithCustomSettings
- Declares that the service implementing this interface yields its own settings.
Table of Contents
- FEATURE_FLAG = 'guides.enabled'
- $commandBus : CommandBus
- $logger : LoggerInterface
- $outputFormats : iteratable<string|int, Format>
- $renderer : Renderer
- __construct() : mixed
- __toString() : string
- checkRequirements() : void
- This method verifies whether PHP has all requirements needed to run this writer.
- getDefaultSettings() : array<string, bool>
- transform() : void
- Abstract definition of the transformation method.
- completedRenderingSetMessage() : void
- renderDocumentationSet() : void
- startRenderingSetMessage() : Stopwatch
Constants
FEATURE_FLAG
public
mixed
FEATURE_FLAG
= 'guides.enabled'
Properties
$commandBus
private
CommandBus
$commandBus
$logger
private
LoggerInterface
$logger
$outputFormats
private
iteratable<string|int, Format>
$outputFormats
$renderer
private
Renderer
$renderer
Methods
__construct()
public
__construct(Renderer $renderer, LoggerInterface $logger, CommandBus $commandBus, iteratable<string|int, Format> $outputFormats) : mixed
Parameters
- $renderer : Renderer
- $logger : LoggerInterface
- $commandBus : CommandBus
- $outputFormats : iteratable<string|int, Format>
Return values
mixed —__toString()
public
__toString() : string
Return values
string —checkRequirements()
This method verifies whether PHP has all requirements needed to run this writer.
public
checkRequirements() : void
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.
Tags
Return values
void —getDefaultSettings()
public
getDefaultSettings() : array<string, bool>
Return values
array<string, bool> —transform()
Abstract definition of the transformation method.
public
transform(ProjectDescriptor $project, Transformation $transformation) : void
Parameters
- $project : ProjectDescriptor
-
Document containing the structure.
- $transformation : Transformation
-
Transformation to execute.
Return values
void —completedRenderingSetMessage()
private
completedRenderingSetMessage(Stopwatch $stopwatch, Dsn $dsn) : void
Parameters
Return values
void —renderDocumentationSet()
private
renderDocumentationSet(GuideSetDescriptor $documentationSet, ProjectDescriptor $project, Transformation $transformation) : void
Parameters
- $documentationSet : GuideSetDescriptor
- $project : ProjectDescriptor
- $transformation : Transformation
Return values
void —startRenderingSetMessage()
private
startRenderingSetMessage(Dsn $dsn) : Stopwatch
Parameters
- $dsn : Dsn