spunQ_IConfiguration Interface Reference

An interface for objects providing configuration options. More...

Inheritance diagram for spunQ_IConfiguration:

List of all members.

Public Member Functions
	getKeysStartingWith ($prefix)
	Returns configuration keys that start with given string.
	getStringsForPrefix ($prefix)
	Returns multiple strings, for which the key starts with given string.
	getStringValue ($key, $default=NULL)
	Returns the configuration value for a key.
	getMultipleStringValues ($prefix)
	Returns all key-value pairs where the key starts with given string.
	getBooleanValue ($key, $default=false)
	Returns the value of a boolean configuration key.
	getMultipleBooleanValues ($key)
	Multiple value version of getBooleanValue().
	getFileValue ($key, $default=NULL)
	Gets a spunQ_File.
	getMultipleFileValues ($key)
	Multiple value version of getFileValue().
	getFolderValue ($key, $default=NULL)
	Gets a spunQ_Folder.
	getMultipleFolderValues ($key)
	Multiple value version of getFolderValue().
	getLastModificationTime ()
	Returns the timestamp the configuration has been modified.

---

Detailed Description

An interface for objects providing configuration options.

For every function that retrieves a single value, there is one that returns multiple values of the same type.

Todo:

This should be in package init or similar

getMultipleStringValues

Definition at line 10 of file IConfiguration.interface.php.

---

Member Function Documentation

spunQ_IConfiguration::getBooleanValue	(	$	key,
		$	default = false
	)

Returns the value of a boolean configuration key.

Parameters:

	$key	The key string to get configuration value for.
	$default	The value to return if the key is not defined.

Returns:

boolean

Implemented in spunQ_Configuration.

spunQ_IConfiguration::getFileValue	(	$	key,
		$	default = NULL
	)

Gets a spunQ_File.

Parameters:

	$key	The key string to get configuration value for.
	$default	The value to return if the key is not defined.

Returns:

spunQ_File

Implemented in spunQ_Configuration.

spunQ_IConfiguration::getFolderValue	(	$	key,
		$	default = NULL
	)

Gets a spunQ_Folder.

Parameters:

	$key	The key string to get configuration value for.
	$default	The value to return if the key is not defined.

Returns:

spunQ_Folder

Implemented in spunQ_Configuration.

spunQ_IConfiguration::getKeysStartingWith

(

$

prefix

)

Returns configuration keys that start with given string.

Parameters:

$prefix

The string that a key must begin with to be returned.

Returns:

array<string> Array of configuration keys.

Implemented in spunQ_Configuration.

spunQ_IConfiguration::getLastModificationTime

(

)

Returns the timestamp the configuration has been modified.

Returns:

integer A unix timestamp

Implemented in spunQ_Configuration.

spunQ_IConfiguration::getMultipleBooleanValues

(

$

key

)

Multiple value version of getBooleanValue().

Parameters:

$key

The key string to get configuration value for.

Returns:

array<bool>

Implemented in spunQ_Configuration.

spunQ_IConfiguration::getMultipleFileValues

(

$

key

)

Multiple value version of getFileValue().

Parameters:

$key

The key string to get configuration value for.

Returns:

array<bool>

Implemented in spunQ_Configuration.

spunQ_IConfiguration::getMultipleFolderValues

(

$

key

)

Multiple value version of getFolderValue().

Parameters:

$key

The key string to get configuration value for.

Returns:

array<bool>

Implemented in spunQ_Configuration.

spunQ_IConfiguration::getMultipleStringValues

(

$

prefix

)

Returns all key-value pairs where the key starts with given string.

Parameters:

$prefix

Prefix to get keys for

Returns:

array Mapping keys to values.

Implemented in spunQ_Configuration.

spunQ_IConfiguration::getStringsForPrefix

(

$

prefix

)

Returns multiple strings, for which the key starts with given string.

Parameters:

$prefix

The string that a key must begin with to be returned.

Returns:

array<string> Associative array mapping keys to string values. The keys all have their prefix stripped.

Implemented in spunQ_Configuration.

spunQ_IConfiguration::getStringValue	(	$	key,
		$	default = NULL
	)

Returns the configuration value for a key.

Parameters:

	$key	The key string to get configuration value for.
	$default	The value to return if the key is not defined.

Returns:

string

Implemented in spunQ_Configuration.

---

The documentation for this interface was generated from the following file:

• IConfiguration.interface.php