FileIo

in package

extends WriterAbstract Uses IoTrait

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

Interfaces, Classes & Used Traits

IoTrait

FileIo.php

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 45

Invokes the query method contained in this class.

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

Parameters

$project : ProjectDescriptor

Document containing the structure.

$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() inherited

public__toString() : string

Returns

string —

Inherited from: \phpDocumentor\Transformer\Writer\WriterAbstract

copy() inherited

protectedcopy(Transformation $transformation, string $path, string $destination) : void

Parameters

$transformation : Transformation

$path : string

$destination : string

Inherited from: \phpDocumentor\Transformer\Writer\IoTrait

readSourceFile() inherited

protectedreadSourceFile(Transformation $transformation, string $path) : string

Parameters

$transformation : Transformation

$path : string

Returns

string —

Inherited from: \phpDocumentor\Transformer\Writer\IoTrait

persistTo() inherited

protectedpersistTo(Transformation $transformation, string $path, string $contents) : void

Parameters

$transformation : Transformation

$path : string

$contents : string

Inherited from: \phpDocumentor\Transformer\Writer\IoTrait

copyDirectory() inherited

privatecopyDirectory(Transformation $transformation, string $path, string $destination) : void

Parameters

$transformation : Transformation

$path : string

$destination : string

Inherited from: \phpDocumentor\Transformer\Writer\IoTrait

stripFirstPartOfPath() inherited

privatestripFirstPartOfPath(string $path) : string

Parameters

$path : string

Returns

string —

Inherited from: \phpDocumentor\Transformer\Writer\IoTrait

isGlobalTemplateReference() inherited

privateisGlobalTemplateReference(string $path) : bool

Parameters

$path : string

Returns

bool —

Inherited from: \phpDocumentor\Transformer\Writer\IoTrait

normalizeSourcePath() inherited

privatenormalizeSourcePath(string $path) : string

Parameters

$path : string

Returns

string —

Inherited from: \phpDocumentor\Transformer\Writer\IoTrait

normalizeDestination() inherited

privatenormalizeDestination(string $destination) : string

Parameters

$destination : string

Returns

string —

Inherited from: \phpDocumentor\Transformer\Writer\IoTrait