ilChatroomSettingsGUI Class Reference

Class ilChatroomSettingsGUI. More...

Inheritance diagram for ilChatroomSettingsGUI:

Collaboration diagram for ilChatroomSettingsGUI:

Public Member Functions
	__construct (ilChatroomObjectGUI $gui)
	Constructor Requires ilChatroomFormFactory, ilChatroom and ilChatroomInstaller, sets $this->gui using given $gui and calls ilChatroomInstaller::install() method. More...
	saveGeneral ()
	Saves settings fetched from $_POST. More...
	general (ilPropertyFormGUI $settingsForm=null)
	Prepares and displays settings form. More...
	executeDefault ($requestedMethod)
Public Member Functions inherited from ilChatroomGUIHandler
	__construct (ilChatroomObjectGUI $gui)
	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...
	sendResponse ($response)
	Sends a json encoded response and exits the php process. More...
	hasPermission ($permission)
	Checks for access with ilRbacSystem. More...

Protected Attributes
	$object
Protected Attributes inherited from ilChatroomGUIHandler
	$gui
	$ilUser
	$ilCtrl
	$ilLng
	$webDirectory
	$obj_service
	$upload
	$rbacsystem
	$mainTpl
	$ilias
	$navigationHistory
	$tree
	$tabs

Additional Inherited Members
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)

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 10 of file class.ilChatroomSettingsGUI.php.

Constructor & Destructor Documentation

__construct()

ilChatroomSettingsGUI::__construct

(

ilChatroomObjectGUI

$gui

)

Constructor Requires ilChatroomFormFactory, ilChatroom and ilChatroomInstaller, sets $this->gui using given $gui and calls ilChatroomInstaller::install() method.

Parameters

ilChatroomObjectGUI

$gui

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

References ILIAS\GlobalScreen\Provider\__construct().

    {
        parent::__construct($gui);

        require_once 'Modules/Chatroom/classes/class.ilChatroomFormFactory.php';
        require_once 'Modules/Chatroom/classes/class.ilChatroom.php';
        require_once 'Modules/Chatroom/classes/class.ilChatroomInstaller.php';
    }

Here is the call graph for this function:

Member Function Documentation

executeDefault()

ilChatroomSettingsGUI::executeDefault

(

$requestedMethod

)

Parameters

string

$requestedMethod

Returns

void

Exceptions

ilDateTimeException

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

References general().

    {
        $this->general();
    }

Here is the call graph for this function:

general()

ilChatroomSettingsGUI::general

(

ilPropertyFormGUI

$settingsForm = null

)

Prepares and displays settings form.

Parameters

ilPropertyFormGUI

$settingsForm

Exceptions

ilDateTimeException

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

References ilChatroomFormFactory\applyValues(), ilChatroom\checkUserPermissions(), ilCtrl\getFormAction(), IL_CAL_UNIX, ilCtrl\redirectByClass(), ROOT_FOLDER_ID, ilUtil\sendInfo(), and ilCtrl\setParameterByClass().

Referenced by executeDefault(), and saveGeneral().

    {
        if (!ilChatroom::checkUserPermissions(array(
            'visible',
            'read'
        ), $this->gui->ref_id)
        ) {
            $this->ilCtrl->setParameterByClass('ilrepositorygui', 'ref_id', ROOT_FOLDER_ID);
            $this->ilCtrl->redirectByClass('ilrepositorygui', '');
        }

        $chatSettings = new ilSetting('chatroom');
        if (!$chatSettings->get('chat_enabled')) {
            ilUtil::sendInfo($this->ilLng->txt('server_disabled'), true);
        }

        $this->gui->switchToVisibleMode();

        $formFactory = new ilChatroomFormFactory();

        $room = ilChatRoom::byObjectId($this->gui->object->getId());

        if (!$settingsForm) {
            $settingsForm = $formFactory->getSettingsForm();

            require_once 'Services/Object/classes/class.ilObjectActivation.php';
            $settings = array(
                'title' => $this->gui->object->getTitle(),
                'desc' => $this->gui->object->getDescription(),
                'access_period' => array(
                    'start' => $this->gui->object->getAccessBegin() ? new ilDateTime(
                        $this->gui->object->getAccessBegin(),
                        IL_CAL_UNIX
                    ) : null,
                    'end' => $this->gui->object->getAccessEnd() ? new ilDateTime(
                        $this->gui->object->getAccessEnd(),
                        IL_CAL_UNIX
                    ) : null
                ),
                'access_visibility' => $this->gui->object->getAccessVisibility()
            );

            $presentationHeader = new ilFormSectionHeaderGUI();
            $presentationHeader->setTitle($this->ilLng->txt('settings_presentation_header'));
            $settingsForm->addItem($presentationHeader);
            $this->obj_service->commonSettings()->legacyForm($settingsForm, $this->gui->object)->addTileImage();

            if ($room) {
                ilChatroomFormFactory::applyValues(
                    $settingsForm,
                    array_merge($settings, $room->getSettings())
                );
            } else {
                ilChatroomFormFactory::applyValues($settingsForm, $settings);
            }
        }

        $settingsForm->setTitle($this->ilLng->txt('settings_title'));
        $settingsForm->addCommandButton('settings-saveGeneral', $this->ilLng->txt('save'));
        $settingsForm->setFormAction($this->ilCtrl->getFormAction($this->gui, 'settings-saveGeneral'));

        $this->mainTpl->setVariable('ADM_CONTENT', $settingsForm->getHtml());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveGeneral()

ilChatroomSettingsGUI::saveGeneral

(

)

Saves settings fetched from $_POST.

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

References $_POST, general(), IL_CAL_UNIX, ilCtrl\redirect(), ilObjectActivation\TIMINGS_ACTIVATION, and ilObjectActivation\TIMINGS_DEACTIVATED.

    {
        $formFactory = new ilChatroomFormFactory();
        $settingsForm = $formFactory->getSettingsForm();
        $this->obj_service->commonSettings()->legacyForm($settingsForm, $this->gui->object)->addTileImage();

        if (!$settingsForm->checkInput()) {
            $settingsForm->setValuesByPost();
            $this->general($settingsForm);
        } else {
            $this->gui->object->setTitle($settingsForm->getInput('title'));
            $this->gui->object->setDescription($settingsForm->getInput('desc'));

            require_once 'Services/Object/classes/class.ilObjectActivation.php';

            $period = $settingsForm->getItemByPostVar('access_period');
            if ($period->getStart() && $period->getEnd()) {
                $this->gui->object->setAccessType(ilObjectActivation::TIMINGS_ACTIVATION);
                $this->gui->object->setAccessBegin($period->getStart()->get(IL_CAL_UNIX));
                $this->gui->object->setAccessEnd($period->getEnd()->get(IL_CAL_UNIX));
                $this->gui->object->setAccessVisibility((int) $settingsForm->getInput('access_visibility'));
            } else {
                $this->gui->object->setAccessType(ilObjectActivation::TIMINGS_DEACTIVATED);
            }

            $this->gui->object->update();
            $this->obj_service->commonSettings()->legacyForm($settingsForm, $this->gui->object)->saveTileImage();
            // @todo: Do not rely on raw post data
            $settings = $_POST;
            $room = ilChatRoom::byObjectId($this->gui->object->getId());

            if (!$room) {
                $room = new ilChatRoom();
                $settings['object_id'] = $this->gui->object->getId();
            }
            $room->saveSettings($settings);

            ilUtil::sendSuccess($this->ilLng->txt('saved_successfully'), true);
            $this->ilCtrl->redirect($this->gui, 'settings-general');
        }
    }

Here is the call graph for this function:

Field Documentation

$object

ilChatroomSettingsGUI::$object

protected

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

---

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

• Modules/Chatroom/classes/gui/class.ilChatroomSettingsGUI.php