PHP Class DataSift\Storyplayer\ConfigLib\HardCodedList

Exibir arquivo Open project: datasift/storyplayer Class Usage Examples

Public Methods

Method Description
__construct ( string $configType ) constructor
addConfig ( object $config ) add a new config object to the list
getConfigType ( ) : string returns the classname for the config data that we store
getConfigs ( ) : array return our list of configs
newConfig ( string $name ) : object create a new config object, and return it to be modified
setConfigType ( string $configType ) what kind of config are we a list of?

Method Details

__construct() public method

constructor
public __construct ( string $configType )
$configType string what type of config are we a list of?

addConfig() public method

add a new config object to the list
public addConfig ( object $config )
$config object the config object to add to the list

getConfigType() public method

returns the classname for the config data that we store
public getConfigType ( ) : string
return string

getConfigs() public method

return our list of configs
public getConfigs ( ) : array
return array

newConfig() public method

the returned object has already been added to our list, and does not need to be added manually
public newConfig ( string $name ) : object
$name string the name of this new config entry
return object

setConfigType() public method

must be a valid class name
public setConfigType ( string $configType )
$configType string the class name for the data that we are a list of