PHP Class DataSift\Storyplayer\Phases\Phase

See link: http://datasift.github.io/storyplayer
Author: Stuart Herbert ([email protected])
Show file Open project: datasift/storyplayer Class Usage Examples

Protected Properties

Property Type Description
$sequenceNo
$st

Public Methods

Method Description
__construct ( StoryTeller $st )
doPerPhaseSetup ( )
doPerPhaseTeardown ( )
doPhase ( mixed $thingBeingPlayed ) : DataSift\Storyplayer\PlayerLib\PhaseGroup_Result execute a phase, and return the results for further analysis
getNewPhaseResult ( )
getPhaseName ( ) : string get the name of this phase
getPhaseSequenceNo ( ) : integer | null what number is assigned to this phase?
getPhaseType ( ) : integer

Method Details

__construct() public method

public __construct ( StoryTeller $st )
$st DataSift\Storyplayer\PlayerLib\StoryTeller

doPerPhaseSetup() public method

public doPerPhaseSetup ( )

doPerPhaseTeardown() public method

public doPerPhaseTeardown ( )

doPhase() abstract public method

execute a phase, and return the results for further analysis
abstract public doPhase ( mixed $thingBeingPlayed ) : DataSift\Storyplayer\PlayerLib\PhaseGroup_Result
$thingBeingPlayed mixed what is the phase executing against?
return DataSift\Storyplayer\PlayerLib\PhaseGroup_Result

getNewPhaseResult() public method

public getNewPhaseResult ( )

getPhaseName() public method

get the name of this phase
public getPhaseName ( ) : string
return string

getPhaseSequenceNo() public method

what number is assigned to this phase?
public getPhaseSequenceNo ( ) : integer | null
return integer | null

getPhaseType() abstract public method

abstract public getPhaseType ( ) : integer
return integer

Property Details

$sequenceNo protected property

protected $sequenceNo

$st protected property

protected $st