ilCalendarSettings Class Reference

Stores all calendar relevant settings. More...

Collaboration diagram for ilCalendarSettings:

Public Member Functions
	useCache ($a_status)
	Enable cache. More...
	isCacheUsed ()
	Check if cache is used. More...
	setCacheMinutes ($a_min)
	Set time of cache storage. More...
	getCacheMinutes ()
	Get cache minutes. More...
	setEnabled ($a_enabled)
	set enabled More...
	isEnabled ()
	is calendar enabled More...
	setDefaultWeekStart ($a_start)
	set week start More...
	getDefaultWeekStart ()
	get default week start More...
	getDefaultCal ()
	setDefaultCal (int $default_cal)
	getDefaultPeriod ()
	setDefaultPeriod (int $default_period)
	setDefaultTimeZone ($a_zone)
	set default timezone More...
	getDefaultTimeZone ()
	get derfault time zone More...
	setDefaultDateFormat ($a_format)
	set default date format More...
	getDefaultDateFormat ()
	get default date format More...
	setDefaultTimeFormat ($a_format)
	set default time format More...
	getDefaultTimeFormat ()
	get default time format More...
	getDefaultDayStart ()
	Get default end of day. More...
	setDefaultDayStart ($a_start)
	Set default start of day. More...
	getDefaultDayEnd ()
	Get default end of day. More...
	setDefaultDayEnd ($a_end)
	set default end of day More...
	areConsultationHoursEnabled ()
	Check if consultation hours are enabled. More...
	enableConsultationHours ($a_status)
	En/Disable consultation hours. More...
	getCalendarSettingsId ()
	Get calendar settings id (Used for permission checks) More...
	setEnableGroupMilestones ($a_enablegroupmilestones)
	Set Enable milestone planning feature for groups. More...
	getEnableGroupMilestones ()
	Get Enable milestone planning feature for groups. More...
	isSynchronisationCacheEnabled ()
	Check if cache is active for calendar synchronisation. More...
	enableSynchronisationCache ($a_status)
	En/Disable synchronisation cache. More...
	setSynchronisationCacheMinutes ($a_min)
	Set synchronisation cache minutes. More...
	getSynchronisationCacheMinutes ()
	get synchronisation cache minutes More...
	isNotificationEnabled ()
	Course group notification enabled. More...
	enableNotification ($a_status)
	Enable course group notification. More...
	isUserNotificationEnabled ()
	enableUserNotification ($a_not)
	enableCGRegistration ($a_status)
	Enable optional registration for courses and groups. More...
	isCGRegistrationEnabled ()
	enableCourseCalendar ($a_stat)
	isCourseCalendarEnabled ()
	isCourseCalendarVisible ()
	setCourseCalendarVisible (bool $status)
	isObjectCalendarVisible (string $type)
	enableGroupCalendar ($a_stat)
	isGroupCalendarEnabled ()
	isGroupCalendarVisible ()
	setGroupCalendarVisible (bool $status)
	enableWebCalSync ($a_stat)
	isWebCalSyncEnabled ()
	setWebCalSyncHours ($a_hours)
	getWebCalSyncHours ()
	setShowWeeks ($a_val)
	Set show weeks. More...
	getShowWeeks ()
	Get show weeks. More...
	enableBatchFileDownloads ($a_stat)
	isBatchFileDownloadsEnabled ()
	save ()
	save More...

Static Public Member Functions
static	_getInstance ()
	get singleton instance More...
static	lookupCalendarContentPresentationEnabled (int $obj_id)
static	lookupCalendarActivated ($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_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

Private Member Functions
	__construct ()
	singleton contructor More...
	read ()
	Read settings. More...
	readCalendarSettingsId ()
	Read ref_id of calendar settings. More...
	initStorage ()
	Init storage class (ilSetting) private. More...

Private Attributes
	$db = null
	$storage = null
	$timezone = null
	$time_format = null
	$week_start = 0
	$day_start = null
	$day_end = null
	$enabled = false
	$cal_settings_id = 0
	$consultation_hours = false
	$default_cal = self::DEFAULT_CAL_LIST
	$default_period = 2
	$cache_enabled = true
	$cache_minutes = 1
	$sync_cache_enabled = true
	$sync_cache_minutes = 10
	$notification = false
	$notification_user = false
	$cg_registration = false
	$course_cal_enabled = true
	$group_cal_enabled = true
	$course_cal_visible = true
	$group_cal_visible = true
	$webcal_sync = false
	$webcal_sync_hours = 2
	$show_weeks = false
	$batch_file_downloads = false

Static Private Attributes
static	$instance = null

Detailed Description

Stores all calendar relevant settings.

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilCalendarSettings::__construct ( )

private

singleton contructor

private

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

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

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $this->db = $ilDB;
        
        $this->initStorage();
        $this->read();
        $this->readCalendarSettingsId();
    }

Here is the call graph for this function:

Member Function Documentation

_getInstance()

static ilCalendarSettings::_getInstance ( )

static

get singleton instance

public

Returns

ilCalendarSettings

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

Referenced by ilCalendarCache\__construct(), ilCalendarAppointmentPresentationGUI\__construct(), ilCalendarUserSettings\__construct(), ilCalendarAppointmentPanelGUI\__construct(), ilCalendarBlockGUI\__construct(), ilCalendarUserSettingsGUI\__construct(), ilCalendarPresentationGUI\__construct(), ilCalendarMonthGUI\addScheduleFilter(), ilCalendarPresentationGUI\addStandardTabs(), ilCalendarViewGUI\addToolbarActions(), ilAppointmentPresentationGroupGUI\collectPropertiesAndActions(), ilAppointmentPresentationCourseGUI\collectPropertiesAndActions(), ilCalendarDayGUI\executeCommand(), ilCalendarPresentationGUI\executeCommand(), ilAppointmentBaseFileHandler\getCatInfo(), ilObjUser\getDateFormat(), ilAppointmentPresentationGUI\getHTML(), ilCalendarAgendaListGUI\getPeriod(), ilUserUtil\getPossibleStartingPoints(), ilUserUtil\getStartingPoint(), ILIAS\Calendar\Provider\CalendarMainBarProvider\getStaticSubItems(), ilObjUser\getTimeFormat(), ilObjUser\getTimeZone(), 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(), ilCalendarCache\storeEntry(), ilCalendarCache\storeUnlimitedEntry(), ilCalendarPresentationGUI\synchroniseExternalCalendars(), ilCalendarAppointmentGUI\update(), ilObjectServiceSettingsGUI\updateServiceSettingsForm(), and ilObjectServiceSettingsGUI\updateToolSettings().

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

Here is the caller graph for this function:

areConsultationHoursEnabled()

ilCalendarSettings::areConsultationHoursEnabled

(

)

Check if consultation hours are enabled.

Returns

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

References $consultation_hours.

Referenced by save().

    {
        return $this->consultation_hours;
    }

Here is the caller graph for this function:

enableBatchFileDownloads()

ilCalendarSettings::enableBatchFileDownloads

(

$a_stat

)

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

Referenced by read().

    {
        $this->batch_file_downloads = $a_stat;
    }

Here is the caller graph for this function:

enableCGRegistration()

ilCalendarSettings::enableCGRegistration

(

$a_status

)

Enable optional registration for courses and groups.

Parameters

bool

$a_status

Returns

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

Referenced by read().

    {
        $this->cg_registration = $a_status;
    }

Here is the caller graph for this function:

enableConsultationHours()

ilCalendarSettings::enableConsultationHours

(

$a_status

)

En/Disable consultation hours.

Returns

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

Referenced by read().

    {
        $this->consultation_hours = $a_status;
    }

Here is the caller graph for this function:

enableCourseCalendar()

ilCalendarSettings::enableCourseCalendar

(

$a_stat

)

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

Referenced by read().

    {
        $this->course_cal_enabled = $a_stat;
    }

Here is the caller graph for this function:

enableGroupCalendar()

ilCalendarSettings::enableGroupCalendar

(

$a_stat

)

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

Referenced by read().

    {
        $this->group_cal_enabled = $a_stat;
    }

Here is the caller graph for this function:

enableNotification()

ilCalendarSettings::enableNotification

(

$a_status

)

Enable course group notification.

Parameters

bool

$a_status

Returns

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

References notification().

Referenced by read().

    {
        $this->notification = $a_status;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

enableSynchronisationCache()

ilCalendarSettings::enableSynchronisationCache

(

$a_status

)

En/Disable synchronisation cache.

Returns

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

Referenced by read().

    {
        $this->sync_cache_enabled = $a_status;
    }

Here is the caller graph for this function:

enableUserNotification()

ilCalendarSettings::enableUserNotification

(

$a_not

)

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

Referenced by read().

    {
        $this->notification_user = $a_not;
    }

Here is the caller graph for this function:

enableWebCalSync()

ilCalendarSettings::enableWebCalSync

(

$a_stat

)

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

Referenced by read().

    {
        $this->webcal_sync = $a_stat;
    }

Here is the caller graph for this function:

getCacheMinutes()

ilCalendarSettings::getCacheMinutes

(

)

Get cache minutes.

Returns

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

References $cache_minutes.

Referenced by save().

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

Here is the caller graph for this function:

getCalendarSettingsId()

ilCalendarSettings::getCalendarSettingsId

(

)

Get calendar settings id (Used for permission checks)

public

Returns

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

References $cal_settings_id.

    {
        return $this->cal_settings_id;
    }

getDefaultCal()

ilCalendarSettings::getDefaultCal

(

)

Returns

int

Definition at line 269 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

(

)

get default date format

public

Returns

int date format

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

Referenced by save().

    {
        return $this->date_format;
    }

Here is the caller graph for this function:

getDefaultDayEnd()

ilCalendarSettings::getDefaultDayEnd

(

)

Get default end of day.

Returns

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

References $day_end.

Referenced by save().

    {
        return $this->day_end;
    }

Here is the caller graph for this function:

getDefaultDayStart()

ilCalendarSettings::getDefaultDayStart

(

)

Get default end of day.

Returns

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

References $day_start.

Referenced by save().

    {
        return $this->day_start;
    }

Here is the caller graph for this function:

getDefaultPeriod()

ilCalendarSettings::getDefaultPeriod

(

)

Returns

int

Definition at line 285 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

(

)

get default time format

public

Returns

int time format

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

References $time_format.

Referenced by save().

    {
        return $this->time_format;
    }

Here is the caller graph for this function:

getDefaultTimeZone()

ilCalendarSettings::getDefaultTimeZone

(

)

get derfault time zone

public

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

References $timezone.

Referenced by save().

    {
        return $this->timezone;
    }

Here is the caller graph for this function:

getDefaultWeekStart()

ilCalendarSettings::getDefaultWeekStart

(

)

get default week start

public

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

References $week_start.

Referenced by save().

    {
        return $this->week_start;
    }

Here is the caller graph for this function:

getEnableGroupMilestones()

ilCalendarSettings::getEnableGroupMilestones

(

)

Get Enable milestone planning feature for groups.

Returns

boolean Enable milestone planning feature for groups

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

Referenced by save().

    {
        return $this->enablegroupmilestones;
    }

Here is the caller graph for this function:

getShowWeeks()

ilCalendarSettings::getShowWeeks

(

)

Get show weeks.

Returns

bool show weeks

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

References $show_weeks.

Referenced by save().

    {
        return $this->show_weeks;
    }

Here is the caller graph for this function:

getSynchronisationCacheMinutes()

ilCalendarSettings::getSynchronisationCacheMinutes

(

)

get synchronisation cache minutes

Returns

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

References $sync_cache_minutes.

Referenced by save().

    {
        return $this->sync_cache_minutes;
    }

Here is the caller graph for this function:

getWebCalSyncHours()

ilCalendarSettings::getWebCalSyncHours

(

)

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

References $webcal_sync_hours.

Referenced by save().

    {
        return $this->webcal_sync_hours;
    }

Here is the caller graph for this function:

initStorage()

ilCalendarSettings::initStorage ( )

private

Init storage class (ilSetting) private.

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

Referenced by __construct().

    {
        include_once('./Services/Administration/classes/class.ilSetting.php');
        $this->storage = new ilSetting('calendar');
    }

Here is the caller graph for this function:

isBatchFileDownloadsEnabled()

ilCalendarSettings::isBatchFileDownloadsEnabled

(

)

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

References $batch_file_downloads.

Referenced by save().

    {
        return $this->batch_file_downloads;
    }

Here is the caller graph for this function:

isCacheUsed()

ilCalendarSettings::isCacheUsed

(

)

Check if cache is used.

Returns

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

References $cache_enabled.

Referenced by save().

    {
        return $this->cache_enabled;
    }

Here is the caller graph for this function:

isCGRegistrationEnabled()

ilCalendarSettings::isCGRegistrationEnabled

(

)

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

References $cg_registration.

Referenced by save().

    {
        return $this->cg_registration;
    }

Here is the caller graph for this function:

isCourseCalendarEnabled()

ilCalendarSettings::isCourseCalendarEnabled

(

)

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

References $course_cal_enabled.

Referenced by save().

    {
        return $this->course_cal_enabled;
    }

Here is the caller graph for this function:

isCourseCalendarVisible()

ilCalendarSettings::isCourseCalendarVisible

(

)

Definition at line 544 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

(

)

is calendar enabled

public

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

References $enabled.

Referenced by lookupCalendarActivated(), and save().

    {
        return (bool) $this->enabled;
    }

Here is the caller graph for this function:

isGroupCalendarEnabled()

ilCalendarSettings::isGroupCalendarEnabled

(

)

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

References $group_cal_enabled.

Referenced by save().

    {
        return $this->group_cal_enabled;
    }

Here is the caller graph for this function:

isGroupCalendarVisible()

ilCalendarSettings::isGroupCalendarVisible

(

)

Definition at line 575 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

(

)

Course group notification enabled.

Returns

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

References $notification.

Referenced by save().

    {
        return (bool) $this->notification;
    }

Here is the caller graph for this function:

isObjectCalendarVisible()

ilCalendarSettings::isObjectCalendarVisible

(

string

$type

)

Definition at line 554 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

(

)

Check if cache is active for calendar synchronisation.

Returns

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

References $sync_cache_enabled.

Referenced by read(), and save().

    {
        return (bool) $this->sync_cache_enabled;
    }

Here is the caller graph for this function:

isUserNotificationEnabled()

ilCalendarSettings::isUserNotificationEnabled

(

)

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

References $notification_user.

Referenced by save().

    {
        return $this->notification_user;
    }

Here is the caller graph for this function:

isWebCalSyncEnabled()

ilCalendarSettings::isWebCalSyncEnabled

(

)

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

References $webcal_sync.

Referenced by save().

    {
        return $this->webcal_sync;
    }

Here is the caller graph for this function:

lookupCalendarActivated()

static ilCalendarSettings::lookupCalendarActivated (   $a_obj_id )

static

Parameters

int

$a_obj_id

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

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

Referenced by ilObjectServiceSettingsGUI\initServiceSettingsForm().

    {
        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
        include_once './Services/Container/classes/class.ilContainer.php';
        return ilContainer::_lookupContainerSetting(
            $a_obj_id,
            'cont_activation_calendar',
            $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

Parameters

int

$obj_id

Returns

bool

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

References $type, 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 ilContainer::_lookupContainerSetting(
            $obj_id,
            'cont_show_calendar', // @todo create ilContainer constant
            $default
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

read()

ilCalendarSettings::read ( )

private

Read settings.

private

Parameters

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

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

Referenced by __construct().

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

Here is the call graph for this function:

Here is the caller graph for this function:

readCalendarSettingsId()

ilCalendarSettings::readCalendarSettingsId ( )

private

Read ref_id of calendar settings.

private

Parameters

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

References $query.

Referenced by __construct().

    {
        $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 = $row["ref_id"];
        return true;
    }

Here is the caller graph for this function:

save()

ilCalendarSettings::save

(

)

save

public

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

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

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

Here is the call graph for this function:

setCacheMinutes()

ilCalendarSettings::setCacheMinutes

(

$a_min

)

Set time of cache storage.

Parameters

int

$a_min

Returns

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

Referenced by read().

    {
        $this->cache_minutes = $a_min;
    }

Here is the caller graph for this function:

setCourseCalendarVisible()

ilCalendarSettings::setCourseCalendarVisible

(

bool

$status

)

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

Referenced by read().

    {
        $this->course_cal_visible = $status;
    }

Here is the caller graph for this function:

setDefaultCal()

ilCalendarSettings::setDefaultCal

(

int

$default_cal

)

Parameters

int

$default_cal

Definition at line 277 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

(

$a_format

)

set default date format

public

Parameters

int	date format

Returns

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

Referenced by read().

    {
        $this->date_format = $a_format;
    }

Here is the caller graph for this function:

setDefaultDayEnd()

ilCalendarSettings::setDefaultDayEnd

(

$a_end

)

set default end of day

Returns

Parameters

object

$a_end

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

Referenced by read().

    {
        $this->day_end = $a_end;
    }

Here is the caller graph for this function:

setDefaultDayStart()

ilCalendarSettings::setDefaultDayStart

(

$a_start

)

Set default start of day.

Returns

Parameters

object

$a_start

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

Referenced by read().

    {
        $this->day_start = $a_start;
    }

Here is the caller graph for this function:

setDefaultPeriod()

ilCalendarSettings::setDefaultPeriod

(

int

$default_period

)

Parameters

int

$default_period

Definition at line 293 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

(

$a_format

)

set default time format

public

Parameters

int	time format

Returns

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

Referenced by read().

    {
        $this->time_format = $a_format;
    }

Here is the caller graph for this function:

setDefaultTimeZone()

ilCalendarSettings::setDefaultTimeZone

(

$a_zone

)

set default timezone

public

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

Referenced by read().

    {
        $this->timezone = $a_zone;
    }

Here is the caller graph for this function:

setDefaultWeekStart()

ilCalendarSettings::setDefaultWeekStart

(

$a_start

)

set week start

public

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

Referenced by read().

    {
        $this->week_start = $a_start;
    }

Here is the caller graph for this function:

setEnabled()

ilCalendarSettings::setEnabled

(

$a_enabled

)

set enabled

public

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

Referenced by read().

    {
        $this->enabled = $a_enabled;
    }

Here is the caller graph for this function:

setEnableGroupMilestones()

ilCalendarSettings::setEnableGroupMilestones

(

$a_enablegroupmilestones

)

Set Enable milestone planning feature for groups.

Parameters

boolean

$a_enablegroupmilestones

Enable milestone planning feature for groups

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

Referenced by read().

    {
        $this->enablegroupmilestones = $a_enablegroupmilestones;
    }

Here is the caller graph for this function:

setGroupCalendarVisible()

ilCalendarSettings::setGroupCalendarVisible

(

bool

$status

)

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

Referenced by read().

    {
        $this->group_cal_visible = $status;
    }

Here is the caller graph for this function:

setShowWeeks()

ilCalendarSettings::setShowWeeks

(

$a_val

)

Set show weeks.

Parameters

bool

$a_val

show weeks

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

Referenced by read().

    {
        $this->show_weeks = $a_val;
    }

Here is the caller graph for this function:

setSynchronisationCacheMinutes()

ilCalendarSettings::setSynchronisationCacheMinutes

(

$a_min

)

Set synchronisation cache minutes.

Parameters

object

$a_min

Returns

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

Referenced by read().

    {
        $this->sync_cache_minutes = $a_min;
    }

Here is the caller graph for this function:

setWebCalSyncHours()

ilCalendarSettings::setWebCalSyncHours

(

$a_hours

)

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

Referenced by read().

    {
        $this->webcal_sync_hours = $a_hours;
    }

Here is the caller graph for this function:

useCache()

ilCalendarSettings::useCache

(

$a_status

)

Enable cache.

Parameters

object

$a_status

Returns

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

Referenced by read().

    {
        $this->cache_enabled = $a_status;
    }

Here is the caller graph for this function:

Field Documentation

$batch_file_downloads

ilCalendarSettings::$batch_file_downloads = false

private

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

Referenced by isBatchFileDownloadsEnabled().

$cache_enabled

ilCalendarSettings::$cache_enabled = true

private

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

Referenced by isCacheUsed(), and read().

$cache_minutes

ilCalendarSettings::$cache_minutes = 1

private

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

Referenced by getCacheMinutes().

$cal_settings_id

ilCalendarSettings::$cal_settings_id = 0

private

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

Referenced by getCalendarSettingsId().

$cg_registration

ilCalendarSettings::$cg_registration = false

private

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

Referenced by isCGRegistrationEnabled().

$consultation_hours

ilCalendarSettings::$consultation_hours = false

private

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

Referenced by areConsultationHoursEnabled().

$course_cal_enabled

ilCalendarSettings::$course_cal_enabled = true

private

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

Referenced by isCourseCalendarEnabled().

$course_cal_visible

ilCalendarSettings::$course_cal_visible = true

private

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

Referenced by isCourseCalendarVisible().

$day_end

ilCalendarSettings::$day_end = null

private

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

Referenced by getDefaultDayEnd().

$day_start

ilCalendarSettings::$day_start = null

private

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

Referenced by getDefaultDayStart().

$db

ilCalendarSettings::$db = null

private

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

$default_cal

ilCalendarSettings::$default_cal = self::DEFAULT_CAL_LIST

private

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

Referenced by getDefaultCal(), and setDefaultCal().

$default_period

ilCalendarSettings::$default_period = 2

private

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

Referenced by getDefaultPeriod(), and setDefaultPeriod().

$enabled

ilCalendarSettings::$enabled = false

private

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

Referenced by isEnabled().

$group_cal_enabled

ilCalendarSettings::$group_cal_enabled = true

private

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

Referenced by isGroupCalendarEnabled().

$group_cal_visible

ilCalendarSettings::$group_cal_visible = true

private

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

Referenced by isGroupCalendarVisible().

$instance

ilCalendarSettings::$instance = null

staticprivate

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

$notification

ilCalendarSettings::$notification = false

private

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

Referenced by isNotificationEnabled().

$notification_user

ilCalendarSettings::$notification_user = false

private

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

Referenced by isUserNotificationEnabled().

$show_weeks

ilCalendarSettings::$show_weeks = false

private

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

Referenced by getShowWeeks().

$storage

ilCalendarSettings::$storage = null

private

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

$sync_cache_enabled

ilCalendarSettings::$sync_cache_enabled = true

private

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

Referenced by isSynchronisationCacheEnabled().

$sync_cache_minutes

ilCalendarSettings::$sync_cache_minutes = 10

private

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

Referenced by getSynchronisationCacheMinutes().

$time_format

ilCalendarSettings::$time_format = null

private

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

Referenced by getDefaultTimeFormat().

$timezone

ilCalendarSettings::$timezone = null

private

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

Referenced by getDefaultTimeZone().

$webcal_sync

ilCalendarSettings::$webcal_sync = false

private

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

Referenced by isWebCalSyncEnabled().

$webcal_sync_hours

ilCalendarSettings::$webcal_sync_hours = 2

private

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

Referenced by getWebCalSyncHours().

$week_start

ilCalendarSettings::$week_start = 0

private

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

Referenced by getDefaultWeekStart().

DATE_FORMAT_DMY

const ilCalendarSettings::DATE_FORMAT_DMY = 1

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

Referenced by ilDclDatetimeRecordRepresentation\formatDate(), ilCalendarUtil\getUserDateFormat(), ilObjCalendarSettingsGUI\initFormSettings(), ilPersonalSettingsGUI\initGeneralSettingsForm(), and ilCalendarUserSettingsGUI\initSettingsForm().

DATE_FORMAT_MDY

const ilCalendarSettings::DATE_FORMAT_MDY = 3

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

Referenced by ilDclDatetimeRecordRepresentation\formatDate(), ilCalendarUtil\getUserDateFormat(), ilObjCalendarSettingsGUI\initFormSettings(), ilPersonalSettingsGUI\initGeneralSettingsForm(), and ilCalendarUserSettingsGUI\initSettingsForm().

DATE_FORMAT_YMD

const ilCalendarSettings::DATE_FORMAT_YMD = 2

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

Referenced by ilDclDatetimeRecordRepresentation\formatDate(), ilCalendarUtil\getUserDateFormat(), ilObjCalendarSettingsGUI\initFormSettings(), ilPersonalSettingsGUI\initGeneralSettingsForm(), and ilCalendarUserSettingsGUI\initSettingsForm().

DEFAULT_CACHE_MINUTES

const ilCalendarSettings::DEFAULT_CACHE_MINUTES = 0

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

DEFAULT_CAL_DAY

const ilCalendarSettings::DEFAULT_CAL_DAY = 1

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

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

DEFAULT_CAL_LIST

const ilCalendarSettings::DEFAULT_CAL_LIST = 4

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

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

DEFAULT_CAL_MONTH

const ilCalendarSettings::DEFAULT_CAL_MONTH = 3

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

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

DEFAULT_CAL_WEEK

const ilCalendarSettings::DEFAULT_CAL_WEEK = 2

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

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

DEFAULT_DAY_END

const ilCalendarSettings::DEFAULT_DAY_END = 19

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

DEFAULT_DAY_START

const ilCalendarSettings::DEFAULT_DAY_START = 8

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

DEFAULT_SHOW_WEEKS

const ilCalendarSettings::DEFAULT_SHOW_WEEKS = true

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

DEFAULT_SYNC_CACHE_MINUTES

const ilCalendarSettings::DEFAULT_SYNC_CACHE_MINUTES = 10

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

TIME_FORMAT_12

const ilCalendarSettings::TIME_FORMAT_12 = 2

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

Referenced by ilBookingProcessGUI\book(), ilDatePresentation\formatDate(), ilDatePresentation\formatPeriod(), ilCalendarWeekGUI\getAppointmentTimeString(), ilCalendarUtil\getHourSelection(), ilObjCalendarSettingsGUI\initFormSettings(), ilPersonalSettingsGUI\initGeneralSettingsForm(), ilCalendarUserSettingsGUI\initSettingsForm(), ilCalendarWeekGUI\parseHourInfo(), ilCalendarDayGUI\parseInfoIntoRaster(), ilCalendarDayGUI\showAppointment(), ilCalendarMonthGUI\showEvents(), and ilChatroomHistoryGUI\showMessages().

TIME_FORMAT_24

const ilCalendarSettings::TIME_FORMAT_24 = 1

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

Referenced by ilBookingProcessGUI\book(), ilDatePresentation\formatDate(), ilDatePresentation\formatPeriod(), ilCalendarWeekGUI\getAppointmentTimeString(), ilCalendarUtil\getHourSelection(), ilCalendarUtil\getUserDateFormat(), ilObjCalendarSettingsGUI\initFormSettings(), ilPersonalSettingsGUI\initGeneralSettingsForm(), ilCalendarUserSettingsGUI\initSettingsForm(), ilUtil\makeTimeSelect(), ilCalendarWeekGUI\parseHourInfo(), ilCalendarDayGUI\parseInfoIntoRaster(), ilCalendarDayGUI\showAppointment(), ilCalendarMonthGUI\showEvents(), and ilChatroomHistoryGUI\showMessages().

WEEK_START_MONDAY

const ilCalendarSettings::WEEK_START_MONDAY = 1

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

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

WEEK_START_SUNDAY

const ilCalendarSettings::WEEK_START_SUNDAY = 0

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

Referenced by ilCalendarSchedule\initPeriod().

---

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

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