Merge pull request #4010 from Elsensee/ticket/14264

[ticket/14264] Don't use constants as return values

phpBB/config/default/container/services_text_reparser.yml

@@ -17,6 +17,7 @@ services:
         class: phpbb\textreparser\plugins\forum_description
         arguments:
             - @dbal.conn
+            - %tables.forums%
         tags:
             - { name: text_reparser.plugin }
 
@@ -24,6 +25,7 @@ services:
         class: phpbb\textreparser\plugins\forum_rules
         arguments:
             - @dbal.conn
+            - %tables.forums%
         tags:
             - { name: text_reparser.plugin }
 
@@ -31,6 +33,7 @@ services:
         class: phpbb\textreparser\plugins\group_description
         arguments:
             - @dbal.conn
+            - %tables.groups%
         tags:
             - { name: text_reparser.plugin }
 
@@ -38,6 +41,7 @@ services:
         class: phpbb\textreparser\plugins\pm_text
         arguments:
             - @dbal.conn
+            - %tables.privmsgs%
         tags:
             - { name: text_reparser.plugin }
 
@@ -52,6 +56,7 @@ services:
         class: phpbb\textreparser\plugins\poll_title
         arguments:
             - @dbal.conn
+            - %tables.topics%
         tags:
             - { name: text_reparser.plugin }
 
@@ -59,6 +64,7 @@ services:
         class: phpbb\textreparser\plugins\post_text
         arguments:
             - @dbal.conn
+            - %tables.posts%
         tags:
             - { name: text_reparser.plugin }
 
@@ -66,5 +72,6 @@ services:
         class: phpbb\textreparser\plugins\user_signature
         arguments:
             - @dbal.conn
+            - %tables.users%
         tags:
             - { name: text_reparser.plugin }

phpBB/phpbb/textreparser/plugins/forum_description.php

@@ -27,12 +27,4 @@ class forum_description extends \phpbb\textreparser\row_based_plugin
 			'options'    => 'forum_desc_options',
 		);
 	}
-
-	/**
-	* {@inheritdoc}
-	*/
-	public function get_table_name()
-	{
-		return FORUMS_TABLE;
-	}
 }

phpBB/phpbb/textreparser/plugins/forum_rules.php

@@ -27,12 +27,4 @@ class forum_rules extends \phpbb\textreparser\row_based_plugin
 			'options'    => 'forum_rules_options',
 		);
 	}
-
-	/**
-	* {@inheritdoc}
-	*/
-	public function get_table_name()
-	{
-		return FORUMS_TABLE;
-	}
 }

phpBB/phpbb/textreparser/plugins/group_description.php

@@ -27,12 +27,4 @@ class group_description extends \phpbb\textreparser\row_based_plugin
 			'options'    => 'group_desc_options',
 		);
 	}
-
-	/**
-	* {@inheritdoc}
-	*/
-	public function get_table_name()
-	{
-		return GROUPS_TABLE;
-	}
 }

phpBB/phpbb/textreparser/plugins/pm_text.php

@@ -29,12 +29,4 @@ class pm_text extends \phpbb\textreparser\row_based_plugin
 			'bbcode_uid'       => 'bbcode_uid',
 		);
 	}
-
-	/**
-	* {@inheritdoc}
-	*/
-	public function get_table_name()
-	{
-		return PRIVMSGS_TABLE;
-	}
 }

phpBB/phpbb/textreparser/plugins/poll_title.php

@@ -39,12 +39,4 @@ class poll_title extends \phpbb\textreparser\row_based_plugin
 
 		return $sql;
 	}
-
-	/**
-	* {@inheritdoc}
-	*/
-	public function get_table_name()
-	{
-		return TOPICS_TABLE;
-	}
 }

phpBB/phpbb/textreparser/plugins/post_text.php

@@ -29,12 +29,4 @@ class post_text extends \phpbb\textreparser\row_based_plugin
 			'bbcode_uid'       => 'bbcode_uid',
 		);
 	}
-
-	/**
-	* {@inheritdoc}
-	*/
-	public function get_table_name()
-	{
-		return POSTS_TABLE;
-	}
 }

phpBB/phpbb/textreparser/plugins/user_signature.php

@@ -54,14 +54,6 @@ class user_signature extends \phpbb\textreparser\row_based_plugin
 		);
 	}
 
-	/**
-	* {@inheritdoc}
-	*/
-	public function get_table_name()
-	{
-		return USERS_TABLE;
-	}
-
 	/**
 	* Save the keyoptions var from \phpbb\user
 	*/

phpBB/phpbb/textreparser/row_based_plugin.php

@@ -20,14 +20,21 @@ abstract class row_based_plugin extends base
 	*/
 	protected $db;
 
+	/**
+	 * @var string
+	 */
+	protected $table;
+
 	/**
 	* Constructor
 	*
 	* @param \phpbb\db\driver\driver_interface $db Database connection
+	* @param string $table
 	*/
-	public function __construct(\phpbb\db\driver\driver_interface $db)
+	public function __construct(\phpbb\db\driver\driver_interface $db, $table)
 	{
 		$this->db = $db;
+		$this->table = $table;
 	}
 
 	/**
@@ -37,13 +44,6 @@ abstract class row_based_plugin extends base
 	*/
 	abstract public function get_columns();
 
-	/**
-	* Return the name of the table used by this plugin
-	*
-	* @return string
-	*/
-	abstract public function get_table_name();
-
 	/**
 	* {@inheritdoc}
 	*/
@@ -51,7 +51,7 @@ abstract class row_based_plugin extends base
 	{
 		$columns = $this->get_columns();
 
-		$sql = 'SELECT MAX(' . $columns['id'] . ') AS max_id FROM ' . $this->get_table_name();
+		$sql = 'SELECT MAX(' . $columns['id'] . ') AS max_id FROM ' . $this->table;
 		$result = $this->db->sql_query($sql);
 		$max_id = (int) $this->db->sql_fetchfield('max_id');
 		$this->db->sql_freeresult($result);
@@ -96,7 +96,7 @@ abstract class row_based_plugin extends base
 		}
 
 		$sql = 'SELECT ' . implode(', ', $fields) . '
-			FROM ' . $this->get_table_name() . '
+			FROM ' . $this->table . '
 			WHERE ' . $columns['id'] . ' BETWEEN ' . $min_id . ' AND ' . $max_id;
 
 		return $sql;
@@ -109,7 +109,7 @@ abstract class row_based_plugin extends base
 	{
 		$columns = $this->get_columns();
 
-		$sql = 'UPDATE ' . $this->get_table_name() . '
+		$sql = 'UPDATE ' . $this->table . '
 			SET ' . $columns['text'] . " = '" . $this->db->sql_escape($record['text']) . "'
 			WHERE " . $columns['id'] . ' = ' . $record['id'];
 		$this->db->sql_query($sql);

tests/text_reparser/plugins/forum_description_test.php

@@ -21,6 +21,6 @@ class phpbb_textreparser_forum_description_test extends phpbb_textreparser_test_
 
 	protected function get_reparser()
 	{
-		return new \phpbb\textreparser\plugins\forum_description($this->db);
+		return new \phpbb\textreparser\plugins\forum_description($this->db, FORUMS_TABLE);
 	}
 }

tests/text_reparser/plugins/forum_rules_test.php

@@ -21,6 +21,6 @@ class phpbb_textreparser_forum_rules_test extends phpbb_textreparser_test_row_ba
 
 	protected function get_reparser()
 	{
-		return new \phpbb\textreparser\plugins\forum_rules($this->db);
+		return new \phpbb\textreparser\plugins\forum_rules($this->db, FORUMS_TABLE);
 	}
 }

tests/text_reparser/plugins/group_description_test.php

@@ -21,6 +21,6 @@ class phpbb_textreparser_group_description_test extends phpbb_textreparser_test_
 
 	protected function get_reparser()
 	{
-		return new \phpbb\textreparser\plugins\group_description($this->db);
+		return new \phpbb\textreparser\plugins\group_description($this->db, GROUPS_TABLE);
 	}
 }

tests/text_reparser/plugins/pm_text_test.php

@@ -21,6 +21,6 @@ class phpbb_textreparser_pm_text_test extends phpbb_textreparser_test_row_based_
 
 	protected function get_reparser()
 	{
-		return new \phpbb\textreparser\plugins\pm_text($this->db);
+		return new \phpbb\textreparser\plugins\pm_text($this->db, PRIVMSGS_TABLE);
 	}
 }

tests/text_reparser/plugins/poll_title_test.php

@@ -21,6 +21,6 @@ class phpbb_textreparser_poll_title_test extends phpbb_textreparser_test_row_bas
 
 	protected function get_reparser()
 	{
-		return new \phpbb\textreparser\plugins\poll_title($this->db);
+		return new \phpbb\textreparser\plugins\poll_title($this->db, TOPICS_TABLE);
 	}
 }

tests/text_reparser/plugins/post_text_test.php

@@ -21,6 +21,6 @@ class phpbb_textreparser_post_text_test extends phpbb_textreparser_test_row_base
 
 	protected function get_reparser()
 	{
-		return new \phpbb\textreparser\plugins\post_text($this->db);
+		return new \phpbb\textreparser\plugins\post_text($this->db, POSTS_TABLE);
 	}
 }

tests/text_reparser/plugins/test_row_based_plugin.php

@@ -24,8 +24,13 @@ abstract class phpbb_textreparser_test_row_based_plugin extends phpbb_database_t
 	{
 		$reparser = $this->get_reparser();
 		$columns = $reparser->get_columns();
+
+		$reflection_reparser = new ReflectionClass(get_class($reparser));
+		$table_property = $reflection_reparser->getProperty('table');
+		$table_property->setAccessible(true);
+
 		$sql = 'SELECT ' . $columns['id'] . ' AS id, ' . $columns['text'] . ' AS text
-			FROM ' . $reparser->get_table_name() . '
+			FROM ' . $table_property->getValue($reparser) . '
 			WHERE ' . $this->db->sql_in_set($columns['id'], $ids) . '
 			ORDER BY id';
 		$result = $this->db->sql_query($sql);

tests/text_reparser/plugins/user_signature_test.php

@@ -21,6 +21,6 @@ class phpbb_textreparser_user_signature_test extends phpbb_textreparser_test_row
 
 	protected function get_reparser()
 	{
-		return new \phpbb\textreparser\plugins\user_signature($this->db);
+		return new \phpbb\textreparser\plugins\user_signature($this->db, USERS_TABLE);
 	}
 }