phpBB API Documentation
Class

phpbb\config\config

class config implements ArrayAccess, IteratorAggregate, Countable

Configuration container class

Methods

__construct(array $config)

Creates a configuration container with a default set of values

ArrayIterator getIterator()

Retrieves an ArrayIterator over the configuration values.

bool offsetExists(string $key)

Checks if the specified config value exists.

string offsetGet(string $key)

Retrieves a configuration value.

offsetSet(string $key, string $value)

Temporarily overwrites the value of a configuration variable.

offsetUnset(string $key)

Called when deleting a configuration value directly, triggers an error.

int count()

Retrieves the number of configuration options currently set.

null delete(String $key, bool $use_cache = true)

Removes a configuration option

set(string $key, string $value, bool $use_cache = true)

Sets a configuration option's value

bool set_atomic(string $key, string $old_value, string $new_value, bool $use_cache = true)

Sets a configuration option's value only if the old_value matches the current configuration value or the configuration value does not exist yet.

bool ensure_lock(string $key, string $new_value)

Checks configuration option's value only if the newvalue matches the current configuration value and the configuration value does exist.Called only after setatomic has been called.

increment(string $key, int $increment, bool $use_cache = true)

Increments an integer configuration value.

Details

at line 32
public __construct(array $config)

Creates a configuration container with a default set of values

Parameters

array $config => string) $config The configuration data.

at line 42
public ArrayIterator getIterator()

Retrieves an ArrayIterator over the configuration values.

Return Value

ArrayIterator An iterator over all config data

at line 53
public bool offsetExists(string $key)

Checks if the specified config value exists.

Parameters

string $key The configuration option's name.

Return Value

bool Whether the configuration option exists.

at line 64
public string offsetGet(string $key)

Retrieves a configuration value.

Parameters

string $key The configuration option's name.

Return Value

string The configuration value

at line 78
public offsetSet(string $key, string $value)

Temporarily overwrites the value of a configuration variable.

The configuration change will not persist. It will be lost after the request.

Parameters

string $key The configuration option's name.
string $value The temporary value.

at line 88
public offsetUnset(string $key)

Called when deleting a configuration value directly, triggers an error.

Parameters

string $key The configuration option's name.

at line 98
public int count()

Retrieves the number of configuration options currently set.

Return Value

int Number of config options

at line 111
public null delete(String $key, bool $use_cache = true)

Removes a configuration option

Parameters

String $key The configuration option's name
bool $use_cache Whether this variable should be cached or if it changes too frequently to be efficiently cached

Return Value

null

at line 124
public set(string $key, string $value, bool $use_cache = true)

Sets a configuration option's value

Parameters

string $key The configuration option's name
string $value New configuration value
bool $use_cache Whether this variable should be cached or if it changes too frequently to be efficiently cached.

at line 140
public bool set_atomic(string $key, string $old_value, string $new_value, bool $use_cache = true)

Sets a configuration option's value only if the old_value matches the current configuration value or the configuration value does not exist yet.

Parameters

string $key The configuration option's name
string $old_value Current configuration value
string $new_value New configuration value
bool $use_cache Whether this variable should be cached or if it changes too frequently to be efficiently cached.

Return Value

bool True if the value was changed, false otherwise.

at line 160
public bool ensure_lock(string $key, string $new_value)

Checks configuration option's value only if the newvalue matches the current configuration value and the configuration value does exist.Called only after setatomic has been called.

Parameters

string $key The configuration option's name
string $new_value New configuration value

Return Value

bool True if the value was changed, false otherwise.

Exceptions

http_exception when config value is set and not equal to new_value.

at line 177
public increment(string $key, int $increment, bool $use_cache = true)

Increments an integer configuration value.

Parameters

string $key The configuration option's name
int $increment Amount to increment by
bool $use_cache Whether this variable should be cached or if it changes too frequently to be efficiently cached.