[ticket/13645] Proper OOP for feeds

PHPBB3-13645
author: Tristan Darricau <tristan.darricau@sensiolabs.com> 2015-08-06 14:20:06 +0200
committer: Tristan Darricau <tristan.darricau@sensiolabs.com> 2015-08-23 22:36:10 +0200
commit: 5df9a4547337ef90300c21d0f997bc67e43cba9e (patch)
tree: f27c76c11fdd67dc1b38359bae247f80be446ed1 /phpBB/phpbb/feed
parent: 8e5e954438b232f4ce7aec6a5db3d52b974c07a8 (diff)
download: forums-5df9a4547337ef90300c21d0f997bc67e43cba9e.tar
forums-5df9a4547337ef90300c21d0f997bc67e43cba9e.tar.gz
forums-5df9a4547337ef90300c21d0f997bc67e43cba9e.tar.bz2
forums-5df9a4547337ef90300c21d0f997bc67e43cba9e.tar.xz
forums-5df9a4547337ef90300c21d0f997bc67e43cba9e.zip
14 files changed, 505 insertions, 320 deletions
diff --git a/phpBB/phpbb/feed/attachments_base.php b/phpBB/phpbb/feed/attachments_base.php
index 04812f1570..b14dafe15a 100644
--- a/phpBB/phpbb/feed/attachments_base.php
+++ b/phpBB/phpbb/feed/attachments_base.php
@@ -16,7 +16,7 @@ namespace phpbb\feed;
 /**
 * Abstract class for feeds displaying attachments
 */
-abstract class attachments_base extends \phpbb\feed\base
+abstract class attachments_base extends base
 {
 	/**
 	* Attachments that may be displayed
diff --git a/phpBB/phpbb/feed/base.php b/phpBB/phpbb/feed/base.php
index 322e2ee9f1..188d229515 100644
--- a/phpBB/phpbb/feed/base.php
+++ b/phpBB/phpbb/feed/base.php
@@ -1,27 +1,27 @@
 <?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.
-*
-*/
+ *
+ * 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
+ * Base class with some generic functions and settings.
+ */
+abstract class base implements feed_interface
 {
 	/**
-	* Feed helper object
-	* @var \phpbb\feed\helper
-	*/
+	 * Feed helper object
+	 * @var \phpbb\feed\helper
+	 */
 	protected $helper;
 
 	/** @var \phpbb\config\config */
@@ -43,46 +43,46 @@ abstract class base
 	protected $phpEx;
 
 	/**
-	* SQL Query to be executed to get feed items
-	*/
-	var $sql = array();
+	 * SQL Query to be executed to get feed items
+	 */
+	protected $sql = array();
 
 	/**
-	* Keys specified for retrieval of title, content, etc.
-	*/
-	var $keys = array();
+	 * Keys specified for retrieval of title, content, etc.
+	 */
+	protected $keys = array();
 
 	/**
-	* Number of items to fetch. Usually overwritten by $config['feed_something']
-	*/
-	var $num_items = 15;
+	 * 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)
-	*/
-	var $separator = "\xE2\x80\xA2"; // &bull;
+	 * 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.)
-	*/
-	var $separator_stats = "\xE2\x80\x94"; // &mdash;
+	 * 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 string								$phpEx		php file extension
-	*/
-	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, $phpEx)
+	 * 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 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, $phpEx)
 	{
 		$this->config = $config;
 		$this->helper = $helper;
@@ -109,23 +109,23 @@ abstract class base
 	}
 
 	/**
-	* Set keys.
-	*/
-	function set_keys()
+	 * {@inheritdoc}
+	 */
+	public function set_keys()
 	{
 	}
 
 	/**
-	* Open feed
-	*/
-	function open()
+	 * {@inheritdoc}
+	 */
+	public function open()
 	{
 	}
 
 	/**
-	* Close feed
-	*/
-	function close()
+	 * {@inheritdoc}
+	 */
+	public function close()
 	{
 		if (!empty($this->result))
 		{
@@ -134,28 +134,47 @@ abstract class base
 	}
 
 	/**
-	* Set key
-	*
-	* @param string $key Key
-	* @param mixed $value Value
-	*/
-	function set($key, $value)
+	 * {@inheritdoc}
+	 */
+	public function set($key, $value)
 	{
 		$this->keys[$key] = $value;
 	}
 
 	/**
-	* Get key
-	*
-	* @param string $key Key
-	* @return mixed
-	*/
-	function get($key)
+	 * {@inheritdoc}
+	 */
+	public function get($key)
 	{
 		return (isset($this->keys[$key])) ? $this->keys[$key] : null;
 	}
 
-	function get_readable_forums()
+	/**
+	 * {@inheritdoc}
+	 */
+	public function get_item()
+	{
+		if (!isset($this->result))
+		{
+			if (!$this->get_sql())
+			{
+				return false;
+			}
+
+			// 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;
 
@@ -167,7 +186,12 @@ abstract class base
 		return $forum_ids;
 	}
 
-	function get_moderator_approve_forums()
+	/**
+	 * 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;
 
@@ -179,7 +203,13 @@ abstract class base
 		return $forum_ids;
 	}
 
-	function is_moderator_approve_forum($forum_id)
+	/**
+	 * 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;
 
@@ -191,7 +221,12 @@ abstract class base
 		return (isset($forum_ids[$forum_id])) ? true : false;
 	}
 
-	function get_excluded_forums()
+	/**
+	 * Returns the ids of the forum excluded from the feeds
+	 *
+	 * @return int[]
+	 */
+	protected function get_excluded_forums()
 	{
 		static $forum_ids;
 
@@ -218,36 +253,35 @@ abstract class base
 		return $forum_ids;
 	}
 
-	function is_excluded_forum($forum_id)
+	/**
+	 * 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;
 	}
 
-	function get_passworded_forums()
+	/**
+	 * 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();
 	}
 
-	function get_item()
-	{
-		if (!isset($this->result))
-		{
-			if (!$this->get_sql())
-			{
-				return false;
-			}
-
-			// 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);
-	}
-
-	function user_viewprofile($row)
+	/**
+	 * Returns the link to the user profile.
+	 *
+	 * @return string
+	 */
+	protected function user_viewprofile($row)
 	{
 		$author_id = (int) $row[$this->get('author_id')];
 
@@ -260,4 +294,11 @@ abstract class base
 
 		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();
 }
diff --git a/phpBB/phpbb/feed/controller/feed.php b/phpBB/phpbb/feed/controller/feed.php
index a2dd9393f6..1cc960b1cb 100644
--- a/phpBB/phpbb/feed/controller/feed.php
+++ b/phpBB/phpbb/feed/controller/feed.php
@@ -17,7 +17,7 @@ use phpbb\auth\auth;
 use phpbb\config\config;
 use phpbb\db\driver\driver_interface;
 use phpbb\exception\http_exception;
-use phpbb\feed\base;
+use phpbb\feed\feed_interface;
 use phpbb\feed\exception\feed_unavailable_exception;
 use phpbb\feed\exception\unauthorized_exception;
 use phpbb\feed\helper as feed_helper;
@@ -252,11 +252,11 @@ class feed
 	/**
 	 * Display a given feed
 	 *
-	 * @param base $feed
+	 * @param feed_interface $feed
 	 *
 	 * @return Response
 	 */
-	protected function send_feed(base $feed)
+	protected function send_feed(feed_interface $feed)
 	{
 		try
 		{
@@ -275,13 +275,13 @@ class feed
 	/**
 	 * Really send the feed
 	 *
-	 * @param base $feed
+	 * @param feed_interface $feed
 	 *
 	 * @return Response
 	 *
 	 * @throw exception\feed_exception
 	 */
-	protected function send_feed_do(base $feed)
+	protected function send_feed_do(feed_interface $feed)
 	{
 		$feed_updated_time = 0;
 		$item_vars = array();
diff --git a/phpBB/phpbb/feed/feed_interface.php b/phpBB/phpbb/feed/feed_interface.php
new file mode 100644
index 0000000000..c185cd249c
--- /dev/null
+++ b/phpBB/phpbb/feed/feed_interface.php
@@ -0,0 +1,67 @@
+<?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;
+
+/**
+ * Interface implemented by all feeds types
+ */
+interface feed_interface
+{
+	/**
+	 * Set keys.
+	 */
+	public function set_keys();
+
+	/**
+	 * Open feed
+	 */
+	public function open();
+
+	/**
+	 * Close feed
+	 */
+	public function close();
+
+	/**
+	 * Set key
+	 *
+	 * @param string $key Key
+	 * @param mixed $value Value
+	 */
+	public function set($key, $value);
+
+	/**
+	 * Get key
+	 *
+	 * @param string $key Key
+	 * @return mixed
+	 */
+	public function get($key);
+
+	/**
+	 * Get the next post in the feed
+	 *
+	 * @return array
+	 */
+	public function get_item();
+
+	/**
+	 * Adjust a feed entry
+	 *
+	 * @param $item_row
+	 * @param $row
+	 * @return array
+	 */
+	public function adjust_item(&$item_row, &$row);
+}
diff --git a/phpBB/phpbb/feed/forum.php b/phpBB/phpbb/feed/forum.php
index f493c4729a..6701c4d9e7 100644
--- a/phpBB/phpbb/feed/forum.php
+++ b/phpBB/phpbb/feed/forum.php
@@ -1,15 +1,15 @@
 <?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.
-*
-*/
+ *
+ * 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;
 
@@ -18,22 +18,22 @@ use phpbb\feed\exception\no_forum_exception;
 use phpbb\feed\exception\unauthorized_forum_exception;
 
 /**
-* Forum feed
-*
-* This will give you the last {$this->num_items} posts made
-* within a specific forum.
-*/
-class forum extends \phpbb\feed\post_base
+ * Forum feed
+ *
+ * This will give you the last {$this->num_items} posts made
+ * within a specific forum.
+ */
+class forum extends post_base
 {
-	var $forum_id		= 0;
-	var $forum_data		= array();
+	protected $forum_id		= 0;
+	protected $forum_data	= array();
 
 	/**
-	* Set the Forum ID
-	*
-	* @param int	$forum_id			Forum ID
-	* @return	\phpbb\feed\forum
-	*/
+	 * Set the Forum ID
+	 *
+	 * @param int	$forum_id			Forum ID
+	 * @return	\phpbb\feed\forum
+	 */
 	public function set_forum_id($forum_id)
 	{
 		$this->forum_id = (int) $forum_id;
@@ -41,7 +41,10 @@ class forum extends \phpbb\feed\post_base
 		return $this;
 	}
 
-	function open()
+	/**
+	 * {@inheritdoc}
+	 */
+	public function open()
 	{
 		// Check if forum exists
 		$sql = 'SELECT forum_id, forum_name, forum_password, forum_type, forum_options
@@ -90,7 +93,10 @@ class forum extends \phpbb\feed\post_base
 		parent::open();
 	}
 
-	function get_sql()
+	/**
+	 * {@inheritdoc}
+	 */
+	protected function get_sql()
 	{
 		// Determine topics with recent activity
 		$sql = 'SELECT topic_id, topic_last_post_time
@@ -118,7 +124,7 @@ class forum extends \phpbb\feed\post_base
 
 		$this->sql = array(
 			'SELECT'	=>	'p.post_id, p.topic_id, p.post_time, p.post_edit_time, p.post_visibility, p.post_subject, p.post_text, p.bbcode_bitfield, p.bbcode_uid, p.enable_bbcode, p.enable_smilies, p.enable_magic_url, p.post_attachment, ' .
-							'u.username, u.user_id',
+				'u.username, u.user_id',
 			'FROM'		=> array(
 				POSTS_TABLE		=> 'p',
 				USERS_TABLE		=> 'u',
@@ -133,7 +139,10 @@ class forum extends \phpbb\feed\post_base
 		return true;
 	}
 
-	function adjust_item(&$item_row, &$row)
+	/**
+	 * {@inheritdoc}
+	 */
+	public function adjust_item(&$item_row, &$row)
 	{
 		parent::adjust_item($item_row, $row);
 
@@ -141,7 +150,10 @@ class forum extends \phpbb\feed\post_base
 		$item_row['forum_id'] = $this->forum_id;
 	}
 
-	function get_item()
+	/**
+	 * {@inheritdoc}
+	 */
+	public function get_item()
 	{
 		return ($row = parent::get_item()) ? array_merge($this->forum_data, $row) : $row;
 	}
diff --git a/phpBB/phpbb/feed/forums.php b/phpBB/phpbb/feed/forums.php
index ee14a5bc76..92f2b2dd4d 100644
--- a/phpBB/phpbb/feed/forums.php
+++ b/phpBB/phpbb/feed/forums.php
@@ -1,29 +1,32 @@
 <?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.
-*
-*/
+ *
+ * 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;
 
 /**
-* 'All Forums' feed
-*
-* This will give you a list of all postable forums where feeds are enabled
-* including forum description, topic stats and post stats
-*/
-class forums extends \phpbb\feed\base
+ * 'All Forums' feed
+ *
+ * This will give you a list of all postable forums where feeds are enabled
+ * including forum description, topic stats and post stats
+ */
+class forums extends base
 {
-	var $num_items	= 0;
+	protected $num_items	= 0;
 
-	function set_keys()
+	/**
+	 * {@inheritdoc}
+	 */
+	public function set_keys()
 	{
 		$this->set('title',		'forum_name');
 		$this->set('text',		'forum_desc');
@@ -33,7 +36,10 @@ class forums extends \phpbb\feed\base
 		$this->set('options',	'forum_desc_options');
 	}
 
-	function get_sql()
+	/**
+	 * {@inheritdoc}
+	 */
+	public function get_sql()
 	{
 		$in_fid_ary = array_diff($this->get_readable_forums(), $this->get_excluded_forums());
 		if (empty($in_fid_ary))
@@ -55,7 +61,10 @@ class forums extends \phpbb\feed\base
 		return true;
 	}
 
-	function adjust_item(&$item_row, &$row)
+	/**
+	 * {@inheritdoc}
+	 */
+	public function adjust_item(&$item_row, &$row)
 	{
 		$item_row['link'] = $this->helper->append_sid('viewforum.' . $this->phpEx, 'f=' . $row['forum_id']);
 
diff --git a/phpBB/phpbb/feed/helper.php b/phpBB/phpbb/feed/helper.php
index 198134cdcf..75736bc981 100644
--- a/phpBB/phpbb/feed/helper.php
+++ b/phpBB/phpbb/feed/helper.php
@@ -1,21 +1,21 @@
 <?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.
-*
-*/
+ *
+ * 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;
 
 /**
-* Class with some helpful functions used in feeds
-*/
+ * Class with some helpful functions used in feeds
+ */
 class helper
 {
 	/** @var \phpbb\config\config */
@@ -31,13 +31,13 @@ class helper
 	protected $phpEx;
 
 	/**
-	* Constructor
-	*
-	* @param	\phpbb\config\config	$config		Config object
-	* @param	\phpbb\user		$user		User object
-	* @param	string	$phpbb_root_path	Root path
-	* @param	string	$phpEx				PHP file extension
-	*/
+	 * Constructor
+	 *
+	 * @param	\phpbb\config\config	$config		Config object
+	 * @param	\phpbb\user		$user		User object
+	 * @param	string	$phpbb_root_path	Root path
+	 * @param	string	$phpEx				PHP file extension
+	 */
 	public function __construct(\phpbb\config\config $config, \phpbb\user $user, $phpbb_root_path, $phpEx)
 	{
 		$this->config = $config;
@@ -47,8 +47,8 @@ class helper
 	}
 
 	/**
-	* Run links through append_sid(), prepend generate_board_url() and remove session id
-	*/
+	 * Run links through append_sid(), prepend generate_board_url() and remove session id
+	 */
 	public function get_board_url()
 	{
 		static $board_url;
@@ -62,16 +62,16 @@ class helper
 	}
 
 	/**
-	* Run links through append_sid(), prepend generate_board_url() and remove session id
-	*/
+	 * Run links through append_sid(), prepend generate_board_url() and remove session id
+	 */
 	public function append_sid($url, $params)
 	{
 		return append_sid($this->get_board_url() . '/' . $url, $params, true, '');
 	}
 
 	/**
-	* Generate ISO 8601 date string (RFC 3339)
-	*/
+	 * Generate ISO 8601 date string (RFC 3339)
+	 */
 	public function format_date($time)
 	{
 		static $zone_offset;
@@ -87,16 +87,16 @@ class helper
 	}
 
 	/**
-	* Generate text content
-	*
-	* @param string $content is feed text content
-	* @param string $uid is bbcode_uid
-	* @param string $bitfield is bbcode bitfield
-	* @param int $options bbcode flag options
-	* @param int $forum_id is the forum id
-	* @param array $post_attachments is an array containing the attachments and their respective info
-	* @return string the html content to be printed for the feed
-	*/
+	 * Generate text content
+	 *
+	 * @param string $content is feed text content
+	 * @param string $uid is bbcode_uid
+	 * @param string $bitfield is bbcode bitfield
+	 * @param int $options bbcode flag options
+	 * @param int $forum_id is the forum id
+	 * @param array $post_attachments is an array containing the attachments and their respective info
+	 * @return string the html content to be printed for the feed
+	 */
 	public function generate_content($content, $uid, $bitfield, $options, $forum_id, $post_attachments)
 	{
 		if (empty($content))
@@ -122,16 +122,16 @@ class helper
 		// Firefox does not support CSS for feeds, though
 
 		// Remove font sizes
-	//	$content = preg_replace('#<span style="font-size: [0-9]+%; line-height: [0-9]+%;">([^>]+)</span>#iU', '\1', $content);
+		//	$content = preg_replace('#<span style="font-size: [0-9]+%; line-height: [0-9]+%;">([^>]+)</span>#iU', '\1', $content);
 
 		// Make text strong :P
-	//	$content = preg_replace('#<span style="font-weight: bold?">(.*?)</span>#iU', '<strong>\1</strong>', $content);
+		//	$content = preg_replace('#<span style="font-weight: bold?">(.*?)</span>#iU', '<strong>\1</strong>', $content);
 
 		// Italic
-	//	$content = preg_replace('#<span style="font-style: italic?">([^<]+)</span>#iU', '<em>\1</em>', $content);
+		//	$content = preg_replace('#<span style="font-style: italic?">([^<]+)</span>#iU', '<em>\1</em>', $content);
 
 		// Underline
-	//	$content = preg_replace('#<span style="text-decoration: underline?">([^<]+)</span>#iU', '<u>\1</u>', $content);
+		//	$content = preg_replace('#<span style="text-decoration: underline?">([^<]+)</span>#iU', '<u>\1</u>', $content);
 
 		// Remove embed Windows Media Streams
 		$content	= preg_replace( '#<\!--\[if \!IE\]>-->([^[]+)<\!--<!\[endif\]-->#si', '', $content);
diff --git a/phpBB/phpbb/feed/news.php b/phpBB/phpbb/feed/news.php
index a02c199d85..fb6fa09278 100644
--- a/phpBB/phpbb/feed/news.php
+++ b/phpBB/phpbb/feed/news.php
@@ -1,27 +1,31 @@
 <?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.
-*
-*/
+ *
+ * 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;
 
 /**
-* News feed
-*
-* This will give you {$this->num_items} first posts
-* of all topics in the selected news forums.
-*/
-class news extends \phpbb\feed\topic_base
+ * News feed
+ *
+ * This will give you {$this->num_items} first posts
+ * of all topics in the selected news forums.
+ */
+class news extends topic_base
 {
-	function get_news_forums()
+	/**
+	 * Returns the ids of the 'news forums'
+	 * @return int[]
+	 */
+	private function get_news_forums()
 	{
 		static $forum_ids;
 
@@ -48,7 +52,10 @@ class news extends \phpbb\feed\topic_base
 		return $forum_ids;
 	}
 
-	function get_sql()
+	/**
+	 * {@inheritdoc}
+	 */
+	protected function get_sql()
 	{
 		// Determine forum ids
 		$in_fid_ary = array_intersect($this->get_news_forums(), $this->get_readable_forums());
diff --git a/phpBB/phpbb/feed/overall.php b/phpBB/phpbb/feed/overall.php
index ab452f5386..40cf94ace0 100644
--- a/phpBB/phpbb/feed/overall.php
+++ b/phpBB/phpbb/feed/overall.php
@@ -1,27 +1,30 @@
 <?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.
-*
-*/
+ *
+ * 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;
 
 /**
-* Board wide feed (aka overall feed)
-*
-* This will give you the newest {$this->num_items} posts
-* from the whole board.
-*/
-class overall extends \phpbb\feed\post_base
+ * Board wide feed (aka overall feed)
+ *
+ * This will give you the newest {$this->num_items} posts
+ * from the whole board.
+ */
+class overall extends post_base
 {
-	function get_sql()
+	/**
+	 * {@inheritdoc}
+	 */
+	protected function get_sql()
 	{
 		$forum_ids = array_diff($this->get_readable_forums(), $this->get_excluded_forums(), $this->get_passworded_forums());
 		if (empty($forum_ids))
@@ -55,8 +58,8 @@ class overall extends \phpbb\feed\post_base
 		// Get the actual data
 		$this->sql = array(
 			'SELECT'	=>	'f.forum_id, f.forum_name, ' .
-							'p.post_id, p.topic_id, p.post_time, p.post_edit_time, p.post_visibility, p.post_subject, p.post_text, p.bbcode_bitfield, p.bbcode_uid, p.enable_bbcode, p.enable_smilies, p.enable_magic_url, p.post_attachment, ' .
-							'u.username, u.user_id',
+				'p.post_id, p.topic_id, p.post_time, p.post_edit_time, p.post_visibility, p.post_subject, p.post_text, p.bbcode_bitfield, p.bbcode_uid, p.enable_bbcode, p.enable_smilies, p.enable_magic_url, p.post_attachment, ' .
+				'u.username, u.user_id',
 			'FROM'		=> array(
 				USERS_TABLE		=> 'u',
 				POSTS_TABLE		=> 'p',
@@ -77,7 +80,10 @@ class overall extends \phpbb\feed\post_base
 		return true;
 	}
 
-	function adjust_item(&$item_row, &$row)
+	/**
+	 * {@inheritdoc}
+	 */
+	public function adjust_item(&$item_row, &$row)
 	{
 		parent::adjust_item($item_row, $row);
 
diff --git a/phpBB/phpbb/feed/post_base.php b/phpBB/phpbb/feed/post_base.php
index 011775b6af..f6dc39cbec 100644
--- a/phpBB/phpbb/feed/post_base.php
+++ b/phpBB/phpbb/feed/post_base.php
@@ -1,27 +1,29 @@
 <?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.
-*
-*/
+ *
+ * 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;
 
 /**
-* Abstract class for post based feeds
-*/
-abstract class post_base extends \phpbb\feed\attachments_base
+ * Abstract class for post based feeds
+ */
+abstract class post_base extends attachments_base
 {
-	var $num_items = 'feed_limit_post';
-	var $attachments = array();
+	protected $num_items = 'feed_limit_post';
 
-	function set_keys()
+	/**
+	 * {@inheritdoc}
+	 */
+	public function set_keys()
 	{
 		$this->set('title',		'post_subject');
 		$this->set('title2',	'topic_title');
@@ -40,7 +42,10 @@ abstract class post_base extends \phpbb\feed\attachments_base
 		$this->set('enable_magic_url',	'enable_magic_url');
 	}
 
-	function adjust_item(&$item_row, &$row)
+	/**
+	 * {@inheritdoc}
+	 */
+	public function adjust_item(&$item_row, &$row)
 	{
 		$item_row['link'] = $this->helper->append_sid('viewtopic.' . $this->phpEx, "t={$row['topic_id']}&amp;p={$row['post_id']}#p{$row['post_id']}");
 
diff --git a/phpBB/phpbb/feed/topic.php b/phpBB/phpbb/feed/topic.php
index c916d3bccc..f029c2b00e 100644
--- a/phpBB/phpbb/feed/topic.php
+++ b/phpBB/phpbb/feed/topic.php
@@ -1,15 +1,15 @@
 <?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.
-*
-*/
+ *
+ * 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;
 
@@ -19,22 +19,22 @@ use phpbb\feed\exception\unauthorized_forum_exception;
 use phpbb\feed\exception\unauthorized_topic_exception;
 
 /**
-* Topic feed for a specific topic
-*
-* This will give you the last {$this->num_items} posts made within this topic.
-*/
-class topic extends \phpbb\feed\post_base
+ * Topic feed for a specific topic
+ *
+ * This will give you the last {$this->num_items} posts made within this topic.
+ */
+class topic extends post_base
 {
-	var $topic_id		= 0;
-	var $forum_id		= 0;
-	var $topic_data		= array();
+	protected $topic_id		= 0;
+	protected $forum_id		= 0;
+	protected $topic_data	= array();
 
 	/**
-	* Set the Topic ID
-	*
-	* @param int	$topic_id			Topic ID
-	* @return	\phpbb\feed\topic
-	*/
+	 * Set the Topic ID
+	 *
+	 * @param int	$topic_id			Topic ID
+	 * @return	\phpbb\feed\topic
+	 */
 	public function set_topic_id($topic_id)
 	{
 		$this->topic_id = (int) $topic_id;
@@ -42,7 +42,10 @@ class topic extends \phpbb\feed\post_base
 		return $this;
 	}
 
-	function open()
+	/**
+	 * {@inheritdoc}
+	 */
+	public function open()
 	{
 		$sql = 'SELECT f.forum_options, f.forum_password, t.topic_id, t.forum_id, t.topic_visibility, t.topic_title, t.topic_time, t.topic_views, t.topic_posts_approved, t.topic_type
 			FROM ' . TOPICS_TABLE . ' t
@@ -94,11 +97,14 @@ class topic extends \phpbb\feed\post_base
 		parent::open();
 	}
 
-	function get_sql()
+	/**
+	 * {@inheritdoc}
+	 */
+	protected function get_sql()
 	{
 		$this->sql = array(
 			'SELECT'	=>	'p.post_id, p.post_time, p.post_edit_time, p.post_visibility, p.post_subject, p.post_text, p.bbcode_bitfield, p.bbcode_uid, p.enable_bbcode, p.enable_smilies, p.enable_magic_url, p.post_attachment, ' .
-							'u.username, u.user_id',
+				'u.username, u.user_id',
 			'FROM'		=> array(
 				POSTS_TABLE		=> 'p',
 				USERS_TABLE		=> 'u',
@@ -112,14 +118,20 @@ class topic extends \phpbb\feed\post_base
 		return true;
 	}
 
-	function adjust_item(&$item_row, &$row)
+	/**
+	 * {@inheritdoc}
+	 */
+	public function adjust_item(&$item_row, &$row)
 	{
 		parent::adjust_item($item_row, $row);
 
 		$item_row['forum_id'] = $this->forum_id;
 	}
 
-	function get_item()
+	/**
+	 * {@inheritdoc}
+	 */
+	public function get_item()
 	{
 		return ($row = parent::get_item()) ? array_merge($this->topic_data, $row) : $row;
 	}
diff --git a/phpBB/phpbb/feed/topic_base.php b/phpBB/phpbb/feed/topic_base.php
index f9ff368cba..0f1a9ccb70 100644
--- a/phpBB/phpbb/feed/topic_base.php
+++ b/phpBB/phpbb/feed/topic_base.php
@@ -1,26 +1,29 @@
 <?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.
-*
-*/
+ *
+ * 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;
 
 /**
-* Abstract class for topic based feeds
-*/
-abstract class topic_base extends \phpbb\feed\attachments_base
+ * Abstract class for topic based feeds
+ */
+abstract class topic_base extends attachments_base
 {
-	var $num_items = 'feed_limit_topic';
+	protected $num_items = 'feed_limit_topic';
 
-	function set_keys()
+	/**
+	 * {@inheritdoc}
+	 */
+	public function set_keys()
 	{
 		$this->set('title',		'topic_title');
 		$this->set('title2',	'forum_name');
@@ -39,7 +42,10 @@ abstract class topic_base extends \phpbb\feed\attachments_base
 		$this->set('enable_magic_url',	'enable_magic_url');
 	}
 
-	function adjust_item(&$item_row, &$row)
+	/**
+	 * {@inheritdoc}
+	 */
+	public function adjust_item(&$item_row, &$row)
 	{
 		$item_row['link'] = $this->helper->append_sid('viewtopic.' . $this->phpEx, 't=' . $row['topic_id'] . '&amp;p=' . $row['post_id'] . '#p' . $row['post_id']);
 
diff --git a/phpBB/phpbb/feed/topics.php b/phpBB/phpbb/feed/topics.php
index 2b9cb3501a..cf4a2e579e 100644
--- a/phpBB/phpbb/feed/topics.php
+++ b/phpBB/phpbb/feed/topics.php
@@ -1,27 +1,30 @@
 <?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.
-*
-*/
+ *
+ * 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;
 
 /**
-* New Topics feed
-*
-* This will give you the last {$this->num_items} created topics
-* including the first post.
-*/
-class topics extends \phpbb\feed\topic_base
+ * New Topics feed
+ *
+ * This will give you the last {$this->num_items} created topics
+ * including the first post.
+ */
+class topics extends topic_base
 {
-	function get_sql()
+	/**
+	 * {@inheritdoc}
+	 */
+	protected function get_sql()
 	{
 		$forum_ids_read = $this->get_readable_forums();
 		if (empty($forum_ids_read))
@@ -77,7 +80,10 @@ class topics extends \phpbb\feed\topic_base
 		return true;
 	}
 
-	function adjust_item(&$item_row, &$row)
+	/**
+	 * {@inheritdoc}
+	 */
+	public function adjust_item(&$item_row, &$row)
 	{
 		parent::adjust_item($item_row, $row);
 
diff --git a/phpBB/phpbb/feed/topics_active.php b/phpBB/phpbb/feed/topics_active.php
index 6d5eddfc16..52340dc2d5 100644
--- a/phpBB/phpbb/feed/topics_active.php
+++ b/phpBB/phpbb/feed/topics_active.php
@@ -1,30 +1,33 @@
 <?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.
-*
-*/
+ *
+ * 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;
 
 /**
-* Active Topics feed
-*
-* This will give you the last {$this->num_items} topics
-* with replies made withing the last {$this->sort_days} days
-* including the last post.
-*/
-class topics_active extends \phpbb\feed\topic_base
+ * Active Topics feed
+ *
+ * This will give you the last {$this->num_items} topics
+ * with replies made withing the last {$this->sort_days} days
+ * including the last post.
+ */
+class topics_active extends topic_base
 {
-	var $sort_days = 7;
+	protected $sort_days = 7;
 
-	function set_keys()
+	/**
+	 * {@inheritdoc}
+	 */
+	public function set_keys()
 	{
 		parent::set_keys();
 
@@ -32,7 +35,10 @@ class topics_active extends \phpbb\feed\topic_base
 		$this->set('creator',	'topic_last_poster_name');
 	}
 
-	function get_sql()
+	/**
+	 * {@inheritdoc}
+	 */
+	protected function get_sql()
 	{
 		$forum_ids_read = $this->get_readable_forums();
 		if (empty($forum_ids_read))
@@ -94,7 +100,12 @@ class topics_active extends \phpbb\feed\topic_base
 		return true;
 	}
 
-	function get_forum_ids()
+	/**
+	 * Returns the ids of the forums not excluded from the active list
+	 *
+	 * @return int[]
+	 */
+	private function get_forum_ids()
 	{
 		static $forum_ids;
 
@@ -122,7 +133,10 @@ class topics_active extends \phpbb\feed\topic_base
 		return $forum_ids;
 	}
 
-	function adjust_item(&$item_row, &$row)
+	/**
+	 * {@inheritdoc}
+	 */
+	public function adjust_item(&$item_row, &$row)
 	{
 		parent::adjust_item($item_row, $row);
author	Tristan Darricau <tristan.darricau@sensiolabs.com>	2015-08-06 14:20:06 +0200
committer	Tristan Darricau <tristan.darricau@sensiolabs.com>	2015-08-23 22:36:10 +0200
commit	5df9a4547337ef90300c21d0f997bc67e43cba9e (patch)
tree	f27c76c11fdd67dc1b38359bae247f80be446ed1 /phpBB/phpbb/feed
parent	8e5e954438b232f4ce7aec6a5db3d52b974c07a8 (diff)
download	forums-5df9a4547337ef90300c21d0f997bc67e43cba9e.tar forums-5df9a4547337ef90300c21d0f997bc67e43cba9e.tar.gz forums-5df9a4547337ef90300c21d0f997bc67e43cba9e.tar.bz2 forums-5df9a4547337ef90300c21d0f997bc67e43cba9e.tar.xz forums-5df9a4547337ef90300c21d0f997bc67e43cba9e.zip