Inheritance diagram for ilChatroomAdminViewGUI:

Collaboration diagram for ilChatroomAdminViewGUI:

Public Member Functions
	__construct (ilChatroomObjectGUI $gui)
	Constructor. More...

	executeDefault ($method)
	{} More...

	saveSettings ()
	Saves settings fetched from $_POST. More...

	serversettings (ilPropertyFormGUI $form=null)
	Prepares view form and displays it. More...

	forcePublicRoom ()

	createPublicRoom ()
	Creates a public chatroom. More...

	saveClientSettings ()
	Saves client settings fetched from $_POST. More...

	clientsettings (ilPropertyFormGUI $form=null)

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...

Data Fields
const	CHATROOM_README_PATH = '/Modules/Chatroom/README.md'

Protected Member Functions
	checkServerConnection (array $serverSettings)
	Checks for server connection. More...

	createSettingTemplate (ilPropertyFormGUI $form)

	getReadmePath ()
	Get the path to the README.txt file. More...

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

	$ilTpl

Protected Attributes inherited from ilChatroomGUIHandler
	$gui

	$ilUser

	$ilCtrl

	$ilLng

	$webDirectory

	$upload

Private Member Functions
	defaultActions ()

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 16 of file class.ilChatroomAdminViewGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilChatroomAdminViewGUI::__construct ( ilChatroomObjectGUI $gui )

Constructor.

Parameters

ilChatroomObjectGUI $gui

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

References $DIC.

     {
         global $DIC;
 
         parent::__construct($gui);
         $this->commonSettings = new ilSetting('common');
         $this->ilTpl          = $DIC->ui()->mainTemplate();
     }

Member Function Documentation

◆ checkServerConnection()

ilChatroomAdminViewGUI::checkServerConnection ( array $serverSettings )

protected

Checks for server connection.

If no connection if possible, show info in gui

Parameters

array $serverSettings

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

References ilChatroomServerConnector\checkServerConnection(), and ilUtil\sendInfo().

Referenced by clientsettings(), and serversettings().

     {
         require_once 'Modules/Chatroom/classes/class.ilChatroomServerConnector.php';
 
         if (
             $serverSettings['port'] &&
             $serverSettings['address'] &&
             !(boolean) @ilChatroomServerConnector::checkServerConnection(false)
         ) {
             ilUtil::sendInfo($this->ilLng->txt('chat_cannot_connect_to_server'));
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clientsettings()

ilChatroomAdminViewGUI::clientsettings ( ilPropertyFormGUI $form = null )

Parameters

ilPropertyFormGUI $form

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

References $factory, $form, checkServerConnection(), ilChatroom\checkUserPermissions(), createSettingTemplate(), defaultActions(), ilCtrl\getFormAction(), ilChatroomAdmin\loadGeneralSettings(), and ilChatroomGUIHandler\redirectIfNoPermission().

Referenced by saveClientSettings().

     {
         $this->redirectIfNoPermission('read');
 
         $this->defaultActions();
         $this->gui->switchToVisibleMode();
 
         $adminSettings  = new ilChatroomAdmin($this->gui->object->getId());
         $serverSettings = $adminSettings->loadGeneralSettings();
 
         if ($form === null) {
             $clientSettings = $adminSettings->loadClientSettings();
             $factory        = new ilChatroomFormFactory();
             $form           = $factory->getClientSettingsForm();
             $form->setValuesByArray($clientSettings);
         }
 
         $this->checkServerConnection($serverSettings);
 
         $form->setTitle($this->ilLng->txt('general_settings_title'));
         if (ilChatroom::checkUserPermissions('write', $this->gui->ref_id, false)) {
             $form->addCommandButton('view-saveClientSettings', $this->ilLng->txt('save'));
         }
         $form->setFormAction($this->ilCtrl->getFormAction($this->gui, 'view-saveClientSettings'));
 
         $settingsTpl = $this->createSettingTemplate($form);
         $this->ilTpl->setVariable('ADM_CONTENT', $settingsTpl->get());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createPublicRoom()

ilChatroomAdminViewGUI::createPublicRoom ( )

Creates a public chatroom.

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

References ilUtil\sendSuccess().

Referenced by forcePublicRoom().

     {
         require_once 'Modules/Chatroom/classes/class.ilChatroomInstaller.php';
         ilChatroomInstaller::createDefaultPublicRoom(true);
         ilUtil::sendSuccess($this->ilLng->txt('public_chat_created'), true);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createSettingTemplate()

ilChatroomAdminViewGUI::createSettingTemplate ( ilPropertyFormGUI $form )

protected

Parameters

ilPropertyFormGUI $form

Returns: ilTemplate

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

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

Referenced by clientsettings(), and serversettings().

     {
         $furtherInformation = sprintf($this->ilLng->txt('server_further_information'), $this->getReadmePath());
         $serverTpl          = new ilTemplate('tpl.chatroom_serversettings.html', true, true, 'Modules/Chatroom');
         $serverTpl->setVariable('VAL_SERVERSETTINGS_FORM', $form->getHTML());
         $serverTpl->setVariable('LBL_SERVERSETTINGS_FURTHER_INFORMATION', $furtherInformation);
 
         return $serverTpl;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ defaultActions()

ilChatroomAdminViewGUI::defaultActions ( )

private

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

References forcePublicRoom().

Referenced by clientsettings(), and serversettings().

     {
         $chatSettings = new ilSetting('chatroom');
         if ($chatSettings->get('chat_enabled', false)) {
             $this->forcePublicRoom();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeDefault()

ilChatroomAdminViewGUI::executeDefault ( $method )

{}

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

References ilCtrl\redirect().

     {
         $this->ilCtrl->redirect($this->gui, 'view-clientsettings');
     }

Here is the call graph for this function:

◆ forcePublicRoom()

ilChatroomAdminViewGUI::forcePublicRoom ( )

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

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

Referenced by defaultActions().

     {
         $ref_id = ilObjChatroom::_getPublicRefId();
         if (!$ref_id) {
             $this->createPublicRoom();
             return;
         }
 
         $instance = ilObjectFactory::getInstanceByRefId($ref_id, false);
         if (!$instance) {
             $this->createPublicRoom();
             return;
         }
 
         $obj_id = ilObject::_lookupObjId($ref_id);
         if (!$obj_id) {
             $this->createPublicRoom();
             return;
         }
 
         if (!ilObject::_hasUntrashedReference($obj_id)) {
             $this->createPublicRoom();
             return;
         }
 
         require_once 'Modules/Chatroom/classes/class.ilChatroomInstaller.php';
         ilChatroomInstaller::ensureCorrectPublicChatroomTreeLocation($ref_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getReadmePath()

ilChatroomAdminViewGUI::getReadmePath ( )

protected

Get the path to the README.txt file.

Returns: string

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

References ilUtil\_getHttpPath().

Referenced by createSettingTemplate().

     {
         return ilUtil::_getHttpPath() . self::CHATROOM_README_PATH;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveClientSettings()

ilChatroomAdminViewGUI::saveClientSettings ( )

Saves client settings fetched from $_POST.

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

References $factory, $form, array, clientsettings(), ilCtrl\redirect(), ilChatroomGUIHandler\redirectIfNoPermission(), ilChatroomAdmin\saveClientSettings(), and ilUtil\sendSuccess().

     {
         $this->redirectIfNoPermission('write');
 
         $factory = new ilChatroomFormFactory();
         $form    = $factory->getClientSettingsForm();
 
         if (!$form->checkInput()) {
             $form->setValuesByPost();
             $this->clientsettings($form);
             return;
         }
 
         $settings = array(
             'name'                  => (string) $form->getInput('client_name'),
             'enable_osd'            => (boolean) $form->getInput('enable_osd'),
             'enable_osc'            => (boolean) $form->getInput('enable_osc'),
             'osd_intervall'         => (int) $form->getInput('osd_intervall'),
             'chat_enabled'          => ((boolean) $form->getInput('chat_enabled')),
             'enable_smilies'        => (boolean) $form->getInput('enable_smilies'),
             'play_invitation_sound' => (boolean) $form->getInput('play_invitation_sound'),
             'auth'                  => $form->getInput('auth')
         );
 
         if (!$settings['chat_enabled']) {
             $settings['enable_osc'] = false;
         }
 
         $notificationSettings = new ilSetting('notifications');
         $notificationSettings->set('osd_polling_intervall', (int) $form->getInput('osd_intervall'));
         $notificationSettings->set('enable_osd', (boolean) $form->getInput('enable_osd'));
 
         $chatSettings = new ilSetting('chatroom');
         $chatSettings->set('chat_enabled', $settings['chat_enabled']);
         $chatSettings->set('enable_osc', $settings['enable_osc']);
         $chatSettings->set('play_invitation_sound', (boolean) $form->getInput('play_invitation_sound'));
 
         $adminSettings = new ilChatroomAdmin($this->gui->object->getId());
         $adminSettings->saveClientSettings((object) $settings);
 
         $fileHandler = new ilChatroomConfigFileHandler();
         $fileHandler->createClientConfigFile($settings);
 
         ilUtil::sendSuccess($this->ilLng->txt('settings_has_been_saved'), true);
         $this->ilCtrl->redirect($this->gui, 'view-clientsettings');
     }

Here is the call graph for this function:

◆ saveSettings()

ilChatroomAdminViewGUI::saveSettings ( )

Saves settings fetched from $_POST.

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

References $factory, $form, array, ilCtrl\redirect(), ilChatroomGUIHandler\redirectIfNoPermission(), ilChatroomAdmin\saveGeneralSettings(), ilUtil\sendSuccess(), and serversettings().

     {
         $this->redirectIfNoPermission('write');
 
         $factory = new ilChatroomFormFactory();
         $form    = $factory->getGeneralSettingsForm();
 
         if (!$form->checkInput()) {
             $form->setValuesByPost();
             $this->serversettings($form);
             return;
         }
 
         $settings = array(
             'protocol'     => $form->getInput('protocol'),
             'port'         => $form->getInput('port'),
             'address'      => $form->getInput('address'),
             'cert'         => $form->getInput('cert'),
             'key'          => $form->getInput('key'),
             'dhparam'      => $form->getInput('dhparam'),
             'log'          => $form->getInput('log'),
             'error_log'    => $form->getInput('error_log'),
             'ilias_proxy'  => $form->getInput('ilias_proxy'),
             'ilias_url'    => $form->getInput('ilias_url'),
             'client_proxy' => $form->getInput('client_proxy'),
             'client_url'   => $form->getInput('client_url'),
             'sub_directory'=> $form->getInput('sub_directory'),
             'deletion_mode'=> $form->getInput('deletion_mode'),
             'deletion_unit'=> $form->getInput('deletion_unit'),
             'deletion_value'=> $form->getInput('deletion_value'),
             'deletion_time' => $form->getInput('deletion_time'),
         );
 
         $adminSettings = new ilChatroomAdmin($this->gui->object->getId());
         $adminSettings->saveGeneralSettings((object) $settings);
 
         $fileHandler = new ilChatroomConfigFileHandler();
         $fileHandler->createServerConfigFile($settings);
 
         ilUtil::sendSuccess($this->ilLng->txt('settings_has_been_saved'), true);
         $this->ilCtrl->redirect($this->gui, 'view-serversettings');
     }

Here is the call graph for this function:

◆ serversettings()

ilChatroomAdminViewGUI::serversettings ( ilPropertyFormGUI $form = null )

Prepares view form and displays it.

Parameters

ilPropertyFormGUI $form

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

References $factory, $form, checkServerConnection(), ilChatroom\checkUserPermissions(), createSettingTemplate(), defaultActions(), ilCtrl\getFormAction(), ilChatroomAdmin\loadGeneralSettings(), and ilChatroomGUIHandler\redirectIfNoPermission().

Referenced by saveSettings().

     {
         $this->redirectIfNoPermission('read');
 
         $this->defaultActions();
         $this->gui->switchToVisibleMode();
 
         $adminSettings  = new ilChatroomAdmin($this->gui->object->getId());
         $serverSettings = $adminSettings->loadGeneralSettings();
 
         if ($form === null) {
             $factory = new ilChatroomFormFactory();
             $form    = $factory->getGeneralSettingsForm();
             $form->setValuesByArray($serverSettings);
         }
 
         $this->checkServerConnection($serverSettings);
 
         $form->setTitle($this->ilLng->txt('chatserver_settings_title'));
         if (ilChatroom::checkUserPermissions('write', $this->gui->ref_id, false)) {
             $form->addCommandButton('view-saveSettings', $this->ilLng->txt('save'));
         }
         $form->setFormAction($this->ilCtrl->getFormAction($this->gui, 'view-saveSettings'));
 
         $settingsTpl = $this->createSettingTemplate($form);
         $this->ilTpl->setVariable('ADM_CONTENT', $settingsTpl->get());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $commonSettings

ilChatroomAdminViewGUI::$commonSettings

protected

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

◆ $ilTpl

ilChatroomAdminViewGUI::$ilTpl

protected

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

◆ CHATROOM_README_PATH

const ilChatroomAdminViewGUI::CHATROOM_README_PATH = '/Modules/Chatroom/README.md'

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

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

Modules/Chatroom/classes/admingui/class.ilChatroomAdminViewGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkServerConnection()

◆ clientsettings()

◆ createPublicRoom()

◆ createSettingTemplate()

◆ defaultActions()

◆ executeDefault()

◆ forcePublicRoom()

◆ getReadmePath()

◆ saveClientSettings()

◆ saveSettings()

◆ serversettings()

Field Documentation

◆ $commonSettings

◆ $ilTpl

◆ CHATROOM_README_PATH