+* 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.

+

+class exception extends \phpbb\exception\runtime_exception

+* 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.

+use Symfony\Component\DependencyInjection\ContainerInterface;

+

+ protected $subscription_types;

+

+ /** @var method\method_interface[] */

+ /** @var ContainerInterface */

+ /** @var \phpbb\event\dispatcher_interface */

+ protected $phpbb_dispatcher;

+ /** @var \phpbb\db\driver\driver_interface */

+ /** @var \phpbb\language\language */

+ protected $language;

+

+ * @param ContainerInterface $phpbb_container

+ * @param \phpbb\event\dispatcher_interface $phpbb_dispatcher

+ * @param \phpbb\db\driver\driver_interface $db

+ * @param \phpbb\cache\service $cache

+ * @param \phpbb\language\language $language

+ *

+ 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\language\language $language, \phpbb\user $user, $notification_types_table, $user_notifications_table)

+ $this->phpbb_dispatcher = $phpbb_dispatcher;

+ $this->language = $language;

+ * Load the user's notifications for a given method

+ * @param string $method_name

+ * @throws \phpbb\notification\exception when the method doesn't refer to a class extending \phpbb\notification\method\method_interface

+ public function load_notifications($method_name, array $options = array())

+ $method = $this->get_method_class($method_name);

+ if (! $method instanceof \phpbb\notification\method\method_interface)

+ {

+ throw new \phpbb\notification\exception($this->language->lang('NOTIFICATION_METHOD_INVALID', $method_name));

+ }

+ else if ($method->is_available())

+ {

+ return $method->load_notifications($options);

+ }

+ else

+ }

+ /**

+ * Mark notifications read or unread for all available methods

+ *

+ * @param bool|string|array $notification_type_name Type identifier or array of item types (only acceptable if the $data is identical for the specified types). False to mark read for all item types

+ * @param bool|int|array $item_id Item id or array of item ids. False to mark read for all item ids

+ * @param bool|int|array $user_id User id or array of user ids. False to mark read for all user ids

+ * @param bool|int $time Time at which to mark all notifications prior to as read. False to mark all as read. (Default: False)

+ *

+ * @deprecated since 3.2

+ */

+ public function mark_notifications_read($notification_type_name, $item_id, $user_id, $time = false)

+ {

+ $this->mark_notifications($notification_type_name, $item_id, $user_id, $time);

+ }

+ /**

+ * Mark notifications read or unread for all available methods

+ *

+ * @param bool|string|array $notification_type_name Type identifier or array of item types (only acceptable if the $data is identical for the specified types). False to mark read for all item types

+ * @param bool|int|array $item_id Item id or array of item ids. False to mark read for all item ids

+ * @param bool|int|array $user_id User id or array of user ids. False to mark read for all user ids

+ * @param bool|int $time Time at which to mark all notifications prior to as read. False to mark all as read. (Default: False)

+ * @param bool $mark_read Define if the notification as to be set to True or False. (Default: True)

+ */

+ public function mark_notifications($notification_type_name, $item_id, $user_id, $time = false, $mark_read = true)

+ {

+ if (is_array($notification_type_name))

+ $notification_type_id = $this->get_notification_type_ids($notification_type_name);

+ else if ($notification_type_name !== false)

+ $notification_type_id = $this->get_notification_type_id($notification_type_name);

+ else

+ $notification_type_id = false;

+ /** @var method\method_interface $method */

+ foreach ($this->get_available_subscription_methods() as $method)

+ {

+ $method->mark_notifications($notification_type_id, $item_id, $user_id, $time, $mark_read);

+ }

+ * Mark notifications read or unread from a parent identifier for all available methods

+ *

+ * @param string|array $notification_type_name Type identifier or array of item types (only acceptable if the $data is identical for the specified types)

+ * @param bool|int|array $item_parent_id Item parent id or array of item parent ids. False to mark read for all item parent ids

+ * @param bool|int|array $user_id User id or array of user ids. False to mark read for all user ids

+ * @param bool|int $time Time at which to mark all notifications prior to as read. False to mark all as read. (Default: False)

+ *

+ * @deprecated since 3.2

+ */

+ public function mark_notifications_read_by_parent($notification_type_name, $item_parent_id, $user_id, $time = false)

+ $this->mark_notifications_by_parent($notification_type_name, $item_parent_id, $user_id, $time);

+ * Mark notifications read or unread from a parent identifier for all available methods

+ * @param bool $mark_read Define if the notification as to be set to True or False. (Default: True)

+ public function mark_notifications_by_parent($notification_type_name, $item_parent_id, $user_id, $time = false, $mark_read = true)

+ if (is_array($notification_type_name))

+ {

+ $notification_type_id = $this->get_notification_type_ids($notification_type_name);

+ }

+ else

+ {

+ $notification_type_id = $this->get_notification_type_id($notification_type_name);

+ }

+

+ /** @var method\method_interface $method */

+ foreach ($this->get_available_subscription_methods() as $method)

+ {

+ $method->mark_notifications_by_parent($notification_type_id, $item_parent_id, $user_id, $time, $mark_read);

+ }

+ * Mark notifications read or unread for a given method

+ * @param string $method_name

+ * @param bool $mark_read Define if the notification as to be set to True or False. (Default: True)

+ public function mark_notifications_by_id($method_name, $notification_id, $time = false, $mark_read = true)

+ $method = $this->get_method_class($method_name);

+ if ($method instanceof \phpbb\notification\method\method_interface && $method->is_available())

+ {

+ $method->mark_notifications_by_id($notification_id, $time, $mark_read);

+ }

+ /**

+ * Allow filtering the notify_users array for a notification that is about to be sent.

+ * Here, $notify_users is already filtered by f_read and the ignored list included in the options variable

+ *

+ * @event core.notification_manager_add_notifications

+ * @var string notification_type_name The forum id from where the topic belongs

+ * @var array data Data specific for the notification_type_name used will be inserted

+ * @var array notify_users The array of userid that are going to be notified for this notification. Set to array() to cancel.

+ * @var array options The options that were used when this method was called (read only)

+ *

+ * @since 3.1.3-RC1

+ */

+ $vars = array(

+ 'notification_type_name',

+ 'data',

+ 'notify_users',

+ 'options',

+ );

+ extract($this->phpbb_dispatcher->trigger_event('core.notification_manager_add_notifications', compact($vars)));

+

+ $notification_methods = array();

+ // We remove each user which was already notified by at least one method.

+ /** @var method\method_interface $method */

+ foreach ($this->get_subscription_methods_instances() as $method)

+ $notified_users = $method->get_notified_users($notification_type_id, array('item_id' => $item_id));

+ foreach ($notified_users as $user => $notifications)

+ {

+ unset($notify_users[$user]);

+ }

+ // Generate the insert_array

+ $notification->create_insert_array($data, $pre_create_data);

+ if (!isset($notification_methods[$method]))

+ $notification_methods[$method] = $this->get_method_class($method);

+

+ $notification_methods[$method]->add_to_queue($notification);

+ * Update notification

+ * @param array $options

+ public function update_notifications($notification_type_name, array $data, array $options = array())

+ $this->update_notification($this->get_item_type_class($notification_type_name), $data, $options);

+ }

+ /**

+ * Update a notification

+ *

+ * @param \phpbb\notification\type\type_interface $notification The notification

+ * @param array $data Data specific for this type that will be updated

+ * @param array $options

+ */

+ public function update_notification(\phpbb\notification\type\type_interface $notification, array $data, array $options = array())

+ {

+ if (empty($options))

+ $options['item_id'] = $notification->get_item_id($data);

+ /** @var method\method_interface $method */

+ foreach ($this->get_available_subscription_methods() as $method)

+ {

+ $method->update_notification($notification, $data, $options);

+ }

+ * @param mixed $user_id User id (Default: false; not checked)

+ public function delete_notifications($notification_type_name, $item_id, $parent_id = false, $user_id = false)

+ $this->delete_notifications($type, $item_id, $parent_id, $user_id);

+ /** @var method\method_interface $method */

+ foreach ($this->get_available_subscription_methods() as $method)

+ {

+ $method->delete_notifications($notification_type_id, $item_id, $parent_id, $user_id);

+ }

+ if ($this->subscription_types === null)

+ $this->subscription_types = array();

+ foreach ($this->notification_types as $type_name => $data)

+ /** @var type\base $type */

+ $type = $this->get_item_type_class($type_name);

+

+ if ($type instanceof \phpbb\notification\type\type_interface && $type->is_available())

+ {

+ $options = array_merge(array(

+ 'id' => $type->get_type(),

+ 'lang' => 'NOTIFICATION_TYPE_' . strtoupper($type->get_type()),

+ 'group' => 'NOTIFICATION_GROUP_MISCELLANEOUS',

+ ), (($type::$notification_option !== false) ? $type::$notification_option : array()));

+ $this->subscription_types[$options['group']][$options['id']] = $options;

+ }

+ // Move Miscellaneous to the very last section

+ if (isset($this->subscription_types['NOTIFICATION_GROUP_MISCELLANEOUS']))

+ {

+ $miscellaneous = $this->subscription_types['NOTIFICATION_GROUP_MISCELLANEOUS'];

+ unset($this->subscription_types['NOTIFICATION_GROUP_MISCELLANEOUS']);

+ $this->subscription_types['NOTIFICATION_GROUP_MISCELLANEOUS'] = $miscellaneous;

+ }

+ return $this->subscription_types;

+ /** @var method\method_interface $method */

+ foreach ($this->get_available_subscription_methods() as $method_name => $method)

+ {

+ $subscription_methods[$method_name] = array(

+ 'id' => $method->get_type(),

+ 'lang' => str_replace('.', '_', strtoupper($method->get_type())),

+ );

+ }

+

+ return $subscription_methods;

+ }

+

+ /**

+ * Get all of the subscription methods

+ *

+ * @return array Array of method's instances

+ */

+ private function get_subscription_methods_instances()

+ {

+ $subscription_methods = array();

+

+ if ($method instanceof \phpbb\notification\method\method_interface)

+ {

+ $subscription_methods[$method_name] = $method;

+ }

+ }

+

+ return $subscription_methods;

+ }

+

+ /**

+ * Get all of the available subscription methods

+ *

+ * @return array Array of method's instances

+ */

+ private function get_available_subscription_methods()

+ {

+ $subscription_methods = array();

+

+ /** @var method\method_interface $method */

+ foreach ($this->get_subscription_methods_instances() as $method_name => $method)

+ {

+ if ($method->is_available())

+ $subscription_methods[$method_name] = $method;

+

+ /**

+ * Get user's notification data

+ *

+ * @param int $user_id The user_id of the user to get the notifications for

+ *

+ * @return array User's notification

+ */

+ protected function get_user_notifications($user_id)

+ {

+ $sql = 'SELECT method, notify, item_type

+ FROM ' . $this->user_notifications_table . '

+ WHERE user_id = ' . (int) $user_id . '

+ AND item_id = 0';

+

+ $result = $this->db->sql_query($sql);

+ $user_notifications = array();

+

+ while ($row = $this->db->sql_fetchrow($result))

+ {

+ $user_notifications[$row['item_type']][] = $row;

+ }

+

+ $this->db->sql_freeresult($result);

+

+ return $user_notifications;

+ }

+

+ $user_id = $user_id ?: $this->user->data['user_id'];

+ $default_methods = $this->get_default_methods();

+

+ $user_notifications = $this->get_user_notifications($user_id);

+ foreach ($this->get_subscription_types() as $types)

+ $type_subscriptions = $default_methods;

+ if (!empty($user_notifications[$id]))

+ foreach ($user_notifications[$id] as $user_notification)

+ $key = array_search($user_notification['method'], $type_subscriptions, true);

+ if (!$user_notification['notify'])

+ if ($key !== false)

+ {

+ unset($type_subscriptions[$key]);

+ }

+

+ else if ($key === false)

+ $type_subscriptions[] = $user_notification['method'];

+ if (!empty($type_subscriptions))

+ {

+ $subscriptions[$id] = $type_subscriptions;

+ }

+ * @param string $method The method of the notification e.g. 'board', 'email', or 'jabber'

+ * (if null a subscription will be added for all the defaults methods)

+ public function add_subscription($item_type, $item_id = 0, $method = null, $user_id = false)

+ if ($method === null)

+ foreach ($this->get_default_methods() as $method_name)

+ {

+ $this->add_subscription($item_type, $item_id, $method_name, $user_id);

+ }

+

+ return;

+ * @param string $method The method of the notification e.g. 'board', 'email', or 'jabber'

+ public function delete_subscription($item_type, $item_id = 0, $method = null, $user_id = false)

+ if ($method === null)

+ foreach ($this->get_default_methods() as $method_name)

+ $this->delete_subscription($item_type, $item_id, $method_name, $user_id);

+

+ return;

+ $user_id = $user_id ?: $this->user->data['user_id'];

+

+ // If a notification is never used, its type will not be added to the database

+ // nor its id cached. If this method is called by an extension during the

+ // purge step, and that extension never used its notifications,

+ // get_notification_type_id() will throw an exception. However,

+ // because no notification type was added to the database,

+ // there is nothing to delete, so we can silently drop the exception.

+ try

+ {

+ $notification_type_id = $this->get_notification_type_id($notification_type_name);

+ /** @var method\method_interface $method */

+ foreach ($this->get_available_subscription_methods() as $method)

+ {

+ $method->purge_notifications($notification_type_id);

+ }

+ }

+ catch (\phpbb\notification\exception $e)

+ {

+ // Continue

+ }

+ * @param bool $only_read True (default) to only prune read notifications

+ /** @var method\method_interface $method */

+ foreach ($this->get_available_subscription_methods() as $method)

+ {

+ $method->prune_notifications($timestamp, $only_read);

+ }

+ }

+ /**

+ * Helper to get the list of methods enabled by default

+ *

+ * @return method\method_interface[]

+ */

+ public function get_default_methods()

+ {

+ $default_methods = array();

+

+ foreach ($this->notification_methods as $method)

+ {

+ if ($method->is_enabled_by_default() && $method->is_available())

+ {

+ $default_methods[] = $method->get_type();

+ }

+ }

+

+ return $default_methods;

+ * Helper to get the notifications item type class and set it up

+ *

+ * @param string $notification_type_name

+ * @param array $data

+ * @return type\type_interface

+ */

+ * Helper to get the notifications method class and set it up

+ *

+ * @param string $method_name

+ * @return method\method_interface

+ */

+ * Helper to load objects (notification types/methods)

+ *

+ * @param string $object_name

+ * @return method\method_interface|type\type_interface

+ */

+ * @throws \phpbb\notification\exception

+ throw new \phpbb\notification\exception('NOTIFICATION_TYPE_NOT_EXIST', array($notification_type_name));

+

+ /**

+ * Find the users which are already notified

+ *

+ * @param bool|string|array $notification_type_name Type identifier or array of item types (only acceptable if the $data is identical for the specified types). False to retrieve all item types

+ * @param array $options

+ * @return array The list of the notified users

+ */

+ public function get_notified_users($notification_type_name, array $options)

+ {

+ $notification_type_id = $this->get_notification_type_id($notification_type_name);

+

+ $notified_users = array();

+

+ /** @var method\method_interface $method */

+ foreach ($this->get_available_subscription_methods() as $method)

+ {

+ $notified_users = $notified_users + $method->get_notified_users($notification_type_id, $options);

+ }

+

+ return $notified_users;

+ }

+* 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.

+ * Set notification manager (required)

+ *

+ * @param \phpbb\notification\manager $notification_manager

+ */

+ public function set_notification_manager(\phpbb\notification\manager $notification_manager)

+ {

+ $this->notification_manager = $notification_manager;

+ }

+

+ /**

+ * Is the method enable by default?

+ *

+ * @return bool

+ public function is_enabled_by_default()

+ return false;

+ * {@inheritdoc}

+ public function get_notified_users($notification_type_id, array $options)

+ return array();

+ }

+

+ /**

+ * {@inheritdoc}

+ */

+ public function load_notifications(array $options = array())

+ {

+ return array(

+ 'notifications' => array(),

+ 'unread_count' => 0,

+ 'total_count' => 0,

+ );

+ * {@inheritdoc}

+ */

+ public function update_notification($notification, array $data, array $options)

+ {

+ }

+

+ /**

+ * {@inheritdoc

+ */

+ public function mark_notifications($notification_type_id, $item_id, $user_id, $time = false, $mark_read = true)

+ {

+ }

+

+ /**

+ * {@inheritdoc}

+ */

+ public function mark_notifications_by_parent($notification_type_id, $item_parent_id, $user_id, $time = false, $mark_read = true)

+ {

+ }

+

+ /**

+ * {@inheritdoc}

+ */

+ public function mark_notifications_by_id($notification_id, $time = false, $mark_read = true)

+ {

+ }

+

+ /**

+ * {@inheritdoc}

+ */

+ public function delete_notifications($notification_type_id, $item_id, $parent_id = false, $user_id = false)

+ {

+ }

+

+ /**

+ * {@inheritdoc}

+ */

+ public function prune_notifications($timestamp, $only_read = true)

+ {

+ }

+

+ /**

+ * {@inheritdoc}

+ */

+ public function purge_notifications($notification_type_id)

+ {

+ }

+

+ /**

+<?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\method;

+

+/**

+* In Board notification method class

+* This class handles in board notifications. This method is enabled by default.

+*

+* @package notifications

+*/

+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 */

+ protected $notification_types_table;

+

+ /** @var string */

+ protected $notifications_table;

+

+ /**

+ * Notification Method Board 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\config\config $config

+ * @param string $notification_types_table

+ * @param string $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->db = $db;

+ $this->cache = $cache;

+ $this->user = $user;

+ $this->config = $config;

+ $this->notification_types_table = $notification_types_table;

+ $this->notifications_table = $notifications_table;

+

+ }

+

+ /**

+ * {@inheritdoc}

+ */

+ public function add_to_queue(\phpbb\notification\type\type_interface $notification)

+ {

+ $this->queue[] = $notification;

+ }

+

+ /**

+ * {@inheritdoc}

+ */

+ public function get_type()

+ {

+ return 'notification.method.board';

+ }

+

+ /**

+ * {@inheritdoc}

+ */

+ public function is_available()

+ {

+ return $this->config['allow_board_notifications'];

+ }

+

+ /**

+ * {@inheritdoc}

+ */

+ public function is_enabled_by_default()

+ {

+ return true;

+ }

+

+ /**

+ * {@inheritdoc}

+ */

+ public function get_notified_users($notification_type_id, array $options)

+ {

+ $notified_users = array();

+ $sql = 'SELECT n.*

+ FROM ' . $this->notifications_table . ' n, ' . $this->notification_types_table . ' nt

+ WHERE n.notification_type_id = ' . (int) $notification_type_id .

+ (isset($options['item_id']) ? ' AND n.item_id = ' . (int) $options['item_id'] : '') .

+ (isset($options['item_parent_id']) ? ' AND n.item_parent_id = ' . (int) $options['item_parent_id'] : '') .

+ (isset($options['user_id']) ? ' AND n.user_id = ' . (int) $options['user_id'] : '') .

+ (isset($options['read']) ? ' AND n.notification_read = ' . (int) $options['read'] : '') .'

+ AND nt.notification_type_id = n.notification_type_id

+ AND nt.notification_type_enabled = 1';

+ $result = $this->db->sql_query($sql);

+ while ($row = $this->db->sql_fetchrow($result))

+ {

+ $notified_users[$row['user_id']] = $row;

+ }

+ $this->db->sql_freeresult($result);

+

+ return $notified_users;

+ }

+

+ /**

+ * {@inheritdoc}

+ */

+ public function load_notifications(array $options = array())

+ {

+ // Merge default options

+ $options = array_merge(array(

+ 'notification_id' => false,

+ 'user_id' => $this->user->data['user_id'],

+ 'order_by' => 'notification_time',

+ 'order_dir' => 'DESC',

+ 'limit' => 0,

+ 'start' => 0,

+ 'all_unread' => false,

+ 'count_unread' => false,

+ 'count_total' => false,

+ ), $options);

+

+ // 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

+ if ($options['user_id'] == $this->user->data['user_id'] && ($this->user->data['user_id'] == ANONYMOUS || $this->user->data['user_type'] == USER_IGNORE))

+ {

+ return array(

+ 'notifications' => array(),

+ 'unread_count' => 0,

+ 'total_count' => 0,

+ );

+ }

+

+ $notifications = $user_ids = array();

+ $load_special = array();

+ $total_count = $unread_count = 0;

+

+ if ($options['count_unread'])

+ {

+ // Get the total number of unread notifications

+ $sql = 'SELECT COUNT(n.notification_id) AS unread_count

+ FROM ' . $this->notifications_table . ' n, ' . $this->notification_types_table . ' nt

+ WHERE n.user_id = ' . (int) $options['user_id'] . '

+ AND n.notification_read = 0

+ AND nt.notification_type_id = n.notification_type_id

+ AND nt.notification_type_enabled = 1';

+ $result = $this->db->sql_query($sql);

+ $unread_count = (int) $this->db->sql_fetchfield('unread_count');

+ $this->db->sql_freeresult($result);

+ }

+

+ if ($options['count_total'])

+ {

+ // Get the total number of notifications

+ $sql = 'SELECT COUNT(n.notification_id) AS total_count

+ FROM ' . $this->notifications_table . ' n, ' . $this->notification_types_table . ' nt

+ WHERE n.user_id = ' . (int) $options['user_id'] . '

+ AND nt.notification_type_id = n.notification_type_id

+ AND nt.notification_type_enabled = 1';

+ $result = $this->db->sql_query($sql);

+ $total_count = (int) $this->db->sql_fetchfield('total_count');

+ $this->db->sql_freeresult($result);

+ }

+

+ if (!$options['count_total'] || $total_count)

+ {

+ $rowset = array();

+

+ // Get the main notifications

+ $sql = 'SELECT n.*, nt.notification_type_name

+ FROM ' . $this->notifications_table . ' n, ' . $this->notification_types_table . ' nt

+ WHERE n.user_id = ' . (int) $options['user_id'] .

+ (($options['notification_id']) ? ((is_array($options['notification_id'])) ? ' AND ' . $this->db->sql_in_set('n.notification_id', $options['notification_id']) : ' AND n.notification_id = ' . (int) $options['notification_id']) : '') . '

+ AND nt.notification_type_id = n.notification_type_id

+ AND nt.notification_type_enabled = 1

+ ORDER BY n.' . $this->db->sql_escape($options['order_by']) . ' ' . $this->db->sql_escape($options['order_dir']);

+ $result = $this->db->sql_query_limit($sql, $options['limit'], $options['start']);

+

+ while ($row = $this->db->sql_fetchrow($result))

+ {

+ $rowset[$row['notification_id']] = $row;

+ }

+ $this->db->sql_freeresult($result);

+

+ // Get all unread notifications

+ if ($unread_count && $options['all_unread'] && !empty($rowset))

+ {

+ $sql = 'SELECT n.*, nt.notification_type_name

+ FROM ' . $this->notifications_table . ' n, ' . $this->notification_types_table . ' nt

+ WHERE n.user_id = ' . (int) $options['user_id'] . '

+ AND n.notification_read = 0

+ AND ' . $this->db->sql_in_set('n.notification_id', array_keys($rowset), true) . '

+ AND nt.notification_type_id = n.notification_type_id

+ AND nt.notification_type_enabled = 1

+ ORDER BY n.' . $this->db->sql_escape($options['order_by']) . ' ' . $this->db->sql_escape($options['order_dir']);

+ $result = $this->db->sql_query_limit($sql, $options['limit'], $options['start']);

+

+ while ($row = $this->db->sql_fetchrow($result))

+ {

+ $rowset[$row['notification_id']] = $row;

+ }

+ $this->db->sql_freeresult($result);

+ }

+

+ foreach ($rowset as $row)

+ {

+ $notification = $this->notification_manager->get_item_type_class($row['notification_type_name'], $row);

+

+ // Array of user_ids to query all at once

+ $user_ids = array_merge($user_ids, $notification->users_to_query());

+

+ // Some notification types also require querying additional tables themselves

+ if (!isset($load_special[$row['notification_type_name']]))

+ {

+ $load_special[$row['notification_type_name']] = array();

+ }

+ $load_special[$row['notification_type_name']] = array_merge($load_special[$row['notification_type_name']], $notification->get_load_special());

+

+ $notifications[$row['notification_id']] = $notification;

+ }

+

+ $this->user_loader->load_users($user_ids);

+

+ // Allow each type to load its own special items

+ foreach ($load_special as $item_type => $data)

+ {

+ $item_class = $this->notification_manager->get_item_type_class($item_type);

+

+ $item_class->load_special($data, $notifications);

+ }

+ }

+

+ return array(

+ 'notifications' => $notifications,

+ 'unread_count' => $unread_count,

+ 'total_count' => $total_count,

+ );

+ }

+

+ /**

+ * {@inheritdoc}

+ */

+ public function notify()

+ {

+ $insert_buffer = new \phpbb\db\sql_insert_buffer($this->db, $this->notifications_table);

+

+ /** @var \phpbb\notification\type\type_interface $notification */

+ foreach ($this->queue as $notification)

+ {

+ $data = $notification->get_insert_array();

+ $insert_buffer->insert($data);

+ }

+

+ $insert_buffer->flush();

+

+ // We're done, empty the queue

+ $this->empty_queue();

+ }

+

+ /**

+ * {@inheritdoc}

+ */

+ public function update_notification($notification, array $data, array $options)

+ {

+ // Allow the notifications class to over-ride the update_notifications functionality

+ if (method_exists($notification, 'update_notifications'))

+ {

+ // Return False to over-ride the rest of the update

+ if ($notification->update_notifications($data) === false)

+ {

+ return;

+ }

+ }

+

+ $notification_type_id = $this->notification_manager->get_notification_type_id($notification->get_type());

+ $update_array = $notification->create_update_array($data);

+

+ $sql = 'UPDATE ' . $this->notifications_table . '

+ SET ' . $this->db->sql_build_array('UPDATE', $update_array) . '

+ WHERE notification_type_id = ' . (int) $notification_type_id .

+ (isset($options['item_id']) ? ' AND item_id = ' . (int) $options['item_id'] : '') .

+ (isset($options['item_parent_id']) ? ' AND item_parent_id = ' . (int) $options['item_parent_id'] : '') .

+ (isset($options['user_id']) ? ' AND user_id = ' . (int) $options['user_id'] : '') .

+ (isset($options['read']) ? ' AND notification_read = ' . (int) $options['read'] : '');

+ $this->db->sql_query($sql);

+ }

+

+ /**

+ * {@inheritdoc}

+ */

+ public function mark_notifications($notification_type_id, $item_id, $user_id, $time = false, $mark_read = true)

+ {

+ $time = ($time !== false) ? $time : time();

+

+ $sql = 'UPDATE ' . $this->notifications_table . '

+ SET notification_read = ' . ($mark_read ? 1 : 0) . '

+ WHERE notification_time <= ' . (int) $time .

+ (($notification_type_id !== false) ? ' AND ' .

+ (is_array($notification_type_id) ? $this->db->sql_in_set('notification_type_id', $notification_type_id) : 'notification_type_id = ' . $notification_type_id) : '') .

+ (($user_id !== false) ? ' AND ' . (is_array($user_id) ? $this->db->sql_in_set('user_id', $user_id) : 'user_id = ' . (int) $user_id) : '') .

+ (($item_id !== false) ? ' AND ' . (is_array($item_id) ? $this->db->sql_in_set('item_id', $item_id) : 'item_id = ' . (int) $item_id) : '');

+ $this->db->sql_query($sql);

+ }

+

+ /**

+ * {@inheritdoc}

+ */

+ public function mark_notifications_by_parent($notification_type_id, $item_parent_id, $user_id, $time = false, $mark_read = true)

+ {

+ $time = ($time !== false) ? $time : time();

+

+ $sql = 'UPDATE ' . $this->notifications_table . '

+ SET notification_read = ' . ($mark_read ? 1 : 0) . '

+ WHERE notification_time <= ' . (int) $time .

+ (($notification_type_id !== false) ? ' AND ' .

+ (is_array($notification_type_id) ? $this->db->sql_in_set('notification_type_id', $notification_type_id) : 'notification_type_id = ' . $notification_type_id) : '') .

+ (($item_parent_id !== false) ? ' AND ' . (is_array($item_parent_id) ? $this->db->sql_in_set('item_parent_id', $item_parent_id, false, true) : 'item_parent_id = ' . (int) $item_parent_id) : '') .

+ (($user_id !== false) ? ' AND ' . (is_array($user_id) ? $this->db->sql_in_set('user_id', $user_id) : 'user_id = ' . (int) $user_id) : '');

+ $this->db->sql_query($sql);

+ }

+

+ /**

+ * {@inheritdoc}

+ */

+ public function mark_notifications_by_id($notification_id, $time = false, $mark_read = true)

+ {

+ $time = ($time !== false) ? $time : time();

+

+ $sql = 'UPDATE ' . $this->notifications_table . '

+ SET notification_read = ' . ($mark_read ? 1 : 0) . '

+ WHERE notification_time <= ' . (int) $time . '

+ AND ' . ((is_array($notification_id)) ? $this->db->sql_in_set('notification_id', $notification_id) : 'notification_id = ' . (int) $notification_id);

+ $this->db->sql_query($sql);

+ }

+

+ /**

+ * {@inheritdoc}

+ */

+ public function delete_notifications($notification_type_id, $item_id, $parent_id = false, $user_id = false)

+ {

+ $sql = 'DELETE FROM ' . $this->notifications_table . '

+ WHERE notification_type_id = ' . (int) $notification_type_id . '

+ AND ' . (is_array($item_id) ? $this->db->sql_in_set('item_id', $item_id) : 'item_id = ' . (int) $item_id) .

+ (($parent_id !== false) ? ' AND ' . ((is_array($parent_id) ? $this->db->sql_in_set('item_parent_id', $parent_id) : 'item_parent_id = ' . (int) $parent_id)) : '') .

+ (($user_id !== false) ? ' AND ' . ((is_array($user_id) ? $this->db->sql_in_set('user_id', $user_id) : 'user_id = ' . (int) $user_id)) : '');

+ $this->db->sql_query($sql);

+ }

+

+ /**

+ * {@inheritdoc}

+ */

+ public function prune_notifications($timestamp, $only_read = true)

+ {

+ $sql = 'DELETE FROM ' . $this->notifications_table . '

+ WHERE notification_time < ' . (int) $timestamp .

+ (($only_read) ? ' AND notification_read = 1' : '');

+ $this->db->sql_query($sql);

+

+ $this->config->set('read_notification_last_gc', time(), false);

+ }

+

+ /**

+ * {@inheritdoc}

+ */

+ public function purge_notifications($notification_type_id)

+ {

+ $sql = 'DELETE FROM ' . $this->notifications_table . '

+ WHERE notification_type_id = ' . (int) $notification_type_id;

+ $this->db->sql_query($sql);

+

+ $sql = 'DELETE FROM ' . $this->notification_types_table . '

+ WHERE notification_type_id = ' . (int) $notification_type_id;

+ $this->db->sql_query($sql);

+

+ $this->cache->destroy('notification_type_ids');

+ }

+}

+* 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.

+

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

+ }

+

+ return 'notification.method.email';

+* 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.

+

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

+ }

+

+ return 'notification.method.jabber';

+ $this->notify_using_messenger(NOTIFY_IM, 'short/');

+* 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.

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

+ }

+

+ /** @var \phpbb\notification\type\type_interface $notification */

+ if ($user['user_type'] == USER_IGNORE || ($user['user_type'] == USER_INACTIVE && $user['user_inactive_reason'] == INACTIVE_MANUAL) || in_array($notification->user_id, $banned_users))

+* 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.

+ * Is the method enable by default?

+ *

+ * @return bool

+ */

+ public function is_enabled_by_default();

+

+ /**

+ * Return the list of the users already notified

+ *

+ * @param int $notification_type_id Type of the notification

+ * @param array $options

+ * @return array User

+ */

+ public function get_notified_users($notification_type_id, array $options);

+

+ /**

+ * Load the user's notifications

+ *

+ * @param array $options Optional options to control what notifications are loaded

+ * notification_id Notification id to load (or array of notification ids)

+ * user_id User id to load notifications for (Default: $user->data['user_id'])

+ * order_by Order by (Default: notification_time)

+ * order_dir Order direction (Default: DESC)

+ * limit Number of notifications to load (Default: 5)

+ * start Notifications offset (Default: 0)

+ * all_unread Load all unread notifications? If set to true, count_unread is set to true (Default: false)

+ * count_unread Count all unread notifications? (Default: false)

+ * count_total Count all notifications? (Default: false)

+ * @return array Array of information based on the request with keys:

+ * 'notifications' array of notification type objects

+ * 'unread_count' number of unread notifications the user has if count_unread is true in the options

+ * 'total_count' number of notifications the user has if count_total is true in the options

+ */

+ public function load_notifications(array $options = array());

+

+ /**

+

+ /**

+ * Update a notification

+ *

+ * @param \phpbb\notification\type\type_interface $notification Notification to update

+ * @param array $data Data specific for this type that will be updated

+ * @param array $options

+ */

+ public function update_notification($notification, array $data, array $options);

+

+ /**

+ * Mark notifications read or unread

+ *

+ * @param bool|string $notification_type_id Type identifier of item types. False to mark read for all item types

+ * @param bool|int|array $item_id Item id or array of item ids. False to mark read for all item ids

+ * @param bool|int|array $user_id User id or array of user ids. False to mark read for all user ids

+ * @param bool|int $time Time at which to mark all notifications prior to as read. False to mark all as read. (Default: False)

+ * @param bool $mark_read Define if the notification as to be set to True or False. (Default: True)

+ */

+ public function mark_notifications($notification_type_id, $item_id, $user_id, $time = false, $mark_read = true);

+

+ /**

+ * Mark notifications read or unread from a parent identifier

+ *

+ * @param string $notification_type_id Type identifier of item types

+ * @param bool|int|array $item_parent_id Item parent id or array of item parent ids. False to mark read for all item parent ids

+ * @param bool|int|array $user_id User id or array of user ids. False to mark read for all user ids

+ * @param bool|int $time Time at which to mark all notifications prior to as read. False to mark all as read. (Default: False)

+ * @param bool $mark_read Define if the notification as to be set to True or False. (Default: True)

+ */

+ public function mark_notifications_by_parent($notification_type_id, $item_parent_id, $user_id, $time = false, $mark_read = true);

+

+ /**

+ * Mark notifications read or unread

+ *

+ * @param int $notification_id Notification id of notification ids.

+ * @param bool|int $time Time at which to mark all notifications prior to as read. False to mark all as read. (Default: False)

+ * @param bool $mark_read Define if the notification as to be set to True or False. (Default: True)

+ */

+ public function mark_notifications_by_id($notification_id, $time = false, $mark_read = true);

+

+ /**

+ * Delete a notification

+ *

+ * @param string $notification_type_id Type identifier of item types

+ * @param int|array $item_id Identifier within the type (or array of ids)

+ * @param mixed $parent_id Parent identifier within the type (or array of ids), used in combination with item_id if specified (Default: false; not checked)

+ * @param mixed $user_id User id (Default: false; not checked)

+ */

+ public function delete_notifications($notification_type_id, $item_id, $parent_id = false, $user_id = false);

+

+ /**

+ * Delete all notifications older than a certain time

+ *

+ * @param int $timestamp Unix timestamp to delete all notifications that were created before

+ * @param bool $only_read True (default) to only prune read notifications

+ */

+ public function prune_notifications($timestamp, $only_read = true);

+

+ /**

+ * Purge all notifications of a certain type

+ *

+ * This should be called when an extension which has notification types

+ * is purged so that all those notifications are removed

+ *

+ * @param string $notification_type_id Type identifier of the subscription

+ */

+ public function purge_notifications($notification_type_id);

+* 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.

+

+ return 'notification.type.admin_activate_user';

+ static public $notification_option = array(

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

+ }

+

+ static public function get_item_id($user)

+ static public function get_item_parent_id($post)

+ while ($row = $this->db->sql_fetchrow($result))

+ return $this->user_loader->get_avatar($this->item_id, false, true);

+ return $this->language->lang($this->language_key, $username);

+ $username = $this->user_loader->get_username($this->item_id, 'username');

+ return $this->user_loader->get_username($this->item_id, 'profile');

+ parent::create_insert_array($user, $pre_create_data);

+* 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.

+

+ return 'notification.type.approve_post';

+ static public $notification_option = array(

+ * @param array $post Data from submit_post

+ * @param array $options Options for finding users for notification

+ $users[$post['poster_id']] = $this->notification_manager->get_default_methods();

+ return $this->get_authorised_recipients(array_keys($users), $post['forum_id'], array_merge($options, array(

+ 'item_type' => static::$notification_option['id'],

+ * {@inheritdoc}

+ parent::create_insert_array($post, $pre_create_data);

+ $this->notification_time = time();

+ }

+

+ /**

+ * {@inheritdoc}

+ */

+ public function get_insert_array()

+ {

+ $data = parent::get_insert_array();

+ $data['notification_time'] = $this->notification_time;

+

+ /**

+ * {inheritDoc}

+ */

+ public function get_redirect_url()

+ {

+ return $this->get_url();

+ }

+* 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.

+

+ return 'notification.type.approve_topic';

+ static public $notification_option = array(

+ * @param array $post Data from submit_post

+ * @param array $options Options for finding users for notification

+ $users[$post['poster_id']] = $this->notification_manager->get_default_methods();

+ return $this->get_authorised_recipients(array_keys($users), $post['forum_id'], array_merge($options, array(

+ 'item_type' => static::$notification_option['id'],

+ * {@inheritdoc}

+ parent::create_insert_array($post, $pre_create_data);

+

+ $this->notification_time = time();

+ }

+

+ /**

+ * {@inheritdoc}

+ */

+ public function get_insert_array()

+ {

+ $data = parent::get_insert_array();

+ $data['notification_time'] = $this->notification_time;

+* 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.

+ /** @var \phpbb\db\driver\driver_interface */

+ /** @var \phpbb\language\language */

+ protected $language;

+ static public $notification_option = false;

+ * Identification data

+ * Notification Type Base Constructor

+ *

+ * @param \phpbb\db\driver\driver_interface $db

+ * @param \phpbb\language\language $language

+ * @param \phpbb\user $user

+ * @param \phpbb\auth\auth $auth

+ * @param string $phpbb_root_path

+ * @param string $php_ext

+ * @param string $user_notifications_table

+ */

+ public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\language\language $language, \phpbb\user $user, \phpbb\auth\auth $auth, $phpbb_root_path, $php_ext, $user_notifications_table)

+ $this->language = $language;

+ * @param mixed $value

+ *

+ * {@inheritdoc}

+ 'notification_data' => array(),

+ }

+ /**

+ * {@inheritdoc}

+ */

+ public function get_insert_array()

+ {

+ $this->create_insert_array($type_data);

+ $data = $this->get_insert_array();

+ * {inheritDoc}

+ */

+ public function get_redirect_url()

+ {

+ return $this->get_url();

+ }

+

+ /**

+ 'STYLING' => $this->get_style_class(),

+ 'REFERENCE' => $this->get_reference(),

+ 'FORUM' => $this->get_forum(),

+ 'REASON' => $this->get_reason(),

+ * @return false

+ * Get the CSS style class of the notification (fall back)

+ *

+ * @return string

+ */

+ public function get_style_class()

+ {

+ return '';

+ }

+

+ /**

+ * Get the reference of the notifcation (fall back)

+ *

+ * @return string

+ */

+ public function get_reference()

+ {

+ return '';

+ }

+

+ /**

+ * Get the forum of the notification reference (fall back)

+ *

+ * @return string

+ */

+ public function get_forum()

+ {

+ return '';

+ }

+

+ /**

+ * Get the reason for the notifcation (fall back)

+ *

+ * @return string

+ */

+ public function get_reason()

+ {

+ return '';

+ }

+

+ /**

+ * Load the special items (fall back)

+ *

+ * @param array $data

+ * @param array $notifications

+ */

+ * Pre create insert array function (fall back)

+ *

+ * @param array $type_data

+ * @param array $notify_users

+ * @return array

+ */

+ * Find the users who want to receive notifications (helper)

+ *

+ * @param array|bool $user_ids User IDs to check if they want to receive notifications

+ * (Bool False to check all users besides anonymous and bots (USER_IGNORE))

+ * @param array $options

+ * @return array

+ */

+ // No rows at all for this user, use the default methods

+ $rowset[$user_id] = $this->notification_manager->get_default_methods();

+ $where = array(

+ 'notification_type_id = ' . (int) $this->notification_type_id,

+ 'item_id = ' . (int) $this->item_id,

+ 'user_id = ' . (int) $this->user_id,

+ );

+

+ $where = implode(' AND ', $where);

+ else

+ {

+ $this->notification_manager->mark_notifications($this->get_type(), (int) $this->item_id, (int) $this->user_id, false, $this->notification_read);

+ }

+

+ return null;

+ }

+

+ /**

+ * Get a list of users that are authorised to receive notifications

+ *

+ * @param array $users Array of users that have subscribed to a notification

+ * @param int $forum_id Forum ID of the forum

+ * @param array $options Array of notification options

+ * @param bool $sort Whether the users array should be sorted. Default: false

+ * @return array Array of users that are authorised recipients

+ */

+ protected function get_authorised_recipients($users, $forum_id, $options, $sort = false)

+ {

+ if (empty($users))

+ {

+ return array();

+ }

+

+ $users = array_unique($users);

+

+ if ($sort)

+ {

+ sort($users);

+ }

+

+ $auth_read = $this->auth->acl_get_list($users, 'f_read', $forum_id);

+

+ if (empty($auth_read))

+ {

+ return array();

+ }

+ return $this->check_user_notification_options($auth_read[$forum_id]['f_read'], $options);

+* 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.

+

+ return 'notification.type.bookmark';

+ static public $notification_option = array(

+ * @param array $post Data from submit_post

+ * @param array $options Options for finding users for notification

+ $users[] = (int) $row['user_id'];

+ $notify_users = $this->get_authorised_recipients($users, $post['forum_id'], $options, true);

+ if (empty($notify_users))

+ $notified_users = $this->notification_manager->get_notified_users($this->get_type(), array(

+ 'item_parent_id' => static::get_item_parent_id($post),

+ 'read' => 0,

+ ));

+

+ foreach ($notified_users as $user => $notification_data)

+ unset($notify_users[$user]);

+

+ /** @var bookmark $notification */

+ $notification = $this->notification_manager->get_item_type_class($this->get_type(), $notification_data);

+ $update_responders = $notification->add_responders($post);

+ if (!empty($update_responders))

+ {

+ $this->notification_manager->update_notification($notification, $update_responders, array(

+ 'item_parent_id' => self::get_item_parent_id($post),

+ 'read' => 0,

+ 'user_id' => $user,

+ ));

+ }

+* 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.

+

+ return 'notification.type.disapprove_post';

+ }

+

+ /**

+ * Get the CSS style class of the notification

+ *

+ * @return string

+ */

+ public function get_style_class()

+ {

+ return 'notification-disapproved';

+ static public $notification_option = array(

+ return $this->language->lang($this->language_key);

+ }

+

+ /**

+ * Get the HTML formatted reference of the notification

+ *

+ * @return string

+ */

+ public function get_reference()

+ {

+ return $this->language->lang(

+ 'NOTIFICATION_REFERENCE',

+ censor_text($this->get_data('topic_title'))

+ );

+ }

+

+ /**

+ * Get the reason for the disapproval notification

+ *

+ * @return string

+ */

+ public function get_reason()

+ {

+ return $this->language->lang(

+ 'NOTIFICATION_REASON',

+ * {@inheritdoc}

+ parent::create_insert_array($post, $pre_create_data);

+

+ $this->notification_time = time();

+ }

+ /**

+ * {@inheritdoc}

+ */

+ public function get_insert_array()

+ {

+ $data = parent::get_insert_array();

+ $data['notification_time'] = $this->notification_time;

+* 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.

+

+ return 'notification.type.disapprove_topic';

+ }

+

+ /**

+ * Get the CSS style class of the notification

+ *

+ * @return string

+ */

+ public function get_style_class()

+ {

+ return 'notification-disapproved';

+ static public $notification_option = array(

+ return $this->language->lang($this->language_key);

+ }

+

+ /**

+ * Get the HTML formatted reference of the notification

+ *

+ * @return string

+ */

+ public function get_reference()

+ {

+ return $this->language->lang(

+ 'NOTIFICATION_REFERENCE',

+ censor_text($this->get_data('topic_title'))

+ );

+ }

+

+ /**

+ * Get the reason for the disapproval notification

+ *

+ * @return string

+ */

+ public function get_reason()

+ {

+ return $this->language->lang(

+ 'NOTIFICATION_REASON',

+ * {@inheritdoc}

+ parent::create_insert_array($post, $pre_create_data);

+

+ $this->notification_time = time();

+ }

+ /**

+ * {@inheritdoc}

+ */

+ public function get_insert_array()

+ {

+ $data = parent::get_insert_array();

+ $data['notification_time'] = $this->notification_time;

+* 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.

+ return 'notification.type.group_request';

+ static public $notification_option = array(

+ /** @var \phpbb\user_loader */

+ protected $user_loader;

+

+ public function set_user_loader(\phpbb\user_loader $user_loader)

+ {

+ $this->user_loader = $user_loader;

+ }

+

+ static public function get_item_id($group)

+ static public function get_item_parent_id($group)

+ return $this->user_loader->get_avatar($this->item_id, false, true);

+ return $this->language->lang('NOTIFICATION_GROUP_REQUEST', $username, $this->get_data('group_name'));

+ parent::create_insert_array($group, $pre_create_data);

+* 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.

+ return 'notification.type.group_request_approved';

+ static public function get_item_id($group)

+ static public function get_item_parent_id($group)

+ $users[$user_id] = $this->notification_manager->get_default_methods();

+ return $this->language->lang('NOTIFICATION_GROUP_REQUEST_APPROVED', $this->get_data('group_name'));

+ parent::create_insert_array($group, $pre_create_data);

+* 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.

+

+ return 'notification.type.pm';

+ static public $notification_option = array(

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

+ }

+

+ static public function get_item_id($pm)

+ static public function get_item_parent_id($pm)

+ * @param array $pm Data from submit_pm

+ * @param array $options Options for finding users for notification

+ return $this->user_loader->get_avatar($this->get_data('from_user_id'), false, true);

+ 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')

+ );

+ * {@inheritdoc}

+ parent::create_insert_array($pm, $pre_create_data);

+* 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.

+

+ return 'notification.type.post';

+ static public $notification_option = array(

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

+ }

+

+ * @return int The post id

+ static public function get_item_id($post)

+ * @return int The topic id

+ static public function get_item_parent_id($post)

+ * @param array $post Data from submit_post

+ * @param array $options Options for finding users for notification

+ $users[] = (int) $row['user_id'];

+ $users[] = (int) $row['user_id'];

+ $notify_users = $this->get_authorised_recipients($users, $post['forum_id'], $options, true);

+ if (empty($notify_users))

+ $notified_users = $this->notification_manager->get_notified_users($this->get_type(), array(

+ 'item_parent_id' => static::get_item_parent_id($post),

+ 'read' => 0,

+ ));

+

+ foreach ($notified_users as $user => $notification_data)

+ unset($notify_users[$user]);

+

+ /** @var post $notification */

+ $notification = $this->notification_manager->get_item_type_class($this->get_type(), $notification_data);

+ $update_responders = $notification->add_responders($post);

+ if (!empty($update_responders))

+ {

+ $this->notification_manager->update_notification($notification, $update_responders, array(

+ 'item_parent_id' => self::get_item_parent_id($post),

+ 'read' => 0,

+ 'user_id' => $user,

+ ));

+ }

+ return $this->user_loader->get_avatar($this->get_data('poster_id'), false, true);

+ if ($trimmed_responders_cnt > 20)

+ {

+ $usernames[] = $this->language->lang('NOTIFICATION_MANY_OTHERS');

+ }

+ else if ($trimmed_responders_cnt)

+ $usernames[] = $this->language->lang('NOTIFICATION_X_OTHERS', $trimmed_responders_cnt);

+ return $this->language->lang(

+ $this->language_key,

+ phpbb_generate_string_list($usernames, $this->user),

+ $responders_cnt

+ );

+ }

+

+ /**

+ * Get the HTML formatted reference of the notification

+ *

+ * @return string

+ */

+ public function get_reference()

+ {

+ return $this->language->lang(

+ 'NOTIFICATION_REFERENCE',

+ censor_text($this->get_data('topic_title'))

+ * {inheritDoc}

+ */

+ public function get_redirect_url()

+ {

+ return append_sid($this->phpbb_root_path . 'viewtopic.' . $this->php_ext, "t={$this->item_parent_id}&amp;view=unread#unread");

+ }

+

+ /**

+ $this->db->sql_freeresult($result);

+ * {@inheritdoc}

+ parent::create_insert_array($post, $pre_create_data);

+ * @return array Array of responder data

+ return array();

+ // Do not add more than 25 responders,

+ // we trim the username list to "a, b, c and x others" anyway

+ // so there is no use to add all of them anyway.

+ if (sizeof($responders) > 25)

+ {

+ return array();

+ }

+

+ return array();

+ $serialized_data = serialize($this->get_data(false));

+

+ // If the data is longer then 4000 characters, it would cause a SQL error.

+ // We don't add the username to the list if this is the case.

+ if (utf8_strlen($serialized_data) >= 4000)

+ {

+ return array();

+ }

+

+ return array('notification_data' => $serialized_data);

+* 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.

+

+ return 'notification.type.post_in_queue';

+ static public $notification_option = array(

+ 'id' => 'notification.type.needs_approval',

+ * @param array $options Options for finding users for notification

+ 'item_type' => static::$notification_option['id'],

+ * {inheritDoc}

+ */

+ public function get_redirect_url()

+ {

+ return parent::get_url();

+ }

+

+ /**

+ * {@inheritdoc}

+ parent::create_insert_array($post, $pre_create_data);

+

+ $this->notification_time = time();

+ }

+ /**

+ * {@inheritdoc}

+ */

+ public function get_insert_array()

+ {

+ $data = parent::get_insert_array();

+ $data['notification_time'] = $this->notification_time;

+* 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.

+

+ * @var \phpbb\textformatter\utils_interface

+ */

+ protected $utils;

+

+ /**

+ return 'notification.type.quote';

+ static public $notification_option = array(

+ * @param array $post Data from submit_post

+ * @param array $options Options for finding users for notification

+ $usernames = $this->utils->get_outermost_quote_authors($post['post_text']);

+ if (empty($usernames))

+ $usernames = array_unique($usernames);

+ $usernames = array_map('utf8_clean_string', $usernames);

+ $users[] = (int) $row['user_id'];

+ return $this->get_authorised_recipients($users, $post['forum_id'], $options, true);

+ * @param array $post Data specific for this type that will be updated

+ * @return true

+ $old_notifications = $this->notification_manager->get_notified_users($this->get_type(), array(

+ 'item_id' => static::get_item_id($post),

+ ));

+ $notifications = array_keys($this->find_users_for_notification($post));

+ $remove_notifications = array_diff(array_keys($old_notifications), array_keys($notifications));

+ $this->notification_manager->delete_notifications($this->get_type(), static::get_item_id($post), false, $remove_notifications);

+ * {inheritDoc}

+ */

+ public function get_redirect_url()

+ {

+ return $this->get_url();

+ }

+

+ /**

+

+ /**

+ * Set the utils service used to retrieve quote authors

+ *

+ * @param \phpbb\textformatter\utils_interface $utils

+ */

+ public function set_utils(\phpbb\textformatter\utils_interface $utils)

+ {

+ $this->utils = $utils;

+ }

+* 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.

+

+ return 'notification.type.report_pm';

+ }

+

+ /**

+ * Get the CSS style class of the notification

+ *

+ * @return string

+ */

+ public function get_style_class()

+ {

+ return 'notification-reported';

+ static public $notification_option = array(

+ 'id' => 'notification.type.report',

+ * @return int The report id

+ static public function get_item_parent_id($pm)

+ * @param array $options Options for finding users for notification

+ 'item_type' => static::$notification_option['id'],

+ $user_data = $this->user_loader->get_username($this->get_data('reporter_id'), 'no_profile');

+

+ 'AUTHOR_NAME' => htmlspecialchars_decode($user_data['username']),

+ 'SUBJECT' => htmlspecialchars_decode(censor_text($this->get_data('message_subject'))),

+ 'U_VIEW_REPORT' => generate_board_url() . "mcp.{$this->php_ext}?r={$this->item_parent_id}&amp;i=pm_reports&amp;mode=pm_report_details",

+ $this->language->add_lang('mcp');

+ return $this->language->lang(

+ $this->language_key,

+ $username

+ );

+ }

+

+ /**

+ * Get the HTML formatted reference of the notification

+ *

+ * @return string

+ */

+ public function get_reference()

+ {

+ return $this->language->lang(

+ 'NOTIFICATION_REFERENCE',

+ censor_text($this->get_data('message_subject'))

+ );

+ }

+

+ /**

+ * Get the reason for the notification

+ *

+ * @return string

+ */

+ public function get_reason()

+ {

+ return $this->language->lang(

+ 'NOTIFICATION_REASON',

+ if ($this->language->is_set($this->get_data('reason_title')))

+ return $this->language->lang(

+ 'NOTIFICATION_REASON',

+ $this->language->lang($this->get_data('reason_title'))

+ return $this->language->lang(

+ 'NOTIFICATION_REASON',

+ return $this->user_loader->get_avatar($this->get_data('reporter_id'), false, true);

+ * {@inheritdoc}

+ parent::create_insert_array($post, $pre_create_data);

+* 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.

+

+ return 'notification.type.report_pm_closed';

+ * @param array $pm Data from submit_pm

+ * @param array $options Options for finding users for notification

+ return array($pm['reporter'] => $this->notification_manager->get_default_methods());

+ return $this->language->lang(

+ $username

+ );

+ }

+

+ /**

+ * Get the HTML formatted reference of the notification

+ *

+ * @return string

+ */

+ public function get_reference()

+ {

+ return $this->language->lang(

+ 'NOTIFICATION_REFERENCE',

+ return $this->user_loader->get_avatar($this->get_data('closer_id'), false, true);

+ * {@inheritdoc}

+ parent::create_insert_array($pm, $pre_create_data);

+ $this->notification_time = time();

+ }

+

+ /**

+ * {@inheritdoc}

+ */

+ public function get_insert_array()

+ {

+ $data = parent::get_insert_array();

+ $data['notification_time'] = $this->notification_time;

+* 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.

+ return 'notification.type.report_post';

+ }

+

+ /**

+ * Get the CSS style class of the notification

+ *

+ * @return string

+ */

+ public function get_style_class()

+ {

+ return 'notification-reported';

+ static public $notification_option = array(

+ 'id' => 'notification.type.report',

+ * @param array $options Options for finding users for notification

+ $this->language->add_lang('mcp');

+ return $this->language->lang(

+ $this->language_key,

+ $username

+ );

+ }

+

+ /**

+ * Get the HTML formatted reference of the notification

+ *

+ * @return string

+ */

+ public function get_reference()

+ {

+ return $this->language->lang(

+ 'NOTIFICATION_REFERENCE',

+ censor_text($this->get_data('post_subject'))

+ );

+ }

+

+ /**

+ * Get the reason for the notification

+ *

+ * @return string

+ */

+ public function get_reason()

+ {

+ return $this->language->lang(

+ 'NOTIFICATION_REASON',

+ if ($this->language->is_set($this->get_data('reason_title')))

+ return $this->language->lang(

+ 'NOTIFICATION_REASON',

+ $this->language->lang($this->get_data('reason_title'))

+ return $this->language->lang(

+ 'NOTIFICATION_REASON',

+ return $this->user_loader->get_avatar($this->get_data('reporter_id'), false, true);

+ * {@inheritdoc}

+ parent::create_insert_array($post, $pre_create_data);

+* 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.

+

+ return 'notification.type.report_post_closed';

+ * @param array $post Data from submit_post

+ * @param array $options Options for finding users for notification

+ return array($post['reporter'] => $this->notification_manager->get_default_methods());

+ return $this->language->lang(

+ $username

+ );

+ }

+

+ /**

+ * Get the HTML formatted reference of the notification

+ *

+ * @return string

+ */

+ public function get_reference()

+ {

+ return $this->language->lang(

+ 'NOTIFICATION_REFERENCE',

+ return $this->user_loader->get_avatar($this->get_data('closer_id'), false, true);

+ * {@inheritdoc}

+ parent::create_insert_array($post, $pre_create_data);

+ $this->notification_time = time();

+ }

+

+ /**

+ * {@inheritdoc}

+ */

+ public function get_insert_array()

+ {

+ $data = parent::get_insert_array();

+ $data['notification_time'] = $this->notification_time;

+* 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.

+

+ return 'notification.type.topic';

+ static public $notification_option = array(

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

+ }

+

+ * @return int The topic id

+ static public function get_item_id($post)

+ * @return int The forum id

+ static public function get_item_parent_id($post)

+ * @param array $options Options for finding users for notification

+ $users[] = (int) $row['user_id'];

+ return $this->get_authorised_recipients($users, $topic['forum_id'], $options);

+ return $this->user_loader->get_avatar($this->get_data('poster_id'), false, true);

+ return $this->language->lang(

+ $username

+ );

+ }

+

+ /**

+ * Get the HTML formatted reference of the notification

+ *

+ * @return string

+ */

+ public function get_reference()

+ {

+ return $this->language->lang(

+ 'NOTIFICATION_REFERENCE',

+ censor_text($this->get_data('topic_title'))

+ );

+ }

+

+ /**

+ * Get the forum of the notification reference

+ *

+ * @return string

+ */

+ public function get_forum()

+ {

+ return $this->language->lang(

+ 'NOTIFICATION_FORUM',

+ $this->db->sql_freeresult($result);

+ * {@inheritdoc}

+ parent::create_insert_array($post, $pre_create_data);

+* 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.

+

+ return 'notification.type.topic_in_queue';

+ static public $notification_option = array(

+ 'id' => 'notification.type.needs_approval',

+ * @param array $options Options for finding users for notification

+ 'item_type' => static::$notification_option['id'],

+ * {@inheritdoc}

+ parent::create_insert_array($topic, $pre_create_data);

+

+ $this->notification_time = time();

+ }

+ /**

+ * {@inheritdoc}

+ */

+ public function get_insert_array()

+ {

+ $data = parent::get_insert_array();

+ $data['notification_time'] = $this->notification_time;

+* 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.

+ static public function get_item_id($type_data);

+ static public function get_item_parent_id($type_data);

+ * Get the CSS style class of the notification

+ *

+ * @return string

+ */

+ public function get_style_class();

+

+ /**

+ * Get the HTML formatted reference of the notification

+ *

+ * @return string

+ */

+ public function get_reference();

+

+ /**

+ * Get the forum of the notification reference

+ *

+ * @return string

+ */

+ public function get_forum();

+

+ /**

+ * Get the url to redirect after the item has been marked as read

+ *

+ * @return string URL

+ */

+ public function get_redirect_url();

+

+ /**

+ */

+ public function create_insert_array($type_data, $pre_create_data);

+

+ /**

+ * Function for getting the data for insertion in an SQL query

+ public function get_insert_array();

+ public function mark_read($return = false);

+ public function mark_unread($return = false);