RenderGuide
in package
extends WriterAbstract
Base class for the actual transformation business logic (writers).
Properties
$flySystemFactory Line 38
private$flySystemFactory : \phpDocumentor\Parser\FlySystemFactory
$kernelFactory Line 41
private$kernelFactory : \phpDocumentor\Guides\KernelFactory
$cacheLocator Line 44
private$cacheLocator : \phpDocumentor\Parser\Cache\Locator
Methods
checkRequirements() inherited
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
transform() Line 56
Abstract definition of the transformation method.
publictransform(ProjectDescriptor $project, Transformation $transformation) : void
Parameters
Document containing the structure.
Transformation to execute.