Cecil

StepInterface

Step interface.

This interface defines the methods that any step in the build process must implement. Steps are used to perform specific actions during the build process, such as generating pages, processing data, or applying transformations.

Table of Contents

Methods

__construct()  : mixed
StepInterface constructor.
canProcess()  : bool
Method to know if the step can be processed.
getName()  : string
Returns the step name.
init()  : void
This method is called before the step is processed to initialize the step with necessary options and to determine if it can be executed.
process()  : void
Process implementation.

Methods

canProcess()

Method to know if the step can be processed.

public canProcess() : bool
Return values
bool

getName()

Returns the step name.

public getName() : string
Return values
string

init()

This method is called before the step is processed to initialize the step with necessary options and to determine if it can be executed.

public init(Builder::OPTIONS $options) : void
Parameters
$options : Builder::OPTIONS
 
On this page

Search results