[ticket/12993] Return an array instead of reference passing

PHPBB3-12993
author: Tristan Darricau <github@nicofuma.fr> 2014-08-19 22:25:01 +0200
committer: Tristan Darricau <github@nicofuma.fr> 2014-08-19 22:25:01 +0200
commit: fe1ab6d2efe7389ab5deb6cab0d721a1fa80c503 (patch)
tree: 849b434027921b495c54f4504f155f662f52f9c0 /phpBB
parent: 5e7d9d2fcf5a78ef97287c635310c6ea28572464 (diff)
download: forums-fe1ab6d2efe7389ab5deb6cab0d721a1fa80c503.tar
forums-fe1ab6d2efe7389ab5deb6cab0d721a1fa80c503.tar.gz
forums-fe1ab6d2efe7389ab5deb6cab0d721a1fa80c503.tar.bz2
forums-fe1ab6d2efe7389ab5deb6cab0d721a1fa80c503.tar.xz
forums-fe1ab6d2efe7389ab5deb6cab0d721a1fa80c503.zip
7 files changed, 60 insertions, 36 deletions
diff --git a/phpBB/includes/functions_compatibility.php b/phpBB/includes/functions_compatibility.php
index efd586c234..7dcb1fb9c1 100644
--- a/phpBB/includes/functions_compatibility.php
+++ b/phpBB/includes/functions_compatibility.php
@@ -188,5 +188,8 @@ function get_user_rank($user_rank, $user_posts, &$rank_title, &$rank_img, &$rank
 		include($phpbb_root_path . 'includes/functions_display.' . $phpEx);
 	}
 
-	phpbb_get_user_rank(array('user_rank' => $user_rank), $user_posts, $rank_title, $rank_img, $rank_img_src);
+	$rank_data = phpbb_get_user_rank(array('user_rank' => $user_rank), $user_posts);
+	$rank_title = $rank_data['title'];
+	$rank_img = $rank_data['img'];
+	$rank_img_src = $rank_data['img_src'];
 }
diff --git a/phpBB/includes/functions_display.php b/phpBB/includes/functions_display.php
index 75b86b4f71..f12d557fd2 100644
--- a/phpBB/includes/functions_display.php
+++ b/phpBB/includes/functions_display.php
@@ -1380,16 +1380,21 @@ function watch_topic_forum($mode, &$s_watching, $user_id, $forum_id, $topic_id,
 *
 * @param array $user_data the current stored users data
 * @param int $user_posts the users number of posts
-* @param string &$rank_title the rank title will be stored here after execution
-* @param string &$rank_img the rank image as full img tag is stored here after execution
-* @param string &$rank_img_src the rank image source is stored here after execution
+*
+* @return array An associative array containing the rank title (title), the rank image source (img) and the rank image as full img tag (img)
 *
 * Note: since we do not want to break backwards-compatibility, this function will only properly assign ranks to guests if you call it for them with user_posts == false
 */
-function phpbb_get_user_rank($user_data, $user_posts, &$rank_title, &$rank_img, &$rank_img_src)
+function phpbb_get_user_rank($user_data, $user_posts)
 {
 	global $ranks, $config, $phpbb_root_path, $phpbb_path_helper, $phpbb_dispatcher;
 
+	$user_rank_data = array(
+		'title'		=> null,
+		'img'		=> null,
+		'img_src'	=> null,
+	);
+
 	/**
 	* Preparing a user's rank before displaying
 	*
@@ -1411,11 +1416,11 @@ function phpbb_get_user_rank($user_data, $user_posts, &$rank_title, &$rank_img,
 	if (!empty($user_data['user_rank']))
 	{
 
-		$rank_title = (isset($ranks['special'][$user_data['user_rank']]['rank_title'])) ? $ranks['special'][$user_data['user_rank']]['rank_title'] : '';
+		$user_rank_data['title'] = (isset($ranks['special'][$user_data['user_rank']]['rank_title'])) ? $ranks['special'][$user_data['user_rank']]['rank_title'] : '';
 
-		$rank_img_src = (!empty($ranks['special'][$user_data['user_rank']]['rank_image'])) ? $phpbb_path_helper->update_web_root_path($phpbb_root_path . $config['ranks_path'] . '/' . $ranks['special'][$user_data['user_rank']]['rank_image']) : '';
+		$user_rank_data['img_src'] = (!empty($ranks['special'][$user_data['user_rank']]['rank_image'])) ? $phpbb_path_helper->update_web_root_path($phpbb_root_path . $config['ranks_path'] . '/' . $ranks['special'][$user_data['user_rank']]['rank_image']) : '';
 
-		$rank_img = (!empty($ranks['special'][$user_data['user_rank']]['rank_image'])) ? '<img src="' . $rank_img_src . '" alt="' . $ranks['special'][$user_data['user_rank']]['rank_title'] . '" title="' . $ranks['special'][$user_data['user_rank']]['rank_title'] . '" />' : '';
+		$user_rank_data['img'] = (!empty($ranks['special'][$user_data['user_rank']]['rank_image'])) ? '<img src="' . $user_rank_data['img_src'] . '" alt="' . $ranks['special'][$user_data['user_rank']]['rank_title'] . '" title="' . $ranks['special'][$user_data['user_rank']]['rank_title'] . '" />' : '';
 	}
 	else if ($user_posts !== false)
 	{
@@ -1425,14 +1430,16 @@ function phpbb_get_user_rank($user_data, $user_posts, &$rank_title, &$rank_img,
 			{
 				if ($user_posts >= $rank['rank_min'])
 				{
-					$rank_title = $rank['rank_title'];
-					$rank_img_src = (!empty($rank['rank_image'])) ? $phpbb_path_helper->update_web_root_path($phpbb_root_path . $config['ranks_path'] . '/' . $rank['rank_image']) : '';
-					$rank_img = (!empty($rank['rank_image'])) ? '<img src="' . $rank_img_src . '" alt="' . $rank['rank_title'] . '" title="' . $rank['rank_title'] . '" />' : '';
+					$user_rank_data['title'] = $rank['rank_title'];
+					$user_rank_data['img_src'] = (!empty($rank['rank_image'])) ? $phpbb_path_helper->update_web_root_path($phpbb_root_path . $config['ranks_path'] . '/' . $rank['rank_image']) : '';
+					$user_rank_data['img'] = (!empty($rank['rank_image'])) ? '<img src="' . $user_rank_data['img_src'] . '" alt="' . $rank['rank_title'] . '" title="' . $rank['rank_title'] . '" />' : '';
 					break;
 				}
 			}
 		}
 	}
+
+	return $user_rank_data;
 }
 
 /**
@@ -1445,8 +1452,7 @@ function phpbb_show_profile($data, $user_notes_enabled = false, $warn_user_enabl
 	$username = $data['username'];
 	$user_id = $data['user_id'];
 
-	$rank_title = $rank_img = $rank_img_src = '';
-	phpbb_get_user_rank($data, (($user_id == ANONYMOUS) ? false : $data['user_posts']), $rank_title, $rank_img, $rank_img_src);
+	$user_rank_data = phpbb_get_user_rank($data, (($user_id == ANONYMOUS) ? false : $data['user_posts']));
 
 	if ((!empty($data['user_allow_viewemail']) && $auth->acl_get('u_sendemail')) || $auth->acl_get('a_user'))
 	{
@@ -1527,7 +1533,7 @@ function phpbb_show_profile($data, $user_notes_enabled = false, $warn_user_enabl
 	// Dump it out to the template
 	$template_data = array(
 		'AGE'			=> $age,
-		'RANK_TITLE'	=> $rank_title,
+		'RANK_TITLE'	=> $user_rank_data['title'],
 		'JOINED'		=> $user->format_date($data['user_regdate']),
 		'LAST_ACTIVE'	=> (empty($last_active)) ? ' - ' : $user->format_date($last_active),
 		'POSTS'			=> ($data['user_posts']) ? $data['user_posts'] : 0,
@@ -1543,8 +1549,8 @@ function phpbb_show_profile($data, $user_notes_enabled = false, $warn_user_enabl
 		'AVATAR_IMG'		=> phpbb_get_user_avatar($data),
 		'ONLINE_IMG'		=> (!$config['load_onlinetrack']) ? '' : (($online) ? $user->img('icon_user_online', 'ONLINE') : $user->img('icon_user_offline', 'OFFLINE')),
 		'S_ONLINE'			=> ($config['load_onlinetrack'] && $online) ? true : false,
-		'RANK_IMG'			=> $rank_img,
-		'RANK_IMG_SRC'		=> $rank_img_src,
+		'RANK_IMG'			=> $user_rank_data['img'],
+		'RANK_IMG_SRC'		=> $user_rank_data['img_src'],
 		'S_JABBER_ENABLED'	=> ($config['jab_enable']) ? true : false,
 
 		'S_WARNINGS'	=> ($auth->acl_getf_global('m_') || $auth->acl_get('m_warn')) ? true : false,
diff --git a/phpBB/includes/mcp/mcp_warn.php b/phpBB/includes/mcp/mcp_warn.php
index b4b6656499..37e4d62fb7 100644
--- a/phpBB/includes/mcp/mcp_warn.php
+++ b/phpBB/includes/mcp/mcp_warn.php
@@ -341,7 +341,7 @@ class mcp_warn
 			include($phpbb_root_path . 'includes/functions_display.' . $phpEx);
 		}
 
-		phpbb_get_user_rank($user_row, $user_row['user_posts'], $rank_title, $rank_img, $rank_img_src);
+		$user_rank_data = phpbb_get_user_rank($user_row, $user_row['user_posts']);
 		$avatar_img = phpbb_get_user_avatar($user_row);
 
 		$template->assign_vars(array(
@@ -350,13 +350,13 @@ class mcp_warn
 			'POST'				=> $message,
 			'USERNAME'			=> $user_row['username'],
 			'USER_COLOR'		=> (!empty($user_row['user_colour'])) ? $user_row['user_colour'] : '',
-			'RANK_TITLE'		=> $rank_title,
+			'RANK_TITLE'		=> $user_rank_data['title'],
 			'JOINED'			=> $user->format_date($user_row['user_regdate']),
 			'POSTS'				=> ($user_row['user_posts']) ? $user_row['user_posts'] : 0,
 			'WARNINGS'			=> ($user_row['user_warnings']) ? $user_row['user_warnings'] : 0,
 
 			'AVATAR_IMG'		=> $avatar_img,
-			'RANK_IMG'			=> $rank_img,
+			'RANK_IMG'			=> $user_rank_data['img'],
 
 			'L_WARNING_POST_DEFAULT'	=> sprintf($user->lang['WARNING_POST_DEFAULT'], generate_board_url() . "/viewtopic.$phpEx?f=$forum_id&amp;p=$post_id#p$post_id"),
 
@@ -490,14 +490,14 @@ class mcp_warn
 		{
 			include($phpbb_root_path . 'includes/functions_display.' . $phpEx);
 		}
-		phpbb_get_user_rank($user_row, $user_row['user_posts'], $rank_title, $rank_img, $rank_img_src);
+		$user_rank_data = phpbb_get_user_rank($user_row, $user_row['user_posts']);
 		$avatar_img = phpbb_get_user_avatar($user_row);
 
 		// OK, they didn't submit a warning so lets build the page for them to do so
 		$template->assign_vars(array(
 			'U_POST_ACTION'		=> $this->u_action,
 
-			'RANK_TITLE'		=> $rank_title,
+			'RANK_TITLE'		=> $user_rank_data['title'],
 			'JOINED'			=> $user->format_date($user_row['user_regdate']),
 			'POSTS'				=> ($user_row['user_posts']) ? $user_row['user_posts'] : 0,
 			'WARNINGS'			=> ($user_row['user_warnings']) ? $user_row['user_warnings'] : 0,
@@ -508,7 +508,7 @@ class mcp_warn
 			'U_PROFILE'			=> get_username_string('profile', $user_row['user_id'], $user_row['username'], $user_row['user_colour']),
 
 			'AVATAR_IMG'		=> $avatar_img,
-			'RANK_IMG'			=> $rank_img,
+			'RANK_IMG'			=> $user_rank_data['img'],
 
 			'S_CAN_NOTIFY'		=> $s_can_notify,
 		));
diff --git a/phpBB/includes/ucp/ucp_pm_viewmessage.php b/phpBB/includes/ucp/ucp_pm_viewmessage.php
index a36ee398f4..2f34fd64a5 100644
--- a/phpBB/includes/ucp/ucp_pm_viewmessage.php
+++ b/phpBB/includes/ucp/ucp_pm_viewmessage.php
@@ -408,7 +408,10 @@ function get_user_information($user_id, $user_row)
 		include($phpbb_root_path . 'includes/functions_display.' . $phpEx);
 	}
 
-	phpbb_get_user_rank($user_row, $user_row['user_posts'], $user_row['rank_title'], $user_row['rank_image'], $user_row['rank_image_src']);
+	$user_rank_data = phpbb_get_user_rank($user_row, $user_row['user_posts']);
+	$user_row['rank_title'] = $user_rank_data['title'];
+	$user_row['rank_image'] = $user_rank_data['img'];
+	$user_row['rank_image_src'] = $user_rank_data['img_src'];
 
 	if ((!empty($user_row['user_allow_viewemail']) && $auth->acl_get('u_sendemail')) || $auth->acl_get('a_email'))
 	{
diff --git a/phpBB/memberlist.php b/phpBB/memberlist.php
index 4a117ea9e6..919036a85c 100644
--- a/phpBB/memberlist.php
+++ b/phpBB/memberlist.php
@@ -283,21 +283,20 @@ switch ($mode)
 							continue;
 						}
 
-						$rank_title = $rank_img = $rank_img_src = '';
-						phpbb_get_user_rank($row, (($row['user_id'] == ANONYMOUS) ? false : $row['user_posts']), $rank_title, $rank_img, $rank_img_src);
+						$user_rank_data = phpbb_get_user_rank($row, (($row['user_id'] == ANONYMOUS) ? false : $row['user_posts']));
 
 						$template->assign_block_vars('group.user', array(
 							'USER_ID'		=> $row['user_id'],
 							'FORUMS'		=> $row['forums'],
 							'FORUM_OPTIONS'	=> (isset($row['forums_options'])) ? true : false,
-							'RANK_TITLE'	=> $rank_title,
+							'RANK_TITLE'	=> $user_rank_data['title'],
 
 							'GROUP_NAME'	=> $groups_ary[$row['default_group']]['group_name'],
 							'GROUP_COLOR'	=> $groups_ary[$row['default_group']]['group_colour'],
 							'U_GROUP'		=> $groups_ary[$row['default_group']]['u_group'],
 
-							'RANK_IMG'		=> $rank_img,
-							'RANK_IMG_SRC'	=> $rank_img_src,
+							'RANK_IMG'		=> $user_rank_data['img'],
+							'RANK_IMG_SRC'	=> $user_rank_data['img_src'],
 
 							'U_PM'			=> ($config['allow_privmsg'] && $auth->acl_get('u_sendpm') && ($row['user_allow_pm'] || $auth->acl_gets('a_', 'm_') || $auth->acl_getf_global('m_'))) ? append_sid("{$phpbb_root_path}ucp.$phpEx", 'i=pm&amp;mode=compose&amp;u=' . $row['user_id']) : '',
 
@@ -1080,10 +1079,14 @@ switch ($mode)
 			$avatar_img = phpbb_get_group_avatar($group_row);
 
 			// ... same for group rank
-			$rank_title = $rank_img = $rank_img_src = '';
+			$user_rank_data = array(
+				'title'		=> null,
+				'img'		=> null,
+				'img_src'	=> null,
+			);
 			if ($group_row['group_rank'])
 			{
-				phpbb_get_user_rank($group_row, false, $rank_title, $rank_img, $rank_img_src);
+				$user_rank_data = phpbb_get_user_rank($group_row, false);
 
 				if ($rank_img)
 				{
@@ -1096,11 +1099,11 @@ switch ($mode)
 				'GROUP_NAME'	=> ($group_row['group_type'] == GROUP_SPECIAL) ? $user->lang['G_' . $group_row['group_name']] : $group_row['group_name'],
 				'GROUP_COLOR'	=> $group_row['group_colour'],
 				'GROUP_TYPE'	=> $user->lang['GROUP_IS_' . $group_row['l_group_type']],
-				'GROUP_RANK'	=> $rank_title,
+				'GROUP_RANK'	=> $user_rank_data['title'],
 
 				'AVATAR_IMG'	=> $avatar_img,
-				'RANK_IMG'		=> $rank_img,
-				'RANK_IMG_SRC'	=> $rank_img_src,
+				'RANK_IMG'		=> $user_rank_data['img'],
+				'RANK_IMG_SRC'	=> $user_rank_data['img_src'],
 
 				'U_PM'			=> ($auth->acl_get('u_sendpm') && $auth->acl_get('u_masspm_group') && $group_row['group_receive_pm'] && $config['allow_privmsg'] && $config['allow_mass_pm']) ? append_sid("{$phpbb_root_path}ucp.$phpEx", 'i=pm&amp;mode=compose&amp;g=' . $group_id) : '',)
 			);
diff --git a/phpBB/phpbb/user_loader.php b/phpBB/phpbb/user_loader.php
index 4da2b383c6..24e663b150 100644
--- a/phpBB/phpbb/user_loader.php
+++ b/phpBB/phpbb/user_loader.php
@@ -223,7 +223,10 @@ class user_loader
 			'rank_img_src',
 		);
 
-		phpbb_get_user_rank($user, (($user['user_id'] == ANONYMOUS) ? false : $user['user_posts']), $rank['rank_title'], $rank['rank_img'], $rank['rank_img_src']);
+		$user_rank_data = phpbb_get_user_rank($user, (($user['user_id'] == ANONYMOUS) ? false : $user['user_posts']));
+		$rank['rank_title'] = $user_rank_data['title'];
+		$rank['rank_img'] = $user_rank_data['img'];
+		$rank['rank_img_src'] = $user_rank_data['img_src'];
 
 		return $rank;
 	}
diff --git a/phpBB/viewtopic.php b/phpBB/viewtopic.php
index 89b5a5033b..792bd296c0 100644
--- a/phpBB/viewtopic.php
+++ b/phpBB/viewtopic.php
@@ -1174,7 +1174,10 @@ while ($row = $db->sql_fetchrow($result))
 
 			$user_cache[$poster_id] = $user_cache_data;
 
-			phpbb_get_user_rank($row, false, $user_cache[$poster_id]['rank_title'], $user_cache[$poster_id]['rank_image'], $user_cache[$poster_id]['rank_image_src']);
+			$user_rank_data = phpbb_get_user_rank($row, false);
+			$user_cache[$poster_id]['rank_title'] = $user_rank_data['title'];
+			$user_cache[$poster_id]['rank_image'] = $user_rank_data['img'];
+			$user_cache[$poster_id]['rank_image_src'] = $user_rank_data['img_src'];
 		}
 		else
 		{
@@ -1238,7 +1241,10 @@ while ($row = $db->sql_fetchrow($result))
 
 			$user_cache[$poster_id] = $user_cache_data;
 
-			phpbb_get_user_rank($row, $row['user_posts'], $user_cache[$poster_id]['rank_title'], $user_cache[$poster_id]['rank_image'], $user_cache[$poster_id]['rank_image_src']);
+			$user_rank_data = phpbb_get_user_rank($row, false);
+			$user_cache[$poster_id]['rank_title'] = $user_rank_data['title'];
+			$user_cache[$poster_id]['rank_image'] = $user_rank_data['img'];
+			$user_cache[$poster_id]['rank_image_src'] = $user_rank_data['img_src'];
 
 			if ((!empty($row['user_allow_viewemail']) && $auth->acl_get('u_sendemail')) || $auth->acl_get('a_email'))
 			{
author	Tristan Darricau <github@nicofuma.fr>	2014-08-19 22:25:01 +0200
committer	Tristan Darricau <github@nicofuma.fr>	2014-08-19 22:25:01 +0200
commit	fe1ab6d2efe7389ab5deb6cab0d721a1fa80c503 (patch)
tree	849b434027921b495c54f4504f155f662f52f9c0 /phpBB
parent	5e7d9d2fcf5a78ef97287c635310c6ea28572464 (diff)
download	forums-fe1ab6d2efe7389ab5deb6cab0d721a1fa80c503.tar forums-fe1ab6d2efe7389ab5deb6cab0d721a1fa80c503.tar.gz forums-fe1ab6d2efe7389ab5deb6cab0d721a1fa80c503.tar.bz2 forums-fe1ab6d2efe7389ab5deb6cab0d721a1fa80c503.tar.xz forums-fe1ab6d2efe7389ab5deb6cab0d721a1fa80c503.zip