ILIAS  release_10 Revision v10.1-43-ga1241a92c2f
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes
ilChatroomAdminViewGUI Class Reference

Class ilChatroomAdminViewGUI. More...

+ Inheritance diagram for ilChatroomAdminViewGUI:
+ Collaboration diagram for ilChatroomAdminViewGUI:

Public Member Functions

 __construct (ilChatroomObjectGUI $gui)
 
 executeDefault (string $requestedMethod)
 
 forcePublicRoom ()
 
 createPublicRoom ()
 
 saveClientSettings ()
 
- 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)
 

Protected Member Functions

 checkServerConnection (array $serverSettings)
 
 createSettingTemplate (ilPropertyFormGUI $form)
 
 getReadmePath ()
 
- 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

ilSetting $commonSettings
 
- 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
 

Private Member Functions

 defaultActions ()
 

Private Attributes

const CHATROOM_README_PATH = '/components/ILIAS/Chatroom/README.md'
 

Detailed Description

Class ilChatroomAdminViewGUI.

Author
Jan Posselt jposs.nosp@m.elt@.nosp@m.datab.nosp@m.ay.d.nosp@m.e
Thomas Joußen tjous.nosp@m.sen@.nosp@m.datab.nosp@m.ay.d.nosp@m.e
Version
$Id$ \

Definition at line 28 of file class.ilChatroomAdminViewGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilChatroomAdminViewGUI::__construct ( ilChatroomObjectGUI  $gui)

Definition at line 34 of file class.ilChatroomAdminViewGUI.php.

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

35  {
36  global $DIC;
37 
38  parent::__construct($gui);
39  $this->commonSettings = new ilSetting('common');
40  }
$DIC
global $DIC
Definition: shib_login.php:25
ILIAS\GlobalScreen\Provider\__construct
__construct(Container $dic, ilPlugin $plugin)
Definition: PluginProviderHelper.php:37
+ Here is the call graph for this function:

Member Function Documentation

◆ checkServerConnection()

ilChatroomAdminViewGUI::checkServerConnection ( array  $serverSettings)
protected

Definition at line 89 of file class.ilChatroomAdminViewGUI.php.

References ilChatroomServerConnector\checkServerConnection().

Referenced by saveClientSettings().

89  : void
90  {
91  if (
92  isset($serverSettings['port'], $serverSettings['address']) &&
93  !ilChatroomServerConnector::checkServerConnection(false)
94  ) {
95  $this->mainTpl->setOnScreenMessage('info', $this->ilLng->txt('chat_cannot_connect_to_server'));
96  }
97  }
ilChatroomServerConnector\checkServerConnection
static checkServerConnection(bool $use_cache=true)
Definition: class.ilChatroomServerConnector.php:35
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ createPublicRoom()

ilChatroomAdminViewGUI::createPublicRoom ( )

Definition at line 83 of file class.ilChatroomAdminViewGUI.php.

Referenced by forcePublicRoom().

83  : void
84  {
85  ilChatroomInstaller::createDefaultPublicRoom(true);
86  $this->mainTpl->setOnScreenMessage('success', $this->ilLng->txt('public_chat_created'), true);
87  }
+ Here is the caller graph for this function:

◆ createSettingTemplate()

ilChatroomAdminViewGUI::createSettingTemplate ( ilPropertyFormGUI  $form)
protected

Definition at line 99 of file class.ilChatroomAdminViewGUI.php.

References ilPropertyFormGUI\getHTML(), and getReadmePath().

Referenced by saveClientSettings().

99  : ilTemplate
100  {
101  $furtherInformation = sprintf($this->ilLng->txt('server_further_information'), $this->getReadmePath());
102  $serverTpl = new ilTemplate('tpl.chatroom_serversettings.html', true, true, 'components/ILIAS/Chatroom');
103  $serverTpl->setVariable('VAL_SERVERSETTINGS_FORM', $form->getHTML());
104  $serverTpl->setVariable('LBL_SERVERSETTINGS_FURTHER_INFORMATION', $furtherInformation);
105 
106  return $serverTpl;
107  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ defaultActions()

ilChatroomAdminViewGUI::defaultActions ( )
private

Definition at line 47 of file class.ilChatroomAdminViewGUI.php.

References forcePublicRoom().

Referenced by saveClientSettings().

47  : void
48  {
49  $chatSettings = new ilSetting('chatroom');
50  if ($chatSettings->get('chat_enabled', '0')) {
51  $this->forcePublicRoom();
52  }
53  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ executeDefault()

ilChatroomAdminViewGUI::executeDefault ( string  $requestedMethod)

Definition at line 42 of file class.ilChatroomAdminViewGUI.php.

42  : void
43  {
44  $this->ilCtrl->redirect($this->gui, 'view-clientsettings');
45  }

◆ forcePublicRoom()

ilChatroomAdminViewGUI::forcePublicRoom ( )

Definition at line 55 of file class.ilChatroomAdminViewGUI.php.

References $ref_id, ilObjChatroom\_getPublicRefId(), ilObject\_hasUntrashedReference(), ilObject\_lookupObjId(), createPublicRoom(), and ilObjectFactory\getInstanceByRefId().

Referenced by defaultActions().

55  : void
56  {
57  $ref_id = ilObjChatroom::_getPublicRefId();
58  if (!$ref_id) {
59  $this->createPublicRoom();
60  return;
61  }
62 
63  $instance = ilObjectFactory::getInstanceByRefId($ref_id, false);
64  if (!($instance instanceof ilObjChatroom)) {
65  $this->createPublicRoom();
66  return;
67  }
68 
69  $obj_id = ilObject::_lookupObjId($ref_id);
70  if (!$obj_id) {
71  $this->createPublicRoom();
72  return;
73  }
74 
75  if (!ilObject::_hasUntrashedReference($obj_id)) {
76  $this->createPublicRoom();
77  return;
78  }
79 
80  ilChatroomInstaller::ensureCorrectPublicChatroomTreeLocation($ref_id);
81  }
ilObject\_hasUntrashedReference
static _hasUntrashedReference(int $obj_id)
checks whether an object has at least one reference that is not in trash
Definition: class.ilObject.php:1105
ilObject\_lookupObjId
static _lookupObjId(int $ref_id)
Definition: class.ilObject.php:924
$ref_id
$ref_id
Definition: ltiauth.php:66
ilObjectFactory\getInstanceByRefId
static getInstanceByRefId(int $ref_id, bool $stop_on_error=true)
get an instance of an Ilias object by reference id
Definition: class.ilObjectFactory.php:141
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getReadmePath()

ilChatroomAdminViewGUI::getReadmePath ( )
protected

Definition at line 109 of file class.ilChatroomAdminViewGUI.php.

References ilUtil\_getHttpPath().

Referenced by createSettingTemplate().

109  : string
110  {
111  return ilUtil::_getHttpPath() . self::CHATROOM_README_PATH;
112  }
ilUtil\_getHttpPath
static _getHttpPath()
Definition: class.ilUtil.php:1322
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ saveClientSettings()

ilChatroomAdminViewGUI::saveClientSettings ( )

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

References checkServerConnection(), ilChatroom\checkUserPermissions(), createSettingTemplate(), defaultActions(), ilChatroomAdmin\loadGeneralSettings(), ilChatroomGUIHandler\redirectIfNoPermission(), and ilChatroomAdmin\saveClientSettings().

114  : void
115  {
116  $this->redirectIfNoPermission('write');
117 
118  $factory = new ilChatroomFormFactory();
119  $form = $factory->getClientSettingsForm();
120 
121  if (!$form->checkInput()) {
122  $form->setValuesByPost();
123  $this->clientsettings($form);
124  return;
125  }
126 
127  $convIdleStateTime = max(1, (int) $form->getInput('conversation_idle_state_in_minutes'));
128 
129  $settings = [
130  'name' => (string) $form->getInput('client_name'),
131  'enable_osc' => (bool) $form->getInput('enable_osc'),
132  'enable_browser_notifications' => (bool) $form->getInput('enable_browser_notifications'),
133  'conversation_idle_state_in_minutes' => $convIdleStateTime,
134  'chat_enabled' => (bool) $form->getInput('chat_enabled'),
135  'auth' => $form->getInput('auth')
136  ];
137 
138  if (!$settings['chat_enabled']) {
139  $settings['enable_osc'] = false;
140  }
141 
142  $chatSettings = new ilSetting('chatroom');
143  $chatSettings->set('chat_enabled', (string) $settings['chat_enabled']);
144  $chatSettings->set('enable_browser_notifications', (string) $settings['enable_browser_notifications']);
145  $chatSettings->set('conversation_idle_state_in_minutes', (string) $convIdleStateTime);
146  $chatSettings->set('enable_osc', (string) $settings['enable_osc']);
147 
148  $adminSettings = new ilChatroomAdmin($this->gui->getObject()->getId());
149  $adminSettings->saveClientSettings((object) $settings);
150 
151  $fileHandler = new ilChatroomConfigFileHandler();
152  $fileHandler->createClientConfigFile($settings);
153 
154  $this->mainTpl->setOnScreenMessage('success', $this->ilLng->txt('settings_has_been_saved'), true);
155  $this->ilCtrl->redirect($this->gui, 'view-clientsettings');
156  }
ilChatroomGUIHandler\redirectIfNoPermission
redirectIfNoPermission($permission)
Checks for requested permissions and redirects if the permission check failed.
Definition: class.ilChatroomGUIHandler.php:125
ilChatroomAdmin
Class ilChatroomAdmin.
Definition: class.ilChatroomAdmin.php:27
ilChatroomAdmin\saveClientSettings
saveClientSettings(stdClass $settings)
Saves given client $settings into settingsTable.
Definition: class.ilChatroomAdmin.php:112
+ Here is the call graph for this function:

Field Documentation

◆ $commonSettings

ilSetting ilChatroomAdminViewGUI::$commonSettings
protected

Definition at line 32 of file class.ilChatroomAdminViewGUI.php.

◆ CHATROOM_README_PATH

const ilChatroomAdminViewGUI::CHATROOM_README_PATH = '/components/ILIAS/Chatroom/README.md'
private

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

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