phpDocumentor

RenderGuide extends WriterAbstract
in package
implements WithCustomSettings, Initializable, TemplateRenderer

FinalYes

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

Tags
experimental

this feature is in alpha stages and can have unresolved issues or missing features.

Table of Contents

Interfaces

WithCustomSettings
Declares that the service implementing this interface yields its own settings.
Initializable
TemplateRenderer

Constants

FEATURE_FLAG  = 'guides.enabled'

Properties

$commandBus  : CommandBus
$environment  : Environment
$environmentFactory  : EnvironmentFactory
$flySystemFactory  : FlySystemFactory
$logger  : LoggerInterface

Methods

__construct()  : mixed
__toString()  : string
checkRequirements()  : void
This method verifies whether PHP has all requirements needed to run this writer.
getDefaultSettings()  : array<string, bool|string>
getName()  : string
Name of this writer, used to identify this writer.
initialize()  : void
isTemplateFound()  : bool
renderTemplate()  : string
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 read-only

private CommandBus $commandBus

Methods

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

getDefaultSettings()

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

getName()

Name of this writer, used to identify this writer.

public getName() : string

This name is also used in Collection as key and should match the name provided in the template definitions' transformations.

Return values
string

isTemplateFound()

public isTemplateFound(RenderContext $context, string $template) : bool
Parameters
$context : RenderContext
$template : string
Return values
bool

renderTemplate()

public renderTemplate(RenderContext $context, string $template[, array<string|int, mixed> $params = [] ]) : string
Parameters
$context : RenderContext
$template : string
$params : array<string|int, mixed> = []
Return values
string

completedRenderingSetMessage()

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

startRenderingSetMessage()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results