Sourcecode
extends WriterAbstract
in package
Sourcecode transformation writer; generates syntax highlighted source files in a destination's subfolder.
Table of Contents
- $pathGenerator : PathGenerator
- __construct() : mixed
- __toString() : string
- checkRequirements() : void
- This method verifies whether PHP has all requirements needed to run this writer.
- transform() : void
- This method writes every source code entry in the structure file to a highlighted file.
Properties
$pathGenerator
private
PathGenerator
$pathGenerator
Methods
__construct()
public
__construct(PathGenerator $pathGenerator) : mixed
Parameters
- $pathGenerator : PathGenerator
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
Return values
void —transform()
This method writes every source code entry in the structure file to a highlighted file.
public
transform(ProjectDescriptor $project, Transformation $transformation) : void
Parameters
- $project : ProjectDescriptor
-
Document containing the structure.
- $transformation : Transformation
-
Transformation to execute.