Merge pull request #5459 from mrgoldy/ticket/15886

[ticket/15886] Group helper functions
author: Marc Alexander <admin@m-a-styles.de> 2019-07-28 15:31:09 +0200
committer: Marc Alexander <admin@m-a-styles.de> 2019-07-28 15:31:09 +0200
commit: f567b2bb69dd85d7a85bf11bd9a4dd7421ef0b45 (patch)
tree: 83abef558de006faf19087433cb9d71ccb9e9d68
parent: ae62bc46428948cdfbb735c8b9b566d02c0f78f0 (diff)
parent: cf9696767715eeef7d82f9dcd5533c50c4f119aa (diff)
download: forums-f567b2bb69dd85d7a85bf11bd9a4dd7421ef0b45.tar
forums-f567b2bb69dd85d7a85bf11bd9a4dd7421ef0b45.tar.gz
forums-f567b2bb69dd85d7a85bf11bd9a4dd7421ef0b45.tar.bz2
forums-f567b2bb69dd85d7a85bf11bd9a4dd7421ef0b45.tar.xz
forums-f567b2bb69dd85d7a85bf11bd9a4dd7421ef0b45.zip
10 files changed, 595 insertions, 74 deletions
diff --git a/phpBB/config/default/container/services.yml b/phpBB/config/default/container/services.yml
index 9bb1d673f4..3ead1e6181 100644
--- a/phpBB/config/default/container/services.yml
+++ b/phpBB/config/default/container/services.yml
@@ -122,7 +122,13 @@ services:
     group_helper:
         class: phpbb\group\helper
         arguments:
+            - '@auth'
+            - '@cache'
+            - '@config'
             - '@language'
+            - '@dispatcher'
+            - '@path_helper'
+            - '@user'
 
     log:
         class: phpbb\log\log
diff --git a/phpBB/includes/functions.php b/phpBB/includes/functions.php
index 5cc6826cb9..2e2b2a01d8 100644
--- a/phpBB/includes/functions.php
+++ b/phpBB/includes/functions.php
@@ -4131,9 +4131,9 @@ function phpbb_get_user_avatar($user_row, $alt = 'USER_AVATAR', $ignore_config =
 *
 * @return string Avatar html
 */
-function phpbb_get_group_avatar($user_row, $alt = 'GROUP_AVATAR', $ignore_config = false, $lazy = false)
+function phpbb_get_group_avatar($group_row, $alt = 'GROUP_AVATAR', $ignore_config = false, $lazy = false)
 {
-	$row = \phpbb\avatar\manager::clean_row($user_row, 'group');
+	$row = \phpbb\avatar\manager::clean_row($group_row, 'group');
 	return phpbb_get_avatar($row, $alt, $ignore_config, $lazy);
 }
 
diff --git a/phpBB/includes/functions_content.php b/phpBB/includes/functions_content.php
index a15a03f966..2542be5e02 100644
--- a/phpBB/includes/functions_content.php
+++ b/phpBB/includes/functions_content.php
@@ -1482,6 +1482,8 @@ function truncate_string($string, $max_length = 60, $max_store_length = 255, $al
 * Get username details for placing into templates.
 * This function caches all modes on first call, except for no_profile and anonymous user - determined by $user_id.
 *
+* @html Username spans and links
+*
 * @param string $mode Can be profile (for getting an url to the profile), username (for obtaining the username), colour (for obtaining the user colour), full (for obtaining a html string representing a coloured link to the users profile) or no_profile (the same as full but forcing no profile link)
 * @param int $user_id The users id
 * @param string $username The users name
@@ -1501,6 +1503,7 @@ function get_username_string($mode, $user_id, $username, $username_colour = '',
 	{
 		global $phpbb_root_path, $phpEx;
 
+		/** @html Username spans and links for usage in the template */
 		$_profile_cache['base_url'] = append_sid("{$phpbb_root_path}memberlist.$phpEx", 'mode=viewprofile&amp;u={USER_ID}');
 		$_profile_cache['tpl_noprofile'] = '<span class="username">{USERNAME}</span>';
 		$_profile_cache['tpl_noprofile_colour'] = '<span style="color: {USERNAME_COLOUR};" class="username-coloured">{USERNAME}</span>';
diff --git a/phpBB/phpbb/group/helper.php b/phpBB/phpbb/group/helper.php
index 5befddfc53..aa3876b325 100644
--- a/phpBB/phpbb/group/helper.php
+++ b/phpBB/phpbb/group/helper.php
@@ -13,19 +13,74 @@
 
 namespace phpbb\group;
 
+use phpbb\auth\auth;
+use phpbb\cache\service as cache;
+use phpbb\config\config;
+use phpbb\language\language;
+use phpbb\event\dispatcher_interface;
+use phpbb\path_helper;
+use phpbb\user;
+
 class helper
 {
-	/** @var  \phpbb\language\language */
+	/** @var auth */
+	protected $auth;
+
+	/** @var cache */
+	protected $cache;
+
+	/** @var config */
+	protected $config;
+
+	/** @var language */
 	protected $language;
 
+	/** @var dispatcher_interface */
+	protected $dispatcher;
+
+	/** @var path_helper */
+	protected $path_helper;
+
+	/** @var user */
+	protected $user;
+
+	/** @var string phpBB root path */
+	protected $phpbb_root_path;
+
+	/** @var array Return templates for a group name string */
+	protected $name_strings;
+
 	/**
 	 * Constructor
 	 *
-	 * @param \phpbb\language\language $language	Language object
+	 * @param auth					$auth			Authentication object
+	 * @param cache					$cache			Cache service object
+	 * @param config				$config			Configuration object
+	 * @param language				$language		Language object
+	 * @param dispatcher_interface	$dispatcher		Event dispatcher object
+	 * @param path_helper			$path_helper	Path helper object
+	 * @param user					$user			User object
 	 */
-	public function __construct(\phpbb\language\language $language)
+	public function __construct(auth $auth, cache $cache, config $config, language $language, dispatcher_interface $dispatcher, path_helper $path_helper, user $user)
 	{
+		$this->auth = $auth;
+		$this->cache = $cache;
+		$this->config = $config;
 		$this->language = $language;
+		$this->dispatcher = $dispatcher;
+		$this->path_helper = $path_helper;
+		$this->user = $user;
+
+		$this->phpbb_root_path = $path_helper->get_phpbb_root_path();
+
+		/** @html Group name spans and links for usage in the template */
+		$this->name_strings = array(
+			'base_url'				=> "{$path_helper->get_phpbb_root_path()}memberlist.{$path_helper->get_php_ext()}?mode=group&amp;g={GROUP_ID}",
+			'tpl_noprofile'			=> '<span class="username">{GROUP_NAME}</span>',
+			'tpl_noprofile_colour'	=> '<span class="username-coloured" style="color: {GROUP_COLOUR};">{GROUP_NAME}</span>',
+			'tpl_profile'			=> '<a class="username" href="{PROFILE_URL}">{GROUP_NAME}</a>',
+			'tpl_profile_colour'	=> '<a class="username-coloured" href="{PROFILE_URL}" style="color: {GROUP_COLOUR};">{GROUP_NAME}</a>',
+		);
 	}
 
 	/**
@@ -37,4 +92,203 @@ class helper
 	{
 		return $this->language->is_set('G_' . utf8_strtoupper($group_name)) ? $this->language->lang('G_' . utf8_strtoupper($group_name)) : $group_name;
 	}
+
+	/**
+	 * Get group name details for placing into templates.
+	 *
+	 * @html Group name spans and links
+	 *
+	 * @param string	$mode				Profile (for getting an url to the profile),
+	 *											group_name (for obtaining the group name),
+	 *											colour (for obtaining the group colour),
+	 *											full (for obtaining a coloured group name link to the group's profile),
+	 *											no_profile (the same as full but forcing no profile link)
+	 * @param int		$group_id			The group id
+	 * @param string	$group_name			The group name
+	 * @param string	$group_colour		The group colour
+	 * @param mixed		$custom_profile_url	optional parameter to specify a profile url. The group id gets appended to this url as &amp;g={group_id}
+	 *
+	 * @return string A string consisting of what is wanted based on $mode.
+	 */
+	public function get_name_string($mode, $group_id, $group_name, $group_colour = '', $custom_profile_url = false)
+	{
+		$s_is_bots = ($group_name === 'BOTS');
+
+		// This switch makes sure we only run code required for the mode
+		switch ($mode)
+		{
+			case 'full':
+			case 'no_profile':
+			case 'colour':
+
+				// Build correct group colour
+				$group_colour = $group_colour ? '#' . $group_colour : '';
+
+				// Return colour
+				if ($mode === 'colour')
+				{
+					$group_name_string = $group_colour;
+					break;
+				}
+
+			// no break;
+
+			case 'group_name':
+
+				// Build correct group name
+				$group_name = $this->get_name($group_name);
+
+				// Return group name
+				if ($mode === 'group_name')
+				{
+					$group_name_string = $group_name;
+					break;
+				}
+
+			// no break;
+
+			case 'profile':
+
+				// Build correct profile url - only show if not anonymous and permission to view profile if registered user
+				// For anonymous the link leads to a login page.
+				if ($group_id && !$s_is_bots && ($this->user->data['user_id'] == ANONYMOUS || $this->auth->acl_get('u_viewprofile')))
+				{
+					$profile_url = ($custom_profile_url !== false) ? $custom_profile_url . '&amp;g=' . (int) $group_id : str_replace(array('={GROUP_ID}', '=%7BGROUP_ID%7D'), '=' . (int) $group_id, append_sid($this->name_strings['base_url']));
+				}
+				else
+				{
+					$profile_url = '';
+				}
+
+				// Return profile
+				if ($mode === 'profile')
+				{
+					$group_name_string = $profile_url;
+					break;
+				}
+
+			// no break;
+		}
+
+		if (!isset($group_name_string))
+		{
+			if (($mode === 'full' && empty($profile_url)) || $mode === 'no_profile' || $s_is_bots)
+			{
+				$group_name_string = str_replace(array('{GROUP_COLOUR}', '{GROUP_NAME}'), array($group_colour, $group_name), (!$group_colour) ? $this->name_strings['tpl_noprofile'] : $this->name_strings['tpl_noprofile_colour']);
+			}
+			else
+			{
+				$group_name_string = str_replace(array('{PROFILE_URL}', '{GROUP_COLOUR}', '{GROUP_NAME}'), array($profile_url, $group_colour, $group_name), (!$group_colour) ? $this->name_strings['tpl_profile'] : $this->name_strings['tpl_profile_colour']);
+			}
+		}
+
+		$name_strings = $this->name_strings;
+
+		/**
+		 * Use this event to change the output of the group name
+		 *
+		 * @event core.modify_group_name_string
+		 * @var string	mode				profile|group_name|colour|full|no_profile
+		 * @var int		group_id			The group identifier
+		 * @var string	group_name			The group name
+		 * @var string	group_colour		The group colour
+		 * @var string	custom_profile_url	Optional parameter to specify a profile url.
+		 * @var string	group_name_string	The string that has been generated
+		 * @var array	name_strings		Array of original return templates
+		 * @since 3.2.8-RC1
+		 */
+		$vars = array(
+			'mode',
+			'group_id',
+			'group_name',
+			'group_colour',
+			'custom_profile_url',
+			'group_name_string',
+			'name_strings',
+		);
+		extract($this->dispatcher->trigger_event('core.modify_group_name_string', compact($vars)));
+
+		return $group_name_string;
+	}
+
+	/**
+	 * Get group rank title and image
+	 *
+	 * @html Group rank image element
+	 *
+	 * @param array		$group_data		The current stored group data
+	 *
+	 * @return array					An associative array containing the rank title (title),
+	 * 									the rank image as full img tag (img) and the rank image source (img_src)
+	 */
+	public function get_rank($group_data)
+	{
+		$group_rank_data = array(
+			'title'		=> null,
+			'img'		=> null,
+			'img_src'	=> null,
+		);
+
+		/**
+		 * Preparing a group's rank before displaying
+		 *
+		 * @event core.get_group_rank_before
+		 * @var	array	group_data		Array with group's data
+		 * @since 3.2.8-RC1
+		 */
+
+		$vars = array('group_data');
+		extract($this->dispatcher->trigger_event('core.get_group_rank_before', compact($vars)));
+
+		if (!empty($group_data['group_rank']))
+		{
+			// Only obtain ranks if group rank is set
+			$ranks = $this->cache->obtain_ranks();
+
+			if (isset($ranks['special'][$group_data['group_rank']]))
+			{
+				$rank = $ranks['special'][$group_data['group_rank']];
+
+				$group_rank_data['title'] = $rank['rank_title'];
+
+				$group_rank_data['img_src'] = (!empty($rank['rank_image'])) ? $this->path_helper->update_web_root_path($this->phpbb_root_path . $this->config['ranks_path'] . '/' . $rank['rank_image']) : '';
+
+				/** @html Group rank image element for usage in the template */
+				$group_rank_data['img'] = (!empty($rank['rank_image'])) ? '<img src="' . $group_rank_data['img_src'] . '" alt="' . $rank['rank_title'] . '" title="' . $rank['rank_title'] . '" />' : '';
+			}
+		}
+
+		/**
+		 * Modify a group's rank before displaying
+		 *
+		 * @event core.get_group_rank_after
+		 * @var	array	group_data		Array with group's data
+		 * @var	array	group_rank_data	Group rank data
+		 * @since 3.2.8-RC1
+		 */
+
+		$vars = array(
+			'group_data',
+			'group_rank_data',
+		);
+		extract($this->dispatcher->trigger_event('core.get_group_rank_after', compact($vars)));
+
+		return $group_rank_data;
+	}
+
+	/**
+	 * Get group avatar.
+	 * Wrapper function for phpbb_get_group_avatar()
+	 *
+	 * @param array		$group_row		Row from the groups table
+	 * @param string	$alt			Optional language string for alt tag within image, can be a language key or text
+	 * @param bool		$ignore_config	Ignores the config-setting, to be still able to view the avatar in the UCP
+	 * @param bool		$lazy			If true, will be lazy loaded (requires JS)
+	 *
+	 * @return string 					Avatar html
+	 */
+	function get_avatar($group_row, $alt = 'GROUP_AVATAR', $ignore_config = false, $lazy = false)
+	{
+		return phpbb_get_group_avatar($group_row, $alt, $ignore_config, $lazy);
+	}
 }
diff --git a/tests/group/helper_get_name_string_test.php b/tests/group/helper_get_name_string_test.php
new file mode 100644
index 0000000000..c626328dcc
--- /dev/null
+++ b/tests/group/helper_get_name_string_test.php
@@ -0,0 +1,115 @@
+<?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.
+ *
+ */
+
+require_once dirname(__FILE__) . '/helper_test_case.php';
+
+class phpbb_group_helper_get_name_string_test extends phpbb_group_helper_test_case
+{
+
+	public function get_name_string_profile_data()
+	{
+		global $phpbb_root_path, $phpEx;
+
+		return array(
+			array(0, 'Non existing group', '', false, ''),
+			array(2, 'Administrators', 'AA0000', false, "{$phpbb_root_path}memberlist.$phpEx?mode=group&amp;g=2"),
+			array(42, 'Example Group', '', 'http://www.example.org/group.php?mode=show', 'http://www.example.org/group.php?mode=show&amp;g=42'),
+		);
+	}
+
+	/**
+	* @dataProvider get_name_string_profile_data
+	*/
+	public function test_get_name_string_profile($group_id, $group_name, $group_colour, $custom_profile_url, $expected)
+	{
+		$this->assertEquals($expected, $this->group_helper->get_name_string('profile', $group_id, $group_name, $group_colour, $custom_profile_url));
+	}
+
+	public function get_name_string_group_name_data()
+	{
+		return array(
+			// Should be fine
+			array(0, 'BOTS', 'AA0000', false, 'Bots'),
+			array(1, 'new_group', '', false, 'Some new group'),
+			array(2, 'group_with_ümlauts', '', 'http://www.example.org/group.php?mode=show', 'Should work'),
+
+			// Should fail and thus return the same
+			array(3, 'not_uppercase', 'FFFFFF', false, 'not_uppercase'),
+			array(4, 'Awesome group', '', false, 'Awesome group'),
+		);
+	}
+
+	/**
+	 * @dataProvider get_name_string_group_name_data
+	 */
+	public function test_get_name_string_group_name($group_id, $group_name, $group_colour, $custom_profile_url, $expected)
+	{
+		$this->assertEquals($expected, $this->group_helper->get_name_string('group_name', $group_id, $group_name, $group_colour, $custom_profile_url));
+	}
+
+	public function get_name_string_colour_data()
+	{
+		return array(
+			array(0, '', '', false, ''),
+			array(0, '', 'F0F0F0', false, '#F0F0F0'),
+			array(1, 'Guests', '000000', false, '#000000'),
+			array(2, 'Administrators', '', false, ''),
+		);
+	}
+
+	/**
+	 * @dataProvider get_name_string_colour_data
+	 */
+	public function test_get_name_string_colour($group_id, $group_name, $group_colour, $custom_profile_url, $expected)
+	{
+		$this->assertEquals($expected, $this->group_helper->get_name_string('colour', $group_id, $group_name, $group_colour, $custom_profile_url));
+	}
+
+	public function get_name_string_full_data()
+	{
+		global $phpbb_root_path, $phpEx;
+
+		return array(
+			array(0, 'BOTS', '000000', false, '<span class="username-coloured" style="color: #000000;">Bots</span>'),
+			array(1, 'BOTS', '111111', false, '<span class="username-coloured" style="color: #111111;">Bots</span>'),
+			array(7, 'new_group', 'FFA500', false, '<a class="username-coloured" href="' . $phpbb_root_path . 'memberlist.' . $phpEx . '?mode=group&amp;g=7" style="color: #FFA500;">Some new group</a>'),
+			array(14, 'Awesome group', '', 'http://www.example.org/group.php?mode=show', '<a class="username" href="http://www.example.org/group.php?mode=show&amp;g=14">Awesome group</a>'),
+		);
+	}
+
+	/**
+	 * @dataProvider get_name_string_full_data
+	 */
+	public function test_get_name_string_full($group_id, $group_name, $group_colour, $custom_profile_url, $expected)
+	{
+		$this->assertEquals($expected, $this->group_helper->get_name_string('full', $group_id, $group_name, $group_colour, $custom_profile_url));
+	}
+
+	public function get_name_string_no_profile_data()
+	{
+		return array(
+			array(0, 'BOTS', '000000', false, '<span class="username-coloured" style="color: #000000;">Bots</span>'),
+			array(1, 'new_group', '', false, '<span class="username">Some new group</span>'),
+			array(2, 'not_uppercase', 'FF0000', false, '<span class="username-coloured" style="color: #FF0000;">not_uppercase</span>'),
+			array(5, 'Awesome group', '', 'http://www.example.org/group.php?mode=show', '<span class="username">Awesome group</span>'),
+		);
+	}
+
+	/**
+	 * @dataProvider get_name_string_no_profile_data
+	 */
+	public function test_get_name_string_no_profile($group_id, $group_name, $group_colour, $custom_profile_url, $expected)
+	{
+		$this->assertEquals($expected, $this->group_helper->get_name_string('no_profile', $group_id, $group_name, $group_colour, $custom_profile_url));
+	}
+}
diff --git a/tests/group/helper_get_name_test.php b/tests/group/helper_get_name_test.php
new file mode 100644
index 0000000000..b39b2cbedd
--- /dev/null
+++ b/tests/group/helper_get_name_test.php
@@ -0,0 +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.
+ *
+ */
+
+require_once dirname(__FILE__) . '/helper_test_case.php';
+
+class phpbb_group_helper_get_name_test extends phpbb_group_helper_test_case
+{
+	public function test_get_name()
+	{
+		// They should be totally fine
+		$this->assertEquals('Bots', $this->group_helper->get_name('Bots'));
+		$this->assertEquals('Some new group', $this->group_helper->get_name('new_group'));
+		$this->assertEquals('Should work', $this->group_helper->get_name('group_with_ümlauts'));
+
+		// This should fail (obviously)
+		$this->assertNotEquals('The key does not contain uppercase letters', $this->group_helper->get_name('not_uppercase'));
+
+		// The key doesn't exist so just return group name...
+		$this->assertEquals('Awesome group', $this->group_helper->get_name('Awesome group'));
+	}
+}
diff --git a/tests/group/helper_get_rank_test.php b/tests/group/helper_get_rank_test.php
new file mode 100644
index 0000000000..5efd8ad95e
--- /dev/null
+++ b/tests/group/helper_get_rank_test.php
@@ -0,0 +1,43 @@
+<?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.
+ *
+ */
+
+require_once dirname(__FILE__) . '/helper_test_case.php';
+
+class phpbb_group_helper_get_rank_test extends phpbb_group_helper_test_case
+{
+	public function get_rank_data()
+	{
+		global $phpbb_root_path;
+
+		return array(
+			array(
+				array('group_id' => 0, 'group_rank' => 1),
+				array(
+					'title' => 'Site admin',
+					'img' => '<img src="' . $phpbb_root_path . 'images/ranks/siteadmin.png' . '" alt="Site admin" title="Site admin" />',
+					'img_src' => $phpbb_root_path . 'images/ranks/siteadmin.png',
+				)
+			),
+			array(array('group_id' => 1, 'group_rank' => 0), array('title' => null, 'img' => null, 'img_src' => null)),
+			array(array('group_id' => 2, 'group_rank' => 2), array('title' => 'Test member', 'img' => '', 'img_src' => '')),
+		);
+	}
+
+	/**
+	 * @dataProvider get_rank_data
+	 */
+	public function test_get_rank($group_data, $expected)
+	{
+		$this->assertEquals($expected, $this->group_helper->get_rank($group_data));
+	}
+}
diff --git a/tests/group/helper_test.php b/tests/group/helper_test.php
deleted file mode 100644
index 2377a6f47c..0000000000
--- a/tests/group/helper_test.php
+++ /dev/null
@@ -1,68 +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.
- *
- */
-
-class phpbb_group_helper_test extends phpbb_test_case
-{
-	/** @var  \phpbb\group\helper */
-	protected $group_helper;
-
-	public function setUp()
-	{
-		global $phpbb_root_path, $phpEx;
-
-		// Set up language service
-		$lang = new \phpbb\language\language(
-			new \phpbb\language\language_file_loader($phpbb_root_path, $phpEx)
-		);
-
-		// Set up language data for testing
-		$reflection_class = new ReflectionClass('\phpbb\language\language');
-
-		// Set default language files loaded flag to true
-		$loaded_flag = $reflection_class->getProperty('common_language_files_loaded');
-		$loaded_flag->setAccessible(true);
-		$loaded_flag->setValue($lang, true);
-
-		// Set up test language data
-		$lang_array = $reflection_class->getProperty('lang');
-		$lang_array->setAccessible(true);
-		$lang_array->setValue($lang, $this->get_test_language_data_set());
-
-		// Set up group helper
-		$this->group_helper = new \phpbb\group\helper($lang);
-	}
-
-	public function test_get_name()
-	{
-		// They should be totally fine
-		$this->assertEquals('Bots', $this->group_helper->get_name('Bots'));
-		$this->assertEquals('Some new group', $this->group_helper->get_name('new_group'));
-		$this->assertEquals('Should work', $this->group_helper->get_name('group_with_ümlauts'));
-
-		// This should fail (obviously)
-		$this->assertNotEquals('They key does not contain uppercase letters', $this->group_helper->get_name('not_uppercase'));
-
-		// The key doesn't exist so just return group name...
-		$this->assertEquals('Awesome group', $this->group_helper->get_name('Awesome group'));
-	}
-
-	protected function get_test_language_data_set()
-	{
-		return array(
-			'G_BOTS'					=> 'Bots',
-			'G_NEW_GROUP'				=> 'Some new group',
-			'G_not_uppercase'			=> 'The key does not contain uppercase letters',
-			'G_GROUP_WITH_ÜMLAUTS'		=> 'Should work',
-		);
-	}
-}
diff --git a/tests/group/helper_test_case.php b/tests/group/helper_test_case.php
new file mode 100644
index 0000000000..e298770331
--- /dev/null
+++ b/tests/group/helper_test_case.php
@@ -0,0 +1,123 @@
+<?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.
+ *
+ */
+
+class phpbb_group_helper_test_case extends phpbb_test_case
+{
+	/** @var  \phpbb\group\helper */
+	protected $group_helper;
+
+	protected function config_defaults()
+	{
+		$defaults = array(
+			'ranks_path' => 'images/ranks'
+		);
+		return $defaults;
+	}
+
+	protected function get_test_language_data_set()
+	{
+		return array(
+			'G_BOTS'					=> 'Bots',
+			'G_NEW_GROUP'				=> 'Some new group',
+			'G_not_uppercase'			=> 'The key does not contain uppercase letters',
+			'G_GROUP_WITH_ÜMLAUTS'		=> 'Should work',
+		);
+	}
+
+	protected function get_test_rank_data_set()
+	{
+		return array(
+			'special' => array(
+				1 => array(
+					'rank_id'		=> 1,
+					'rank_title'	=> 'Site admin',
+					'rank_special'	=> 1,
+					'rank_image'	=> 'siteadmin.png',
+				),
+				2 => array(
+					'rank_id'		=> 2,
+					'rank_title'	=> 'Test member',
+					'rank_special'	=> 1,
+					'rank_image'	=> '',
+				)
+			)
+		);
+	}
+
+	protected function setup_engine(array $new_config = array())
+	{
+		global $phpbb_dispatcher, $phpbb_root_path, $phpEx;
+
+		// Set up authentication data for testing
+		$auth = $this->getMock('\phpbb\auth\auth');
+		$auth->expects($this->any())
+			->method('acl_get')
+			->with($this->stringContains('_'), $this->anything())
+			->will($this->returnValueMap(array(
+				array('u_viewprofile', true),
+			)));
+
+		// Set up cache service
+		$cache_service = $this->getMockBuilder('\phpbb\cache\service')->disableOriginalConstructor()->getMock();
+		$cache_service->expects($this->any())
+			->method('obtain_ranks')
+			->will($this->returnValue($this->get_test_rank_data_set()));
+
+		// Set up configuration
+		$defaults = $this->config_defaults();
+		$config = new \phpbb\config\config(array_merge($defaults, $new_config));
+
+		// Set up language service
+		$lang = new \phpbb\language\language(
+			new \phpbb\language\language_file_loader($phpbb_root_path, $phpEx)
+		);
+
+		// Set up language data for testing
+		$reflection_class = new ReflectionClass('\phpbb\language\language');
+
+		// Set default language files loaded flag to true
+		$loaded_flag = $reflection_class->getProperty('common_language_files_loaded');
+		$loaded_flag->setAccessible(true);
+		$loaded_flag->setValue($lang, true);
+
+		// Set up test language data
+		$lang_array = $reflection_class->getProperty('lang');
+		$lang_array->setAccessible(true);
+		$lang_array->setValue($lang, $this->get_test_language_data_set());
+
+		// Set up event dispatcher
+		$phpbb_dispatcher = new phpbb_mock_event_dispatcher();
+
+		// Set up path helper
+		$path_helper = $this->getMockBuilder('\phpbb\path_helper')
+			->disableOriginalConstructor()
+			->setMethods(array())
+			->getMock();
+		$path_helper->method('get_phpbb_root_path')
+			->willReturn($phpbb_root_path);
+		$path_helper->method('get_php_ext')
+			->willReturn($phpEx);
+		$path_helper->method('update_web_root_path')
+			->will($this->returnArgument(0));
+
+		$user = new \phpbb\user($lang, '\phpbb\datetime');
+		$user->data['user_id'] = ANONYMOUS;
+
+		$this->group_helper = new \phpbb\group\helper($auth, $cache_service, $config, $lang, $phpbb_dispatcher, $path_helper, $user);
+	}
+
+	public function setUp()
+	{
+		$this->setup_engine();
+	}
+}
diff --git a/tests/notification/group_request_test.php b/tests/notification/group_request_test.php
index 92e758a336..e849c66fa5 100644
--- a/tests/notification/group_request_test.php
+++ b/tests/notification/group_request_test.php
@@ -49,9 +49,23 @@ class phpbb_notification_group_request_test extends phpbb_tests_notification_bas
 			$this->cache->get_driver()
 		));
 		$this->container->set('group_helper', new \phpbb\group\helper(
+			$this->getMock('\phpbb\auth\auth'),
+			$this->cache,
+			$this->config,
 			new \phpbb\language\language(
 				new phpbb\language\language_file_loader($phpbb_root_path, $phpEx)
-			)
+			),
+			new phpbb_mock_event_dispatcher(),
+			new \phpbb\path_helper(
+				new \phpbb\symfony_request(
+					new phpbb_mock_request()
+				),
+				new \phpbb\filesystem\filesystem(),
+				$this->getMock('\phpbb\request\request'),
+				$phpbb_root_path,
+				$phpEx
+			),
+			$this->user
 		));
 		$phpbb_dispatcher = new phpbb_mock_event_dispatcher;
 		$phpbb_log = new \phpbb\log\dummy();
author	Marc Alexander <admin@m-a-styles.de>	2019-07-28 15:31:09 +0200
committer	Marc Alexander <admin@m-a-styles.de>	2019-07-28 15:31:09 +0200
commit	f567b2bb69dd85d7a85bf11bd9a4dd7421ef0b45 (patch)
tree	83abef558de006faf19087433cb9d71ccb9e9d68
parent	ae62bc46428948cdfbb735c8b9b566d02c0f78f0 (diff)
parent	cf9696767715eeef7d82f9dcd5533c50c4f119aa (diff)
download	forums-f567b2bb69dd85d7a85bf11bd9a4dd7421ef0b45.tar forums-f567b2bb69dd85d7a85bf11bd9a4dd7421ef0b45.tar.gz forums-f567b2bb69dd85d7a85bf11bd9a4dd7421ef0b45.tar.bz2 forums-f567b2bb69dd85d7a85bf11bd9a4dd7421ef0b45.tar.xz forums-f567b2bb69dd85d7a85bf11bd9a4dd7421ef0b45.zip