ilCalendarSettings Class Reference

Stores all calendar relevant settings. More...

Collaboration diagram for ilCalendarSettings:

Public Member Functions
	useCache ($a_status)
	Enable cache.
	isCacheUsed ()
	Check if cache is used.
	setCacheMinutes ($a_min)
	Set time of cache storage.
	getCacheMinutes ()
	Get cache minutes.
	setEnabled ($a_enabled)
	set enabled
	isEnabled ()
	is calendar enabled
	setDefaultWeekStart ($a_start)
	set week start
	getDefaultWeekStart ()
	get default week start
	setDefaultTimeZone ($a_zone)
	set default timezone
	getDefaultTimeZone ()
	get derfault time zone
	setDefaultTimeFormat ($a_format)
	set default time format
	getDefaultTimeFormat ()
	get default time format
	getDefaultDayStart ()
	Get default end of day.
	setDefaultDayStart ($a_start)
	Set default start of day.
	getDefaultDayEnd ()
	Get default end of day.
	setDefaultDayEnd ($a_end)
	set default end of day
	getCalendarSettingsId ()
	Get calendar settings id (Used for permission checks)
	setEnableGroupMilestones ($a_enablegroupmilestones)
	Set Enable milestone planning feature for groups.
	getEnableGroupMilestones ()
	Get Enable milestone planning feature for groups.
	isSynchronisationCacheEnabled ()
	Check if cache is active for calendar synchronisation.
	enableSynchronisationCache ($a_status)
	En/Disable synchronisation cache.
	setSynchronisationCacheMinutes ($a_min)
	Set synchronisation cache minutes.
	getSynchronisationCacheMinutes ()
	get synchronisation cache minutes
	save ()
	save

Static Public Member Functions
static	_getInstance ()
	get singleton instance

Data Fields
const	WEEK_START_MONDAY = 1
const	WEEK_START_SUNDAY = 0
const	DEFAULT_DAY_START = 8
const	DEFAULT_DAY_END = 19
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
	read ()
	Read settings.
	readCalendarSettingsId ()
	Read ref_id of calendar settings.
	initStorage ()
	Init storage class (ilSetting) private.

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
	$cache_enabled = true
	$cache_minutes = 1
	$sync_cache_enabled = true
	$sync_cache_minutes = 10

Static Private Attributes
static	$instance = null

Detailed Description

Stores all calendar relevant settings.

Author

Stefan Meyer smeye.nosp@m.r@da.nosp@m.tabay.nosp@m..de

Version

$Id$

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

Constructor & Destructor Documentation

ilCalendarSettings::__construct ( )

private

singleton contructor

private

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

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

        {
                global $ilDB;

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

Here is the call graph for this function:

Member Function Documentation

static ilCalendarSettings::_getInstance ( )

static

get singleton instance

public

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

References $instance.

Referenced by ilCalendarCache\__construct(), ilCalendarUserSettingsGUI\__construct(), ilObjPersonalDesktopSettingsGUI\editSettings(), ilCalendarPresentationGUI\executeCommand(), ilObjUser\getTimeFormat(), ilObjUser\getTimeZone(), ilObjCalendarSettingsGUI\initCalendarSettings(), ilCalendarCategoryGUI\initFormCategory(), ilColumnGUI\isGloballyActivated(), ilCalendarAuthenticationToken\isIcalExpired(), ilCalendarCache\readEntry(), ilCalendarCategoryGUI\readPermissions(), ilCalendarCategories\readPublicCalendars(), ilObjPersonalDesktopSettingsGUI\saveSettings(), ilPersonalDesktopGUI\setTabs(), ilCalendarDayGUI\show(), ilCalendarWeekGUI\show(), ilCalendarMonthGUI\show(), ilCalendarCache\storeEntry(), and ilCalendarCache\storeUnlimitedEntry().

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

Here is the caller graph for this function:

ilCalendarSettings::enableSynchronisationCache

(

$a_status

)

En/Disable synchronisation cache.

Returns

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

Referenced by read().

        {
                $this->sync_cache_enabled = $a_status;
        }

Here is the caller graph for this function:

ilCalendarSettings::getCacheMinutes

(

)

Get cache minutes.

Returns

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

References $cache_minutes.

Referenced by save().

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

Here is the caller graph for this function:

ilCalendarSettings::getCalendarSettingsId

(

)

Get calendar settings id (Used for permission checks)

public

Returns

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

References $cal_settings_id.

        {
                return $this->cal_settings_id;
        }

ilCalendarSettings::getDefaultDayEnd

(

)

Get default end of day.

Returns

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

References $day_end.

Referenced by save().

        {
                return $this->day_end;
        }

Here is the caller graph for this function:

ilCalendarSettings::getDefaultDayStart

(

)

Get default end of day.

Returns

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

References $day_start.

Referenced by save().

        {
                return $this->day_start;
        }

Here is the caller graph for this function:

ilCalendarSettings::getDefaultTimeFormat

(

)

get default time format

public

Returns

int time format

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

References $time_format.

Referenced by save().

        {
                return $this->time_format;
        }

Here is the caller graph for this function:

ilCalendarSettings::getDefaultTimeZone

(

)

get derfault time zone

public

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

References $timezone.

Referenced by save().

        {
                return $this->timezone;
        }

Here is the caller graph for this function:

ilCalendarSettings::getDefaultWeekStart

(

)

get default week start

public

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

References $week_start.

Referenced by save().

        {
                return $this->week_start;
        }

Here is the caller graph for this function:

ilCalendarSettings::getEnableGroupMilestones

(

)

Get Enable milestone planning feature for groups.

Returns

boolean Enable milestone planning feature for groups

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

Referenced by save().

        {
                return $this->enablegroupmilestones;
        }

Here is the caller graph for this function:

ilCalendarSettings::getSynchronisationCacheMinutes

(

)

get synchronisation cache minutes

Returns

Definition at line 329 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:

ilCalendarSettings::initStorage ( )

private

Init storage class (ilSetting) private.

Definition at line 403 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:

ilCalendarSettings::isCacheUsed

(

)

Check if cache is used.

Returns

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

References $cache_enabled.

Referenced by save().

        {
                return $this->cache_enabled;
        }

Here is the caller graph for this function:

ilCalendarSettings::isEnabled

(

)

is calendar enabled

public

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

References $enabled.

Referenced by save().

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

Here is the caller graph for this function:

ilCalendarSettings::isSynchronisationCacheEnabled

(

)

Check if cache is active for calendar synchronisation.

Returns

Definition at line 301 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:

ilCalendarSettings::read ( )

private

Read settings.

private

Parameters

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

References $cache_enabled, ilTimeZone\_getDefaultTimeZone(), enableSynchronisationCache(), isSynchronisationCacheEnabled(), setCacheMinutes(), setDefaultDayEnd(), setDefaultDayStart(), setDefaultTimeFormat(), setDefaultTimeZone(), setDefaultWeekStart(), setEnabled(), setEnableGroupMilestones(), setSynchronisationCacheMinutes(), 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->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));
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilCalendarSettings::readCalendarSettingsId ( )

private

Read ref_id of calendar settings.

private

Parameters

@return

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

References $ilDB, $query, $res, and $row.

Referenced by __construct().

        {
                global $ilDB;
                
                $query = "SELECT ref_id FROM object_reference obr ".
                        "JOIN object_data obd ON obd.obj_id = obr.obj_id ".
                        "WHERE type = 'cals'";
                        
                $res = $this->db->query($query);
                $row = $res->fetchRow();
                
                $this->cal_settings_id = $row[0];
                return true;
        }

Here is the caller graph for this function:

ilCalendarSettings::save

(

)

save

public

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

References getCacheMinutes(), getDefaultDayEnd(), getDefaultDayStart(), getDefaultTimeFormat(), getDefaultTimeZone(), getDefaultWeekStart(), getEnableGroupMilestones(), getSynchronisationCacheMinutes(), isCacheUsed(), isEnabled(), and isSynchronisationCacheEnabled().

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

Here is the call graph for this function:

ilCalendarSettings::setCacheMinutes

(

$a_min

)

Set time of cache storage.

Parameters

int

$a_min

Returns

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

Referenced by read().

        {
                $this->cache_minutes = $a_min;
        }

Here is the caller graph for this function:

ilCalendarSettings::setDefaultDayEnd

(

$a_end

)

set default end of day

Returns

Parameters

object

$a_end

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

Referenced by read().

        {
                $this->day_end = $a_end;
        }

Here is the caller graph for this function:

ilCalendarSettings::setDefaultDayStart

(

$a_start

)

Set default start of day.

Returns

Parameters

object

$a_start

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

Referenced by read().

        {
                $this->day_start = $a_start;
        }

Here is the caller graph for this function:

ilCalendarSettings::setDefaultTimeFormat

(

$a_format

)

set default time format

public

Parameters

int	time format

Returns

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

Referenced by read().

        {
                $this->time_format = $a_format;
        }

Here is the caller graph for this function:

ilCalendarSettings::setDefaultTimeZone

(

$a_zone

)

set default timezone

public

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

Referenced by read().

        {
                $this->timezone = $a_zone;
        }

Here is the caller graph for this function:

ilCalendarSettings::setDefaultWeekStart

(

$a_start

)

set week start

public

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

Referenced by read().

        {
                $this->week_start = $a_start;
        }

Here is the caller graph for this function:

ilCalendarSettings::setEnabled

(

$a_enabled

)

set enabled

public

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

Referenced by read().

        {
                $this->enabled = $a_enabled;
        }

Here is the caller graph for this function:

ilCalendarSettings::setEnableGroupMilestones

(

$a_enablegroupmilestones

)

Set Enable milestone planning feature for groups.

Parameters

boolean

$a_enablegroupmilestones

Enable milestone planning feature for groups

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

Referenced by read().

        {
                $this->enablegroupmilestones = $a_enablegroupmilestones;
        }

Here is the caller graph for this function:

ilCalendarSettings::setSynchronisationCacheMinutes

(

$a_min

)

Set synchronisation cache minutes.

Parameters

object

$a_min

Returns

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

Referenced by read().

        {
                $this->sync_cache_minutes = $a_min;
        }

Here is the caller graph for this function:

ilCalendarSettings::useCache

(

$a_status

)

Enable cache.

Parameters

object

$a_status

Returns

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

Referenced by read().

        {
                $this->cache_enabled = $a_status;
        }

Here is the caller graph for this function:

Field Documentation

ilCalendarSettings::$cache_enabled = true

private

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

Referenced by isCacheUsed(), and read().

ilCalendarSettings::$cache_minutes = 1

private

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

Referenced by getCacheMinutes().

ilCalendarSettings::$cal_settings_id = 0

private

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

Referenced by getCalendarSettingsId().

ilCalendarSettings::$day_end = null

private

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

Referenced by getDefaultDayEnd().

ilCalendarSettings::$day_start = null

private

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

Referenced by getDefaultDayStart().

ilCalendarSettings::$db = null

private

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

ilCalendarSettings::$enabled = false

private

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

Referenced by isEnabled().

ilCalendarSettings::$instance = null

staticprivate

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

Referenced by _getInstance().

ilCalendarSettings::$storage = null

private

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

ilCalendarSettings::$sync_cache_enabled = true

private

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

Referenced by isSynchronisationCacheEnabled().

ilCalendarSettings::$sync_cache_minutes = 10

private

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

Referenced by getSynchronisationCacheMinutes().

ilCalendarSettings::$time_format = null

private

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

Referenced by getDefaultTimeFormat().

ilCalendarSettings::$timezone = null

private

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

Referenced by getDefaultTimeZone().

ilCalendarSettings::$week_start = 0

private

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

Referenced by getDefaultWeekStart().

const ilCalendarSettings::DEFAULT_CACHE_MINUTES = 0

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

const ilCalendarSettings::DEFAULT_DAY_END = 19

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

Referenced by ilCalendarUserSettings\read().

const ilCalendarSettings::DEFAULT_DAY_START = 8

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

Referenced by ilCalendarUserSettings\read().

const ilCalendarSettings::DEFAULT_SYNC_CACHE_MINUTES = 10

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

const ilCalendarSettings::TIME_FORMAT_12 = 2

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

Referenced by ilDatePresentation\formatDate(), ilDatePresentation\formatPeriod(), ilCalendarUtil\getHourSelection(), ilObjCalendarSettingsGUI\initFormSettings(), ilCalendarUserSettingsGUI\initSettingsForm(), ilCalendarDayGUI\parseHourInfo(), ilCalendarWeekGUI\parseHourInfo(), ilCalendarDayGUI\showAppointment(), ilCalendarWeekGUI\showAppointment(), and ilCalendarMonthGUI\showEvents().

const ilCalendarSettings::TIME_FORMAT_24 = 1

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

Referenced by ilDatePresentation\formatDate(), ilDatePresentation\formatPeriod(), ilCalendarUtil\getHourSelection(), ilObjCalendarSettingsGUI\initFormSettings(), ilCalendarUserSettingsGUI\initSettingsForm(), ilCalendarDayGUI\parseHourInfo(), ilCalendarWeekGUI\parseHourInfo(), ilCalendarDayGUI\showAppointment(), ilCalendarWeekGUI\showAppointment(), and ilCalendarMonthGUI\showEvents().

const ilCalendarSettings::WEEK_START_MONDAY = 1

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

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