PHP Class DataSift\Storyplayer\Cli\PlayStory_Command

See link: http://datasift.github.io/storyplayer

Author: Stuart Herbert ([email protected])

Inheritance: extends BaseCommand, implements DataSift\Storyplayer\Cli\CliSignalHandler

Datei anzeigen Open project: datasift/storyplayer

Protected Properties

Property	Type	Description
$envName	string	the environment that we have loaded
$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?
$playerList		our list of players 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
addStoriesFromFolder ( Phix_Project\CliEngine $engine, DataSift\Storyplayer\Injectables $injectables, $folder )
addStoryFromFile ( Phix_Project\CliEngine $engine, DataSift\Storyplayer\Injectables $injectables, $storyFile )	------------------------------------------------------------------
findStoriesInFolder ( $folder )
initPlayerList ( Phix_Project\CliEngine $cliEngine, DataSift\Storyplayer\Injectables $injectables, array $cliParams ) : void
initReporting ( Phix_Project\CliEngine $engine, DataSift\Storyplayer\Injectables $injectables ) : void
initSignalHandling ( DataSift\Storyplayer\Injectables $injectables ) : void
summariseStoryList ( $storyResults )	------------------------------------------------------------------

Method Details

__construct() public method

public __construct ( $injectables )

addStoriesFromFolder() protected method

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

addStoryFromFile() protected method

------------------------------------------------------------------

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

findStoriesInFolder() protected method

protected findStoriesInFolder ( $folder )

initPlayerList() protected method

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

initReporting() protected method

protected initReporting ( Phix_Project\CliEngine $engine, DataSift\Storyplayer\Injectables $injectables ) : void
$engine	Phix_Project\CliEngine
$injectables	DataSift\Storyplayer\Injectables
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

summariseStoryList() protected method

------------------------------------------------------------------

protected summariseStoryList ( $storyResults )

Property Details

$envName protected_oe property

the environment that we have loaded

protected string $envName
return	string

$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

$playerList protected_oe property

our list of players to execute

protected $playerList

$st protected_oe property

we need to track this for handling CTRL-C

protected $st