Sabre\VObject\TimeZoneUtil Class Reference

Time zone name translation. More...

Collaboration diagram for Sabre\VObject\TimeZoneUtil:

Static Public Member Functions
static	getTimeZone ($tzid, Component $vcalendar=null, $failIfUncertain=false)
	This method will try to find out the correct timezone for an iCalendar date-time value. More...
static	loadTzMaps ()
	This method will load in all the tz mapping information, if it's not yet done. More...
static	getIdentifiersBC ()
	This method returns an array of timezone identifiers, that are supported by DateTimeZone(), but not returned by DateTimeZone::listIdentifiers(). More...

Static Public Attributes
static	$map = null
static	$microsoftExchangeMap
	List of microsoft exchange timezone ids. More...

Detailed Description

Time zone name translation.

This file translates well-known time zone names into "Olson database" time zone names.

Copyright

Copyright (C) fruux GmbH (https://fruux.com/)

Author

Frank Edelhaeuser (fedel.nosp@m.@use.nosp@m.rs.so.nosp@m.urce.nosp@m.forge.nosp@m..net)

Evert Pot (http://evertpot.com/) @license http://sabre.io/license/ Modified BSD License

Definition at line 15 of file TimeZoneUtil.php.

Member Function Documentation

getIdentifiersBC()

static Sabre\VObject\TimeZoneUtil::getIdentifiersBC ( )

static

This method returns an array of timezone identifiers, that are supported by DateTimeZone(), but not returned by DateTimeZone::listIdentifiers().

We're not using DateTimeZone::listIdentifiers(DateTimeZone::ALL_WITH_BC) because:

• It's not supported by some PHP versions as well as HHVM.
• It also returns identifiers, that are invalid values for new DateTimeZone() on some PHP versions. (See timezonedata/php-bc.php and timezonedata php-workaround.php)

Returns

array

Definition at line 272 of file TimeZoneUtil.php.

                                       {
        return include __DIR__ . '/timezonedata/php-bc.php';
    }

Referenced by Sabre\VObject\TimeZoneUtilTest\getPHPTimeZoneBCIdentifiers().

Here is the caller graph for this function:

getTimeZone()

static Sabre\VObject\TimeZoneUtil::getTimeZone (   $tzid, Component  $vcalendar = null,   $failIfUncertain = false  )

static

This method will try to find out the correct timezone for an iCalendar date-time value.

You must pass the contents of the TZID parameter, as well as the full calendar.

If the lookup fails, this method will return the default PHP timezone (as configured using date_default_timezone_set, or the date.timezone ini setting).

Alternatively, if $failIfUncertain is set to true, it will throw an exception if we cannot accurately determine the timezone.

Parameters

string	$tzid
Sabre\VObject\Component	$vcalendar

Returns

DateTimeZone

Definition at line 125 of file TimeZoneUtil.php.

                                                                                              {
 
        // First we will just see if the tzid is a support timezone identifier.
        //
        // The only exception is if the timezone starts with (. This is to
        // handle cases where certain microsoft products generate timezone
        // identifiers that for instance look like:
        //
        // (GMT+01.00) Sarajevo/Warsaw/Zagreb
        //
        // Since PHP 5.5.10, the first bit will be used as the timezone and
        // this method will return just GMT+01:00. This is wrong, because it
        // doesn't take DST into account.
        if ($tzid[0] !== '(') {
 
            // PHP has a bug that logs PHP warnings even it shouldn't:
            // https://bugs.php.net/bug.php?id=67881
            //
            // That's why we're checking if we'll be able to successfull instantiate
            // \DateTimeZone() before doing so. Otherwise we could simply instantiate
            // and catch the exception.
            $tzIdentifiers = \DateTimeZone::listIdentifiers();
 
            try {
                if (
                    (in_array($tzid, $tzIdentifiers)) ||
                    (preg_match('/^GMT(\+|-)([0-9]{4})$/', $tzid, $matches)) ||
                    (in_array($tzid, self::getIdentifiersBC()))
                ) {
                    return new \DateTimeZone($tzid);
                }
            } catch (\Exception $e) {
            }
 
        }
 
        self::loadTzMaps();
 
        // Next, we check if the tzid is somewhere in our tzid map.
        if (isset(self::$map[$tzid])) {
            return new \DateTimeZone(self::$map[$tzid]);
        }
 
        // Some Microsoft products prefix the offset first, so let's strip that off
        // and see if it is our tzid map.  We don't want to check for this first just
        // in case there are overrides in our tzid map.
        if (preg_match('/^\‍((UTC|GMT)(\+|\-)[\d]{2}\:[\d]{2}\‍) (.*)/', $tzid, $matches)) {
            $tzidAlternate = $matches[3];
            if (isset(self::$map[$tzidAlternate])) {
                return new \DateTimeZone(self::$map[$tzidAlternate]);
            }
        }
 
        // Maybe the author was hyper-lazy and just included an offset. We
        // support it, but we aren't happy about it.
        if (preg_match('/^GMT(\+|-)([0-9]{4})$/', $tzid, $matches)) {
 
            // Note that the path in the source will never be taken from PHP 5.5.10
            // onwards. PHP 5.5.10 supports the "GMT+0100" style of format, so it
            // already gets returned early in this function. Once we drop support
            // for versions under PHP 5.5.10, this bit can be taken out of the
            // source.
            // @codeCoverageIgnoreStart
            return new \DateTimeZone('Etc/GMT' . $matches[1] . ltrim(substr($matches[2], 0, 2), '0'));
            // @codeCoverageIgnoreEnd
        }
 
        if ($vcalendar) {
 
            // If that didn't work, we will scan VTIMEZONE objects
            foreach ($vcalendar->select('VTIMEZONE') as $vtimezone) {
 
                if ((string)$vtimezone->TZID === $tzid) {
 
                    // Some clients add 'X-LIC-LOCATION' with the olson name.
                    if (isset($vtimezone->{'X-LIC-LOCATION'})) {
 
                        $lic = (string)$vtimezone->{'X-LIC-LOCATION'};
 
                        // Libical generators may specify strings like
                        // "SystemV/EST5EDT". For those we must remove the
                        // SystemV part.
                        if (substr($lic, 0, 8) === 'SystemV/') {
                            $lic = substr($lic, 8);
                        }
 
                        return self::getTimeZone($lic, null, $failIfUncertain);
 
                    }
                    // Microsoft may add a magic number, which we also have an
                    // answer for.
                    if (isset($vtimezone->{'X-MICROSOFT-CDO-TZID'})) {
                        $cdoId = (int)$vtimezone->{'X-MICROSOFT-CDO-TZID'}->getValue();
 
                        // 2 can mean both Europe/Lisbon and Europe/Sarajevo.
                        if ($cdoId === 2 && strpos((string)$vtimezone->TZID, 'Sarajevo') !== false) {
                            return new \DateTimeZone('Europe/Sarajevo');
                        }
 
                        if (isset(self::$microsoftExchangeMap[$cdoId])) {
                            return new \DateTimeZone(self::$microsoftExchangeMap[$cdoId]);
                        }
                    }
 
                }
 
            }
 
        }
 
        if ($failIfUncertain) {
            throw new \InvalidArgumentException('We were unable to determine the correct PHP timezone for tzid: ' . $tzid);
        }
 
        // If we got all the way here, we default to UTC.
        return new \DateTimeZone(date_default_timezone_get());
 
    }

References $map, Sabre\VObject\TimeZoneUtil\getTimeZone(), and Sabre\VObject\TimeZoneUtil\loadTzMaps().

Referenced by Sabre\VObject\Property\ICalendar\DateTime\getDateTimes(), Sabre\VObject\TimeZoneUtil\getTimeZone(), Sabre\VObject\Component\VTimeZone\getTimeZone(), Sabre\VObject\TimeZoneUtilTest\testExchangeMap(), Sabre\VObject\TimeZoneUtilTest\testFallBack(), Sabre\VObject\TimeZoneUtilTest\testLjubljanaBug(), Sabre\VObject\TimeZoneUtilTest\testPrefixedOffsetExchangeIdentifier(), Sabre\VObject\TimeZoneUtilTest\testTimeZoneBCIdentifiers(), Sabre\VObject\TimeZoneUtilTest\testTimezoneFail(), Sabre\VObject\TimeZoneUtilTest\testTimeZoneIdentifiers(), Sabre\VObject\TimeZoneUtilTest\testTimezoneOffset(), Sabre\VObject\TimeZoneUtilTest\testUnknownExchangeId(), Sabre\VObject\TimeZoneUtilTest\testWeirdSystemVLICs(), Sabre\VObject\TimeZoneUtilTest\testWetherMicrosoftIsStillInsane(), and Sabre\VObject\TimeZoneUtilTest\testWindowsTimeZone().

Here is the call graph for this function:

Here is the caller graph for this function:

loadTzMaps()

static Sabre\VObject\TimeZoneUtil::loadTzMaps ( )

static

This method will load in all the tz mapping information, if it's not yet done.

Definition at line 248 of file TimeZoneUtil.php.

                                 {
 
        if (!is_null(self::$map)) return;
 
        self::$map = array_merge(
            include __DIR__ . '/timezonedata/windowszones.php',
            include __DIR__ . '/timezonedata/lotuszones.php',
            include __DIR__ . '/timezonedata/exchangezones.php',
            include __DIR__ . '/timezonedata/php-workaround.php'
        );
 
    }

References $map.

Referenced by Sabre\VObject\TimeZoneUtilTest\getMapping(), and Sabre\VObject\TimeZoneUtil\getTimeZone().

Here is the caller graph for this function:

Field Documentation

$map

Sabre\VObject\TimeZoneUtil::$map = null

static

Definition at line 17 of file TimeZoneUtil.php.

Referenced by Sabre\VObject\TimeZoneUtilTest\getMapping().

$microsoftExchangeMap

Sabre\VObject\TimeZoneUtil::$microsoftExchangeMap

static

List of microsoft exchange timezone ids.

Source: http://msdn.microsoft.com/en-us/library/aa563018(loband).aspx

Definition at line 24 of file TimeZoneUtil.php.

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/sabre/vobject/lib/TimeZoneUtil.php