ilChatroomSettingsGUI Class Reference

Class ilChatroomSettingsGUI. More...

Inheritance diagram for ilChatroomSettingsGUI:

Collaboration diagram for ilChatroomSettingsGUI:

Public Member Functions
	saveGeneral ()
	general (?\ILIAS\UI\Component\Input\Container\Form\Form $settingsForm=null)
	executeDefault (string $requestedMethod)
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)

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

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

Member Function Documentation

executeDefault()

ilChatroomSettingsGUI::executeDefault

(

string

$requestedMethod

)

Reimplemented from ilChatroomGUIHandler.

Definition at line 131 of file class.ilChatroomSettingsGUI.php.

                                                           : void
    {
        $this->general();
    }

References general().

Here is the call graph for this function:

general()

ilChatroomSettingsGUI::general

(

?\ILIAS\UI\Component\Input\Container\Form\Form

$settingsForm = null

)

Definition at line 93 of file class.ilChatroomSettingsGUI.php.

                                                                                                : void
    {
        if (!ilChatroom::checkUserPermissions(['visible', 'read'], $this->gui->getRefId())) {
            $this->ilCtrl->setParameterByClass(ilRepositoryGUI::class, 'ref_id', ROOT_FOLDER_ID);
            $this->ilCtrl->redirectByClass(ilRepositoryGUI::class);
        }
 
        $chatSettings = new ilSetting('chatroom');
        if (!$chatSettings->get('chat_enabled', '0')) {
            $this->mainTpl->setOnScreenMessage('info', $this->ilLng->txt('server_disabled'), true);
        }
 
        $this->gui->switchToVisibleMode();
 
        $formFactory = new ilChatroomFormFactory();
 
        $room = ilChatroom::byObjectId($this->gui->getObject()->getId());
 
        if ($settingsForm === null) {
            $settings = [
                'title' => $this->gui->getObject()->getTitle(),
                'desc' => $this->gui->getObject()->getDescription(),
            ];
            if ($room) {
                $settings = array_merge($settings, $room->getSettings());
            }
 
            $settingsForm = $formFactory->getSettingsForm(
                $this->gui,
                $this->ilCtrl,
                $settings,
                ilChatroom::checkUserPermissions(['write'], $this->gui->getRefId(), false)
            );
        }
 
        $this->mainTpl->setVariable('ADM_CONTENT', $this->uiRenderer->render($settingsForm));
    }

References ilChatroom\byObjectId(), ilChatroom\checkUserPermissions(), ilCtrl\redirectByClass(), ROOT_FOLDER_ID, and ilCtrl\setParameterByClass().

Referenced by executeDefault(), and saveGeneral().

Here is the call graph for this function:

Here is the caller graph for this function:

saveGeneral()

ilChatroomSettingsGUI::saveGeneral

(

)

Definition at line 29 of file class.ilChatroomSettingsGUI.php.

                                 : void
    {
        if (!ilChatroom::checkUserPermissions(['write'], $this->gui->getRefId())) {
            $this->ilCtrl->setParameterByClass(ilRepositoryGUI::class, 'ref_id', ROOT_FOLDER_ID);
            $this->ilCtrl->redirectByClass(ilRepositoryGUI::class);
        }
 
        $formFactory = new ilChatroomFormFactory();
 
        $settingsForm = $formFactory->getSettingsForm(
            $this->gui,
            $this->ilCtrl,
            null,
            true
        );
 
        $result = (new \ILIAS\Data\Factory())->error($this->ilLng->txt('form_input_not_valid'));
        if ($this->http->request()->getMethod() === 'POST') {
            $settingsForm = $settingsForm->withRequest($this->http->request());
            $result = $settingsForm->getInputGroup()->getContent();
        }
 
        if (!$result->isOK()) {
            $this->mainTpl->setOnScreenMessage('failure', $result->error());
            $this->general($settingsForm);
            return;
        }
 
        $values = $result->value();
 
        $this->gui->getObject()->getObjectProperties()->storePropertyTitleAndDescription(
            $values[ilChatroomFormFactory::PROP_TITLE_AND_DESC]
        );
        $this->gui->getObject()->getObjectProperties()->storePropertyIsOnline(
            $values[ilChatroomFormFactory::PROP_ONLINE_STATUS]
        );
        $this->gui->getObject()->getObjectProperties()->storePropertyTileImage(
            $values[ilChatroomFormFactory::PROP_TILE_IMAGE]
        );
 
        $room = ilChatroom::byObjectId($this->gui->getObject()->getId());
        $mutated_settings = $room->getSettings();
        if (!$room) {
            $room = new ilChatroom();
            $mutated_settings['object_id'] = $this->gui->getObject()->getId();
        }
 
        foreach ($mutated_settings as $setting => &$value) {
            if ($setting === ilChatroomFormFactory::PROP_ALLOW_CUSTOM_NAMES) {
                $value = is_array($values[$setting] ?? null);
            } elseif ($setting === ilChatroomFormFactory::PROP_AUTOGEN_USERNAMES) {
                $value = $values[ilChatroomFormFactory::PROP_ALLOW_CUSTOM_NAMES][ilChatroomFormFactory::PROP_AUTOGEN_USERNAMES] ?? '';
            } elseif (array_key_exists($setting, $values)) {
                $value = $values[$setting];
            }
        }
        unset($value);
 
        $room->saveSettings($mutated_settings);
 
        $this->mainTpl->setOnScreenMessage('success', $this->ilLng->txt('saved_successfully'), true);
        $this->ilCtrl->redirect($this->gui, 'settings-general');
    }

References ilChatroom\byObjectId(), ilChatroom\checkUserPermissions(), error(), general(), ILIAS\FileDelivery\http(), ilChatroomFormFactory\PROP_ALLOW_CUSTOM_NAMES, ilChatroomFormFactory\PROP_AUTOGEN_USERNAMES, ilChatroomFormFactory\PROP_ONLINE_STATUS, ilChatroomFormFactory\PROP_TILE_IMAGE, ilChatroomFormFactory\PROP_TITLE_AND_DESC, ilCtrl\redirect(), ilCtrl\redirectByClass(), ROOT_FOLDER_ID, and ilCtrl\setParameterByClass().

Here is the call graph for this function:

---

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

• components/ILIAS/Chatroom/classes/gui/class.ilChatroomSettingsGUI.php