interface OperationInterface (View source)

internal  
 

Interface for scaffold operation objects.

Methods

string
contents()

Returns the exact data that will be written to the scaffold files.

process(ScaffoldFilePath $destination, IOInterface $io, ScaffoldOptions $options)

Process this scaffold operation.

scaffoldOverExistingTarget(OperationInterface $existing_target)

Determines what to do if operation is used at same path as a previous op.

scaffoldAtNewLocation(ScaffoldFilePath $destination)

Determines what to do if operation is used without a previous operation.

Details

string contents()

Returns the exact data that will be written to the scaffold files.

Return Value

string

Data to be written to the scaffold location.

ScaffoldResult process(ScaffoldFilePath $destination, IOInterface $io, ScaffoldOptions $options)

Process this scaffold operation.

Parameters

ScaffoldFilePath $destination

Scaffold file's destination path.

IOInterface $io

IOInterface to write to.

ScaffoldOptions $options

Various options that may alter the behavior of the operation.

Return Value

ScaffoldResult

Result of the scaffolding operation.

OperationInterface scaffoldOverExistingTarget(OperationInterface $existing_target)

Determines what to do if operation is used at same path as a previous op.

Default behavior is to scaffold this operation at the specified destination, ignoring whatever was there before.

Parameters

OperationInterface $existing_target

Existing file at the destination path that we should combine with.

Return Value

OperationInterface

The op to use at this destination.

OperationInterface scaffoldAtNewLocation(ScaffoldFilePath $destination)

Determines what to do if operation is used without a previous operation.

Default behavior is to scaffold this operation at the specified destination. Most operations overwrite rather than modify existing files, and therefore do not need to do anything special when there is no existing file.

Parameters

ScaffoldFilePath $destination

Scaffold file's destination path.

Return Value

OperationInterface

The op to use at this destination.