WriterAbstract

in package

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

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.

codeCoverageIgnore

Abstract definition of the transformation method.

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

Parameters

$project : ProjectDescriptor

Document containing the structure.

$transformation : Transformation

Transformation to execute.

public__toString() : string

Returns

string