The DateTimeZone class

(PHP 5 >= 5.2.0, PHP 7)

Introduction

Representation of time zone.

Class synopsis

DateTimeZone {

/* Constants */

const integer AFRICA = 1 ;

const integer AMERICA = 2 ;

const integer ANTARCTICA = 4 ;

const integer ARCTIC = 8 ;

const integer ASIA = 16 ;

const integer ATLANTIC = 32 ;

const integer AUSTRALIA = 64 ;

const integer EUROPE = 128 ;

const integer INDIAN = 256 ;

const integer PACIFIC = 512 ;

const integer UTC = 1024 ;

const integer ALL = 2047 ;

const integer ALL_WITH_BC = 4095 ;

const integer PER_COUNTRY = 4096 ;

/* Methods */

public __construct ( string $timezone )

public array getLocation ( void )

public string getName ( void )

public int getOffset ( DateTime $datetime )

public array getTransitions ([ int $timestamp_begin [, int $timestamp_end ]] )

public static array listAbbreviations ( void )

public static array listIdentifiers ([ int $what = DateTimeZone::ALL [, string $country = NULL ]] )

}

Predefined Constants

DateTimeZone::AFRICA: Africa time zones.
DateTimeZone::AMERICA: America time zones.
DateTimeZone::ANTARCTICA: Antarctica time zones.
DateTimeZone::ARCTIC: Arctic time zones.
DateTimeZone::ASIA: Asia time zones.
DateTimeZone::ATLANTIC: Atlantic time zones.
DateTimeZone::AUSTRALIA: Australia time zones.
DateTimeZone::EUROPE: Europe time zones.
DateTimeZone::INDIAN: Indian time zones.
DateTimeZone::PACIFIC: Pacific time zones.
DateTimeZone::UTC: UTC time zones.
DateTimeZone::ALL: All time zones.
DateTimeZone::ALL_WITH_BC: All time zones including backwards compatible.
DateTimeZone::PER_COUNTRY: Time zones per country.

DateTimeZone::__construct — Creates new DateTimeZone object
DateTimeZone::getLocation — Returns location information for a timezone
DateTimeZone::getName — Returns the name of the timezone
DateTimeZone::getOffset — Returns the timezone offset from GMT
DateTimeZone::getTransitions — Returns all transitions for the timezone
DateTimeZone::listAbbreviations — Returns associative array containing dst, offset and the timezone name
DateTimeZone::listIdentifiers — Returns a numerically indexed array containing all defined timezone identifiers

User Contributed Notes

ryan at amst dot com

8 months ago


It seems like as of PHP 5.5, creating a new DateTimeZone with a string like 'EDT' will cause DateTimeZone::getName() to return 'EDT' whereas prior to 5.5 it would convert it would have returned 'America/New_York'

This is of particular note when using a DateTimeZone object to change the timezone on a DateTime object.  Using a DateTimeZone object when set as shown above will cause the conversion to be wrong without throwing any errors.

The DateTimeZone class

Introduction

Class synopsis

Predefined Constants

Table of Contents

User Contributed Notes