Stores all calendar relevant settings. More...

Collaboration diagram for ilCalendarSettings:

Public Member Functions
	useCache (bool $a_status)

	isCacheUsed ()

	setCacheMinutes (int $a_min)

	getCacheMinutes ()

	setEnabled (bool $a_enabled)

	isEnabled ()

	setDefaultWeekStart (int $a_start)

	getDefaultWeekStart ()

	getDefaultCal ()

	setDefaultCal (int $default_cal)

	getDefaultPeriod ()

	setDefaultPeriod (int $default_period)

	setDefaultTimeZone (string $a_zone)

	getDefaultTimeZone ()

	setDefaultDateFormat (int $a_format)

	getDefaultDateFormat ()

	setDefaultTimeFormat (int $a_format)

	getDefaultTimeFormat ()

	getDefaultDayStart ()

	setDefaultDayStart (int $a_start)

	getDefaultDayEnd ()

	setDefaultDayEnd (int $a_end)

	areConsultationHoursEnabled ()

	enableConsultationHours (bool $a_status)

	getCalendarSettingsId ()

	isSynchronisationCacheEnabled ()

	enableSynchronisationCache (bool $a_status)

	setSynchronisationCacheMinutes (int $a_min)

	getSynchronisationCacheMinutes ()

	isNotificationEnabled ()

	enableNotification (bool $a_status)

	isUserNotificationEnabled ()

	enableUserNotification (bool $a_not)

	enableCGRegistration (bool $a_status)

	isCGRegistrationEnabled ()

	enableCourseCalendar (bool $a_stat)

	isCourseCalendarEnabled ()

	isCourseCalendarVisible ()

	setCourseCalendarVisible (bool $status)

	isObjectCalendarVisible (string $type)

	enableGroupCalendar (bool $a_stat)

	isGroupCalendarEnabled ()

	isGroupCalendarVisible ()

	setGroupCalendarVisible (bool $status)

	enableWebCalSync (bool $a_stat)

	isWebCalSyncEnabled ()

	setWebCalSyncHours (int $a_hours)

	getWebCalSyncHours ()

	setShowWeeks (bool $a_val)

	getShowWeeks ()

	enableBatchFileDownloads (bool $a_stat)

	isBatchFileDownloadsEnabled ()

	save ()

Static Public Member Functions
static	_getInstance ()

static	lookupCalendarContentPresentationEnabled (int $obj_id)

static	lookupCalendarActivated (int $a_obj_id)

Data Fields
const	WEEK_START_MONDAY = 1

const	WEEK_START_SUNDAY = 0

const	DEFAULT_DAY_START = 8

const	DEFAULT_DAY_END = 19

const	DATE_FORMAT_UNDEFINED = 0

const	DATE_FORMAT_DMY = 1

const	DATE_FORMAT_YMD = 2

const	DATE_FORMAT_MDY = 3

const	DEFAULT_CAL_DAY = 1

const	DEFAULT_CAL_WEEK = 2

const	DEFAULT_CAL_MONTH = 3

const	DEFAULT_CAL_LIST = 4

const	TIME_FORMAT_24 = 1

const	TIME_FORMAT_12 = 2

const	DEFAULT_CACHE_MINUTES = 0

const	DEFAULT_SYNC_CACHE_MINUTES = 10

const	DEFAULT_SHOW_WEEKS = true

Protected Attributes
ilDBInterface	$db

ilSetting	$storage

Private Member Functions
	__construct ()

	read ()

	readCalendarSettingsId ()

	initStorage ()

Private Attributes
string	$timezone = ilTimeZone::UTC

int	$time_format = self::TIME_FORMAT_12

int	$week_start = self::WEEK_START_SUNDAY

int	$day_start = self::DEFAULT_DAY_START

int	$day_end = self::DEFAULT_DAY_END

bool	$enabled = false

int	$cal_settings_id = 0

bool	$consultation_hours = false

int	$date_format = 0

int	$default_cal = self::DEFAULT_CAL_LIST

int	$default_period = 2

bool	$cache_enabled = true

int	$cache_minutes = 1

bool	$sync_cache_enabled = true

int	$sync_cache_minutes = 10

bool	$notification = false

bool	$notification_user = false

bool	$cg_registration = false

bool	$course_cal_enabled = true

bool	$group_cal_enabled = true

bool	$course_cal_visible = true

bool	$group_cal_visible = true

bool	$webcal_sync = false

int	$webcal_sync_hours = 2

bool	$show_weeks = false

bool	$batch_file_downloads = false

Static Private Attributes
static ilCalendarSettings	$instance = null

Detailed Description

Stores all calendar relevant settings.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

◆ __construct()

ilCalendarSettings::__construct ( )

private

Definition at line 89 of file class.ilCalendarSettings.php.

References $DIC, initStorage(), read(), and readCalendarSettingsId().

     {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->initStorage();
         $this->read();
         $this->readCalendarSettingsId();
     }

Here is the call graph for this function:

Member Function Documentation

◆ _getInstance()

static ilCalendarSettings::_getInstance ( )

static

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

Referenced by ilCalendarCache\__construct(), ilCalendarCronRemoteReader\__construct(), ilCalendarUserSettingsGUI\__construct(), ilCalendarAppointmentPanelGUI\__construct(), ilCalendarUserSettings\__construct(), ilCalendarAppointmentPresentationGUI\__construct(), ilCalendarPresentationGUI\__construct(), ilCalendarBlockGUI\__construct(), ilCalendarPresentationGUI\addStandardTabs(), ilCalendarViewGUI\addToolbarFileDownload(), ilAppointmentPresentationGroupGUI\collectPropertiesAndActions(), ilAppointmentPresentationCourseGUI\collectPropertiesAndActions(), ilCalendarPresentationGUI\executeCommand(), ilAppointmentBaseFileHandler\getCatInfo(), ilObjUser\getDateFormat(), ilAppointmentPresentationGUI\getHTML(), ilCalendarAgendaListGUI\getPeriod(), ilUserStartingPointRepository\getPossibleStartingPoints(), ILIAS\GlobalScreen\Provider\Provider\CalendarMainBarProvider\getStaticSubItems(), ilObjUser\getTimeFormat(), ilObjUser\getTimeZone(), ilUserStartingPointRepository\getValidAndAccessibleStartingPointAsUrl(), ilPortfolioPageConfig\init(), ilObjCalendarSettingsGUI\initCalendarSettings(), ilCalendarAppointmentGUI\initForm(), ilCalendarCategoryGUI\initFormCategory(), ilCalendarAgendaListGUI\initPeriod(), ilObjectServiceSettingsGUI\initServiceSettingsForm(), ilColumnGUI\isGloballyActivated(), ilCalendarAuthenticationToken\isIcalExpired(), lookupCalendarActivated(), ilCalendarCache\readEntry(), ilCalendarCategoryGUI\readPermissions(), ilCalendarCategories\readPublicCalendars(), ilCalendarCategories\readReposCalendars(), ilCalendarCategories\readSelectedCategories(), ilCalendarAppointmentGUI\save(), ilCalendarWeekGUI\show(), ilCalendarMonthGUI\show(), ilCalendarCache\storeEntry(), ilCalendarCache\storeUnlimitedEntry(), ilCalendarAppointmentGUI\update(), and ilObjectServiceSettingsGUI\updateServiceSettingsForm().

                                          : ilCalendarSettings
     {
         if (self::$instance) {
             return self::$instance;
         }
         return self::$instance = new ilCalendarSettings();
     }

Here is the caller graph for this function:

◆ areConsultationHoursEnabled()

ilCalendarSettings::areConsultationHoursEnabled ( )

Definition at line 260 of file class.ilCalendarSettings.php.

References $consultation_hours.

Referenced by save().

                                                  : bool
     {
         return $this->consultation_hours;
     }

Here is the caller graph for this function:

◆ enableBatchFileDownloads()

ilCalendarSettings::enableBatchFileDownloads ( bool $a_stat )

Definition at line 406 of file class.ilCalendarSettings.php.

Referenced by read().

                                                           : void
     {
         $this->batch_file_downloads = $a_stat;
     }

Here is the caller graph for this function:

◆ enableCGRegistration()

ilCalendarSettings::enableCGRegistration ( bool $a_status )

Definition at line 315 of file class.ilCalendarSettings.php.

Referenced by read().

                                                         : void
     {
         $this->cg_registration = $a_status;
     }

Here is the caller graph for this function:

◆ enableConsultationHours()

ilCalendarSettings::enableConsultationHours ( bool $a_status )

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

Referenced by read().

                                                            : void
     {
         $this->consultation_hours = $a_status;
     }

Here is the caller graph for this function:

◆ enableCourseCalendar()

ilCalendarSettings::enableCourseCalendar ( bool $a_stat )

Definition at line 325 of file class.ilCalendarSettings.php.

Referenced by read().

                                                       : void
     {
         $this->course_cal_enabled = $a_stat;
     }

Here is the caller graph for this function:

◆ enableGroupCalendar()

ilCalendarSettings::enableGroupCalendar ( bool $a_stat )

Definition at line 356 of file class.ilCalendarSettings.php.

Referenced by read().

                                                      : void
     {
         $this->group_cal_enabled = $a_stat;
     }

Here is the caller graph for this function:

◆ enableNotification()

ilCalendarSettings::enableNotification ( bool $a_status )

Definition at line 300 of file class.ilCalendarSettings.php.

References ILIAS\UI\examples\Symbol\Glyph\Notification\notification().

Referenced by read().

                                                       : void
     {
         $this->notification = $a_status;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enableSynchronisationCache()

ilCalendarSettings::enableSynchronisationCache ( bool $a_status )

Definition at line 280 of file class.ilCalendarSettings.php.

Referenced by read().

                                                               : void
     {
         $this->sync_cache_enabled = $a_status;
     }

Here is the caller graph for this function:

◆ enableUserNotification()

ilCalendarSettings::enableUserNotification ( bool $a_not )

Definition at line 310 of file class.ilCalendarSettings.php.

Referenced by read().

                                                        : void
     {
         $this->notification_user = $a_not;
     }

Here is the caller graph for this function:

◆ enableWebCalSync()

ilCalendarSettings::enableWebCalSync ( bool $a_stat )

Definition at line 376 of file class.ilCalendarSettings.php.

Referenced by read().

                                                   : void
     {
         $this->webcal_sync = $a_stat;
     }

Here is the caller graph for this function:

◆ getCacheMinutes()

ilCalendarSettings::getCacheMinutes ( )

Definition at line 165 of file class.ilCalendarSettings.php.

References $cache_minutes.

Referenced by save().

                                      : int
     {
         return $this->cache_minutes;
     }

Here is the caller graph for this function:

◆ getCalendarSettingsId()

ilCalendarSettings::getCalendarSettingsId ( )

Definition at line 270 of file class.ilCalendarSettings.php.

References $cal_settings_id.

                                            : int
     {
         return $this->cal_settings_id;
     }

◆ getDefaultCal()

ilCalendarSettings::getDefaultCal ( )

Definition at line 190 of file class.ilCalendarSettings.php.

References $default_cal.

Referenced by save().

                                    : int
     {
         return $this->default_cal;
     }

Here is the caller graph for this function:

◆ getDefaultDateFormat()

ilCalendarSettings::getDefaultDateFormat ( )

Definition at line 225 of file class.ilCalendarSettings.php.

References $date_format.

Referenced by save().

                                           : int
     {
         return $this->date_format;
     }

Here is the caller graph for this function:

◆ getDefaultDayEnd()

ilCalendarSettings::getDefaultDayEnd ( )

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

References $day_end.

Referenced by save().

                                       : int
     {
         return $this->day_end;
     }

Here is the caller graph for this function:

◆ getDefaultDayStart()

ilCalendarSettings::getDefaultDayStart ( )

Definition at line 240 of file class.ilCalendarSettings.php.

References $day_start.

Referenced by save().

                                         : int
     {
         return $this->day_start;
     }

Here is the caller graph for this function:

◆ getDefaultPeriod()

ilCalendarSettings::getDefaultPeriod ( )

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

References $default_period.

Referenced by save().

                                       : int
     {
         return $this->default_period;
     }

Here is the caller graph for this function:

◆ getDefaultTimeFormat()

ilCalendarSettings::getDefaultTimeFormat ( )

Definition at line 235 of file class.ilCalendarSettings.php.

References $time_format.

Referenced by save().

                                           : int
     {
         return $this->time_format;
     }

Here is the caller graph for this function:

◆ getDefaultTimeZone()

ilCalendarSettings::getDefaultTimeZone ( )

Definition at line 215 of file class.ilCalendarSettings.php.

References $timezone.

Referenced by save().

                                         : string
     {
         return $this->timezone;
     }

Here is the caller graph for this function:

◆ getDefaultWeekStart()

ilCalendarSettings::getDefaultWeekStart ( )

Definition at line 185 of file class.ilCalendarSettings.php.

References $week_start.

Referenced by save().

                                          : int
     {
         return $this->week_start;
     }

Here is the caller graph for this function:

◆ getShowWeeks()

ilCalendarSettings::getShowWeeks ( )

Definition at line 401 of file class.ilCalendarSettings.php.

References $show_weeks.

Referenced by save().

                                   : bool
     {
         return $this->show_weeks;
     }

Here is the caller graph for this function:

◆ getSynchronisationCacheMinutes()

ilCalendarSettings::getSynchronisationCacheMinutes ( )

Definition at line 290 of file class.ilCalendarSettings.php.

References $sync_cache_minutes.

Referenced by save().

                                                     : int
     {
         return $this->sync_cache_minutes;
     }

Here is the caller graph for this function:

◆ getWebCalSyncHours()

ilCalendarSettings::getWebCalSyncHours ( )

Definition at line 391 of file class.ilCalendarSettings.php.

References $webcal_sync_hours.

Referenced by save().

                                         : int
     {
         return $this->webcal_sync_hours;
     }

Here is the caller graph for this function:

◆ initStorage()

ilCalendarSettings::initStorage ( )

private

Definition at line 513 of file class.ilCalendarSettings.php.

Referenced by __construct().

     {
         $this->storage = new ilSetting('calendar');
     }

Here is the caller graph for this function:

◆ isBatchFileDownloadsEnabled()

ilCalendarSettings::isBatchFileDownloadsEnabled ( )

Definition at line 411 of file class.ilCalendarSettings.php.

References $batch_file_downloads.

Referenced by save().

                                                  : bool
     {
         return $this->batch_file_downloads;
     }

Here is the caller graph for this function:

◆ isCacheUsed()

ilCalendarSettings::isCacheUsed ( )

Definition at line 155 of file class.ilCalendarSettings.php.

References $cache_enabled.

Referenced by save().

                                  : bool
     {
         return $this->cache_enabled;
     }

Here is the caller graph for this function:

◆ isCGRegistrationEnabled()

ilCalendarSettings::isCGRegistrationEnabled ( )

Definition at line 320 of file class.ilCalendarSettings.php.

References $cg_registration.

Referenced by save().

                                              : bool
     {
         return $this->cg_registration;
     }

Here is the caller graph for this function:

◆ isCourseCalendarEnabled()

ilCalendarSettings::isCourseCalendarEnabled ( )

Definition at line 330 of file class.ilCalendarSettings.php.

References $course_cal_enabled.

Referenced by save().

                                              : bool
     {
         return $this->course_cal_enabled;
     }

Here is the caller graph for this function:

◆ isCourseCalendarVisible()

ilCalendarSettings::isCourseCalendarVisible ( )

Definition at line 335 of file class.ilCalendarSettings.php.

References $course_cal_visible.

Referenced by isObjectCalendarVisible(), and save().

                                              : bool
     {
         return $this->course_cal_visible;
     }

Here is the caller graph for this function:

◆ isEnabled()

ilCalendarSettings::isEnabled ( )

Definition at line 175 of file class.ilCalendarSettings.php.

References $enabled.

Referenced by lookupCalendarActivated(), and save().

                                : bool
     {
         return $this->enabled;
     }

Here is the caller graph for this function:

◆ isGroupCalendarEnabled()

ilCalendarSettings::isGroupCalendarEnabled ( )

Definition at line 361 of file class.ilCalendarSettings.php.

References $group_cal_enabled.

Referenced by save().

                                             : bool
     {
         return $this->group_cal_enabled;
     }

Here is the caller graph for this function:

◆ isGroupCalendarVisible()

ilCalendarSettings::isGroupCalendarVisible ( )

Definition at line 366 of file class.ilCalendarSettings.php.

References $group_cal_visible.

Referenced by isObjectCalendarVisible(), and save().

                                             : bool
     {
         return $this->group_cal_visible;
     }

Here is the caller graph for this function:

◆ isNotificationEnabled()

ilCalendarSettings::isNotificationEnabled ( )

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

References $notification.

Referenced by save().

                                            : bool
     {
         return $this->notification;
     }

Here is the caller graph for this function:

◆ isObjectCalendarVisible()

ilCalendarSettings::isObjectCalendarVisible ( string $type )

Definition at line 345 of file class.ilCalendarSettings.php.

References isCourseCalendarVisible(), and isGroupCalendarVisible().

                                                          : bool
     {
         switch ($type) {
             case 'crs':
                 return $this->isCourseCalendarVisible();
             case 'grp':
                 return $this->isGroupCalendarVisible();
         }
         return false;
     }

Here is the call graph for this function:

◆ isSynchronisationCacheEnabled()

ilCalendarSettings::isSynchronisationCacheEnabled ( )

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

References $sync_cache_enabled.

Referenced by save().

                                                    : bool
     {
         return $this->sync_cache_enabled;
     }

Here is the caller graph for this function:

◆ isUserNotificationEnabled()

ilCalendarSettings::isUserNotificationEnabled ( )

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

References $notification_user.

Referenced by save().

                                                : bool
     {
         return $this->notification_user;
     }

Here is the caller graph for this function:

◆ isWebCalSyncEnabled()

ilCalendarSettings::isWebCalSyncEnabled ( )

Definition at line 381 of file class.ilCalendarSettings.php.

References $webcal_sync.

Referenced by save().

                                          : bool
     {
         return $this->webcal_sync;
     }

Here is the caller graph for this function:

◆ lookupCalendarActivated()

static ilCalendarSettings::lookupCalendarActivated ( int $a_obj_id )

static

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

References _getInstance(), ilContainer\_lookupContainerSetting(), ilObject\_lookupType(), and isEnabled().

Referenced by ilObjectServiceSettingsGUI\initServiceSettingsForm().

                                                                  : bool
     {
         if (!ilCalendarSettings::_getInstance()->isEnabled()) {
             return false;
         }
         $type = ilObject::_lookupType($a_obj_id);
         // lookup global setting
         $gl_activated = false;
         switch ($type) {
             case 'crs':
                 $gl_activated = ilCalendarSettings::_getInstance()->isCourseCalendarEnabled();
                 break;
 
             case 'grp':
                 $gl_activated = ilCalendarSettings::_getInstance()->isGroupCalendarEnabled();
                 break;
 
             default:
                 return false;
         }
         // look individual object setting
         return (bool) ilContainer::_lookupContainerSetting(
             $a_obj_id,
             'cont_activation_calendar',
             (string) $gl_activated
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookupCalendarContentPresentationEnabled()

static ilCalendarSettings::lookupCalendarContentPresentationEnabled ( int $obj_id )

static

Definition at line 107 of file class.ilCalendarSettings.php.

References ilContainer\_lookupContainerSetting(), and ilObject\_lookupType().

Referenced by ilObjectServiceSettingsGUI\initServiceSettingsForm(), and ilColumnGUI\isGloballyActivated().

                                                                                 : bool
     {
         if (!self::lookupCalendarActivated($obj_id)) {
             return false;
         }
         $settings = self::_getInstance();
         $type = ilObject::_lookupType($obj_id);
         $default = $settings->isObjectCalendarVisible($type);
         return (bool) ilContainer::_lookupContainerSetting(
             $obj_id,
             'cont_show_calendar',
             (string) $default
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilCalendarSettings::read ( )

private

Definition at line 445 of file class.ilCalendarSettings.php.

References ilTimeZone\_getDefaultTimeZone(), enableBatchFileDownloads(), enableCGRegistration(), enableConsultationHours(), enableCourseCalendar(), enableGroupCalendar(), enableNotification(), enableSynchronisationCache(), enableUserNotification(), enableWebCalSync(), setCacheMinutes(), setCourseCalendarVisible(), setDefaultCal(), setDefaultDateFormat(), setDefaultDayEnd(), setDefaultDayStart(), setDefaultPeriod(), setDefaultTimeFormat(), setDefaultTimeZone(), setDefaultWeekStart(), setEnabled(), setGroupCalendarVisible(), setShowWeeks(), setSynchronisationCacheMinutes(), setWebCalSyncHours(), and useCache().

Referenced by __construct().

     {
         $this->setEnabled((bool) $this->storage->get('enabled'));
         $this->setDefaultTimeZone($this->storage->get('default_timezone', ilTimeZone::_getDefaultTimeZone()));
         $this->setDefaultWeekStart((int) $this->storage->get('default_week_start', (string) self::WEEK_START_MONDAY));
         $this->setDefaultDateFormat((int) $this->storage->get('default_date_format', (string) self::DATE_FORMAT_DMY));
         $this->setDefaultTimeFormat((int) $this->storage->get('default_time_format', (string) self::TIME_FORMAT_24));
         $this->setDefaultDayStart((int) $this->storage->get('default_day_start', (string) self::DEFAULT_DAY_START));
         $this->setDefaultDayEnd((int) $this->storage->get('default_day_end', (string) self::DEFAULT_DAY_END));
         $this->useCache((bool) $this->storage->get('cache_enabled', (string) $this->cache_enabled));
         $this->setCacheMinutes((int) $this->storage->get('cache_minutes', (string) self::DEFAULT_CACHE_MINUTES));
         $this->enableSynchronisationCache((bool) $this->storage->get(
             'sync_cache_enabled',
             (string) $this->isSynchronisationCacheEnabled()
         ));
         $this->setSynchronisationCacheMinutes((int) $this->storage->get(
             'sync_cache_minutes',
             (string) self::DEFAULT_SYNC_CACHE_MINUTES
         ));
         $this->enableNotification((bool) $this->storage->get('notification', (string) $this->isNotificationEnabled()));
         $this->enableConsultationHours((bool) $this->storage->get(
             'consultation_hours',
             (string) $this->areConsultationHoursEnabled()
         ));
         $this->enableCGRegistration((bool) $this->storage->get(
             'cg_registration',
             (string) $this->isCGRegistrationEnabled()
         ));
         $this->enableCourseCalendar((bool) $this->storage->get(
             'course_cal',
             (string) $this->isCourseCalendarEnabled()
         ));
         $this->setCourseCalendarVisible((bool) $this->storage->get(
             'course_cal_visible',
             (string) $this->isCourseCalendarVisible()
         ));
         $this->enableGroupCalendar((bool) $this->storage->get('group_cal', (string) $this->isGroupCalendarEnabled()));
         $this->setGroupCalendarVisible((bool) $this->storage->get(
             'group_cal_visible',
             (string) $this->isGroupCalendarVisible()
         ));
         $this->enableUserNotification((bool) $this->storage->get(
             'notification_user',
             (string) $this->isUserNotificationEnabled()
         ));
         $this->enableWebCalSync((bool) $this->storage->get('webcal_sync', (string) $this->isWebCalSyncEnabled()));
         $this->setWebCalSyncHours((int) $this->storage->get('webcal_sync_hours', (string) $this->getWebCalSyncHours()));
         $this->setShowWeeks((bool) $this->storage->get('show_weeks', (string) $this->getShowWeeks()));
         $this->enableBatchFileDownloads((bool) $this->storage->get(
             'batch_files',
             (string) $this->isBatchFileDownloadsEnabled()
         ));
         $this->setDefaultCal((int) $this->storage->get('default_calendar_view', (string) $this->getDefaultCal()));
         $this->setDefaultPeriod((int) $this->storage->get('default_period', (string) $this->getDefaultPeriod()));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readCalendarSettingsId()

ilCalendarSettings::readCalendarSettingsId ( )

private

Definition at line 501 of file class.ilCalendarSettings.php.

References ILIAS\Repository\int().

Referenced by __construct().

                                              : void
     {
         $query = "SELECT ref_id FROM object_reference obr " .
             "JOIN object_data obd ON obd.obj_id = obr.obj_id " .
             "WHERE type = 'cals'";
 
         $set = $this->db->query($query);
         $row = $this->db->fetchAssoc($set);
 
         $this->cal_settings_id = (int) $row["ref_id"];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilCalendarSettings::save ( )

Definition at line 416 of file class.ilCalendarSettings.php.

References areConsultationHoursEnabled(), getCacheMinutes(), getDefaultCal(), getDefaultDateFormat(), getDefaultDayEnd(), getDefaultDayStart(), getDefaultPeriod(), getDefaultTimeFormat(), getDefaultTimeZone(), getDefaultWeekStart(), getShowWeeks(), getSynchronisationCacheMinutes(), getWebCalSyncHours(), isBatchFileDownloadsEnabled(), isCacheUsed(), isCGRegistrationEnabled(), isCourseCalendarEnabled(), isCourseCalendarVisible(), isEnabled(), isGroupCalendarEnabled(), isGroupCalendarVisible(), isNotificationEnabled(), isSynchronisationCacheEnabled(), isUserNotificationEnabled(), and isWebCalSyncEnabled().

     {
         $this->storage->set('enabled', (string) (int) $this->isEnabled());
         $this->storage->set('default_timezone', $this->getDefaultTimeZone());
         $this->storage->set('default_week_start', (string) $this->getDefaultWeekStart());
         $this->storage->set('default_date_format', (string) $this->getDefaultDateFormat());
         $this->storage->set('default_time_format', (string) $this->getDefaultTimeFormat());
         $this->storage->set('default_day_start', (string) $this->getDefaultDayStart());
         $this->storage->set('default_day_end', (string) $this->getDefaultDayEnd());
         $this->storage->set('cache_minutes', (string) $this->getCacheMinutes());
         $this->storage->set('sync_cache_enabled', (string) (int) $this->isSynchronisationCacheEnabled());
         $this->storage->set('sync_cache_minutes', (string) $this->getSynchronisationCacheMinutes());
         $this->storage->set('cache_enabled', (string) (int) $this->isCacheUsed());
         $this->storage->set('notification', (string) (int) $this->isNotificationEnabled());
         $this->storage->set('consultation_hours', (string) (int) $this->areConsultationHoursEnabled());
         $this->storage->set('cg_registration', (string) (int) $this->isCGRegistrationEnabled());
         $this->storage->set('course_cal', (string) (int) $this->isCourseCalendarEnabled());
         $this->storage->set('course_cal_visible', (string) (int) $this->isCourseCalendarVisible());
         $this->storage->set('group_cal', (string) (int) $this->isGroupCalendarEnabled());
         $this->storage->set('group_cal_visible', (string) (int) $this->isGroupCalendarVisible());
         $this->storage->set('notification_user', (string) (int) $this->isUserNotificationEnabled());
         $this->storage->set('webcal_sync', (string) (int) $this->isWebCalSyncEnabled());
         $this->storage->set('webcal_sync_hours', (string) $this->getWebCalSyncHours());
         $this->storage->set('show_weeks', (string) (int) $this->getShowWeeks());
         $this->storage->set('batch_files', (string) (int) $this->isBatchFileDownloadsEnabled());
         $this->storage->set('default_calendar_view', (string) $this->getDefaultCal());
         $this->storage->set('default_period', (string) $this->getDefaultPeriod());
     }

Here is the call graph for this function:

◆ setCacheMinutes()

ilCalendarSettings::setCacheMinutes ( int $a_min )

Definition at line 160 of file class.ilCalendarSettings.php.

Referenced by read().

                                                : void
     {
         $this->cache_minutes = $a_min;
     }

Here is the caller graph for this function:

◆ setCourseCalendarVisible()

ilCalendarSettings::setCourseCalendarVisible ( bool $status )

Definition at line 340 of file class.ilCalendarSettings.php.

Referenced by read().

                                                           : void
     {
         $this->course_cal_visible = $status;
     }

Here is the caller graph for this function:

◆ setDefaultCal()

ilCalendarSettings::setDefaultCal ( int $default_cal )

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

References $default_cal.

Referenced by read().

                                                    : void
     {
         $this->default_cal = $default_cal;
     }

Here is the caller graph for this function:

◆ setDefaultDateFormat()

ilCalendarSettings::setDefaultDateFormat ( int $a_format )

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

Referenced by read().

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

Here is the caller graph for this function:

◆ setDefaultDayEnd()

ilCalendarSettings::setDefaultDayEnd ( int $a_end )

Definition at line 255 of file class.ilCalendarSettings.php.

Referenced by read().

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

Here is the caller graph for this function:

◆ setDefaultDayStart()

ilCalendarSettings::setDefaultDayStart ( int $a_start )

Definition at line 245 of file class.ilCalendarSettings.php.

Referenced by read().

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

Here is the caller graph for this function:

◆ setDefaultPeriod()

ilCalendarSettings::setDefaultPeriod ( int $default_period )

Definition at line 205 of file class.ilCalendarSettings.php.

References $default_period.

Referenced by read().

                                                          : void
     {
         $this->default_period = $default_period;
     }

Here is the caller graph for this function:

◆ setDefaultTimeFormat()

ilCalendarSettings::setDefaultTimeFormat ( int $a_format )

Definition at line 230 of file class.ilCalendarSettings.php.

Referenced by read().

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

Here is the caller graph for this function:

◆ setDefaultTimeZone()

ilCalendarSettings::setDefaultTimeZone ( string $a_zone )

Definition at line 210 of file class.ilCalendarSettings.php.

Referenced by read().

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

Here is the caller graph for this function:

◆ setDefaultWeekStart()

ilCalendarSettings::setDefaultWeekStart ( int $a_start )

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

Referenced by read().

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

Here is the caller graph for this function:

◆ setEnabled()

ilCalendarSettings::setEnabled ( bool $a_enabled )

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

Referenced by read().

                                                : void
     {
         $this->enabled = $a_enabled;
     }

Here is the caller graph for this function:

◆ setGroupCalendarVisible()

ilCalendarSettings::setGroupCalendarVisible ( bool $status )

Definition at line 371 of file class.ilCalendarSettings.php.

Referenced by read().

                                                          : void
     {
         $this->group_cal_visible = $status;
     }

Here is the caller graph for this function:

◆ setShowWeeks()

ilCalendarSettings::setShowWeeks ( bool $a_val )

Definition at line 396 of file class.ilCalendarSettings.php.

Referenced by read().

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

Here is the caller graph for this function:

◆ setSynchronisationCacheMinutes()

ilCalendarSettings::setSynchronisationCacheMinutes ( int $a_min )

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

Referenced by read().

                                                               : void
     {
         $this->sync_cache_minutes = $a_min;
     }

Here is the caller graph for this function:

◆ setWebCalSyncHours()

ilCalendarSettings::setWebCalSyncHours ( int $a_hours )

Definition at line 386 of file class.ilCalendarSettings.php.

Referenced by read().

                                                     : void
     {
         $this->webcal_sync_hours = $a_hours;
     }

Here is the caller graph for this function:

◆ useCache()

ilCalendarSettings::useCache ( bool $a_status )

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

Referenced by read().

                                             : void
     {
         $this->cache_enabled = $a_status;
     }

Here is the caller graph for this function:

Field Documentation

◆ $batch_file_downloads

bool ilCalendarSettings::$batch_file_downloads = false

private

Definition at line 87 of file class.ilCalendarSettings.php.

Referenced by isBatchFileDownloadsEnabled().

◆ $cache_enabled

bool ilCalendarSettings::$cache_enabled = true

private

Definition at line 73 of file class.ilCalendarSettings.php.

Referenced by isCacheUsed().

◆ $cache_minutes

int ilCalendarSettings::$cache_minutes = 1

private

Definition at line 74 of file class.ilCalendarSettings.php.

Referenced by getCacheMinutes().

◆ $cal_settings_id

int ilCalendarSettings::$cal_settings_id = 0

private

Definition at line 68 of file class.ilCalendarSettings.php.

Referenced by getCalendarSettingsId().

◆ $cg_registration

bool ilCalendarSettings::$cg_registration = false

private

Definition at line 79 of file class.ilCalendarSettings.php.

Referenced by isCGRegistrationEnabled().

◆ $consultation_hours

bool ilCalendarSettings::$consultation_hours = false

private

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

Referenced by areConsultationHoursEnabled().

◆ $course_cal_enabled

bool ilCalendarSettings::$course_cal_enabled = true

private

Definition at line 80 of file class.ilCalendarSettings.php.

Referenced by isCourseCalendarEnabled().

◆ $course_cal_visible

bool ilCalendarSettings::$course_cal_visible = true

private

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

Referenced by isCourseCalendarVisible().

◆ $date_format

int ilCalendarSettings::$date_format = 0

private

Definition at line 70 of file class.ilCalendarSettings.php.

Referenced by getDefaultDateFormat().

◆ $day_end

int ilCalendarSettings::$day_end = self::DEFAULT_DAY_END

private

Definition at line 66 of file class.ilCalendarSettings.php.

Referenced by getDefaultDayEnd().

◆ $day_start

int ilCalendarSettings::$day_start = self::DEFAULT_DAY_START

private

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

Referenced by getDefaultDayStart().

◆ $db

ilDBInterface ilCalendarSettings::$db

protected

Definition at line 59 of file class.ilCalendarSettings.php.

◆ $default_cal

int ilCalendarSettings::$default_cal = self::DEFAULT_CAL_LIST

private

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

Referenced by getDefaultCal(), and setDefaultCal().

◆ $default_period

int ilCalendarSettings::$default_period = 2

private

Definition at line 72 of file class.ilCalendarSettings.php.

Referenced by getDefaultPeriod(), and setDefaultPeriod().

◆ $enabled

bool ilCalendarSettings::$enabled = false

private

Definition at line 67 of file class.ilCalendarSettings.php.

Referenced by isEnabled().

◆ $group_cal_enabled

bool ilCalendarSettings::$group_cal_enabled = true

private

Definition at line 81 of file class.ilCalendarSettings.php.

Referenced by isGroupCalendarEnabled().

◆ $group_cal_visible

bool ilCalendarSettings::$group_cal_visible = true

private

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

Referenced by isGroupCalendarVisible().

◆ $instance

ilCalendarSettings ilCalendarSettings::$instance = null

staticprivate

Definition at line 57 of file class.ilCalendarSettings.php.

◆ $notification

bool ilCalendarSettings::$notification = false

private

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

Referenced by isNotificationEnabled().

◆ $notification_user

bool ilCalendarSettings::$notification_user = false

private

Definition at line 78 of file class.ilCalendarSettings.php.

Referenced by isUserNotificationEnabled().

◆ $show_weeks

bool ilCalendarSettings::$show_weeks = false

private

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

Referenced by getShowWeeks().

◆ $storage

ilSetting ilCalendarSettings::$storage

protected

Definition at line 60 of file class.ilCalendarSettings.php.

◆ $sync_cache_enabled

bool ilCalendarSettings::$sync_cache_enabled = true

private

Definition at line 75 of file class.ilCalendarSettings.php.

Referenced by isSynchronisationCacheEnabled().

◆ $sync_cache_minutes

int ilCalendarSettings::$sync_cache_minutes = 10

private

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

Referenced by getSynchronisationCacheMinutes().

◆ $time_format

int ilCalendarSettings::$time_format = self::TIME_FORMAT_12

private

Definition at line 63 of file class.ilCalendarSettings.php.

Referenced by getDefaultTimeFormat().

◆ $timezone

string ilCalendarSettings::$timezone = ilTimeZone::UTC

private

Definition at line 62 of file class.ilCalendarSettings.php.

Referenced by getDefaultTimeZone().

◆ $webcal_sync

bool ilCalendarSettings::$webcal_sync = false

private

Definition at line 84 of file class.ilCalendarSettings.php.

Referenced by isWebCalSyncEnabled().

◆ $webcal_sync_hours

int ilCalendarSettings::$webcal_sync_hours = 2

private

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

Referenced by getWebCalSyncHours().

◆ $week_start

int ilCalendarSettings::$week_start = self::WEEK_START_SUNDAY

private

Definition at line 64 of file class.ilCalendarSettings.php.

Referenced by getDefaultWeekStart().

◆ DATE_FORMAT_DMY

const ilCalendarSettings::DATE_FORMAT_DMY = 1

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

Referenced by ilObjUser\getDateFormat(), ilObjCalendarSettingsGUI\initFormSettings(), ilPersonalSettingsGUI\initGeneralSettingsForm(), ilCalendarUserSettingsGUI\initSettingsForm(), and ilCalendarUserSettings\translateDateFormatToId().

◆ DATE_FORMAT_MDY

const ilCalendarSettings::DATE_FORMAT_MDY = 3

Definition at line 42 of file class.ilCalendarSettings.php.

Referenced by ilObjUser\getDateFormat(), ilObjCalendarSettingsGUI\initFormSettings(), ilPersonalSettingsGUI\initGeneralSettingsForm(), ilCalendarUserSettingsGUI\initSettingsForm(), and ilCalendarUserSettings\translateDateFormatToId().

◆ DATE_FORMAT_UNDEFINED

const ilCalendarSettings::DATE_FORMAT_UNDEFINED = 0

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

◆ DATE_FORMAT_YMD

const ilCalendarSettings::DATE_FORMAT_YMD = 2

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

Referenced by ilObjUser\getDateFormat(), ilObjCalendarSettingsGUI\initFormSettings(), ilPersonalSettingsGUI\initGeneralSettingsForm(), ilCalendarUserSettingsGUI\initSettingsForm(), and ilCalendarUserSettings\translateDateFormatToId().

◆ DEFAULT_CACHE_MINUTES

const ilCalendarSettings::DEFAULT_CACHE_MINUTES = 0

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

◆ DEFAULT_CAL_DAY

const ilCalendarSettings::DEFAULT_CAL_DAY = 1

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

Referenced by ilUserStartingPointGUI\getCalenderSubInputs(), ilObjCalendarSettingsGUI\initFormSettings(), and ilCalendarPresentationGUI\readLastClass().

◆ DEFAULT_CAL_LIST

const ilCalendarSettings::DEFAULT_CAL_LIST = 4

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

Referenced by ilUserStartingPointGUI\getCalenderSubInputs(), ilObjCalendarSettingsGUI\initFormSettings(), and ilCalendarPresentationGUI\readLastClass().

◆ DEFAULT_CAL_MONTH

const ilCalendarSettings::DEFAULT_CAL_MONTH = 3

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

Referenced by ilUserStartingPointGUI\getCalenderSubInputs(), ilObjCalendarSettingsGUI\initFormSettings(), and ilCalendarPresentationGUI\readLastClass().

◆ DEFAULT_CAL_WEEK

const ilCalendarSettings::DEFAULT_CAL_WEEK = 2

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

Referenced by ilUserStartingPointGUI\getCalenderSubInputs(), ilObjCalendarSettingsGUI\initFormSettings(), and ilCalendarPresentationGUI\readLastClass().

◆ DEFAULT_DAY_END

const ilCalendarSettings::DEFAULT_DAY_END = 19

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

◆ DEFAULT_DAY_START

const ilCalendarSettings::DEFAULT_DAY_START = 8

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

◆ DEFAULT_SHOW_WEEKS

const ilCalendarSettings::DEFAULT_SHOW_WEEKS = true

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

◆ DEFAULT_SYNC_CACHE_MINUTES

const ilCalendarSettings::DEFAULT_SYNC_CACHE_MINUTES = 10

Definition at line 53 of file class.ilCalendarSettings.php.

◆ TIME_FORMAT_12

const ilCalendarSettings::TIME_FORMAT_12 = 2

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

Referenced by ilSessionReminderCheck\__construct(), ILIAS\UI\Implementation\Component\Input\Container\Form\FormAdapterGUI\dateTime(), ILIAS\UI\Implementation\Component\Input\Container\Form\FormAdapterGUI\dateTimeDuration(), ilDatePresentation\formatDate(), ilDatePresentation\formatPeriod(), ilCalendarViewGUI\getAppointmentShyButton(), ilCalendarWeekGUI\getAppointmentTimeString(), ILIAS\Mail\Attachments\MailAttachmentTableGUI\getColumnDefinition(), ILIAS\Mail\Folder\MailFolderTableUI\getColumnDefinition(), ILIAS\Chatroom\Bans\BannedUsersTable\getColumns(), ILIAS\Export\ExportHandler\Table\Handler\getColumns(), ILIAS\Calendar\ConsultationHours\BookingTableGUI\getColumns(), ilCalendarUtil\getHourSelection(), ilIndividualAssessmentDateFormatter\getUserDateFormat(), ILIAS\Cache\Services\SubObjectModes\DataTable\Supplier\initColumn(), ilObjCalendarSettingsGUI\initFormSettings(), ilPersonalSettingsGUI\initGeneralSettingsForm(), ilCalendarUserSettingsGUI\initSettingsForm(), ilCalendarWeekGUI\parseHourInfo(), ilCalendarDayGUI\parseInfoIntoRaster(), ilCalendarDayGUI\showAppointment(), ilCalendarMonthGUI\showEvents(), and ILIAS\Chatroom\BuildChat\timeFormat().

◆ TIME_FORMAT_24

const ilCalendarSettings::TIME_FORMAT_24 = 1

Definition at line 49 of file class.ilCalendarSettings.php.

Referenced by ilSessionReminderCheck\__construct(), ILIAS\BookingManager\BookingProcess\WeekGUI\__construct(), ILIAS\AccessControl\Log\Table\buildUserDateTimeFormat(), ILIAS\Test\Logging\TestLogViewer\buildUserDateTimeFormat(), ilDatePresentation\formatDate(), ilDatePresentation\formatPeriod(), ilCalendarViewGUI\getAppointmentShyButton(), ilCalendarWeekGUI\getAppointmentTimeString(), ilObjUser\getDateTimeFormat(), ilCalendarUtil\getHourSelection(), ilIndividualAssessmentDateFormatter\getUserDateFormat(), ilCalendarUtil\getUserDateFormat(), ilObjCalendarSettingsGUI\initFormSettings(), ilPersonalSettingsGUI\initGeneralSettingsForm(), ilCalendarUserSettingsGUI\initSettingsForm(), ilLegacyFormElementsUtil\makeTimeSelect(), ilCalendarWeekGUI\parseHourInfo(), ilCalendarDayGUI\parseInfoIntoRaster(), ilChatroomHistoryGUI\renderDateTimeInformation(), ilCalendarDayGUI\showAppointment(), and ilCalendarMonthGUI\showEvents().

◆ WEEK_START_MONDAY

const ilCalendarSettings::WEEK_START_MONDAY = 1

Definition at line 33 of file class.ilCalendarSettings.php.

Referenced by ilCalendarSchedule\initPeriod(), and ilCalendarRecurrence\toICal().

◆ WEEK_START_SUNDAY

const ilCalendarSettings::WEEK_START_SUNDAY = 0

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

Referenced by ilCalendarSchedule\initPeriod().

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

components/ILIAS/Calendar/classes/class.ilCalendarSettings.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getInstance()

◆ areConsultationHoursEnabled()

◆ enableBatchFileDownloads()

◆ enableCGRegistration()

◆ enableConsultationHours()

◆ enableCourseCalendar()

◆ enableGroupCalendar()

◆ enableNotification()

◆ enableSynchronisationCache()

◆ enableUserNotification()

◆ enableWebCalSync()

◆ getCacheMinutes()

◆ getCalendarSettingsId()

◆ getDefaultCal()

◆ getDefaultDateFormat()

◆ getDefaultDayEnd()

◆ getDefaultDayStart()

◆ getDefaultPeriod()

◆ getDefaultTimeFormat()

◆ getDefaultTimeZone()

◆ getDefaultWeekStart()

◆ getShowWeeks()

◆ getSynchronisationCacheMinutes()

◆ getWebCalSyncHours()

◆ initStorage()

◆ isBatchFileDownloadsEnabled()

◆ isCacheUsed()

◆ isCGRegistrationEnabled()

◆ isCourseCalendarEnabled()

◆ isCourseCalendarVisible()

◆ isEnabled()

◆ isGroupCalendarEnabled()

◆ isGroupCalendarVisible()

◆ isNotificationEnabled()

◆ isObjectCalendarVisible()

◆ isSynchronisationCacheEnabled()

◆ isUserNotificationEnabled()

◆ isWebCalSyncEnabled()

◆ lookupCalendarActivated()

◆ lookupCalendarContentPresentationEnabled()

◆ read()

◆ readCalendarSettingsId()

◆ save()

◆ setCacheMinutes()

◆ setCourseCalendarVisible()

◆ setDefaultCal()

◆ setDefaultDateFormat()

◆ setDefaultDayEnd()

◆ setDefaultDayStart()

◆ setDefaultPeriod()

◆ setDefaultTimeFormat()

◆ setDefaultTimeZone()

◆ setDefaultWeekStart()

◆ setEnabled()

◆ setGroupCalendarVisible()

◆ setShowWeeks()

◆ setSynchronisationCacheMinutes()

◆ setWebCalSyncHours()

◆ useCache()

Field Documentation

◆ $batch_file_downloads

◆ $cache_enabled

◆ $cache_minutes

◆ $cal_settings_id

◆ $cg_registration

◆ $consultation_hours

◆ $course_cal_enabled

◆ $course_cal_visible

◆ $date_format