class.ilObjectServiceSettingsGUI.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilObjectServiceSettingsGUI 
{
        // unfortunately the following constants are not stored
        // in a non-GUI class, other classes are currently directly
        // accessing these, see ilObjectDataSet (changes should be
        // made there accordingly)

        const CALENDAR_VISIBILITY = 'cont_show_calendar';
        const NEWS_VISIBILITY = 'cont_show_news';
        const USE_NEWS = 'cont_use_news';
        const AUTO_RATING_NEW_OBJECTS = 'cont_auto_rate_new_obj';
        const INFO_TAB_VISIBILITY = 'cont_show_info_tab';
        const TAXONOMIES = 'cont_taxonomies';
        const TAG_CLOUD = 'cont_tag_cloud';
        const CUSTOM_METADATA = 'cont_custom_md';
        const BADGES = 'cont_badges';
        
        private $gui = null;
        private $modes = array();
        private $obj_id = 0;
        
        public function __construct($a_parent_gui, $a_obj_id, $a_modes)
        {
                $this->gui = $a_parent_gui;
                $this->modes = $a_modes;
                $this->obj_id = $a_obj_id;
        }
        
        
        
        public function executeCommand()
        {
                global $ilCtrl;
                
                $next_class = $ilCtrl->getNextClass($this);
                $cmd = $ilCtrl->getCmd('editSettings');
                
                switch($next_class)
                {
                        default:
                                $this->$cmd();
                                break;
                }
        }
        
        public static function initServiceSettingsForm($a_obj_id, ilPropertyFormGUI $form, $services)
        {
                global $ilSetting, $ilCtrl;
                
                // info tab
                if(in_array(self::INFO_TAB_VISIBILITY, $services))
                {
                        $info = new ilCheckboxInputGUI($GLOBALS['lng']->txt('obj_tool_setting_info_tab'), self::INFO_TAB_VISIBILITY);
                        $info->setValue(1);
                        $info->setChecked(ilContainer::_lookupContainerSetting(
                                                $a_obj_id,
                                                self::INFO_TAB_VISIBILITY,
                                                true
                                ));
                        //$info->setOptionTitle($GLOBALS['lng']->txt('obj_tool_setting_info_tab'));
                        $info->setInfo($GLOBALS['lng']->txt('obj_tool_setting_info_tab_info'));
                        $form->addItem($info);
                }
                
                // calendar
                if(in_array(self::CALENDAR_VISIBILITY, $services))
                {
                        include_once './Services/Calendar/classes/class.ilObjCalendarSettings.php';
                        if(ilCalendarSettings::_getInstance()->isEnabled())
                        {
                                // Container tools (calendar, news, ... activation)
                                $cal = new ilCheckboxInputGUI($GLOBALS['lng']->txt('obj_tool_setting_calendar'), self::CALENDAR_VISIBILITY);
                                $cal->setValue(1);
                                include_once './Services/Calendar/classes/class.ilObjCalendarSettings.php';
                                $cal->setChecked(ilCalendarSettings::lookupCalendarActivated($a_obj_id));
                                //$cal->setOptionTitle($GLOBALS['lng']->txt('obj_tool_setting_calendar'));
                                $cal->setInfo($GLOBALS['lng']->txt('obj_tool_setting_calendar_info'));
                                $form->addItem($cal);
                        }
                }
                
                // news
                if(in_array(self::USE_NEWS, $services))
                {
                        $news = new ilCheckboxInputGUI($GLOBALS['lng']->txt('obj_tool_setting_use_news'), self::USE_NEWS);
                        $news->setValue(1);
                        $checked = ilContainer::_lookupContainerSetting(
                                $a_obj_id,
                                self::USE_NEWS,
                                true
                        );
                        $news->setChecked($checked);
                        $info = $GLOBALS['lng']->txt('obj_tool_setting_use_news_info');
                        if ($checked)
                        {
                                $info.=" <a href='".$ilCtrl->getLinkTargetByClass("ilcontainernewssettingsgui", "").
                                        "'>» ".$GLOBALS['lng']->txt('obj_tool_setting_use_news_open_settings')."</a>";
                        }
                        $news->setInfo($info);
                        $form->addItem($news);

                }
                if(in_array(self::NEWS_VISIBILITY, $services))
                {
                        if($ilSetting->get('block_activated_news'))
                        {
                                // Container tools (calendar, news, ... activation)
                                $news = new ilCheckboxInputGUI($GLOBALS['lng']->txt('obj_tool_setting_news'), self::NEWS_VISIBILITY);
                                $news->setValue(1);
                                $news->setChecked(ilContainer::_lookupContainerSetting(
                                                $a_obj_id,
                                                self::NEWS_VISIBILITY,
                                                $ilSetting->get('block_activated_news',true)
                                ));
                                //$news->setOptionTitle($GLOBALS['lng']->txt('obj_tool_setting_news'));
                                $news->setInfo($GLOBALS['lng']->txt('obj_tool_setting_news_info'));
                                $form->addItem($news);
                                
                                if(in_array(ilObject::_lookupType($a_obj_id), array('crs', 'grp')))
                                {                                       
                                        $ref_id = array_pop(ilObject::_getAllReferences($a_obj_id));
                                        
                                        include_once 'Services/Membership/classes/class.ilMembershipNotifications.php';
                                        ilMembershipNotifications::addToSettingsForm($ref_id, null, $news);
                                }
                        }
                }
                
                // (local) custom metadata
                if(in_array(self::CUSTOM_METADATA, $services))
                {                                               
                        $md = new ilCheckboxInputGUI($GLOBALS['lng']->txt('obj_tool_setting_custom_metadata'), self::CUSTOM_METADATA);
                        $md->setInfo($GLOBALS['lng']->txt('obj_tool_setting_custom_metadata_info'));
                        $md->setValue(1);               
                        $md->setChecked(ilContainer::_lookupContainerSetting(
                                                $a_obj_id,
                                                self::CUSTOM_METADATA,
                                                false
                                ));
                        $form->addItem($md);                                                                    
                }               
                                
                // tag cloud
                if(in_array(self::TAG_CLOUD, $services))
                {                       
                        $tags_active = new ilSetting("tags");
                        if($tags_active->get("enable", false))
                        {
                                $tag = new ilCheckboxInputGUI($GLOBALS['lng']->txt('obj_tool_setting_tag_cloud'), self::TAG_CLOUD);
                                $tag->setInfo($GLOBALS['lng']->txt('obj_tool_setting_tag_cloud_info'));
                                $tag->setValue(1);              
                                $tag->setChecked(ilContainer::_lookupContainerSetting(
                                                        $a_obj_id,
                                                        self::TAG_CLOUD,
                                                        false
                                        ));
                                $form->addItem($tag);                                           
                        }                       
                }               
                
                // taxonomies
                if(in_array(self::TAXONOMIES, $services))
                {       
                        $tax = new ilCheckboxInputGUI($GLOBALS['lng']->txt('obj_tool_setting_taxonomies'), self::TAXONOMIES);
                        $tax->setValue(1);              
                        $tax->setChecked(ilContainer::_lookupContainerSetting(
                                                $a_obj_id,
                                                self::TAXONOMIES,
                                                false
                                ));
                        $form->addItem($tax);                   
                }
                
                // auto rating
                if(in_array(self::AUTO_RATING_NEW_OBJECTS, $services))
                {                       
                        $GLOBALS['lng']->loadLanguageModule("rating");
                        
                        // auto rating for new objects
                        $rate = new ilCheckboxInputGUI($GLOBALS['lng']->txt('rating_new_objects_auto'), self::AUTO_RATING_NEW_OBJECTS);
                        $rate->setValue(1);
                        //$rate->setOptionTitle($GLOBALS['lng']->txt('rating_new_objects_auto'));
                        $rate->setInfo($GLOBALS['lng']->txt('rating_new_objects_auto_info'));
                        $rate->setChecked(ilContainer::_lookupContainerSetting(
                                                $a_obj_id,
                                                self::AUTO_RATING_NEW_OBJECTS,
                                                false
                                ));
                        $form->addItem($rate);                  
                }
                
                // badges
                if(in_array(self::BADGES, $services))
                {               
                        include_once 'Services/Badge/classes/class.ilBadgeHandler.php';
                        if(ilBadgeHandler::getInstance()->isActive())
                        {
                                $bdg = new ilCheckboxInputGUI($GLOBALS['lng']->txt('obj_tool_setting_badges'), self::BADGES);
                                $bdg->setInfo($GLOBALS['lng']->txt('obj_tool_setting_badges_info'));
                                $bdg->setValue(1);              
                                $bdg->setChecked(ilContainer::_lookupContainerSetting(
                                                        $a_obj_id,
                                                        self::BADGES,
                                                        false
                                        ));
                                $form->addItem($bdg);           
                        }
                }               
                
                return $form;
        }
        
        public static function updateServiceSettingsForm($a_obj_id, ilPropertyFormGUI $form, $services)
        {
                // info
                if(in_array(self::INFO_TAB_VISIBILITY, $services))
                {
                        include_once './Services/Container/classes/class.ilContainer.php';
                        ilContainer::_writeContainerSetting($a_obj_id,self::INFO_TAB_VISIBILITY,(int) $form->getInput(self::INFO_TAB_VISIBILITY));
                }
                
                // calendar
                if(in_array(self::CALENDAR_VISIBILITY, $services))
                {
                        include_once './Services/Calendar/classes/class.ilCalendarSettings.php';
                        if(ilCalendarSettings::_getInstance()->isEnabled())
                        {
                                include_once './Services/Container/classes/class.ilContainer.php';
                                ilContainer::_writeContainerSetting($a_obj_id,self::CALENDAR_VISIBILITY,(int) $form->getInput(self::CALENDAR_VISIBILITY));
                        }
                }
                
                // news
                if(in_array(self::USE_NEWS, $services))
                {
                        include_once './Services/Container/classes/class.ilContainer.php';
                        ilContainer::_writeContainerSetting($a_obj_id,self::USE_NEWS,(int) $form->getInput(self::USE_NEWS));
                }
                if(in_array(self::NEWS_VISIBILITY, $services))
                {
                        include_once './Services/Container/classes/class.ilContainer.php';
                        ilContainer::_writeContainerSetting($a_obj_id,self::NEWS_VISIBILITY,(int) $form->getInput(self::NEWS_VISIBILITY));
                        
                        if(in_array(ilObject::_lookupType($a_obj_id), array('crs', 'grp')))
                        {                                       
                                $ref_id = array_pop(ilObject::_getAllReferences($a_obj_id));
                                        
                                include_once "Services/Membership/classes/class.ilMembershipNotifications.php";
                                ilMembershipNotifications::importFromForm($ref_id, $form);
                        }
                }
                
                // rating
                if(in_array(self::AUTO_RATING_NEW_OBJECTS, $services))
                {
                        include_once './Services/Container/classes/class.ilContainer.php';
                        ilContainer::_writeContainerSetting($a_obj_id,self::AUTO_RATING_NEW_OBJECTS,(int) $form->getInput(self::AUTO_RATING_NEW_OBJECTS));
                }
                
                // taxonomies
                if(in_array(self::TAXONOMIES, $services))
                {
                        include_once './Services/Container/classes/class.ilContainer.php';
                        ilContainer::_writeContainerSetting($a_obj_id,self::TAXONOMIES,(int) $form->getInput(self::TAXONOMIES));
                }
                
                // tag cloud
                if(in_array(self::TAG_CLOUD, $services))
                {
                        include_once './Services/Container/classes/class.ilContainer.php';
                        ilContainer::_writeContainerSetting($a_obj_id,self::TAG_CLOUD,(int) $form->getInput(self::TAG_CLOUD));
                }
                
                // (local) custom metadata
                if(in_array(self::CUSTOM_METADATA, $services))
                {
                        include_once './Services/Container/classes/class.ilContainer.php';
                        ilContainer::_writeContainerSetting($a_obj_id,self::CUSTOM_METADATA,(int) $form->getInput(self::CUSTOM_METADATA));
                }
                
                // badges
                if(in_array(self::BADGES, $services))
                {
                        include_once 'Services/Badge/classes/class.ilBadgeHandler.php';
                        if(ilBadgeHandler::getInstance()->isActive())
                        {
                                include_once './Services/Container/classes/class.ilContainer.php';
                                ilContainer::_writeContainerSetting($a_obj_id,self::BADGES,(int) $form->getInput(self::BADGES));
                        }
                }
                
                return true;
        }

        
        public function getModes()
        {
                return $this->modes;
        }
        
        public function getObjId()
        {
                return $this->obj_id;
        }
        
        protected function cancel()
        {
                $GLOBALS['ilCtrl']->returnToParent($this);
        }
        
        protected function editSettings(ilPropertyFormGUI $form = null)
        {
                if(!$form instanceof ilPropertyFormGUI)
                {
                        $form = $this->initSettingsForm();
                }
                $GLOBALS['tpl']->setContent($form->getHTML());
        }
        
        
        protected function updateToolSettings()
        {
                $form = $this->initSettingsForm();
                if($form->checkInput())
                {
                        include_once './Services/Calendar/classes/class.ilCalendarSettings.php';
                        if(ilCalendarSettings::_getInstance()->isEnabled())
                        {
                                if($this->isModeActive(self::CALENDAR_VISIBILITY))
                                {
                                        ilContainer::_writeContainerSetting($this->getObjId(),'show_calendar',(int) $form->getInput('calendar'));
                                }
                        }
                        ilUtil::sendSuccess($GLOBALS['lng']->txt('settings_saved'),true);
                        $GLOBALS['ilCtrl']->redirect($this);
                }
                
                ilUtil::sendFailure($GLOBALS['lng']->txt('err_check_input'));
                $form->setValuesByPost();
                $this->editSettings($form);
        }
        
        protected function isModeActive($a_mode)
        {
                return in_array($a_mode, $this->getModes());
        }
        
}
?>