LockManagerGroup Class Reference

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

Public Member Functions
	__construct ( $domain, array $lockManagerConfigs)
	Do not call this directly. More...
	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...

Protected Attributes
string	$domain
	domain (usually wiki ID) More...
array	$managers = []
	Array of (name => ('class' => ..., 'config' => ..., 'instance' => ...)) More...

Detailed Description

Class to handle file lock manager registration.

Since

1.19

Definition at line 31 of file LockManagerGroup.php.

Constructor & Destructor Documentation

__construct()

LockManagerGroup::__construct	(		$domain,
		array	$lockManagerConfigs
	)

Do not call this directly.

Use LockManagerGroupFactory.

Parameters

string	$domain	Domain (usually wiki ID)
array[]	$lockManagerConfigs	In format of $wgLockManagers

Definition at line 44 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

Exception

Definition at line 97 of file LockManagerGroup.php.

get()

LockManagerGroup::get

(

$name

)

Get the lock manager object with a given name.

Parameters

string

$name

Returns

LockManager

Exceptions

Exception

Definition at line 73 of file LockManagerGroup.php.

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.

Deprecated:

since 1.35, seemingly unused, just call get() and catch any exception instead

Returns

LockManager

Exceptions

Exception

Definition at line 132 of file LockManagerGroup.php.

References wfDeprecated().

getDefault()

LockManagerGroup::getDefault

(

)

Get the default lock manager configured for the site.

Returns NullLockManager if no lock manager could be found.

Deprecated:

since 1.35, seemingly unused, just call get() and catch any exception instead

Returns

LockManager

Definition at line 114 of file LockManagerGroup.php.

References wfDeprecated().

Member Data Documentation

$domain

string LockManagerGroup::$domain

protected

domain (usually wiki ID)

Definition at line 33 of file LockManagerGroup.php.

Referenced by __construct().

$managers

array LockManagerGroup::$managers = []

protected

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

Definition at line 36 of file LockManagerGroup.php.

---

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

• includes/filebackend/lockmanager/LockManagerGroup.php