makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-28 06:08:52 +00:00
Code Issues Projects Releases Packages Wiki Activity

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

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

PHPBB3-10739
This commit is contained in:
Igor Wiedler 2012-09-01 19:17:01 +02:00
parent 7ed7b19a1f
commit 282a80077d
11 changed files with 143 additions and 54 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
phpBB/includes/cron/task/core/prune_all_forums.php
View file

@ -31,6 +31,14 @@ class phpbb_cron_task_core_prune_all_forums extends phpbb_cron_task_base
protected $config; protected $config;
protected $db; 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) public function __construct($phpbb_root_path, $php_ext, phpbb_config $config, dbal $db)
{ {
$this->phpbb_root_path = $phpbb_root_path; $this->phpbb_root_path = $phpbb_root_path;

8
phpBB/includes/cron/task/core/prune_forum.php
View file

@ -41,6 +41,14 @@ class phpbb_cron_task_core_prune_forum extends phpbb_cron_task_base implements p
*/ */
protected $forum_data; 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) public function __construct($phpbb_root_path, $php_ext, phpbb_config $config, dbal $db)
{ {
$this->phpbb_root_path = $phpbb_root_path; $this->phpbb_root_path = $phpbb_root_path;

7
phpBB/includes/cron/task/core/queue.php
View file

@ -26,6 +26,13 @@ class phpbb_cron_task_core_queue extends phpbb_cron_task_base
protected $php_ext; protected $php_ext;
protected $config; 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) public function __construct($phpbb_root_path, $php_ext, phpbb_config $config)
{ {
$this->phpbb_root_path = $phpbb_root_path; $this->phpbb_root_path = $phpbb_root_path;

6
phpBB/includes/cron/task/core/tidy_cache.php
View file

@ -25,6 +25,12 @@ class phpbb_cron_task_core_tidy_cache extends phpbb_cron_task_base
protected $config; protected $config;
protected $cache; 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) public function __construct(phpbb_config $config, phpbb_cache_driver_interface $cache)
{ {
$this->config = $config; $this->config = $config;

7
phpBB/includes/cron/task/core/tidy_database.php
View file

@ -26,6 +26,13 @@ class phpbb_cron_task_core_tidy_database extends phpbb_cron_task_base
protected $php_ext; protected $php_ext;
protected $config; 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) public function __construct($phpbb_root_path, $php_ext, phpbb_config $config)
{ {
$this->phpbb_root_path = $phpbb_root_path; $this->phpbb_root_path = $phpbb_root_path;

10
phpBB/includes/cron/task/core/tidy_search.php
View file

@ -31,6 +31,16 @@ class phpbb_cron_task_core_tidy_search extends phpbb_cron_task_base
protected $db; protected $db;
protected $user; 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) 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; $this->phpbb_root_path = $phpbb_root_path;

6
phpBB/includes/cron/task/core/tidy_sessions.php
View file

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

7
phpBB/includes/cron/task/core/tidy_warnings.php
View file

@ -28,6 +28,13 @@ class phpbb_cron_task_core_tidy_warnings extends phpbb_cron_task_base
protected $php_ext; protected $php_ext;
protected $config; 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) public function __construct($phpbb_root_path, $php_ext, phpbb_config $config)
{ {
$this->phpbb_root_path = $phpbb_root_path; $this->phpbb_root_path = $phpbb_root_path;

82
phpBB/includes/di/processor/config.php
View file

@ -12,51 +12,65 @@
*/ */
if (!defined('IN_PHPBB')) if (!defined('IN_PHPBB'))
{ {
exit; exit;
} }
use Symfony\Component\DependencyInjection\ContainerBuilder; 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 class phpbb_di_processor_config implements phpbb_di_processor_interface
{ {
private $config_file; private $config_file;
private $phpbb_root_path; private $phpbb_root_path;
private $php_ext; private $php_ext;
public function __construct($config_file, $phpbb_root_path, $php_ext) /**
{ * Constructor.
$this->config_file = $config_file; *
$this->phpbb_root_path = $phpbb_root_path; * @param string $config_file The config file
$this->php_ext = $php_ext; * @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;
}
public function process(ContainerBuilder $container) /**
{ * @inheritdoc
require $this->config_file; */
public function process(ContainerBuilder $container)
{
require $this->config_file;
$container->setParameter('core.root_path', $this->phpbb_root_path); $container->setParameter('core.root_path', $this->phpbb_root_path);
$container->setParameter('core.php_ext', $this->php_ext); $container->setParameter('core.php_ext', $this->php_ext);
$container->setParameter('core.table_prefix', $table_prefix); $container->setParameter('core.table_prefix', $table_prefix);
$container->setParameter('cache.driver.class', $this->fix_acm_type($acm_type)); $container->setParameter('cache.driver.class', $this->fix_acm_type($acm_type));
$container->setParameter('dbal.driver.class', 'dbal_'.$dbms); $container->setParameter('dbal.driver.class', 'dbal_'.$dbms);
$container->setParameter('dbal.dbhost', $dbhost); $container->setParameter('dbal.dbhost', $dbhost);
$container->setParameter('dbal.dbuser', $dbuser); $container->setParameter('dbal.dbuser', $dbuser);
$container->setParameter('dbal.dbpasswd', $dbpasswd); $container->setParameter('dbal.dbpasswd', $dbpasswd);
$container->setParameter('dbal.dbname', $dbname); $container->setParameter('dbal.dbname', $dbname);
$container->setParameter('dbal.dbport', $dbport); $container->setParameter('dbal.dbport', $dbport);
$container->setParameter('dbal.new_link', defined('PHPBB_DB_NEW_LINK') && PHPBB_DB_NEW_LINK); $container->setParameter('dbal.new_link', defined('PHPBB_DB_NEW_LINK') && PHPBB_DB_NEW_LINK);
$container->set('container', $container); $container->set('container', $container);
} }
protected function fix_acm_type($acm_type) protected function fix_acm_type($acm_type)
{ {
if (preg_match('#^[a-z]+$#', $acm_type)) if (preg_match('#^[a-z]+$#', $acm_type))
{ {
return 'phpbb_cache_driver_'.$acm_type; return 'phpbb_cache_driver_'.$acm_type;
} }
return $acm_type; return $acm_type;
} }
} }

47
phpBB/includes/di/processor/ext.php
View file

@ -12,32 +12,43 @@
*/ */
if (!defined('IN_PHPBB')) if (!defined('IN_PHPBB'))
{ {
exit; exit;
} }
use Symfony\Component\Config\FileLocator; use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder; use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader; 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 class phpbb_di_processor_ext implements phpbb_di_processor_interface
{ {
private $extension_manager; private $extension_manager;
public function __construct($extension_manager) /**
{ * Constructor.
$this->extension_manager = $extension_manager; *
} * @param string $extension_manager The extension manager
*/
public function __construct($extension_manager)
{
$this->extension_manager = $extension_manager;
}
public function process(ContainerBuilder $container) /**
{ * @inheritdoc
$enabled_exts = $this->extension_manager->all_enabled(); */
foreach ($enabled_exts as $name => $path) public function process(ContainerBuilder $container)
{ {
if (file_exists($path . '/config/services.yml')) $enabled_exts = $this->extension_manager->all_enabled();
{ foreach ($enabled_exts as $name => $path)
$loader = new YamlFileLoader($container, new FileLocator($path . '/config')); {
$loader->load('services.yml'); if (file_exists($path . '/config/services.yml'))
} {
} $loader = new YamlFileLoader($container, new FileLocator($path . '/config'));
} $loader->load('services.yml');
}
}
}
} }

9
phpBB/includes/di/processor/interface.php
View file

@ -12,12 +12,17 @@
*/ */
if (!defined('IN_PHPBB')) if (!defined('IN_PHPBB'))
{ {
exit; exit;
} }
use Symfony\Component\DependencyInjection\ContainerBuilder; use Symfony\Component\DependencyInjection\ContainerBuilder;
interface phpbb_di_processor_interface interface phpbb_di_processor_interface
{ {
public function process(ContainerBuilder $container); /**
* Mutate the container.
*
* @param ContainerBuilder $container The container
*/
public function process(ContainerBuilder $container);
} }