 |
Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
|
|
Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
|
Class representing a lock. More...
Public Member Functions | |
| __construct ($key, $factory) | |
| Construct a lock containing the unique key required to release it. | |
| __destruct () | |
| Print debugging if this lock falls out of scope before being released. | |
| extend ($maxlifetime=86400) | |
| Extend the lifetime of this lock. | |
| get_key () | |
| Return the unique key representing this lock. | |
| init_factory (lock_factory $factory) | |
| Sets the lock factory that owns a lock. | |
| release () | |
| Release this lock. | |
Protected Attributes | |
| string | $caller = 'unknown' |
| $caller Where was this called from? Stored for when a warning is shown | |
| lock_factory | $factory |
| $factory The factory that generated this lock | |
| string int | $key = '' |
| $key A unique key representing a held lock | |
| bool | $released |
| $released Has this lock been released? If a lock falls out of scope without being released - show a warning. | |
Class representing a lock.
The methods available for a specific lock type are only known by it's factory.
| core\lock\lock::__construct | ( | $key, | |
| $factory ) |
Construct a lock containing the unique key required to release it.
| mixed | $key | - The lock key. The type of this is up to the lock_factory being used. For file locks this is a file handle. For MySQL this is a string. |
| lock_factory | $factory | - The factory that generated this lock. |
| core\lock\lock::extend | ( | $maxlifetime = 86400 | ) |
Extend the lifetime of this lock.
Not supported by all factories.
| int | $maxlifetime | - the new lifetime for the lock (in seconds). |
| bool |
| core\lock\lock::get_key | ( | ) |
Return the unique key representing this lock.
| string|int | lock key. |
| core\lock\lock::init_factory | ( | lock_factory | $factory | ) |
Sets the lock factory that owns a lock.
This function should not be called under normal use. It is intended only for cases like {
When used, it should be called immediately after constructing the lock.
| lock_factory | $factory | New lock factory that owns this lock |
| core\lock\lock::release | ( | ) |
Release this lock.
| bool |
1.11.0