diff options
| author | Andreas Fischer <bantu@phpbb.com> | 2010-12-16 03:14:41 +0100 |
|---|---|---|
| committer | Oleg Pudeyev <oleg@bsdpower.com> | 2011-02-12 22:05:52 -0500 |
| commit | 134afe36e2c9734ccc6ed6be5a1896c41dc52227 (patch) | |
| tree | 1dd5b76c615f30fba08dd0ff22e0fc7b678008fa /phpBB/includes/cron | |
| parent | 6fc11184e7d2fd2a46d915738ae7f686c8547433 (diff) | |
| download | forums-134afe36e2c9734ccc6ed6be5a1896c41dc52227.tar forums-134afe36e2c9734ccc6ed6be5a1896c41dc52227.tar.gz forums-134afe36e2c9734ccc6ed6be5a1896c41dc52227.tar.bz2 forums-134afe36e2c9734ccc6ed6be5a1896c41dc52227.tar.xz forums-134afe36e2c9734ccc6ed6be5a1896c41dc52227.zip | |
[feature/system-cron] Add phpDoc documentation for phpbb_cron_lock class.
PHPBB3-9596
Diffstat (limited to 'phpBB/includes/cron')
| -rw-r--r-- | phpBB/includes/cron/lock.php | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/phpBB/includes/cron/lock.php b/phpBB/includes/cron/lock.php index b407191922..b2ba89ad6c 100644 --- a/phpBB/includes/cron/lock.php +++ b/phpBB/includes/cron/lock.php @@ -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() { |