Class ilChatroomBanGUI. More...

Inheritance diagram for ilChatroomBanGUI:

Collaboration diagram for ilChatroomBanGUI:

Public Member Functions

__construct (ilChatroomObjectGUI $gui, \ilCtrl $controller=null, \ilLanguage $language=null, \ilUser $user=null)

delete ()

Unbans users fetched from $_REQUEST['banned_user_id']. More...

executeDefault ($method)

{

Parameters

string $requestedMethod

Returns: mixed

} More...

show ()

Displays banned users task. More...

active ()

Kicks and bans user, fetched from $_REQUEST['user'] and adds history entry. More...

Public Member Functions inherited from ilChatroomGUIHandler

__construct (ilChatroomObjectGUI $gui)

sendResponse ($response)

Sends a json encoded response and exits the php process. More...

hasPermission ($permission)

Checks for access with ilRbacSystem. More...

execute ($method)

Executes given $method if existing, otherwise executes executeDefault() method. More...

executeDefault ($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...

Private Attributes
	$controller

	$language

	$user

Additional Inherited Members
Protected Member Functions inherited from ilChatroomGUIHandler
	getRoomByObjectId ($objectId)

	exitIfNoRoomExists ($room)
	Checks if a ilChatroom exists. More...

	exitIfNoRoomPermission ($room, $subRoom, $chat_user)
	Check if user can moderate a chatroom. More...

	canModerate ($room, $subRoom, $user_id)
	Checks if the user has permission to moderate a ilChatroom. More...

	isMainRoom ($subRoomId)

Protected Attributes inherited from ilChatroomGUIHandler
	$gui

	$ilUser

	$ilCtrl

	$ilLng

	$webDirectory

	$upload

	$rbacsystem

	$mainTpl

	$ilias

	$navigationHistory

	$tree

	$tabs

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 13 of file class.ilChatroomBanGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilChatroomBanGUI::__construct	(	ilChatroomObjectGUI	$gui,
		\ilCtrl	$controller = `null`,
		\ilLanguage	$language = `null`,
		\ilUser	$user = `null`
	)

Parameters

ilChatroomObjectGUI	$gui
ilCtrl \| null	$controller
ilLanguage \| null	$language
ilUser \| null	$user

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

      {
        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);
    }

References $controller, $DIC, ilChatroomGUIHandler\$gui, $language, $user, and user().

Here is the call graph for this function:

Member Function Documentation

◆ active()

ilChatroomBanGUI::active ( )

Kicks and bans user, fetched from $_REQUEST['user'] and adds history entry.

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

    {
        $this->redirectIfNoPermission(array('read', 'moderate'));
 
        $room = ilChatroom::byObjectId($this->gui->object->getId());
        $subRoomId = $_REQUEST['sub'];
        $userToBan = $_REQUEST['user'];
 
        $this->exitIfNoRoomExists($room);
 
        $connector = $this->gui->getConnector();
        $response = $connector->sendBan($room->getRoomId(), $subRoomId, $userToBan); // @TODO Respect Scope
 
        if ($this->isSuccessful($response)) {
            $room->banUser($_REQUEST['user'], $this->user->getId());
            $room->disconnectUser($_REQUEST['user']);
        }
 
        $this->sendResponse($response);
    }

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

Here is the call graph for this function:

◆ delete()

ilChatroomBanGUI::delete ( )

Unbans users fetched from $_REQUEST['banned_user_id'].

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

    {
        $users = $_REQUEST['banned_user_id'];
 
        if (!is_array($users)) {
            ilUtil::sendInfo($this->ilLng->txt('no_checkbox'), true);
            $this->ilCtrl->redirect($this->gui, 'ban-show');
        }
 
        $room = ilChatroom::byObjectId($this->gui->object->getId());
        $room->unbanUser($users);
 
        $this->ilCtrl->redirect($this->gui, 'ban-show');
    }

References $users, ilChatroom\byObjectId(), ilCtrl\redirect(), and ilUtil\sendInfo().

Here is the call graph for this function:

◆ executeDefault()

ilChatroomBanGUI::executeDefault ( $method )

{

Parameters

string $requestedMethod

Returns: mixed

}

Reimplemented from ilChatroomGUIHandler.

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

    {
        $this->show();
    }

References show().

Here is the call graph for this function:

◆ show()

ilChatroomBanGUI::show ( )

Displays banned users task.

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

    {
        include_once 'Modules/Chatroom/classes/class.ilChatroom.php';
 
        $this->redirectIfNoPermission('read');
 
        $this->gui->switchToVisibleMode();
 
        require_once 'Modules/Chatroom/classes/class.ilBannedUsersTableGUI.php';
 
        $table = new ilBannedUsersTableGUI($this->gui, 'ban-show');
        $table->setFormAction($this->controller->getFormAction($this->gui, 'ban-show'));
 
        $room = ilChatroom::byObjectId($this->gui->object->getId());
        if ($room) {
            $data = $room->getBannedUsers();
 
            $actorIDs = array_filter(array_map(function ($row) {
                return $row['actor_id'];
            }, $data));
 
            require_once 'Services/User/classes/class.ilUserUtil.php';
            $sortable_names = ilUserUtil::getNamePresentation($actorIDs);
            $names = ilUserUtil::getNamePresentation($actorIDs, false, false, '', false, false, false);
 
            array_walk($data, function (&$row) use ($names, $sortable_names) {
                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');
                }
            });
 
            $table->setData($data);
        }
 
        $this->gui->tpl->setVariable('ADM_CONTENT', $table->getHTML());
    }

References $data, $row, $table, ilChatroom\byObjectId(), ilUserUtil\getNamePresentation(), and ilChatroomGUIHandler\redirectIfNoPermission().

Referenced by executeDefault().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $controller

ilChatroomBanGUI::$controller

private

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

Referenced by __construct().

◆ $language

ilChatroomBanGUI::$language

private

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

Referenced by __construct().

◆ $user

ilChatroomBanGUI::$user

private

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

Referenced by __construct().

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

Modules/Chatroom/classes/gui/class.ilChatroomBanGUI.php

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ active()

◆ delete()

◆ executeDefault()

◆ show()

Field Documentation

◆ $controller

◆ $language

◆ $user