1
0
mirror of https://github.com/phpbb/phpbb.git synced 2025-02-24 03:54:10 +01:00

[ticket/12715] Update console command cron:* comments

PHPBB3-12715
This commit is contained in:
Tristan Darricau 2014-06-15 12:26:23 +02:00
parent 413754af1f
commit 8966e4a269
2 changed files with 28 additions and 4 deletions

View File

@ -23,6 +23,12 @@ class cron_list extends \phpbb\console\command\command
/** @var \phpbb\user */
protected $user;
/**
* Constructor
*
* @param \phpbb\cron\manager $cron_manager Cron manager
* @param \phpbb\user $user User instance
*/
public function __construct(\phpbb\cron\manager $cron_manager, \phpbb\user $user)
{
$this->cron_manager = $cron_manager;
@ -30,6 +36,9 @@ class cron_list extends \phpbb\console\command\command
parent::__construct();
}
/**
* {@inheritdoc}
*/
protected function configure()
{
$this
@ -38,6 +47,16 @@ class cron_list extends \phpbb\console\command\command
;
}
/**
* Executes the command cron:list.
*
* Prints a list of ready and unready cron jobs.
*
* @param InputInterface $input An InputInterface instance
* @param OutputInterface $output An OutputInterface instance
*
* @return null
*/
protected function execute(InputInterface $input, OutputInterface $output)
{
$tasks = $this->cron_manager->get_tasks();
@ -80,6 +99,12 @@ class cron_list extends \phpbb\console\command\command
}
}
/**
* Print a list of cron jobs
*
* @param array $tasks A list of task to display
* @param OutputInterface $output An OutputInterface instance
*/
protected function print_tasks_names(array $tasks, OutputInterface $output)
{
foreach ($tasks as $task)

View File

@ -15,7 +15,6 @@ namespace phpbb\console\command\cron;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
class run extends \phpbb\console\command\command
@ -35,7 +34,7 @@ class run extends \phpbb\console\command\command
* @param \phpbb\cron\manager $cron_manager The cron manager containing
* the cron tasks to be executed.
* @param \phpbb\lock\db $lock_db The lock for accessing database.
* @param \phobb\user $user The user object (used to get language information)
* @param \phpbb\user $user The user object (used to get language information)
*/
public function __construct(\phpbb\cron\manager $cron_manager, \phpbb\lock\db $lock_db, \phpbb\user $user)
{
@ -102,7 +101,7 @@ class run extends \phpbb\console\command\command
}
}
/*
/**
* Executes all ready cron tasks.
*
* If verbose mode is set, an info message will be printed if there is no task to
@ -140,7 +139,7 @@ class run extends \phpbb\console\command\command
return 0;
}
/*
/**
* Executes a given cron task, if it is ready.
*
* If there is a task whose name matches $task_name, it is run and 0 is returned.