The IntlTimeZone class

Introduction

Class synopsis

IntlTimeZone

/* Constants */

public const int IntlTimeZone::DISPLAY_SHORT;

public const int IntlTimeZone::DISPLAY_LONG;

public const int IntlTimeZone::DISPLAY_SHORT_GENERIC;

public const int IntlTimeZone::DISPLAY_LONG_GENERIC;

public const int IntlTimeZone::DISPLAY_SHORT_GMT;

public const int IntlTimeZone::DISPLAY_LONG_GMT;

public const int IntlTimeZone::DISPLAY_SHORT_COMMONLY_USED;

public const int IntlTimeZone::DISPLAY_GENERIC_LOCATION;

public const int IntlTimeZone::TYPE_ANY;

public const int IntlTimeZone::TYPE_CANONICAL;

public const int IntlTimeZone::TYPE_CANONICAL_LOCATION;

/* Methods */

private __construct()

public static intfalse countEquivalentIDs(string $timezoneId)

public static IntlTimeZone createDefault()

public static IntlIteratorfalse createEnumeration(IntlTimeZonestringintfloatnull $countryOrRawOffset = null)

public static IntlTimeZonenull createTimeZone(string $timezoneId)

public static IntlIteratorfalse createTimeZoneIDEnumeration(int $type, stringnull $region = null, intnull $rawOffset = null)

public static IntlTimeZonenull fromDateTimeZone(DateTimeZone $timezone)

public static stringfalse getCanonicalID(string $timezoneId, bool &$isSystemId = null)

public stringfalse getDisplayName(bool $dst = false, int $style = IntlTimeZone::DISPLAY_LONG, stringnull $locale = null)

public int getDSTSavings()

public static stringfalse getEquivalentID(string $timezoneId, int $offset)

public intfalse getErrorCode()

public stringfalse getErrorMessage()

public static IntlTimeZone getGMT()

public stringfalse getID()

public static stringfalse getIDForWindowsID(string $timezoneId, stringnull $region = null)

public bool getOffset(
    float $timestamp,
    bool $local,
    int &$rawOffset,
    int &$dstOffset
)

public int getRawOffset()

public static stringfalse getRegion(string $timezoneId)

public static stringfalse getTZDataVersion()

public static IntlTimeZone getUnknown()

public static stringfalse getWindowsID(string $timezoneId)

public bool hasSameRules(IntlTimeZone $other)

public DateTimeZonefalse toDateTimeZone()

public bool useDaylightTime()

Predefined Constants

IntlTimeZone::DISPLAY_SHORT
IntlTimeZone::DISPLAY_LONG
IntlTimeZone::DISPLAY_SHORT_GENERIC
IntlTimeZone::DISPLAY_LONG_GENERIC
IntlTimeZone::DISPLAY_SHORT_GMT
IntlTimeZone::DISPLAY_LONG_GMT
IntlTimeZone::DISPLAY_SHORT_COMMONLY_USED
IntlTimeZone::DISPLAY_GENERIC_LOCATION
IntlTimeZone::TYPE_ANY
IntlTimeZone::TYPE_CANONICAL
IntlTimeZone::TYPE_CANONICAL_LOCATION

Table of Contents

IntlTimeZone::__construct — Private constructor to disallow direct instantiation
IntlTimeZone::countEquivalentIDs — Get the number of IDs in the equivalency group that includes the given ID
IntlTimeZone::createDefault — Create a new copy of the default timezone for this host
IntlTimeZone::createEnumeration — Get an enumeration over time zone IDs associated with the given country or offset
IntlTimeZone::createTimeZone — Create a timezone object for the given ID
IntlTimeZone::createTimeZoneIDEnumeration — Get an enumeration over system time zone IDs with the given filter conditions
IntlTimeZone::fromDateTimeZone — Create a timezone object from DateTimeZone
IntlTimeZone::getCanonicalID — Get the canonical system timezone ID or the normalized custom time zone ID for the given time zone ID
IntlTimeZone::getDisplayName — Get a name of this time zone suitable for presentation to the user
IntlTimeZone::getDSTSavings — Get the amount of time to be added to local standard time to get local wall clock time
IntlTimeZone::getEquivalentID — Get an ID in the equivalency group that includes the given ID
IntlTimeZone::getErrorCode — Get last error code on the object
IntlTimeZone::getErrorMessage — Get last error message on the object
IntlTimeZone::getGMT — Create GMT (UTC) timezone
IntlTimeZone::getID — Get timezone ID
IntlTimeZone::getIDForWindowsID — Translate a Windows timezone into a system timezone
IntlTimeZone::getOffset — Get the time zone raw and GMT offset for the given moment in time
IntlTimeZone::getRawOffset — Get the raw GMT offset (before taking daylight savings time into account
IntlTimeZone::getRegion — Get the region code associated with the given system time zone ID
IntlTimeZone::getTZDataVersion — Get the timezone data version currently used by ICU
IntlTimeZone::getUnknown — Get the "unknown" time zone
IntlTimeZone::getWindowsID — Translate a system timezone into a Windows timezone
IntlTimeZone::hasSameRules — Check if this zone has the same rules and offset as another zone
IntlTimeZone::toDateTimeZone — Convert to DateTimeZone object
IntlTimeZone::useDaylightTime — Check if this time zone uses daylight savings time