ilObjChatroomGUI Class Reference

ilObjChatroomGUI: ilMDEditorGUI, ilInfoScreenGUI, ilPermissionGUI, ilObjectCopyGUI ilObjChatroomGUI: ilExportGUI, ilCommonActionDispatcherGUI, ilPropertyFormGUI, ilExportGUI More...

Inheritance diagram for ilObjChatroomGUI:

Collaboration diagram for ilObjChatroomGUI:

Public Member Functions
	__construct ($data=null, ?int $id=0, bool $call_by_reference=true, bool $prepare_output=true)
	getRefId ()
	getUnsafeGetCommands ()
	This method must return a list of unsafe GET commands. More...
	getSafePostCommands ()
	This method must return a list of safe POST commands. More...
	executeCommand ()
	getConnector ()
	fallback ()
	settings ()
Public Member Functions inherited from ilChatroomObjectGUI
	getConnector ()
	switchToVisibleMode ()
	Calls $this->prepareOutput() method. More...
	getAdminTabs ()
Public Member Functions inherited from ilObjectGUI
	getRefId ()
	setAdminMode (string $mode)
	getAdminMode ()
	getObject ()
	executeCommand ()
	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...
	setCreationMode (bool $mode=true)
	If true, a creation screen is displayed the current [ref_id] does belong to the parent class The mode is determined in ilRepositoryGUI. More...
	getCreationMode ()
	prepareOutput (bool $show_sub_objects=true)
	getAdminTabs ()
	administration tabs show only permissions and trash folder More...
	getHTML ()
	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...
	cancelObject ()
	cancel action and go back to previous page More...
	createObject ()
	create new object form More...
	editAvailabilityPeriodObject ()
	saveAvailabilityPeriodObject ()
	cancelCreation ()
	cancel create action and go back to repository parent More...
	saveObject ()
	getDidacticTemplateVar (string $type)
	Get didactic template setting from creation screen. More...
	putObjectInTree (ilObject $obj, int $parent_node_id=null)
	Add object to tree at given position. More...
	editObject ()
	addExternalEditFormCustom (ilPropertyFormGUI $form)
	updateObject ()
	updates object entry in object_data More...
	getFormAction (string $cmd, string $default_form_action="")
	Get form action for command (command is method name without "Object", e.g. More...
	isVisible (int $ref_id, string $type)
	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...
	deleteObject (bool $error=false)
	Display deletion confirmation screen. More...
	setColumnSettings (ilColumnGUI $column_gui)
	addToDeskObject ()
	removeFromDeskObject ()
Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Static Public Member Functions
static	_goto ($params)
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot (bool $raise_error=false)
	Goto repository root. More...
static	_gotoRepositoryNode (int $ref_id, string $cmd="")
static	_gotoSharedWorkspaceNode (int $wsp_id)

Protected Member Functions
	getObjectDefinition ()
	addLocatorItems ()
	createActionDispatcherGUI ()
	infoScreen ()
	afterImport (ilObject $new_object)
	afterSave (ilObject $new_object)
Protected Member Functions inherited from ilChatroomObjectGUI
	dispatchCall (string $gui, string $method)
	getObjectDefinition ()
Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	assignObject ()
	setTitleAndDescription ()
	createActionDispatcherGUI ()
	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...
	insertHeaderAction (?ilObjectListGUI $list_gui=null)
	Insert header action into main template. More...
	addHeaderAction ()
	Add header action menu. More...
	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...
	setTabs ()
	set admin tabs More...
	setAdminTabs ()
	set admin tabs More...
	setLocator ()
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator (bool $omit=true)
	addAdminLocatorItems (bool $do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	getCreationFormsHTML (StandardForm|ilPropertyFormGUI|array $form)
	getTitleForCreationFormPage ()
	getCreationFormTitle ()
	initCreateForm (string $new_type)
	didacticTemplatesToForm ()
	initDidacticTemplate (ilPropertyFormGUI $form)
	retrieveAdditionalDidacticTemplateOptions ()
	addAdoptContentLinkToToolbar ()
	addImportButtonToToolbar ()
	addAvailabilityPeriodButtonToToolbar (ilToolbarGUI $toolbar)
	parseDidacticTemplateVar (string $var, string $type)
	afterSave (ilObject $new_object)
	Post (successful) object creation hook. More...
	initEditForm ()
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...
	getEditFormValues ()
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...
	validateCustom (ilPropertyFormGUI $form)
	Validate custom values (if not possible with checkInput()) More...
	updateCustom (ilPropertyFormGUI $form)
	Insert custom update form values into object. More...
	afterUpdate ()
	Post (successful) object update hook. More...
	routeImportCmdObject ()
	importFile (string $file_to_import, string $path_to_uploaded_file_in_temp_dir)
	deleteUploadedImportFile (string $path_to_uploaded_file_in_temp_dir)
	afterImport (ilObject $new_object)
	Post (successful) object import hook. More...
	setFormAction (string $cmd, string $form_action)
	getReturnLocation (string $cmd, string $default_location="")
	Get return location for command (command is method name without "Object", e.g. More...
	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...
	getTargetFrame (string $cmd, string $default_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame (string $cmd, string $target_frame)
	Set specific target frame for command. More...
	showPossibleSubObjects ()
	show possible sub objects (pull down menu) More...
	getTabs ()
	overwrite in derived GUI class of your object type More...
	redirectToRefId (int $ref_id, string $cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current ["ref_id"] value of the request More...
	getCenterColumnHTML ()
	Get center column. More...
	getRightColumnHTML ()
	Display right column. More...
	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...
	getCreatableObjectTypes ()
	buildAddNewItemElements (array $subtypes, string $create_target_class=ilRepositoryGUI::class, ?int $redirect_target_ref_id=null,)
	buildGroup (string $create_target_class, array $obj_types_in_group, string $title, array $subtypes)

Additional Inherited Members
Data Fields inherited from ilObjectGUI
const	ADMIN_MODE_NONE = ""
const	ADMIN_MODE_SETTINGS = "settings"
const	ADMIN_MODE_REPOSITORY = "repository"
const	UPLOAD_TYPE_LOCAL = 1
const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2
const	CFORM_NEW = 1
const	CFORM_IMPORT = 2
const	CFORM_CLONE = 3
const	SUPPORTED_IMPORT_MIME_TYPES = [MimeType::APPLICATION__ZIP, MimeType::APPLICATION__X_ZIP_COMPRESSED]
Protected Attributes inherited from ilChatroomObjectGUI
GlobalHttpState	$http
Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service
ServerRequestInterface	$request
ilLocatorGUI	$locator
ilObjUser	$user
ilAccessHandler	$access
ilSetting	$settings
ilToolbarGUI	$toolbar
ilRbacAdmin	$rbac_admin
ilRbacSystem	$rbac_system
ilRbacReview	$rbac_review
ilObjectService	$object_service
ilObjectDefinition	$obj_definition
ilGlobalTemplateInterface	$tpl
ilTree	$tree
ilCtrl	$ctrl
ilErrorHandling	$error
ilLanguage	$lng
ilTabsGUI	$tabs_gui
ILIAS	$ilias
ArrayBasedRequestWrapper	$post_wrapper
RequestWrapper	$request_wrapper
Refinery	$refinery
ilFavouritesManager	$favourites
ilObjectCustomIconFactory	$custom_icon_factory
UIFactory	$ui_factory
UIRenderer	$ui_renderer
Filesystem	$temp_file_system
ilObject	$object = null
bool	$creation_mode = false
	$data
int	$id
bool	$call_by_reference = false
bool	$prepare_output
int	$ref_id
int	$obj_id
int	$maxcount
array	$form_action = []
array	$return_location = []
array	$target_frame = []
string	$tmp_import_dir
string	$sub_objects = ""
bool	$omit_locator = false
string	$type = ""
string	$admin_mode = self::ADMIN_MODE_NONE
int	$requested_ref_id = 0
int	$requested_crtptrefid = 0
int	$requested_crtcb = 0
string	$requested_new_type = ""
string	$link_params
string	$html = ""

Detailed Description

ilObjChatroomGUI: ilMDEditorGUI, ilInfoScreenGUI, ilPermissionGUI, ilObjectCopyGUI ilObjChatroomGUI: ilExportGUI, ilCommonActionDispatcherGUI, ilPropertyFormGUI, ilExportGUI

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

Constructor & Destructor Documentation

__construct()

ilObjChatroomGUI::__construct	(		$data = null,
		?int	$id = 0,
		bool	$call_by_reference = true,
		bool	$prepare_output = true
	)

Definition at line 31 of file class.ilObjChatroomGUI.php.

References ilObjectGUI\$call_by_reference, ilObjectGUI\$data, ilObjectGUI\$id, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\lng().

    {
        $this->type = 'chtr';
        parent::__construct($data, $id, $call_by_reference, false);
        $this->lng->loadLanguageModule('chatroom');
        $this->lng->loadLanguageModule('chatroom_adm');
    }

Here is the call graph for this function:

Member Function Documentation

_goto()

static ilObjChatroomGUI::_goto (   $params )

static

Definition at line 39 of file class.ilObjChatroomGUI.php.

References $DIC, $params, $parts, ilObjectGUI\$ref_id, ilObjectGUI\_gotoRepositoryNode(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilChatroom\checkUserPermissions(), ILIAS\Repository\int(), and ROOT_FOLDER_ID.

                                         : void
    {
        global $DIC;
        $main_tpl = $DIC->ui()->mainTemplate();

        $parts = array_filter(explode('_', (string) $params));
        $ref_id = (int) $parts[0];
        $sub = (int) ($parts[1] ?? 0);

        if (ilChatroom::checkUserPermissions('read', $ref_id, false)) {
            if ($sub) {
                $DIC->ctrl()->setParameterByClass(self::class, 'sub', $sub);
            }

            $DIC->ctrl()->setParameterByClass(self::class, 'ref_id', $ref_id);
            $DIC->ctrl()->redirectByClass(
                [
                    ilRepositoryGUI::class,
                    self::class,
                ],
                'view'
            );
        } elseif (ilChatroom::checkUserPermissions('visible', $ref_id, false)) {
            $DIC->ctrl()->setParameterByClass(ilInfoScreenGUI::class, 'ref_id', $ref_id);
            $DIC->ctrl()->redirectByClass(
                [
                    ilRepositoryGUI::class,
                    self::class,
                    ilInfoScreenGUI::class
                ],
                'info'
            );
        } elseif ($DIC->rbac()->system()->checkAccess('read', ROOT_FOLDER_ID)) {
            $main_tpl->setOnScreenMessage('info', sprintf(
                $DIC->language()->txt('msg_no_perm_read_item'),
                ilObject::_lookupTitle(ilObject::_lookupObjId($ref_id))
            ), true);
            ilObjectGUI::_gotoRepositoryNode(ROOT_FOLDER_ID);
        }

        $DIC['ilErr']->raiseError(
            sprintf(
                $DIC->language()->txt('msg_no_perm_read_item'),
                ilObject::_lookupTitle(ilObject::_lookupObjId($ref_id))
            ),
            $DIC['ilErr']->FATAL
        );
    }

Here is the call graph for this function:

addLocatorItems()

ilObjChatroomGUI::addLocatorItems ( )

protected

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

References ILIAS\Repository\ctrl(), getRefId(), ILIAS\Repository\locator(), and ILIAS\Repository\object().

                                        : void
    {
        if (is_object($this->object)) {
            $this->locator->addItem(
                $this->object->getTitle(),
                $this->ctrl->getLinkTarget($this, 'view'),
                '',
                $this->getRefId()
            );
        }
    }

Here is the call graph for this function:

afterImport()

ilObjChatroomGUI::afterImport ( ilObject  $new_object )

protected

Definition at line 293 of file class.ilObjChatroomGUI.php.

References $response, ilChatroom\byObjectId(), getConnector(), ilObject\getId(), ilObject\getOwner(), and ilObject\getTitle().

                                                        : void
    {
        $room = ilChatroom::byObjectId($new_object->getId());
        $connector = $this->getConnector();
        $response = $connector->sendCreatePrivateRoom($room->getRoomId(), $new_object->getOwner(), $new_object->getTitle());

        parent::afterImport($new_object);
    }

Here is the call graph for this function:

afterSave()

ilObjChatroomGUI::afterSave ( ilObject  $new_object )

protected

Definition at line 302 of file class.ilObjChatroomGUI.php.

References $response, ILIAS\Repository\ctrl(), getConnector(), ilObject\getId(), ilObject\getOwner(), ilObject\getRefId(), ilObject\getTitle(), and ILIAS\Repository\lng().

                                                      : void
    {
        $room = new ilChatroom();
        $room->saveSettings([
            'object_id' => $new_object->getId(),
            'autogen_usernames' => 'Autogen #',
            'display_past_msgs' => 100,
        ]);

        $connector = $this->getConnector();
        $response = $connector->sendCreatePrivateRoom(
            $room->getRoomId(),
            $new_object->getOwner(),
            $new_object->getTitle()
        );

        $this->tpl->setOnScreenMessage('success', $this->lng->txt('object_added'), true);
        $this->ctrl->setParameter($this, 'ref_id', $new_object->getRefId());
        $this->ctrl->redirect($this, 'settings-general');
    }

Here is the call graph for this function:

createActionDispatcherGUI()

ilObjChatroomGUI::createActionDispatcherGUI ( )

protected

Definition at line 241 of file class.ilObjChatroomGUI.php.

References $DIC, ilObjectGUI\$ref_id, ILIAS\Repository\object(), and ilCommonActionDispatcherGUI\TYPE_REPOSITORY.

                                                  : ilCommonActionDispatcherGUI
    {
        global $DIC;

        return new ilCommonActionDispatcherGUI(
            ilCommonActionDispatcherGUI::TYPE_REPOSITORY,
            new AccessBridge($DIC->rbac()->system()),
            $this->object->getType(),
            $this->ref_id,
            $this->object->getId()
        );
    }

Here is the call graph for this function:

executeCommand()

ilObjChatroomGUI::executeCommand

(

)

Definition at line 123 of file class.ilObjChatroomGUI.php.

References $DIC, Vendor\Package\$e, $GLOBALS, $refId, $res, ilObjectGUI\addHeaderAction(), ilObjectGUI\cancelCreation(), ilChatroom\checkPermissionsOfUser(), ILIAS\Repository\ctrl(), ilChatroomObjectGUI\dispatchCall(), ilObjectGUI\getCreationMode(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), ILIAS\FileDelivery\http(), infoScreen(), ilObjectGUI\prepareOutput(), ILIAS\Repository\refinery(), and ILIAS\Repository\user().

                                    : void
    {
        global $DIC;

        if ('cancel' === $this->ctrl->getCmd() && $this->getCreationMode()) {
            $this->cancelCreation();
            return;
        }

        $refId = $this->http->wrapper()->query()->retrieve('ref_id', $this->refinery->kindlyTo()->int());
        if (!$this->getCreationMode() && ilChatroom::checkPermissionsOfUser($this->user->getId(), 'read', $refId)) {
            $DIC['ilNavigationHistory']->addItem(
                $refId,
                './goto.php?target=' . $this->type . '_' . $refId,
                $this->type
            );
        }

        $next_class = $this->ctrl->getNextClass() ?? '';

        $tabFactory = null;
        if (!$this->getCreationMode()) {
            $tabFactory = new ilChatroomTabGUIFactory($this);

            $baseClass = $this->http->wrapper()->query()->retrieve(
                'baseClass',
                $this->refinery->byTrying([
                    $this->refinery->kindlyTo()->string(),
                    $this->refinery->always('')
                ])
            );
            if (strtolower($baseClass) === strtolower(ilAdministrationGUI::class)) {
                $tabFactory->getAdminTabsForCommand($this->ctrl->getCmd());
            } else {
                $DIC['ilHelp']->setScreenIdComponent('chtr');
                $tabFactory->getTabsForCommand($this->ctrl->getCmd());
            }
        }

        switch (strtolower($next_class)) {
            case strtolower(ilInfoScreenGUI::class):
                $this->infoScreen();
                break;

            case strtolower(ilPropertyFormGUI::class):
                $factory = new ilChatroomFormFactory();
                $form = $factory->getClientSettingsForm();
                $this->ctrl->forwardCommand($form);
                break;

            case strtolower(ilPermissionGUI::class):
                $this->prepareOutput();
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;

            case strtolower(ilExportGUI::class):
                $this->prepareOutput();

                $GLOBALS['DIC']->tabs()->setTabActive('export');

                $exp = new ilExportGUI($this);
                $exp->addFormat('xml');
                $this->ctrl->forwardCommand($exp);
                break;

            case strtolower(ilObjectCopyGUI::class):
                $this->prepareOutput();
                $cp = new ilObjectCopyGUI($this);
                $cp->setType('chtr');
                $this->ctrl->forwardCommand($cp);
                break;

            case strtolower(ilCommonActionDispatcherGUI::class):
                $this->prepareOutput();
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                $this->ctrl->forwardCommand($gui);
                break;

            default:
                try {
                    $res = explode('-', (string) $this->ctrl->getCmd(''), 2);
                    $result = $this->dispatchCall($res[0], $res[1] ?? '');
                    if (!$result && method_exists($this, $this->ctrl->getCmd() . 'Object')) {
                        $this->prepareOutput();
                        $this->{$this->ctrl->getCmd() . 'Object'}();
                    }
                } catch (Exception $e) {
                    if ($this->ctrl->isAsynch()) {
                        $responseStream = Streams::ofString(json_encode([
                            'success' => false,
                            'reason' => $e->getMessage()
                        ], JSON_THROW_ON_ERROR));
                        $this->http->saveResponse(
                            $this->http->response()
                                ->withBody($responseStream)
                                ->withHeader(ResponseHeader::CONTENT_TYPE, 'application/json')
                        );
                        $this->http->sendResponse();
                        $this->http->close();
                    } else {
                        throw $e;
                    }
                }
                break;
        }

        if ($this->object?->getType() !== 'chta') {
            $this->addHeaderAction();
        }

        if ($tabFactory !== null &&
            $tabFactory->getActivatedTab() !== null &&
            $this->tabs_gui->getActiveTab() !== $tabFactory->getActivatedTab()) {
            $this->tabs_gui->activateTab($tabFactory->getActivatedTab());
        }
    }

Here is the call graph for this function:

fallback()

ilObjChatroomGUI::fallback

(

)

Definition at line 282 of file class.ilObjChatroomGUI.php.

References ILIAS\Repository\lng(), and ilObjectGUI\prepareOutput().

                              : void
    {
        $this->prepareOutput();
        $this->tpl->setVariable('ADM_CONTENT', $this->lng->txt('invalid_operation'));
    }

Here is the call graph for this function:

getConnector()

ilObjChatroomGUI::getConnector

(

)

Definition at line 277 of file class.ilObjChatroomGUI.php.

References ilChatroomAdmin\getDefaultConfiguration().

Referenced by afterImport(), and afterSave().

                                  : ilChatroomServerConnector
    {
        return new ilChatroomServerConnector(ilChatroomAdmin::getDefaultConfiguration()->getServerSettings());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getObjectDefinition()

ilObjChatroomGUI::getObjectDefinition ( )

protected

Definition at line 88 of file class.ilObjChatroomGUI.php.

References ilChatroomObjectDefinition\getDefaultDefinition().

                                            : ilChatroomObjectDefinition
    {
        return ilChatroomObjectDefinition::getDefaultDefinition('Chatroom');
    }

Here is the call graph for this function:

getRefId()

ilObjChatroomGUI::getRefId

(

)

Definition at line 105 of file class.ilObjChatroomGUI.php.

Referenced by addLocatorItems().

                              : int
    {
        return $this->object->getRefId();
    }

Here is the caller graph for this function:

getSafePostCommands()

ilObjChatroomGUI::getSafePostCommands

(

)

This method must return a list of safe POST commands.

Safe post commands returned by this method will no longer be CSRF protected and will NOT be appended by an ilCtrlToken.

Returns

string[]

Implements ilCtrlSecurityInterface.

Definition at line 115 of file class.ilObjChatroomGUI.php.

                                         : array
    {
        return [
            'view-toggleAutoMessageDisplayState',
            'ban-handleTableActions',
        ];
    }

getUnsafeGetCommands()

ilObjChatroomGUI::getUnsafeGetCommands

(

)

This method must return a list of unsafe GET commands.

Unsafe get commands returned by this method will now be CSRF protected, which means an ilCtrlToken is appended each time a link-target is generated to the class implementing this interface with a command from that list.

Tokens will be validated in

See also

ilCtrlInterface::getCmd(), whereas the fallback command will be used if the CSRF validation fails.

Returns

string[]

Implements ilCtrlSecurityInterface.

Definition at line 110 of file class.ilObjChatroomGUI.php.

                                          : array
    {
        return [];
    }

infoScreen()

ilObjChatroomGUI::infoScreen ( )

protected

Definition at line 254 of file class.ilObjChatroomGUI.php.

References $refId, ilChatroom\checkUserPermissions(), ILIAS\Repository\ctrl(), ilObjectGUI\prepareOutput(), and ILIAS\Repository\refinery().

Referenced by executeCommand().

                                   : void
    {
        if (strtolower($this->ctrl->getCmd() ?? '') === 'info') {
            $this->ctrl->redirectByClass(ilInfoScreenGUI::class, 'showSummary');
        }

        $this->prepareOutput();

        $info = new ilInfoScreenGUI($this);

        $info->enablePrivateNotes();

        $refId = $this->request_wrapper->retrieve(
            'ref_id',
            $this->refinery->kindlyTo()->int()
        );
        if (ilChatroom::checkUserPermissions('read', $refId, false)) {
            $info->enableNews();
        }

        $this->ctrl->forwardCommand($info);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

settings()

ilObjChatroomGUI::settings

(

)

Definition at line 288 of file class.ilObjChatroomGUI.php.

References ilObjectGUI\prepareOutput().

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

Here is the call graph for this function:

---

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

• components/ILIAS/Chatroom/classes/class.ilObjChatroomGUI.php