LockManagerGroup Class Reference

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

Collaboration diagram for LockManagerGroup:

List of all members.

Public Member Functions
	config ($name)
	Get the config array for a lock manager object with a given name.
	get ($name)
	Get the lock manager object with a given name.
	getAny ()
	Get the default lock manager configured for the site or at least some other effective configured lock manager.
	getDefault ()
	Get the default lock manager configured for the site.
Static Public Member Functions
static	destroySingletons ()
	Destroy the singleton instances.
static	singleton ($domain=false)
Protected Member Functions
	__construct ($domain)
	initFromGlobals ()
	Register lock managers from the global variables.
	register (array $configs)
	Register an array of file lock manager configurations.
Protected Attributes
	$domain
Array	$managers = array()
	of (name => ('class' => ..., 'config' => ..., 'instance' => ...)) *
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

LockManagerGroup::__construct

(

$

domain

)

[protected]

Parameters:

string

$domain

Domain (usually wiki ID)

Definition at line 42 of file LockManagerGroup.php.

---

Member Function Documentation

LockManagerGroup::config

(

$

name

)

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

Parameters:

$name

string

Returns:

Array

Exceptions:

MWException

Definition at line 133 of file LockManagerGroup.php.

static LockManagerGroup::destroySingletons

(

)

[static]

Destroy the singleton instances.

Returns:

void

Definition at line 64 of file LockManagerGroup.php.

Referenced by ForkController\prepareEnvironment().

LockManagerGroup::get

(

$

name

)

Get the lock manager object with a given name.

Parameters:

$name

string

Returns:

LockManager

Exceptions:

MWException

Definition at line 113 of file LockManagerGroup.php.

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 161 of file LockManagerGroup.php.

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 147 of file LockManagerGroup.php.

LockManagerGroup::initFromGlobals

(

)

[protected]

Register lock managers from the global variables.

Returns:

void

Definition at line 73 of file LockManagerGroup.php.

LockManagerGroup::register

(

array $

configs

)

[protected]

Register an array of file lock manager configurations.

Parameters:

$configs

Array

Returns:

void

Exceptions:

MWException

Definition at line 86 of file LockManagerGroup.php.

static LockManagerGroup::singleton

(

$

domain = false

)

[static]

Parameters:

string

$domain

Domain (usually wiki ID)

Returns:

LockManagerGroup

Definition at line 50 of file LockManagerGroup.php.

---

Member Data Documentation

LockManagerGroup::$domain [protected]

Definition at line 35 of file LockManagerGroup.php.

LockManagerGroup::$instances = array() [static, protected]

Definition at line 33 of file LockManagerGroup.php.

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