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...
	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 ()
	enableGroupCalendar ($a_stat)
	isGroupCalendarEnabled ()
	enableWebCalSync ($a_stat)
	isWebCalSyncEnabled ()
	setWebCalSyncHours ($a_hours)
	getWebCalSyncHours ()
	save ()
	save More...

Static Public Member Functions
static	_getInstance ()
	get singleton instance More...
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	TIME_FORMAT_24 = 1
const	TIME_FORMAT_12 = 2
const	DEFAULT_CACHE_MINUTES = 0
const	DEFAULT_SYNC_CACHE_MINUTES = 10

Private Member Functions
	__construct ()
	singleton contructor More...
	read ()
	Read settings. More...
	readCalendarSettingsId ()
	Read ref_id of calendar settings. More...
	initStorage ()
	Init storage class (ilSetting) @access 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
	$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
	$webcal_sync = false
	$webcal_sync_hours = 2

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

@access private

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

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

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

Here is the call graph for this function:

Member Function Documentation

_getInstance()

static ilCalendarSettings::_getInstance ( )

static

get singleton instance

@access public

Returns

ilCalendarSettings

ilCalendarSettings

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

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

References $instance.

Referenced by ilCalendarUserSettings\__construct(), ilCalendarCache\__construct(), ilCalendarUserSettingsGUI\__construct(), ilCalendarAppointmentPanelGUI\__construct(), ilObjPersonalDesktopSettingsGUI\editSettings(), ilCalendarPresentationGUI\executeCommand(), ilObjUser\getDateFormat(), ilUserUtil\getPossibleStartingPoints(), ilObjUser\getTimeFormat(), ilObjUser\getTimeZone(), ilPortfolioPageConfig\init(), ilObjCalendarSettingsGUI\initCalendarSettings(), ilCalendarAppointmentGUI\initForm(), ilCalendarCategoryGUI\initFormCategory(), ilObjectServiceSettingsGUI\initServiceSettingsForm(), ilColumnGUI\isGloballyActivated(), ilCalendarAuthenticationToken\isIcalExpired(), lookupCalendarActivated(), ilCalendarPresentationGUI\prepareOutput(), ilCalendarCache\readEntry(), ilCalendarCategoryGUI\readPermissions(), ilCalendarCategories\readPublicCalendars(), ilCalendarCategories\readReposCalendars(), ilCalendarCategories\readSelectedCategories(), ilMainMenuGUI\renderDropDown(), ilMainMenuGUI\renderEntry(), ilCalendarAppointmentGUI\save(), ilObjPersonalDesktopSettingsGUI\saveSettings(), ilCalendarDayGUI\show(), ilCalendarMonthGUI\show(), ilCalendarWeekGUI\show(), ilCalendarCache\storeEntry(), ilCalendarCache\storeUnlimitedEntry(), ilCalendarPresentationGUI\synchroniseExternalCalendars(), ilCalendarAppointmentGUI\update(), ilObjectServiceSettingsGUI\updateServiceSettingsForm(), and ilObjectServiceSettingsGUI\updateToolSettings().

Here is the caller graph for this function:

areConsultationHoursEnabled()

ilCalendarSettings::areConsultationHoursEnabled

(

)

Check if consultation hours are enabled.

Returns

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

        {
                return $this->consultation_hours;
        }

References $consultation_hours.

Referenced by save().

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 462 of file class.ilCalendarSettings.php.

        {
                $this->cg_registration = $a_status;
        }

Referenced by read().

Here is the caller graph for this function:

enableConsultationHours()

ilCalendarSettings::enableConsultationHours

(

$a_status

)

En/Disable consultation hours.

Returns

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

        {
                $this->consultation_hours = $a_status;
        }

Referenced by read().

Here is the caller graph for this function:

enableCourseCalendar()

ilCalendarSettings::enableCourseCalendar

(

$a_stat

)

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

        {
                $this->course_cal_enabled = $a_stat;
        }

Referenced by read().

Here is the caller graph for this function:

enableGroupCalendar()

ilCalendarSettings::enableGroupCalendar

(

$a_stat

)

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

        {
                $this->group_cal_enabled = $a_stat;
        }

Referenced by read().

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 442 of file class.ilCalendarSettings.php.

        {
                $this->notification = $a_status;
        }

Referenced by read().

Here is the caller graph for this function:

enableSynchronisationCache()

ilCalendarSettings::enableSynchronisationCache

(

$a_status

)

En/Disable synchronisation cache.

Returns

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

        {
                $this->sync_cache_enabled = $a_status;
        }

Referenced by read().

Here is the caller graph for this function:

enableUserNotification()

ilCalendarSettings::enableUserNotification

(

$a_not

)

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

        {
                $this->notification_user = $a_not;
        }

Referenced by read().

Here is the caller graph for this function:

enableWebCalSync()

ilCalendarSettings::enableWebCalSync

(

$a_stat

)

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

        {
                $this->webcal_sync = $a_stat;
        }

Referenced by read().

Here is the caller graph for this function:

getCacheMinutes()

ilCalendarSettings::getCacheMinutes

(

)

Get cache minutes.

Returns

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

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

References $cache_minutes.

Referenced by save().

Here is the caller graph for this function:

getCalendarSettingsId()

ilCalendarSettings::getCalendarSettingsId

(

)

Get calendar settings id (Used for permission checks)

@access public

Returns

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

        {
                return $this->cal_settings_id;
        }

References $cal_settings_id.

getDefaultDateFormat()

ilCalendarSettings::getDefaultDateFormat

(

)

get default date format

@access public

Returns

int date format

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

        {
                return $this->date_format;
        }

Referenced by save().

Here is the caller graph for this function:

getDefaultDayEnd()

ilCalendarSettings::getDefaultDayEnd

(

)

Get default end of day.

Returns

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

        {
                return $this->day_end;
        }

References $day_end.

Referenced by save().

Here is the caller graph for this function:

getDefaultDayStart()

ilCalendarSettings::getDefaultDayStart

(

)

Get default end of day.

Returns

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

        {
                return $this->day_start;
        }

References $day_start.

Referenced by save().

Here is the caller graph for this function:

getDefaultTimeFormat()

ilCalendarSettings::getDefaultTimeFormat

(

)

get default time format

@access public

Returns

int time format

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

        {
                return $this->time_format;
        }

References $time_format.

Referenced by save().

Here is the caller graph for this function:

getDefaultTimeZone()

ilCalendarSettings::getDefaultTimeZone

(

)

get derfault time zone

@access public

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

        {
                return $this->timezone;
        }

References $timezone.

Referenced by save().

Here is the caller graph for this function:

getDefaultWeekStart()

ilCalendarSettings::getDefaultWeekStart

(

)

get default week start

@access public

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

        {
                return $this->week_start;
        }

References $week_start.

Referenced by save().

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 386 of file class.ilCalendarSettings.php.

        {
                return $this->enablegroupmilestones;
        }

Referenced by save().

Here is the caller graph for this function:

getSynchronisationCacheMinutes()

ilCalendarSettings::getSynchronisationCacheMinutes

(

)

get synchronisation cache minutes

Returns

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

        {
                return $this->sync_cache_minutes;
        }

References $sync_cache_minutes.

Referenced by save().

Here is the caller graph for this function:

getWebCalSyncHours()

ilCalendarSettings::getWebCalSyncHours

(

)

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

        {
                return $this->webcal_sync_hours;
        }

References $webcal_sync_hours.

Referenced by save().

Here is the caller graph for this function:

initStorage()

ilCalendarSettings::initStorage ( )

private

Init storage class (ilSetting) @access private.

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

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

Referenced by __construct().

Here is the caller graph for this function:

isCacheUsed()

ilCalendarSettings::isCacheUsed

(

)

Check if cache is used.

Returns

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

        {
                return $this->cache_enabled;
        }

References $cache_enabled.

Referenced by save().

Here is the caller graph for this function:

isCGRegistrationEnabled()

ilCalendarSettings::isCGRegistrationEnabled

(

)

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

        {
                return $this->cg_registration;
        }

References $cg_registration.

Referenced by save().

Here is the caller graph for this function:

isCourseCalendarEnabled()

ilCalendarSettings::isCourseCalendarEnabled

(

)

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

        {
                return $this->course_cal_enabled;
        }

References $course_cal_enabled.

Referenced by save().

Here is the caller graph for this function:

isEnabled()

ilCalendarSettings::isEnabled

(

)

is calendar enabled

@access public

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

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

References $enabled.

Referenced by lookupCalendarActivated(), and save().

Here is the caller graph for this function:

isGroupCalendarEnabled()

ilCalendarSettings::isGroupCalendarEnabled

(

)

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

        {
                return $this->group_cal_enabled;
        }

References $group_cal_enabled.

Referenced by save().

Here is the caller graph for this function:

isNotificationEnabled()

ilCalendarSettings::isNotificationEnabled

(

)

Course group notification enabled.

Returns

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

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

References $notification.

Referenced by save().

Here is the caller graph for this function:

isSynchronisationCacheEnabled()

ilCalendarSettings::isSynchronisationCacheEnabled

(

)

Check if cache is active for calendar synchronisation.

Returns

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

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

References $sync_cache_enabled.

Referenced by save().

Here is the caller graph for this function:

isUserNotificationEnabled()

ilCalendarSettings::isUserNotificationEnabled

(

)

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

        {
                return $this->notification_user;
        }

References $notification_user.

Referenced by save().

Here is the caller graph for this function:

isWebCalSyncEnabled()

ilCalendarSettings::isWebCalSyncEnabled

(

)

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

        {
                return $this->webcal_sync;
        }

References $webcal_sync.

Referenced by save().

Here is the caller graph for this function:

lookupCalendarActivated()

static ilCalendarSettings::lookupCalendarActivated (   $a_obj_id )

static

Parameters

type

$a_obj_id

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

        {
                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_show_calendar',
                                $gl_activated
                        );
        }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

read()

ilCalendarSettings::read ( )

private

Read settings.

@access private

Parameters

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

        {
                $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->enableGroupCalendar($this->storage->get('group_cal',$this->isGroupCalendarEnabled()));
                $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()));
        }

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

Referenced by __construct().

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.

@access private

Parameters

return

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

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

References $query, and $row.

Referenced by __construct().

Here is the caller graph for this function:

save()

ilCalendarSettings::save

(

)

save

@access public

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

        {
                $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('group_cal',(int) $this->isGroupCalendarEnabled());
                $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());
        }

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

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 178 of file class.ilCalendarSettings.php.

        {
                $this->cache_minutes = $a_min;
        }

Referenced by read().

Here is the caller graph for this function:

setDefaultDateFormat()

ilCalendarSettings::setDefaultDateFormat

(

$a_format

)

set default date format

@access public

Parameters

int	date format

Returns

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

        {
                $this->date_format = $a_format;
        }

Referenced by read().

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 335 of file class.ilCalendarSettings.php.

        {
                $this->day_end = $a_end;
        }

Referenced by read().

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 316 of file class.ilCalendarSettings.php.

        {
                $this->day_start = $a_start;
        }

Referenced by read().

Here is the caller graph for this function:

setDefaultTimeFormat()

ilCalendarSettings::setDefaultTimeFormat

(

$a_format

)

set default time format

@access public

Parameters

int	time format

Returns

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

        {
                $this->time_format = $a_format;
        }

Referenced by read().

Here is the caller graph for this function:

setDefaultTimeZone()

ilCalendarSettings::setDefaultTimeZone

(

$a_zone

)

set default timezone

@access public

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

        {
                $this->timezone = $a_zone;
        }

Referenced by read().

Here is the caller graph for this function:

setDefaultWeekStart()

ilCalendarSettings::setDefaultWeekStart

(

$a_start

)

set week start

@access public

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

        {
                $this->week_start = $a_start;
        }

Referenced by read().

Here is the caller graph for this function:

setEnabled()

ilCalendarSettings::setEnabled

(

$a_enabled

)

set enabled

@access public

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

        {
                $this->enabled = $a_enabled;
        }

Referenced by read().

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 376 of file class.ilCalendarSettings.php.

        {
                $this->enablegroupmilestones = $a_enablegroupmilestones;
        }

Referenced by read().

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 414 of file class.ilCalendarSettings.php.

        {
                $this->sync_cache_minutes = $a_min;
        }

Referenced by read().

Here is the caller graph for this function:

setWebCalSyncHours()

ilCalendarSettings::setWebCalSyncHours

(

$a_hours

)

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

        {
                $this->webcal_sync_hours = $a_hours;
        }

Referenced by read().

Here is the caller graph for this function:

useCache()

ilCalendarSettings::useCache

(

$a_status

)

Enable cache.

Parameters

object

$a_status

Returns

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

        {
                $this->cache_enabled = $a_status;
        }

Referenced by read().

Here is the caller graph for this function:

Field Documentation

$cache_enabled

ilCalendarSettings::$cache_enabled = true

private

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

Referenced by isCacheUsed().

$cache_minutes

ilCalendarSettings::$cache_minutes = 1

private

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

Referenced by getCacheMinutes().

$cal_settings_id

ilCalendarSettings::$cal_settings_id = 0

private

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

Referenced by getCalendarSettingsId().

$cg_registration

ilCalendarSettings::$cg_registration = false

private

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

Referenced by isCGRegistrationEnabled().

$consultation_hours

ilCalendarSettings::$consultation_hours = false

private

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

Referenced by areConsultationHoursEnabled().

$course_cal_enabled

ilCalendarSettings::$course_cal_enabled = true

private

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

Referenced by isCourseCalendarEnabled().

$day_end

ilCalendarSettings::$day_end = null

private

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

Referenced by getDefaultDayEnd().

$day_start

ilCalendarSettings::$day_start = null

private

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

Referenced by getDefaultDayStart().

$db

ilCalendarSettings::$db = null

private

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

$enabled

ilCalendarSettings::$enabled = false

private

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

Referenced by isEnabled().

$group_cal_enabled

ilCalendarSettings::$group_cal_enabled = true

private

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

Referenced by isGroupCalendarEnabled().

$instance

ilCalendarSettings::$instance = null

staticprivate

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

Referenced by _getInstance().

$notification

ilCalendarSettings::$notification = false

private

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

Referenced by isNotificationEnabled().

$notification_user

ilCalendarSettings::$notification_user = false

private

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

Referenced by isUserNotificationEnabled().

$storage

ilCalendarSettings::$storage = null

private

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

$sync_cache_enabled

ilCalendarSettings::$sync_cache_enabled = true

private

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

Referenced by isSynchronisationCacheEnabled().

$sync_cache_minutes

ilCalendarSettings::$sync_cache_minutes = 10

private

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

Referenced by getSynchronisationCacheMinutes().

$time_format

ilCalendarSettings::$time_format = null

private

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

Referenced by getDefaultTimeFormat().

$timezone

ilCalendarSettings::$timezone = null

private

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

Referenced by getDefaultTimeZone().

$webcal_sync

ilCalendarSettings::$webcal_sync = false

private

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

Referenced by isWebCalSyncEnabled().

$webcal_sync_hours

ilCalendarSettings::$webcal_sync_hours = 2

private

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

Referenced by getWebCalSyncHours().

$week_start

ilCalendarSettings::$week_start = 0

private

Definition at line 60 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 ilDateTimeInputGUI\checkInput(), ilDataCollectionDatatype\formatDate(), ilADTDateSearchUtil\handleTextInputPost(), ilObjCalendarSettingsGUI\initFormSettings(), ilPersonalSettingsGUI\initGeneralSettingsForm(), ilCalendarUserSettingsGUI\initSettingsForm(), and ilDateTimeInputGUI\render().

DATE_FORMAT_MDY

const ilCalendarSettings::DATE_FORMAT_MDY = 3

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

Referenced by ilDateTimeInputGUI\checkInput(), ilDataCollectionDatatype\formatDate(), ilADTDateSearchUtil\handleTextInputPost(), ilObjCalendarSettingsGUI\initFormSettings(), ilPersonalSettingsGUI\initGeneralSettingsForm(), ilCalendarUserSettingsGUI\initSettingsForm(), and ilDateTimeInputGUI\render().

DATE_FORMAT_YMD

const ilCalendarSettings::DATE_FORMAT_YMD = 2

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

Referenced by ilDateTimeInputGUI\checkInput(), ilDataCollectionDatatype\formatDate(), ilADTDateSearchUtil\handleTextInputPost(), ilObjCalendarSettingsGUI\initFormSettings(), ilPersonalSettingsGUI\initGeneralSettingsForm(), ilCalendarUserSettingsGUI\initSettingsForm(), and ilDateTimeInputGUI\render().

DEFAULT_CACHE_MINUTES

const ilCalendarSettings::DEFAULT_CACHE_MINUTES = 0

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

DEFAULT_DAY_END

const ilCalendarSettings::DEFAULT_DAY_END = 19

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

Referenced by ilCalendarUserSettings\read().

DEFAULT_DAY_START

const ilCalendarSettings::DEFAULT_DAY_START = 8

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

Referenced by ilCalendarUserSettings\read().

DEFAULT_SYNC_CACHE_MINUTES

const ilCalendarSettings::DEFAULT_SYNC_CACHE_MINUTES = 10

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

TIME_FORMAT_12

const ilCalendarSettings::TIME_FORMAT_12 = 2

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

Referenced by ilObjBookingPoolGUI\buildDatesBySchedule(), ilDateTimeInputGUI\checkInput(), ilDatePresentation\formatDate(), ilDatePresentation\formatPeriod(), ilCalendarUtil\getHourSelection(), ilADTDateSearchUtil\handleTextInputPost(), ilObjCalendarSettingsGUI\initFormSettings(), ilPersonalSettingsGUI\initGeneralSettingsForm(), ilCalendarUserSettingsGUI\initSettingsForm(), ilCalendarWeekGUI\parseHourInfo(), ilCalendarDayGUI\parseInfoIntoRaster(), ilDateTimeInputGUI\render(), ilObjBookingPoolGUI\renderSlots(), ilCalendarDayGUI\showAppointment(), ilCalendarWeekGUI\showAppointment(), ilCalendarMonthGUI\showEvents(), and ilChatroomHistoryTask\showMessages().

TIME_FORMAT_24

const ilCalendarSettings::TIME_FORMAT_24 = 1

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

Referenced by ilDatePresentation\formatDate(), ilDatePresentation\formatPeriod(), ilCalendarUtil\getHourSelection(), ilObjCalendarSettingsGUI\initFormSettings(), ilPersonalSettingsGUI\initGeneralSettingsForm(), ilCalendarUserSettingsGUI\initSettingsForm(), ilUtil\makeTimeSelect(), ilCalendarWeekGUI\parseHourInfo(), ilCalendarDayGUI\parseInfoIntoRaster(), ilObjBookingPoolGUI\renderSlots(), ilCalendarDayGUI\showAppointment(), ilCalendarWeekGUI\showAppointment(), ilCalendarMonthGUI\showEvents(), and ilChatroomHistoryTask\showMessages().

WEEK_START_MONDAY

const ilCalendarSettings::WEEK_START_MONDAY = 1

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

Referenced by ilCalendarRecurrence\toICal().

WEEK_START_SUNDAY

const ilCalendarSettings::WEEK_START_SUNDAY = 0

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

---

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

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