An interface for generating database load balancers. More...

Inheritance diagram for LBFactory:

[legend]

Public Member Functions
	__construct ( $conf)
	Construct a factory based on a configuration array (typically from $wgLBFactoryConf) More...

	callMethod ( $loadBalancer, $methodName, $args)
	Private helper for forEachLBCallMethod. More...

	commitMasterChanges ()
	Commit changes on all master connections. More...

	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. More...

	forEachLBCallMethod ( $methodName, $args=array())
	Call a method of each tracked load balancer. More...

&	getExternalLB ( $cluster, $wiki=false)
	Get a cached (tracked) load balancer for external storage. More...

	getMainLB ( $wiki=false)
	Get a cached (tracked) load balancer object. More...

	hasMasterChanges ()
	Detemine if any master connection has pending changes. More...

	newExternalLB ( $cluster, $wiki=false)
	Create a new load balancer for external storage. More...

	newMainLB ( $wiki=false)
	Create a new load balancer object. More...

	rollbackMasterChanges ()
	Rollback changes on all master connections. More...

	shutdown ()
	Prepare all tracked load balancers for shutdown STUB. More...

Static Public Member Functions
static	destroyInstance ()
	Shut down, close connections and destroy the cached instance. More...

static	disableBackend ()
	Disables all access to the load balancer, will cause all database access to throw a DBAccessError. More...

static	getLBFactoryClass (array $config)
	Returns the LBFactory class to use and the load balancer configuration. More...

static	setInstance ( $instance)
	Set the instance to be the given object. More...

static &	singleton ()
	Get an LBFactory instance. More...

Static Protected Attributes
static	$instance

Detailed Description

An interface for generating database load balancers.

Definition at line 28 of file LBFactory.php.

Constructor & Destructor Documentation

◆ __construct()

LBFactory::__construct ( $conf )

abstract

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

Parameters

array $conf

Reimplemented in LBFactoryFake, LBFactorySimple, LBFactoryMulti, and LBFactorySingle.

Member Function Documentation

◆ callMethod()

LBFactory::callMethod	(	$loadBalancer,
		$methodName,
		$args
	)

Private helper for forEachLBCallMethod.

Parameters

LoadBalancer	$loadBalancer
string	$methodName
	$args

Definition at line 184 of file LBFactory.php.

References $args, and array().

◆ commitMasterChanges()

LBFactory::commitMasterChanges ( )

Commit changes on all master connections.

Definition at line 191 of file LBFactory.php.

References forEachLBCallMethod().

Referenced by LBFactorySimple\shutdown(), and LBFactoryMulti\shutdown().

◆ destroyInstance()

static LBFactory::destroyInstance ( )

static

Shut down, close connections and destroy the cached instance.

Definition at line 90 of file LBFactory.php.

Referenced by Maintenance\finalSetup(), and setInstance().

◆ disableBackend()

static LBFactory::disableBackend ( )

static

Disables all access to the load balancer, will cause all database access to throw a DBAccessError.

Definition at line 36 of file LBFactory.php.

References global.

Referenced by Installer\__construct().

◆ forEachLB()

LBFactory::forEachLB	(	$callback,
		$params = `array()`
	)

abstract

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