dev.obliquid.com: Date
[ class tree: Date ] [ index: Date ] [ all elements ]
Packages:
obliquid
cal
core
Date
dev
doc
ezxml
general
msg
news
pear
posts
prj
user


Files:
TimeZone.php

Classes:
Date_TimeZone

Class: Date_TimeZone

Source Location: Program_Root/classes/pear/Date/Date/TimeZone.php

Class Overview




TimeZone representation class, along with time zone information data.




Author(s):






    
            

Version:


    
  
  • 1.0
    • 








Variables






Methods

















Inherited Variables





Inherited Methods














Class Details



[line 47]

TimeZone representation class, along with time zone information data.


TimeZone representation class, along with time zone information data.  The default timezone is set from the first valid timezone id found  in one of the following places, in this order: 
  1) global $_DATE_TIMEZONE_DEFAULT
  2) system environment variable PHP_TZ
  3) system environment variable TZ
  4) the result of date('T')
  If no valid timezone id is found, the default timezone is set to 'UTC'.  You may also manually set the default timezone by passing a valid id to  Date_TimeZone::setDefault().
This class includes time zone data (from zoneinfo) in the form of a global array, $_DATE_TIMEZONE_DATA.






Tags:





  

    version:  1.0
  

  

    access:  public
  

  

    author:  Baba Buehler <mailto:baba@babaz.com>
  










[ Top ]







Class Variables



	
	

	
$default = 

	
[line 89]

  System Default Time Zone







  

	

  

    

      Type:  
      object Date_TimeZone
    

      

	



	
[ Top ]


	
	

	
$dstlongname = 

	
[line 73]

  DST Long Name of this time zone







  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$dstshortname = 

	
[line 78]

  DST Short Name of this timezone







  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$hasdst = 

	
[line 68]

  true if this time zone observes daylight savings time







  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$id = 

	
[line 53]

  Time Zone ID of this time zone







  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$longname = 

	
[line 58]

  Long Name of this time zone (ie Central Standard Time)







  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$offset = 

	
[line 83]

  offset, in milliseconds, of this timezone







  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$shortname = 

	
[line 63]

  Short Name of this time zone (ie CST)







  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]










Class Methods



  

	
	
constructor Date_TimeZone [line 103]

	

    

    

		object Date_TimeZone Date_TimeZone(
string
$id)
    

    


	
		Constructor


Creates a new Date::TimeZone object, representing the time zone  specified in $id.  If the supplied ID is invalid, the created  time zone is UTC.






Tags:





  

    return:  the new Date_TimeZone object
  

  

    access:  public
  












        
Parameters:

    

    

          

        string  
        $id  
        the time zone id
      

        

    


        
[ Top ]

  

  

	
	
method getAvailableIDs [line 304]

	

    

    

		mixed getAvailableIDs(
)
    

    


	
		Returns the list of valid time zone id strings


Returns the list of valid time zone id strings






Tags:





  

    return:  an array of strings with the valid time zone IDs
  

  

    access:  public
  












        
[ Top ]

  

  

	
	
method getDefault [line 138]

	

    

    

		object Date_TimeZone getDefault(
)
    

    


	
		Return a TimeZone object representing the system default time zone


Return a TimeZone object representing the system default time zone,  which is initialized during the loading of TimeZone.php.






Tags:





  

    return:  the default time zone
  

  

    access:  public
  












        
[ Top ]

  

  

	
	
method getDSTLongName [line 358]

	

    

    

		string getDSTLongName(
)
    

    


	
		Returns the DST long name for this time zone


Returns the DST long name for this time zone, i.e. "Central Daylight Time"






Tags:





  

    return:  the daylight savings time long name
  

  

    access:  public
  












        
[ Top ]

  

  

	
	
method getDSTSavings [line 267]

	

    

    

		int getDSTSavings(
)
    

    


	
		Get the DST offset for this time zone


Returns the DST offset of this time zone, in milliseconds,  if the zone observes DST, zero otherwise.  Currently the  DST offset is hard-coded to one hour.






Tags:





  

    return:  the DST offset, in milliseconds or zero if the zone does not observe DST
  

  

    access:  public
  












        
[ Top ]

  

  

	
	
method getDSTShortName [line 371]

	

    

    

		string getDSTShortName(
)
    

    


	
		Returns the DST short name for this time zone


Returns the DST short name for this time zone, i.e. "CDT"






Tags:





  

    return:  the daylight savings time short name
  

  

    access:  public
  












        
[ Top ]

  

  

	
	
method getID [line 318]

	

    

    

		string getID(
)
    

    


	
		Returns the id for this time zone


Returns the time zone id  for this time zone, i.e. "America/Chicago"






Tags:





  

    return:  the id
  

  

    access:  public
  












        
[ Top ]

  

  

	
	
method getLongName [line 332]

	

    

    

		string getLongName(
)
    

    


	
		Returns the long name for this time zone


Returns the long name for this time zone,  i.e. "Central Standard Time"






Tags:





  

    return:  the long name
  

  

    access:  public
  












        
[ Top ]

  

  

	
	
method getOffset [line 287]

	

    

    

		int getOffset(
object Date
$date)
    

    


	
		Get the DST-corrected offset to UTC for the given date


Attempts to get the offset to UTC for a given date/time, taking into  account daylight savings time, if the time zone observes it and if  it is in effect.  Please see the WARNINGS on Date::TimeZone::inDaylightTime().






Tags:





  

    return:  the corrected offset to UTC in milliseconds
  

  

    access:  public
  












        
Parameters:

    

    

          

        object Date  
        $date  
        the Date to test
      

        

    


        
[ Top ]

  

  

	
	
method getRawOffset [line 384]

	

    

    

		int getRawOffset(
)
    

    


	
		Returns the raw (non-DST-corrected) offset from UTC/GMT for this time zone


Returns the raw (non-DST-corrected) offset from UTC/GMT for this time zone






Tags:





  

    return:  the offset, in milliseconds
  

  

    access:  public
  












        
[ Top ]

  

  

	
	
method getShortName [line 345]

	

    

    

		string getShortName(
)
    

    


	
		Returns the short name for this time zone


Returns the short name for this time zone, i.e. "CST"






Tags:





  

    return:  the short name
  

  

    access:  public
  












        
[ Top ]

  

  

	
	
method hasDaylightTime [line 226]

	

    

    

		boolean hasDaylightTime(
)
    

    


	
		Returns true if this zone observes daylight savings time


Returns true if this zone observes daylight savings time






Tags:





  

    return:  true if this time zone has DST
  

  

    access:  public
  












        
[ Top ]

  

  

	
	
method inDaylightTime [line 246]

	

    

    

		boolean inDaylightTime(
object Date
$date)
    

    


	
		Is the given date/time in DST for this time zone


Attempts to determine if a given Date object represents a date/time  that is in DST for this time zone.  WARNINGS: this basically attempts to  "trick" the system into telling us if we're in DST for a given time zone.  This uses putenv() which may not work in safe mode, and relies on unix time  which is only valid for dates from 1970 to ~2038.  This relies on the  underlying OS calls, so it may not work on Windows or on a system where  zoneinfo is not installed or configured properly.






Tags:





  

    return:  true if this date is in DST for this time zone
  

  

    access:  public
  












        
Parameters:

    

    

          

        object Date  
        $date  
        the date/time to test
      

        

    


        
[ Top ]

  

  

	
	
method isEqual [line 187]

	

    

    

		boolean isEqual(
object Date_TimeZone
$tz)
    

    


	
		Is this time zone equal to another


Tests to see if this time zone is equal (ids match)  to a given Date_TimeZone object.






Tags:





  

    return:  true if this time zone is equal to the supplied time zone
  

  

    access:  public
  












        
Parameters:

    

    

          

        object Date_TimeZone  
        $tz  
        the timezone to test
      

        

    


        
[ Top ]

  

  

	
	
method isEquivalent [line 210]

	

    

    

		boolean isEquivalent(
object Date_TimeZone
$tz)
    

    


	
		Is this time zone equivalent to another


Tests to see if this time zone is equivalent to  a given time zone object.  Equivalence in this context  is defined by the two time zones having an equal raw  offset and an equal setting of "hasdst".  This is not true  equivalence, as the two time zones may have different rules  for the observance of DST, but this implementation does not  know DST rules.






Tags:





  

    return:  true if this time zone is equivalent to the supplied time zone
  

  

    access:  public
  












        
Parameters:

    

    

          

        object Date_TimeZone  
        $tz  
        the timezone object to test
      

        

    


        
[ Top ]

  

  

	
	
method isValidID [line 168]

	

    

    

		boolean isValidID(
string
$id)
    

    


	
		Tests if given id is represented in the $_DATE_TIMEZONE_DATA time zone data


Tests if given id is represented in the $_DATE_TIMEZONE_DATA time zone data






Tags:





  

    return:  true if the supplied ID is valid
  

  

    access:  public
  












        
Parameters:

    

    

          

        string  
        $id  
        the id to test
      

        

    


        
[ Top ]

  

  

	
	
method setDefault [line 152]

	

    

    

		void setDefault(
string
$id)
    

    


	
		Sets the system default time zone to the time zone in $id


Sets the system default time zone to the time zone in $id






Tags:





  

    access:  public
  












        
Parameters:

    

    

          

        string  
        $id  
        the time zone id to use
      

        

    


        
[ Top ]

  





        

		    

		    Documentation generated on Tue, 29 Mar 2005 09:04:42 -0800 by phpDocumentor 1.2.0rc2