TYPO3  7.6
Public Member Functions | List of all members
StepInterface Interface Reference
Inheritance diagram for StepInterface:
AbstractStepAction DatabaseConnect DatabaseData DatabaseSelect DefaultConfiguration EnvironmentAndFolders

Public Member Functions

 execute ()
 
 needsExecution ()
 
 setStepsCounter ($current, $total)
 
 getCurrentStep ()
 
 getTotalSteps ()
 

Detailed Description

Interface implemented by single steps

Definition at line 22 of file StepInterface.php.

Member Function Documentation

execute ( )

Execute a step

Returns
array<>
getCurrentStep ( )

Gets current position

Returns
int

Implemented in AbstractStepAction.

getTotalSteps ( )

Gets total steps

Returns
int

Implemented in AbstractStepAction.

needsExecution ( )

Whether this step must be executed

Returns
bool TRUE if this step needs to be executed

Implemented in DatabaseConnect, DefaultConfiguration, DatabaseSelect, DatabaseData, and EnvironmentAndFolders.

setStepsCounter (   $current,
  $total 
)

Tell the action which position it has in the list of actions

Parameters
int$currentThe current position
int$totalThe total number of steps
Returns
void

Implemented in AbstractStepAction.