MediaWiki  master
EtcdConfig Class Reference

Interface for configuration instances. More...

Inheritance diagram for EtcdConfig:
Collaboration diagram for EtcdConfig:

Public Member Functions

 __construct (array $params)
 
 fetchAllFromEtcd ()
 
 get ( $name)
 Get a configuration variable such as "Sitename" or "UploadMaintenance.". More...
 
 getModifiedIndex ()
 
 has ( $name)
 Check whether a configuration option is set for the given name. More...
 
 setLogger (LoggerInterface $logger)
 

Protected Member Functions

 fetchAllFromEtcdServer (string $address, ?int $port=null)
 
 parseDirectory ( $dirName, $dirNode, &$config)
 Recursively parse a directory node and populate the array passed by reference, throwing EtcdConfigParseError if there is a validation error. More...
 
 parseResponse ( $rbody)
 Parse a response body, throwing EtcdConfigParseError if there is a validation error. More...
 

Detailed Description

Interface for configuration instances.

Since
1.29

Definition at line 32 of file EtcdConfig.php.

Constructor & Destructor Documentation

◆ __construct()

EtcdConfig::__construct ( array  $params)
Parameters
array$paramsParameter 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.

Member Function Documentation

◆ 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$addressHost
?int$port Port
Returns
array (containing the keys config, error, retry, modifiedIndex)

Definition at line 260 of file EtcdConfig.php.

References true.

◆ get()

EtcdConfig::get (   $name)

Get a configuration variable such as "Sitename" or "UploadMaintenance.".

Parameters
string$nameName of configuration option
Returns
mixed Value configured
Exceptions
ConfigException

Implements Config.

Definition at line 139 of file EtcdConfig.php.

◆ getModifiedIndex()

EtcdConfig::getModifiedIndex ( )

Definition at line 149 of file EtcdConfig.php.

◆ has()

EtcdConfig::has (   $name)

Check whether a configuration option is set for the given name.

Parameters
string$nameName 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$dirNameThe relative directory name
array$dirNodeThe decoded directory node
array&$configThe 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

Parse a response body, throwing EtcdConfigParseError if there is a validation error.

Parameters
string$rbody
Returns
array

Definition at line 299 of file EtcdConfig.php.

◆ setLogger()

EtcdConfig::setLogger ( LoggerInterface  $logger)

Definition at line 128 of file EtcdConfig.php.


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