[ Index ]

PHP Cross Reference of Akelos Framework

title

Body

[close]

/AkLocalize/ -> AkTimeZone.php (summary)

(no description)

Author: Bermi Ferrer
Copyright: Copyright (c) 2002-2006, Akelos Media, S.L. http://www.akelos.org
License: GNU Lesser General Public License
File Size: 300 lines (18 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

AkTimeZone:: (15 methods):
  init()
  getFormattedOffset()
  now()
  today()
  time()
  dateTime()
  adjust()
  unadjust()
  compare()
  toString()
  inDst()
  create()
  locateTimezone()
  getTimezones()
  all()


Class: AkTimeZone  - X-Ref

A value object representing a time zone. A time zone is simply a named
offset (in seconds) from GMT. Note that two time zone objects are only
equivalent if they have both the same offset, and the same name.

A TimeZone instance may be used to convert a Time value to the corresponding
time zone.

The class also includes a method named all(), which returns a list of all TimeZone objects.
init($name, $utc_offset, $dst = false)   X-Ref
Initiates a new AkTimeZone object with the given name and offset. The offset is
the number of seconds that this time zone is offset from UTC (GMT).


getFormattedOffset($colon = true)   X-Ref
Returns the offset of this time zone as a formatted string, of the
format "+HH:MM". If the offset is zero, this returns the empty
string. If $colon is false, a colon will not be inserted into the
result.


now()   X-Ref
Compute and return the current time, in the time zone represented by
AkTimeZone.


today()   X-Ref
Return the current date in this time zone.


time()   X-Ref
Return the current time in this time zone.


dateTime()   X-Ref
Return the current time in this time zone.


adjust($time)   X-Ref
Adjust the given time to the time zone represented by AkTimeZone.


unadjust($time)   X-Ref
Reinterprets the given time value as a time in the current time
zone, and then adjusts it to return the corresponding time in the
local time zone.


compare($zone)   X-Ref
Compare this time zone to the parameter. The two are compared first on
their offsets, and then by name.


toString()   X-Ref
Returns a textual representation of this time zone.


inDst($timestamp, $zone_name)   X-Ref
No description

create($name, $timezone = null, $zones = null, $dst_zones = null)   X-Ref
No description

locateTimezone($timezone_name_or_offset)   X-Ref
Locate a specific time zone. If the argument is a string, it
is interpreted to mean the name of the timezone to locate. If it is a
numeric value it is either the hour offset, or the second offset, of the
timezone to find. (The first one with that offset will be returned.)
Returns false if no such time zone is known to the system.


getTimezones()   X-Ref
Return an array of all time zones, as Place => Offset. There are multiple
places per time zone, in many cases, to make it easier for users to
find their own time zone.

Places prefixed with "-" are those who have DST in the South Hemisphere

all()   X-Ref
Return an array of all AkTimeZone objects. There are multiple AkTimeZone objects
per time zone, in many cases, to make it easier for users to find their own time zone.




Generated: Mon Oct 27 12:43:49 2008 Cross-referenced by PHPXref 0.6