ilTimeZone Class Reference

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

Collaboration diagram for ilTimeZone:

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

Static Public Member Functions
static	_getInstance ($a_tz='')
	get instance by timezone More...
static	_setDefaultTimeZone ($a_tz)
	set default timezone More...
static	_restoreDefaultTimeZone ()
	restore default timezone to server timezone More...
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	$instances = array()
static	$valid_tz = array()

Static Protected Member Functions
static	_switchTimeZone ($a_timezone)
	Switch tz. More...

Protected Attributes
	$log
	$timezone = "UTC"

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

Private Member Functions
	__construct ($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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilTimeZone::__construct (   $a_timezone )

private

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

@access private

Parameters

string

valid timezone

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

    {
        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();
        }
    }

References $DIC, and _getDefaultTimeZone().

Here is the call graph for this function:

Member Function Documentation

__sleep()

ilTimeZone::__sleep

(

)

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

    {
        return array('timezone');
    }

__wakeup()

ilTimeZone::__wakeup

(

)

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

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

References $DIC.

_getDefaultTimeZone()

static ilTimeZone::_getDefaultTimeZone ( )

static

Calculate and set default time zone.

@access public

Returns

time zone string

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

    {
        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;
    }

References $default_timezone, $tz, and UTC.

Referenced by ilSoapInstallationInfoXMLWriter\__buildClient(), __construct(), _getInstance(), _setDefaultTimeZone(), initDefaultTimeZone(), ilObjCalendarSettingsGUI\initFormSettings(), and ilCalendarSettings\read().

Here is the caller graph for this function:

_getInstance()

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

static

get instance by timezone

@access public

Parameters

string

valid php timezone

Exceptions

ilTimeZoneException

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

    {
        global $DIC;
 
        if (!$a_tz) {
            $a_tz = self::_getDefaultTimeZone();
        }
        
        if (isset(self::$instances[$a_tz])) {
            $instance = self::$instances[$a_tz];
        } else {
            $instance = 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;
    }

References $DIC, and _getDefaultTimeZone().

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

Here is the call graph for this function:

Here is the caller graph for this function:

_restoreDefaultTimeZone()

static ilTimeZone::_restoreDefaultTimeZone ( )

static

restore default timezone to server timezone

@access public

Parameters

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

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

References $server_timezone, and _switchTimeZone().

Referenced by ilCalendarRecurrenceCalculator\calculateDateList().

Here is the call graph for this function:

Here is the caller graph for this function:

_setDefaultTimeZone()

static ilTimeZone::_setDefaultTimeZone (   $a_tz )

static

set default timezone

@access public

Parameters

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

    {
        // 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;
    }

References _getDefaultTimeZone().

Referenced by ilCalendarRecurrenceCalculator\adjustTimeZones().

Here is the call graph for this function:

Here is the caller graph for this function:

_switchTimeZone()

static ilTimeZone::_switchTimeZone (   $a_timezone )

staticprotected

Switch tz.

@access public

Exceptions

ilTimeZoneException

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

    {
        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;
    }

References $DIC.

Referenced by _restoreDefaultTimeZone(), restoreTZ(), and switchTZ().

Here is the caller graph for this function:

getIdentifier()

ilTimeZone::getIdentifier

(

)

get identifier

@access public

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

    {
        return $this->timezone;
    }

References $timezone.

initDefaultTimeZone()

static ilTimeZone::initDefaultTimeZone ( ilIniFile  $ini )

static

Initialize default timezone from system settings.

Returns

bool

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

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

References $ini, $tz, and _getDefaultTimeZone().

Referenced by ilInitialisation\initIliasIniFile().

Here is the call graph for this function:

Here is the caller graph for this function:

restoreTZ()

ilTimeZone::restoreTZ

(

)

Restore default timezone.

@access public

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

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

References _switchTimeZone().

Referenced by validateTZ().

Here is the call graph for this function:

Here is the caller graph for this function:

switchTZ()

ilTimeZone::switchTZ

(

)

Switch timezone to given timezone.

@access public

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

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

References _switchTimeZone().

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

Here is the call graph for this function:

Here is the caller graph for this function:

validateTZ()

ilTimeZone::validateTZ

(

)

validate timezone

@access public

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

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

References restoreTZ(), and switchTZ().

Here is the call graph for this function:

Field Documentation

$current_timezone

ilTimeZone::$current_timezone = ''

staticprotected

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

$default_timezone

ilTimeZone::$default_timezone = ''

staticprotected

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

Referenced by _getDefaultTimeZone().

$instances

ilTimeZone::$instances = array()

static

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

$log

ilTimeZone::$log

protected

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

$server_timezone

ilTimeZone::$server_timezone = ''

staticprotected

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

Referenced by _restoreDefaultTimeZone().

$timezone

ilTimeZone::$timezone = "UTC"

protected

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

Referenced by getIdentifier().

$valid_tz

ilTimeZone::$valid_tz = array()

static

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

UTC

const ilTimeZone::UTC = 'UTC'

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

Referenced by ilDate\__construct(), _getDefaultTimeZone(), ilCalendarCategory\add(), ilCalendarRecurrenceCalculator\adjustTimeZones(), ilExportFileInfo\create(), ilCalendarExport\createVEVENT(), ilConsultationHourUtils\findCalendarAppointmentsForBooking(), ilCalendarUserSettings\getExportTimeZone(), ilTrQuery\getSessionData(), ilECSTimePlace\getUTBegin(), ilECSTimePlace\getUTEnd(), ilBookingEntry\lookupBookingsForObject(), ilObjectCustomUserFieldHistory\lookupEntriesByObjectId(), ilSCTasks\lookupLastUpdate(), ilContainerXmlParser\parseTiming(), ilExportFileInfo\read(), ilObjectCustomUserFieldHistory\read(), ilSCGroup\read(), ilSCTask\read(), ilDateList\removeByDAY(), ilConsultationHourCron\run(), ilCalendarEntry\save(), ilObjectCustomUserFieldHistory\save(), ilECSTimePlace\setBegin(), ilECSTimePlace\setEnd(), ilCalendarRecurrenceExclusion\toICal(), ilCalendarCategory\update(), ilCalendarEntry\update(), ilSCTask\update(), and ilContainerXmlWriter\writeCourseItemInformation().

---

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

• Services/Calendar/classes/class.ilTimeZone.php