@ilCtrl_Calls ilForumModeratorsGUI: ilRepositorySearchGUI More...

Inheritance diagram for ilForumModeratorsGUI:

Collaboration diagram for ilForumModeratorsGUI:

Public Member Functions
	executeCommand ()

	addModeratorCommand (array $users=[])

	getUnsafeGetCommands ()
	This method must return a list of unsafe GET commands. More...

	getSafePostCommands ()
	This method must return a list of safe POST commands. More...

	getUnsafeGetCommands ()
	This method must return a list of unsafe GET commands. More...

	getSafePostCommands ()
	This method must return a list of safe POST commands. More...

Private Member Functions
	detachModeratorRole ()

	showModeratorsCommand ()

	handleModeratorActionsCommand ()

Private Attributes
const string	CMD_SHOW_MODERATORS = 'showModerators'

const string	CMD_ADD_MODERATOR = 'addModerator'

const string	CMD_HANDLE_TABLE_ACTIONS = 'handleModeratorActions'

const string	DEFAULT_CMD = self::CMD_SHOW_MODERATORS

readonly ilCtrlInterface	$ctrl

readonly ilGlobalTemplateInterface	$tpl

readonly ilLanguage	$lng

readonly ilTabsGUI	$tabs

readonly ilErrorHandling	$error

readonly ilObjUser	$user

readonly ilToolbarGUI	$toolbar

readonly ilForumModerators	$frm_moderators

readonly ilAccessHandler	$access

readonly ILIAS HTTP Wrapper WrapperFactory	$http_wrapper

readonly ILIAS Refinery Factory	$refinery

readonly ILIAS HTTP Services	$http

readonly ILIAS UI Factory	$ui_factory

readonly ILIAS UI Renderer	$ui_renderer

Detailed Description

@ilCtrl_Calls ilForumModeratorsGUI: ilRepositorySearchGUI

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

Member Function Documentation

◆ addModeratorCommand()

ilForumModeratorsGUI::addModeratorCommand ( array $users = [] )

Parameters

list<int> $users

Definition at line 105 of file class.ilForumModeratorsGUI.php.

                                                          : void
    {
        if ($users === []) {
            $this->tpl->setOnScreenMessage(
                $this->tpl::MESSAGE_TYPE_FAILURE,
                $this->lng->txt('frm_moderators_select_one')
            );
            return;
        }
 
        $frm_properties = ilForumProperties::getInstance(ilObject::_lookupObjId($this->forum->getRefId()));
        $notificaton_type = $frm_properties->getNotificationType();
        $is_membersip_enabled_parent = $this->forum->isParentMembershipEnabledContainer();
        $tmp_frm_noti = new ilForumNotification($this->forum->getRefId());
 
        foreach ($users as $usr_id) {
            $this->frm_moderators->addModeratorRole($usr_id);
            if ($is_membersip_enabled_parent && $notificaton_type !== NotificationType::DEFAULT) {
                $tmp_frm_noti->setUserId($usr_id);
                $tmp_frm_noti->setUserIdNoti($this->user->getId());
                $tmp_frm_noti->setUserToggle($frm_properties->getUserToggleNoti());
                $tmp_frm_noti->setAdminForce($frm_properties->getAdminForceNoti());
                $tmp_frm_noti->insertAdminForce();
            }
        }
 
        $this->tpl->setOnScreenMessage(
            $this->tpl::MESSAGE_TYPE_SUCCESS,
            $this->lng->txt('frm_moderator_role_added_successfully'),
            true
        );
        $this->ctrl->redirect($this, self::CMD_SHOW_MODERATORS);
    }

References ilObject\_lookupObjId(), ILIAS\Repository\ctrl(), ILIAS\Forum\Notification\DEFAULT, ilForumProperties\getInstance(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ detachModeratorRole()

ilForumModeratorsGUI::detachModeratorRole ( )

private

Definition at line 139 of file class.ilForumModeratorsGUI.php.

                                          : void
    {
        $usr_ids = $this->http_wrapper->query()->retrieve(
            'frm_moderators_table_usr_ids',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int()),
                $this->refinery->always([])
            ])
        );
 
        if ($usr_ids === []) {
            $this->tpl->setOnScreenMessage(
                $this->tpl::MESSAGE_TYPE_FAILURE,
                $this->lng->txt('frm_moderators_select_at_least_one')
            );
            $this->ctrl->redirect($this, self::CMD_SHOW_MODERATORS);
        }
 
        $entries = $this->frm_moderators->getCurrentModerators();
        if (count($usr_ids) === count($entries)) {
            $this->tpl->setOnScreenMessage(
                $this->tpl::MESSAGE_TYPE_FAILURE,
                $this->lng->txt('frm_at_least_one_moderator'),
                true
            );
            $this->ctrl->redirect($this, self::CMD_SHOW_MODERATORS);
        }
 
        $frm_properties = ilForumProperties::getInstance(ilObject::_lookupObjId($this->forum->getRefId()));
        $obj_id = $frm_properties->getObjId();
        $notificaton_type = $frm_properties->getNotificationType();
        $is_membersip_enabled_parent = $this->forum->isParentMembershipEnabledContainer();
        $need_participants = $is_membersip_enabled_parent && $notificaton_type !== NotificationType::DEFAULT;
        $tmp_frm_noti = new ilForumNotification($this->forum->getRefId());
 
        $participants_result = $need_participants
            ? new \ILIAS\Data\Result\Ok($this->forum->parentParticipants())
            : new \ILIAS\Data\Result\Error("Participants not required for ref_id {$this->forum->getRefId()}");
 
        foreach ($usr_ids as $usr_id) {
            $this->frm_moderators->detachModeratorRole($usr_id);
            $participants_result->map(function (ilParticipants $participants) use ($tmp_frm_noti, $usr_id, $obj_id) {
                if (!$participants->isAssigned($usr_id)) {
                    $tmp_frm_noti->setUserId($usr_id);
                    $tmp_frm_noti->setForumId($obj_id);
                    $tmp_frm_noti->deleteAdminForce();
                }
            });
        }
 
        $this->tpl->setOnScreenMessage(
            $this->tpl::MESSAGE_TYPE_SUCCESS,
            $this->lng->txt('frm_moderators_detached_role_successfully'),
            true
        );
        $this->ctrl->redirect($this, self::CMD_SHOW_MODERATORS);
    }

References ilObject\_lookupObjId(), ILIAS\Repository\ctrl(), ILIAS\Forum\Notification\DEFAULT, ilForumProperties\getInstance(), ilParticipants\isAssigned(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Referenced by handleModeratorActionsCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilForumModeratorsGUI::executeCommand ( )

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

                                    : void
    {
        if (!$this->access->checkAccess('write', '', $this->forum->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
 
        $this->tabs->activateTab('frm_moderators');
 
        $next_class = $this->ctrl->getNextClass($this) ?? '';
        $cmd = $this->ctrl->getCmd();
 
        switch (strtolower($next_class)) {
            case strtolower(ilRepositorySearchGUI::class):
                $rep_search = new ilRepositorySearchGUI();
                $rep_search->setCallback($this, self::CMD_ADD_MODERATOR . 'Command');
                $this->ctrl->setReturn($this, self::CMD_SHOW_MODERATORS);
                $this->ctrl->forwardCommand($rep_search);
                break;
 
            default:
                if ($cmd === null || $cmd === '' || !method_exists($this, $cmd . 'Command')) {
                    $cmd = self::DEFAULT_CMD;
                }
                $verified_command = $cmd . 'Command';
 
                $this->$verified_command();
                break;
        }
    }

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), DEFAULT_CMD, error(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

Here is the call graph for this function:

◆ getSafePostCommands()

ilForumModeratorsGUI::getSafePostCommands ( )

This method must return a list of safe POST commands.

Safe post commands returned by this method will no longer be CSRF protected and will NOT be appended by an ilCtrlToken.

Returns: string[]

Implements ilCtrlSecurityInterface.

Definition at line 246 of file class.ilForumModeratorsGUI.php.

                                         : array
    {
        return [];
    }

◆ getUnsafeGetCommands()

ilForumModeratorsGUI::getUnsafeGetCommands ( )

This method must return a list of unsafe GET commands.

Unsafe get commands returned by this method will now be CSRF protected, which means an ilCtrlToken is appended each time a link-target is generated to the class implementing this interface with a command from that list.

Tokens will be validated in

See also: ilCtrlInterface::getCmd(), whereas the fallback command will be used if the CSRF validation fails.

Returns: string[]

Implements ilCtrlSecurityInterface.

Definition at line 239 of file class.ilForumModeratorsGUI.php.

                                          : array
    {
        return [
            self::CMD_HANDLE_TABLE_ACTIONS,
        ];
    }

References CMD_HANDLE_TABLE_ACTIONS.

◆ handleModeratorActionsCommand()

ilForumModeratorsGUI::handleModeratorActionsCommand ( )

private

Definition at line 224 of file class.ilForumModeratorsGUI.php.

                                                    : void
    {
        $action = $this->http_wrapper->query()->retrieve(
            'frm_moderators_table_action',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->string(),
                $this->refinery->always('')
            ])
        );
        match ($action) {
            'detachModeratorRole' => $this->detachModeratorRole(),
            default => $this->ctrl->redirect($this, self::CMD_SHOW_MODERATORS),
        };
    }

References ILIAS\Repository\ctrl(), detachModeratorRole(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

◆ showModeratorsCommand()

ilForumModeratorsGUI::showModeratorsCommand ( )

private

Definition at line 197 of file class.ilForumModeratorsGUI.php.

                                            : void
    {
        ilRepositorySearchGUI::fillAutoCompleteToolbar(
            $this,
            $this->toolbar,
            [
                'auto_complete_name' => $this->lng->txt('user'),
                'submit_name' => $this->lng->txt('add'),
                'add_search' => true,
                'add_from_container' => $this->frm_moderators->getRefId()
            ]
        );
 
        $tbl = new \ILIAS\Forum\Moderation\ForumModeratorsTable(
            $this->frm_moderators,
            $this->lng,
            $this->http,
            $this->ui_factory,
            ilUtil::_getHttpPath() . '/' . $this->ctrl->getLinkTarget(
                $this,
                self::CMD_HANDLE_TABLE_ACTIONS
            )
        );
 
        $this->tpl->setContent($this->ui_renderer->render($tbl->getComponent()));
    }