GUI class for service settings (calendar, notes, comments) More...

Collaboration diagram for ilObjectServiceSettingsGUI:

Public Member Functions
	__construct ($a_parent_gui, $a_obj_id, $a_modes)
	Constructor. More...

	executeCommand ()
	Control class handling. More...

	getModes ()
	Get active modes. More...

	getObjId ()
	Get obj id. More...

Static Public Member Functions
static	initServiceSettingsForm ($a_obj_id, ilPropertyFormGUI $form, $services)
	Init service settings form. More...

static	updateServiceSettingsForm ($a_obj_id, ilPropertyFormGUI $form, $services)
	Update service settings. More...

Data Fields
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'

const	ORGU_POSITION_ACCESS = 'obj_orgunit_positions'

const	SKILLS = 'cont_skills'

Protected Member Functions
	cancel ()

	editSettings (ilPropertyFormGUI $form=null)
	Edit tool settings (calendar, news, comments, ...) More...

	updateToolSettings ()
	Update settings. More...

	isModeActive ($a_mode)
	Check if specific mode is active. More...

Protected Attributes
	$ctrl

Private Attributes
	$gui = null

	$modes = array()

	$obj_id = 0

Detailed Description

GUI class for service settings (calendar, notes, comments)

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

ilObjectServiceSettingsGUI:

Definition at line 14 of file class.ilObjectServiceSettingsGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjectServiceSettingsGUI::__construct	(	$a_parent_gui,
		$a_obj_id,
		$a_modes
	)

Constructor.

Parameters

type $a_parent_gui

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

References $DIC.

     {
         global $DIC;
 
         $this->ctrl = $DIC->ctrl();
         $this->gui = $a_parent_gui;
         $this->modes = $a_modes;
         $this->obj_id = $a_obj_id;
     }

Member Function Documentation

◆ cancel()

ilObjectServiceSettingsGUI::cancel ( )

protected

Definition at line 396 of file class.ilObjectServiceSettingsGUI.php.

References $GLOBALS.

     {
         $GLOBALS['ilCtrl']->returnToParent($this);
     }

◆ editSettings()

ilObjectServiceSettingsGUI::editSettings ( ilPropertyFormGUI $form = null )

protected

Edit tool settings (calendar, news, comments, ...)

Parameters

ilPropertyFormGUI $form

Definition at line 405 of file class.ilObjectServiceSettingsGUI.php.

References $form, and $GLOBALS.

Referenced by updateToolSettings().

     {
         if (!$form instanceof ilPropertyFormGUI) {
             $form = $this->initSettingsForm();
         }
         $GLOBALS['tpl']->setContent($form->getHTML());
     }

Here is the caller graph for this function:

◆ executeCommand()

ilObjectServiceSettingsGUI::executeCommand ( )

Control class handling.

Returns

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

References $ctrl, and $ilCtrl.

     {
         $ilCtrl = $this->ctrl;
         
         $next_class = $ilCtrl->getNextClass($this);
         $cmd = $ilCtrl->getCmd('editSettings');
         
         switch ($next_class) {
             default:
                 $this->$cmd();
                 break;
         }
     }

◆ getModes()

ilObjectServiceSettingsGUI::getModes ( )

Get active modes.

Returns: bool

Definition at line 382 of file class.ilObjectServiceSettingsGUI.php.

References $modes.

Referenced by isModeActive().

     {
         return $this->modes;
     }

Here is the caller graph for this function:

◆ getObjId()

ilObjectServiceSettingsGUI::getObjId ( )

Get obj id.

Returns: type

Definition at line 391 of file class.ilObjectServiceSettingsGUI.php.

References $obj_id.

Referenced by updateToolSettings().

     {
         return $this->obj_id;
     }

Here is the caller graph for this function:

◆ initServiceSettingsForm()

static ilObjectServiceSettingsGUI::initServiceSettingsForm	(		$a_obj_id,
		ilPropertyFormGUI	$form,
			$services
	)

static

Init service settings form.

Parameters

ilPropertyFormGUI	$form
type	$services

Definition at line 81 of file class.ilObjectServiceSettingsGUI.php.

References $DIC, $form, $GLOBALS, $ilCtrl, $ilSetting, $info, $tag, ilObject\_getAllReferences(), ilCalendarSettings\_getInstance(), ilContainer\_lookupContainerSetting(), ilObject\_lookupType(), ilPropertyFormGUI\addItem(), ilMembershipNotifications\addToSettingsForm(), array, ilOrgUnitGlobalSettings\getInstance(), ilBadgeHandler\getInstance(), and ilCalendarSettings\lookupCalendarActivated().

Referenced by ilObjBookingPoolGUI\addExternalEditFormCustom(), ilObjExerciseGUI\initEditCustomForm(), ilObjCategoryGUI\initEditForm(), ilObjCourseGUI\initEditForm(), ilObjSessionGUI\initForm(), ilObjGroupGUI\initForm(), ilIndividualAssessmentSettingsGUI\initSettingsForm(), ilObjGlossaryGUI\initSettingsForm(), and ilObjWikiGUI\initSettingsForm().

     {
         global $DIC;
 
         $ilSetting = $DIC->settings();
         $ilCtrl = $DIC->ctrl();
         
         // 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);
             }
         }
         if (in_array(self::ORGU_POSITION_ACCESS, $services)) {
             $position_settings = ilOrgUnitGlobalSettings::getInstance()->getObjectPositionSettingsByType(
                 ilObject::_lookupType($a_obj_id)
             );
             if (
                 $position_settings->isActive()
             ) {
                 $lia = new ilCheckboxInputGUI(
                     $GLOBALS['DIC']->language()->txt('obj_orgunit_positions'),
                     self::ORGU_POSITION_ACCESS
                 );
                 $lia->setInfo($GLOBALS['DIC']->language()->txt('obj_orgunit_positions_info'));
                 $lia->setValue(1);
                 $lia->setChecked(
                     (bool) ilOrgUnitGlobalSettings::getInstance()->isPositionAccessActiveForObject($a_obj_id)
                 );
                 if (!$position_settings->isChangeableForObject()) {
                     $lia->setDisabled(true);
                 }
                 $form->addItem($lia);
             }
         }
 
         // skills
         if (in_array(self::SKILLS, $services)) {
             $skmg_set = new ilSetting("skmg");
             if ($skmg_set->get("enable_skmg")) {
                 $skill = new ilCheckboxInputGUI($GLOBALS['lng']->txt('obj_tool_setting_skills'), self::SKILLS);
                 $skill->setInfo($GLOBALS['lng']->txt('obj_tool_setting_skills_info'));
                 $skill->setValue(1);
                 $skill->setChecked(ilContainer::_lookupContainerSetting(
                     $a_obj_id,
                     self::SKILLS,
                     false
                 ));
                 $form->addItem($skill);
             }
         }
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isModeActive()

ilObjectServiceSettingsGUI::isModeActive ( $a_mode )

protected

Check if specific mode is active.

Parameters

type $a_mode

Returns: type

Definition at line 441 of file class.ilObjectServiceSettingsGUI.php.

References getModes().

Referenced by updateToolSettings().

     {
         return in_array($a_mode, $this->getModes());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateServiceSettingsForm()

static ilObjectServiceSettingsGUI::updateServiceSettingsForm	(		$a_obj_id,
		ilPropertyFormGUI	$form,
			$services
	)

static

Update service settings.

Parameters

int	$a_obj_id
ilPropertyFormGUI	$form
	string[]	$services

Returns: bool

Definition at line 283 of file class.ilObjectServiceSettingsGUI.php.

References ilObject\_getAllReferences(), ilCalendarSettings\_getInstance(), ilObject\_lookupType(), ilContainer\_writeContainerSetting(), array, ilPropertyFormGUI\getInput(), ilOrgUnitGlobalSettings\getInstance(), ilBadgeHandler\getInstance(), and ilMembershipNotifications\importFromForm().

Referenced by ilObjSessionGUI\saveObject(), ilObjGlossaryGUI\saveProperties(), ilObjWikiGUI\saveSettingsObject(), ilIndividualAssessmentSettingsGUI\update(), ilObjBookingPoolGUI\updateCustom(), ilObjExerciseGUI\updateCustom(), ilObjGroupGUI\updateObject(), ilObjCourseGUI\updateObject(), ilObjCategoryGUI\updateObject(), and ilObjSessionGUI\updateObject().

     {
         // 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));
             }
         }
         
         // extended user access
         if (in_array(self::ORGU_POSITION_ACCESS, $services)) {
             $position_settings = ilOrgUnitGlobalSettings::getInstance()->getObjectPositionSettingsByType(
                 ilObject::_lookupType($a_obj_id)
             );
             
             if ($position_settings->isActive() && $position_settings->isChangeableForObject()) {
                 $orgu_object_settings = new ilOrgUnitObjectPositionSetting($a_obj_id);
                 $orgu_object_settings->setActive(
                     (int) $form->getInput(self::ORGU_POSITION_ACCESS)
                 );
                 $orgu_object_settings->update();
             }
         }
 
         // skills
         if (in_array(self::SKILLS, $services)) {
             $skmg_set = new ilSetting("skmg");
             if ($skmg_set->get("enable_skmg")) {
                 include_once './Services/Container/classes/class.ilContainer.php';
                 ilContainer::_writeContainerSetting($a_obj_id, self::SKILLS, (int) $form->getInput(self::SKILLS));
             }
         }
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateToolSettings()

ilObjectServiceSettingsGUI::updateToolSettings ( )

protected

Update settings.

Definition at line 417 of file class.ilObjectServiceSettingsGUI.php.

References $form, $GLOBALS, ilCalendarSettings\_getInstance(), ilContainer\_writeContainerSetting(), editSettings(), getObjId(), isModeActive(), ilUtil\sendFailure(), and ilUtil\sendSuccess().

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