Refactor to follow interface more closely

Signed-off-by: Matt Friedman <maf675@gmail.com>

Author: iMattPro

config/services.yml

@@ -130,9 +130,6 @@ services:
         parent: notification.type.base
         shared: false
         calls:
-            - [set_controller_helper, ['@controller.helper']]
-            - [set_idea_factory, ['@phpbb.ideas.idea']]
-            - [set_ideas_forum_id, ['@config']]
-            - [set_user_loader, ['@user_loader']]
+            - [set_additional_services, ['@config', '@controller.helper', '@phpbb.ideas.idea', '@user_loader']]
         tags:
             - { name: notification.type }

notification/type/status.php

@@ -10,86 +10,56 @@
 
 namespace phpbb\ideas\notification\type;
 
+use phpbb\config\config;
+use phpbb\controller\helper;
 use phpbb\ideas\ext;
+use phpbb\ideas\factory\idea;
+use phpbb\user_loader;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 
 /**
  * Ideas status change notification class.
  */
 class status extends \phpbb\notification\type\base
 {
-	/** @var \phpbb\config\config */
+	/** @var config */
 	protected $config;
 
-	/** @var \phpbb\controller\helper */
+	/** @var helper */
 	protected $helper;
 
-	/** @var \phpbb\ideas\factory\idea */
+	/** @var idea */
 	protected $idea;
 
-	/** @var \phpbb\user_loader */
+	/** @var user_loader */
 	protected $user_loader;
 
 	/** @var int */
 	protected $ideas_forum_id;
 
 	/**
-	 * Set the controller helper
-	 *
-	 * @param \phpbb\controller\helper $helper
+	 * Set additional services and properties
 	 *
+	 * @param config $config
+	 * @param helper $helper
+	 * @param idea $idea
+	 * @param user_loader $user_loader
 	 * @return void
 	 */
-	public function set_controller_helper(\phpbb\controller\helper $helper)
+	public function set_additional_services(config $config, helper $helper, idea $idea, user_loader $user_loader)
 	{
 		$this->helper = $helper;
-	}
-
-	/**
-	 * Set the Idea object
-	 *
-	 * @param \phpbb\ideas\factory\idea $idea
-	 *
-	 * @return void
-	 */
-	public function set_idea_factory(\phpbb\ideas\factory\idea $idea)
-	{
 		$this->idea = $idea;
-	}
-
-	/**
-	 * Set the config object
-	 *
-	 * @param \phpbb\config\config $config
-	 *
-	 * @return void
-	 */
-	public function set_ideas_forum_id(\phpbb\config\config $config)
-	{
-		$this->ideas_forum_id = (int) $config['ideas_forum_id'];
-	}
-
-	public function set_user_loader(\phpbb\user_loader $user_loader)
-	{
 		$this->user_loader = $user_loader;
-	}
-
-	/**
-	 * Get notification type name
-	 *
-	 * @return string
-	 */
-	public function get_type()
-	{
-		return 'phpbb.ideas.notification.type.status';
+		$this->ideas_forum_id = (int) $config['ideas_forum_id'];
 	}
 
 	/**
 	 * Email template to use to send notifications
 	 *
 	 * @var string
 	 */
-	public $email_template = '@phpbb_ideas/status_notification';
+	protected $email_template = '@phpbb_ideas/status_notification';
 
 	/**
 	 * Language key used to output the text
@@ -99,59 +69,47 @@ public function get_type()
 	protected $language_key = 'IDEA_STATUS_CHANGE';
 
 	/**
-	 * Notification option data (for outputting to the user)
-	 *
-	 * @var bool|array False if the service should use its default data
-	 * 					Array of data (including keys 'id', 'lang', and 'group')
+	 * {@inheritDoc}
 	 */
 	public static $notification_option = [
 		'lang'	=> 'NOTIFICATION_TYPE_IDEAS',
 		'group'	=> 'NOTIFICATION_GROUP_MISCELLANEOUS',
 	];
 
 	/**
-	 * Is this type available to the current user (defines whether it will be shown in the UCP Edit notification options)
-	 *
-	 * @return bool True/False whether this is available to the user
+	 * {@inheritDoc}
 	 */
-	public function is_available()
+	public function get_type()
 	{
-		return (bool) $this->auth->acl_get('f_read', $this->ideas_forum_id);
+		return 'phpbb.ideas.notification.type.status';
 	}
 
 	/**
-	 * Get the id of the notification
-	 *
-	 * @param array $type_data The type-specific data
-	 *
-	 * @return int ID of the notification
+	 * {@inheritDoc}
 	 */
 	public static function get_item_id($type_data)
 	{
 		return (int) $type_data['item_id'];
 	}
 
 	/**
-	 * Get the id of the parent
-	 *
-	 * @param array $type_data The type-specific data
-	 *
-	 * @return int ID of the parent
+	 * {@inheritDoc}
 	 */
 	public static function get_item_parent_id($type_data)
 	{
 		return 0;
 	}
 
 	/**
-	 * Find the users who want to receive notifications
-	 *
-	 * @param array $type_data The type-specific data
-	 * @param array $options Options for finding users for notification
-	 * 		ignore_users => array of users and user types that should not receive notifications from this type because they've already been notified
-	 * 						e.g.: [2 => [''], 3 => ['', 'email'], ...]
-	 *
-	 * @return array
+	 * {@inheritDoc}
+	 */
+	public function is_available()
+	{
+		return (bool) $this->auth->acl_get('f_read', $this->ideas_forum_id);
+	}
+
+	/**
+	 * {@inheritDoc}
 	 */
 	public function find_users_for_notification($type_data, $options = [])
 	{
@@ -167,27 +125,15 @@ public function find_users_for_notification($type_data, $options = [])
 	}
 
 	/**
-	 * Get the user's avatar
-	 */
-	public function get_avatar()
-	{
-		return $this->user_loader->get_avatar($this->get_data('idea_author'), false, true);
-	}
-
-	/**
-	 * Users needed to query before this notification can be displayed
-	 *
-	 * @return array Array of user_ids
+	 * {@inheritDoc}
 	 */
 	public function users_to_query()
 	{
 		return [$this->get_data('idea_author')];
 	}
 
 	/**
-	 * Get the HTML-formatted title of this notification
-	 *
-	 * @return string
+	 * {@inheritDoc}
 	 */
 	public function get_title()
 	{
@@ -199,20 +145,15 @@ public function get_title()
 	}
 
 	/**
-	 * Get the HTML-formatted reference of the notification
-	 *
-	 * @return string
+	 * {@inheritDoc}
 	 */
 	public function get_reference()
 	{
 		return  $this->language->lang(ext::status_name($this->get_data('status')));
 	}
 
 	/**
-	 * Get the url to this item
-	 *
-	 * @param int $reference_type The type of reference to be generated (one of the constants)
-	 * @return string URL
+	 * {@inheritDoc}
 	 */
 	public function get_url($reference_type = UrlGeneratorInterface::ABSOLUTE_PATH)
 	{
@@ -222,19 +163,23 @@ public function get_url($reference_type = UrlGeneratorInterface::ABSOLUTE_PATH)
 	}
 
 	/**
-	 * Get email template
-	 *
-	 * @return string|bool
+	 * {@inheritDoc}
+	 */
+	public function get_avatar()
+	{
+		return $this->user_loader->get_avatar($this->get_data('idea_author'), false, true);
+	}
+
+	/**
+	 * {@inheritDoc}
 	 */
 	public function get_email_template()
 	{
 		return $this->email_template;
 	}
 
 	/**
-	 * Get email template variables
-	 *
-	 * @return array
+	 * {@inheritDoc}
 	 */
 	public function get_email_template_variables()
 	{
@@ -246,15 +191,7 @@ public function get_email_template_variables()
 	}
 
 	/**
-	 * Pre create insert array function
-	 * This allows you to perform certain actions, like run a query
-	 * and load data, before create_insert_array() is run. The data
-	 * returned from this function will be sent to create_insert_array().
-	 *
-	 * @param array $type_data The type-specific data
-	 * @param array $notify_users Notify users list
-	 * 		Formatted from find_users_for_notification()
-	 * @return array Whatever you want to send to create_insert_array().
+	 * {@inheritDoc}
 	 */
 	public function pre_create_insert_array($type_data, $notify_users)
 	{
@@ -271,11 +208,7 @@ public function pre_create_insert_array($type_data, $notify_users)
 	}
 
 	/**
-	 * Function for preparing the data for insertion in an SQL query
-	 * (The service handles insertion)
-	 *
-	 * @param array $type_data The type-specific data
-	 * @param array $pre_create_data Data from pre_create_insert_array()
+	 * {@inheritDoc}
 	 */
 	public function create_insert_array($type_data, $pre_create_data = [])
 	{

tests/notification/status_test.php

@@ -63,10 +63,7 @@ protected function setUp(): void
 			->willReturn($this->forum_id);
 
 		$this->notification_type = new status($db, $this->language, $user, $this->auth, $phpbb_root_path, $phpEx, 'phpbb_user_notifications');
-		$this->notification_type->set_ideas_forum_id($this->config);
-		$this->notification_type->set_controller_helper($this->helper);
-		$this->notification_type->set_idea_factory($this->idea_factory);
-		$this->notification_type->set_user_loader($this->user_loader);
+		$this->notification_type->set_additional_services($this->config, $this->helper, $this->idea_factory, $this->user_loader);
 
 		// Set protected properties using reflection
 		$reflection = new \ReflectionClass($this->notification_type);