phpDocumentor

RenderGuide extends WriterAbstract
in package
implements WithCustomSettings

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

Tags
experimental

Do not use; this stage is meant as a sandbox / playground to experiment with generating guides.

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
$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

Methods

__construct()

public __construct(Renderer $renderer, LoggerInterface $logger, CommandBus $commandBus) : mixed
Parameters
$renderer : Renderer
$logger : LoggerInterface
$commandBus : CommandBus
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
throws
RequirementMissing

When a requirements is missing stating which one.

codeCoverageIgnore
Return values
void

getDefaultSettings()

public getDefaultSettings() : array<string, bool>
Return values
array<string, bool>

completedRenderingSetMessage()

private completedRenderingSetMessage(Stopwatch $stopwatch, Dsn $dsn) : void
Parameters
$stopwatch : Stopwatch
$dsn : Dsn
Return values
void

startRenderingSetMessage()

private startRenderingSetMessage(Dsn $dsn) : Stopwatch
Parameters
$dsn : Dsn
Return values
Stopwatch

Search results