\phpDocumentor\Transformer\WriterFileIo

Writer containing file system operations.

The Query part of the transformation determines the action, currently supported is:

  • copy, copies a file or directory to the destination given in $artifact

Summary

Methods
Properties
Constants
checkRequirements()
transform()
__toString()
No public properties found
No constants found
copy()
readSourceFile()
persistTo()
No protected properties found
N/A
copyDirectory()
stripFirstPartOfPath()
isGlobalTemplateReference()
normalizeSourcePath()
normalizeDestination()
No private properties found
N/A

Methods

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

Invokes the query method contained in this class.

Parameters

\phpDocumentor\Descriptor\ProjectDescriptor $project

Document containing the structure.

\phpDocumentor\Transformer\Transformation $transformation

Transformation to execute.

Throws

\InvalidArgumentException

If the query is not supported.

\League\Flysystem\FileNotFoundException

If the source file does not exist or could not be read.

\League\Flysystem\FileExistsException

__toString()

__toString() : string

Returns

string —

copy()

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

Parameters

\phpDocumentor\Transformer\Transformation $transformation
string $path
string $destination

readSourceFile()

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

Parameters

\phpDocumentor\Transformer\Transformation $transformation
string $path

Returns

string —

persistTo()

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

Parameters

\phpDocumentor\Transformer\Transformation $transformation
string $path
string $contents

copyDirectory()

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

Parameters

\phpDocumentor\Transformer\Transformation $transformation
string $path
string $destination

stripFirstPartOfPath()

stripFirstPartOfPath(string  $path) : string

Parameters

string $path

Returns

string —

isGlobalTemplateReference()

isGlobalTemplateReference(string  $path) : bool

Parameters

string $path

Returns

bool —

normalizeSourcePath()

normalizeSourcePath(string  $path) : string

Parameters

string $path

Returns

string —

normalizeDestination()

normalizeDestination(string  $destination) : string

Parameters

string $destination

Returns

string —