LockManagerGroup Class Reference

Class to handle file lock manager registration. More...

Public Member Functions
	config ( $name)
	Get the config array for a lock manager object with a given name. More...
	get ( $name)
	Get the lock manager object with a given name. More...
	getAny ()
	Get the default lock manager configured for the site or at least some other effective configured lock manager. More...
	getDefault ()
	Get the default lock manager configured for the site. More...

Static Public Member Functions
static	destroySingletons ()
	Destroy the singleton instances. More...
static	singleton ( $domain=false)

Protected Member Functions
	__construct ( $domain)
	initFromGlobals ()
	Register lock managers from the global variables. More...
	register (array $configs)
	Register an array of file lock manager configurations. More...

Protected Attributes
	$domain
array	$managers = array()
	of (name => ('class' => ..., 'config' => ..., 'instance' => ...)) * More...

Static Protected Attributes
static	$instances = array()

Detailed Description

Class to handle file lock manager registration.

Author

Aaron Schulz

Since

1.19

Definition at line 31 of file LockManagerGroup.php.

Constructor & Destructor Documentation

__construct()

LockManagerGroup::__construct (   $domain )

protected

Parameters

string

$domain

Domain (usually wiki ID)

Definition at line 42 of file LockManagerGroup.php.

References $domain.

Member Function Documentation

config()

LockManagerGroup::config

(

$name

)

Get the config array for a lock manager object with a given name.

Parameters

string

$name

Returns

array

Exceptions

MWException

Definition at line 130 of file LockManagerGroup.php.

References $name, and array().

destroySingletons()

static LockManagerGroup::destroySingletons ( )

static

Destroy the singleton instances.

Definition at line 63 of file LockManagerGroup.php.

References array().

Referenced by ForkController\prepareEnvironment().

get()

LockManagerGroup::get

(

$name

)

Get the lock manager object with a given name.

Parameters

string

$name

Returns

LockManager

Exceptions

MWException

Definition at line 109 of file LockManagerGroup.php.

References $name.

getAny()

LockManagerGroup::getAny

(

)

Get the default lock manager configured for the site or at least some other effective configured lock manager.

Throws an exception if no lock manager could be found.

Returns

LockManager

Exceptions

MWException

Definition at line 159 of file LockManagerGroup.php.

getDefault()

LockManagerGroup::getDefault

(

)

Get the default lock manager configured for the site.

Returns NullLockManager if no lock manager could be found.

Returns

LockManager

Definition at line 145 of file LockManagerGroup.php.

References array().

initFromGlobals()

LockManagerGroup::initFromGlobals ( )

protected

Register lock managers from the global variables.

Definition at line 70 of file LockManagerGroup.php.

References $wgLockManagers, and global.

register()

LockManagerGroup::register ( array  $configs )

protected

Register an array of file lock manager configurations.

Parameters

array

$configs

Exceptions

MWException

Definition at line 82 of file LockManagerGroup.php.

References $domain, $name, array(), and as.

singleton()

static LockManagerGroup::singleton (   $domain = false )

static

Parameters

bool | string

$domain

Domain (usually wiki ID). Default: false.

Returns

LockManagerGroup

Definition at line 50 of file LockManagerGroup.php.

References $domain, false, and wfWikiID().

Referenced by FSRepo\__construct(), FileBackend\__construct(), FileBackendGroup\get(), StoreBatchTest\setUp(), and FileBackendTest\setUp().

Member Data Documentation

$domain

LockManagerGroup::$domain

protected

Definition at line 35 of file LockManagerGroup.php.

Referenced by __construct(), register(), and singleton().

$instances

LockManagerGroup::$instances = array()

staticprotected

Definition at line 33 of file LockManagerGroup.php.

$managers

array LockManagerGroup::$managers = array()

protected

of (name => ('class' => ..., 'config' => ..., 'instance' => ...)) *

Definition at line 37 of file LockManagerGroup.php.

---

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

• includes/filebackend/lockmanager/LockManagerGroup.php