Method |
Description |
|
__construct ( ) |
constructor |
|
disableColourSupport ( ) : void |
disables any colour output |
|
enableColourSupport ( ) : void |
asks each active plugin to switch on colour support if possible |
|
endPhase ( Phase $phase, Phase_Result $phaseResult ) : void |
called when a story ends a phase |
|
endPhaseGroup ( PhaseGroup_Result $result ) : void |
called when we have finished playing a PhaseGroup |
|
endStoryplayer ( float $duration ) : integer |
called when Storyplayer exits |
|
enforceColourSupport ( ) : void |
forces switching on colour support |
|
getActiveConsolePlugin ( ) : Console | null |
return the active plugin in the 'console' slot |
|
getActivePluginInSlot ( string $slotName ) : OutputPlugin | null |
return the active plugin in the named slot |
|
getPlugins ( ) : array |
get the array of all plugins |
|
logCliError ( string $msg ) : void |
called when the outer CLI shell encounters a fatal error |
|
logCliErrorWithException ( string $msg, Exception $e ) : void |
called when the outer CLI shell encounters a fatal error |
|
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, array | null $codeLine = null ) : void |
called when a story logs an action |
|
logPhaseCodeLine ( array $codeLine ) : void |
called when we want to record which line of code in a phase is
currently executing |
|
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() |
|
resetSilentMode ( ) : void |
disable 'silent' mode |
|
setSilentMode ( ) : void |
switches 'silent' mode on |
|
startPhase ( $phase ) : void |
called when a story starts a new phase |
|
startPhaseGroup ( string $activity, string $name ) : void |
called when we start playing a new PhaseGroup |
|
startStoryplayer ( string $version, string $url, string $copyright, string $license ) : void |
called when storyplayer starts |
|
usePluginAsConsole ( Console $plugin ) : void |
make a plugin the one that we use when writing to the user's
console |
|
usePluginInSlot ( OutputPlugin $plugin, string $slotName ) |
set the plugin for a named output slot |
|