diff options
| author | Oleg Pudeyev <oleg@bsdpower.com> | 2010-12-19 23:56:43 +0100 |
|---|---|---|
| committer | Oleg Pudeyev <oleg@bsdpower.com> | 2011-02-12 22:05:53 -0500 |
| commit | 53dd847dd582930c84518d77a805468543e32ad0 (patch) | |
| tree | 51a2a1e49c7eaf0bf084df7fa5b1731a2bd6be69 /phpBB/includes/cron/task/task.php | |
| parent | 47702b8ca72aeaa2b33dd13f2aa762ae7271c10a (diff) | |
| download | forums-53dd847dd582930c84518d77a805468543e32ad0.tar forums-53dd847dd582930c84518d77a805468543e32ad0.tar.gz forums-53dd847dd582930c84518d77a805468543e32ad0.tar.bz2 forums-53dd847dd582930c84518d77a805468543e32ad0.tar.xz forums-53dd847dd582930c84518d77a805468543e32ad0.zip | |
[feature/system-cron] Added @param/@return documentation
Also adjusted some function descriptions for greater informativity.
PHPBB3-9596
Diffstat (limited to 'phpBB/includes/cron/task/task.php')
| -rw-r--r-- | phpBB/includes/cron/task/task.php | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/phpBB/includes/cron/task/task.php b/phpBB/includes/cron/task/task.php index 72fda91dd0..58c4a96f8e 100644 --- a/phpBB/includes/cron/task/task.php +++ b/phpBB/includes/cron/task/task.php @@ -49,6 +49,15 @@ interface phpbb_cron_task /** * Returns whether this cron task can be run in shutdown function. * + * By the time shutdown sequence invokes a particular piece of code, + * resources that that code requires may already be released. + * If so, a particular cron task may be marked shutdown function- + * unsafe, and it will be executed in normal program flow. + * + * Generally speaking cron tasks should start off as shutdown function- + * safe, and only be marked shutdown function-unsafe if a problem + * is discovered. + * * @return bool */ public function is_shutdown_function_safe(); |