Class ActiveSupport::TimeZone
In: vendor/rails/activesupport/lib/active_support/values/time_zone.rb
Parent: Object

Methods

<=>   =~   []   all   at   formatted_offset   local   local_to_utc   new   new   now   parse   period_for_local   period_for_utc   to_s   today   tzinfo   us_zones   utc_offset   utc_to_local  

Included Modules

Comparable

Constants

MAPPING = { "International Date Line West" => "Pacific/Midway", "Midway Island" => "Pacific/Midway", "Samoa" => "Pacific/Pago_Pago", "Hawaii" => "Pacific/Honolulu", "Alaska" => "America/Juneau", "Pacific Time (US & Canada)" => "America/Los_Angeles", "Tijuana" => "America/Tijuana", "Mountain Time (US & Canada)" => "America/Denver", "Arizona" => "America/Phoenix", "Chihuahua" => "America/Chihuahua", "Mazatlan" => "America/Mazatlan", "Central Time (US & Canada)" => "America/Chicago", "Saskatchewan" => "America/Regina", "Guadalajara" => "America/Mexico_City", "Mexico City" => "America/Mexico_City", "Monterrey" => "America/Monterrey", "Central America" => "America/Guatemala", "Eastern Time (US & Canada)" => "America/New_York", "Indiana (East)" => "America/Indiana/Indianapolis", "Bogota" => "America/Bogota", "Lima" => "America/Lima", "Quito" => "America/Lima", "Atlantic Time (Canada)" => "America/Halifax", "Caracas" => "America/Caracas", "La Paz" => "America/La_Paz", "Santiago" => "America/Santiago", "Newfoundland" => "America/St_Johns", "Brasilia" => "America/Sao_Paulo", "Buenos Aires" => "America/Argentina/Buenos_Aires", "Georgetown" => "America/Argentina/San_Juan", "Greenland" => "America/Godthab", "Mid-Atlantic" => "Atlantic/South_Georgia", "Azores" => "Atlantic/Azores", "Cape Verde Is." => "Atlantic/Cape_Verde", "Dublin" => "Europe/Dublin", "Edinburgh" => "Europe/Dublin", "Lisbon" => "Europe/Lisbon", "London" => "Europe/London", "Casablanca" => "Africa/Casablanca", "Monrovia" => "Africa/Monrovia", "UTC" => "Etc/UTC", "Belgrade" => "Europe/Belgrade", "Bratislava" => "Europe/Bratislava", "Budapest" => "Europe/Budapest", "Ljubljana" => "Europe/Ljubljana", "Prague" => "Europe/Prague", "Sarajevo" => "Europe/Sarajevo", "Skopje" => "Europe/Skopje", "Warsaw" => "Europe/Warsaw", "Zagreb" => "Europe/Zagreb", "Brussels" => "Europe/Brussels", "Copenhagen" => "Europe/Copenhagen", "Madrid" => "Europe/Madrid", "Paris" => "Europe/Paris", "Amsterdam" => "Europe/Amsterdam", "Berlin" => "Europe/Berlin", "Bern" => "Europe/Berlin", "Rome" => "Europe/Rome", "Stockholm" => "Europe/Stockholm", "Vienna" => "Europe/Vienna", "West Central Africa" => "Africa/Algiers", "Bucharest" => "Europe/Bucharest", "Cairo" => "Africa/Cairo", "Helsinki" => "Europe/Helsinki", "Kyev" => "Europe/Kiev", "Riga" => "Europe/Riga", "Sofia" => "Europe/Sofia", "Tallinn" => "Europe/Tallinn", "Vilnius" => "Europe/Vilnius", "Athens" => "Europe/Athens", "Istanbul" => "Europe/Istanbul", "Minsk" => "Europe/Minsk", "Jerusalem" => "Asia/Jerusalem", "Harare" => "Africa/Harare", "Pretoria" => "Africa/Johannesburg", "Moscow" => "Europe/Moscow", "St. Petersburg" => "Europe/Moscow", "Volgograd" => "Europe/Moscow", "Kuwait" => "Asia/Kuwait", "Riyadh" => "Asia/Riyadh", "Nairobi" => "Africa/Nairobi", "Baghdad" => "Asia/Baghdad", "Tehran" => "Asia/Tehran", "Abu Dhabi" => "Asia/Muscat", "Muscat" => "Asia/Muscat", "Baku" => "Asia/Baku", "Tbilisi" => "Asia/Tbilisi", "Yerevan" => "Asia/Yerevan", "Kabul" => "Asia/Kabul", "Ekaterinburg" => "Asia/Yekaterinburg", "Islamabad" => "Asia/Karachi", "Karachi" => "Asia/Karachi", "Tashkent" => "Asia/Tashkent", "Chennai" => "Asia/Kolkata", "Kolkata" => "Asia/Kolkata", "Mumbai" => "Asia/Kolkata", "New Delhi" => "Asia/Kolkata", "Kathmandu" => "Asia/Katmandu", "Astana" => "Asia/Dhaka", "Dhaka" => "Asia/Dhaka", "Sri Jayawardenepura" => "Asia/Colombo", "Almaty" => "Asia/Almaty", "Novosibirsk" => "Asia/Novosibirsk", "Rangoon" => "Asia/Rangoon", "Bangkok" => "Asia/Bangkok", "Hanoi" => "Asia/Bangkok", "Jakarta" => "Asia/Jakarta", "Krasnoyarsk" => "Asia/Krasnoyarsk", "Beijing" => "Asia/Shanghai", "Chongqing" => "Asia/Chongqing", "Hong Kong" => "Asia/Hong_Kong", "Urumqi" => "Asia/Urumqi", "Kuala Lumpur" => "Asia/Kuala_Lumpur", "Singapore" => "Asia/Singapore", "Taipei" => "Asia/Taipei", "Perth" => "Australia/Perth", "Irkutsk" => "Asia/Irkutsk", "Ulaan Bataar" => "Asia/Ulaanbaatar", "Seoul" => "Asia/Seoul", "Osaka" => "Asia/Tokyo", "Sapporo" => "Asia/Tokyo", "Tokyo" => "Asia/Tokyo", "Yakutsk" => "Asia/Yakutsk", "Darwin" => "Australia/Darwin", "Adelaide" => "Australia/Adelaide", "Canberra" => "Australia/Melbourne", "Melbourne" => "Australia/Melbourne", "Sydney" => "Australia/Sydney", "Brisbane" => "Australia/Brisbane", "Hobart" => "Australia/Hobart", "Vladivostok" => "Asia/Vladivostok", "Guam" => "Pacific/Guam", "Port Moresby" => "Pacific/Port_Moresby", "Magadan" => "Asia/Magadan", "Solomon Is." => "Asia/Magadan", "New Caledonia" => "Pacific/Noumea", "Fiji" => "Pacific/Fiji", "Kamchatka" => "Asia/Kamchatka", "Marshall Is." => "Pacific/Majuro", "Auckland" => "Pacific/Auckland", "Wellington" => "Pacific/Auckland", "Nuku'alofa" => "Pacific/Tongatapu"   Keys are Rails TimeZone names, values are TZInfo identifiers
ZONES = []
ZONES_MAP = {}
US_ZONES = ZONES.find_all { |z| z.name =~ /US|Arizona|Indiana|Hawaii|Alaska/ }

External Aliases

new -> create

Attributes

name  [R] 

Public Class methods

[](arg)

Locate a specific time zone object. 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 nil if no such time zone is known to the system.

[Source]

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 385
385:       def [](arg)
386:         case arg
387:           when String
388:             ZONES_MAP[arg]
389:           when Numeric, ActiveSupport::Duration
390:             arg *= 3600 if arg.abs <= 13
391:             all.find { |z| z.utc_offset == arg.to_i }
392:           else
393:             raise ArgumentError, "invalid argument to TimeZone[]: #{arg.inspect}"
394:         end
395:       end
all()

Return an array of all TimeZone objects. There are multiple TimeZone objects per time zone, in many cases, to make it easier for users to find their own time zone.

[Source]

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 376
376:       def all
377:         ZONES
378:       end
new(name, utc_offset, tzinfo = nil)

Create a new TimeZone object with the given name and offset. The offset is the number of seconds that this time zone is offset from UTC (GMT). Seconds were chosen as the offset unit because that is the unit that Ruby uses to represent time zone offsets (see Time#utc_offset).

[Source]

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 180
180:     def initialize(name, utc_offset, tzinfo = nil)
181:       @name = name
182:       @utc_offset = utc_offset
183:       @tzinfo = tzinfo
184:     end
new(name)

Return a TimeZone instance with the given name, or nil if no such TimeZone instance exists. (This exists to support the use of this class with the composed_of macro.)

[Source]

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 369
369:       def new(name)
370:         self[name]
371:       end
us_zones()

A convenience method for returning a collection of TimeZone objects for time zones in the USA.

[Source]

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 399
399:       def us_zones
400:         US_ZONES
401:       end

Public Instance methods

<=>(zone)

Compare this time zone to the parameter. The two are comapred first on their offsets, and then by name.

[Source]

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 198
198:     def <=>(zone)
199:       result = (utc_offset <=> zone.utc_offset)
200:       result = (name <=> zone.name) if result == 0
201:       result
202:     end
=~(re)

Compare name and TZInfo identifier to a supplied regexp, returning true if a match is found.

[Source]

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 206
206:     def =~(re)
207:       return true if name =~ re || MAPPING[name] =~ re
208:     end
at(secs)

Method for creating new ActiveSupport::TimeWithZone instance in time zone of self from number of seconds since the Unix epoch. Example: 

  Time.zone = "Hawaii"        # => "Hawaii"
  Time.utc(2000).to_f         # => 946684800.0
  Time.zone.at(946684800.0)   # => Fri, 31 Dec 1999 14:00:00 HST -10:00

[Source]

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 229
229:     def at(secs)
230:       utc = Time.at(secs).utc rescue DateTime.civil(1970).since(secs)
231:       utc.in_time_zone(self)
232:     end
formatted_offset(colon=true, alternate_utc_string = nil)

Returns the offset of this time zone as a formatted string, of the format "+HH:MM".

[Source]

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 192
192:     def formatted_offset(colon=true, alternate_utc_string = nil)
193:       utc_offset == 0 && alternate_utc_string || utc_offset.to_utc_offset_s(colon)
194:     end
local(*args)

Method for creating new ActiveSupport::TimeWithZone instance in time zone of self from given values. Example: 

  Time.zone = "Hawaii"                      # => "Hawaii"
  Time.zone.local(2007, 2, 1, 15, 30, 45)   # => Thu, 01 Feb 2007 15:30:45 HST -10:00

[Source]

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 219
219:     def local(*args)
220:       time = Time.utc_time(*args)
221:       ActiveSupport::TimeWithZone.new(nil, self, time)
222:     end
local_to_utc(time, dst=true)

Adjust the given time to the simultaneous time in UTC. Returns a Time.utc() instance.

[Source]

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 275
275:     def local_to_utc(time, dst=true)
276:       tzinfo.local_to_utc(time, dst)
277:     end
now()

Returns an ActiveSupport::TimeWithZone instance representing the current time in the time zone represented by self. Example: 

  Time.zone = 'Hawaii'  # => "Hawaii"
  Time.zone.now         # => Wed, 23 Jan 2008 20:24:27 HST -10:00

[Source]

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 259
259:     def now
260:       Time.now.utc.in_time_zone(self)
261:     end
parse(str, now=now)

Method for creating new ActiveSupport::TimeWithZone instance in time zone of self from parsed string. Example: 

  Time.zone = "Hawaii"                      # => "Hawaii"
  Time.zone.parse('1999-12-31 14:00:00')    # => Fri, 31 Dec 1999 14:00:00 HST -10:00

If upper components are missing from the string, they are supplied from TimeZone#now: 

  Time.zone.now                 # => Fri, 31 Dec 1999 14:00:00 HST -10:00
  Time.zone.parse('22:30:00')   # => Fri, 31 Dec 1999 22:30:00 HST -10:00

[Source]

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 243
243:     def parse(str, now=now)
244:       date_parts = Date._parse(str)
245:       return if date_parts.blank?
246:       time = Time.parse(str, now) rescue DateTime.parse(str)
247:       if date_parts[:offset].nil?
248:         ActiveSupport::TimeWithZone.new(nil, self, time)
249:       else
250:         time.in_time_zone(self)
251:       end
252:     end
period_for_local(time, dst=true)

Available so that TimeZone instances respond like TZInfo::Timezone instances

[Source]

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 285
285:     def period_for_local(time, dst=true)
286:       tzinfo.period_for_local(time, dst)
287:     end
period_for_utc(time)

Available so that TimeZone instances respond like TZInfo::Timezone instances

[Source]

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 280
280:     def period_for_utc(time)
281:       tzinfo.period_for_utc(time)
282:     end
to_s()

Returns a textual representation of this time zone.

[Source]

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 211
211:     def to_s
212:       "(GMT#{formatted_offset}) #{name}"
213:     end
today()

Return the current date in this time zone.

[Source]

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 264
264:     def today
265:       tzinfo.now.to_date
266:     end
tzinfo()

TODO: Preload instead of lazy load for thread safety

[Source]

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 290
290:     def tzinfo
291:       require 'tzinfo' unless defined?(TZInfo)
292:       @tzinfo ||= TZInfo::Timezone.get(MAPPING[name])
293:     end
utc_offset()

[Source]

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 186
186:     def utc_offset
187:       @utc_offset ||= tzinfo.current_period.utc_offset
188:     end
utc_to_local(time)

Adjust the given time to the simultaneous time in the time zone represented by self. Returns a Time.utc() instance — if you want an ActiveSupport::TimeWithZone instance, use Time#in_time_zone() instead.

[Source]

     # File vendor/rails/activesupport/lib/active_support/values/time_zone.rb, line 270
270:     def utc_to_local(time)
271:       tzinfo.utc_to_local(time)
272:     end

[Validate]