ilForumSettingsGUI Class Reference

Class ilForumSettingsGUI. More...

Inheritance diagram for ilForumSettingsGUI:

Collaboration diagram for ilForumSettingsGUI:

Public Member Functions
	__construct (private readonly ilObjForumGUI $parent_obj)
	getRefId ()
	executeCommand ()
	getCustomForm (ilPropertyFormGUI $a_form)
	settingsTabs ()
	getCustomValues (array &$a_values)
	updateCustomValues (ilPropertyFormGUI $a_form)
	showMembers ()
	saveEventsForUser ()
	enableAdminForceNoti ()
	disableAdminForceNoti ()
	enableHideUserToggleNoti ()
	disableHideUserToggleNoti ()
	getParticipants ()
	updateNotificationSettings ()

Private Member Functions
	initForcedForumNotification ()
	addAvailabilitySection (ilPropertyFormGUI $form)
	getUserNotificationTableData (array $user_ids)
	showMembersTable (array $moderators, array $admins, array $members, array $tutors)
	updateUserNotifications (bool $update_all_users=false)
	initNotificationSettingsForm ()

Private Attributes
readonly ilCtrlInterface	$ctrl
readonly ilGlobalTemplateInterface	$tpl
readonly ilLanguage	$lng
readonly ilSetting	$settings
readonly ilTabsGUI	$tabs
readonly ilAccessHandler	$access
readonly ilTree	$tree
readonly ILIAS HTTP GlobalHttpState	$http
ilForumNotification	$forumNotificationObj
ilPropertyFormGUI	$notificationSettingsForm = null
readonly int	$ref_id
readonly ilObjectService	$obj_service
readonly ILIAS DI Container	$dic
readonly ilErrorHandling	$error
readonly ILIAS UI Factory	$ui_factory

Additional Inherited Members
Data Fields inherited from ilForumObjectConstants
const	OBJ_TYPE = 'frm'
const	UI_TAB_ID_INFO = 'info_short'
const	UI_TAB_ID_SETTINGS = 'settings'
const	UI_TAB_ID_MODERATORS = 'frm_moderators'
const	UI_TAB_ID_THREADS = 'forums_threads'
const	UI_TAB_ID_STATS = 'frm_statistics'
const	UI_TAB_ID_EXPORT = 'export'
const	UI_TAB_ID_PERMISSIONS = 'perm_settings'
const	UI_SUB_TAB_ID_BASIC_SETTINGS = 'general'
const	UI_SUB_TAB_ID_NOTIFICATIONS = 'notifications'
const	UI_SUB_TAB_ID_NEWS = 'cont_news_settings'
const	UI_SUB_TAB_ID_STYLE = 'cont_style'
const	UI_CMD_COPAGE_DOWNLOAD_FILE = 'downloadFile'
const	UI_CMD_COPAGE_DISPLAY_FULLSCREEN = 'displayMediaFullscreen'
const	UI_CMD_COPAGE_DOWNLOAD_PARAGRAPH = 'download_paragraph'

Detailed Description

Class ilForumSettingsGUI.

Author

Nadia Matuschek nmatu.nosp@m.sche.nosp@m.k@dat.nosp@m.abay.nosp@m..de ilForumSettingsGUI: ilObjectContentStyleSettingsGUI

Definition at line 26 of file class.ilForumSettingsGUI.php.

Constructor & Destructor Documentation

__construct()

ilForumSettingsGUI::__construct

(

private readonly ilObjForumGUI

$parent_obj

)

Definition at line 44 of file class.ilForumSettingsGUI.php.

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), and ILIAS\Repository\tabs().

    {
        global $DIC;

        $this->dic = $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->lng = $DIC->language();
        $this->settings = $DIC->settings();
        $this->tabs = $DIC->tabs();
        $this->access = $DIC->access();
        $this->tree = $DIC->repositoryTree();
        $this->obj_service = $this->dic->object();
        $this->ref_id = $this->parent_obj->getObject()->getRefId();
        $this->http = $DIC->http();
        $this->ui_factory = $DIC->ui()->factory();
        $this->error = $DIC['ilErr'];

        $this->lng->loadLanguageModule('style');
        $this->lng->loadLanguageModule('cont');
    }

Here is the call graph for this function:

Member Function Documentation

addAvailabilitySection()

ilForumSettingsGUI::addAvailabilitySection ( ilPropertyFormGUI  $form )

private

Definition at line 93 of file class.ilForumSettingsGUI.php.

References ilPropertyFormGUI\addItem(), and ILIAS\Repository\lng().

Referenced by getCustomForm().

                                                                    : void
    {
        $section = new ilFormSectionHeaderGUI();
        $section->setTitle($this->lng->txt('rep_activation_availability'));
        $form->addItem($section);

        $online = new ilCheckboxInputGUI($this->lng->txt('rep_activation_online'), 'activation_online');
        $online->setInfo($this->lng->txt('frm_activation_online_info'));
        $form->addItem($online);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

disableAdminForceNoti()

ilForumSettingsGUI::disableAdminForceNoti

(

)

Definition at line 554 of file class.ilForumSettingsGUI.php.

References $user_id, ILIAS\Repository\access(), ILIAS\Repository\lng(), ilForumNotification\setUserId(), and showMembers().

                                           : void
    {
        if (!$this->access->checkAccess('write', '', $this->parent_obj->getRefId())) {
            $this->error->raiseError(
                $this->lng->txt('msg_no_perm_read'),
                $this->error->MESSAGE
            );
        }

        $user_ids = [];
        if ($this->dic->http()->wrapper()->post()->has('user_id')) {
            $user_ids = $this->dic->http()->wrapper()->post()->retrieve(
                'user_id',
                $this->dic->refinery()->kindlyTo()->listOf($this->dic->refinery()->kindlyTo()->int())
            );
        }

        if (count($user_ids) === 0) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('time_limit_no_users_selected'));
        } else {
            $frm_noti = new ilForumNotification($this->parent_obj->getObject()->getRefId());

            foreach ($user_ids as $user_id) {
                $frm_noti->setUserId((int) $user_id);
                $is_enabled = $frm_noti->isAdminForceNotification();

                if ($is_enabled) {
                    $frm_noti->deleteAdminForce();
                }
            }

            $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'));
        }

        $this->showMembers();
    }

Here is the call graph for this function:

disableHideUserToggleNoti()

ilForumSettingsGUI::disableHideUserToggleNoti

(

)

Definition at line 632 of file class.ilForumSettingsGUI.php.

References $user_id, ILIAS\Repository\access(), ILIAS\Repository\lng(), ilForumNotification\setUserId(), and showMembers().

                                               : void
    {
        if (!$this->access->checkAccess('write', '', $this->parent_obj->getRefId())) {
            $this->error->raiseError(
                $this->lng->txt('msg_no_perm_read'),
                $this->error->MESSAGE
            );
        }

        $user_ids = [];
        if ($this->dic->http()->wrapper()->post()->has('user_id')) {
            $user_ids = $this->dic->http()->wrapper()->post()->retrieve(
                'user_id',
                $this->dic->refinery()->kindlyTo()->listOf($this->dic->refinery()->kindlyTo()->int())
            );
        }

        if (count($user_ids) === 0) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('time_limit_no_users_selected'));
        } else {
            $frm_noti = new ilForumNotification($this->parent_obj->getObject()->getRefId());

            foreach ($user_ids as $user_id) {
                $frm_noti->setUserId((int) $user_id);
                $frm_noti->setUserToggle(false);
                $is_enabled = $frm_noti->isAdminForceNotification();
                if ($is_enabled) {
                    $frm_noti->updateUserToggle();
                } else {
                    $frm_noti->setAdminForce(true);
                    $frm_noti->insertAdminForce();
                }
            }

            $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'));
        }

        $this->showMembers();
    }

Here is the call graph for this function:

enableAdminForceNoti()

ilForumSettingsGUI::enableAdminForceNoti

(

)

Definition at line 515 of file class.ilForumSettingsGUI.php.

References $user_id, ILIAS\Repository\access(), ILIAS\Repository\lng(), ilForumNotification\setUserId(), and showMembers().

                                          : void
    {
        if (!$this->access->checkAccess('write', '', $this->parent_obj->getRefId())) {
            $this->error->raiseError(
                $this->lng->txt('msg_no_perm_read'),
                $this->error->MESSAGE
            );
        }

        $user_ids = [];
        if ($this->dic->http()->wrapper()->post()->has('user_id')) {
            $user_ids = $this->dic->http()->wrapper()->post()->retrieve(
                'user_id',
                $this->dic->refinery()->kindlyTo()->listOf($this->dic->refinery()->kindlyTo()->int())
            );
        }

        if (count($user_ids) === 0) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('time_limit_no_users_selected'), true);
        } else {
            $frm_noti = new ilForumNotification($this->parent_obj->getObject()->getRefId());

            foreach ($user_ids as $user_id) {
                $frm_noti->setUserId((int) $user_id);
                $frm_noti->setUserToggle(false);
                $is_enabled = $frm_noti->isAdminForceNotification();

                if (!$is_enabled) {
                    $frm_noti->setAdminForce(true);
                    $frm_noti->insertAdminForce();
                }
            }

            $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'));
        }

        $this->showMembers();
    }

Here is the call graph for this function:

enableHideUserToggleNoti()

ilForumSettingsGUI::enableHideUserToggleNoti

(

)

Definition at line 591 of file class.ilForumSettingsGUI.php.

References $user_id, ILIAS\Repository\access(), ILIAS\Repository\lng(), ilForumNotification\setUserId(), and showMembers().

                                              : void
    {
        if (!$this->access->checkAccess('write', '', $this->parent_obj->getRefId())) {
            $this->error->raiseError(
                $this->lng->txt('msg_no_perm_read'),
                $this->error->MESSAGE
            );
        }

        $user_ids = [];
        if ($this->dic->http()->wrapper()->post()->has('user_id')) {
            $user_ids = $this->dic->http()->wrapper()->post()->retrieve(
                'user_id',
                $this->dic->refinery()->kindlyTo()->listOf($this->dic->refinery()->kindlyTo()->int())
            );
        }

        if (count($user_ids) === 0) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('time_limit_no_users_selected'));
        } else {
            $frm_noti = new ilForumNotification($this->parent_obj->getObject()->getRefId());

            foreach ($user_ids as $user_id) {
                $frm_noti->setUserId((int) $user_id);
                $frm_noti->setUserToggle(true);
                $is_enabled = $frm_noti->isAdminForceNotification();

                if (!$is_enabled) {
                    $frm_noti->setAdminForce(true);
                    $frm_noti->insertAdminForce();
                } else {
                    $frm_noti->updateUserToggle();
                }
            }

            $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'));
        }

        $this->showMembers();
    }

Here is the call graph for this function:

executeCommand()

ilForumSettingsGUI::executeCommand

(

)

Definition at line 78 of file class.ilForumSettingsGUI.php.

References ILIAS\Repository\ctrl(), and settingsTabs().

                                    : void
    {
        $cmd = $this->ctrl->getCmd();

        switch (true) {
            case method_exists($this, $cmd):
                $this->settingsTabs();
                $this->{$cmd}();
                break;

            default:
                $this->ctrl->redirect($this->parent_obj);
        }
    }

Here is the call graph for this function:

getCustomForm()

ilForumSettingsGUI::getCustomForm

(

ilPropertyFormGUI

$a_form

)

Definition at line 104 of file class.ilForumSettingsGUI.php.

References addAvailabilitySection(), ilPropertyFormGUI\addItem(), ilRadioGroupInputGUI\addOption(), ilForumProperties\isFileUploadGloballyAllowed(), ILIAS\Repository\lng(), ilFormPropertyGUI\setInfo(), ILIAS\Repository\settings(), settingsTabs(), ilPropertyFormGUI\setTitle(), ILIAS\Repository\tabs(), ilForumProperties\VIEW_DATE, ilForumProperties\VIEW_DATE_ASC, ilForumProperties\VIEW_DATE_DESC, and ilForumProperties\VIEW_TREE.

                                                            : void
    {
        $this->settingsTabs();
        $this->tabs->activateSubTab(self::UI_SUB_TAB_ID_BASIC_SETTINGS);
        $a_form->setTitle($this->lng->txt('frm_settings_form_header'));

        $this->addAvailabilitySection($a_form);

        $presentationHeader = new ilFormSectionHeaderGUI();
        $presentationHeader->setTitle($this->lng->txt('settings_presentation_header'));
        $a_form->addItem($presentationHeader);

        $this->obj_service->commonSettings()->legacyForm($a_form, $this->parent_obj->getObject())->addTileImage();

        $rg_pro = new ilRadioGroupInputGUI($this->lng->txt('frm_default_view'), 'default_view');
        $option_view_by_posts = new ilRadioOption($this->lng->txt('sort_by_posts'), (string) ilForumProperties::VIEW_TREE);
        $option_view_by_posts->setInfo($this->lng->txt('sort_by_posts_desc'));
        $rg_pro->addOption($option_view_by_posts);
        $option_view_by_date = new ilRadioOption($this->lng->txt('sort_by_date'), (string) ilForumProperties::VIEW_DATE);
        $option_view_by_date->setInfo($this->lng->txt('sort_by_date_desc'));
        $sub_group = new ilRadioGroupInputGUI('', 'default_view_by_date');
        $sub_group->addOption(new ilRadioOption($this->lng->txt('ascending_order'), (string) ilForumProperties::VIEW_DATE_ASC));
        $sub_group->addOption(new ilRadioOption($this->lng->txt('descending_order'), (string) ilForumProperties::VIEW_DATE_DESC));

        $option_view_by_date->addSubItem($sub_group);
        $rg_pro->addOption($option_view_by_date);
        $a_form->addItem($rg_pro);

        $userFunctionsHeader = new ilFormSectionHeaderGUI();
        $userFunctionsHeader->setTitle($this->lng->txt('frm_settings_user_functions_header'));
        $a_form->addItem($userFunctionsHeader);

        $frm_subject = new ilRadioGroupInputGUI($this->lng->txt('frm_subject_setting'), 'subject_setting');
        $frm_subject->addOption(new ilRadioOption($this->lng->txt('preset_subject'), 'preset_subject'));
        $frm_subject->addOption(new ilRadioOption($this->lng->txt('add_re_to_subject'), 'add_re_to_subject'));
        $frm_subject->addOption(new ilRadioOption($this->lng->txt('empty_subject'), 'empty_subject'));
        $a_form->addItem($frm_subject);

        $cb_prop = new ilCheckboxInputGUI($this->lng->txt('enable_thread_ratings'), 'thread_rating');
        $cb_prop->setValue('1');
        $cb_prop->setInfo($this->lng->txt('enable_thread_ratings_info'));
        $a_form->addItem($cb_prop);

        if (!ilForumProperties::isFileUploadGloballyAllowed()) {
            $frm_upload = new ilCheckboxInputGUI($this->lng->txt('file_upload_allowed'), 'file_upload_allowed');
            $frm_upload->setValue('1');
            $frm_upload->setInfo($this->lng->txt('allow_file_upload_desc'));
            $a_form->addItem($frm_upload);
        }

        $moderatorFunctionsHeader = new ilFormSectionHeaderGUI();
        $moderatorFunctionsHeader->setTitle($this->lng->txt('frm_settings_mod_functions_header'));
        $a_form->addItem($moderatorFunctionsHeader);

        $cb_prop = new ilCheckboxInputGUI($this->lng->txt('activate_new_posts'), 'post_activation');
        $cb_prop->setValue('1');
        $cb_prop->setInfo($this->lng->txt('post_activation_desc'));
        $a_form->addItem($cb_prop);

        $cb_prop = new ilCheckboxInputGUI($this->lng->txt('mark_moderator_posts'), 'mark_mod_posts');
        $cb_prop->setValue('1');
        $cb_prop->setInfo($this->lng->txt('mark_moderator_posts_desc'));
        $a_form->addItem($cb_prop);

        if ($this->settings->get('enable_anonymous_fora') || $this->settings->get('enable_fora_statistics')) {
            $privacyHeader = new ilFormSectionHeaderGUI();
            $privacyHeader->setTitle($this->lng->txt('frm_settings_privacy_header'));
            $a_form->addItem($privacyHeader);
        }

        if ($this->settings->get('enable_fora_statistics')) {
            $cb_prop = new ilCheckboxInputGUI($this->lng->txt('frm_statistics_enabled'), 'statistics_enabled');
            $cb_prop->setValue('1');
            $cb_prop->setInfo($this->lng->txt('frm_statistics_enabled_desc'));
            $a_form->addItem($cb_prop);
        }

        if ($this->settings->get('enable_anonymous_fora') || $this->parent_obj->objProperties->isAnonymized()) {
            $cb_prop = new ilCheckboxInputGUI($this->lng->txt('frm_anonymous_posting'), 'anonymized');
            $cb_prop->setValue('1');
            $cb_prop->setInfo($this->lng->txt('frm_anonymous_posting_desc'));
            $a_form->addItem($cb_prop);
        }
    }

Here is the call graph for this function:

getCustomValues()

ilForumSettingsGUI::getCustomValues

(

array &

$a_values

)

Definition at line 251 of file class.ilForumSettingsGUI.php.

References ilForumProperties\VIEW_DATE, ilForumProperties\VIEW_DATE_ASC, ilForumProperties\VIEW_DATE_DESC, and ilForumProperties\VIEW_TREE.

                                                     : void
    {
        $a_values['anonymized'] = $this->parent_obj->objProperties->isAnonymized();
        $a_values['statistics_enabled'] = $this->parent_obj->objProperties->isStatisticEnabled();
        $a_values['post_activation'] = $this->parent_obj->objProperties->isPostActivationEnabled();
        $a_values['subject_setting'] = $this->parent_obj->objProperties->getSubjectSetting();
        $a_values['mark_mod_posts'] = $this->parent_obj->objProperties->getMarkModeratorPosts();
        $a_values['thread_rating'] = $this->parent_obj->objProperties->isIsThreadRatingEnabled();

        $default_view_value = $this->parent_obj->objProperties->getDefaultView();
        if (in_array($default_view_value, [
            ilForumProperties::VIEW_TREE,
            ilForumProperties::VIEW_DATE,
            ilForumProperties::VIEW_DATE_ASC,
            ilForumProperties::VIEW_DATE_DESC
        ], true)) {
            if (in_array($default_view_value, [
                ilForumProperties::VIEW_DATE_ASC,
                ilForumProperties::VIEW_DATE_DESC
            ], true)) {
                $default_view_by_date = $default_view_value;
                $default_view = ilForumProperties::VIEW_DATE;
            } else {
                $default_view = $default_view_value;
            }
        } else {
            $default_view = ilForumProperties::VIEW_TREE;
        }

        $a_values['default_view'] = $default_view;
        if (isset($default_view_by_date)) {
            $a_values['default_view_by_date'] = $default_view_by_date;
        }
        $a_values['file_upload_allowed'] = $this->parent_obj->objProperties->getFileUploadAllowed();

        $object = $this->parent_obj->getObject();
        $a_values['activation_online'] = !$object->getOfflineStatus();
    }

getParticipants()

ilForumSettingsGUI::getParticipants

(

)

Definition at line 672 of file class.ilForumSettingsGUI.php.

References ilCourseParticipants\_getInstanceByObjId(), ilGroupParticipants\_getInstanceByObjId(), ilObjectFactory\getInstanceByRefId(), and ILIAS\Repository\lng().

Referenced by saveEventsForUser(), showMembers(), and updateUserNotifications().

                                     : ilParticipants
    {
        if (!$this->parent_obj->isParentObjectCrsOrGrp()) {
            $this->error->raiseError(
                $this->lng->txt('msg_no_perm_read'),
                $this->error->MESSAGE
            );
        }

        $grp_ref_id = $this->tree->checkForParentType($this->parent_obj->getObject()->getRefId(), 'grp');
        if ($grp_ref_id > 0) {
            $parent_obj = ilObjectFactory::getInstanceByRefId($grp_ref_id);
            return ilGroupParticipants::_getInstanceByObjId($parent_obj->getId());
        }

        $crs_ref_id = $this->tree->checkForParentType($this->parent_obj->getObject()->getRefId(), 'crs');
        $parent_obj = ilObjectFactory::getInstanceByRefId($crs_ref_id);

        return ilCourseParticipants::_getInstanceByObjId($parent_obj->getId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRefId()

ilForumSettingsGUI::getRefId

(

)

Definition at line 67 of file class.ilForumSettingsGUI.php.

References $ref_id.

Referenced by ilForumNotificationTableGUI\__construct().

                              : int
    {
        return $this->ref_id;
    }

Here is the caller graph for this function:

getUserNotificationTableData()

ilForumSettingsGUI::getUserNotificationTableData ( array  $user_ids )

private

Parameters

int[]

$user_ids

Returns

array

Definition at line 422 of file class.ilForumSettingsGUI.php.

References $user_id, ilObjUser\_lookupLogin(), ilObjUser\_lookupName(), and ilLegacyFormElementsUtil\formCheckbox().

Referenced by showMembers().

                                                                  : array
    {
        $counter = 0;
        $users = [];
        foreach ($user_ids as $user_id) {
            $forced_events = $this->forumNotificationObj->getForcedEventsObjectByUserId($user_id);

            $users[$counter]['user_id'] = ilLegacyFormElementsUtil::formCheckbox(false, 'user_id[]', (string) $user_id);
            $users[$counter]['login'] = ilObjUser::_lookupLogin($user_id);
            $name = ilObjUser::_lookupName($user_id);
            $users[$counter]['firstname'] = $name['firstname'];
            $users[$counter]['lastname'] = $name['lastname'];
            $users[$counter]['user_toggle_noti'] = $forced_events->getUserToggle();
            $users[$counter]['notification_id'] = $forced_events->getNotificationId();
            $users[$counter]['interested_events'] = $forced_events->getInterestedEvents();
            $users[$counter]['usr_id_events'] = $user_id;
            $users[$counter]['forum_id'] = $forced_events->getForumId();

            $counter++;
        }
        return $users;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initForcedForumNotification()

ilForumSettingsGUI::initForcedForumNotification ( )

private

Definition at line 72 of file class.ilForumSettingsGUI.php.

References ilForumNotification\readAllForcedEvents().

Referenced by showMembers().

                                                  : void
    {
        $this->forumNotificationObj = new ilForumNotification($this->parent_obj->getObject()->getRefId());
        $this->forumNotificationObj->readAllForcedEvents();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initNotificationSettingsForm()

ilForumSettingsGUI::initNotificationSettingsForm ( )

private

Definition at line 724 of file class.ilForumSettingsGUI.php.

References ilRadioOption\addSubItem(), ilForumNotificationEvents\CENSORED, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), null, ilForumNotificationEvents\POST_DELETED, ilForumNotificationEvents\THREAD_DELETED, ilForumNotificationEvents\UNCENSORED, and ilForumNotificationEvents\UPDATED.

Referenced by showMembers(), and updateNotificationSettings().

                                                   : bool
    {
        if (null === $this->notificationSettingsForm) {
            $form = new ilPropertyFormGUI();
            $form->setFormAction($this->ctrl->getFormAction($this, 'updateNotificationSettings'));
            $form->setTitle($this->lng->txt('forums_notification_settings'));

            $radio_grp = new ilRadioGroupInputGUI('', 'notification_type');
            $radio_grp->setValue('default');

            $opt_default = new ilRadioOption($this->lng->txt("user_decides_notification"), 'default');
            $opt_0 = new ilRadioOption($this->lng->txt("settings_for_all_members"), 'all_users');
            $opt_1 = new ilRadioOption($this->lng->txt("settings_per_users"), 'per_user');

            $radio_grp->addOption($opt_default);
            $radio_grp->addOption($opt_0);
            $radio_grp->addOption($opt_1);

            $chb_2 = new ilCheckboxInputGUI($this->lng->txt('user_toggle_noti'), 'usr_toggle');
            $chb_2->setValue('1');

            $opt_0->addSubItem($chb_2);

            $cb_grp = new ilCheckboxGroupInputGUI($this->lng->txt('notification_settings'), 'notification_events');

            $notify_modified = new ilCheckboxOption($this->lng->txt('notify_modified'), (string) ilForumNotificationEvents::UPDATED);
            $cb_grp->addOption($notify_modified);

            $notify_censored = new ilCheckboxOption($this->lng->txt('notify_censored'), (string) ilForumNotificationEvents::CENSORED);
            $cb_grp->addOption($notify_censored);

            $notify_uncensored = new ilCheckboxOption($this->lng->txt('notify_uncensored'), (string) ilForumNotificationEvents::UNCENSORED);
            $cb_grp->addOption($notify_uncensored);

            $notify_post_deleted = new ilCheckboxOption($this->lng->txt('notify_post_deleted'), (string) ilForumNotificationEvents::POST_DELETED);
            $cb_grp->addOption($notify_post_deleted);

            $notify_thread_deleted = new ilCheckboxOption($this->lng->txt('notify_thread_deleted'), (string) ilForumNotificationEvents::THREAD_DELETED);
            $cb_grp->addOption($notify_thread_deleted);
            $opt_0->addSubItem($cb_grp);

            $form->addItem($radio_grp);

            $form->addCommandButton('updateNotificationSettings', $this->lng->txt('save'));

            $this->notificationSettingsForm = $form;

            return false;
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveEventsForUser()

ilForumSettingsGUI::saveEventsForUser

(

)

Definition at line 461 of file class.ilForumSettingsGUI.php.

References $lng, $ui_factory, ilForum\_getModerators(), ILIAS\Repository\access(), ilForumNotificationEventsFormGUI\build(), ILIAS\Repository\ctrl(), ilForumNotificationEvents\DEACTIVATED, getParticipants(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), null, ilForumNotification\setUserId(), and showMembers().

                                       : void
    {
        if (!$this->access->checkAccess('write', '', $this->parent_obj->getRefId())) {
            $this->error->raiseError(
                $this->lng->txt('msg_no_perm_read'),
                $this->error->MESSAGE
            );
        }

        $events_form_builder = new ilForumNotificationEventsFormGUI(
            $this->ctrl->getFormAction($this, 'saveEventsForUser'),
            null,
            $this->ui_factory,
            $this->lng
        );

        if ($this->http->request()->getMethod() === 'POST') {
            $form = $events_form_builder->build()->withRequest($this->http->request());
            $formData = $form->getData();

            $interested_events = ilForumNotificationEvents::DEACTIVATED;

            foreach ($events_form_builder->getValidEvents() as $event) {
                $interested_events += isset($formData[$event]) && $formData[$event] ? $events_form_builder->getValueForEvent(
                    $event
                ) : 0;
            }

            if (isset($formData['hidden_value']) && $formData['hidden_value']) {
                $hidden_value = json_decode($formData['hidden_value'], false, 512, JSON_THROW_ON_ERROR);

                $oParticipants = $this->getParticipants();
                $moderator_ids = ilForum::_getModerators($this->parent_obj->getObject()->getRefId());
                $admin_ids = $oParticipants->getAdmins();
                $member_ids = $oParticipants->getMembers();
                $tutor_ids = $oParticipants->getTutors();

                $valid_usr_ids = array_unique(array_merge($moderator_ids, $admin_ids, $member_ids, $tutor_ids));

                if (in_array($hidden_value->usr_id, $valid_usr_ids)) {
                    $frm_noti = new ilForumNotification($this->parent_obj->getRefId());
                    $frm_noti->setUserId($hidden_value->usr_id);
                    $frm_noti->setForumId($this->parent_obj->getObject()->getId());
                    $frm_noti->setInterestedEvents($interested_events);
                    $frm_noti->updateInterestedEvents();
                }
            }
        }

        $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'), true);

        $this->showMembers();
    }

Here is the call graph for this function:

settingsTabs()

ilForumSettingsGUI::settingsTabs

(

)

Definition at line 189 of file class.ilForumSettingsGUI.php.

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\settings(), and ILIAS\Repository\tabs().

Referenced by executeCommand(), getCustomForm(), and ilObjForumGUI\getSafePostCommands().

                                  : bool
    {
        $this->tabs->addSubTabTarget(
            self::UI_SUB_TAB_ID_BASIC_SETTINGS,
            $this->ctrl->getLinkTarget($this->parent_obj, 'edit'),
            '',
            [strtolower(ilObjForumGUI::class)]
        );

        if ($this->settings->get('forum_notification') > 0) {
            // check if there a parent-node is a grp or crs
            $grp_ref_id = $this->tree->checkForParentType($this->parent_obj->getRefId(), 'grp');
            $crs_ref_id = $this->tree->checkForParentType($this->parent_obj->getRefId(), 'crs');

            #show member-tab for notification if forum-notification is enabled in administration
            if (($grp_ref_id > 0 || $crs_ref_id > 0) && $this->access->checkAccess(
                'write',
                '',
                $this->parent_obj->getRefId()
            )) {
                $cmd = '';
                if ($this->dic->http()->wrapper()->query()->has('cmd')) {
                    $cmd = $this->dic->http()->wrapper()->query()->retrieve(
                        'cmd',
                        $this->dic->refinery()->kindlyTo()->string()
                    );
                }
                $mem_active = ['showMembers', 'forums_notification_settings'];
                $force_mem_active = false;
                if (in_array($cmd, $mem_active, true)) {
                    $force_mem_active = true;
                }
                $this->tabs->addSubTabTarget(
                    self::UI_SUB_TAB_ID_NOTIFICATIONS,
                    $this->ctrl->getLinkTarget($this, 'showMembers'),
                    '',
                    [strtolower(self::class)],
                    '',
                    $force_mem_active
                );
            }
        }

        $this->tabs->addSubTabTarget(
            self::UI_SUB_TAB_ID_NEWS,
            $this->ctrl->getLinkTargetByClass(ilContainerNewsSettingsGUI::class),
            '',
            [strtolower(ilContainerNewsSettingsGUI::class)]
        );

        $this->tabs->addSubTabTarget(
            self::UI_SUB_TAB_ID_STYLE,
            $this->ctrl->getLinkTargetByClass(strtolower(ilObjectContentStyleSettingsGUI::class), ""),
            '',
            [strtolower(ilObjectContentStyleSettingsGUI::class)]
        );

        $this->tabs->activateTab(self::UI_TAB_ID_SETTINGS);

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showMembers()

ilForumSettingsGUI::showMembers

(

)

Definition at line 342 of file class.ilForumSettingsGUI.php.

References ilForum\_getModerators(), ILIAS\Repository\access(), ilForumNotificationEvents\CENSORED, getParticipants(), getUserNotificationTableData(), initForcedForumNotification(), initNotificationSettingsForm(), ILIAS\Repository\lng(), ilForumNotificationEvents\POST_DELETED, ilForumNotification\setAdminForce(), showMembersTable(), ilForumNotificationEvents\THREAD_DELETED, ilForumNotificationEvents\UNCENSORED, and ilForumNotificationEvents\UPDATED.

Referenced by disableAdminForceNoti(), disableHideUserToggleNoti(), enableAdminForceNoti(), enableHideUserToggleNoti(), saveEventsForUser(), and updateNotificationSettings().

                                 : void
    {
        if (!$this->access->checkAccess('write', '', $this->parent_obj->getRefId())) {
            $this->error->raiseError(
                $this->lng->txt('msg_no_perm_read'),
                $this->error->MESSAGE
            );
        }

        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.forums_members_list.html', 'components/ILIAS/Forum');

        // instantiate the property form
        if (!$this->initNotificationSettingsForm()) {
            // if the form was just created set the values fetched from database
            $interested_events = $this->parent_obj->objProperties->getInterestedEvents();

            $form_events = [];
            if (($interested_events & ilForumNotificationEvents::UPDATED) !== 0) {
                $form_events[] = ilForumNotificationEvents::UPDATED;
            }

            if (($interested_events & ilForumNotificationEvents::CENSORED) !== 0) {
                $form_events[] = ilForumNotificationEvents::CENSORED;
            }

            if (($interested_events & ilForumNotificationEvents::UNCENSORED) !== 0) {
                $form_events[] = ilForumNotificationEvents::UNCENSORED;
            }

            if (($interested_events & ilForumNotificationEvents::POST_DELETED) !== 0) {
                $form_events[] = ilForumNotificationEvents::POST_DELETED;
            }

            if (($interested_events & ilForumNotificationEvents::THREAD_DELETED) !== 0) {
                $form_events[] = ilForumNotificationEvents::THREAD_DELETED;
            }

            $this->notificationSettingsForm->setValuesByArray([
                'notification_type' => $this->parent_obj->objProperties->getNotificationType(),
                'adm_force' => $this->parent_obj->objProperties->isAdminForceNoti(),
                'usr_toggle' => $this->parent_obj->objProperties->isUserToggleNoti(),
                'notification_events' => $form_events
            ]);
        }

        // set form html into template
        $this->tpl->setVariable('NOTIFICATIONS_SETTINGS_FORM', $this->notificationSettingsForm->getHTML());

        $oParticipants = $this->getParticipants();

        $moderator_ids = ilForum::_getModerators($this->parent_obj->getObject()->getRefId());

        $admin_ids = $oParticipants->getAdmins();
        $member_ids = $oParticipants->getMembers();
        $tutor_ids = $oParticipants->getTutors();

        if ($this->parent_obj->objProperties->getNotificationType() === 'default') {
            // update forum_notification table
            $forum_noti = new ilForumNotification($this->parent_obj->getObject()->getRefId());
            $forum_noti->setAdminForce($this->parent_obj->objProperties->isAdminForceNoti());
            $forum_noti->setUserToggle($this->parent_obj->objProperties->isUserToggleNoti());
            $forum_noti->setForumId($this->parent_obj->objProperties->getObjId());
            $forum_noti->setInterestedEvents($this->parent_obj->objProperties->getInterestedEvents());
            $forum_noti->update();
        } elseif ($this->parent_obj->objProperties->getNotificationType() === 'per_user') {
            $this->initForcedForumNotification();

            $moderators = $this->getUserNotificationTableData($moderator_ids);
            $admins = $this->getUserNotificationTableData($admin_ids);
            $members = $this->getUserNotificationTableData($member_ids);
            $tutors = $this->getUserNotificationTableData($tutor_ids);

            $this->showMembersTable($moderators, $admins, $members, $tutors);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showMembersTable()

ilForumSettingsGUI::showMembersTable ( array  $moderators, array  $admins, array  $members, array  $tutors  )

private

Definition at line 445 of file class.ilForumSettingsGUI.php.

References $data.

Referenced by showMembers().

                                                                                                      : void
    {
        foreach (array_filter([
            'moderators' => $moderators,
            'administrator' => $admins,
            'tutors' => $tutors,
            'members' => $members
        ]) as $type => $data) {
            $tbl = new ilForumNotificationTableGUI($this, 'showMembers', $type);
            $tbl->setData($data);

            $this->tpl->setCurrentBlock(strtolower($type) . '_table');
            $this->tpl->setVariable(strtoupper($type), $tbl->getHTML());
        }
    }

Here is the caller graph for this function:

updateCustomValues()

ilForumSettingsGUI::updateCustomValues

(

ilPropertyFormGUI

$a_form

)

Definition at line 290 of file class.ilForumSettingsGUI.php.

References ilSession\get(), ilPropertyFormGUI\getInput(), ILIAS\Repository\int(), ilForumProperties\isFileUploadGloballyAllowed(), ilSession\set(), ILIAS\Repository\settings(), ilForumProperties\VIEW_DATE, ilForumProperties\VIEW_DATE_ASC, ilForumProperties\VIEW_DATE_DESC, and ilForumProperties\VIEW_TREE.

                                                                 : void
    {
        $default_view_input_value = (int) $a_form->getInput('default_view');
        if (in_array($default_view_input_value, [
            ilForumProperties::VIEW_TREE,
            ilForumProperties::VIEW_DATE,
            ilForumProperties::VIEW_DATE_ASC,
            ilForumProperties::VIEW_DATE_DESC
        ], true)) {
            if ($default_view_input_value === ilForumProperties::VIEW_DATE) {
                $default_view_order_by_date_value = (int) $a_form->getInput('default_view_by_date');
                if (in_array($default_view_order_by_date_value, [
                    ilForumProperties::VIEW_DATE_ASC,
                    ilForumProperties::VIEW_DATE_DESC
                ], true)) {
                    $default_view_input_value = $default_view_order_by_date_value;
                }
            }
            $default_view = $default_view_input_value;
        } else {
            $default_view = ilForumProperties::VIEW_TREE;
        }
        $this->parent_obj->objProperties->setDefaultView($default_view);

        // BUGFIX FOR 11271

        $view_mode = 'viewmode_' . $this->parent_obj->getObject()->getId();
        if (ilSession::get($view_mode)) {
            ilSession::set($view_mode, $default_view);
        }

        if ($this->settings->get('enable_anonymous_fora') || $this->parent_obj->objProperties->isAnonymized()) {
            $this->parent_obj->objProperties->setAnonymisation((bool) $a_form->getInput('anonymized'));
        }
        if ($this->settings->get('enable_fora_statistics')) {
            $this->parent_obj->objProperties->setStatisticsStatus((bool) $a_form->getInput('statistics_enabled'));
        }
        $this->parent_obj->objProperties->setPostActivation((bool) $a_form->getInput('post_activation'));
        $this->parent_obj->objProperties->setSubjectSetting($a_form->getInput('subject_setting'));
        $this->parent_obj->objProperties->setMarkModeratorPosts((bool) $a_form->getInput('mark_mod_posts'));
        $this->parent_obj->objProperties->setIsThreadRatingEnabled((bool) $a_form->getInput('thread_rating'));
        if (!ilForumProperties::isFileUploadGloballyAllowed()) {
            $this->parent_obj->objProperties->setFileUploadAllowed((bool) $a_form->getInput('file_upload_allowed'));
        }
        $this->parent_obj->objProperties->update();
        $this->obj_service->commonSettings()->legacyForm($a_form, $this->parent_obj->getObject())->saveTileImage();

        $object = $this->parent_obj->getObject();
        $object->setOfflineStatus(!(bool) $a_form->getInput('activation_online'));
        $object->update();
    }

Here is the call graph for this function:

updateNotificationSettings()

ilForumSettingsGUI::updateNotificationSettings

(

)

Definition at line 777 of file class.ilForumSettingsGUI.php.

References ILIAS\Repository\access(), ilForumNotification\deleteNotificationAllUsers(), initNotificationSettingsForm(), ILIAS\Repository\int(), ILIAS\Repository\lng(), showMembers(), and updateUserNotifications().

                                                : void
    {
        if (!$this->access->checkAccess('write', '', $this->parent_obj->getRefId())) {
            $this->error->raiseError(
                $this->lng->txt('msg_no_perm_read'),
                $this->error->MESSAGE
            );
        }

        // instantiate the property form
        $this->initNotificationSettingsForm();

        // check input
        if ($this->notificationSettingsForm->checkInput()) {
            $notification_type = '';
            if ($this->dic->http()->wrapper()->post()->has('notification_type')) {
                $notification_type = $this->dic->http()->wrapper()->post()->retrieve(
                    'notification_type',
                    $this->dic->refinery()->kindlyTo()->string()
                );
            }

            if ($notification_type === 'all_users') {
                // set values and call update
                $notification_events = $this->notificationSettingsForm->getInput('notification_events');
                $interested_events = 0;

                if (is_array($notification_events)) {
                    foreach ($notification_events as $activated_event) {
                        $interested_events += (int) $activated_event;
                    }
                }

                $this->parent_obj->objProperties->setAdminForceNoti(true);
                $this->parent_obj->objProperties->setUserToggleNoti((bool) $this->notificationSettingsForm->getInput('usr_toggle'));
                $this->parent_obj->objProperties->setNotificationType('all_users');
                $this->parent_obj->objProperties->setInterestedEvents($interested_events);
                $this->updateUserNotifications(true);
            } elseif ($notification_type === 'per_user') {
                $this->parent_obj->objProperties->setNotificationType('per_user');
                $this->parent_obj->objProperties->setAdminForceNoti(true);
                $this->parent_obj->objProperties->setUserToggleNoti(false);
                $this->updateUserNotifications();
            } else { //  if($notification_type] == 'default')
                $this->parent_obj->objProperties->setNotificationType('default');
                $this->parent_obj->objProperties->setAdminForceNoti(false);
                $this->parent_obj->objProperties->setUserToggleNoti(false);
                $frm_noti = new ilForumNotification($this->parent_obj->getObject()->getRefId());
                $frm_noti->deleteNotificationAllUsers();
            }

            $this->parent_obj->objProperties->update();

            $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'));
        }
        $this->notificationSettingsForm->setValuesByPost();

        $this->showMembers();
    }

Here is the call graph for this function:

updateUserNotifications()

ilForumSettingsGUI::updateUserNotifications ( bool  $update_all_users = false )

private

Definition at line 693 of file class.ilForumSettingsGUI.php.

References $user_id, ilForum\_getModerators(), and getParticipants().

Referenced by updateNotificationSettings().

                                                                            : void
    {
        $oParticipants = $this->getParticipants();

        $frm_noti = new ilForumNotification($this->parent_obj->getObject()->getRefId());
        $moderator_ids = ilForum::_getModerators($this->parent_obj->getObject()->getRefId());

        $admin_ids = $oParticipants->getAdmins();
        $member_ids = $oParticipants->getMembers();
        $tutor_ids = $oParticipants->getTutors();

        $all_forum_users = array_merge($moderator_ids, $admin_ids, $member_ids, $tutor_ids);
        $all_forum_users = array_unique($all_forum_users);

        $all_notis = $frm_noti->read();

        foreach ($all_forum_users as $user_id) {
            $frm_noti->setUserId($user_id);

            $frm_noti->setAdminForce(true);
            $frm_noti->setUserToggle($this->parent_obj->objProperties->isUserToggleNoti());
            $frm_noti->setInterestedEvents($this->parent_obj->objProperties->getInterestedEvents());

            if (array_key_exists($user_id, $all_notis) && $update_all_users) {
                $frm_noti->update();
            } elseif (!$frm_noti->existsNotification()) {
                $frm_noti->insertAdminForce();
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access

readonly ilAccessHandler ilForumSettingsGUI::$access

private

Definition at line 33 of file class.ilForumSettingsGUI.php.

$ctrl

readonly ilCtrlInterface ilForumSettingsGUI::$ctrl

private

Definition at line 28 of file class.ilForumSettingsGUI.php.

$dic

readonly ILIAS DI Container ilForumSettingsGUI::$dic

private

Definition at line 40 of file class.ilForumSettingsGUI.php.

$error

readonly ilErrorHandling ilForumSettingsGUI::$error

private

Definition at line 41 of file class.ilForumSettingsGUI.php.

$forumNotificationObj

ilForumNotification ilForumSettingsGUI::$forumNotificationObj

private

Definition at line 36 of file class.ilForumSettingsGUI.php.

$http

readonly ILIAS HTTP GlobalHttpState ilForumSettingsGUI::$http

private

Definition at line 35 of file class.ilForumSettingsGUI.php.

$lng

readonly ilLanguage ilForumSettingsGUI::$lng

private

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

Referenced by saveEventsForUser().

$notificationSettingsForm

ilPropertyFormGUI ilForumSettingsGUI::$notificationSettingsForm = null

private

Definition at line 37 of file class.ilForumSettingsGUI.php.

$obj_service

readonly ilObjectService ilForumSettingsGUI::$obj_service

private

Definition at line 39 of file class.ilForumSettingsGUI.php.

$ref_id

readonly int ilForumSettingsGUI::$ref_id

private

Definition at line 38 of file class.ilForumSettingsGUI.php.

Referenced by getRefId().

$settings

readonly ilSetting ilForumSettingsGUI::$settings

private

Definition at line 31 of file class.ilForumSettingsGUI.php.

$tabs

readonly ilTabsGUI ilForumSettingsGUI::$tabs

private

Definition at line 32 of file class.ilForumSettingsGUI.php.

$tpl

readonly ilGlobalTemplateInterface ilForumSettingsGUI::$tpl

private

Definition at line 29 of file class.ilForumSettingsGUI.php.

$tree

readonly ilTree ilForumSettingsGUI::$tree

private

Definition at line 34 of file class.ilForumSettingsGUI.php.

$ui_factory

readonly ILIAS UI Factory ilForumSettingsGUI::$ui_factory

private

Definition at line 42 of file class.ilForumSettingsGUI.php.

Referenced by saveEventsForUser().

---

The documentation for this class was generated from the following file:

• components/ILIAS/Forum/classes/class.ilForumSettingsGUI.php