1
0
mirror of https://github.com/phpbb/phpbb.git synced 2025-07-30 13:30:25 +02:00

[ticket/10345] Add documentation and phpbb_ prefix to the new avatar functions

PHPBB3-10345
This commit is contained in:
Joas Schilling
2011-11-30 21:03:29 +01:00
parent 6472a270e0
commit b790d2e283
5 changed files with 26 additions and 14 deletions

View File

@@ -2039,7 +2039,7 @@ function avatar_remote($data, &$error)
{
if ($width > $config['avatar_max_width'] || $height > $config['avatar_max_height'])
{
$error[] = avatar_error_wrong_size($width, $height);
$error[] = phpbb_avatar_error_wrong_size($width, $height);
return false;
}
}
@@ -2048,7 +2048,7 @@ function avatar_remote($data, &$error)
{
if ($width < $config['avatar_min_width'] || $height < $config['avatar_min_height'])
{
$error[] = avatar_error_wrong_size($width, $height);
$error[] = phpbb_avatar_error_wrong_size($width, $height);
return false;
}
}
@@ -2388,7 +2388,7 @@ function avatar_process_user(&$error, $custom_userdata = false, $can_upload = nu
{
if ($data['width'] > $config['avatar_max_width'] || $data['height'] > $config['avatar_max_height'])
{
$error[] = avatar_error_wrong_size($data['width'], $data['height']);
$error[] = phpbb_avatar_error_wrong_size($data['width'], $data['height']);
}
}
@@ -2398,7 +2398,7 @@ function avatar_process_user(&$error, $custom_userdata = false, $can_upload = nu
{
if ($data['width'] < $config['avatar_min_width'] || $data['height'] < $config['avatar_min_height'])
{
$error[] = avatar_error_wrong_size($data['width'], $data['height']);
$error[] = phpbb_avatar_error_wrong_size($data['width'], $data['height']);
}
}
}
@@ -2444,7 +2444,14 @@ function avatar_process_user(&$error, $custom_userdata = false, $can_upload = nu
return (sizeof($error)) ? false : true;
}
function avatar_error_wrong_size($width, $height)
/**
* Returns a language string with the avatar size of the new avatar and the allowed maximum and minimum
*
* @param $width int The width of the new uploaded/selected avatar
* @param $height int The height of the new uploaded/selected avatar
* @return string
*/
function phpbb_avatar_error_wrong_size($width, $height)
{
global $config, $user;
@@ -2457,7 +2464,12 @@ function avatar_error_wrong_size($width, $height)
$user->lang('PIXELS', (int) $height));
}
function avatar_explanation_string()
/**
* Returns an explanation string with maximum avatar settings
*
* @return string
*/
function phpbb_avatar_explanation_string()
{
global $config, $user;