Merge pull request #2509 from Stephannos/ticket/12602

[ticket/12602] Add command to print the cron list

* Stephannos/ticket/12602:
  [ticket/12602] Fix language key removal.
  [ticket/12602] Rectify language keys.
  [ticket/12602] Fix test mistake.
  [ticket/12602] Fix language var mistakes.
  [ticket/12602] Add types, change description of cron:list.
  [ticket/12602] Fix internationalisation of cron_list.php
  [ticket/12602] Fix spaces issues.
  [ticket/12602] Coding style correction.
  [ticket/12602] Fix coding style mistakes.
  [ticket/12602] Headers updated.
  [ticket/12602] Changes to respect coding style and to factorize code.
  [ticket/12602] Cleanup tests
  [ticket/12602] Add function get_tasks.
  [ticket/12602] Correction of the output message for the cron list
  [ticket/12602] Add files to print the cron list and test files.

phpBB/phpbb/console/command/cron/cron_list.php

@@ -0,0 +1,90 @@
+<?php
+/**
+*
+* This file is part of the phpBB Forum Software package.
+*
+* @copyright (c) phpBB Limited <https://www.phpbb.com>
+* @license GNU General Public License, version 2 (GPL-2.0)
+*
+* For full copyright and license information, please see
+* the docs/CREDITS.txt file.
+*
+*/
+namespace phpbb\console\command\cron;
+
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class cron_list extends \phpbb\console\command\command
+{
+	/** @var \phpbb\cron\manager */
+	protected $cron_manager;
+
+	/** @var \phpbb\user */
+	protected $user;
+
+	public function __construct(\phpbb\cron\manager $cron_manager, \phpbb\user $user)
+	{
+		$this->cron_manager = $cron_manager;
+		$this->user = $user;
+		parent::__construct();
+	}
+
+	protected function configure()
+	{
+		$this
+			->setName('cron:list')
+			->setDescription($this->user->lang('CLI_DESCRIPTION_CRON_LIST'))
+		;
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output)
+	{
+		$tasks = $this->cron_manager->get_tasks();
+
+		if (empty($tasks))
+		{
+			$output->writeln($this->user->lang('CRON_NO_TASKS'));
+			return;
+		}
+
+		$ready_tasks = array();
+		$not_ready_tasks = array();
+		foreach ($tasks as $task)
+		{
+			if ($task->is_ready())
+			{
+				$ready_tasks[] = $task;
+			}
+			else
+			{
+				$not_ready_tasks[] = $task;
+			}
+		}
+
+		if (!empty($ready_tasks))
+		{
+			$output->writeln('<info>' . $this->user->lang('TASKS_READY') . '</info>');
+			$this->print_tasks_names($ready_tasks, $output);
+		}
+
+		if (!empty($ready_tasks) && !empty($not_ready_tasks))
+		{
+			$output->writeln('');
+		}
+
+		if (!empty($not_ready_tasks))
+		{
+			$output->writeln('<info>' . $this->user->lang('TASKS_NOT_READY') . '</info>');
+			$this->print_tasks_names($not_ready_tasks, $output);
+		}
+	}
+
+	protected function print_tasks_names(array $tasks, OutputInterface $output)
+	{
+		foreach ($tasks as $task)
+		{
+			$output->writeln($task->get_name());
+		}
+	}
+}

phpBB/phpbb/cron/manager.php

@@ -121,6 +121,16 @@ class manager
 		return null;
 	}
 
+	/**
+	* Find all tasks and return them.
+	*
+	* @return array List of all tasks.
+	*/
+	public function get_tasks()
+	{
+		return $this->tasks;
+	}
+
 	/**
 	* Wraps a task inside an instance of \phpbb\cron\task\wrapper.
 	*