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

Private Member Functions
	defaultActions ()

Private Attributes
const string	CHATROOM_README_PATH = __DIR__ . '/../../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.

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

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

checkServerConnection()

ilChatroomAdminViewGUI::checkServerConnection ( array  $serverSettings )

protected

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

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

References ilChatroomServerConnector\checkServerConnection().

Here is the call graph for this function:

createPublicRoom()

ilChatroomAdminViewGUI::createPublicRoom

(

)

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

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

Referenced by forcePublicRoom().

Here is the caller graph for this function:

defaultActions()

ilChatroomAdminViewGUI::defaultActions ( )

private

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

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

References forcePublicRoom().

Here is the call graph for this function:

deliverDocumentation()

ilChatroomAdminViewGUI::deliverDocumentation

(

)

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

                                          : never
    {
        $this->redirectIfNoPermission(['visible','read']);
 
        $this->file_delivery->delivery()->inline(
            ILIAS\Filesystem\Stream\Streams::ofResource(
                fopen(self::CHATROOM_README_PATH, 'rb')
            ),
            basename(self::CHATROOM_README_PATH),
            'text/markdown'
        );
    }

References ilChatroomGUIHandler\redirectIfNoPermission().

Here is the call graph for this function:

executeDefault()

ilChatroomAdminViewGUI::executeDefault

(

string

$requestedMethod

)

Reimplemented from ilChatroomGUIHandler.

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

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

References ilCtrl\redirect().

Here is the call graph for this function:

forcePublicRoom()

ilChatroomAdminViewGUI::forcePublicRoom

(

)

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

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

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

Referenced by defaultActions().

Here is the call graph for this function:

Here is the caller graph for this function:

saveClientSettings()

ilChatroomAdminViewGUI::saveClientSettings

(

)

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

                                        : 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'),
            '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);
 
        $osc_accept_msg = $form->getInput('chat_osc_accept_msg');
        $broadcast_typing = $form->getInput('chat_broadcast_typing');
        if (in_array($osc_accept_msg, ['n', 'y'], true)) {
            $this->commonSettings->set('chat_osc_accept_msg', $osc_accept_msg);
        }
 
        if (in_array($broadcast_typing, ['n', 'y'], true)) {
            $this->commonSettings->set('chat_broadcast_typing', $broadcast_typing);
        }
 
        $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');
    }

References ilCtrl\redirect(), and ilChatroomGUIHandler\redirectIfNoPermission().

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 string ilChatroomAdminViewGUI::CHATROOM_README_PATH = __DIR__ . '/../../README.md'

private

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

---

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

• components/ILIAS/Chatroom/classes/admingui/class.ilChatroomAdminViewGUI.php