PHP Class DataSift\Storyplayer\PlayerLib\StoryTeller

all actions and tests inside a story are executed through an instance of this class, making this class the StoryTeller :)
See link: http://datasift.github.io/storyplayer
Author: Stuart Herbert ([email protected])
Afficher le fichier Open project: datasift/storyplayer Class Usage Examples

Protected Properties

Свойство Type Description
$self StoryTeller singleton instance of StoryTeller

Méthodes publiques

Méthode Description
__call ( string $methodName, array $methodArgs ) : mixed
__construct ( DataSift\Storyplayer\Injectables $injectables )
closeAllOpenActions ( ) : void
convertDataForOutput ( $data ) : void
getActionLogger ( ) : Action_Logger
getActiveConfig ( ) : ActiveConfig
getCheckpoint ( ) : Story_Checkpoint
getConfig ( ) : object
getCurrentPhase ( ) : Phase
getCurrentPhaseName ( ) : string
getDeviceAdapter ( ) : DataSift\Storyplayer\DeviceLib\DeviceAdapter
getDeviceDetails ( ) : DataSift\Stone\ObjectLib\BaseObject
getDeviceName ( ) : string
getEnvironment ( ) : FromEnvironment
getEnvironmentName ( ) : void
getNewCommandRunner ( ) : CommandRunner
getOutput ( ) : Output
getPageContext ( ) : PageContext
getParams ( ) : array
getPersistDevice ( ) : boolean
getPersistProcesses ( ) : boolean
getPersistTestEnvironment ( ) : boolean
getPhaseLoader ( ) : PhaseLoader
getRunningDevice ( ) : DataSift\WebDriver\WebDriverSession
getRuntimeConfig ( ) : object
getRuntimeConfigManager ( ) : RuntimeConfigManager
getScriptFilename ( ) : string
getStory ( ) : Story
getSystemUnderTestConfig ( ) ------------------------------------------------------------------
getTestEnvironmentConfig ( ) : object
getTestEnvironmentName ( ) : string
getTestEnvironmentSignature ( ) : string
getTestUsers ( ) : DataSift\Stone\ObjectLib\BaseObject return the list of test users
getTestUsersFileIsReadOnly ( ) : boolean should we treat the file on disk where we loaded test user data from as read-only?
getTestUsersFilename ( ) : string retrieve the filename we loaded test users from
hasTestUsers ( ) : boolean have we loaded any test users from disk?
instance ( )
saveRuntimeConfig ( ) : void
setActionLogger ( Action_Logger $actionLogger ) : StoryTeller
setCheckpoint ( Story_Checkpoint $checkpoint ) : StoryTeller
setConfig ( $config ) : void
setCurrentPhase ( Phase $newPhase ) : void
setDataFormatter ( $dataFormatter )
setDevice ( string $deviceName, DataSift\Stone\ObjectLib\BaseObject $deviceDetails )
setDeviceAdapter ( DataSift\Storyplayer\DeviceLib\DeviceAdapter | null $adapter )
setOutput ( Output $output ) : void
setPageContext ( PageContext $pageContext ) : StoryTeller
setPersistDevice ( ) : void
setPersistProcesses ( ) : void
setPersistTestEnvironment ( ) : void
setPhaseLoader ( $phaseLoader )
setProseLoader ( $proseLoader ) : void
setRuntimeConfig ( $runtimeConfig ) : void
setRuntimeConfigManager ( RuntimeConfigManager $runtimeConfigManager ) : StoryTeller
setScriptFilename ( $filename ) : void
setStory ( Story $story ) : StoryTeller track the story that we are testing
setTestUsers ( DataSift\Stone\ObjectLib\BaseObject $users ) remember the test users that we have
setTestUsersFileIsReadOnly ( boolean $readOnly = true ) set whether or not we treat the file on disk were we loaded test user data from as read-only
setTestUsersFilename ( string $filename ) remember the filename we loaded test users from
startAction ( $text ) : Action_LogItem
startDevice ( ) : void
stopDevice ( ) : void

Method Details

__call() public méthode

public __call ( string $methodName, array $methodArgs ) : mixed
$methodName string
$methodArgs array
Résultat mixed

__construct() public méthode

public __construct ( DataSift\Storyplayer\Injectables $injectables )
$injectables DataSift\Storyplayer\Injectables

closeAllOpenActions() public méthode

public closeAllOpenActions ( ) : void
Résultat void

convertDataForOutput() public méthode

public convertDataForOutput ( $data ) : void
Résultat void

getActionLogger() public méthode

public getActionLogger ( ) : Action_Logger
Résultat Action_Logger

getActiveConfig() public méthode

public getActiveConfig ( ) : ActiveConfig
Résultat DataSift\Storyplayer\ConfigLib\ActiveConfig

getCheckpoint() public méthode

public getCheckpoint ( ) : Story_Checkpoint
Résultat Story_Checkpoint

getConfig() public méthode

public getConfig ( ) : object
Résultat object

getCurrentPhase() public méthode

public getCurrentPhase ( ) : Phase
Résultat DataSift\Storyplayer\Phases\Phase

getCurrentPhaseName() public méthode

public getCurrentPhaseName ( ) : string
Résultat string

getDeviceAdapter() public méthode

public getDeviceAdapter ( ) : DataSift\Storyplayer\DeviceLib\DeviceAdapter
Résultat DataSift\Storyplayer\DeviceLib\DeviceAdapter

getDeviceDetails() public méthode

public getDeviceDetails ( ) : DataSift\Stone\ObjectLib\BaseObject
Résultat DataSift\Stone\ObjectLib\BaseObject

getDeviceName() public méthode

public getDeviceName ( ) : string
Résultat string

getEnvironment() public méthode

public getEnvironment ( ) : FromEnvironment
Résultat Prose\FromEnvironment

getEnvironmentName() public méthode

public getEnvironmentName ( ) : void
Résultat void

getNewCommandRunner() public méthode

public getNewCommandRunner ( ) : CommandRunner
Résultat DataSift\Storyplayer\CommandLib\CommandRunner

getOutput() public méthode

public getOutput ( ) : Output
Résultat DataSift\Storyplayer\Output

getPageContext() public méthode

public getPageContext ( ) : PageContext
Résultat Prose\PageContext

getParams() public méthode

public getParams ( ) : array
Résultat array

getPersistDevice() public méthode

public getPersistDevice ( ) : boolean
Résultat boolean

getPersistProcesses() public méthode

public getPersistProcesses ( ) : boolean
Résultat boolean

getPersistTestEnvironment() public méthode

public getPersistTestEnvironment ( ) : boolean
Résultat boolean

getPhaseLoader() public méthode

public getPhaseLoader ( ) : PhaseLoader
Résultat PhaseLoader

getRunningDevice() public méthode

public getRunningDevice ( ) : DataSift\WebDriver\WebDriverSession
Résultat DataSift\WebDriver\WebDriverSession

getRuntimeConfig() public méthode

public getRuntimeConfig ( ) : object
Résultat object

getRuntimeConfigManager() public méthode

public getRuntimeConfigManager ( ) : RuntimeConfigManager
Résultat DataSift\Storyplayer\Cli\RuntimeConfigManager

getScriptFilename() public méthode

public getScriptFilename ( ) : string
Résultat string

getStory() public méthode

public getStory ( ) : Story
Résultat Story

getSystemUnderTestConfig() public méthode

------------------------------------------------------------------
public getSystemUnderTestConfig ( )

getTestEnvironmentConfig() public méthode

public getTestEnvironmentConfig ( ) : object
Résultat object

getTestEnvironmentName() public méthode

public getTestEnvironmentName ( ) : string
Résultat string

getTestEnvironmentSignature() public méthode

public getTestEnvironmentSignature ( ) : string
Résultat string

getTestUsers() public méthode

return the list of test users
public getTestUsers ( ) : DataSift\Stone\ObjectLib\BaseObject
Résultat DataSift\Stone\ObjectLib\BaseObject

getTestUsersFileIsReadOnly() public méthode

NOTE: we never treat the loaded data as read-only. Stories are free to change this data, and these changes will persist between stories. We just won't save any changes back to disk if this method call returns TRUE.
public getTestUsersFileIsReadOnly ( ) : boolean
Résultat boolean

getTestUsersFilename() public méthode

retrieve the filename we loaded test users from
public getTestUsersFilename ( ) : string
Résultat string

hasTestUsers() public méthode

have we loaded any test users from disk?
public hasTestUsers ( ) : boolean
Résultat boolean TRUE if we have

instance() public static méthode

public static instance ( )

saveRuntimeConfig() public méthode

public saveRuntimeConfig ( ) : void
Résultat void

setActionLogger() public méthode

public setActionLogger ( Action_Logger $actionLogger ) : StoryTeller
$actionLogger Action_Logger
Résultat StoryTeller

setCheckpoint() public méthode

public setCheckpoint ( Story_Checkpoint $checkpoint ) : StoryTeller
$checkpoint Story_Checkpoint
Résultat StoryTeller

setConfig() public méthode

public setConfig ( $config ) : void
Résultat void

setCurrentPhase() public méthode

public setCurrentPhase ( Phase $newPhase ) : void
$newPhase DataSift\Storyplayer\Phases\Phase
Résultat void

setDataFormatter() public méthode

public setDataFormatter ( $dataFormatter )

setDevice() public méthode

public setDevice ( string $deviceName, DataSift\Stone\ObjectLib\BaseObject $deviceDetails )
$deviceName string
$deviceDetails DataSift\Stone\ObjectLib\BaseObject

setDeviceAdapter() public méthode

public setDeviceAdapter ( DataSift\Storyplayer\DeviceLib\DeviceAdapter | null $adapter )
$adapter DataSift\Storyplayer\DeviceLib\DeviceAdapter | null

setOutput() public méthode

public setOutput ( Output $output ) : void
$output DataSift\Storyplayer\Output
Résultat void

setPageContext() public méthode

public setPageContext ( PageContext $pageContext ) : StoryTeller
$pageContext Prose\PageContext
Résultat StoryTeller

setPersistDevice() public méthode

public setPersistDevice ( ) : void
Résultat void

setPersistProcesses() public méthode

public setPersistProcesses ( ) : void
Résultat void

setPersistTestEnvironment() public méthode

public setPersistTestEnvironment ( ) : void
Résultat void

setPhaseLoader() public méthode

public setPhaseLoader ( $phaseLoader )

setProseLoader() public méthode

public setProseLoader ( $proseLoader ) : void
Résultat void

setRuntimeConfig() public méthode

public setRuntimeConfig ( $runtimeConfig ) : void
Résultat void

setRuntimeConfigManager() public méthode

public setRuntimeConfigManager ( RuntimeConfigManager $runtimeConfigManager ) : StoryTeller
$runtimeConfigManager DataSift\Storyplayer\Cli\RuntimeConfigManager
Résultat StoryTeller

setScriptFilename() public méthode

public setScriptFilename ( $filename ) : void
Résultat void

setStory() public méthode

NOTE: setting the story also creates a new Story_Result object so that we can track how the story is getting on
public setStory ( Story $story ) : StoryTeller
$story Story
Résultat StoryTeller

setTestUsers() public méthode

remember the test users that we have
public setTestUsers ( DataSift\Stone\ObjectLib\BaseObject $users )
$users DataSift\Stone\ObjectLib\BaseObject our test users

setTestUsersFileIsReadOnly() public méthode

NOTE: we never treat the loaded data as read-only. Stories are free to change this data, and these changes will persist between stories. We just won't save any changes back to disk if you set this to TRUE.
public setTestUsersFileIsReadOnly ( boolean $readOnly = true )
$readOnly boolean TRUE if we should not save data back to this file

setTestUsersFilename() public méthode

we'll re-use this filename later on when it is time to save the test users back to disk
public setTestUsersFilename ( string $filename )
$filename string the filename to remember

startAction() public méthode

public startAction ( $text ) : Action_LogItem
Résultat Action_LogItem

startDevice() public méthode

public startDevice ( ) : void
Résultat void

stopDevice() public méthode

public stopDevice ( ) : void
Résultat void

Property Details

$self protected_oe static_oe property

singleton instance of StoryTeller
protected static StoryTeller,DataSift\Storyplayer\PlayerLib $self
Résultat StoryTeller