\phpDocumentor\Transformer\WriterSourcecode

checkRequirements()

checkRequirements() : void

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

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.

transform()

transform(\phpDocumentor\Descriptor\ProjectDescriptor  $project, \phpDocumentor\Transformer\Transformation  $transformation) : void

This method writes every source code entry in the structure file to a highlighted file.

Parameters

__toString()

__toString() : string

Returns

__construct()

__construct(\phpDocumentor\Transformer\Writer\PathGenerator  $pathGenerator) : mixed

Parameters

Returns

copy()

copy(\phpDocumentor\Transformer\Transformation  $transformation, string  $path, string  $destination) : void

Parameters

readSourceFile()

readSourceFile(\phpDocumentor\Transformer\Transformation  $transformation, string  $path) : string

Parameters

Returns

persistTo()

persistTo(\phpDocumentor\Transformer\Transformation  $transformation, string  $path, string  $contents) : void

Parameters

copyDirectory()

copyDirectory(\phpDocumentor\Transformer\Transformation  $transformation, string  $path, string  $destination) : void

Parameters

stripFirstPartOfPath()

stripFirstPartOfPath(string  $path) : string

Parameters

Returns

isGlobalTemplateReference()

isGlobalTemplateReference(string  $path) : bool

Parameters

Returns

normalizeSourcePath()

normalizeSourcePath(string  $path) : string

Parameters

Returns

normalizeDestination()

normalizeDestination(string  $destination) : string

Parameters

Returns