mirror/php-phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-07-26 03:22:37 +02:00
Code Issues Releases Wiki Activity

[feature/new-tz-handling] Update doc blocks for the three timezone functions

Browse Source 
PHPBB3-9558
This commit is contained in:
Joas Schilling
2012-06-18 11:28:23 +02:00
parent 2c4677b79e
commit 1716e2a2a5
1 changed files with 20 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
phpBB/includes/functions.php
View File

@@ -1068,6 +1068,13 @@ function style_select($default = '', $all = false)
return $style_options; return $style_options;
} }
/**
* Format the timezone offset with hours and minutes
*
* @param int $tz_offset Timezone offset in seconds
* @return string Normalized offset string: -7200 => -02:00
* 16200 => +04:30
*/
function phpbb_format_timezone_offset($tz_offset) function phpbb_format_timezone_offset($tz_offset)
{ {
$sign = ($tz_offset < 0) ? '-' : '+'; $sign = ($tz_offset < 0) ? '-' : '+';
@@ -1081,9 +1088,11 @@ function phpbb_format_timezone_offset($tz_offset)
return $offset_string; return $offset_string;
} }
// Compares two time zone labels. /**
// Arranges them in increasing order by timezone offset. * Compares two time zone labels.
// Places UTC before other timezones in the same offset. * Arranges them in increasing order by timezone offset.
* Places UTC before other timezones in the same offset.
*/
function tz_select_compare($a, $b) function tz_select_compare($a, $b)
{ {
$a_sign = $a[3]; $a_sign = $a[3];
@@ -1129,6 +1138,14 @@ function tz_select_compare($a, $b)
/** /**
* Pick a timezone * Pick a timezone
*
* @param string $default A timezone to select
* @param boolean $truncate Shall we truncate the options text
* @param boolean $return_tzs_only Shall we just return the options for the timezone selector,
* or also return the options for the time selector.
*
* @return string/array Returns either the options for timezone selector
* or an array, also containing the options for the time selector.
*/ */
function tz_select($default = '', $truncate = false, $return_tzs_only = true) function tz_select($default = '', $truncate = false, $return_tzs_only = true)
{ {