RenderGuide

in package
extends WriterAbstract

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

RenderGuide.php
experimental

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

Properties

private$flySystemFactory  : \phpDocumentor\Parser\FlySystemFactory                

private$kernelFactory  : \phpDocumentor\Guides\KernelFactory                

private$cacheLocator  : \phpDocumentor\Parser\Cache\Locator

Methods

This method verifies whether PHP has all requirements needed to run this writer.

publiccheckRequirements() : 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.

Throws

\phpDocumentor\Transformer\Writer\Exception\RequirementMissing

When a requirements is missing stating which one.

Inherited from
\phpDocumentor\Transformer\Writer\WriterAbstract
codeCoverageIgnore

Abstract definition of the transformation method.

publictransform(ProjectDescriptor $project, Transformation $transformation) : void

Parameters

$project : ProjectDescriptor

Document containing the structure.

$transformation : Transformation

Transformation to execute.

public__toString() : string

Returns

string —
Inherited from
\phpDocumentor\Transformer\Writer\WriterAbstract

public__construct(FlySystemFactory $flySystemFactory, KernelFactory $kernelFactory, Locator $cacheLocator) : mixed

Parameters

$flySystemFactory : FlySystemFactory
$kernelFactory : KernelFactory
$cacheLocator : Locator

Returns

mixed — 

privatedetermineInputFolder(Dsn $dsn, string $cachePath) : string

Parameters

$dsn : Dsn
$cachePath : string

Returns

string —