PHP Класс DataSift\Storyplayer\PlayerLib\StoryTeller

all actions and tests inside a story are executed through an instance of this class, making this class the StoryTeller :)
Автор: Stuart Herbert ([email protected])
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$self StoryTeller singleton instance of StoryTeller

Открытые методы

Метод Описание
__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

Описание методов

__call() публичный Метод

public __call ( string $methodName, array $methodArgs ) : mixed
$methodName string
$methodArgs array
Результат mixed

__construct() публичный Метод

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

closeAllOpenActions() публичный Метод

public closeAllOpenActions ( ) : void
Результат void

convertDataForOutput() публичный Метод

public convertDataForOutput ( $data ) : void
Результат void

getActionLogger() публичный Метод

public getActionLogger ( ) : Action_Logger
Результат Action_Logger

getActiveConfig() публичный Метод

public getActiveConfig ( ) : ActiveConfig
Результат DataSift\Storyplayer\ConfigLib\ActiveConfig

getCheckpoint() публичный Метод

public getCheckpoint ( ) : Story_Checkpoint
Результат Story_Checkpoint

getConfig() публичный Метод

public getConfig ( ) : object
Результат object

getCurrentPhase() публичный Метод

public getCurrentPhase ( ) : Phase
Результат DataSift\Storyplayer\Phases\Phase

getCurrentPhaseName() публичный Метод

public getCurrentPhaseName ( ) : string
Результат string

getDeviceAdapter() публичный Метод

public getDeviceAdapter ( ) : DataSift\Storyplayer\DeviceLib\DeviceAdapter
Результат DataSift\Storyplayer\DeviceLib\DeviceAdapter

getDeviceDetails() публичный Метод

public getDeviceDetails ( ) : DataSift\Stone\ObjectLib\BaseObject
Результат DataSift\Stone\ObjectLib\BaseObject

getDeviceName() публичный Метод

public getDeviceName ( ) : string
Результат string

getEnvironment() публичный Метод

public getEnvironment ( ) : FromEnvironment
Результат Prose\FromEnvironment

getEnvironmentName() публичный Метод

public getEnvironmentName ( ) : void
Результат void

getNewCommandRunner() публичный Метод

public getNewCommandRunner ( ) : CommandRunner
Результат DataSift\Storyplayer\CommandLib\CommandRunner

getOutput() публичный Метод

public getOutput ( ) : Output
Результат DataSift\Storyplayer\Output

getPageContext() публичный Метод

public getPageContext ( ) : PageContext
Результат Prose\PageContext

getParams() публичный Метод

public getParams ( ) : array
Результат array

getPersistDevice() публичный Метод

public getPersistDevice ( ) : boolean
Результат boolean

getPersistProcesses() публичный Метод

public getPersistProcesses ( ) : boolean
Результат boolean

getPersistTestEnvironment() публичный Метод

public getPersistTestEnvironment ( ) : boolean
Результат boolean

getPhaseLoader() публичный Метод

public getPhaseLoader ( ) : PhaseLoader
Результат PhaseLoader

getRunningDevice() публичный Метод

public getRunningDevice ( ) : DataSift\WebDriver\WebDriverSession
Результат DataSift\WebDriver\WebDriverSession

getRuntimeConfig() публичный Метод

public getRuntimeConfig ( ) : object
Результат object

getRuntimeConfigManager() публичный Метод

public getRuntimeConfigManager ( ) : RuntimeConfigManager
Результат DataSift\Storyplayer\Cli\RuntimeConfigManager

getScriptFilename() публичный Метод

public getScriptFilename ( ) : string
Результат string

getStory() публичный Метод

public getStory ( ) : Story
Результат Story

getSystemUnderTestConfig() публичный Метод

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

getTestEnvironmentConfig() публичный Метод

public getTestEnvironmentConfig ( ) : object
Результат object

getTestEnvironmentName() публичный Метод

public getTestEnvironmentName ( ) : string
Результат string

getTestEnvironmentSignature() публичный Метод

public getTestEnvironmentSignature ( ) : string
Результат string

getTestUsers() публичный Метод

return the list of test users
public getTestUsers ( ) : DataSift\Stone\ObjectLib\BaseObject
Результат DataSift\Stone\ObjectLib\BaseObject

getTestUsersFileIsReadOnly() публичный Метод

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
Результат boolean

getTestUsersFilename() публичный Метод

retrieve the filename we loaded test users from
public getTestUsersFilename ( ) : string
Результат string

hasTestUsers() публичный Метод

have we loaded any test users from disk?
public hasTestUsers ( ) : boolean
Результат boolean TRUE if we have

instance() публичный статический Метод

public static instance ( )

saveRuntimeConfig() публичный Метод

public saveRuntimeConfig ( ) : void
Результат void

setActionLogger() публичный Метод

public setActionLogger ( Action_Logger $actionLogger ) : StoryTeller
$actionLogger Action_Logger
Результат StoryTeller

setCheckpoint() публичный Метод

public setCheckpoint ( Story_Checkpoint $checkpoint ) : StoryTeller
$checkpoint Story_Checkpoint
Результат StoryTeller

setConfig() публичный Метод

public setConfig ( $config ) : void
Результат void

setCurrentPhase() публичный Метод

public setCurrentPhase ( Phase $newPhase ) : void
$newPhase DataSift\Storyplayer\Phases\Phase
Результат void

setDataFormatter() публичный Метод

public setDataFormatter ( $dataFormatter )

setDevice() публичный Метод

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

setDeviceAdapter() публичный Метод

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

setOutput() публичный Метод

public setOutput ( Output $output ) : void
$output DataSift\Storyplayer\Output
Результат void

setPageContext() публичный Метод

public setPageContext ( PageContext $pageContext ) : StoryTeller
$pageContext Prose\PageContext
Результат StoryTeller

setPersistDevice() публичный Метод

public setPersistDevice ( ) : void
Результат void

setPersistProcesses() публичный Метод

public setPersistProcesses ( ) : void
Результат void

setPersistTestEnvironment() публичный Метод

public setPersistTestEnvironment ( ) : void
Результат void

setPhaseLoader() публичный Метод

public setPhaseLoader ( $phaseLoader )

setProseLoader() публичный Метод

public setProseLoader ( $proseLoader ) : void
Результат void

setRuntimeConfig() публичный Метод

public setRuntimeConfig ( $runtimeConfig ) : void
Результат void

setRuntimeConfigManager() публичный Метод

public setRuntimeConfigManager ( RuntimeConfigManager $runtimeConfigManager ) : StoryTeller
$runtimeConfigManager DataSift\Storyplayer\Cli\RuntimeConfigManager
Результат StoryTeller

setScriptFilename() публичный Метод

public setScriptFilename ( $filename ) : void
Результат void

setStory() публичный Метод

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
Результат StoryTeller

setTestUsers() публичный Метод

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

setTestUsersFileIsReadOnly() публичный Метод

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() публичный Метод

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 startAction ( $text ) : Action_LogItem
Результат Action_LogItem

startDevice() публичный Метод

public startDevice ( ) : void
Результат void

stopDevice() публичный Метод

public stopDevice ( ) : void
Результат void

Описание свойств

$self защищенное статическое свойство

singleton instance of StoryTeller
protected static StoryTeller,DataSift\Storyplayer\PlayerLib $self
Результат StoryTeller