SequentialProcess Class Reference

Inheritance diagram for SequentialProcess:
ImportSequentialProcess TestSequentialProcess ImportCreateUpdateModelsSequentialProcess ImportDataAnalysisSequentialProcess

Public Member Functions

 getAllStepsMessage ()
 run ($step, $params)
 isComplete ()
 getNextStep ()
 getNextParams ()
 getNextMessage ()
 getCompletionPercentage ()
 getViewClassNameByStep ($step)

Protected Member Functions

 steps ()
 stepMessages ()
 resolveNextInformationByCurrentStep ($step)
 setNextMessageByStep ($step)

Protected Attributes

 $complete = false
 $nextStep
 $nextParams
 $nextMessage
 $completionPercentage
 $subSequenceCompletionPercentage = 0

Detailed Description

Component to run a sequential process. After a step is run, information regarding the next step is populated including any parameters and messages. Sequential processes can also include sub processes. An example would be if a specific step has a loop over models via a data provider.

Definition at line 42 of file SequentialProcess.php.


Member Function Documentation

getAllStepsMessage (  )  [abstract]

Method to get the message that is utilized for all steps in a sequence.

Returns:
string message content.

Reimplemented in TestSequentialProcess, ImportCreateUpdateModelsSequentialProcess, and ImportDataAnalysisSequentialProcess.

steps (  )  [abstract, protected]
Returns:
array of steps in the sequence

Reimplemented in TestSequentialProcess, ImportCreateUpdateModelsSequentialProcess, and ImportDataAnalysisSequentialProcess.

stepMessages (  )  [abstract, protected]

Array indexed by step. The value represents the step specific message.

Returns:
array of step messages.

Reimplemented in TestSequentialProcess, ImportCreateUpdateModelsSequentialProcess, and ImportDataAnalysisSequentialProcess.

run ( step,
params 
)

Given a step, run it and setup for the next step in the process.

Parameters:
string or null $step
array or null $params

Definition at line 109 of file SequentialProcess.php.


Field Documentation

$complete = false [protected]

If all the steps are completed, this is set to true.

Definition at line 64 of file SequentialProcess.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Sat Oct 21 07:10:30 2017