diff options
| author | Joas Schilling <nickvergessen@gmx.de> | 2012-06-18 11:28:23 +0200 |
|---|---|---|
| committer | Joas Schilling <nickvergessen@gmx.de> | 2012-06-18 15:10:59 +0200 |
| commit | 1716e2a2a57903464bf4a1b6843bca913c656695 (patch) | |
| tree | 0a585c8f3b9e63d509ca95a687cc8f7af951598e /phpBB/includes/functions.php | |
| parent | 2c4677b79ee657d2ab9f4e2592924391a7814f79 (diff) | |
| download | forums-1716e2a2a57903464bf4a1b6843bca913c656695.tar forums-1716e2a2a57903464bf4a1b6843bca913c656695.tar.gz forums-1716e2a2a57903464bf4a1b6843bca913c656695.tar.bz2 forums-1716e2a2a57903464bf4a1b6843bca913c656695.tar.xz forums-1716e2a2a57903464bf4a1b6843bca913c656695.zip | |
[feature/new-tz-handling] Update doc blocks for the three timezone functions
PHPBB3-9558
Diffstat (limited to 'phpBB/includes/functions.php')
| -rw-r--r-- | phpBB/includes/functions.php | 23 |
1 files changed, 20 insertions, 3 deletions
diff --git a/phpBB/includes/functions.php b/phpBB/includes/functions.php index 19e59f2ddb..618af7ee00 100644 --- a/phpBB/includes/functions.php +++ b/phpBB/includes/functions.php @@ -1068,6 +1068,13 @@ function style_select($default = '', $all = false) 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) { $sign = ($tz_offset < 0) ? '-' : '+'; @@ -1081,9 +1088,11 @@ function phpbb_format_timezone_offset($tz_offset) return $offset_string; } -// Compares two time zone labels. -// Arranges them in increasing order by timezone offset. -// Places UTC before other timezones in the same offset. +/** +* Compares two time zone labels. +* Arranges them in increasing order by timezone offset. +* Places UTC before other timezones in the same offset. +*/ function tz_select_compare($a, $b) { $a_sign = $a[3]; @@ -1129,6 +1138,14 @@ function tz_select_compare($a, $b) /** * 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) { |