The IntlTimeZone class

(PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1)

Introduction

Class synopsis

class IntlTimeZone {

/* Constants */

public const int DISPLAY_SHORT;

public const int DISPLAY_LONG;

public const int DISPLAY_SHORT_GENERIC;

public const int DISPLAY_LONG_GENERIC;

public const int DISPLAY_SHORT_GMT;

public const int DISPLAY_LONG_GMT;

public const int DISPLAY_SHORT_COMMONLY_USED;

public const int DISPLAY_GENERIC_LOCATION;

public const int TYPE_ANY;

public const int TYPE_CANONICAL;

public const int TYPE_CANONICAL_LOCATION;

/* Methods */

private function __construct()

public static function countEquivalentIDs(string $timezoneId): int|false

public static function createDefault(): IntlTimeZone

public static function createEnumeration(string|int|null $countryOrRawOffset = null): IntlIterator|false

public static function createTimeZone(string $timezoneId): ?IntlTimeZone

public static function createTimeZoneIDEnumeration(int $type, ?string $region = null, ?int $rawOffset = null): IntlIterator|false

public static function fromDateTimeZone(DateTimeZone $timezone): ?IntlTimeZone

public static function getCanonicalID(string $timezoneId, bool &$isSystemId = null): string|false

public function getDisplayName(bool $dst = false, int $style = IntlTimeZone::DISPLAY_LONG, ?string $locale = null): string|false

public function getDSTSavings(): int

public static function getEquivalentID(string $timezoneId, int $offset): string|false

public function getErrorCode(): int|false

public function getErrorMessage(): string|false

public static function getGMT(): IntlTimeZone

public static function getIanaID(string $timezoneId): string|false

public function getID(): string|false

public static function getIDForWindowsID(string $timezoneId, ?string $region = null): string|false

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

public function getRawOffset(): int

public static function getRegion(string $timezoneId): string|false

public static function getTZDataVersion(): string|false

public static function getUnknown(): IntlTimeZone

public static function getWindowsID(string $timezoneId): string|false

public function hasSameRules(IntlTimeZone $other): bool

public function toDateTimeZone(): DateTimeZone|false

public function useDaylightTime(): bool

}

Predefined Constants

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

Changelog

Version	Description
8.4.0	The class constants are now typed.

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::getIanaID — Translate a timezone identifier to its IANA equivalent
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

The IntlTimeZone class

Introduction

Class synopsis

Predefined Constants

Changelog

Table of Contents