Code Coverage
 
Classes and Traits
Functions and Methods
Lines
Total
0.00% covered (danger)
0.00%
0 / 1
28.57% covered (danger)
28.57%
2 / 7
CRAP
32.14% covered (danger)
32.14%
9 / 28
topic_in_queue
0.00% covered (danger)
0.00%
0 / 1
28.57% covered (danger)
28.57%
2 / 7
48.81
32.14% covered (danger)
32.14%
9 / 28
 get_type
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
1 / 1
 is_available
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
2 / 2
 find_users_for_notification
0.00% covered (danger)
0.00%
0 / 1
11.77
35.29% covered (danger)
35.29%
6 / 17
 get_url
0.00% covered (danger)
0.00%
0 / 1
2.00
0.00% covered (danger)
0.00%
0 / 1
 create_insert_array
0.00% covered (danger)
0.00%
0 / 1
2.00
0.00% covered (danger)
0.00%
0 / 3
 get_insert_array
0.00% covered (danger)
0.00%
0 / 1
2.00
0.00% covered (danger)
0.00%
0 / 3
 get_email_template
0.00% covered (danger)
0.00%
0 / 1
2.00
0.00% covered (danger)
0.00%
0 / 1
<?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;
/**
* Topic in queue notifications class
* This class handles notifications for topics when they are put in the moderation queue (for moderators)
*/
class topic_in_queue extends \phpbb\notification\type\topic
{
    /**
    * Get notification type name
    *
    * @return string
    */
    public function get_type()
    {
        return 'notification.type.topic_in_queue';
    }
    /**
    * Language key used to output the text
    *
    * @var string
    */
    protected $language_key = 'NOTIFICATION_TOPIC_IN_QUEUE';
    /**
    * 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(
        'id'    => 'notification.type.needs_approval',
        'lang'    => 'NOTIFICATION_TYPE_IN_MODERATION_QUEUE',
        'group'    => 'NOTIFICATION_GROUP_MODERATION',
    );
    /**
    * Permission to check for (in find_users_for_notification)
    *
    * @var string Permission name
    */
    protected $permission = 'm_approve';
    /**
    * Is available
    */
    public function is_available()
    {
        $has_permission = $this->auth->acl_getf($this->permission, true);
        return (!empty($has_permission));
    }
    /**
    * Find the users who want to receive notifications
    *
    * @param array $topic Data from the topic
    * @param array $options Options for finding users for notification
    *
    * @return array
    */
    public function find_users_for_notification($topic, $options = array())
    {
        $options = array_merge(array(
            'ignore_users'        => array(),
        ), $options);
        // 0 is for global moderator permissions
        $auth_approve = $this->auth->acl_get_list(false, 'm_approve', array($topic['forum_id'], 0));
        if (empty($auth_approve))
        {
            return array();
        }
        $has_permission = array();
        if (isset($auth_approve[$topic['forum_id']][$this->permission]))
        {
            $has_permission = $auth_approve[$topic['forum_id']][$this->permission];
        }
        if (isset($auth_approve[0][$this->permission]))
        {
            $has_permission = array_unique(array_merge($has_permission, $auth_approve[0][$this->permission]));
        }
        sort($has_permission);
        $auth_read = $this->auth->acl_get_list($has_permission, 'f_read', $topic['forum_id']);
        if (empty($auth_read))
        {
            return array();
        }
        return $this->check_user_notification_options($auth_read[$topic['forum_id']]['f_read'], array_merge($options, array(
            'item_type'        => static::$notification_option['id'],
        )));
    }
    /**
    * Get the url to this item
    *
    * @return string URL
    */
    public function get_url()
    {
        return append_sid($this->phpbb_root_path . 'mcp.' . $this->php_ext, "i=queue&amp;mode=approve_details&amp;t={$this->item_id}");
    }
    /**
    * {@inheritdoc}
    */
    public function create_insert_array($topic, $pre_create_data = array())
    {
        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;
        return $data;
    }
    /**
    * Get email template
    *
    * @return string|bool
    */
    public function get_email_template()
    {
        return 'topic_in_queue';
    }
}