ILIAS
Release_4_2_x_branch Revision 61807
|
Stores all calendar relevant settings. More...
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 | |
setDefaultDateFormat ($a_format) | |
set default date format | |
getDefaultDateFormat () | |
get default date format | |
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 | |
areConsultationHoursEnabled () | |
Check if consultation hours are enabled. | |
enableConsultationHours ($a_status) | |
En/Disable consultation hours. | |
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 | |
isNotificationEnabled () | |
Course group notification enabled. | |
enableNotification ($a_status) | |
Enable course group notification. | |
enableCGRegistration ($a_status) | |
Enable optional registration for courses and groups. | |
isCGRegistrationEnabled () | |
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 | 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 | |
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 | |
$consultation_hours = false | |
$cache_enabled = true | |
$cache_minutes = 1 | |
$sync_cache_enabled = true | |
$sync_cache_minutes = 10 | |
$notification = false | |
$cg_registration = false |
Static Private Attributes | |
static | $instance = null |
Stores all calendar relevant settings.
Definition at line 35 of file class.ilCalendarSettings.php.
|
private |
singleton contructor
private
Definition at line 84 of file class.ilCalendarSettings.php.
References $ilDB, initStorage(), read(), and readCalendarSettingsId().
|
static |
get singleton instance
public
Definition at line 102 of file class.ilCalendarSettings.php.
References $instance.
Referenced by ilCalendarCache\__construct(), ilCalendarUserSettingsGUI\__construct(), ilObjPersonalDesktopSettingsGUI\editSettings(), ilCalendarPresentationGUI\executeCommand(), ilObjUser\getDateFormat(), ilObjUser\getTimeFormat(), ilObjUser\getTimeZone(), ilObjCalendarSettingsGUI\initCalendarSettings(), ilCalendarAppointmentGUI\initForm(), ilCalendarCategoryGUI\initFormCategory(), ilColumnGUI\isGloballyActivated(), ilCalendarAuthenticationToken\isIcalExpired(), ilCalendarPresentationGUI\prepareOutput(), ilCalendarCache\readEntry(), ilCalendarCategoryGUI\readPermissions(), ilCalendarCategories\readPublicCalendars(), ilMainMenuGUI\renderDropDown(), ilMainMenuGUI\renderEntry(), ilCalendarAppointmentGUI\save(), ilObjPersonalDesktopSettingsGUI\saveSettings(), ilCalendarDayGUI\show(), ilCalendarWeekGUI\show(), ilCalendarMonthGUI\show(), ilCalendarCache\storeEntry(), ilCalendarCache\storeUnlimitedEntry(), and ilCalendarAppointmentGUI\update().
ilCalendarSettings::areConsultationHoursEnabled | ( | ) |
Check if consultation hours are enabled.
Definition at line 301 of file class.ilCalendarSettings.php.
References $consultation_hours.
Referenced by save().
ilCalendarSettings::enableCGRegistration | ( | $a_status | ) |
Enable optional registration for courses and groups.
bool | $a_status |
Definition at line 409 of file class.ilCalendarSettings.php.
Referenced by read().
ilCalendarSettings::enableConsultationHours | ( | $a_status | ) |
En/Disable consultation hours.
Definition at line 310 of file class.ilCalendarSettings.php.
Referenced by read().
ilCalendarSettings::enableNotification | ( | $a_status | ) |
Enable course group notification.
bool | $a_status |
Definition at line 399 of file class.ilCalendarSettings.php.
Referenced by read().
ilCalendarSettings::enableSynchronisationCache | ( | $a_status | ) |
En/Disable synchronisation cache.
Definition at line 361 of file class.ilCalendarSettings.php.
Referenced by read().
ilCalendarSettings::getCacheMinutes | ( | ) |
Get cache minutes.
Definition at line 144 of file class.ilCalendarSettings.php.
References $cache_minutes.
Referenced by save().
ilCalendarSettings::getCalendarSettingsId | ( | ) |
Get calendar settings id (Used for permission checks)
public
Definition at line 323 of file class.ilCalendarSettings.php.
References $cal_settings_id.
ilCalendarSettings::getDefaultDateFormat | ( | ) |
get default date format
public
Definition at line 231 of file class.ilCalendarSettings.php.
Referenced by save().
ilCalendarSettings::getDefaultDayEnd | ( | ) |
Get default end of day.
Definition at line 282 of file class.ilCalendarSettings.php.
References $day_end.
Referenced by save().
ilCalendarSettings::getDefaultDayStart | ( | ) |
Get default end of day.
Definition at line 263 of file class.ilCalendarSettings.php.
References $day_start.
Referenced by save().
ilCalendarSettings::getDefaultTimeFormat | ( | ) |
get default time format
public
Definition at line 254 of file class.ilCalendarSettings.php.
References $time_format.
Referenced by save().
ilCalendarSettings::getDefaultTimeZone | ( | ) |
get derfault time zone
public
Definition at line 208 of file class.ilCalendarSettings.php.
References $timezone.
Referenced by save().
ilCalendarSettings::getDefaultWeekStart | ( | ) |
get default week start
public
Definition at line 188 of file class.ilCalendarSettings.php.
References $week_start.
Referenced by save().
ilCalendarSettings::getEnableGroupMilestones | ( | ) |
Get Enable milestone planning feature for groups.
Definition at line 343 of file class.ilCalendarSettings.php.
Referenced by save().
ilCalendarSettings::getSynchronisationCacheMinutes | ( | ) |
get synchronisation cache minutes
Definition at line 380 of file class.ilCalendarSettings.php.
References $sync_cache_minutes.
Referenced by save().
|
private |
Init storage class (ilSetting) private.
Definition at line 496 of file class.ilCalendarSettings.php.
Referenced by __construct().
ilCalendarSettings::isCacheUsed | ( | ) |
Check if cache is used.
Definition at line 125 of file class.ilCalendarSettings.php.
References $cache_enabled.
Referenced by save().
ilCalendarSettings::isCGRegistrationEnabled | ( | ) |
Definition at line 414 of file class.ilCalendarSettings.php.
References $cg_registration.
Referenced by save().
ilCalendarSettings::isEnabled | ( | ) |
is calendar enabled
public
Definition at line 166 of file class.ilCalendarSettings.php.
References $enabled.
Referenced by save().
ilCalendarSettings::isNotificationEnabled | ( | ) |
Course group notification enabled.
Definition at line 389 of file class.ilCalendarSettings.php.
References $notification.
Referenced by save().
ilCalendarSettings::isSynchronisationCacheEnabled | ( | ) |
Check if cache is active for calendar synchronisation.
Definition at line 352 of file class.ilCalendarSettings.php.
References $sync_cache_enabled.
Referenced by read(), and save().
|
private |
Read settings.
private
Definition at line 450 of file class.ilCalendarSettings.php.
References $cache_enabled, ilTimeZone\_getDefaultTimeZone(), enableCGRegistration(), enableConsultationHours(), enableNotification(), enableSynchronisationCache(), isSynchronisationCacheEnabled(), setCacheMinutes(), setDefaultDateFormat(), setDefaultDayEnd(), setDefaultDayStart(), setDefaultTimeFormat(), setDefaultTimeZone(), setDefaultWeekStart(), setEnabled(), setEnableGroupMilestones(), setSynchronisationCacheMinutes(), and useCache().
Referenced by __construct().
|
private |
Read ref_id of calendar settings.
private
@return |
Definition at line 476 of file class.ilCalendarSettings.php.
References $ilDB, $query, $res, and $row.
Referenced by __construct().
ilCalendarSettings::save | ( | ) |
save
public
Definition at line 424 of file class.ilCalendarSettings.php.
References areConsultationHoursEnabled(), getCacheMinutes(), getDefaultDateFormat(), getDefaultDayEnd(), getDefaultDayStart(), getDefaultTimeFormat(), getDefaultTimeZone(), getDefaultWeekStart(), getEnableGroupMilestones(), getSynchronisationCacheMinutes(), isCacheUsed(), isCGRegistrationEnabled(), isEnabled(), isNotificationEnabled(), and isSynchronisationCacheEnabled().
ilCalendarSettings::setCacheMinutes | ( | $a_min | ) |
Set time of cache storage.
int | $a_min |
Definition at line 135 of file class.ilCalendarSettings.php.
Referenced by read().
ilCalendarSettings::setDefaultDateFormat | ( | $a_format | ) |
set default date format
public
int | date format |
Definition at line 220 of file class.ilCalendarSettings.php.
Referenced by read().
ilCalendarSettings::setDefaultDayEnd | ( | $a_end | ) |
set default end of day
object | $a_end |
Definition at line 292 of file class.ilCalendarSettings.php.
Referenced by read().
ilCalendarSettings::setDefaultDayStart | ( | $a_start | ) |
Set default start of day.
object | $a_start |
Definition at line 273 of file class.ilCalendarSettings.php.
Referenced by read().
ilCalendarSettings::setDefaultTimeFormat | ( | $a_format | ) |
set default time format
public
int | time format |
Definition at line 243 of file class.ilCalendarSettings.php.
Referenced by read().
ilCalendarSettings::setDefaultTimeZone | ( | $a_zone | ) |
set default timezone
public
Definition at line 198 of file class.ilCalendarSettings.php.
Referenced by read().
ilCalendarSettings::setDefaultWeekStart | ( | $a_start | ) |
set week start
public
Definition at line 177 of file class.ilCalendarSettings.php.
Referenced by read().
ilCalendarSettings::setEnabled | ( | $a_enabled | ) |
set enabled
public
Definition at line 155 of file class.ilCalendarSettings.php.
Referenced by read().
ilCalendarSettings::setEnableGroupMilestones | ( | $a_enablegroupmilestones | ) |
Set Enable milestone planning feature for groups.
boolean | $a_enablegroupmilestones | Enable milestone planning feature for groups |
Definition at line 333 of file class.ilCalendarSettings.php.
Referenced by read().
ilCalendarSettings::setSynchronisationCacheMinutes | ( | $a_min | ) |
Set synchronisation cache minutes.
object | $a_min |
Definition at line 371 of file class.ilCalendarSettings.php.
Referenced by read().
ilCalendarSettings::useCache | ( | $a_status | ) |
Enable cache.
object | $a_status |
Definition at line 116 of file class.ilCalendarSettings.php.
Referenced by read().
|
private |
Definition at line 68 of file class.ilCalendarSettings.php.
Referenced by isCacheUsed(), and read().
|
private |
Definition at line 69 of file class.ilCalendarSettings.php.
Referenced by getCacheMinutes().
|
private |
Definition at line 64 of file class.ilCalendarSettings.php.
Referenced by getCalendarSettingsId().
|
private |
Definition at line 76 of file class.ilCalendarSettings.php.
Referenced by isCGRegistrationEnabled().
|
private |
Definition at line 66 of file class.ilCalendarSettings.php.
Referenced by areConsultationHoursEnabled().
|
private |
Definition at line 62 of file class.ilCalendarSettings.php.
Referenced by getDefaultDayEnd().
|
private |
Definition at line 61 of file class.ilCalendarSettings.php.
Referenced by getDefaultDayStart().
|
private |
Definition at line 56 of file class.ilCalendarSettings.php.
|
private |
Definition at line 63 of file class.ilCalendarSettings.php.
Referenced by isEnabled().
|
staticprivate |
Definition at line 54 of file class.ilCalendarSettings.php.
Referenced by _getInstance().
|
private |
Definition at line 74 of file class.ilCalendarSettings.php.
Referenced by isNotificationEnabled().
|
private |
Definition at line 57 of file class.ilCalendarSettings.php.
|
private |
Definition at line 71 of file class.ilCalendarSettings.php.
Referenced by isSynchronisationCacheEnabled().
|
private |
Definition at line 72 of file class.ilCalendarSettings.php.
Referenced by getSynchronisationCacheMinutes().
|
private |
Definition at line 59 of file class.ilCalendarSettings.php.
Referenced by getDefaultTimeFormat().
|
private |
Definition at line 58 of file class.ilCalendarSettings.php.
Referenced by getDefaultTimeZone().
|
private |
Definition at line 60 of file class.ilCalendarSettings.php.
Referenced by getDefaultWeekStart().
const ilCalendarSettings::DATE_FORMAT_DMY = 1 |
Definition at line 43 of file class.ilCalendarSettings.php.
Referenced by ilDateTimeInputGUI\checkInput(), ilObjCalendarSettingsGUI\initFormSettings(), ilPersonalSettingsGUI\initGeneralSettingsForm(), ilCalendarUserSettingsGUI\initSettingsForm(), and ilDateTimeInputGUI\render().
const ilCalendarSettings::DATE_FORMAT_MDY = 3 |
Definition at line 45 of file class.ilCalendarSettings.php.
Referenced by ilDateTimeInputGUI\checkInput(), ilObjCalendarSettingsGUI\initFormSettings(), ilPersonalSettingsGUI\initGeneralSettingsForm(), ilCalendarUserSettingsGUI\initSettingsForm(), and ilDateTimeInputGUI\render().
const ilCalendarSettings::DATE_FORMAT_YMD = 2 |
Definition at line 44 of file class.ilCalendarSettings.php.
Referenced by ilDateTimeInputGUI\checkInput(), ilObjCalendarSettingsGUI\initFormSettings(), ilPersonalSettingsGUI\initGeneralSettingsForm(), ilCalendarUserSettingsGUI\initSettingsForm(), and ilDateTimeInputGUI\render().
const ilCalendarSettings::DEFAULT_CACHE_MINUTES = 0 |
Definition at line 50 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 51 of file class.ilCalendarSettings.php.
const ilCalendarSettings::TIME_FORMAT_12 = 2 |
Definition at line 48 of file class.ilCalendarSettings.php.
Referenced by ilCalendarAppointmentGUI\book(), ilCalendarAppointmentGUI\cancelBooking(), ilDateTimeInputGUI\checkInput(), ilDatePresentation\formatDate(), ilDatePresentation\formatPeriod(), ilCalendarUtil\getHourSelection(), ilObjCalendarSettingsGUI\initFormSettings(), ilPersonalSettingsGUI\initGeneralSettingsForm(), ilCalendarUserSettingsGUI\initSettingsForm(), ilCalendarDayGUI\parseHourInfo(), ilCalendarWeekGUI\parseHourInfo(), ilDateTimeInputGUI\render(), ilObjBookingPoolGUI\renderList(), ilCalendarDayGUI\showAppointment(), ilCalendarWeekGUI\showAppointment(), ilCalendarMonthGUI\showEvents(), and ilChatroomHistoryTask\showMessages().
const ilCalendarSettings::TIME_FORMAT_24 = 1 |
Definition at line 47 of file class.ilCalendarSettings.php.
Referenced by ilCalendarAppointmentGUI\book(), ilCalendarAppointmentGUI\cancelBooking(), ilDatePresentation\formatDate(), ilDatePresentation\formatPeriod(), ilCalendarUtil\getHourSelection(), ilObjCalendarSettingsGUI\initFormSettings(), ilPersonalSettingsGUI\initGeneralSettingsForm(), ilCalendarUserSettingsGUI\initSettingsForm(), ilUtil\makeTimeSelect(), ilCalendarDayGUI\parseHourInfo(), ilCalendarWeekGUI\parseHourInfo(), ilObjBookingPoolGUI\renderList(), ilCalendarDayGUI\showAppointment(), ilCalendarWeekGUI\showAppointment(), ilCalendarMonthGUI\showEvents(), and ilChatroomHistoryTask\showMessages().
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.