[feature/dic] Spaces to tabs, add useless docblocks

Fully documents the constructors of the processors and the cron tasks.

PHPBB3-10739

phpBB/includes/cron/task/core/prune_all_forums.php

@@ -31,6 +31,14 @@ class phpbb_cron_task_core_prune_all_forums extends phpbb_cron_task_base
 	protected $config;
 	protected $db;
 
+	/**
+	* Constructor.
+	*
+	* @param string $phpbb_root_path The root path
+	* @param string $php_ext The PHP extension
+	* @param phpbb_config $config The config
+	* @param dbal $db The db connection
+	*/
 	public function __construct($phpbb_root_path, $php_ext, phpbb_config $config, dbal $db)
 	{
 		$this->phpbb_root_path = $phpbb_root_path;

phpBB/includes/cron/task/core/prune_forum.php

@@ -41,6 +41,14 @@ class phpbb_cron_task_core_prune_forum extends phpbb_cron_task_base implements p
 	*/
 	protected $forum_data;
 
+	/**
+	* Constructor.
+	*
+	* @param string $phpbb_root_path The root path
+	* @param string $php_ext The PHP extension
+	* @param phpbb_config $config The config
+	* @param dbal $db The db connection
+	*/
 	public function __construct($phpbb_root_path, $php_ext, phpbb_config $config, dbal $db)
 	{
 		$this->phpbb_root_path = $phpbb_root_path;

phpBB/includes/cron/task/core/queue.php

@@ -26,6 +26,13 @@ class phpbb_cron_task_core_queue extends phpbb_cron_task_base
 	protected $php_ext;
 	protected $config;
 
+	/**
+	* Constructor.
+	*
+	* @param string $phpbb_root_path The root path
+	* @param string $php_ext The PHP extension
+	* @param phpbb_config $config The config
+	*/
 	public function __construct($phpbb_root_path, $php_ext, phpbb_config $config)
 	{
 		$this->phpbb_root_path = $phpbb_root_path;

phpBB/includes/cron/task/core/tidy_cache.php

@@ -25,6 +25,12 @@ class phpbb_cron_task_core_tidy_cache extends phpbb_cron_task_base
 	protected $config;
 	protected $cache;
 
+	/**
+	* Constructor.
+	*
+	* @param phpbb_config $config The config
+	* @param phpbb_cache_driver_interface $cache The cache driver
+	*/
 	public function __construct(phpbb_config $config, phpbb_cache_driver_interface $cache)
 	{
 		$this->config = $config;

phpBB/includes/cron/task/core/tidy_database.php

@@ -26,6 +26,13 @@ class phpbb_cron_task_core_tidy_database extends phpbb_cron_task_base
 	protected $php_ext;
 	protected $config;
 
+	/**
+	* Constructor.
+	*
+	* @param string $phpbb_root_path The root path
+	* @param string $php_ext The PHP extension
+	* @param phpbb_config $config The config
+	*/
 	public function __construct($phpbb_root_path, $php_ext, phpbb_config $config)
 	{
 		$this->phpbb_root_path = $phpbb_root_path;

phpBB/includes/cron/task/core/tidy_search.php

@@ -31,6 +31,16 @@ class phpbb_cron_task_core_tidy_search extends phpbb_cron_task_base
 	protected $db;
 	protected $user;
 
+	/**
+	* Constructor.
+	*
+	* @param string $phpbb_root_path The root path
+	* @param string $php_ext The PHP extension
+	* @param phpbb_auth $auth The auth
+	* @param phpbb_config $config The config
+	* @param dbal $db The db connection
+	* @param phpbb_user $user The user
+	*/
 	public function __construct($phpbb_root_path, $php_ext, phpbb_auth $auth, phpbb_config $config, dbal $db, phpbb_user $user)
 	{
 		$this->phpbb_root_path = $phpbb_root_path;

phpBB/includes/cron/task/core/tidy_sessions.php

@@ -25,6 +25,12 @@ class phpbb_cron_task_core_tidy_sessions extends phpbb_cron_task_base
 	protected $config;
 	protected $user;
 
+	/**
+	* Constructor.
+	*
+	* @param phpbb_config $config The config
+	* @param phpbb_user $user The user
+	*/
 	public function __construct(phpbb_config $config, phpbb_user $user)
 	{
 		$this->config = $config;

phpBB/includes/cron/task/core/tidy_warnings.php

@@ -28,6 +28,13 @@ class phpbb_cron_task_core_tidy_warnings extends phpbb_cron_task_base
 	protected $php_ext;
 	protected $config;
 
+	/**
+	* Constructor.
+	*
+	* @param string $phpbb_root_path The root path
+	* @param string $php_ext The PHP extension
+	* @param phpbb_config $config The config
+	*/
 	public function __construct($phpbb_root_path, $php_ext, phpbb_config $config)
 	{
 		$this->phpbb_root_path = $phpbb_root_path;

phpBB/includes/di/processor/config.php

@@ -17,12 +17,23 @@ if (!defined('IN_PHPBB'))
 
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
+/**
+* Configure the container for phpBB's services though
+* user-defined parameters defined in the config.php file.
+*/
 class phpbb_di_processor_config implements phpbb_di_processor_interface
 {
 	private $config_file;
 	private $phpbb_root_path;
 	private $php_ext;
 
+	/**
+	* Constructor.
+	*
+	* @param string $config_file The config file
+	* @param string $phpbb_root_path The root path
+	* @param string $php_ext The PHP extension
+	*/
 	public function __construct($config_file, $phpbb_root_path, $php_ext)
 	{
 		$this->config_file = $config_file;
@@ -30,6 +41,9 @@ class phpbb_di_processor_config implements phpbb_di_processor_interface
 		$this->php_ext = $php_ext;
 	}
 
+	/**
+	* @inheritdoc
+	*/
 	public function process(ContainerBuilder $container)
 	{
 		require $this->config_file;

phpBB/includes/di/processor/ext.php

@@ -19,15 +19,26 @@ use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
 
+/**
+* Load the service configurations from all extensions into the container.
+*/
 class phpbb_di_processor_ext implements phpbb_di_processor_interface
 {
 	private $extension_manager;
 
+	/**
+	* Constructor.
+	*
+	* @param string $extension_manager The extension manager
+	*/
 	public function __construct($extension_manager)
 	{
 		$this->extension_manager = $extension_manager;
 	}
 
+	/**
+	* @inheritdoc
+	*/
 	public function process(ContainerBuilder $container)
 	{
 		$enabled_exts = $this->extension_manager->all_enabled();

phpBB/includes/di/processor/interface.php

@@ -19,5 +19,10 @@ use Symfony\Component\DependencyInjection\ContainerBuilder;
 
 interface phpbb_di_processor_interface
 {
+	/**
+	* Mutate the container.
+	*
+	* @param ContainerBuilder $container The container
+	*/
 	public function process(ContainerBuilder $container);
 }