Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
core\lock\lock_config Class Reference

Lock configuration class, used to get an instance of the currently configured lock factory. More...

Static Public Member Functions

static get_lock_factory (string $type)
 Get an instance of the currently configured locking subclass.
 
static get_lock_factory_class ()
 Get the currently configured locking subclass.
 

Detailed Description

Lock configuration class, used to get an instance of the currently configured lock factory.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ get_lock_factory()

static core\lock\lock_config::get_lock_factory ( string $type)
static

Get an instance of the currently configured locking subclass.

Parameters
string$type- Unique namespace for the locks generated by this factory. e.g. core_cron
Return values
core\lock\lock_factory
Exceptions
coding_exception

◆ get_lock_factory_class()

static core\lock\lock_config::get_lock_factory_class ( )
static

Get the currently configured locking subclass.

Return values
stringclass name
Exceptions
coding_exception

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