[ticket/11103] Expand class vars and use docblocks for phpBB classes

PHPBB3-11103

phpBB/includes/notification/manager.php

@@ -21,7 +21,32 @@ if (!defined('IN_PHPBB'))
 */
 class phpbb_notification_manager
 {
-	protected $db, $cache, $template, $extension_manager, $user, $auth, $config, $phpbb_root_path, $php_ext = null;
+	/** @var dbal */
+	protected $db = null;
+
+	/** @var phpbb_cache_service */
+	protected $cache = null;
+
+	/** @var phpbb_template */
+	protected $template = null;
+
+	/** @var phpbb_extension_manager */
+	protected $extension_manager = null;
+
+	/** @var phpbb_user */
+	protected $user = null;
+
+	/** @var phpbb_auth */
+	protected $auth = null;
+
+	/** @var phpbb_config */
+	protected $config = null;
+
+	/** @var string */
+	protected $phpbb_root_path = null;
+
+	/** @var string */
+	protected $php_ext = null;
 
 	/**
 	* Users loaded from the DB
@@ -71,7 +96,7 @@ class phpbb_notification_manager
 			'count_total'		=> false,
 		), $options);
 
-		// If all_unread, count_unread mus be true
+		// If all_unread, count_unread must be true
 		$options['count_unread'] = ($options['all_unread']) ? true : $options['count_unread'];
 
 		// Anonymous users and bots never receive notifications

phpBB/includes/notification/method/base.php

@@ -21,26 +21,35 @@ if (!defined('IN_PHPBB'))
 */
 abstract class phpbb_notification_method_base implements phpbb_notification_method_interface
 {
-	protected $notification_manager, $db, $cache, $template, $extension_manager, $user, $auth, $config, $phpbb_root_path, $php_ext = null;
+	/** @var phpbb_notification_manager */
+	protected $notification_manager = null;
 
-	/**
+	/** @var dbal */
-	* Desired notifications
+	protected $db = null;
-	* unique by (type, type_id, user_id, method)
+
-	* if multiple methods are desired, multiple rows will exist.
+	/** @var phpbb_cache_service */
-	*
+	protected $cache = null;
-	* method of "none" will over-ride any other options
+
-	*
+	/** @var phpbb_template */
-	* item_type
+	protected $template = null;
-	* item_id
+
-	* user_id
+	/** @var phpbb_extension_manager */
-	* method
+	protected $extension_manager = null;
-	* 	none (will never receive notifications)
+
-	* 	standard (listed in notifications window
+	/** @var phpbb_user */
-	* 	popup?
+	protected $user = null;
-	* 	email
+
-	* 	jabber
+	/** @var phpbb_auth */
-	*	sms?
+	protected $auth = null;
-	*/
+
+	/** @var phpbb_config */
+	protected $config = null;
+
+	/** @var string */
+	protected $phpbb_root_path = null;
+
+	/** @var string */
+	protected $php_ext = null;
 
 	/**
 	* Queue of messages to be sent

phpBB/includes/notification/type/base.php

@@ -21,7 +21,35 @@ if (!defined('IN_PHPBB'))
 */
 abstract class phpbb_notification_type_base implements phpbb_notification_type_interface
 {
-	protected $notification_manager, $db, $cache, $template, $extension_manager, $user, $auth, $config, $phpbb_root_path, $php_ext = null;
+	/** @var phpbb_notification_manager */
+	protected $notification_manager = null;
+
+	/** @var dbal */
+	protected $db = null;
+
+	/** @var phpbb_cache_service */
+	protected $cache = null;
+
+	/** @var phpbb_template */
+	protected $template = null;
+
+	/** @var phpbb_extension_manager */
+	protected $extension_manager = null;
+
+	/** @var phpbb_user */
+	protected $user = null;
+
+	/** @var phpbb_auth */
+	protected $auth = null;
+
+	/** @var phpbb_config */
+	protected $config = null;
+
+	/** @var string */
+	protected $phpbb_root_path = null;
+
+	/** @var string */
+	protected $php_ext = null;
 
 	/**
 	* Array of user data containing information needed to output the notifications to the template