Collaboration diagram for ilCalendarUserSettings:

Public Member Functions
	getTimeZone ()

	setTimeZone (string $a_tz)

	getExportTimeZoneType ()

	setExportTimeZoneType (int $a_type)

	getExportTimeZone ()

	setWeekStart (int $a_weekstart)

	getWeekStart ()

	setDayStart (int $a_start)

	getDayStart ()

	setDayEnd (int $a_end)

	getDayEnd ()

	setDateFormat (int $a_format)

	getDateFormat ()

	setTimeFormat (int $a_format)

	getTimeFormat ()

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

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

	setShowWeeks (bool $a_val)

	getShowWeeks ()

	save ()

Static Public Member Functions
static	_getInstanceByUserId (int $a_user_id)

static	_getInstance ()

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 array	$instances = array()

Protected Member Functions
	read ()

	translateDateFormatToId (DateFormat $format)

Protected Attributes
ilObjUser	$user

ilCalendarSettings	$settings

Private Member Functions
	__construct (int $a_user_id)

Private Attributes
int	$calendar_selection_type = 1

string	$timezone = ilTimeZone::UTC

int	$export_tz_type = self::CAL_EXPORT_TZ_TZ

int	$weekstart = 0

int	$time_format = 0

int	$date_format = 0

int	$day_start = 0

int	$day_end = 0

bool	$show_weeks = true

Detailed Description

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

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

Constructor & Destructor Documentation

◆ __construct()

ilCalendarUserSettings::__construct ( int $a_user_id )

private

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

    {
        global $DIC;
 
        $this->user = $DIC->user();
 
        if ($this->user->getId() !== $a_user_id) {
            $user = ilObjectFactory::getInstanceByObjId($a_user_id, false);
            if ($user instanceof ilObjUser) {
                $this->user = $user;
            } else {
                throw new DomainException('Invalid user id given: ' . $a_user_id);
            }
        }
        $this->settings = ilCalendarSettings::_getInstance();
        $this->read();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ _getInstance()

static ilCalendarUserSettings::_getInstance ( )

static

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

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

References $DIC, and _getInstanceByUserId().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getInstanceByUserId()

static ilCalendarUserSettings::_getInstanceByUserId ( int $a_user_id )

static

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

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

Referenced by ilCalendarBlockGUI\__construct(), ilCalendarUserSettingsGUI\__construct(), ilCalendarExport\__construct(), ilCalendarSchedule\__construct(), ilMiniCalendarGUI\__construct(), ilCalendarHeaderNavigationGUI\__construct(), ilRecurrenceInputGUI\__construct(), _getInstance(), ilBookingProcessWithScheduleGUI\book(), ilCalendarViewGUI\getBucketTitle(), ilCalendarDayGUI\initialize(), ilCalendarInboxGUI\initialize(), ilCalendarMonthGUI\initialize(), ilCalendarWeekGUI\initialize(), ilCalendarRecurrence\toICal(), and ilBookingProcessWithScheduleGUI\week().

Here is the caller graph for this function:

◆ getCalendarSelectionType()

ilCalendarUserSettings::getCalendarSelectionType ( )

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

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

                                              : int
    {
        return $this->calendar_selection_type;
    }

References $calendar_selection_type.

Referenced by save().

Here is the caller graph for this function:

◆ getDateFormat()

ilCalendarUserSettings::getDateFormat ( )

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

                                   : int
    {
        return $this->date_format;
    }

References $date_format.

Referenced by save().

Here is the caller graph for this function:

◆ getDayEnd()

ilCalendarUserSettings::getDayEnd ( )

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

                               : int
    {
        return $this->day_end;
    }

References $day_end.

Referenced by save().

Here is the caller graph for this function:

◆ getDayStart()

ilCalendarUserSettings::getDayStart ( )

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

                                 : int
    {
        return $this->day_start;
    }

References $day_start.

Referenced by save().

Here is the caller graph for this function:

◆ getExportTimeZone()

ilCalendarUserSettings::getExportTimeZone ( )

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

                                       : string
    {
        switch ($this->getExportTimeZoneType()) {
            case self::CAL_EXPORT_TZ_TZ:
                return $this->getTimeZone();
 
            case self::CAL_EXPORT_TZ_UTC:
                return ilTimeZone::UTC;
        }
        return '';
    }

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 ( )

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

                                           : int
    {
        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 ( )

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

                                  : bool
    {
        return $this->show_weeks;
    }

References $show_weeks.

Referenced by save().

Here is the caller graph for this function:

◆ getTimeFormat()

ilCalendarUserSettings::getTimeFormat ( )

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

                                   : int
    {
        return $this->time_format;
    }

References $time_format.

Referenced by save().

Here is the caller graph for this function:

◆ getTimeZone()

ilCalendarUserSettings::getTimeZone ( )

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

                                 : string
    {
        return $this->timezone;
    }

References $timezone.

Referenced by getExportTimeZone(), and save().

Here is the caller graph for this function:

◆ getWeekStart()

ilCalendarUserSettings::getWeekStart ( )

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

                                  : int
    {
        return $this->weekstart;
    }

References $weekstart.

Referenced by save().

Here is the caller graph for this function:

◆ read()

ilCalendarUserSettings::read ( )

protected

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

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

References $export_tz_type, $weekstart, CAL_SELECTION_MEMBERSHIP, ILIAS\Repository\int(), setDayEnd(), setDayStart(), setShowWeeks(), ILIAS\Repository\settings(), translateDateFormatToId(), and ILIAS\Repository\user().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilCalendarUserSettings::save ( )

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

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

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

Here is the call graph for this function:

◆ setCalendarSelectionType()

ilCalendarUserSettings::setCalendarSelectionType ( int $a_type )

set calendar selection type

Parameters

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

Returns: void

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

    {
        $this->calendar_selection_type = $a_type;
    }

◆ setDateFormat()

ilCalendarUserSettings::setDateFormat ( int $a_format )

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

                                                : void
    {
        $this->date_format = $a_format;
    }

◆ setDayEnd()

ilCalendarUserSettings::setDayEnd ( int $a_end )

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

                                         : void
    {
        $this->day_end = $a_end;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setDayStart()

ilCalendarUserSettings::setDayStart ( int $a_start )

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

                                             : void
    {
        $this->day_start = $a_start;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setExportTimeZoneType()

ilCalendarUserSettings::setExportTimeZoneType ( int $a_type )

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

                                                      : void
    {
        $this->export_tz_type = $a_type;
    }

◆ setShowWeeks()

ilCalendarUserSettings::setShowWeeks ( bool $a_val )

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

                                             : void
    {
        $this->show_weeks = $a_val;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setTimeFormat()

ilCalendarUserSettings::setTimeFormat ( int $a_format )

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

                                                : void
    {
        $this->time_format = $a_format;
    }

◆ setTimeZone()

ilCalendarUserSettings::setTimeZone ( string $a_tz )

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

                                             : void
    {
        $this->timezone = $a_tz;
    }

◆ setWeekStart()

ilCalendarUserSettings::setWeekStart ( int $a_weekstart )

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

                                                  : void
    {
        $this->weekstart = $a_weekstart;
    }

◆ translateDateFormatToId()

ilCalendarUserSettings::translateDateFormatToId ( DateFormat $format )

protected

Todo:: use the data DateFormat throughout to avoid this translation

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

                                                                  : int
    {
        switch ((string) $format) {
            case 'd.m.Y':
                return ilCalendarSettings::DATE_FORMAT_DMY;
 
            case 'm/d/Y':
                return ilCalendarSettings::DATE_FORMAT_MDY;
 
            case 'Y-m-d':
            default:
                return ilCalendarSettings::DATE_FORMAT_YMD;
        }
    }