phpbb\ideas\notification\type\status

Complexity

Total Complexity

21

Size/Duplication

Total Lines	204
Duplicated Lines	0 %

Importance

Changes	12
Bugs	1	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	create_insert_array()	0	10	3
A	is_available()	0	3	1
A	get_avatar()	0	3	1
A	find_users_for_notification()	0	11	2
A	users_to_query()	0	3	1
A	get_reference()	0	3	1
A	get_item_id()	0	3	1
A	set_additional_services()	0	6	1
A	load_idea()	0	10	3
A	get_url()	0	5	1
A	get_email_template()	0	3	1
A	get_email_template_variables()	0	6	1
A	get_title()	0	7	2
A	get_item_parent_id()	0	3	1
A	get_type()	0	3	1

<?php
/**
 *
 * Ideas extension for the phpBB Forum Software package.
 *
 * @copyright (c) phpBB Limited <https://www.phpbb.com>
 * @license GNU General Public License, version 2 (GPL-2.0)
 *
 */

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;

The type Symfony\Component\Routing\Generator\UrlGeneratorInterface was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * Ideas status change notification class.
 */
class status extends \phpbb\notification\type\base

The type phpbb\notification\type\base was not found. Maybe you did not declare it correctly or list all dependencies?

{
	/** @var config */
	protected $config;

	/** @var helper */
	protected $helper;

	/** @var idea */
	protected $idea;

	/** @var user_loader */
	protected $user_loader;

	/** @var int */
	protected $ideas_forum_id;

	/** @var array */
	protected $idea_cache = [];

	/**
	 * Set additional services and properties
	 *
	 * @param config $config
	 * @param helper $helper
	 * @param idea $idea
	 * @param user_loader $user_loader
	 * @return void
	 */
	public function set_additional_services(config $config, helper $helper, idea $idea, user_loader $user_loader)
	{
		$this->helper = $helper;
		$this->idea = $idea;
		$this->user_loader = $user_loader;
		$this->ideas_forum_id = (int) $config['ideas_forum_id'];
	}

	/**
	 * Email template to use to send notifications
	 *
	 * @var string
	 */
	protected $email_template = '@phpbb_ideas/status_notification';

	/**
	 * Language key used to output the text
	 *
	 * @var string
	 */
	protected $language_key = 'IDEA_STATUS_CHANGE';

	/**
	 * {@inheritDoc}
	 */
	public static $notification_option = [
		'lang'	=> 'NOTIFICATION_TYPE_IDEAS',
		'group'	=> 'NOTIFICATION_GROUP_MISCELLANEOUS',
	];

	/**
	 * {@inheritDoc}
	 */
	public function get_type()
	{
		return 'phpbb.ideas.notification.type.status';
	}

	/**
	 * {@inheritDoc}
	 */
	public static function get_item_id($type_data)
	{
		return (int) $type_data['idea_id'];
	}

	/**
	 * {@inheritDoc}
	 */
	public static function get_item_parent_id($type_data)
	{
		return 0;
	}

	/**
	 * {@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 = [])
	{
		$options = array_merge([
			'ignore_users'		=> [],
		], $options);

		$idea = $this->load_idea($type_data['idea_id']);

		$users = $idea ? [$idea['idea_author']] : [];

		return $this->get_authorised_recipients($users, $this->ideas_forum_id, $options);
	}

	/**
	 * {@inheritDoc}
	 */
	public function users_to_query()
	{
		return [$this->get_data('idea_author')];
	}

	/**
	 * {@inheritDoc}
	 */
	public function get_title()
	{
		if (!$this->language->is_set($this->language_key))
		{
			$this->language->add_lang('common', 'phpbb/ideas');
		}
		return $this->language->lang($this->language_key, $this->get_data('idea_title'));
	}

	/**
	 * {@inheritDoc}
	 */
	public function get_reference()
	{
		return  $this->language->lang(ext::status_name($this->get_data('status')));
	}

	/**
	 * {@inheritDoc}
	 */
	public function get_url($reference_type = UrlGeneratorInterface::ABSOLUTE_PATH)
	{
		$params = ['idea_id' => $this->get_data('idea_id')];

		return $this->helper->route('phpbb_ideas_idea_controller', $params, true, false, $reference_type);
	}

	/**
	 * {@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;
	}

	/**
	 * {@inheritDoc}
	 */
	public function get_email_template_variables()
	{
		return [
			'IDEA_TITLE'	=> html_entity_decode(censor_text($this->get_data('idea_title')), ENT_COMPAT),

The function censor_text was not found. Maybe you did not declare it correctly or list all dependencies?

			'STATUS'		=> html_entity_decode($this->language->lang(ext::status_name($this->get_data('status'))), ENT_COMPAT),
			'U_VIEW_IDEA'	=> $this->get_url(UrlGeneratorInterface::ABSOLUTE_URL),
		];
	}

	/**
	 * {@inheritDoc}
	 */
	public function create_insert_array($type_data, $pre_create_data = [])
	{
		$idea = $this->load_idea($type_data['idea_id']);

		$this->set_data('idea_id', (int) $type_data['idea_id']);
		$this->set_data('status', (int) $type_data['status']);
		$this->set_data('idea_title', $idea ? $idea['idea_title'] : '');
		$this->set_data('idea_author', $idea ? (int) $idea['idea_author'] : 0);

		parent::create_insert_array($type_data, $pre_create_data);
	}

	/**
	 * Load and cache an idea by id
	 *
	 * @param int $idea_id
	 * @return array|false
	 */
	protected function load_idea($idea_id)
	{
		$idea_id = (int) $idea_id;

		if (!array_key_exists($idea_id, $this->idea_cache))
		{
			$this->idea_cache[$idea_id] = $this->idea->get_idea($idea_id) ?: false;
		}

		return $this->idea_cache[$idea_id];
	}
}