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/ -> installation_lock_factory.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: | 111 lines (3 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
installation_lock_factory:: (9 methods):
__construct()
supports_timeout()
supports_auto_release()
is_available()
supports_recursion()
get_debug_info()
get_lock()
release_lock()
extend_lock()
Class: installation_lock_factory - X-Ref
Lock factory for use during installation.| __construct($type) X-Ref |
| Create this lock factory. param: string $type - The type, e.g. cron, cache, session |
| supports_timeout() X-Ref |
| Return information about the blocking behaviour of the lock type on this platform. return: boolean - False if attempting to get a lock will block indefinitely. |
| supports_auto_release() X-Ref |
| This lock type will be automatically released when a process ends. return: boolean - True |
| is_available() X-Ref |
| This lock factory is only available during the initial installation. To use it at any other time would be potentially dangerous. return: boolean |
| supports_recursion() X-Ref |
| get_debug_info() X-Ref |
| Get some info that might be useful for debugging. return: boolean - string |
| get_lock($resource, $timeout, $maxlifetime = 86400) X-Ref |
| Get a lock within the specified timeout or return false. param: string $resource - The identifier for the lock. Should use frankenstyle prefix. param: int $timeout - The number of seconds to wait for a lock before giving up. param: int $maxlifetime - Unused by this lock type. return: boolean - true if a lock was obtained. |
| release_lock(lock $lock) X-Ref |
| Release a lock that was previously obtained with @lock. param: lock $lock - A lock obtained from this factory. return: boolean - true if the lock is no longer held (including if it was never held). |
| extend_lock() X-Ref |
