summaryrefslogtreecommitdiffstats
path: root/Bugzilla/WebService/Bugzilla.pm
diff options
context:
space:
mode:
Diffstat (limited to 'Bugzilla/WebService/Bugzilla.pm')
-rw-r--r--Bugzilla/WebService/Bugzilla.pm46
1 files changed, 27 insertions, 19 deletions
diff --git a/Bugzilla/WebService/Bugzilla.pm b/Bugzilla/WebService/Bugzilla.pm
index a66871dc6..c7bbf7c04 100644
--- a/Bugzilla/WebService/Bugzilla.pm
+++ b/Bugzilla/WebService/Bugzilla.pm
@@ -168,9 +168,7 @@ Use L</time> instead.
=item B<Description>
-Returns the timezone of the server Bugzilla is running on. This is
-important because all dates/times that the webservice interface
-returns will be in this timezone.
+Returns the timezone that Bugzilla expects dates and times in.
=item B<Params> (none)
@@ -179,12 +177,21 @@ returns will be in this timezone.
A hash with a single item, C<timezone>, that is the timezone offset as a
string in (+/-)XXXX (RFC 2822) format.
+=item B<History>
+
+=over
+
+=item As of Bugzilla B<3.6>, the timezone returned is always C<+0000>
+(the UTC timezone).
+
+=back
+
=back
=item C<time>
-B<UNSTABLE>
+B<EXPERIMENTAL>
=over
@@ -203,8 +210,8 @@ A struct with the following items:
=item C<db_time>
-C<dateTime> The current time in Bugzilla's B<local time zone>, according
-to the Bugzilla I<database server>.
+C<dateTime> The current time in UTC, according to the Bugzilla
+I<database server>.
Note that Bugzilla assumes that the database and the webserver are running
in the same time zone. However, if the web server and the database server
@@ -213,8 +220,8 @@ rely on for doing searches and other input to the WebService.
=item C<web_time>
-C<dateTime> This is the current time in Bugzilla's B<local time zone>,
-according to Bugzilla's I<web server>.
+C<dateTime> This is the current time in UTC, according to Bugzilla's
+I<web server>.
This might be different by a second from C<db_time> since this comes from
a different source. If it's any more different than a second, then there is
@@ -223,26 +230,23 @@ rely on the C<db_time>, not the C<web_time>.
=item C<web_time_utc>
-The same as C<web_time>, but in the B<UTC> time zone instead of the local
-time zone.
+Identical to C<web_time>. (Exists only for backwards-compatibility with
+versions of Bugzilla before 3.6.)
=item C<tz_name>
-C<string> The long name of the time zone that the Bugzilla web server is
-in. Will usually look something like: C<America/Los Angeles>
+C<string> The literal string C<UTC>. (Exists only for backwards-compatibility
+with versions of Bugzilla before 3.6.)
=item C<tz_short_name>
-C<string> The "short name" of the time zone that the Bugzilla web server
-is in. This should only be used for display, and not relied on for your
-programs, because different time zones can have the same short name.
-(For example, there are two C<EST>s.)
-
-This will look something like: C<PST>.
+C<string> The literal string C<UTC>. (Exists only for backwards-compatibility
+with versions of Bugzilla before 3.6.)
=item C<tz_offset>
-C<string> The timezone offset as a string in (+/-)XXXX (RFC 2822) format.
+C<string> The literal string C<+0000>. (Exists only for backwards-compatibility
+with versions of Bugzilla before 3.6.)
=back
@@ -252,6 +256,10 @@ C<string> The timezone offset as a string in (+/-)XXXX (RFC 2822) format.
=item Added in Bugzilla B<3.4>.
+=item As of Bugzilla B<3.6>, this method returns all data as though the server
+were in the UTC timezone, instead of returning information in the server's
+local timezone.
+
=back
=back