PHP Class DataSift\Storyplayer\PlayerLib\PhaseGroup_Result

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
$activity string the reason that the PhaseGroup is running at all
$durationTime float how long did the story take to play?
$endTime float when did we finish playing this story?
$failedPhase PhaseResult
$filename string which file is this PhaseGroup_Result associated with?
$name string this is an end-user name (e.g. the name of the story) rather than the name of the internal class
$resultCode integer did the story pass, fail, or otherwise go horribly wrong?
$resultStrings
$startTime float when did we start playing this story?

Public Methods

Method Description
__construct ( $name )
getDuration ( ) : float
getPhaseGroupFailed ( ) : boolean
getPhaseGroupSkipped ( ) : boolean
getPhaseGroupSucceeded ( ) : boolean
getResultString ( ) : string
setActivity ( $activity ) : void
setPhaseGroupHasBeenBlacklisted ( $phaseResult ) : void
setPhaseGroupHasBeenSkipped ( ) : void
setPhaseGroupHasError ( $phaseResult ) : void
setPhaseGroupHasFailed ( $phaseResult ) : void
setPhaseGroupHasSucceeded ( ) : void
setPhaseGroupIsIncomplete ( $phaseResult ) : void

Protected Methods

Method Description
setEndTime ( ) : void

Method Details

__construct() public method

public __construct ( $name )

getDuration() public method

public getDuration ( ) : float
return float

getPhaseGroupFailed() public method

public getPhaseGroupFailed ( ) : boolean
return boolean

getPhaseGroupSkipped() public method

public getPhaseGroupSkipped ( ) : boolean
return boolean

getPhaseGroupSucceeded() public method

public getPhaseGroupSucceeded ( ) : boolean
return boolean

getResultString() public method

public getResultString ( ) : string
return string

setActivity() public method

public setActivity ( $activity ) : void
return void

setEndTime() protected method

protected setEndTime ( ) : void
return void

setPhaseGroupHasBeenBlacklisted() public method

public setPhaseGroupHasBeenBlacklisted ( $phaseResult ) : void
return void

setPhaseGroupHasBeenSkipped() public method

public setPhaseGroupHasBeenSkipped ( ) : void
return void

setPhaseGroupHasError() public method

public setPhaseGroupHasError ( $phaseResult ) : void
return void

setPhaseGroupHasFailed() public method

public setPhaseGroupHasFailed ( $phaseResult ) : void
return void

setPhaseGroupHasSucceeded() public method

public setPhaseGroupHasSucceeded ( ) : void
return void

setPhaseGroupIsIncomplete() public method

public setPhaseGroupIsIncomplete ( $phaseResult ) : void
return void

Property Details

$activity public property

the reason that the PhaseGroup is running at all
public string $activity
return string

$durationTime public property

how long did the story take to play?
public float $durationTime
return float

$endTime public property

when did we finish playing this story?
public float $endTime
return float

$failedPhase public property

public PhaseResult $failedPhase
return PhaseResult

$filename public property

which file is this PhaseGroup_Result associated with?
public string $filename
return string

$name public property

this is an end-user name (e.g. the name of the story) rather than the name of the internal class
public string $name
return string

$resultCode public property

did the story pass, fail, or otherwise go horribly wrong?
public int $resultCode
return integer

$resultStrings public property

public $resultStrings

$startTime public property

when did we start playing this story?
public float $startTime
return float