PHPXRef 0.7.1 : MediaWiki-1.24.0 : Detail view of LBFactory.php

[Source view] [Print] [Project Stats]

Generator of database load balancing objects. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

File Size:	386 lines (10 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 3 classes

LBFactorySimple:: (7 methods):
  __construct()
  newMainLB()
  getMainLB()
  newExternalLB()
  getExternalLB()
  forEachLB()
  shutdown()

LBFactoryFake:: (6 methods):
  __construct()
  newMainLB()
  getMainLB()
  newExternalLB()
  getExternalLB()
  forEachLB()

DBAccessError:: (1 method):
__construct()

Defines 1 function

  disableBackend()
  singleton()
  getLBFactoryClass()
  destroyInstance()
  setInstance()
  shutdown()
  forEachLBCallMethod()
  callMethod()
  commitMasterChanges()
  rollbackMasterChanges()
  hasMasterChanges()

Class: LBFactorySimple - X-Ref

A simple single-master LBFactory that gets its configuration from the b/c globals

__construct( $conf ) X-Ref

No description

newMainLB( $wiki = false ) X-Ref

param: bool|string $wiki
return: LoadBalancer

getMainLB( $wiki = false ) X-Ref

param: bool|string $wiki
return: LoadBalancer

newExternalLB( $cluster, $wiki = false ) X-Ref

param: string $cluster
param: bool|string $wiki
return: LoadBalancer

getExternalLB( $cluster, $wiki = false ) X-Ref

param: string $cluster
param: bool|string $wiki
return: array

forEachLB( $callback, $params = array() X-Ref

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.

param: callable $callback
param: array $params

shutdown() X-Ref

No description

Class: LBFactoryFake - X-Ref

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

__construct( $conf ) X-Ref

No description

newMainLB( $wiki = false ) X-Ref

No description

getMainLB( $wiki = false ) X-Ref

No description

newExternalLB( $cluster, $wiki = false ) X-Ref

No description

getExternalLB( $cluster, $wiki = false ) X-Ref

No description

forEachLB( $callback, $params = array() X-Ref

No description

Class: DBAccessError - X-Ref

Exception class for attempted DB access

__construct() X-Ref

No description

Functions

Functions that are not part of a class:

disableBackend() X-Ref

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

singleton() X-Ref

Get an LBFactory instance

return: LBFactory

getLBFactoryClass( array $config ) X-Ref

Returns the LBFactory class to use and the load balancer configuration.

param: array $config (e.g. $wgLBFactoryConf)
return: string Class name

destroyInstance() X-Ref

Shut down, close connections and destroy the cached instance.

setInstance( $instance ) X-Ref

Set the instance to be the given object

param: LBFactory $instance

shutdown() X-Ref

Prepare all tracked load balancers for shutdown
STUB

forEachLBCallMethod( $methodName, $args = array() X-Ref

Call a method of each tracked load balancer

param: string $methodName
param: array $args

callMethod( $loadBalancer, $methodName, $args ) X-Ref

Private helper for forEachLBCallMethod

param: LoadBalancer $loadBalancer
param: string $methodName
param: array $args

commitMasterChanges() X-Ref

Commit changes on all master connections