1
0
mirror of https://github.com/phpbb/phpbb.git synced 2025-07-31 14:00:31 +02:00

[feature/system-cron] Add phpDoc documentation for phpbb_cron_lock class.

PHPBB3-9596
This commit is contained in:
Andreas Fischer
2010-12-16 03:14:41 +01:00
committed by Oleg Pudeyev
parent 6fc11184e7
commit 134afe36e2

View File

@@ -21,8 +21,20 @@ if (!defined('IN_PHPBB'))
*/
class phpbb_cron_lock
{
/**
* Unique identifier for this lock.
*
* @var string
*/
private $cron_id;
/**
* Tries to acquire the cron lock by updating
* the 'cron_lock' configuration variable in the database.
*
* @return bool true if lock was acquired
* false otherwise
*/
public function lock()
{
global $config, $db;
@@ -67,6 +79,8 @@ class phpbb_cron_lock
* Releases cron lock.
*
* Attempting to release a cron lock that is already released is harmless.
*
* @return void
*/
public function unlock()
{