Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
- Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
- PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.
/lib/classes/lock/ -> lock.php (source)
Differences Between: [Versions 310 and 403] [Versions 311 and 403] [Versions 39 and 403] [Versions 400 and 403] [Versions 401 and 403] [Versions 402 and 403]
(no description)
| File Size: | 124 lines (4 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
lock:: (6 methods):
__construct()
init_factory()
get_key()
extend()
release()
__destruct()
Class representing a lock
The methods available for a specific lock type are only known by it's factory.
The methods available for a specific lock type are only known by it's factory.
| __construct($key, $factory) X-Ref |
| Construct a lock containing the unique key required to release it. param: mixed $key - The lock key. The type of this is up to the lock_factory being used. param: lock_factory $factory - The factory that generated this lock. |
| init_factory(lock_factory $factory) X-Ref |
| Sets the lock factory that owns a lock. This function should not be called under normal use. It is intended only for cases like {@see timing_wrapper_lock_factory} where we wrap a lock factory. When used, it should be called immediately after constructing the lock. param: lock_factory $factory New lock factory that owns this lock |
| get_key() X-Ref |
| Return the unique key representing this lock. return: string|int lock key. |
| extend() X-Ref |
| release() X-Ref |
| Release this lock return: bool |
| __destruct() X-Ref |
| Print debugging if this lock falls out of scope before being released. |
