MediaWiki  1.32.5
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
EtcdConfig Class Reference

Interface for configuration instances. More...

Inheritance diagram for EtcdConfig:
Inheritance graph
[legend]
Collaboration diagram for EtcdConfig:
Collaboration graph
[legend]

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 ( $address)
 
 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...
 

Private Member Functions

 load ()
 
 unserialize ( $string)
 

Private Attributes

int $baseCacheTTL
 
string $directory
 
string $encoding
 
string $host
 
MultiHttpClient $http
 
LoggerInterface $logger
 
array $procCache
 
string $protocol
 
int $skewCacheTTL
 
BagOStuff $srvCache
 
int $timeout
 

Detailed Description

Interface for configuration instances.

Since
1.29

Definition at line 31 of file EtcdConfig.php.

Constructor & Destructor Documentation

◆ __construct()

EtcdConfig::__construct ( array  $params)
Parameters
array$paramsParameter map:
  • host: the host address and port
  • protocol: either http or https
  • directory: the etc "directory" were MediaWiki specific variables are located
  • encoding: one of ("JSON", "YAML"). Defaults to JSON. [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 68 of file EtcdConfig.php.

References $params, directory, and http.

Member Function Documentation

◆ fetchAllFromEtcd()

EtcdConfig::fetchAllFromEtcd ( )
Returns
array (containing the keys config, error, retry, modifiedIndex)

Definition at line 209 of file EtcdConfig.php.

References $host, $response, IP\combineHostAndPort(), and fetchAllFromEtcdServer().

Referenced by load().

◆ fetchAllFromEtcdServer()

EtcdConfig::fetchAllFromEtcdServer (   $address)
protected
Parameters
string$addressHost and port
Returns
array (containing the keys config, error, retry, modifiedIndex)

Definition at line 238 of file EtcdConfig.php.

References $e, $response, http, list, parseResponse(), and true.

Referenced by fetchAllFromEtcd().

◆ 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 112 of file EtcdConfig.php.

References $name, and load().

◆ getModifiedIndex()

EtcdConfig::getModifiedIndex ( )

Definition at line 122 of file EtcdConfig.php.

References load().

◆ 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 106 of file EtcdConfig.php.

References $name, and load().

◆ load()

EtcdConfig::load ( )
private
Exceptions
ConfigException

Definition at line 130 of file EtcdConfig.php.

References $baseCacheTTL, $skewCacheTTL, $timeout, directory, fetchAllFromEtcd(), IExpiringStore\TTL_INDEFINITE, and use.

Referenced by get(), getModifiedIndex(), and has().

◆ 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 292 of file EtcdConfig.php.

References $value, as, and unserialize().

Referenced by parseResponse().

◆ 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 269 of file EtcdConfig.php.

References parseDirectory().

Referenced by fetchAllFromEtcdServer().

◆ setLogger()

EtcdConfig::setLogger ( LoggerInterface  $logger)

Definition at line 101 of file EtcdConfig.php.

References $logger, and http.

◆ unserialize()

EtcdConfig::unserialize (   $string)
private
Parameters
string$string
Returns
mixed

Definition at line 326 of file EtcdConfig.php.

Referenced by parseDirectory().

Member Data Documentation

◆ $baseCacheTTL

int EtcdConfig::$baseCacheTTL
private

Definition at line 50 of file EtcdConfig.php.

Referenced by load().

◆ $directory

string EtcdConfig::$directory
private

Definition at line 46 of file EtcdConfig.php.

◆ $encoding

string EtcdConfig::$encoding
private

Definition at line 48 of file EtcdConfig.php.

◆ $host

string EtcdConfig::$host
private

Definition at line 42 of file EtcdConfig.php.

Referenced by fetchAllFromEtcd().

◆ $http

MultiHttpClient EtcdConfig::$http
private

Definition at line 33 of file EtcdConfig.php.

◆ $logger

LoggerInterface EtcdConfig::$logger
private

Definition at line 39 of file EtcdConfig.php.

Referenced by setLogger().

◆ $procCache

array EtcdConfig::$procCache
private

Definition at line 37 of file EtcdConfig.php.

◆ $protocol

string EtcdConfig::$protocol
private

Definition at line 44 of file EtcdConfig.php.

◆ $skewCacheTTL

int EtcdConfig::$skewCacheTTL
private

Definition at line 52 of file EtcdConfig.php.

Referenced by load().

◆ $srvCache

BagOStuff EtcdConfig::$srvCache
private

Definition at line 35 of file EtcdConfig.php.

◆ $timeout

int EtcdConfig::$timeout
private

Definition at line 54 of file EtcdConfig.php.

Referenced by load().

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