PHP Class DataSift\Storyplayer\Console\DefaultConsole

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

Protected Properties

Property Type Description
$currentPhase
$phaseMessages
$phaseNumber
$storyResults array a list of the results we have received from stories

Public Methods

Method Description
endPhase ( $phase, $phaseResult ) : void called when a story ends a phase
endPhaseGroup ( $result )
endStoryplayer ( $duration )
logCliError ( string $msg ) : void called when the outer CLI shell encounters a fatal error
logCliErrorWithException ( string $msg, Exception $e ) : void
logCliInfo ( string $msg ) : void called when the outer CLI shell needs to tell the user something
logCliWarning ( string $msg ) : void called when the outer CLI shell needs to publish a warning
logPhaseActivity ( string $msg, $codeLine = null ) : void called when a story logs an action
logPhaseCodeLine ( $codeLine )
logPhaseError ( string $phaseName, string $msg ) : void called when a story logs an error
logPhaseSkipped ( string $phaseName, string $msg ) : void called when a story is skipped
logPhaseSubprocessOutput ( string $msg ) : void called when a story logs the (possibly partial) output from running a subprocess
logVardump ( string $name, mixed $var ) : void an alternative to using PHP's built-in var_dump()
startPhase ( $phase ) : void called when a story starts a new phase
startPhaseGroup ( $activity, string $name ) : void called when we start a new set of phases
startStoryplayer ( string $version, string $url, string $copyright, string $license ) : void called when storyplayer starts

Method Details

endPhase() public method

called when a story ends a phase
public endPhase ( $phase, $phaseResult ) : void
return void

endPhaseGroup() public method

public endPhaseGroup ( $result )

endStoryplayer() public method

public endStoryplayer ( $duration )

logCliError() public method

called when the outer CLI shell encounters a fatal error
public logCliError ( string $msg ) : void
$msg string the error message to show the user
return void

logCliErrorWithException() public method

public logCliErrorWithException ( string $msg, Exception $e ) : void
$msg string
$e Exception
return void

logCliInfo() public method

called when the outer CLI shell needs to tell the user something
public logCliInfo ( string $msg ) : void
$msg string the message to show the user
return void

logCliWarning() public method

called when the outer CLI shell needs to publish a warning
public logCliWarning ( string $msg ) : void
$msg string the warning message to show the user
return void

logPhaseActivity() public method

called when a story logs an action
public logPhaseActivity ( string $msg, $codeLine = null ) : void
$msg string
return void

logPhaseCodeLine() public method

public logPhaseCodeLine ( $codeLine )

logPhaseError() public method

called when a story logs an error
public logPhaseError ( string $phaseName, string $msg ) : void
$phaseName string
$msg string
return void

logPhaseSkipped() public method

called when a story is skipped
public logPhaseSkipped ( string $phaseName, string $msg ) : void
$phaseName string
$msg string
return void

logPhaseSubprocessOutput() public method

called when a story logs the (possibly partial) output from running a subprocess
public logPhaseSubprocessOutput ( string $msg ) : void
$msg string the output to log
return void

logVardump() public method

an alternative to using PHP's built-in var_dump()
public logVardump ( string $name, mixed $var ) : void
$name string a human-readable name to describe $var
$var mixed the variable to dump
return void

startPhase() public method

called when a story starts a new phase
public startPhase ( $phase ) : void
return void

startPhaseGroup() public method

called when we start a new set of phases
public startPhaseGroup ( $activity, string $name ) : void
$name string
return void

startStoryplayer() public method

called when storyplayer starts
public startStoryplayer ( string $version, string $url, string $copyright, string $license ) : void
$version string
$url string
$copyright string
$license string
return void

Property Details

$currentPhase protected property

protected $currentPhase

$phaseMessages protected property

protected $phaseMessages

$phaseNumber protected property

protected $phaseNumber

$storyResults protected property

a list of the results we have received from stories
protected array $storyResults
return array