PHP 클래스 DataSift\Storyplayer\DefinitionLib\TestEnvironment_Definition

저자: Stuart Herbert ([email protected])
파일 보기 프로젝트 열기: datasift/storyplayer 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$groups array a list of all of the groups of hosts in our test environment
$moduleSettings null | object these settings apply to any host in any group in this environment
$name string the name of this test environment

공개 메소드들

메소드 설명
__construct ( string $name ) create a new test environment definition
getConfig ( ) : DataSift\Stone\ObjectLib\BaseObject what does our definition look like, as a config structure?
getModuleSettings ( ) : null | object get the current module settings for this test environment
getName ( ) : string what is the name of this test environment?
hasModuleSettings ( ) : boolean do we have any module settings?
mergeSystemUnderTestConfig ( $sutConfig ) ------------------------------------------------------------------
newGroup ( integer | string $groupId, Storyplayer\TestEnvironments\GroupAdapter $groupAdapter ) : TestEnvironmentGroup create a new group of hosts
setModuleSettings ( object $newSettings ) tell us the module settings you want to apply to this test environment
setName ( string $name ) set the name of this test environment

메소드 상세

__construct() 공개 메소드

create a new test environment definition
public __construct ( string $name )
$name string the name to assign to this test environment

getConfig() 공개 메소드

IMPORTANT: we make sure that the data we return is a read-only copy of our definition. At the time of writing, we're not sure if other parts of SPv2 will break as a result.
public getConfig ( ) : DataSift\Stone\ObjectLib\BaseObject
리턴 DataSift\Stone\ObjectLib\BaseObject

getModuleSettings() 공개 메소드

get the current module settings for this test environment
public getModuleSettings ( ) : null | object
리턴 null | object

getName() 공개 메소드

what is the name of this test environment?
public getName ( ) : string
리턴 string

hasModuleSettings() 공개 메소드

do we have any module settings?
public hasModuleSettings ( ) : boolean
리턴 boolean

mergeSystemUnderTestConfig() 공개 메소드

------------------------------------------------------------------
public mergeSystemUnderTestConfig ( $sutConfig )

newGroup() 공개 메소드

create a new group of hosts
public newGroup ( integer | string $groupId, Storyplayer\TestEnvironments\GroupAdapter $groupAdapter ) : TestEnvironmentGroup
$groupId integer | string the ID of this group
$groupAdapter Storyplayer\TestEnvironments\GroupAdapter the adapter for this group
리턴 TestEnvironmentGroup a new and empty group, ready for you to define

setModuleSettings() 공개 메소드

tell us the module settings you want to apply to this test environment
public setModuleSettings ( object $newSettings )
$newSettings object the settings to apply

setName() 공개 메소드

set the name of this test environment
public setName ( string $name )
$name string the new name for this test environment

프로퍼티 상세

$groups 보호되어 있는 프로퍼티

a list of all of the groups of hosts in our test environment
protected array $groups
리턴 array

$moduleSettings 보호되어 있는 프로퍼티

these settings apply to any host in any group in this environment
protected null|object $moduleSettings
리턴 null | object

$name 보호되어 있는 프로퍼티

the name of this test environment
protected string $name
리턴 string