PHP Class DataSift\Storyplayer\Cli\Script_Command

See link: http://datasift.github.io/storyplayer
Author: Stuart Herbert ([email protected])
Inheritance: extends BaseCommand, implements DataSift\Storyplayer\Cli\CliSignalHandler
Exibir arquivo Open project: datasift/storyplayer

Protected Properties

Property Type Description
$injectables needed for when user presses CTRL+C
$output we track this for convenience
$persistProcesses boolean should we let background processes survive when we shutdown?
$scriptList our list of scripts to execute
$st we need to track this for handling CTRL-C

Public Methods

Method Description
__construct ( $injectables )
processCommand ( Phix_Project\CliEngine $engine, array $params = [], DataSift\Storyplayer\Injectables | null $injectables = null ) : integer
processInsideLegacyHandler ( Phix_Project\CliEngine $engine, $params = [], $injectables = null )
sigtermHandler ( integer $signo ) : void

Protected Methods

Method Description
addScriptFromFile ( Phix_Project\CliEngine $engine, DataSift\Storyplayer\Injectables $injectables, $storyFile ) ------------------------------------------------------------------
addScriptsFromFile ( Phix_Project\CliEngine $engine, DataSift\Storyplayer\Injectables $injectables, $file )
addScriptsFromFolder ( Phix_Project\CliEngine $engine, DataSift\Storyplayer\Injectables $injectables, $folder )
initScriptList ( Phix_Project\CliEngine $cliEngine, DataSift\Storyplayer\Injectables $injectables, array $cliParams ) : void
initSignalHandling ( DataSift\Storyplayer\Injectables $injectables ) : void

Method Details

__construct() public method

public __construct ( $injectables )

addScriptFromFile() protected method

------------------------------------------------------------------
protected addScriptFromFile ( Phix_Project\CliEngine $engine, DataSift\Storyplayer\Injectables $injectables, $storyFile )
$engine Phix_Project\CliEngine
$injectables DataSift\Storyplayer\Injectables

addScriptsFromFile() protected method

protected addScriptsFromFile ( Phix_Project\CliEngine $engine, DataSift\Storyplayer\Injectables $injectables, $file )
$engine Phix_Project\CliEngine
$injectables DataSift\Storyplayer\Injectables

addScriptsFromFolder() protected method

protected addScriptsFromFolder ( Phix_Project\CliEngine $engine, DataSift\Storyplayer\Injectables $injectables, $folder )
$engine Phix_Project\CliEngine
$injectables DataSift\Storyplayer\Injectables

initScriptList() protected method

protected initScriptList ( Phix_Project\CliEngine $cliEngine, DataSift\Storyplayer\Injectables $injectables, array $cliParams ) : void
$cliEngine Phix_Project\CliEngine
$injectables DataSift\Storyplayer\Injectables
$cliParams array
return void

initSignalHandling() protected method

protected initSignalHandling ( DataSift\Storyplayer\Injectables $injectables ) : void
$injectables DataSift\Storyplayer\Injectables
return void

processCommand() public method

public processCommand ( Phix_Project\CliEngine $engine, array $params = [], DataSift\Storyplayer\Injectables | null $injectables = null ) : integer
$engine Phix_Project\CliEngine
$params array
$injectables DataSift\Storyplayer\Injectables | null
return integer

processInsideLegacyHandler() public method

public processInsideLegacyHandler ( Phix_Project\CliEngine $engine, $params = [], $injectables = null )
$engine Phix_Project\CliEngine

sigtermHandler() public method

public sigtermHandler ( integer $signo ) : void
$signo integer
return void

Property Details

$injectables protected_oe property

needed for when user presses CTRL+C
protected $injectables

$output protected_oe property

we track this for convenience
protected $output

$persistProcesses protected_oe property

should we let background processes survive when we shutdown?
protected bool $persistProcesses
return boolean

$scriptList protected_oe property

our list of scripts to execute
protected $scriptList

$st protected_oe property

we need to track this for handling CTRL-C
protected $st