PhpOffice\PhpSpreadsheet\Shared\TimeZone Class Reference

Collaboration diagram for PhpOffice\PhpSpreadsheet\Shared\TimeZone:

Static Public Member Functions
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	validateTimeZone ($timezone)
	Validate a Timezone name. More...

Detailed Description

Definition at line 8 of file TimeZone.php.

Member Function Documentation

getTimeZone()

static PhpOffice\PhpSpreadsheet\Shared\TimeZone::getTimeZone ( )

static

Return the Default Timezone used for date/time conversions.

Returns

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

Definition at line 52 of file TimeZone.php.

    {
        return self::$timezone;
    }

getTimeZoneAdjustment()

static PhpOffice\PhpSpreadsheet\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
float | int	$timestamp	PHP date/time value

Returns

int Number of seconds for timezone adjustment

Definition at line 66 of file TimeZone.php.

References PhpOffice\PhpSpreadsheet\Shared\TimeZone\$timezone.

    {
        $timezone = $timezone ?? self::$timezone;
        $dtobj = Date::dateTimeFromTimestamp("$timestamp");
        if (!self::validateTimezone($timezone)) {
            throw new PhpSpreadsheetException("Invalid timezone $timezone");
        }
        $dtobj->setTimeZone(new DateTimeZone($timezone));

        return $dtobj->getOffset();
    }

setTimeZone()

static PhpOffice\PhpSpreadsheet\Shared\TimeZone::setTimeZone (   $timezone )

static

Set the Default Timezone used for date/time conversions.

Parameters

string

$timezone

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

Returns

bool Success or failure

Definition at line 36 of file TimeZone.php.

References PhpOffice\PhpSpreadsheet\Shared\TimeZone\$timezone.

    {
        if (self::validateTimezone($timezone)) {
            self::$timezone = $timezone;

            return true;
        }

        return false;
    }

validateTimeZone()

static PhpOffice\PhpSpreadsheet\Shared\TimeZone::validateTimeZone (   $timezone )

staticprivate

Validate a Timezone name.

Parameters

string

$timezone

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

Returns

bool Success or failure

Definition at line 24 of file TimeZone.php.

References PhpOffice\PhpSpreadsheet\Shared\TimeZone\$timezone.

    {
        return in_array($timezone, DateTimeZone::listIdentifiers(DateTimeZone::ALL_WITH_BC));
    }

Field Documentation

$timezone

PhpOffice\PhpSpreadsheet\Shared\TimeZone::$timezone = 'UTC'

staticprotected

Definition at line 15 of file TimeZone.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\TimeZone\getTimeZoneAdjustment(), PhpOffice\PhpSpreadsheet\Shared\TimeZone\setTimeZone(), and PhpOffice\PhpSpreadsheet\Shared\TimeZone\validateTimeZone().

---

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

• libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Shared/TimeZone.php