makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-07-26 11:58:53 +00:00
Code Issues Projects Releases Packages Wiki Activity

[feature/system-cron] Add phpDoc documentation for phpbb_cron_manager class.

Browse source 
PHPBB3-9596
This commit is contained in:
Andreas Fischer 2010-12-17 01:15:57 +01:00 • committed by Oleg Pudeyev
parent 134afe36e2
commit f4f8523ca3
1 changed files with 38 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -24,8 +24,19 @@ if (!defined('IN_PHPBB'))
*/ */
class phpbb_cron_manager class phpbb_cron_manager
{ {
/**
* Set of phpbb_cron_task_wrapper objects.
* Array holding all tasks that have been found.
*
* @var array
*/
private $tasks = array(); private $tasks = array();
/**
* Constructor. Loads all available tasks.
*
* @return void
*/
public function __construct() public function __construct()
{ {
$task_names = $this->find_cron_task_names(); $task_names = $this->find_cron_task_names();
@ -43,6 +54,8 @@ class phpbb_cron_manager
* Cron task is expected to be a class named phpbb_cron_task_${mod}_${name}. * Cron task is expected to be a class named phpbb_cron_task_${mod}_${name}.
* *
* Todo: consider caching found task file list in global cache. * Todo: consider caching found task file list in global cache.
*
* @return array Array of strings
*/ */
public function find_cron_task_names() public function find_cron_task_names()
{ {
@ -82,13 +95,26 @@ class phpbb_cron_manager
} }
/** /**
* Checks whether $name is a valid identifier, and therefore part of valid cron task class name. * Checks whether $name is a valid identifier, and
* therefore part of valid cron task class name.
*
* @param string $name Name to check
*
* @return int
*/ */
public function is_valid_name($name) public function is_valid_name($name)
{ {
return preg_match('/^[a-zA-Z][a-zA-Z0-9_]*$/', $name); return preg_match('/^[a-zA-Z][a-zA-Z0-9_]*$/', $name);
} }
/**
* Loads tasks given by name, wraps them
* and puts them into $this->tasks.
*
* @param array $task_names Array of strings
*
* @return void
*/
public function load_tasks($task_names) public function load_tasks($task_names)
{ {
foreach ($task_names as $task_name) foreach ($task_names as $task_name)
@ -102,8 +128,9 @@ class phpbb_cron_manager
/** /**
* Finds a task that is ready to run. * Finds a task that is ready to run.
*
* If several tasks are ready, any one of them could be returned. * If several tasks are ready, any one of them could be returned.
*
* @return phpbb_cron_task_wrapper|null
*/ */
public function find_one_ready_task() public function find_one_ready_task()
{ {
@ -119,6 +146,8 @@ class phpbb_cron_manager
/** /**
* Finds all tasks that are ready to run. * Finds all tasks that are ready to run.
*
* @return array Array of phpbb_cron_task_wrapper
*/ */
public function find_all_ready_tasks() public function find_all_ready_tasks()
{ {
@ -135,8 +164,9 @@ class phpbb_cron_manager
/** /**
* Finds a task by name. * Finds a task by name.
*
* Web runner uses this method to resolve names to tasks. * Web runner uses this method to resolve names to tasks.
*
* @return array|null Array of phpbb_cron_task_wrapper
*/ */
public function find_task($name) public function find_task($name)
{ {
@ -152,10 +182,12 @@ class phpbb_cron_manager
/** /**
* Creates an instance of parametrized cron task $name with args $args. * Creates an instance of parametrized cron task $name with args $args.
*
* $name is the task name, which is the same as cron task class name.
* $args will be passed to the task class's constructor.
* The constructed task is wrapped with cron task wrapper before being returned. * The constructed task is wrapped with cron task wrapper before being returned.
*
* @param string $name The task name, which is the same as cron task class name.
* @param array $args Will be passed to the task class's constructor.
*
* @return phpbb_cron_task_wrapper|null
*/ */
public function instantiate_task($name, $args) public function instantiate_task($name, $args)
{ {