diff options
| author | mrgoldy <gijsmartens1@gmail.com> | 2019-03-10 17:44:03 +0100 |
|---|---|---|
| committer | mrgoldy <gijsmartens1@gmail.com> | 2019-03-10 17:44:03 +0100 |
| commit | 45e1aff14a149a652924e77cd404e39b2e5aacb5 (patch) | |
| tree | e650c45f5bebd1f6f14ba35737b8a95c4c37a4c1 /phpBB | |
| parent | 479201a3a1b821d2b3212000955fad1343f4efd0 (diff) | |
| download | forums-45e1aff14a149a652924e77cd404e39b2e5aacb5.tar forums-45e1aff14a149a652924e77cd404e39b2e5aacb5.tar.gz forums-45e1aff14a149a652924e77cd404e39b2e5aacb5.tar.bz2 forums-45e1aff14a149a652924e77cd404e39b2e5aacb5.tar.xz forums-45e1aff14a149a652924e77cd404e39b2e5aacb5.zip | |
[ticket/15886] Appropriate HTML docs
PHPBB3-15886
Diffstat (limited to 'phpBB')
| -rw-r--r-- | phpBB/includes/functions_content.php | 4 | ||||
| -rw-r--r-- | phpBB/phpbb/group/helper.php | 7 |
2 files changed, 9 insertions, 2 deletions
diff --git a/phpBB/includes/functions_content.php b/phpBB/includes/functions_content.php index e83a9ec195..1840416efc 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,7 +1503,7 @@ function get_username_string($mode, $user_id, $username, $username_colour = '', { global $phpbb_root_path, $phpEx; - /** @html User name strings for usage in the template */ + /** @html Username spans and links for usage in the template */ $_profile_cache['base_url'] = append_sid("{$phpbb_root_path}memberlist.$phpEx", 'mode=viewprofile&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 7f249d7aee..5f6d1ba440 100644 --- a/phpBB/phpbb/group/helper.php +++ b/phpBB/phpbb/group/helper.php @@ -73,7 +73,7 @@ class helper $this->phpbb_root_path = $path_helper->get_phpbb_root_path(); - /** @html Group name strings for usage in the template */ + /** @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&g={GROUP_ID}", 'tpl_noprofile' => '<span class="username">{GROUP_NAME}</span>', @@ -96,6 +96,8 @@ class helper /** * 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), @@ -212,6 +214,8 @@ class helper /** * 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), @@ -249,6 +253,7 @@ class helper $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'] . '" />' : ''; } } |