makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-28 22:28:51 +00:00
Code Issues Projects Releases Packages Wiki Activity

[feature/system-cron] Added documentation for cron manager constructor.

Browse source 
PHPBB3-9596
This commit is contained in:
Oleg Pudeyev 2011-01-18 17:03:45 -05:00
parent 92c278d39a
commit 4e689c522f
1 changed files with 15 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
phpBB/includes/cron/manager.php
View file

@ -33,7 +33,9 @@ class phpbb_cron_manager
protected $tasks = array(); protected $tasks = array();
/** /**
* Directory containing cron tasks * Path to the root of directory tree with tasks.
* For bundled phpBB tasks, this is the path to includes/cron/tasks
* under phpBB root.
* @var string * @var string
*/ */
protected $task_path; protected $task_path;
@ -53,9 +55,21 @@ class phpbb_cron_manager
/** /**
* Constructor. Loads all available tasks. * Constructor. Loads all available tasks.
* *
* Tasks will be looked up in directory tree rooted at $task_path.
* Task classes will be autoloaded and must be named according to
* autoloading naming conventions. To load cron tasks shipped with
* phpbb, pass $phpbb_root_path . 'includes/cron/task' as $task_path.
*
* If $cache is given, names of found cron tasks will be cached in it
* for one hour. Note that the cron task names are stored without
* namespacing; if two different phbb_cron_manager instances are
* constructed with different $task_path arguments but the same $cache,
* the second instance will use task names found by the first instance.
*
* @param string $task_path Directory containing cron tasks * @param string $task_path Directory containing cron tasks
* @param string $phpEx PHP file extension * @param string $phpEx PHP file extension
* @param phpbb_cache_driver_interface $cache Cache for task names (optional) * @param phpbb_cache_driver_interface $cache Cache for task names (optional)
* @return void
*/ */
public function __construct($task_path, $phpEx, phpbb_cache_driver_interface $cache = null) public function __construct($task_path, $phpEx, phpbb_cache_driver_interface $cache = null)
{ {