[feature/dic] Add a doc block for the prune_forum cron task forum_data

PHPBB3-10739
This commit is contained in:
Igor Wiedler 2012-08-25 17:16:20 +02:00
parent 919b13460d
commit c6e522afb6

View file

@ -31,6 +31,14 @@ class phpbb_cron_task_core_prune_forum extends phpbb_cron_task_base implements p
protected $config; protected $config;
protected $db; 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; protected $forum_data;
public function __construct($phpbb_root_path, $php_ext, phpbb_config $config, dbal $db) public function __construct($phpbb_root_path, $php_ext, phpbb_config $config, dbal $db)