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

[feature/system-cron] Added @param/@return documentation

Also adjusted some function descriptions for greater informativity.

PHPBB3-9596
This commit is contained in:
Oleg Pudeyev
2010-12-19 23:56:43 +01:00
parent 47702b8ca7
commit 53dd847dd5
14 changed files with 98 additions and 11 deletions

View File

@@ -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();