Collaboration diagram for ilCalendarUserSettings:

Public Member Functions
	getTimeZone ()
	get Time zone More...

	setTimeZone ($a_tz)
	set timezone More...

	getExportTimeZoneType ()
	Get export timezone setting. More...

	setExportTimeZoneType ($a_type)
	Set export timezone type. More...

	getExportTimeZone ()
	Get export timezone. More...

	setWeekStart ($a_weekstart)
	set week start More...

	getWeekStart ()
	get weekstart More...

	setDayStart ($a_start)
	Set start of day. More...

	getDayStart ()
	get start of day More...

	setDayEnd ($a_end)
	Set day end. More...

	getDayEnd ()
	Get end of day. More...

	setDateFormat ($a_format)
	set date format More...

	getDateFormat ()
	get date format More...

	setTimeFormat ($a_format)
	set time format More...

	getTimeFormat ()
	get time format More...

	getCalendarSelectionType ()
	get calendar selection type ("MyMembership" or "Selected Items") More...

	setCalendarSelectionType ($a_type)
	set calendar selection type More...

	setShowWeeks ($a_val)
	Set show weeks. More...

	getShowWeeks ()
	Get show weeks. More...

	save ()
	save More...

Static Public Member Functions
static	_getInstanceByUserId ($a_user_id)
	get singleton instance More...

static	_getInstance ()
	get instance for logged in user More...

Data Fields
const	CAL_SELECTION_MEMBERSHIP = 1

const	CAL_SELECTION_ITEMS = 2

const	CAL_EXPORT_TZ_TZ = 1

const	CAL_EXPORT_TZ_UTC = 2

Static Public Attributes
static	$instances = array()

Protected Member Functions
	read ()
	read More...

Protected Attributes
	$user

	$settings

Private Member Functions
	__construct ($a_user_id)
	Constructor. More...

Private Attributes
	$calendar_selection_type = 1

	$timezone

	$export_tz_type = self::CAL_EXPORT_TZ_TZ

	$weekstart

	$time_format

	$date_format

	$day_start

	$day_end

	$show_weeks = true

Detailed Description

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

Version: $Id$

Definition at line 11 of file class.ilCalendarUserSettings.php.

Constructor & Destructor Documentation

◆ __construct()

ilCalendarUserSettings::__construct ( $a_user_id )

private

Constructor.

@access private

Parameters

return

Definition at line 46 of file class.ilCalendarUserSettings.php.

    {
        global $DIC;
 
        $ilUser = $DIC['ilUser'];
        
        if ($ilUser->getId() == $a_user_id) {
            $this->user = $ilUser;
        } else {
            $this->user = ilObjectFactory::getInstanceByObjId($a_user_id, false);
        }
        $this->settings = ilCalendarSettings::_getInstance();
        $this->read();
    }

References $DIC, $ilUser, ilCalendarSettings\_getInstance(), ilObjectFactory\getInstanceByObjId(), read(), settings(), and user().

Here is the call graph for this function:

Member Function Documentation

◆ _getInstance()

static ilCalendarUserSettings::_getInstance ( )

static

get instance for logged in user

Returns: object ilCalendarUserSettings

Definition at line 83 of file class.ilCalendarUserSettings.php.

    {
        global $DIC;
 
        $ilUser = $DIC['ilUser'];
        
        return self::_getInstanceByUserId($ilUser->getId());
    }

References $DIC, $ilUser, and _getInstanceByUserId().

Referenced by ilCalendarPresentationGUI\__construct(), ilCalendarSelectionBlockGUI\__construct(), ilCalendarCategoryGUI\appendCalendarSelection(), ilCalendarSelectionBlockGUI\getCalendars(), ilPDCalendarBlockGUI\initCategories(), ilCalendarCategories\initialize(), and ilCalendarCategoryGUI\switchCalendarMode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getInstanceByUserId()

static ilCalendarUserSettings::_getInstanceByUserId ( $a_user_id )

static

get singleton instance

@access public

Parameters

int user id

Returns: object ilCalendarUserSettings

Definition at line 69 of file class.ilCalendarUserSettings.php.

    {
        if (isset(self::$instances[$a_user_id])) {
            return self::$instances[$a_user_id];
        }
        return self::$instances[$a_user_id] = new ilCalendarUserSettings($a_user_id);
    }

Here is the caller graph for this function:

◆ getCalendarSelectionType()

ilCalendarUserSettings::getCalendarSelectionType ( )

get calendar selection type ("MyMembership" or "Selected Items")

Returns

Definition at line 265 of file class.ilCalendarUserSettings.php.

    {
        return $this->calendar_selection_type;
    }

References $calendar_selection_type.

Referenced by save().

Here is the caller graph for this function:

◆ getDateFormat()

ilCalendarUserSettings::getDateFormat ( )

get date format

@access public

Returns: int date format

Definition at line 231 of file class.ilCalendarUserSettings.php.

    {
        return $this->date_format;
    }

References $date_format.

Referenced by save().

Here is the caller graph for this function:

◆ getDayEnd()

ilCalendarUserSettings::getDayEnd ( )

Get end of day.

Returns

Definition at line 208 of file class.ilCalendarUserSettings.php.

    {
        return $this->day_end;
    }

References $day_end.

Referenced by save().

Here is the caller graph for this function:

◆ getDayStart()

ilCalendarUserSettings::getDayStart ( )

get start of day

Returns

Definition at line 189 of file class.ilCalendarUserSettings.php.

    {
        return $this->day_start;
    }

References $day_start.

Referenced by save().

Here is the caller graph for this function:

◆ getExportTimeZone()

ilCalendarUserSettings::getExportTimeZone ( )

Get export timezone.

Returns: type

Definition at line 138 of file class.ilCalendarUserSettings.php.

    {
        switch ($this->getExportTimeZoneType()) {
            case self::CAL_EXPORT_TZ_TZ:
                return $this->getTimeZone();
                
            case self::CAL_EXPORT_TZ_UTC:
                include_once './Services/Calendar/classes/class.ilTimeZone.php';
                return ilTimeZone::UTC;
        }
    }

References CAL_EXPORT_TZ_TZ, CAL_EXPORT_TZ_UTC, getExportTimeZoneType(), getTimeZone(), and ilTimeZone\UTC.

Here is the call graph for this function:

◆ getExportTimeZoneType()

ilCalendarUserSettings::getExportTimeZoneType ( )

Get export timezone setting.

Returns: type

Definition at line 120 of file class.ilCalendarUserSettings.php.

    {
        return $this->export_tz_type;
    }

References $export_tz_type.

Referenced by getExportTimeZone(), and save().

Here is the caller graph for this function:

◆ getShowWeeks()

ilCalendarUserSettings::getShowWeeks ( )

Get show weeks.

Returns: bool show weeks

Definition at line 295 of file class.ilCalendarUserSettings.php.

    {
        return $this->show_weeks;
    }

References $show_weeks.

Referenced by save().

Here is the caller graph for this function:

◆ getTimeFormat()

ilCalendarUserSettings::getTimeFormat ( )

get time format

@access public

Returns: int time format

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

    {
        return $this->time_format;
    }

References $time_format.

Referenced by save().

Here is the caller graph for this function:

◆ getTimeZone()

ilCalendarUserSettings::getTimeZone ( )

get Time zone

@access public

Parameters

return

Definition at line 99 of file class.ilCalendarUserSettings.php.

    {
        return $this->timezone;
    }

References $timezone.

Referenced by getExportTimeZone(), and save().

Here is the caller graph for this function:

◆ getWeekStart()

ilCalendarUserSettings::getWeekStart ( )

get weekstart

@access public

Returns

Definition at line 170 of file class.ilCalendarUserSettings.php.

    {
        return (int) $this->weekstart;
    }

References $weekstart.

Referenced by save().

Here is the caller graph for this function:

◆ read()

ilCalendarUserSettings::read ( )

protected

read

@access protected

Definition at line 324 of file class.ilCalendarUserSettings.php.

    {
        $this->timezone = $this->user->getTimeZone();
        $this->export_tz_type = (
            ($this->user->getPref('export_tz_type') !== false) ?
                $this->user->getPref('export_tz_type') :
                $this->export_tz_type
        );
        $this->date_format = $this->user->getDateFormat();
        $this->time_format = $this->user->getTimeFormat();
        if (($weekstart = $this->user->getPref('weekstart')) === false) {
            $weekstart = $this->settings->getDefaultWeekStart();
        }
        $this->calendar_selection_type = $this->user->getPref('calendar_selection_type') ?
            $this->user->getPref('calendar_selection_type') :
            self::CAL_SELECTION_MEMBERSHIP;
 
        $this->weekstart = $weekstart;
        
        $this->setDayStart(
            $this->user->getPref('day_start') !== false ?
            $this->user->getPref('day_start') :
            $this->settings->getDefaultDayStart()
        );
        $this->setDayEnd(
            $this->user->getPref('day_end') !== false ?
            $this->user->getPref('day_end') :
            $this->settings->getDefaultDayEnd()
        );
        $this->setShowWeeks(
            $this->user->getPref('show_weeks') !== false ?
            $this->user->getPref('show_weeks') :
            $this->settings->getShowWeeks()
        );
    }

References $export_tz_type, $weekstart, CAL_SELECTION_MEMBERSHIP, setDayEnd(), setDayStart(), setShowWeeks(), settings(), and user().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilCalendarUserSettings::save ( )

save

@access public

Definition at line 305 of file class.ilCalendarUserSettings.php.

    {
        $this->user->writePref('user_tz', $this->getTimeZone());
        $this->user->writePref('export_tz_type', $this->getExportTimeZoneType());
        $this->user->writePref('weekstart', $this->getWeekStart());
        $this->user->writePref('date_format', $this->getDateFormat());
        $this->user->writePref('time_format', $this->getTimeFormat());
        $this->user->writePref('calendar_selection_type', $this->getCalendarSelectionType());
        $this->user->writePref('day_start', $this->getDayStart());
        $this->user->writePref('day_end', $this->getDayEnd());
        $this->user->writePref('show_weeks', $this->getShowWeeks());
    }

References getCalendarSelectionType(), getDateFormat(), getDayEnd(), getDayStart(), getExportTimeZoneType(), getShowWeeks(), getTimeFormat(), getTimeZone(), getWeekStart(), and user().

Here is the call graph for this function:

◆ setCalendarSelectionType()

ilCalendarUserSettings::setCalendarSelectionType ( $a_type )

set calendar selection type

Parameters

int $type self::CAL_SELECTION_MEMBERSHIP | self::CAL_SELECTION_ITEM

Returns: void

Definition at line 275 of file class.ilCalendarUserSettings.php.

    {
        $this->calendar_selection_type = $a_type;
    }

◆ setDateFormat()

ilCalendarUserSettings::setDateFormat ( $a_format )

set date format

@access public

Parameters

int date

Returns

Definition at line 220 of file class.ilCalendarUserSettings.php.

    {
        $this->date_format = $a_format;
    }

◆ setDayEnd()

ilCalendarUserSettings::setDayEnd ( $a_end )

Set day end.

Returns

Parameters

int $a_end

Definition at line 199 of file class.ilCalendarUserSettings.php.

    {
        $this->day_end = $a_end;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setDayStart()

ilCalendarUserSettings::setDayStart ( $a_start )

Set start of day.

Returns

Parameters

int $a_start

Definition at line 180 of file class.ilCalendarUserSettings.php.

    {
        $this->day_start = $a_start;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setExportTimeZoneType()

ilCalendarUserSettings::setExportTimeZoneType ( $a_type )

Set export timezone type.

Parameters

type $a_type

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

    {
        $this->export_tz_type = $a_type;
    }

◆ setShowWeeks()

ilCalendarUserSettings::setShowWeeks ( $a_val )

Set show weeks.

Parameters

bool $a_val show weeks

Definition at line 285 of file class.ilCalendarUserSettings.php.

    {
        $this->show_weeks = $a_val;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setTimeFormat()

ilCalendarUserSettings::setTimeFormat ( $a_format )

set time format

@access public

Parameters

int time

Returns

Definition at line 243 of file class.ilCalendarUserSettings.php.

    {
        $this->time_format = $a_format;
    }

◆ setTimeZone()

ilCalendarUserSettings::setTimeZone ( $a_tz )

set timezone

@access public

Parameters

return

Definition at line 111 of file class.ilCalendarUserSettings.php.

    {
        $this->timezone = $a_tz;
    }

◆ setWeekStart()

ilCalendarUserSettings::setWeekStart ( $a_weekstart )

set week start

@access public

Parameters

return

Definition at line 159 of file class.ilCalendarUserSettings.php.

    {
        $this->weekstart = $a_weekstart;
    }

Field Documentation

◆ $calendar_selection_type

ilCalendarUserSettings::$calendar_selection_type = 1

private

Definition at line 24 of file class.ilCalendarUserSettings.php.

Referenced by getCalendarSelectionType().

◆ $date_format

ilCalendarUserSettings::$date_format

private

Definition at line 29 of file class.ilCalendarUserSettings.php.

Referenced by getDateFormat().

◆ $day_end

ilCalendarUserSettings::$day_end

private

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

Referenced by getDayEnd().

◆ $day_start

ilCalendarUserSettings::$day_start

private

Definition at line 31 of file class.ilCalendarUserSettings.php.

Referenced by getDayStart().

◆ $export_tz_type

ilCalendarUserSettings::$export_tz_type = self::CAL_EXPORT_TZ_TZ

private

Definition at line 26 of file class.ilCalendarUserSettings.php.

Referenced by getExportTimeZoneType(), and read().

◆ $instances

ilCalendarUserSettings::$instances = array()

static

Definition at line 19 of file class.ilCalendarUserSettings.php.

◆ $settings

ilCalendarUserSettings::$settings

protected

Definition at line 22 of file class.ilCalendarUserSettings.php.

◆ $show_weeks

ilCalendarUserSettings::$show_weeks = true

private

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

Referenced by getShowWeeks().

◆ $time_format

ilCalendarUserSettings::$time_format

private

Definition at line 28 of file class.ilCalendarUserSettings.php.

Referenced by getTimeFormat().

◆ $timezone

ilCalendarUserSettings::$timezone

private

Definition at line 25 of file class.ilCalendarUserSettings.php.

Referenced by getTimeZone().

◆ $user

ilCalendarUserSettings::$user

protected

Definition at line 21 of file class.ilCalendarUserSettings.php.

◆ $weekstart

ilCalendarUserSettings::$weekstart

private

Definition at line 27 of file class.ilCalendarUserSettings.php.

Referenced by getWeekStart(), and read().

◆ CAL_EXPORT_TZ_TZ

const ilCalendarUserSettings::CAL_EXPORT_TZ_TZ = 1

Definition at line 16 of file class.ilCalendarUserSettings.php.

Referenced by getExportTimeZone(), and ilCalendarUserSettingsGUI\initSettingsForm().

◆ CAL_EXPORT_TZ_UTC

const ilCalendarUserSettings::CAL_EXPORT_TZ_UTC = 2

Definition at line 17 of file class.ilCalendarUserSettings.php.

Referenced by ilCalendarExport\createTimezones(), ilCalendarExport\createVEVENT(), getExportTimeZone(), and ilCalendarUserSettingsGUI\initSettingsForm().

◆ CAL_SELECTION_ITEMS

const ilCalendarUserSettings::CAL_SELECTION_ITEMS = 2

Definition at line 14 of file class.ilCalendarUserSettings.php.

Referenced by ilCalendarSelectionBlockGUI\__construct(), and ilCalendarCategoryGUI\appendCalendarSelection().

◆ CAL_SELECTION_MEMBERSHIP

const ilCalendarUserSettings::CAL_SELECTION_MEMBERSHIP = 1

Definition at line 13 of file class.ilCalendarUserSettings.php.

Referenced by ilCalendarPresentationGUI\__construct(), ilCalendarSelectionBlockGUI\__construct(), ilCalendarCategoryGUI\appendCalendarSelection(), ilCalendarSelectionBlockGUI\getCalendars(), ilPDCalendarBlockGUI\initCategories(), ilCalendarCategories\initialize(), and read().

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

Services/Calendar/classes/class.ilCalendarUserSettings.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getInstance()

◆ _getInstanceByUserId()

◆ getCalendarSelectionType()

◆ getDateFormat()

◆ getDayEnd()

◆ getDayStart()

◆ getExportTimeZone()

◆ getExportTimeZoneType()

◆ getShowWeeks()

◆ getTimeFormat()

◆ getTimeZone()

◆ getWeekStart()

◆ read()

◆ save()

◆ setCalendarSelectionType()

◆ setDateFormat()

◆ setDayEnd()

◆ setDayStart()

◆ setExportTimeZoneType()

◆ setShowWeeks()

◆ setTimeFormat()

◆ setTimeZone()

◆ setWeekStart()

Field Documentation

◆ $calendar_selection_type

◆ $date_format

◆ $day_end

◆ $day_start

◆ $export_tz_type

◆ $instances

◆ $settings

◆ $show_weeks

◆ $time_format

◆ $timezone

◆ $user

◆ $weekstart

◆ CAL_EXPORT_TZ_TZ

◆ CAL_EXPORT_TZ_UTC

◆ CAL_SELECTION_ITEMS

◆ CAL_SELECTION_MEMBERSHIP