This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilObjectServiceSettingsGUI:

Public Member Functions
	__construct (ilObjectGUI $parent_gui, int $obj_id, array $modes)
	Constructor. More...

	executeCommand ()

	getModes ()
	Get active modes. More...

	getObjId ()
	Get obj id. More...

Static Public Member Functions
static	initServiceSettingsForm (int $obj_id, ilPropertyFormGUI $form, array $services)

static	updateServiceSettingsForm (int $obj_id, ilPropertyFormGUI $form, array $services)

Data Fields
const	CALENDAR_CONFIGURATION = 'cont_cal_configuration'

const	CALENDAR_VISIBILITY = 'cont_show_calendar'

const	CALENDAR_ACTIVATION = 'cont_activation_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'

const	FILTER = 'filter'

const	BOOKING = 'cont_bookings'

const	EXTERNAL_MAIL_PREFIX = 'mail_external_prefix'

Protected Member Functions
	cancel ()

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

	updateToolSettings ()
	Update settings. More...

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

Protected Attributes
ilCtrl	$ctrl

ilGlobalTemplateInterface	$main_tpl

ilLanguage	$lng

ilObjectGUI	$gui = null

array	$modes = []

int	$obj_id = 0

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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$

@ilCtrl_Calls ilObjectServiceSettingsGUI:

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

Constructor & Destructor Documentation

◆ __construct()

ilObjectServiceSettingsGUI::__construct	(	ilObjectGUI	$parent_gui,
		int	$obj_id,
		array	$modes
	)

Constructor.

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

    {
        global $DIC;
        $this->main_tpl = $DIC->ui()->mainTemplate();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC["lng"];
 
        $this->gui = $parent_gui;
        $this->modes = $DIC->refinery()->to()->listOf(
            $DIC->refinery()->kindlyTo()->string()
        )->transform($modes);
 
        $this->obj_id = $obj_id;
    }

References $DIC, $modes, $obj_id, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

◆ cancel()

ilObjectServiceSettingsGUI::cancel ( )

protected

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

                               : void
    {
        $this->ctrl->returnToParent($this);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ editSettings()

ilObjectServiceSettingsGUI::editSettings ( ilPropertyFormGUI $form = null )

protected

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

Parameters

ilPropertyFormGUI $form

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

                                                                   : void
    {
        if (!$form instanceof ilPropertyFormGUI) {
            // TODO: cant find initSettingsForm, is editSettings ever called?
            $form = $this->initSettingsForm();
        }
        $this->main_tpl->setContent($form->getHTML());
    }

References ilPropertyFormGUI\getHTML().

Here is the call graph for this function:

◆ executeCommand()

ilObjectServiceSettingsGUI::executeCommand ( )

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

                                    : void
    {
        $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd('editSettings');
        $this->$cmd();
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ getModes()

ilObjectServiceSettingsGUI::getModes ( )

Get active modes.

Returns: string[]

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

                              : array
    {
        return $this->modes;
    }

◆ getObjId()

ilObjectServiceSettingsGUI::getObjId ( )

Get obj id.

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

                              : int
    {
        return $this->obj_id;
    }

◆ initServiceSettingsForm()

static ilObjectServiceSettingsGUI::initServiceSettingsForm	(	int	$obj_id,
		ilPropertyFormGUI	$form,
		array	$services
	)

static

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

     : ilPropertyFormGUI {
        global $DIC;
 
        $ilSetting = $DIC->settings();
        $ilCtrl = $DIC->ctrl();
        $lng = $DIC->language();
 
        $lng->loadLanguageModule("obj");
 
        // info tab
        if (in_array(self::INFO_TAB_VISIBILITY, $services)) {
            $info = new ilCheckboxInputGUI($lng->txt('obj_tool_setting_info_tab'), self::INFO_TAB_VISIBILITY);
            $info->setValue("1");
            $info->setChecked((bool) ilContainer::_lookupContainerSetting(
                $obj_id,
                self::INFO_TAB_VISIBILITY
            ));
            //$info->setOptionTitle($lng->txt('obj_tool_setting_info_tab'));
            $info->setInfo($lng->txt('obj_tool_setting_info_tab_info'));
            $form->addItem($info);
        }
 
        // calendar
        if (in_array(self::CALENDAR_CONFIGURATION, $services)) {
            $settings = ilCalendarSettings::_getInstance();
            if ($settings->isEnabled()) {
                $active = new ilCheckboxInputGUI(
                    $lng->txt('obj_tool_setting_calendar_active'),
                    self::CALENDAR_ACTIVATION
                );
                $active->setValue("1");
                $active->setChecked(ilCalendarSettings::lookupCalendarActivated($obj_id));
                $active->setInfo($lng->txt('obj_tool_setting_calendar_active_info'));
 
                $visible = new ilCheckboxInputGUI(
                    $lng->txt('obj_tool_setting_calendar'),
                    self::CALENDAR_VISIBILITY
                );
                $visible->setValue("1");
                $visible->setChecked(ilCalendarSettings::lookupCalendarContentPresentationEnabled($obj_id));
                $visible->setInfo($lng->txt('obj_tool_setting_calendar_info'));
                $active->addSubItem($visible);
 
                $form->addItem($active);
            }
        }
 
        // news
        if (in_array(self::USE_NEWS, $services)) {
            $news = new ilCheckboxInputGUI($lng->txt('obj_tool_setting_use_news'), self::USE_NEWS);
            $news->setValue("1");
            $checked = (bool) ilContainer::_lookupContainerSetting(
                $obj_id,
                self::USE_NEWS
            );
            $news->setChecked($checked);
            $info = $lng->txt('obj_tool_setting_use_news_info');
            if ($checked) {
                $info .= " <a href='" . $ilCtrl->getLinkTargetByClass("ilcontainernewssettingsgui", "") .
                    "'>» " . $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($lng->txt('obj_tool_setting_news'), self::NEWS_VISIBILITY);
                $news->setValue("1");
                $news->setChecked((bool) ilContainer::_lookupContainerSetting(
                    $obj_id,
                    self::NEWS_VISIBILITY,
                    $ilSetting->get('block_activated_news')
                ));
                //$news->setOptionTitle($lng->txt('obj_tool_setting_news'));
                $news->setInfo($lng->txt('obj_tool_setting_news_info'));
                $form->addItem($news);
 
                if (in_array(ilObject::_lookupType($obj_id), array('crs', 'grp'))) {
                    $refs = ilObject::_getAllReferences($obj_id);
                    $ref_id = array_pop($refs);
 
                    ilMembershipNotifications::addToSettingsForm($ref_id, null, $news);
                }
            }
        }
 
        // (local) custom metadata
        if (in_array(self::CUSTOM_METADATA, $services)) {
            $md = new ilCheckboxInputGUI($lng->txt('obj_tool_setting_custom_metadata'), self::CUSTOM_METADATA);
            $md->setInfo($lng->txt('obj_tool_setting_custom_metadata_info'));
            $md->setValue("1");
            $md->setChecked((bool) ilContainer::_lookupContainerSetting(
                $obj_id,
                self::CUSTOM_METADATA
            ));
            $form->addItem($md);
        }
 
        // tag cloud
        if (in_array(self::TAG_CLOUD, $services)) {
            $tags_active = new ilSetting("tags");
            if ($tags_active->get("enable")) {
                $tag = new ilCheckboxInputGUI($lng->txt('obj_tool_setting_tag_cloud'), self::TAG_CLOUD);
                $tag->setInfo($lng->txt('obj_tool_setting_tag_cloud_info'));
                $tag->setValue("1");
                $tag->setChecked((bool) ilContainer::_lookupContainerSetting(
                    $obj_id,
                    self::TAG_CLOUD
                ));
                $form->addItem($tag);
            }
        }
 
        // taxonomies
        if (in_array(self::TAXONOMIES, $services)) {
            $tax = new ilCheckboxInputGUI($lng->txt('obj_tool_setting_taxonomies'), self::TAXONOMIES);
            $tax->setInfo($lng->txt('obj_tool_setting_taxonomies_info'));
            $tax->setValue("1");
            $tax->setChecked((bool) ilContainer::_lookupContainerSetting(
                $obj_id,
                self::TAXONOMIES
            ));
            $form->addItem($tax);
        }
 
        // auto rating
        if (in_array(self::AUTO_RATING_NEW_OBJECTS, $services)) {
            $lng->loadLanguageModule("rating");
 
            // auto rating for new objects
            $rate = new ilCheckboxInputGUI($lng->txt('rating_new_objects_auto'), self::AUTO_RATING_NEW_OBJECTS);
            $rate->setValue("1");
            //$rate->setOptionTitle($lng->txt('rating_new_objects_auto'));
            $rate->setInfo($lng->txt('rating_new_objects_auto_info'));
            $rate->setChecked((bool) ilContainer::_lookupContainerSetting(
                $obj_id,
                self::AUTO_RATING_NEW_OBJECTS
            ));
            $form->addItem($rate);
        }
 
        // badges
        if (in_array(self::BADGES, $services)) {
            if (ilBadgeHandler::getInstance()->isActive()) {
                $bdg = new ilCheckboxInputGUI($lng->txt('obj_tool_setting_badges'), self::BADGES);
                $bdg->setInfo($lng->txt('obj_tool_setting_badges_info'));
                $bdg->setValue("1");
                $bdg->setChecked((bool) ilContainer::_lookupContainerSetting(
                    $obj_id,
                    self::BADGES
                ));
                $form->addItem($bdg);
            }
        }
        if (in_array(self::ORGU_POSITION_ACCESS, $services)) {
            $position_settings = ilOrgUnitGlobalSettings::getInstance()->getObjectPositionSettingsByType(
                ilObject::_lookupType($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(
                    ilOrgUnitGlobalSettings::getInstance()->isPositionAccessActiveForObject($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($lng->txt('obj_tool_setting_skills'), self::SKILLS);
                $skill->setInfo($lng->txt('obj_tool_setting_skills_info'));
                $skill->setValue("1");
                $skill->setChecked((bool) ilContainer::_lookupContainerSetting(
                    $obj_id,
                    self::SKILLS
                ));
                $form->addItem($skill);
            }
        }
 
        // filter
        if (in_array(self::FILTER, $services)) {
            $filter = new ilCheckboxInputGUI($lng->txt('obj_tool_setting_filter'), self::FILTER);
            $filter->setInfo($lng->txt('obj_tool_setting_filter_info'));
            $filter->setValue("1");
            $filter->setChecked((bool) ilContainer::_lookupContainerSetting(
                $obj_id,
                self::FILTER
            ));
            $form->addItem($filter);
 
            $filter_show_empty = new ilCheckboxInputGUI($lng->txt('obj_tool_setting_filter_empty'), "filter_show_empty");
            $filter_show_empty->setInfo($lng->txt('obj_tool_setting_filter_empty_info'));
            $filter_show_empty->setValue("1");
            $filter_show_empty->setChecked((bool) ilContainer::_lookupContainerSetting(
                $obj_id,
                "filter_show_empty"
            ));
            $filter->addSubItem($filter_show_empty);
        }
        // booking tool
        if (in_array(self::BOOKING, $services)) {
            $book = new ilCheckboxInputGUI($lng->txt('obj_tool_booking'), self::BOOKING);
            $book->setInfo($lng->txt('obj_tool_booking_info'));
            $book->setValue("1");
            $book->setChecked((bool) ilContainer::_lookupContainerSetting(
                $obj_id,
                self::BOOKING
            ));
            $form->addItem($book);
        }
 
        if (in_array(self::EXTERNAL_MAIL_PREFIX, $services)) {
            $externalMailPrefix = new ilTextInputGUI($lng->txt('obj_tool_ext_mail_subject_prefix'), self::EXTERNAL_MAIL_PREFIX);
            $externalMailPrefix->setMaxLength(255);
            $externalMailPrefix->setInfo($lng->txt('obj_tool_ext_mail_subject_prefix_info'));
            $externalMailPrefix->setValue(ilContainer::_lookupContainerSetting($obj_id, self::EXTERNAL_MAIL_PREFIX, ''));
            $form->addItem($externalMailPrefix);
        }
 
        return $form;
    }

References $lng, $obj_id, ilContainer\_lookupContainerSetting(), ilPropertyFormGUI\addItem(), and ilLanguage\txt().

Referenced by ilObjBookingPoolGUI\addExternalEditFormCustom(), ilIndividualAssessmentCommonSettingsGUI\addServiceSettingsToForm(), ilStudyProgrammeCommonSettingsGUI\addServiceSettingsToForm(), ilObjTestSettingsGeneralGUI\buildForm(), ilObjContentPageGUI\initEditCustomForm(), ilObjMediaPoolGUI\initEditCustomForm(), ilObjPortfolioTemplateGUI\initEditCustomForm(), ilObjCategoryGUI\initEditForm(), ilObjCourseGUI\initEditForm(), ilObjSessionGUI\initForm(), ilObjGroupGUI\initForm(), ilObjContentObjectGUI\initPropertiesForm(), ilObjFileBasedLMGUI\initSettingsForm(), and ilObjWikiGUI\initSettingsForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isModeActive()

ilObjectServiceSettingsGUI::isModeActive ( string $mode )

protected

Check if specific mode is active.

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

                                                 : bool
    {
        return in_array($mode, $this->getModes(), true);
    }

◆ updateServiceSettingsForm()

static ilObjectServiceSettingsGUI::updateServiceSettingsForm	(	int	$obj_id,
		ilPropertyFormGUI	$form,
		array	$services
	)

static

Parameters

string[] $services

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

                                                                                                           : bool
    {
        // info
        if (in_array(self::INFO_TAB_VISIBILITY, $services)) {
            ilContainer::_writeContainerSetting(
                $obj_id,
                self::INFO_TAB_VISIBILITY,
                $form->getInput(self::INFO_TAB_VISIBILITY)
            );
        }
 
        // calendar
        if (in_array(self::CALENDAR_CONFIGURATION, $services)) {
            if (ilCalendarSettings::_getInstance()->isEnabled()) {
                $active = $form->getInput(self::CALENDAR_ACTIVATION);
                $visible = $form->getInput(self::CALENDAR_VISIBILITY);
                ilContainer::_writeContainerSetting(
                    $obj_id,
                    self::CALENDAR_ACTIVATION,
                    $active
                );
                ilContainer::_writeContainerSetting(
                    $obj_id,
                    self::CALENDAR_VISIBILITY,
                    $active ? $visible : ""
                );
            }
        }
        // news
        if (in_array(self::USE_NEWS, $services)) {
            ilContainer::_writeContainerSetting($obj_id, self::USE_NEWS, $form->getInput(self::USE_NEWS));
        }
        if (in_array(self::NEWS_VISIBILITY, $services)) {
            ilContainer::_writeContainerSetting($obj_id, self::NEWS_VISIBILITY, $form->getInput(self::NEWS_VISIBILITY));
 
            if (in_array(ilObject::_lookupType($obj_id), array('crs', 'grp'))) {
                $refs = ilObject::_getAllReferences($obj_id);
                $ref_id = array_pop($refs);
 
                ilMembershipNotifications::importFromForm($ref_id, $form);
            }
        }
 
        // rating
        if (in_array(self::AUTO_RATING_NEW_OBJECTS, $services)) {
            ilContainer::_writeContainerSetting(
                $obj_id,
                self::AUTO_RATING_NEW_OBJECTS,
                $form->getInput(self::AUTO_RATING_NEW_OBJECTS)
            );
        }
 
        // taxonomies
        if (in_array(self::TAXONOMIES, $services)) {
            ilContainer::_writeContainerSetting($obj_id, self::TAXONOMIES, $form->getInput(self::TAXONOMIES));
        }
 
        // tag cloud
        if (in_array(self::TAG_CLOUD, $services)) {
            ilContainer::_writeContainerSetting($obj_id, self::TAG_CLOUD, $form->getInput(self::TAG_CLOUD));
        }
 
        // (local) custom metadata
        if (in_array(self::CUSTOM_METADATA, $services)) {
            ilContainer::_writeContainerSetting($obj_id, self::CUSTOM_METADATA, $form->getInput(self::CUSTOM_METADATA));
        }
 
        // badges
        if (in_array(self::BADGES, $services)) {
            if (ilBadgeHandler::getInstance()->isActive()) {
                ilContainer::_writeContainerSetting($obj_id, self::BADGES, $form->getInput(self::BADGES));
            }
        }
 
        // booking
        if (in_array(self::BOOKING, $services)) {
            ilContainer::_writeContainerSetting($obj_id, self::BOOKING, $form->getInput(self::BOOKING));
        }
 
        // extended user access
        if (in_array(self::ORGU_POSITION_ACCESS, $services)) {
            $position_settings = ilOrgUnitGlobalSettings::getInstance()->getObjectPositionSettingsByType(
                ilObject::_lookupType($obj_id)
            );
 
            if ($position_settings->isActive() && $position_settings->isChangeableForObject()) {
                $orgu_object_settings = new ilOrgUnitObjectPositionSetting($obj_id);
                $orgu_object_settings->setActive(
                    (bool) $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")) {
                ilContainer::_writeContainerSetting($obj_id, self::SKILLS, $form->getInput(self::SKILLS));
            }
        }
 
        // filter
        if (in_array(self::FILTER, $services)) {
            ilContainer::_writeContainerSetting($obj_id, self::FILTER, $form->getInput(self::FILTER));
            ilContainer::_writeContainerSetting($obj_id, "filter_show_empty", $form->getInput("filter_show_empty"));
        }
 
        if (in_array(self::EXTERNAL_MAIL_PREFIX, $services)) {
            ilContainer::_writeContainerSetting($obj_id, self::EXTERNAL_MAIL_PREFIX, $form->getInput(self::EXTERNAL_MAIL_PREFIX));
        }
 
        return true;
    }

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

Referenced by ilObjTestSettingsGeneralGUI\performSaveForm(), ilObjSessionGUI\saveObject(), ilObjGlossaryGUI\saveProperties(), ilObjFileBasedLMGUI\saveProperties(), ilObjContentObjectGUI\saveProperties(), ilIndividualAssessmentCommonSettingsGUI\saveSettings(), ilStudyProgrammeCommonSettingsGUI\saveSettings(), ilObjWikiGUI\saveSettingsObject(), ilObjExerciseGUI\updateCustom(), ilObjBookingPoolGUI\updateCustom(), ilObjContentPageGUI\updateCustom(), ilObjMediaPoolGUI\updateCustom(), ilObjPortfolioTemplateGUI\updateCustom(), ilObjCategoryGUI\updateObject(), ilObjCourseGUI\updateObject(), ilObjGroupGUI\updateObject(), and ilObjSessionGUI\updateObject().

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 486 of file class.ilObjectServiceSettingsGUI.php.

                                           : void
    {
        // TODO: cant find initSettingsForm, is updateToolSettings ever called?
        $form = $this->initSettingsForm();
        if ($form->checkInput()) {
            if (ilCalendarSettings::_getInstance()->isEnabled()) {
                if ($this->isModeActive(self::CALENDAR_VISIBILITY)) {
                    ilContainer::_writeContainerSetting($this->getObjId(), 'show_calendar', $form->getInput('calendar'));
                }
            }
            $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
            $this->ctrl->redirect($this);
        }
 
        $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('err_check_input'));
        $form->setValuesByPost();
        $this->editSettings($form);
    }