MediaWiki  master
GlobalVarConfig Class Reference

Accesses configuration settings from $GLOBALS. More...

Inheritance diagram for GlobalVarConfig:
Collaboration diagram for GlobalVarConfig:

Public Member Functions

 __construct ( $prefix='wg')
 
 get ( $name)
 
 has ( $name)
 

Static Public Member Functions

static newInstance ()
 Default builder function. More...
 

Protected Member Functions

 getWithPrefix ( $prefix, $name)
 Get a variable with a given prefix, if not the defaults. More...
 
 hasWithPrefix ( $prefix, $name)
 Check if a variable with a given prefix is set. More...
 

Private Attributes

string $prefix
 Prefix to use for configuration variables. More...
 

Detailed Description

Accesses configuration settings from $GLOBALS.

Since
1.23

Definition at line 28 of file GlobalVarConfig.php.

Constructor & Destructor Documentation

◆ __construct()

GlobalVarConfig::__construct (   $prefix = 'wg')

Definition at line 44 of file GlobalVarConfig.php.

References $prefix.

Member Function Documentation

◆ get()

GlobalVarConfig::get (   $name)

Implements Config.

Definition at line 51 of file GlobalVarConfig.php.

References $name, getWithPrefix(), and has().

◆ getWithPrefix()

GlobalVarConfig::getWithPrefix (   $prefix,
  $name 
)
protected

Get a variable with a given prefix, if not the defaults.

Parameters
string$prefixPrefix to use on the variable, if one.
string$nameVariable name without prefix
Returns
mixed

Definition at line 72 of file GlobalVarConfig.php.

References $GLOBALS, and $name.

Referenced by get().

◆ has()

GlobalVarConfig::has (   $name)

Implements Config.

Definition at line 61 of file GlobalVarConfig.php.

References $name, and hasWithPrefix().

Referenced by get().

◆ hasWithPrefix()

GlobalVarConfig::hasWithPrefix (   $prefix,
  $name 
)
protected

Check if a variable with a given prefix is set.

Parameters
string$prefixPrefix to use on the variable
string$nameVariable name without prefix
Returns
bool

Definition at line 83 of file GlobalVarConfig.php.

References $GLOBALS, and $name.

Referenced by has().

◆ newInstance()

static GlobalVarConfig::newInstance ( )
static

Default builder function.

Returns
GlobalVarConfig

Definition at line 40 of file GlobalVarConfig.php.

Referenced by GlobalVarConfigTest\testNewInstance(), and ConfigFactoryTest\testRegisterInstance().

Member Data Documentation

◆ $prefix

string GlobalVarConfig::$prefix
private

Prefix to use for configuration variables.

Definition at line 34 of file GlobalVarConfig.php.

Referenced by __construct().


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