ilTimeZone Class Reference

This class offers methods for timezone handling. More...

Collaboration diagram for ilTimeZone:

Public Member Functions
	__sleep ()
	__wakeup ()
	getIdentifier ()
	switchTZ ()
	Switch timezone to given timezone. More...
	restoreTZ ()
	Restore default timezone. More...
	validateTZ ()

Static Public Member Functions
static	_getInstance (string $a_tz='')
	get instance by timezone More...
static	_setDefaultTimeZone (string $a_tz)
static	_restoreDefaultTimeZone ()
static	_getDefaultTimeZone ()
	Calculate and set default time zone. More...
static	initDefaultTimeZone (ilIniFile $ini)
	Initialize default timezone from system settings. More...

Data Fields
const	UTC = 'UTC'

Static Public Attributes
static array	$instances = array()
static array	$valid_tz = array()

Static Protected Member Functions
static	_switchTimeZone (string $a_timezone)

Protected Attributes
ilLogger	$log
string	$timezone = "UTC"

Static Protected Attributes
static string	$default_timezone = ''
static string	$current_timezone = ''
static string	$server_timezone = ''

Private Member Functions
	__construct (string $a_timezone)
	Create new timezone object If no timezone is given, the default server timezone is chosen. More...

Detailed Description

This class offers methods for timezone handling.

ilTimeZone::_getDefault tries to "guess" the server timezone in the following manner: 1) PHP >= 5.2.0 use date_default_timezone_get 2) Read ini option date.timezone if available 3) Read environment PHP_TZ 4) Read environment TZ 5) Use date('T') 6) Use UTC

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 32 of file class.ilTimeZone.php.

Constructor & Destructor Documentation

__construct()

ilTimeZone::__construct ( string  $a_timezone )

private

Create new timezone object If no timezone is given, the default server timezone is chosen.

Definition at line 50 of file class.ilTimeZone.php.

References $DIC.

    {
        global $DIC;

        $this->log = $DIC->logger()->cal();

        if ($a_timezone) {
            $this->timezone = $a_timezone;
        } else {
            $this->timezone = self::_getDefaultTimeZone();
        }

        if (!self::$server_timezone) {
            self::$server_timezone = self::_getDefaultTimeZone();
        }

        if (!self::$default_timezone) {
            self::_getDefaultTimeZone();
        }
    }

Member Function Documentation

__sleep()

ilTimeZone::__sleep

(

)

Definition at line 71 of file class.ilTimeZone.php.

    {
        return array('timezone');
    }

__wakeup()

ilTimeZone::__wakeup

(

)

Definition at line 76 of file class.ilTimeZone.php.

References $DIC.

    {
        global $DIC;
        $this->log = $DIC->logger()->cal();
    }

_getDefaultTimeZone()

static ilTimeZone::_getDefaultTimeZone ( )

static

Calculate and set default time zone.

Definition at line 195 of file class.ilTimeZone.php.

Referenced by ilObjCalendarSettingsGUI\initFormSettings(), and ilCalendarSettings\read().

                                                : string
    {
        if (strlen(self::$default_timezone)) {
            return self::$default_timezone;
        }
        // PHP >= 5.2.0
        // php throws a warning date_default_timezone_get relies on os determination. There is no way to check if this could happen.
        if (function_exists('date_default_timezone_get') and $tz = date_default_timezone_get()) {
            return self::$default_timezone = $tz;
        }
        // PHP ini option (PHP >= 5.1.0)
        if ($tz = ini_get('date.timezone')) {
            return self::$default_timezone = $tz;
        }
        // is $_ENV['PHP_TZ'] set ?
        if ($tz = getenv('PHP_TZ')) {
            return self::$default_timezone = $tz;
        }
        // is $_ENV['TZ'] set ?
        if ($tz = getenv('TZ')) {
            return self::$default_timezone = $tz;
        }
        if (strlen($tz = date('T'))) {
            return self::$default_timezone = $tz;
        }
        return self::$default_timezone = self::UTC;
    }

Here is the caller graph for this function:

_getInstance()

static ilTimeZone::_getInstance ( string  $a_tz = '' )

static

get instance by timezone

Exceptions

ilTimeZoneException

Definition at line 91 of file class.ilTimeZone.php.

Referenced by ilDate\__construct(), ilICalParser\__construct(), ilDateTime\__construct(), ilCalendarRecurrenceCalculator\applyBYMONTHDAYRules(), ilDateTime\get(), ilICalParser\getTZ(), ilDateTime\switchTimeZone(), and ilUserImportParser\verifyPref().

                                                          : ilTimeZone
    {
        if (!$a_tz) {
            $a_tz = self::_getDefaultTimeZone();
        }

        $instance = self::$instances[$a_tz] ?? (self::$instances[$a_tz] = new ilTimeZone($a_tz));

        // Validate timezone if it is not validated before
        if (!array_key_exists($instance->getIdentifier(), self::$valid_tz)) {
            if (!$instance->validateTZ()) {
                throw new ilTimeZoneException('Unsupported timezone given.');
            }
            self::$valid_tz[$instance->getIdentifier()] = true;
        }

        // now validate timezone setting
        return $instance;
    }

Here is the caller graph for this function:

_restoreDefaultTimeZone()

static ilTimeZone::_restoreDefaultTimeZone ( )

static

Definition at line 186 of file class.ilTimeZone.php.

Referenced by ilCalendarRecurrenceCalculator\calculateDateList().

                                                    : void
    {
        self::$default_timezone = self::$server_timezone;
        self::_switchTimeZone(self::$default_timezone);
    }

Here is the caller graph for this function:

_setDefaultTimeZone()

static ilTimeZone::_setDefaultTimeZone ( string  $a_tz )

static

Definition at line 177 of file class.ilTimeZone.php.

Referenced by ilCalendarRecurrenceCalculator\adjustTimeZones().

                                                            : void
    {
        // Save the server timezone, since there is no way to read later.
        if (!self::$server_timezone) {
            self::$server_timezone = self::_getDefaultTimeZone();
        }
        self::$default_timezone = $a_tz;
    }

Here is the caller graph for this function:

_switchTimeZone()

static ilTimeZone::_switchTimeZone ( string  $a_timezone )

staticprotected

Definition at line 150 of file class.ilTimeZone.php.

References $DIC.

                                                                 : bool
    {
        global $DIC;

        $logger = $DIC->logger()->cal();
        if (self::$current_timezone == $a_timezone) {
            return true;
        }

        // PHP >= 5.2.0
        if (function_exists('date_default_timezone_set')) {
            if (!date_default_timezone_set($a_timezone)) {
                $logger->info('Invalid timezone given. Timezone: ' . $a_timezone);
                throw new ilTimeZoneException('Invalid timezone given');
            }
            #$ilLog->write(__METHOD__.': Switched timezone to: '.$a_timezone);
            self::$current_timezone = $a_timezone;
            return true;
        }
        if (!putenv('TZ=' . $a_timezone)) {
            $logger->warning('Cannot set TZ environment variable. Please register TZ in php.ini (safe_mode_allowed_env_vars). Timezone');
            throw new ilTimeZoneException('Cannot set TZ environment variable.');
        }
        self::$current_timezone = $a_timezone;
        return true;
    }

getIdentifier()

ilTimeZone::getIdentifier

(

)

Definition at line 82 of file class.ilTimeZone.php.

References $timezone.

Referenced by ilDateTime\get(), and ilICalParser\switchTZ().

                                   : string
    {
        return $this->timezone;
    }

Here is the caller graph for this function:

initDefaultTimeZone()

static ilTimeZone::initDefaultTimeZone ( ilIniFile  $ini )

static

Initialize default timezone from system settings.

Definition at line 226 of file class.ilTimeZone.php.

References ilIniFile\readVariable().

Referenced by ilInitialisation\initIliasIniFile().

                                                              : string
    {
        $tz = $ini->readVariable('server', 'timezone');
        if (!strlen($tz)) {
            $tz = self::_getDefaultTimeZone();
        }
        if (!strlen($tz)) {
            $tz = 'UTC';
        }
        date_default_timezone_set($tz);
        return $tz;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

restoreTZ()

ilTimeZone::restoreTZ

(

)

Restore default timezone.

Definition at line 129 of file class.ilTimeZone.php.

References Vendor\Package\$e.

Referenced by validateTZ().

                               : bool
    {
        try {
            self::_switchTimeZone(self::$default_timezone);
            return true;
        } catch (ilTimeZoneException $e) {
            // Shouldn't happen since this has been checked during initialisation
            $this->log->warning(': Unsupported timezone given: Timzone: ' . $this->timezone);
            return false;
        }
    }

Here is the caller graph for this function:

switchTZ()

ilTimeZone::switchTZ

(

)

Switch timezone to given timezone.

Definition at line 114 of file class.ilTimeZone.php.

Referenced by ilICalParser\switchTZ(), and validateTZ().

                              : bool
    {
        try {
            self::_switchTimeZone($this->timezone);
            return true;
        } catch (ilTimeZoneException $exc) {
            // Shouldn't happen since this has been checked during initialisation
            $this->log->warning(': Unsupported timezone given: Timzone: ' . $this->timezone);
            return false;
        }
    }

Here is the caller graph for this function:

validateTZ()

ilTimeZone::validateTZ

(

)

Definition at line 141 of file class.ilTimeZone.php.

References restoreTZ(), and switchTZ().

                                : bool
    {
        // this is done by switching to the current tz
        if ($this->switchTZ() and $this->restoreTZ()) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Field Documentation

$current_timezone

string ilTimeZone::$current_timezone = ''

staticprotected

Definition at line 40 of file class.ilTimeZone.php.

$default_timezone

string ilTimeZone::$default_timezone = ''

staticprotected

Definition at line 39 of file class.ilTimeZone.php.

$instances

array ilTimeZone::$instances = array()

static

Definition at line 36 of file class.ilTimeZone.php.

$log

ilLogger ilTimeZone::$log

protected

Definition at line 43 of file class.ilTimeZone.php.

$server_timezone

string ilTimeZone::$server_timezone = ''

staticprotected

Definition at line 41 of file class.ilTimeZone.php.

$timezone

string ilTimeZone::$timezone = "UTC"

protected

Definition at line 44 of file class.ilTimeZone.php.

Referenced by getIdentifier().

$valid_tz

array ilTimeZone::$valid_tz = array()

static

Definition at line 37 of file class.ilTimeZone.php.

UTC

const ilTimeZone::UTC = 'UTC'

Definition at line 34 of file class.ilTimeZone.php.

Referenced by ilDate\__construct(), ilObjCourse\__readSettings(), ilCalendarCategory\add(), ilCalendarExport\addCategories(), ilCalendarRecurrenceCalculator\adjustTimeZones(), ilCalendarUtil\convertDateToUtcDBTimestamp(), ilObjEmployeeTalkSeriesGUI\copyTemplateValues(), ilExportFileInfo\create(), ilCalendarExport\createVEVENT(), ilEmployeeTalkAppointmentGUI\deleteTalks(), ilEmployeeTalkAppointmentGUI\editAppointment(), ilConsultationHourUtils\findCalendarAppointmentsForBooking(), ilObjCourse\findCoursesWithNotEnoughMembers(), ilObjGroup\findGroupsWithNotEnoughMembers(), ilCalendarUserSettings\getExportTimeZone(), ilAdvancedMDFieldDefinitionDateTime\getLuceneSearchString(), ilTrQuery\getSessionData(), ilECSTimePlace\getUTBegin(), ilECSTimePlace\getUTEnd(), ilObjEmployeeTalkSeriesGUI\loadRecurrenceSettings(), ilEmployeeTalkAppointmentGUI\loadRecurrenceSettings(), ilBookingEntry\lookupBookingsForObject(), ilObjectCustomUserFieldHistory\lookupEntriesByObjectId(), ilSCTasks\lookupLastUpdate(), ilObjGroupAccess\lookupPeriodInfo(), ilObjCourseAccess\lookupPeriodInfo(), ILIAS\EmployeeTalk\Talk\Repository\IliasDBEmployeeTalkRepository\parseFromStdClass(), ilContainerXmlParser\parseTiming(), ilSCGroup\read(), ilSCTask\read(), ilObjectCustomUserFieldHistory\read(), ilExportFileInfo\read(), ilObjGroup\read(), ilDateList\removeByDAY(), ilConsultationHourCron\run(), ilObjectCustomUserFieldHistory\save(), ilCalendarEntry\save(), ilECSTimePlace\setBegin(), ilECSTimePlace\setEnd(), ilCalendarRecurrenceExclusion\toICal(), ilSCTask\update(), ilCalendarCategory\update(), ilCalendarEntry\update(), and ilContainerXmlWriter\writeCourseItemInformation().

---

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

• components/ILIAS/Calendar/classes/class.ilTimeZone.php