PHPExcel_Shared_TimeZone Class Reference

Collaboration diagram for PHPExcel_Shared_TimeZone:

Static Public Member Functions
static	_validateTimeZone ($timezone)
	Validate a Timezone name. More...
static	setTimeZone ($timezone)
	Set the Default Timezone used for date/time conversions. More...
static	getTimeZone ()
	Return the Default Timezone used for date/time conversions. More...
static	getTimeZoneAdjustment ($timezone, $timestamp)
	Return the Timezone offset used for date/time conversions to/from UST This requires both the timezone and the calculated date/time to allow for local DST. More...

Static Protected Attributes
static	$_timezone = 'UTC'

Static Private Member Functions
static	_getTimezoneTransitions ($objTimezone, $timestamp)
	Return the Timezone transition for the specified timezone and timestamp. More...

Detailed Description

Definition at line 37 of file TimeZone.php.

Member Function Documentation

_getTimezoneTransitions()

static PHPExcel_Shared_TimeZone::_getTimezoneTransitions (   $objTimezone,   $timestamp  )

staticprivate

Return the Timezone transition for the specified timezone and timestamp.

Parameters

DateTimeZone	$objTimezone	The timezone for finding the transitions
integer	$timestamp	PHP date/time value for finding the current transition

Returns

array The current transition details

Definition at line 92 of file TimeZone.php.

References $key, $timestamp, and array.

                                                                                  {
                $allTransitions = $objTimezone->getTransitions();
                $transitions = array();
                foreach($allTransitions as $key => $transition) {
                        if ($transition['ts'] > $timestamp) {
                                $transitions[] = ($key > 0) ? $allTransitions[$key - 1] : $transition;
                                break;
                        }
                        if (empty($transitions)) {
                                $transitions[] = end($allTransitions);
                        }
                }

                return $transitions;
        }

_validateTimeZone()

static PHPExcel_Shared_TimeZone::_validateTimeZone (   $timezone )

static

Validate a Timezone name.

Parameters

string

$timezone

Time zone (e.g. 'Europe/London')

Returns

boolean Success or failure

Definition at line 53 of file TimeZone.php.

                                                            {
                if (in_array($timezone, DateTimeZone::listIdentifiers())) {
                        return TRUE;
                }
                return FALSE;
        }

getTimeZone()

static PHPExcel_Shared_TimeZone::getTimeZone ( )

static

Return the Default Timezone used for date/time conversions.

Returns

string Timezone (e.g. 'Europe/London')

Definition at line 80 of file TimeZone.php.

                                             {
                return self::$_timezone;
        }       //      function getTimezone()

getTimeZoneAdjustment()

static PHPExcel_Shared_TimeZone::getTimeZoneAdjustment (   $timezone,   $timestamp  )

static

Return the Timezone offset used for date/time conversions to/from UST This requires both the timezone and the calculated date/time to allow for local DST.

Parameters

string	$timezone	The timezone for finding the adjustment to UST
integer	$timestamp	PHP date/time value

Returns

integer Number of seconds for timezone adjustment

Exceptions

PHPExcel_Exception

Definition at line 117 of file TimeZone.php.

References $timestamp.

                                                                            {
                if ($timezone !== NULL) {
                        if (!self::_validateTimezone($timezone)) {
                                throw new PHPExcel_Exception("Invalid timezone " . $timezone);
                        }
                } else {
                        $timezone = self::$_timezone;
                }

                if ($timezone == 'UST') {
                        return 0;
                }

                $objTimezone = new DateTimeZone($timezone);
                if (version_compare(PHP_VERSION, '5.3.0') >= 0) {
                        $transitions = $objTimezone->getTransitions($timestamp,$timestamp);
                } else {
                        $transitions = self::_getTimezoneTransitions($objTimezone, $timestamp);
                }

                return (count($transitions) > 0) ? $transitions[0]['offset'] : 0;
        }

setTimeZone()

static PHPExcel_Shared_TimeZone::setTimeZone (   $timezone )

static

Set the Default Timezone used for date/time conversions.

Parameters

string

$timezone

Time zone (e.g. 'Europe/London')

Returns

boolean Success or failure

Definition at line 66 of file TimeZone.php.

                                                      {
                if (self::_validateTimezone($timezone)) {
                        self::$_timezone = $timezone;
                        return TRUE;
                }
                return FALSE;
        }       //      function setTimezone()

Field Documentation

$_timezone

PHPExcel_Shared_TimeZone::$_timezone = 'UTC'

staticprotected

Definition at line 45 of file TimeZone.php.

---

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

• libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/Shared/TimeZone.php