diff options
| author | Igor Wiedler <igor@wiedler.ch> | 2012-08-25 17:16:20 +0200 |
|---|---|---|
| committer | Igor Wiedler <igor@wiedler.ch> | 2012-08-25 17:16:20 +0200 |
| commit | c6e522afb6060a9294defe31eafc0130ee3aff15 (patch) | |
| tree | 5ff6915f30ef0995018650005a9339d514d71d1a /phpBB | |
| parent | 919b13460dad9562f877970b8679abdc7b78b07c (diff) | |
| download | forums-c6e522afb6060a9294defe31eafc0130ee3aff15.tar forums-c6e522afb6060a9294defe31eafc0130ee3aff15.tar.gz forums-c6e522afb6060a9294defe31eafc0130ee3aff15.tar.bz2 forums-c6e522afb6060a9294defe31eafc0130ee3aff15.tar.xz forums-c6e522afb6060a9294defe31eafc0130ee3aff15.zip | |
[feature/dic] Add a doc block for the prune_forum cron task forum_data
PHPBB3-10739
Diffstat (limited to 'phpBB')
| -rw-r--r-- | phpBB/includes/cron/task/core/prune_forum.php | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/phpBB/includes/cron/task/core/prune_forum.php b/phpBB/includes/cron/task/core/prune_forum.php index 428224a527..8bb13ffe36 100644 --- a/phpBB/includes/cron/task/core/prune_forum.php +++ b/phpBB/includes/cron/task/core/prune_forum.php @@ -31,6 +31,14 @@ class phpbb_cron_task_core_prune_forum extends phpbb_cron_task_base implements p protected $config; protected $db; + /** + * If $forum_data is given, it is assumed to contain necessary information + * about a single forum that is to be pruned. + * + * If $forum_data is not given, forum id will be retrieved via request_var + * and a database query will be performed to load the necessary information + * about the forum. + */ protected $forum_data; public function __construct($phpbb_root_path, $php_ext, phpbb_config $config, dbal $db) |