Interface for configuration instances.
More...
Interface for configuration instances.
- Since
- 1.29
Definition at line 32 of file EtcdConfig.php.
◆ __construct()
EtcdConfig::__construct |
( |
array | $params | ) |
|
- Parameters
-
array | $params | Parameter map:
- host: the host address
- directory: the etc "directory" were MediaWiki specific variables are located
- service: service name used in SRV discovery. Defaults to 'etcd'. [optional]
- port: custom host port [optional]
- protocol: one of ("http", "https"). Defaults to http. [optional]
- cache: BagOStuff instance or ObjectFactory spec thereof for a server cache. The cache will also be used as a fallback if etcd is down. [optional]
- cacheTTL: logical cache TTL in seconds [optional]
- skewTTL: maximum seconds to randomly lower the assigned TTL on cache save [optional]
- timeout: seconds to wait for etcd before throwing an error [optional]
|
Definition at line 74 of file EtcdConfig.php.
◆ fetchAllFromEtcd()
EtcdConfig::fetchAllFromEtcd |
( |
| ) |
|
- Returns
- array (containing the keys config, error, retry, modifiedIndex)
Definition at line 239 of file EtcdConfig.php.
◆ fetchAllFromEtcdServer()
EtcdConfig::fetchAllFromEtcdServer |
( |
string | $address, |
|
|
?int | $port = null ) |
|
protected |
- Parameters
-
string | $address | Host |
?int | $port | Port |
- Returns
- array (containing the keys config, error, retry, modifiedIndex)
Definition at line 260 of file EtcdConfig.php.
References true.
◆ get()
Get a configuration variable such as "Sitename" or "UploadMaintenance.".
- Parameters
-
string | $name | Name of configuration option |
- Returns
- mixed Value configured
- Exceptions
-
Implements Config.
Definition at line 139 of file EtcdConfig.php.
◆ getModifiedIndex()
EtcdConfig::getModifiedIndex |
( |
| ) |
|
◆ has()
Check whether a configuration option is set for the given name.
- Parameters
-
string | $name | Name of configuration option |
- Returns
- bool
- Since
- 1.24
Implements Config.
Definition at line 133 of file EtcdConfig.php.
◆ parseDirectory()
EtcdConfig::parseDirectory |
( |
| $dirName, |
|
|
| $dirNode, |
|
|
& | $config ) |
|
protected |
Recursively parse a directory node and populate the array passed by reference, throwing EtcdConfigParseError if there is a validation error.
- Parameters
-
string | $dirName | The relative directory name |
array | $dirNode | The decoded directory node |
array | &$config | The output array |
- Returns
- int lastModifiedIndex The maximum last modified index across all keys in the directory
Definition at line 322 of file EtcdConfig.php.
References unserialize().
◆ parseResponse()
EtcdConfig::parseResponse |
( |
| $rbody | ) |
|
|
protected |
◆ setLogger()
EtcdConfig::setLogger |
( |
LoggerInterface | $logger | ) |
|
The documentation for this class was generated from the following file: