ilChatroomBanGUI Class Reference

Class ilChatroomBanGUI. More...

Inheritance diagram for ilChatroomBanGUI:

Collaboration diagram for ilChatroomBanGUI:

Public Member Functions
	__construct (?ilChatroomObjectGUI $gui, ?ilCtrlInterface $controller=null, ?ilLanguage $language=null, ?ilObjUser $user=null)
	handleTableActions ()
	delete ()
	executeDefault (string $requestedMethod)
	show ()
	Displays banned users task. More...
	active ()
Public Member Functions inherited from ilChatroomGUIHandler
	execute (string $method)
	executeDefault (string $requestedMethod)
	redirectIfNoPermission ($permission)
	Checks for requested permissions and redirects if the permission check failed. More...
	isSuccessful ($response)
	Checks for success param in an json decoded response. More...
	hasPermission (string $permission)

Private Attributes
readonly ilCtrlInterface	$controller
readonly ilLanguage	$language
readonly ilObjUser	$user

Additional Inherited Members
Protected Member Functions inherited from ilChatroomGUIHandler
	getRequestValue (string $key, Transformation $trafo, $default=null)
	hasRequestValue (string $key)
	getRoomByObjectId (int $objectId)
	exitIfNoRoomExists (?ilChatroom $room)
	Checks if a ilChatroom exists. More...
	sendJSONResponse ($response)
	Sends a json encoded response and exits the php process. More...
	sendResponse (string $content, string $type)
	Sends a response and exits the php process. More...
Protected Attributes inherited from ilChatroomGUIHandler
ilObjUser	$ilUser
ilCtrlInterface	$ilCtrl
ilLanguage	$ilLng
Filesystem	$webDirectory
ilObjectService	$obj_service
FileUpload	$upload
ilRbacSystem	$rbacsystem
ilGlobalTemplateInterface	$mainTpl
ILIAS	$ilias
ilNavigationHistory	$navigationHistory
ilTree	$tree
ilTabsGUI	$tabs
UIFactory	$uiFactory
UIRenderer	$uiRenderer
GlobalHttpState	$http
Refinery	$refinery

Detailed Description

Class ilChatroomBanGUI.

Author

Jan Posselt jposs.nosp@m.elt@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Version

$Id$ \

Definition at line 27 of file class.ilChatroomBanGUI.php.

Constructor & Destructor Documentation

__construct()

ilChatroomBanGUI::__construct	(	?ilChatroomObjectGUI	$gui,
		?ilCtrlInterface	$controller = null,
		?ilLanguage	$language = null,
		?ilObjUser	$user = null
	)

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

References $controller, $DIC, $language, $user, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), null, and ILIAS\Repository\user().

      {
        if ($controller === null) {
            global $DIC;
            $controller = $DIC->ctrl();
        }
        $this->controller = $controller;

        if ($language === null) {
            global $DIC;
            $language = $DIC->language();
        }
        $this->language = $language;

        if ($user === null) {
            global $DIC;
            $user = $DIC->user();
        }
        $this->user = $user;

        parent::__construct($gui);
    }

Here is the call graph for this function:

Member Function Documentation

active()

ilChatroomBanGUI::active

(

)

Definition at line 150 of file class.ilChatroomBanGUI.php.

References $response, ilChatroom\byObjectId(), ilChatroomGUIHandler\exitIfNoRoomExists(), ilChatroomGUIHandler\getRequestValue(), ilChatroomGUIHandler\isSuccessful(), ilChatroomGUIHandler\redirectIfNoPermission(), ILIAS\Repository\refinery(), ilChatroomGUIHandler\sendResponse(), and ILIAS\Repository\user().

                            : void
    {
        $this->redirectIfNoPermission(['read', 'moderate']);

        $room = ilChatroom::byObjectId($this->gui->getObject()->getId());
        $this->exitIfNoRoomExists($room);

        $userToBan = $this->getRequestValue('user', $this->refinery->kindlyTo()->int());

        $connector = $this->gui->getConnector();
        $response = $connector->sendBan($room->getRoomId(), $userToBan);

        if ($this->isSuccessful($response)) {
            $room->banUser($userToBan, $this->user->getId());
            $room->disconnectUser($userToBan);
        }

        $this->sendResponse($response, 'application/json');
    }

Here is the call graph for this function:

delete()

ilChatroomBanGUI::delete

(

)

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

References ilChatroom\byObjectId(), ilChatroomGUIHandler\exitIfNoRoomExists(), ilChatroomGUIHandler\getRequestValue(), and ILIAS\Repository\refinery().

                            : void
    {
        $userTrafo = $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->string());

        $users = $this->getRequestValue('chat_ban_table_user_ids', $userTrafo, []);
        if ($users === []) {
            $this->mainTpl->setOnScreenMessage('info', $this->ilLng->txt('no_checkbox'), true);
            $this->ilCtrl->redirect($this->gui, 'ban-show');
        }

        $room = ilChatroom::byObjectId($this->gui->getObject()->getId());
        $this->exitIfNoRoomExists($room);

        if ((string) current($users) === 'ALL_OBJECTS') {
            $users = array_map(static fn(array $row): int => (int) $row['user_id'], $room->getBannedUsers());
        } else {
            $users = array_map(intval(...), $users);
        }

        $room->unbanUser($users);

        $this->mainTpl->setOnScreenMessage(
            $this->mainTpl::MESSAGE_TYPE_SUCCESS,
            $this->ilLng->txt('saved_successfully'),
            true
        );
        $this->ilCtrl->redirect($this->gui, 'ban-show');
    }

Here is the call graph for this function:

executeDefault()

ilChatroomBanGUI::executeDefault

(

string

$requestedMethod

)

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

References show().

                                                           : void
    {
        $this->show();
    }

Here is the call graph for this function:

handleTableActions()

ilChatroomBanGUI::handleTableActions

(

)

Definition at line 60 of file class.ilChatroomBanGUI.php.

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

                                        : void
    {
        $action = $this->http->wrapper()->query()->retrieve(
            'chat_ban_table_action',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->string(),
                $this->refinery->always('')
            ])
        );
        match ($action) {
            'delete' => $this->delete(),
            default => $this->ilCtrl->redirect($this, 'show'),
        };
    }

Here is the call graph for this function:

show()

ilChatroomBanGUI::show

(

)

Displays banned users task.

Definition at line 112 of file class.ilChatroomBanGUI.php.

References $data, ilChatroomGUIHandler\$http, ilChatroomGUIHandler\$ilCtrl, ilChatroomGUIHandler\$ilLng, ilChatroomGUIHandler\$uiFactory, ilChatroom\byObjectId(), ilChatroomGUIHandler\exitIfNoRoomExists(), ilUserUtil\getNamePresentation(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), ilChatroomGUIHandler\redirectIfNoPermission(), and ILIAS\Repository\user().

Referenced by executeDefault().

                          : void
    {
        $this->redirectIfNoPermission('read');

        $this->gui->switchToVisibleMode();

        $room = ilChatroom::byObjectId($this->gui->getObject()->getId());
        $this->exitIfNoRoomExists($room);

        $data = $room->getBannedUsers();
        $actorId = array_filter(array_map(static fn(array $row): int => (int) $row['actor_id'], $data));

        $sortable_names = ilUserUtil::getNamePresentation($actorId);
        $names = ilUserUtil::getNamePresentation($actorId, false, false, '', false, false, false);

        array_walk($data, function (&$row) use ($names, $sortable_names): void {
            if ($row['actor_id'] > 0 && isset($names[$row['actor_id']])) {
                $row['actor_display'] = $names[$row['actor_id']];
                $row['actor'] = $sortable_names[$row['actor_id']];
            } else {
                $row['actor_display'] = $this->language->txt('unknown');
                $row['actor'] = $this->language->txt('unknown');
            }
        });

        $tbl = new \ILIAS\Chatroom\Bans\BannedUsersTable(
            $this->user,
            $room->getRoomId(),
            $data,
            $this->ilCtrl,
            $this->ilLng,
            $this->http,
            $this->uiFactory
        );

        $this->mainTpl->setContent($this->uiRenderer->render($tbl->getComponent()));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$controller

readonly ilCtrlInterface ilChatroomBanGUI::$controller

private

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

Referenced by __construct().

$language

readonly ilLanguage ilChatroomBanGUI::$language

private

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

Referenced by __construct().

$user

readonly ilObjUser ilChatroomBanGUI::$user

private

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

Referenced by __construct().

---

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

• components/ILIAS/Chatroom/classes/gui/class.ilChatroomBanGUI.php