abstract class AbstractOperation implements OperationInterface (View source)

internal  
 

Provides default behaviors for operations.

Properties

protected string $contents

Cached contents of scaffold file to be written to disk.

Methods

string
contents()

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

string
generateContents()

Load the scaffold contents or otherwise generate what is needed.

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

final 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.

abstract protected string generateContents()

Load the scaffold contents or otherwise generate what is needed.

Return Value

string

The contents of the scaffold file.

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.