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

Fully documents the constructors of the processors and the cron tasks. PHPBB3-10739
author: Igor Wiedler <igor@wiedler.ch> 2012-09-01 19:17:01 +0200
committer: Igor Wiedler <igor@wiedler.ch> 2012-09-01 19:17:01 +0200
commit: 282a80077d4630ba59043fffe59e8a7ce8619ecb (patch)
tree: e2a9af2dd81160a52973034fc386a15075023eab /phpBB/includes
parent: 7ed7b19a1f1c3732b561ec3c8a4a39f115b5e6ac (diff)
download: forums-282a80077d4630ba59043fffe59e8a7ce8619ecb.tar
forums-282a80077d4630ba59043fffe59e8a7ce8619ecb.tar.gz
forums-282a80077d4630ba59043fffe59e8a7ce8619ecb.tar.bz2
forums-282a80077d4630ba59043fffe59e8a7ce8619ecb.tar.xz
forums-282a80077d4630ba59043fffe59e8a7ce8619ecb.zip
11 files changed, 150 insertions, 61 deletions
diff --git a/phpBB/includes/cron/task/core/prune_all_forums.php b/phpBB/includes/cron/task/core/prune_all_forums.php
index 5164087b68..252e16e57d 100644
--- a/phpBB/includes/cron/task/core/prune_all_forums.php
+++ b/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;
diff --git a/phpBB/includes/cron/task/core/prune_forum.php b/phpBB/includes/cron/task/core/prune_forum.php
index 8bb13ffe36..41d60af921 100644
--- a/phpBB/includes/cron/task/core/prune_forum.php
+++ b/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;
diff --git a/phpBB/includes/cron/task/core/queue.php b/phpBB/includes/cron/task/core/queue.php
index 3278ce9d76..c765660906 100644
--- a/phpBB/includes/cron/task/core/queue.php
+++ b/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;
diff --git a/phpBB/includes/cron/task/core/tidy_cache.php b/phpBB/includes/cron/task/core/tidy_cache.php
index 573243c166..6017eea561 100644
--- a/phpBB/includes/cron/task/core/tidy_cache.php
+++ b/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;
diff --git a/phpBB/includes/cron/task/core/tidy_database.php b/phpBB/includes/cron/task/core/tidy_database.php
index c9f81cbb51..1d256f964f 100644
--- a/phpBB/includes/cron/task/core/tidy_database.php
+++ b/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;
diff --git a/phpBB/includes/cron/task/core/tidy_search.php b/phpBB/includes/cron/task/core/tidy_search.php
index 00af293b6d..2e5f3d79d5 100644
--- a/phpBB/includes/cron/task/core/tidy_search.php
+++ b/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;
diff --git a/phpBB/includes/cron/task/core/tidy_sessions.php b/phpBB/includes/cron/task/core/tidy_sessions.php
index 695a537274..13531aa30b 100644
--- a/phpBB/includes/cron/task/core/tidy_sessions.php
+++ b/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;
diff --git a/phpBB/includes/cron/task/core/tidy_warnings.php b/phpBB/includes/cron/task/core/tidy_warnings.php
index acffd12052..8dd0674fe5 100644
--- a/phpBB/includes/cron/task/core/tidy_warnings.php
+++ b/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;
diff --git a/phpBB/includes/di/processor/config.php b/phpBB/includes/di/processor/config.php
index 1a5ec15854..22b6252a6d 100644
--- a/phpBB/includes/di/processor/config.php
+++ b/phpBB/includes/di/processor/config.php
@@ -12,51 +12,65 @@
 */
 if (!defined('IN_PHPBB'))
 {
-    exit;
+	exit;
 }
 
 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;
-
-    public function __construct($config_file, $phpbb_root_path, $php_ext)
-    {
-        $this->config_file = $config_file;
-        $this->phpbb_root_path = $phpbb_root_path;
-        $this->php_ext = $php_ext;
-    }
-
-    public function process(ContainerBuilder $container)
-    {
-        require $this->config_file;
-
-        $container->setParameter('core.root_path', $this->phpbb_root_path);
-        $container->setParameter('core.php_ext', $this->php_ext);
-
-        $container->setParameter('core.table_prefix', $table_prefix);
-        $container->setParameter('cache.driver.class', $this->fix_acm_type($acm_type));
-        $container->setParameter('dbal.driver.class', 'dbal_'.$dbms);
-        $container->setParameter('dbal.dbhost', $dbhost);
-        $container->setParameter('dbal.dbuser', $dbuser);
-        $container->setParameter('dbal.dbpasswd', $dbpasswd);
-        $container->setParameter('dbal.dbname', $dbname);
-        $container->setParameter('dbal.dbport', $dbport);
-        $container->setParameter('dbal.new_link', defined('PHPBB_DB_NEW_LINK') && PHPBB_DB_NEW_LINK);
-
-        $container->set('container', $container);
-    }
-
-    protected function fix_acm_type($acm_type)
-    {
-        if (preg_match('#^[a-z]+$#', $acm_type))
-        {
-            return 'phpbb_cache_driver_'.$acm_type;
-        }
-
-        return $acm_type;
-    }
+	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;
+		$this->phpbb_root_path = $phpbb_root_path;
+		$this->php_ext = $php_ext;
+	}
+
+	/**
+	* @inheritdoc
+	*/
+	public function process(ContainerBuilder $container)
+	{
+		require $this->config_file;
+
+		$container->setParameter('core.root_path', $this->phpbb_root_path);
+		$container->setParameter('core.php_ext', $this->php_ext);
+
+		$container->setParameter('core.table_prefix', $table_prefix);
+		$container->setParameter('cache.driver.class', $this->fix_acm_type($acm_type));
+		$container->setParameter('dbal.driver.class', 'dbal_'.$dbms);
+		$container->setParameter('dbal.dbhost', $dbhost);
+		$container->setParameter('dbal.dbuser', $dbuser);
+		$container->setParameter('dbal.dbpasswd', $dbpasswd);
+		$container->setParameter('dbal.dbname', $dbname);
+		$container->setParameter('dbal.dbport', $dbport);
+		$container->setParameter('dbal.new_link', defined('PHPBB_DB_NEW_LINK') && PHPBB_DB_NEW_LINK);
+
+		$container->set('container', $container);
+	}
+
+	protected function fix_acm_type($acm_type)
+	{
+		if (preg_match('#^[a-z]+$#', $acm_type))
+		{
+			return 'phpbb_cache_driver_'.$acm_type;
+		}
+
+		return $acm_type;
+	}
 }
diff --git a/phpBB/includes/di/processor/ext.php b/phpBB/includes/di/processor/ext.php
index 04a586a086..e69a3d73b3 100644
--- a/phpBB/includes/di/processor/ext.php
+++ b/phpBB/includes/di/processor/ext.php
@@ -12,32 +12,43 @@
 */
 if (!defined('IN_PHPBB'))
 {
-    exit;
+	exit;
 }
 
 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;
+	private $extension_manager;
 
-    public function __construct($extension_manager)
-    {
-        $this->extension_manager = $extension_manager;
-    }
+	/**
+	* Constructor.
+	*
+	* @param string $extension_manager The extension manager
+	*/
+	public function __construct($extension_manager)
+	{
+		$this->extension_manager = $extension_manager;
+	}
 
-    public function process(ContainerBuilder $container)
-    {
-        $enabled_exts = $this->extension_manager->all_enabled();
-        foreach ($enabled_exts as $name => $path)
-        {
-            if (file_exists($path . '/config/services.yml'))
-            {
-                $loader = new YamlFileLoader($container, new FileLocator($path . '/config'));
-                $loader->load('services.yml');
-            }
-        }
-    }
+	/**
+	* @inheritdoc
+	*/
+	public function process(ContainerBuilder $container)
+	{
+		$enabled_exts = $this->extension_manager->all_enabled();
+		foreach ($enabled_exts as $name => $path)
+		{
+			if (file_exists($path . '/config/services.yml'))
+			{
+				$loader = new YamlFileLoader($container, new FileLocator($path . '/config'));
+				$loader->load('services.yml');
+			}
+		}
+	}
 }
diff --git a/phpBB/includes/di/processor/interface.php b/phpBB/includes/di/processor/interface.php
index 51bd85a076..b8563791cc 100644
--- a/phpBB/includes/di/processor/interface.php
+++ b/phpBB/includes/di/processor/interface.php
@@ -12,12 +12,17 @@
 */
 if (!defined('IN_PHPBB'))
 {
-    exit;
+	exit;
 }
 
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
 interface phpbb_di_processor_interface
 {
-    public function process(ContainerBuilder $container);
+	/**
+	* Mutate the container.
+	*
+	* @param ContainerBuilder $container The container
+	*/
+	public function process(ContainerBuilder $container);
 }
author	Igor Wiedler <igor@wiedler.ch>	2012-09-01 19:17:01 +0200
committer	Igor Wiedler <igor@wiedler.ch>	2012-09-01 19:17:01 +0200
commit	282a80077d4630ba59043fffe59e8a7ce8619ecb (patch)
tree	e2a9af2dd81160a52973034fc386a15075023eab /phpBB/includes
parent	7ed7b19a1f1c3732b561ec3c8a4a39f115b5e6ac (diff)
download	forums-282a80077d4630ba59043fffe59e8a7ce8619ecb.tar forums-282a80077d4630ba59043fffe59e8a7ce8619ecb.tar.gz forums-282a80077d4630ba59043fffe59e8a7ce8619ecb.tar.bz2 forums-282a80077d4630ba59043fffe59e8a7ce8619ecb.tar.xz forums-282a80077d4630ba59043fffe59e8a7ce8619ecb.zip