Inheritance diagram for ilForumModeratorsGUI:

Collaboration diagram for ilForumModeratorsGUI:

Public Member Functions
	executeCommand ()

	addModerator (array $users=[])

	detachModeratorRole ()

	showModerators ()

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

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

Protected Attributes
ILIAS UI Renderer	$ui_renderer

Private Member Functions
	handleModeratorActions ()

Private Attributes
readonly ilCtrlInterface	$ctrl

readonly ilGlobalTemplateInterface	$tpl

readonly ilLanguage	$lng

readonly ilTabsGUI	$tabs

readonly ilErrorHandling	$error

readonly ilObjUser	$user

readonly ilToolbarGUI	$toolbar

readonly ilForumModerators	$oForumModerators

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

Detailed Description

Class ilForumModeratorsGUI.

Author: Nadia Matuschek nmatu.nosp@m.sche.nosp@m.k@dat.nosp@m.abay.nosp@m..de ilForumModeratorsGUI: ilRepositorySearchGUI \

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

Member Function Documentation

◆ addModerator()

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

Parameters

list<int> $users

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

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

                                                    : void
     {
         if ($users === []) {
             $this->tpl->setOnScreenMessage('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->oForumModerators->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('success', $this->lng->txt('frm_moderator_role_added_successfully'), true);
         $this->ctrl->redirect($this, 'showModerators');
     }

Here is the call graph for this function:

◆ detachModeratorRole()

ilForumModeratorsGUI::detachModeratorRole ( )

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

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

Referenced by handleModeratorActions().

                                          : void
     {
         $usr_ids = $this->http_wrapper->post()->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('failure', $this->lng->txt('frm_moderators_select_at_least_one'));
             $this->ctrl->redirect($this, 'showModerators');
         }
 
         $entries = $this->oForumModerators->getCurrentModerators();
         if (count($usr_ids) === count($entries)) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('frm_at_least_one_moderator'), true);
             $this->ctrl->redirect($this, 'showModerators');
         }
 
         $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(ilParticipants::getInstance($this->forum->getRefId()))
             : new \ILIAS\Data\Result\Error("Participants not required for ref_id {$this->forum->getRefId()}");
 
         foreach ($usr_ids as $usr_id) {
             $this->oForumModerators->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('success', $this->lng->txt('frm_moderators_detached_role_successfully'), true);
         $this->ctrl->redirect($this, 'showModerators');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilForumModeratorsGUI::executeCommand ( )

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

References ILIAS\Repository\ctrl().

                                     : void
     {
         $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, 'addModerator');
                 $this->ctrl->setReturn($this, 'showModerators');
                 $this->ctrl->forwardCommand($rep_search);
                 break;
 
             default:
                 if (!$cmd) {
                     $cmd = 'showModerators';
                 }
                 $this->$cmd();
                 break;
         }
     }

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 220 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 213 of file class.ilForumModeratorsGUI.php.

                                           : array
     {
         return [
             'handleModeratorActions',
         ];
     }

◆ handleModeratorActions()

ilForumModeratorsGUI::handleModeratorActions ( )

private

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

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

                                              : 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, 'showModerators'),
         };
     }

Here is the call graph for this function:

◆ showModerators()

ilForumModeratorsGUI::showModerators ( )

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

References ILIAS\Repository\ctrl(), ilRepositorySearchGUI\fillAutoCompleteToolbar(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

                                     : 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->oForumModerators->getRefId()
             ]
         );
 
         $tbl = new \ILIAS\Forum\Moderation\ForumModeratorsTable(
             $this->oForumModerators,
             $this->ctrl,
             $this->lng,
             $this->http,
             $this->ui_factory
         );
 
         $this->tpl->setContent($this->ui_renderer->render($tbl->getComponent()));
     }