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...
	sendResponse ($response, bool $isJson=false)
	Sends a json encoded response and exits the php process. 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...
	exitIfNoRoomModeratePermission (ilChatroom $room, int $subRoom, ilChatroomUser $chatUser)
	Check if user can moderate a chatroom. More...
	canModerate (ilChatroom $room, int $subRoom, int $usrId)
	isMainRoom (int $subRoomId)

Protected Attributes
ilSetting	$commonSettings
Protected Attributes inherited from ilChatroomGUIHandler
ilChatroomObjectGUI	$gui
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 = '/Modules/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().

    {
        global $DIC;

        parent::__construct($gui);
        $this->commonSettings = new ilSetting('common');
    }

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

                                                                   : void
    {
        if (
            isset($serverSettings['port'], $serverSettings['address']) &&
            !ilChatroomServerConnector::checkServerConnection(false)
        ) {
            $this->mainTpl->setOnScreenMessage('info', $this->ilLng->txt('chat_cannot_connect_to_server'));
        }
    }

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

                                      : void
    {
        ilChatroomInstaller::createDefaultPublicRoom(true);
        $this->mainTpl->setOnScreenMessage('success', $this->ilLng->txt('public_chat_created'), true);
    }

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

                                                                     : ilTemplate
    {
        $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 47 of file class.ilChatroomAdminViewGUI.php.

References forcePublicRoom().

Referenced by saveClientSettings().

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

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.

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

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

                                     : void
    {
        $ref_id = ilObjChatroom::_getPublicRefId();
        if (!$ref_id) {
            $this->createPublicRoom();
            return;
        }

        $instance = ilObjectFactory::getInstanceByRefId($ref_id, false);
        if (!($instance instanceof ilObjChatroom)) {
            $this->createPublicRoom();
            return;
        }

        $obj_id = ilObject::_lookupObjId($ref_id);
        if (!$obj_id) {
            $this->createPublicRoom();
            return;
        }

        if (!ilObject::_hasUntrashedReference($obj_id)) {
            $this->createPublicRoom();
            return;
        }

        ilChatroomInstaller::ensureCorrectPublicChatroomTreeLocation($ref_id);
    }

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

                                      : string
    {
        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

(

)

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

References $factory, ILIAS\LTI\ToolProvider\$settings, checkServerConnection(), ilChatroom\checkUserPermissions(), createSettingTemplate(), defaultActions(), ilChatroomAdmin\loadGeneralSettings(), ilChatroomGUIHandler\redirectIfNoPermission(), and ilChatroomAdmin\saveClientSettings().

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

        $factory = new ilChatroomFormFactory();
        $form = $factory->getClientSettingsForm();

        if (!$form->checkInput()) {
            $form->setValuesByPost();
            $this->clientsettings($form);
            return;
        }

        $convIdleStateTime = max(1, (int) $form->getInput('conversation_idle_state_in_minutes'));

        $settings = [
            'name' => (string) $form->getInput('client_name'),
            'enable_osc' => (bool) $form->getInput('enable_osc'),
            'enable_browser_notifications' => (bool) $form->getInput('enable_browser_notifications'),
            'conversation_idle_state_in_minutes' => $convIdleStateTime,
            'chat_enabled' => (bool) $form->getInput('chat_enabled'),
            'enable_smilies' => (bool) $form->getInput('enable_smilies'),
            'auth' => $form->getInput('auth')
        ];

        if (!$settings['chat_enabled']) {
            $settings['enable_osc'] = false;
        }

        $chatSettings = new ilSetting('chatroom');
        $chatSettings->set('chat_enabled', (string) $settings['chat_enabled']);
        $chatSettings->set('enable_browser_notifications', (string) $settings['enable_browser_notifications']);
        $chatSettings->set('conversation_idle_state_in_minutes', (string) $convIdleStateTime);
        $chatSettings->set('enable_osc', (string) $settings['enable_osc']);

        $adminSettings = new ilChatroomAdmin($this->gui->getObject()->getId());
        $adminSettings->saveClientSettings((object) $settings);

        $fileHandler = new ilChatroomConfigFileHandler();
        $fileHandler->createClientConfigFile($settings);

        $this->mainTpl->setOnScreenMessage('success', $this->ilLng->txt('settings_has_been_saved'), true);
        $this->ilCtrl->redirect($this->gui, 'view-clientsettings');
    }

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 = '/Modules/Chatroom/README.md'

private

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

---

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

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