<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\notification\type;
/**
* Private message notifications class
* This class handles notifications for private messages
*/
class pm extends \phpbb\notification\type\base
{
/**
* Get notification type name
*
* @return string
*/
public function get_type()
{
return 'notification.type.pm';
}
/**
* Notification option data (for outputting to the user)
*
* @var bool|array False if the service should use it's default data
* Array of data (including keys 'id', 'lang', and 'group')
*/
static public $notification_option = array(
'lang' => 'NOTIFICATION_TYPE_PM',
);
/** @var \phpbb\user_loader */
protected $user_loader;
/** @var \phpbb\config\config */
protected $config;
public function set_config(\phpbb\config\config $config)
{
$this->config = $config;
}
public function set_user_loader(\phpbb\user_loader $user_loader)
{
$this->user_loader = $user_loader;
}
/**
* Is available
*/
public function is_available()
{
return ($this->config['allow_privmsg'] && $this->auth->acl_get('u_readpm'));
}
/**
* Get the id of the
*
* @param array $pm The data from the private message
*/
static public function get_item_id($pm)
{
return (int) $pm['msg_id'];
}
/**
* Get the id of the parent
*
* @param array $pm The data from the pm
*/
static public function get_item_parent_id($pm)
{
// No parent
return 0;
}
/**
* Find the users who want to receive notifications
*
* @param array $pm Data from submit_pm
* @param array $options Options for finding users for notification
*
* @return array
*/
public function find_users_for_notification($pm, $options = array())
{
$options = array_merge(array(
'ignore_users' => array(),
), $options);
if (!count($pm['recipients']))
{
return array();
}
unset($pm['recipients'][$pm['from_user_id']]);
$this->user_loader->load_users(array_keys($pm['recipients']));
return $this->check_user_notification_options(array_keys($pm['recipients']), $options);
}
/**
* Get the user's avatar
*/
public function get_avatar()
{
return $this->user_loader->get_avatar($this->get_data('from_user_id'), false, true);
}
/**
* Get the HTML formatted title of this notification
*
* @return string
*/
public function get_title()
{
$username = $this->user_loader->get_username($this->get_data('from_user_id'), 'no_profile');
return $this->language->lang('NOTIFICATION_PM', $username);
}
/**
* Get the HTML formatted reference of the notification
*
* @return string
*/
public function get_reference()
{
return $this->language->lang(
'NOTIFICATION_REFERENCE',
$this->get_data('message_subject')
);
}
/**
* Get email template
*
* @return string|bool
*/
public function get_email_template()
{
return 'privmsg_notify';
}
/**
* Get email template variables
*
* @return array
*/
public function get_email_template_variables()
{
$user_data = $this->user_loader->get_user($this->get_data('from_user_id'));
return array(
'AUTHOR_NAME' => html_entity_decode($user_data['username'], ENT_COMPAT),
'SUBJECT' => html_entity_decode(censor_text($this->get_data('message_subject')), ENT_COMPAT),
'U_VIEW_MESSAGE' => generate_board_url() . '/ucp.' . $this->php_ext . "?i=pm&mode=view&p={$this->item_id}",
);
}
/**
* Get the url to this item
*
* @return string URL
*/
public function get_url()
{
return append_sid($this->phpbb_root_path . 'ucp.' . $this->php_ext, "i=pm&mode=view&p={$this->item_id}");
}
/**
* Users needed to query before this notification can be displayed
*
* @return array Array of user_ids
*/
public function users_to_query()
{
return array($this->get_data('from_user_id'));
}
/**
* {@inheritdoc}
*/
public function create_insert_array($pm, $pre_create_data = array())
{
$this->set_data('from_user_id', $pm['from_user_id']);
$this->set_data('message_subject', $pm['message_subject']);
parent::create_insert_array($pm, $pre_create_data);
}
}