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

Overview
Module Structure
Class Hierarchy
Code

Overview

Module Structure

  module: <Toplevel Module>
  module: TZInfo#25
  class: LinkedTimezone#27
inherits from
  InfoTimezone ( TZInfo )
has properties
method: period_for_utc / 1 #33
method: periods_for_local / 1 #41
method: setup / 1 #46

Class Hierarchy

Object ( Builtin-Module )
Timezone ( TZInfo )
InfoTimezone ( TZInfo )
  LinkedTimezone    #27

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    class LinkedTimezone < InfoTimezone #:nodoc:
  28      # Returns the TimezonePeriod for the given UTC time. utc can either be
  29      # a DateTime, Time or integer timestamp (Time.to_i). Any timezone 
  30      # information in utc is ignored (it is treated as a UTC time).        
  31      #
  32      # If no TimezonePeriod could be found, PeriodNotFound is raised.
  33      def period_for_utc(utc)
  34        @linked_timezone.period_for_utc(utc)
  35      end
  36      
  37      # Returns the set of TimezonePeriod instances that are valid for the given
  38      # local time as an array. If you just want a single period, use 
  39      # period_for_local instead and specify how abiguities should be resolved.
  40      # Raises PeriodNotFound if no periods are found for the given time.
  41      def periods_for_local(local)
  42        @linked_timezone.periods_for_local(local)
  43      end
  44      
  45      protected
  46        def setup(info)
  47          super(info)
  48          @linked_timezone = Timezone.get(info.link_to_identifier)
  49        end
  50    end
  51  end