ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
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 ()
 
 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 Member Functions

 delete ()
 

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
 
ILIAS FileDelivery Services $file_delivery
 

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.

38 {
39 if ($controller === null) {
40 global $DIC;
41 $controller = $DIC->ctrl();
42 }
43 $this->controller = $controller;
44
45 if ($language === null) {
46 global $DIC;
47 $language = $DIC->language();
48 }
49 $this->language = $language;
50
51 if ($user === null) {
52 global $DIC;
53 $user = $DIC->user();
54 }
55 $this->user = $user;
56
58 }
readonly ilLanguage $language
readonly ilCtrlInterface $controller
readonly ilObjUser $user
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc
global $DIC
Definition: shib_login.php:26

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

+ Here is the call graph for this function:

Member Function Documentation

◆ active()

ilChatroomBanGUI::active ( )

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

152 : void
153 {
154 $this->redirectIfNoPermission(['read', 'moderate']);
155
156 $room = ilChatroom::byObjectId($this->gui->getObject()->getId());
157 $this->exitIfNoRoomExists($room);
158
159 $userToBan = $this->getRequestValue('user', $this->refinery->kindlyTo()->int());
160
161 $connector = $this->gui->getConnector();
162 $response = $connector->sendBan($room->getRoomId(), $userToBan);
163
164 if ($this->isSuccessful($response)) {
165 $room->banUser($userToBan, $this->user->getId());
166 $room->disconnectUser($userToBan);
167 }
168
169 $this->sendResponse($response, 'application/json');
170 }
redirectIfNoPermission($permission)
Checks for requested permissions and redirects if the permission check failed.
exitIfNoRoomExists(?ilChatroom $room)
Checks if a ilChatroom exists.
sendResponse(string $content, string $type)
Sends a response and exits the php process.
isSuccessful($response)
Checks for success param in an json decoded response.
getRequestValue(string $key, Transformation $trafo, $default=null)
static byObjectId(int $object_id)
$response
Definition: xapitoken.php:93

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

+ Here is the call graph for this function:

◆ delete()

ilChatroomBanGUI::delete ( )
private

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

75 : void
76 {
77 $this->redirectIfNoPermission(['read', 'moderate']);
78
79 $userTrafo = $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->string());
80
81 $users = $this->getRequestValue('chat_ban_table_user_ids', $userTrafo, []);
82 if ($users === []) {
83 $this->mainTpl->setOnScreenMessage('info', $this->ilLng->txt('no_checkbox'), true);
84 $this->ilCtrl->redirect($this->gui, 'ban-show');
85 }
86
87 $room = ilChatroom::byObjectId($this->gui->getObject()->getId());
88 $this->exitIfNoRoomExists($room);
89
90 if ((string) current($users) === 'ALL_OBJECTS') {
91 $users = array_map(static fn(array $row): int => (int) $row['user_id'], $room->getBannedUsers());
92 } else {
93 $users = array_map(intval(...), $users);
94 }
95
96 $room->unbanUser($users);
97
98 $this->mainTpl->setOnScreenMessage(
99 $this->mainTpl::MESSAGE_TYPE_SUCCESS,
100 $this->ilLng->txt('saved_successfully'),
101 true
102 );
103 $this->ilCtrl->redirect($this->gui, 'ban-show');
104 }
Class ilCtrl provides processing control methods.
redirect(object $a_gui_obj, ?string $a_cmd=null, ?string $a_anchor=null, bool $is_async=false)
@inheritDoc

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

+ Here is the call graph for this function:

◆ executeDefault()

ilChatroomBanGUI::executeDefault ( string  $requestedMethod)

Reimplemented from ilChatroomGUIHandler.

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

106 : void
107 {
108 $this->show();
109 }
show()
Displays banned users task.

References show().

+ Here is the call graph for this function:

◆ handleTableActions()

ilChatroomBanGUI::handleTableActions ( )

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

60 : void
61 {
62 $action = $this->http->wrapper()->query()->retrieve(
63 'chat_ban_table_action',
64 $this->refinery->byTrying([
65 $this->refinery->kindlyTo()->string(),
66 $this->refinery->always('')
67 ])
68 );
69 match ($action) {
70 'delete' => $this->delete(),
71 default => $this->ilCtrl->redirect($this, 'show'),
72 };
73 }
static http()
Fetches the global http state from ILIAS.

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

+ Here is the call graph for this function:

◆ show()

ilChatroomBanGUI::show ( )

Displays banned users task.

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

114 : void
115 {
116 $this->redirectIfNoPermission(['read', 'moderate']);
117
118 $this->gui->switchToVisibleMode();
119
120 $room = ilChatroom::byObjectId($this->gui->getObject()->getId());
121 $this->exitIfNoRoomExists($room);
122
123 $data = $room->getBannedUsers();
124 $actorId = array_filter(array_map(static fn(array $row): int => (int) $row['actor_id'], $data));
125
126 $sortable_names = ilUserUtil::getNamePresentation($actorId);
127 $names = ilUserUtil::getNamePresentation($actorId, false, false, '', false, false, false);
128
129 array_walk($data, function (&$row) use ($names, $sortable_names): void {
130 if ($row['actor_id'] > 0 && isset($names[$row['actor_id']])) {
131 $row['actor_display'] = $names[$row['actor_id']];
132 $row['actor'] = $sortable_names[$row['actor_id']];
133 } else {
134 $row['actor_display'] = $this->language->txt('unknown');
135 $row['actor'] = $this->language->txt('unknown');
136 }
137 });
138
139 $tbl = new \ILIAS\Chatroom\Bans\BannedUsersTable(
140 $this->user,
141 $room->getRoomId(),
142 $data,
143 $this->ilCtrl,
144 $this->ilLng,
145 $this->http,
146 $this->uiFactory
147 );
148
149 $this->mainTpl->setContent($this->uiRenderer->render($tbl->getComponent()));
150 }
static getNamePresentation( $a_user_id, bool $a_user_image=false, bool $a_profile_link=false, string $a_profile_back_link='', bool $a_force_first_lastname=false, bool $a_omit_login=false, bool $a_sortable=true, bool $a_return_data_array=false, $a_ctrl_path=null)
Default behaviour is:

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

Referenced by executeDefault().

+ 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: