class.ilCalendarSettings.php

Go to the documentation of this file.

<?php
/*
    +-----------------------------------------------------------------------------+
    | ILIAS open source                                                           |
    +-----------------------------------------------------------------------------+
    | Copyright (c) 1998-2006 ILIAS open source, University of Cologne            |
    |                                                                             |
    | This program is free software; you can redistribute it and/or               |
    | modify it under the terms of the GNU General Public License                 |
    | as published by the Free Software Foundation; either version 2              |
    | of the License, or (at your option) any later version.                      |
    |                                                                             |
    | This program is distributed in the hope that it will be useful,             |
    | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
    | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
    | GNU General Public License for more details.                                |
    |                                                                             |
    | You should have received a copy of the GNU General Public License           |
    | along with this program; if not, write to the Free Software                 |
    | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
    +-----------------------------------------------------------------------------+
*/

include_once('Services/Calendar/classes/class.ilTimeZone.php');

class ilCalendarSettings
{
    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;

    public const DEFAULT_CAL_DAY = 1;
    public const DEFAULT_CAL_WEEK = 2;
    public const DEFAULT_CAL_MONTH = 3;
    public 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 static $instance = null;

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

    private $batch_file_downloads = false;

    private function __construct()
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $this->db = $ilDB;
        
        $this->initStorage();
        $this->read();
        $this->readCalendarSettingsId();
    }
    
    public static function _getInstance()
    {
        if (self::$instance) {
            return self::$instance;
        }
        return self::$instance = new ilCalendarSettings();
    }
    
    public static function lookupCalendarContentPresentationEnabled(int $obj_id) : 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
        );
    }

    public static function lookupCalendarActivated($a_obj_id)
    {
        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
            );
    }
    
    public function useCache($a_status)
    {
        $this->cache_enabled = $a_status;
    }
    
    public function isCacheUsed()
    {
        return $this->cache_enabled;
    }
    
    public function setCacheMinutes($a_min)
    {
        $this->cache_minutes = $a_min;
    }
    
    public function getCacheMinutes()
    {
        return (int) $this->cache_minutes;
    }

    public function setEnabled($a_enabled)
    {
        $this->enabled = $a_enabled;
    }
    
    public function isEnabled()
    {
        return (bool) $this->enabled;
    }
    
    public function setDefaultWeekStart($a_start)
    {
        $this->week_start = $a_start;
    }
    
    public function getDefaultWeekStart()
    {
        return $this->week_start;
    }


    public function getDefaultCal() : int
    {
        return $this->default_cal;
    }

    public function setDefaultCal(int $default_cal) : void
    {
        $this->default_cal = $default_cal;
    }

    public function getDefaultPeriod() : int
    {
        return $this->default_period;
    }

    public function setDefaultPeriod(int $default_period) : void
    {
        $this->default_period = $default_period;
    }
    
    public function setDefaultTimeZone($a_zone)
    {
        $this->timezone = $a_zone;
    }
    
    public function getDefaultTimeZone()
    {
        return $this->timezone;
    }

    public function setDefaultDateFormat($a_format)
    {
        $this->date_format = $a_format;
    }

    public function getDefaultDateFormat()
    {
        return $this->date_format;
    }
    
    public function setDefaultTimeFormat($a_format)
    {
        $this->time_format = $a_format;
    }
    
    public function getDefaultTimeFormat()
    {
        return $this->time_format;
    }
    
    public function getDefaultDayStart()
    {
        return $this->day_start;
    }
    
    public function setDefaultDayStart($a_start)
    {
        $this->day_start = $a_start;
    }
    
    public function getDefaultDayEnd()
    {
        return $this->day_end;
    }
    
    public function setDefaultDayEnd($a_end)
    {
        $this->day_end = $a_end;
    }
    
    public function areConsultationHoursEnabled()
    {
        return $this->consultation_hours;
    }
    
    public function enableConsultationHours($a_status)
    {
        $this->consultation_hours = $a_status;
    }
    

    public function getCalendarSettingsId()
    {
        return $this->cal_settings_id;
    }

    public function setEnableGroupMilestones($a_enablegroupmilestones)
    {
        $this->enablegroupmilestones = $a_enablegroupmilestones;
    }

    public function getEnableGroupMilestones()
    {
        return $this->enablegroupmilestones;
    }
    
    public function isSynchronisationCacheEnabled()
    {
        return (bool) $this->sync_cache_enabled;
    }
    
    public function enableSynchronisationCache($a_status)
    {
        $this->sync_cache_enabled = $a_status;
    }
    
    public function setSynchronisationCacheMinutes($a_min)
    {
        $this->sync_cache_minutes = $a_min;
    }
    
    public function getSynchronisationCacheMinutes()
    {
        return $this->sync_cache_minutes;
    }
    
    public function isNotificationEnabled()
    {
        return (bool) $this->notification;
    }
    
    public function enableNotification($a_status)
    {
        $this->notification = $a_status;
    }

    public function isUserNotificationEnabled()
    {
        return $this->notification_user;
    }

    public function enableUserNotification($a_not)
    {
        $this->notification_user = $a_not;
    }
    
    public function enableCGRegistration($a_status)
    {
        $this->cg_registration = $a_status;
    }
    
    public function isCGRegistrationEnabled()
    {
        return $this->cg_registration;
    }
    
    public function enableCourseCalendar($a_stat)
    {
        $this->course_cal_enabled = $a_stat;
    }
    
    public function isCourseCalendarEnabled()
    {
        return $this->course_cal_enabled;
    }
    
    public function isCourseCalendarVisible() : bool
    {
        return $this->course_cal_visible;
    }

    public function setCourseCalendarVisible(bool $status)
    {
        $this->course_cal_visible = $status;
    }

    public function isObjectCalendarVisible(string $type) : bool
    {
        switch ($type) {
            case 'crs':
                return $this->isCourseCalendarVisible();
            case 'grp':
                return $this->isGroupCalendarVisible();
        }
        return false;
    }
    
    public function enableGroupCalendar($a_stat)
    {
        $this->group_cal_enabled = $a_stat;
    }
    
    public function isGroupCalendarEnabled()
    {
        return $this->group_cal_enabled;
    }
    
    public function isGroupCalendarVisible() : bool
    {
        return $this->group_cal_visible;
    }

    public function setGroupCalendarVisible(bool $status)
    {
        $this->group_cal_visible = $status;
    }
    
    public function enableWebCalSync($a_stat)
    {
        $this->webcal_sync = $a_stat;
    }
    
    public function isWebCalSyncEnabled()
    {
        return $this->webcal_sync;
    }
    
    public function setWebCalSyncHours($a_hours)
    {
        $this->webcal_sync_hours = $a_hours;
    }
    
    public function getWebCalSyncHours()
    {
        return $this->webcal_sync_hours;
    }

    public function setShowWeeks($a_val)
    {
        $this->show_weeks = $a_val;
    }
    
    public function getShowWeeks()
    {
        return $this->show_weeks;
    }

    public function enableBatchFileDownloads($a_stat)
    {
        $this->batch_file_downloads = $a_stat;
    }

    public function isBatchFileDownloadsEnabled()
    {
        return $this->batch_file_downloads;
    }
    
    public function save()
    {
        $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());
    }

    private function read()
    {
        $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()));
    }
    
    private function readCalendarSettingsId()
    {
        $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;
    }
    
    private function initStorage()
    {
        include_once('./Services/Administration/classes/class.ilSetting.php');
        $this->storage = new ilSetting('calendar');
    }
}