Code Coverage
 
Classes and Traits
Functions and Methods
Lines
Total
0.00% covered (danger)
0.00%
0 / 1
7.14% covered (danger)
7.14%
1 / 14
CRAP
16.67% covered (danger)
16.67%
14 / 84
base
0.00% covered (danger)
0.00%
0 / 1
13.33% covered (danger)
13.33%
2 / 15
550.83
16.67% covered (danger)
16.67%
14 / 84
 __construct
0.00% covered (danger)
0.00%
0 / 1
3.28
68.42% covered (warning)
68.42%
13 / 19
 set_keys
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
1 / 1
 open
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 1
 close
0.00% covered (danger)
0.00%
0 / 1
6
0.00% covered (danger)
0.00%
0 / 5
 set
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 2
 get
0.00% covered (danger)
0.00%
0 / 1
6
0.00% covered (danger)
0.00%
0 / 1
 get_item
0.00% covered (danger)
0.00%
0 / 1
12
0.00% covered (danger)
0.00%
0 / 14
 get_readable_forums
0.00% covered (danger)
0.00%
0 / 1
6
0.00% covered (danger)
0.00%
0 / 6
 get_moderator_approve_forums
0.00% covered (danger)
0.00%
0 / 1
6
0.00% covered (danger)
0.00%
0 / 6
 is_moderator_approve_forum
0.00% covered (danger)
0.00%
0 / 1
12
0.00% covered (danger)
0.00%
0 / 6
 get_excluded_forums
0.00% covered (danger)
0.00%
0 / 1
20
0.00% covered (danger)
0.00%
0 / 15
 is_excluded_forum
0.00% covered (danger)
0.00%
0 / 1
6
0.00% covered (danger)
0.00%
0 / 2
 get_passworded_forums
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 1
 user_viewprofile
0.00% covered (danger)
0.00%
0 / 1
6
0.00% covered (danger)
0.00%
0 / 5
 get_sql
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
0 / 0
<?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\feed;
/**
 * Base class with some generic functions and settings.
 */
abstract class base implements feed_interface
{
    /**
     * Feed helper object
     * @var \phpbb\feed\helper
     */
    protected $helper;
    /** @var \phpbb\config\config */
    protected $config;
    /** @var \phpbb\db\driver\driver_interface */
    protected $db;
    /** @var \phpbb\cache\driver\driver_interface */
    protected $cache;
    /** @var \phpbb\user */
    protected $user;
    /** @var \phpbb\auth\auth */
    protected $auth;
    /** @var \phpbb\content_visibility */
    protected $content_visibility;
    /** @var \phpbb\event\dispatcher_interface */
    protected $phpbb_dispatcher;
    /** @var string */
    protected $phpEx;
    /**
     * SQL Query to be executed to get feed items
     */
    protected $sql = array();
    /**
     * Keys specified for retrieval of title, content, etc.
     */
    protected $keys = array();
    /**
     * Number of items to fetch. Usually overwritten by $config['feed_something']
     */
    protected $num_items = 15;
    /**
     * Separator for title elements to separate items (for example forum / topic)
     */
    protected $separator = "\xE2\x80\xA2"; // &bull;
    /**
     * Separator for the statistics row (Posted by, post date, replies, etc.)
     */
    protected $separator_stats = "\xE2\x80\x94"; // &mdash;
    /** @var mixed Query result handle */
    protected $result;
    /**
     * Constructor
     *
     * @param \phpbb\feed\helper                    $helper        Feed helper
     * @param \phpbb\config\config                $config        Config object
     * @param \phpbb\db\driver\driver_interface    $db            Database connection
     * @param \phpbb\cache\driver\driver_interface    $cache    Cache object
     * @param \phpbb\user                        $user        User object
     * @param \phpbb\auth\auth                    $auth        Auth object
     * @param \phpbb\content_visibility            $content_visibility        Auth object
     * @param \phpbb\event\dispatcher_interface    $phpbb_dispatcher        Event dispatcher object
     * @param string                                $phpEx        php file extension
     */
    public function __construct(
        \phpbb\feed\helper $helper,
        \phpbb\config\config $config,
        \phpbb\db\driver\driver_interface $db,
        \phpbb\cache\driver\driver_interface $cache,
        \phpbb\user $user,
        \phpbb\auth\auth $auth,
        \phpbb\content_visibility $content_visibility,
        \phpbb\event\dispatcher_interface $phpbb_dispatcher,
        $phpEx
    )
    {
        $this->config = $config;
        $this->helper = $helper;
        $this->db = $db;
        $this->cache = $cache;
        $this->user = $user;
        $this->auth = $auth;
        $this->content_visibility = $content_visibility;
        $this->phpbb_dispatcher = $phpbb_dispatcher;
        $this->phpEx = $phpEx;
        $this->set_keys();
        // Allow num_items to be string
        if (is_string($this->num_items))
        {
            $this->num_items = (int) $this->config[$this->num_items];
            // A precaution
            if (!$this->num_items)
            {
                $this->num_items = 10;
            }
        }
    }
    /**
     * {@inheritdoc}
     */
    public function set_keys()
    {
    }
    /**
     * {@inheritdoc}
     */
    public function open()
    {
    }
    /**
     * {@inheritdoc}
     */
    public function close()
    {
        if (!empty($this->result))
        {
            $this->db->sql_freeresult($this->result);
        }
    }
    /**
     * {@inheritdoc}
     */
    public function set($key, $value)
    {
        $this->keys[$key] = $value;
    }
    /**
     * {@inheritdoc}
     */
    public function get($key)
    {
        return (isset($this->keys[$key])) ? $this->keys[$key] : null;
    }
    /**
     * {@inheritdoc}
     */
    public function get_item()
    {
        if (!isset($this->result))
        {
            if (!$this->get_sql())
            {
                return false;
            }
            $sql_ary = $this->sql;
            /**
             * Event to modify the feed item sql
             *
             * @event core.feed_base_modify_item_sql
             * @var    array    sql_ary        The SQL array to get the feed item data
             *
             * @since 3.1.10-RC1
             */
            $vars = array('sql_ary');
            extract($this->phpbb_dispatcher->trigger_event('core.feed_base_modify_item_sql', compact($vars)));
            $this->sql = $sql_ary;
            unset($sql_ary);
            // Query database
            $sql = $this->db->sql_build_query('SELECT', $this->sql);
            $this->result = $this->db->sql_query_limit($sql, $this->num_items);
        }
        return $this->db->sql_fetchrow($this->result);
    }
    /**
     * Returns the ids of the forums readable by the current user.
     *
     * @return int[]
     */
    protected function get_readable_forums()
    {
        static $forum_ids;
        if (!isset($forum_ids))
        {
            $forum_ids = array_keys($this->auth->acl_getf('f_read', true));
        }
        return $forum_ids;
    }
    /**
     * Returns the ids of the forum for which the current user can approve the post in the moderation queue.
     *
     * @return int[]
     */
    protected function get_moderator_approve_forums()
    {
        static $forum_ids;
        if (!isset($forum_ids))
        {
            $forum_ids = array_keys($this->auth->acl_getf('m_approve', true));
        }
        return $forum_ids;
    }
    /**
     * Returns true if the current user can approve the post of the given forum
     *
     * @param int $forum_id Forum id to check
     * @return bool
     */
    protected function is_moderator_approve_forum($forum_id)
    {
        static $forum_ids;
        if (!isset($forum_ids))
        {
            $forum_ids = array_flip($this->get_moderator_approve_forums());
        }
        return (isset($forum_ids[$forum_id])) ? true : false;
    }
    /**
     * Returns the ids of the forum excluded from the feeds
     *
     * @return int[]
     */
    protected function get_excluded_forums()
    {
        static $forum_ids;
        // Matches acp/acp_board.php
        $cache_name    = 'feed_excluded_forum_ids';
        if (!isset($forum_ids) && ($forum_ids = $this->cache->get('_' . $cache_name)) === false)
        {
            $sql = 'SELECT forum_id
                FROM ' . FORUMS_TABLE . '
                WHERE ' . $this->db->sql_bit_and('forum_options', FORUM_OPTION_FEED_EXCLUDE, '<> 0');
            $result = $this->db->sql_query($sql);
            $forum_ids = array();
            while ($forum_id = (int) $this->db->sql_fetchfield('forum_id'))
            {
                $forum_ids[$forum_id] = $forum_id;
            }
            $this->db->sql_freeresult($result);
            $this->cache->put('_' . $cache_name, $forum_ids);
        }
        return $forum_ids;
    }
    /**
     * Returns true if the given id is in the excluded forums list.
     *
     * @param int $forum_id Id to check
     * @return bool
     */
    protected function is_excluded_forum($forum_id)
    {
        $forum_ids = $this->get_excluded_forums();
        return isset($forum_ids[$forum_id]) ? true : false;
    }
    /**
     * Returns all password protected forum ids the current user is currently NOT authenticated for.
     *
     * @return array     Array of forum ids
     */
    protected function get_passworded_forums()
    {
        return $this->user->get_passworded_forums();
    }
    /**
     * Returns the link to the user profile.
     *
     * @return string
     */
    protected function user_viewprofile($row)
    {
        $author_id = (int) $row[$this->get('author_id')];
        if ($author_id == ANONYMOUS)
        {
            // Since we cannot link to a profile, we just return GUEST
            // instead of $row['username']
            return $this->user->lang['GUEST'];
        }
        return '<a href="' . $this->helper->append_sid('memberlist.' . $this->phpEx, 'mode=viewprofile&amp;u=' . $author_id) . '">' . $row[$this->get('creator')] . '</a>';
    }
    /**
     * Returns the SQL query used to retrieve the posts of the feed.
     *
     * @return string SQL SELECT query
     */
    protected abstract function get_sql();
}