[ticket/11444] Cleanup method constructors

PHPBB3-11444
This commit is contained in:
Tristan Darricau 2015-07-09 14:28:34 +02:00
parent 06077d9970
commit f29b12e353
7 changed files with 89 additions and 96 deletions

View file

@ -6,13 +6,10 @@ services:
- @notification.method_collection - @notification.method_collection
- @service_container - @service_container
- @user_loader - @user_loader
- @config
- @dispatcher - @dispatcher
- @dbal.conn - @dbal.conn
- @cache - @cache
- @user - @user
- %core.root_path%
- %core.php_ext%
- %tables.notification_types% - %tables.notification_types%
- %tables.user_notifications% - %tables.user_notifications%
@ -350,10 +347,7 @@ services:
- @dbal.conn - @dbal.conn
- @cache.driver - @cache.driver
- @user - @user
- @auth
- @config - @config
- %core.root_path%
- %core.php_ext%
- %tables.notification_types% - %tables.notification_types%
- %tables.notifications% - %tables.notifications%
tags: tags:
@ -364,10 +358,7 @@ services:
scope: prototype scope: prototype
arguments: arguments:
- @user_loader - @user_loader
- @dbal.conn
- @cache.driver
- @user - @user
- @auth
- @config - @config
- %core.root_path% - %core.root_path%
- %core.php_ext% - %core.php_ext%
@ -379,10 +370,7 @@ services:
scope: prototype scope: prototype
arguments: arguments:
- @user_loader - @user_loader
- @dbal.conn
- @cache.driver
- @user - @user
- @auth
- @config - @config
- %core.root_path% - %core.root_path%
- %core.php_ext% - %core.php_ext%

View file

@ -13,7 +13,7 @@
namespace phpbb\notification; namespace phpbb\notification;
use \Symfony\Component\DependencyInjection\ContainerInterface; use Symfony\Component\DependencyInjection\ContainerInterface;
/** /**
* Notifications service class * Notifications service class
@ -35,9 +35,6 @@ class manager
/** @var \phpbb\user_loader */ /** @var \phpbb\user_loader */
protected $user_loader; protected $user_loader;
/** @var \phpbb\config\config */
protected $config;
/** @var \phpbb\event\dispatcher_interface */ /** @var \phpbb\event\dispatcher_interface */
protected $phpbb_dispatcher; protected $phpbb_dispatcher;
@ -50,12 +47,6 @@ class manager
/** @var \phpbb\user */ /** @var \phpbb\user */
protected $user; protected $user;
/** @var string */
protected $phpbb_root_path;
/** @var string */
protected $php_ext;
/** @var string */ /** @var string */
protected $notification_types_table; protected $notification_types_table;
@ -69,34 +60,27 @@ class manager
* @param array $notification_methods * @param array $notification_methods
* @param ContainerInterface $phpbb_container * @param ContainerInterface $phpbb_container
* @param \phpbb\user_loader $user_loader * @param \phpbb\user_loader $user_loader
* @param \phpbb\config\config $config
* @param \phpbb\event\dispatcher_interface $phpbb_dispatcher * @param \phpbb\event\dispatcher_interface $phpbb_dispatcher
* @param \phpbb\db\driver\driver_interface $db * @param \phpbb\db\driver\driver_interface $db
* @param \phpbb\cache\service $cache * @param \phpbb\cache\service $cache
* @param \phpbb\user $user * @param \phpbb\user $user
* @param string $phpbb_root_path
* @param string $php_ext
* @param string $notification_types_table * @param string $notification_types_table
* @param string $user_notifications_table * @param string $user_notifications_table
* *
* @return \phpbb\notification\manager * @return \phpbb\notification\manager
*/ */
public function __construct($notification_types, $notification_methods, ContainerInterface $phpbb_container, \phpbb\user_loader $user_loader, \phpbb\config\config $config, \phpbb\event\dispatcher_interface $phpbb_dispatcher, \phpbb\db\driver\driver_interface $db, \phpbb\cache\service $cache, $user, $phpbb_root_path, $php_ext, $notification_types_table, $user_notifications_table) public function __construct($notification_types, $notification_methods, ContainerInterface $phpbb_container, \phpbb\user_loader $user_loader, \phpbb\event\dispatcher_interface $phpbb_dispatcher, \phpbb\db\driver\driver_interface $db, \phpbb\cache\service $cache, \phpbb\user $user, $notification_types_table, $user_notifications_table)
{ {
$this->notification_types = $notification_types; $this->notification_types = $notification_types;
$this->notification_methods = $notification_methods; $this->notification_methods = $notification_methods;
$this->phpbb_container = $phpbb_container; $this->phpbb_container = $phpbb_container;
$this->user_loader = $user_loader; $this->user_loader = $user_loader;
$this->config = $config;
$this->phpbb_dispatcher = $phpbb_dispatcher; $this->phpbb_dispatcher = $phpbb_dispatcher;
$this->db = $db; $this->db = $db;
$this->cache = $cache; $this->cache = $cache;
$this->user = $user; $this->user = $user;
$this->phpbb_root_path = $phpbb_root_path;
$this->php_ext = $php_ext;
$this->notification_types_table = $notification_types_table; $this->notification_types_table = $notification_types_table;
$this->user_notifications_table = $user_notifications_table; $this->user_notifications_table = $user_notifications_table;
} }

View file

@ -21,36 +21,6 @@ abstract class base implements \phpbb\notification\method\method_interface
/** @var \phpbb\notification\manager */ /** @var \phpbb\notification\manager */
protected $notification_manager; protected $notification_manager;
/** @var \phpbb\user_loader */
protected $user_loader;
/** @var \phpbb\db\driver\driver_interface */
protected $db;
/** @var \phpbb\cache\driver\driver_interface */
protected $cache;
/** @var \phpbb\template\template */
protected $template;
/** @var \phpbb\extension\manager */
protected $extension_manager;
/** @var \phpbb\user */
protected $user;
/** @var \phpbb\auth\auth */
protected $auth;
/** @var \phpbb\config\config */
protected $config;
/** @var string */
protected $phpbb_root_path;
/** @var string */
protected $php_ext;
/** /**
* Queue of messages to be sent * Queue of messages to be sent
* *
@ -58,31 +28,6 @@ abstract class base implements \phpbb\notification\method\method_interface
*/ */
protected $queue = array(); protected $queue = array();
/**
* Notification Method Base Constructor
*
* @param \phpbb\user_loader $user_loader
* @param \phpbb\db\driver\driver_interface $db
* @param \phpbb\cache\driver\driver_interface $cache
* @param \phpbb\user $user
* @param \phpbb\auth\auth $auth
* @param \phpbb\config\config $config
* @param string $phpbb_root_path
* @param string $php_ext
* @return \phpbb\notification\method\base
*/
public function __construct(\phpbb\user_loader $user_loader, \phpbb\db\driver\driver_interface $db, \phpbb\cache\driver\driver_interface $cache, $user, \phpbb\auth\auth $auth, \phpbb\config\config $config, $phpbb_root_path, $php_ext)
{
$this->user_loader = $user_loader;
$this->db = $db;
$this->cache = $cache;
$this->user = $user;
$this->auth = $auth;
$this->config = $config;
$this->phpbb_root_path = $phpbb_root_path;
$this->php_ext = $php_ext;
}
/** /**
* Set notification manager (required) * Set notification manager (required)
* *

View file

@ -21,6 +21,21 @@ namespace phpbb\notification\method;
*/ */
class board extends \phpbb\notification\method\base class board extends \phpbb\notification\method\base
{ {
/** @var \phpbb\user_loader */
protected $user_loader;
/** @var \phpbb\db\driver\driver_interface */
protected $db;
/** @var \phpbb\cache\driver\driver_interface */
protected $cache;
/** @var \phpbb\user */
protected $user;
/** @var \phpbb\config\config */
protected $config;
/** @var string */ /** @var string */
protected $notification_types_table; protected $notification_types_table;
@ -34,27 +49,20 @@ class board extends \phpbb\notification\method\base
* @param \phpbb\db\driver\driver_interface $db * @param \phpbb\db\driver\driver_interface $db
* @param \phpbb\cache\driver\driver_interface $cache * @param \phpbb\cache\driver\driver_interface $cache
* @param \phpbb\user $user * @param \phpbb\user $user
* @param \phpbb\auth\auth $auth
* @param \phpbb\config\config $config * @param \phpbb\config\config $config
* @param string $phpbb_root_path
* @param string $php_ext
* @param string $notification_types_table * @param string $notification_types_table
* @param string $notifications_table * @param string $notifications_table
* @return \phpbb\notification\method\board
*/ */
public function __construct(\phpbb\user_loader $user_loader, \phpbb\db\driver\driver_interface $db, \phpbb\cache\driver\driver_interface $cache, $user, \phpbb\auth\auth $auth, \phpbb\config\config $config, $phpbb_root_path, $php_ext, $notification_types_table, $notifications_table) public function __construct(\phpbb\user_loader $user_loader, \phpbb\db\driver\driver_interface $db, \phpbb\cache\driver\driver_interface $cache, \phpbb\user $user, \phpbb\config\config $config, $notification_types_table, $notifications_table)
{ {
$this->user_loader = $user_loader; $this->user_loader = $user_loader;
$this->db = $db; $this->db = $db;
$this->cache = $cache; $this->cache = $cache;
$this->user = $user; $this->user = $user;
$this->auth = $auth;
$this->config = $config; $this->config = $config;
$this->phpbb_root_path = $phpbb_root_path;
$this->php_ext = $php_ext;
$this->notification_types_table = $notification_types_table; $this->notification_types_table = $notification_types_table;
$this->notifications_table = $notifications_table; $this->notifications_table = $notifications_table;
} }
/** /**

View file

@ -20,6 +20,29 @@ namespace phpbb\notification\method;
class email extends \phpbb\notification\method\messenger_base class email extends \phpbb\notification\method\messenger_base
{ {
/** @var \phpbb\user */
protected $user;
/** @var \phpbb\config\config */
protected $config;
/**
* Notification Method email Constructor
*
* @param \phpbb\user_loader $user_loader
* @param \phpbb\user $user
* @param \phpbb\config\config $config
* @param string $phpbb_root_path
* @param string $php_ext
*/
public function __construct(\phpbb\user_loader $user_loader, \phpbb\user $user, \phpbb\config\config $config, $phpbb_root_path, $php_ext)
{
parent::__construct($user_loader, $phpbb_root_path, $php_ext);
$this->user = $user;
$this->config = $config;
}
/** /**
* Get notification method name * Get notification method name
* *

View file

@ -20,6 +20,29 @@ namespace phpbb\notification\method;
class jabber extends \phpbb\notification\method\messenger_base class jabber extends \phpbb\notification\method\messenger_base
{ {
/** @var \phpbb\user */
protected $user;
/** @var \phpbb\config\config */
protected $config;
/**
* Notification Method jabber Constructor
*
* @param \phpbb\user_loader $user_loader
* @param \phpbb\user $user
* @param \phpbb\config\config $config
* @param string $phpbb_root_path
* @param string $php_ext
*/
public function __construct(\phpbb\user_loader $user_loader, \phpbb\user $user, \phpbb\config\config $config, $phpbb_root_path, $php_ext)
{
parent::__construct($user_loader, $phpbb_root_path, $php_ext);
$this->user = $user;
$this->config = $config;
}
/** /**
* Get notification method name * Get notification method name
* *
@ -61,6 +84,6 @@ class jabber extends \phpbb\notification\method\messenger_base
return; return;
} }
return $this->notify_using_messenger(NOTIFY_IM, 'short/'); $this->notify_using_messenger(NOTIFY_IM, 'short/');
} }
} }

View file

@ -19,6 +19,29 @@ namespace phpbb\notification\method;
*/ */
abstract class messenger_base extends \phpbb\notification\method\base abstract class messenger_base extends \phpbb\notification\method\base
{ {
/** @var \phpbb\user_loader */
protected $user_loader;
/** @var string */
protected $phpbb_root_path;
/** @var string */
protected $php_ext;
/**
* Notification Method Board Constructor
*
* @param \phpbb\user_loader $user_loader
* @param string $phpbb_root_path
* @param string $php_ext
*/
public function __construct(\phpbb\user_loader $user_loader, $phpbb_root_path, $php_ext)
{
$this->user_loader = $user_loader;
$this->phpbb_root_path = $phpbb_root_path;
$this->php_ext = $php_ext;
}
/** /**
* Notify using phpBB messenger * Notify using phpBB messenger
* *
@ -57,7 +80,6 @@ abstract class messenger_base extends \phpbb\notification\method\base
include($this->phpbb_root_path . 'includes/functions_messenger.' . $this->php_ext); include($this->phpbb_root_path . 'includes/functions_messenger.' . $this->php_ext);
} }
$messenger = new \messenger(); $messenger = new \messenger();
$board_url = generate_board_url();
// Time to go through the queue and send emails // Time to go through the queue and send emails
foreach ($this->queue as $notification) foreach ($this->queue as $notification)