File: active_support/vendor/tzinfo-0.3.12/tzinfo/data_timezone.rb

Overview
Module Structure
Class Hierarchy
Code

Overview

Module Structure

  module: <Toplevel Module>
  module: TZInfo#25
  class: DataTimezone#28
inherits from
  InfoTimezone ( TZInfo )
has properties
method: period_for_utc / 1 #35
method: periods_for_local / 1 #43

Class Hierarchy

Object ( Builtin-Module )
Timezone ( TZInfo )
InfoTimezone ( TZInfo )
  DataTimezone    #28

Code

   1  #--
   2  # Copyright (c) 2006 Philip Ross
   3  # 
   4  # Permission is hereby granted, free of charge, to any person obtaining a copy
   5  # of this software and associated documentation files (the "Software"), to deal
   6  # in the Software without restriction, including without limitation the rights
   7  # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8  # copies of the Software, and to permit persons to whom the Software is
   9  # furnished to do so, subject to the following conditions:
  10  # 
  11  # The above copyright notice and this permission notice shall be included in all
  12  # copies or substantial portions of the Software.
  13  #
  14  # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17  # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18  # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19  # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  20  # THE SOFTWARE.
  21  #++
  22 
  23  require 'tzinfo/info_timezone'
  24 
  25  module TZInfo
  26 
  27    # A Timezone based on a DataTimezoneInfo.
  28    class DataTimezone < InfoTimezone #:nodoc:
  29      
  30      # Returns the TimezonePeriod for the given UTC time. utc can either be
  31      # a DateTime, Time or integer timestamp (Time.to_i). Any timezone 
  32      # information in utc is ignored (it is treated as a UTC time).        
  33      #
  34      # If no TimezonePeriod could be found, PeriodNotFound is raised.
  35      def period_for_utc(utc)
  36        info.period_for_utc(utc)
  37      end
  38      
  39      # Returns the set of TimezonePeriod instances that are valid for the given
  40      # local time as an array. If you just want a single period, use 
  41      # period_for_local instead and specify how abiguities should be resolved.
  42      # Raises PeriodNotFound if no periods are found for the given time.
  43      def periods_for_local(local)
  44        info.periods_for_local(local)
  45      end    
  46    end
  47  end