PHP Class DataSift\Storyplayer\PlayerLib\Phase_Result

a result is a little more than just a PASS/FAIL: 1. we need to know what happened during this phase 2. we need to know how this affects the playing of the story 3. we need to know if there are any other phases we need to execute *because* we have executed this phase 4. we need to know if there's a message to pass on to the end-user perhaps it was much easier when we just hard-coded all of this?
See link: http://datasift.github.io/storyplayer
Author: Stuart Herbert ([email protected])
Show file Open project: datasift/storyplayer Class Usage Examples

Public Properties

Property Type Description
$activityLog

Protected Properties

Property Type Description
$exception
$message
$nextAction
$phaseName
$result
$resultTextMap

Public Methods

Method Description
__construct ( $phaseName )
getException ( ) : Exception | null
getMessage ( ) : string | null
getNextAction ( ) : integer
getPhaseCannotRun ( ) : boolean
getPhaseCompleted ( ) : boolean
getPhaseFailed ( ) : boolean
getPhaseHasBeenSkipped ( ) : boolean
getPhaseHasNoActions ( ) : boolean
getPhaseIsBlacklisted ( ) : boolean
getPhaseIsIncomplete ( ) : boolean
getPhaseName ( ) : string
getPhaseResult ( ) : integer
getPhaseResultString ( ) : string
getPhaseSucceeded ( ) : boolean
hasMessage ( ) : boolean
setContinuePlaying ( integer $result = 1, string | null $msg = null, Exceptio\Exception | null $e = null ) : void
setPlayingFailed ( integer $result, string $msg, Exceptio\Exception | null $e = null ) : void
setSkipPlaying ( integer $result, string $msg, $e = null ) : void

Method Details

__construct() public method

public __construct ( $phaseName )

getException() public method

public getException ( ) : Exception | null
return Exception | null

getMessage() public method

public getMessage ( ) : string | null
return string | null

getNextAction() public method

public getNextAction ( ) : integer
return integer

getPhaseCannotRun() public method

public getPhaseCannotRun ( ) : boolean
return boolean

getPhaseCompleted() public method

public getPhaseCompleted ( ) : boolean
return boolean

getPhaseFailed() public method

public getPhaseFailed ( ) : boolean
return boolean

getPhaseHasBeenSkipped() public method

public getPhaseHasBeenSkipped ( ) : boolean
return boolean

getPhaseHasNoActions() public method

public getPhaseHasNoActions ( ) : boolean
return boolean

getPhaseIsBlacklisted() public method

public getPhaseIsBlacklisted ( ) : boolean
return boolean

getPhaseIsIncomplete() public method

public getPhaseIsIncomplete ( ) : boolean
return boolean

getPhaseName() public method

public getPhaseName ( ) : string
return string

getPhaseResult() public method

public getPhaseResult ( ) : integer
return integer

getPhaseResultString() public method

public getPhaseResultString ( ) : string
return string

getPhaseSucceeded() public method

public getPhaseSucceeded ( ) : boolean
return boolean

hasMessage() public method

public hasMessage ( ) : boolean
return boolean

setContinuePlaying() public method

public setContinuePlaying ( integer $result = 1, string | null $msg = null, Exceptio\Exception | null $e = null ) : void
$result integer
$msg string | null
$e Exceptio\Exception | null
return void

setPlayingFailed() public method

public setPlayingFailed ( integer $result, string $msg, Exceptio\Exception | null $e = null ) : void
$result integer
$msg string
$e Exceptio\Exception | null
return void

setSkipPlaying() public method

public setSkipPlaying ( integer $result, string $msg, $e = null ) : void
$result integer
$msg string
return void

Property Details

$activityLog public property

public $activityLog

$exception protected property

protected $exception

$message protected property

protected $message

$nextAction protected property

protected $nextAction

$phaseName protected property

protected $phaseName

$result protected property

protected $result

$resultTextMap protected property

protected $resultTextMap