MediaWiki  REL1_19
LBFactory_Fake Class Reference

LBFactory class that throws an error on any attempt to use it. More...

Inheritance diagram for LBFactory_Fake:
Collaboration diagram for LBFactory_Fake:

List of all members.

Public Member Functions

 __construct ($conf)
 Construct a factory based on a configuration array (typically from $wgLBFactoryConf)
 forEachLB ($callback, $params=array())
 Execute a function for each tracked load balancer The callback is called with the load balancer as the first parameter, and $params passed as the subsequent parameters.
getExternalLB ($cluster, $wiki=false)
 Get a cached (tracked) load balancer for external storage.
 getMainLB ($wiki=false)
 Get a cached (tracked) load balancer object.
 newExternalLB ($cluster, $wiki=false)
 Create a new load balancer for external storage.
 newMainLB ($wiki=false)
 Create a new load balancer object.

Detailed Description

LBFactory class that throws an error on any attempt to use it.

This will typically be done via wfGetDB(). Call LBFactory::disableBackend() to start using this, and LBFactory::enableBackend() to return to normal behavior

Definition at line 269 of file LBFactory.php.


Constructor & Destructor Documentation

Construct a factory based on a configuration array (typically from $wgLBFactoryConf)

Parameters:
$conf

Reimplemented from LBFactory.

Definition at line 270 of file LBFactory.php.


Member Function Documentation

LBFactory_Fake::forEachLB ( callback,
params = array() 
)

Execute a function for each tracked load balancer The callback is called with the load balancer as the first parameter, and $params passed as the subsequent parameters.

Parameters:
$callbackstring|array
array$params

Reimplemented from LBFactory.

Definition at line 284 of file LBFactory.php.

& LBFactory_Fake::getExternalLB ( cluster,
wiki = false 
)

Get a cached (tracked) load balancer for external storage.

Parameters:
$clusterString: external storage cluster, or false for core
$wikiString: wiki ID, or false for the current wiki
Returns:
LoadBalancer

Reimplemented from LBFactory.

Definition at line 281 of file LBFactory.php.

Get a cached (tracked) load balancer object.

Parameters:
$wikiString: wiki ID, or false for the current wiki
Returns:
LoadBalancer

Reimplemented from LBFactory.

Definition at line 275 of file LBFactory.php.

LBFactory_Fake::newExternalLB ( cluster,
wiki = false 
)

Create a new load balancer for external storage.

The resulting object will be untracked, not chronology-protected, and the caller is responsible for cleaning it up.

Parameters:
$clusterString: external storage cluster, or false for core
$wikiString: wiki ID, or false for the current wiki
Returns:
LoadBalancer

Reimplemented from LBFactory.

Definition at line 278 of file LBFactory.php.

Create a new load balancer object.

The resulting object will be untracked, not chronology-protected, and the caller is responsible for cleaning it up.

Parameters:
$wikiString: wiki ID, or false for the current wiki
Returns:
LoadBalancer

Reimplemented from LBFactory.

Definition at line 272 of file LBFactory.php.


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