ilObjChatroomGUI Class Reference

Class ilObjChatroomGUI GUI class for chatroom objects. 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 ()
	@inheritDoc More...
	getSafePostCommands ()
	@inheritDoc More...
	executeCommand ()
	getConnector ()
	fallback ()
	Calls $this->prepareOutput method and sets template variable. More...
	settings ()
	Calls prepareOutput method. More...
	insertObject ()
Public Member Functions inherited from ilChatroomObjectGUI
	getConnector ()
	switchToVisibleMode ()
	Calls $this->prepareOutput() method. More...
	getAdminTabs ()
	administration tabs show only permissions and trash folder More...
Public Member Functions inherited from ilObjectGUI
	__construct ($data, int $id=0, bool $call_by_reference=true, bool $prepare_output=true)
	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] don't belong to the current 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...
	cancelDeleteObject ()
	cancel deletion of object More...
	cancelObject ()
	cancel action and go back to previous page More...
	createObject ()
	create new object form More...
	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)
	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html Should be overwritten and redirect to settings screen. More...
	addToDeskObject ()
	removeFromDeskObject ()
Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)
	getUnsafeGetCommands ()
	This method must return a list of unsafe GET commands. More...
	getSafePostCommands ()
	This method must return a list of safe POST commands. More...

Static Public Member Functions
static	_goto ($params)
	@ineritdoc More...
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 ()
	initCreationForms (string $new_type)
	Init creation forms. More...
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
Protected Member Functions inherited from ilChatroomObjectGUI
	dispatchCall (string $gui, string $method)
	getObjectDefinition ()
Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	assignObject ()
	setTitleAndDescription ()
	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...
	initCreationForms (string $new_type)
	Init creation forms. More...
	getCreationFormsHTML (array $forms)
	Get HTML for creation forms (accordion) More...
	initCreateForm (string $new_type)
	initDidacticTemplate (ilPropertyFormGUI $form)
	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...
	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...
	initImportForm (string $new_type)
	importFileObject (int $parent_id=null)
	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 ()
	@abstract 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...
	fillCloneTemplate (?string $tpl_name, string $type)
	Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. 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...
	showCustomIconsEditing ( $input_colspan=1, ilPropertyFormGUI $form=null, $as_section=true)
	show edit section of custom icons for container More...

Additional Inherited Members
Data Fields inherited from ilObjectGUI
const	ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION
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
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
Factory	$refinery
ilFavouritesManager	$favourites
ilObjectCustomIconFactory	$custom_icon_factory
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

Class ilObjChatroomGUI GUI class for chatroom objects.

Author

Jan Posselt <jposselt at databay.de>

Version

$Id$ @ilCtrl_Calls ilObjChatroomGUI: ilMDEditorGUI, ilInfoScreenGUI, ilPermissionGUI, ilObjectCopyGUI @ilCtrl_Calls ilObjChatroomGUI: ilExportGUI, ilCommonActionDispatcherGUI, ilPropertyFormGUI, ilExportGUI

Definition at line 33 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 35 of file class.ilObjChatroomGUI.php.

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

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

Here is the call graph for this function:

Member Function Documentation

_goto()

static ilObjChatroomGUI::_goto (   $params )

static

@ineritdoc

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

                                         : void
    {
        global $DIC;
        $main_tpl = $DIC->ui()->mainTemplate();
 
        $parts = array_filter(explode('_', $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
        );
    }

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

Here is the call graph for this function:

addLocatorItems()

ilObjChatroomGUI::addLocatorItems ( )

protected

should be overwritten to add object specific items (repository items are preloaded)

Reimplemented from ilObjectGUI.

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

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

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

Here is the call graph for this function:

executeCommand()

ilObjChatroomGUI::executeCommand

(

)

Reimplemented from ilObjectGUI.

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

                                    : 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 = '';
            if ($this->http->wrapper()->query()->has('baseClass')) {
                $baseClass = $this->http->wrapper()->query()->retrieve(
                    'baseClass',
                    $this->refinery->kindlyTo()->string()
                );
            }
            if (strtolower($baseClass) === strtolower(ilAdministrationGUI::class)) {
                $tabFactory->getAdminTabsForCommand($this->ctrl->getCmd());
            } else {
                $DIC['ilHelp']->setScreenIdComponent('chtr');
                $tabFactory->getTabsForCommand($this->ctrl->getCmd());
            }
        }
 
        // #8701 - infoscreen actions
        if ($this->ctrl->getCmd() !== 'info' && strtolower($next_class) === strtolower(ilInfoScreenGUI::class)) {
            $this->ctrl->setCmd('info-' . $this->ctrl->getCmd());
        }
 
        // repository info call
        if ($this->ctrl->getCmd() === 'infoScreen') {
            $this->ctrl->setCmdClass(ilInfoScreenGUI::class);
            $this->ctrl->setCmd('info');
        }
 
        switch (strtolower($next_class)) {
            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('-', $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 ($tabFactory !== null &&
            $tabFactory->getActivatedTab() !== null &&
            $this->tabs_gui->getActiveTab() !== $tabFactory->getActivatedTab()) {
            $this->tabs_gui->activateTab($tabFactory->getActivatedTab());
        }
    }

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

Here is the call graph for this function:

fallback()

ilObjChatroomGUI::fallback

(

)

Calls $this->prepareOutput method and sets template variable.

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

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

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

Here is the call graph for this function:

getConnector()

ilObjChatroomGUI::getConnector

(

)

Reimplemented from ilChatroomObjectGUI.

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

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

References ilChatroomAdmin\getDefaultConfiguration().

Here is the call graph for this function:

getObjectDefinition()

ilObjChatroomGUI::getObjectDefinition ( )

protected

Reimplemented from ilChatroomObjectGUI.

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

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

References ilChatroomObjectDefinition\getDefaultDefinition().

Here is the call graph for this function:

getRefId()

ilObjChatroomGUI::getRefId

(

)

Reimplemented from ilObjectGUI.

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

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

getSafePostCommands()

ilObjChatroomGUI::getSafePostCommands

(

)

@inheritDoc

Implements ilCtrlSecurityInterface.

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

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

getUnsafeGetCommands()

ilObjChatroomGUI::getUnsafeGetCommands

(

)

@inheritDoc

Implements ilCtrlSecurityInterface.

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

                                          : array
    {
        return [];
    }

initCreationForms()

ilObjChatroomGUI::initCreationForms ( string  $new_type )

protected

Init creation forms.

This will create the default creation forms: new, import, clone

Returns

array<int, ilPropertyFormGUI>

Reimplemented from ilObjectGUI.

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

                                                          : array
    {
        $forms = parent::initCreationForms($new_type);
 
        $forms[self::CFORM_NEW]->clearCommandButtons();
        $forms[self::CFORM_NEW]->addCommandButton('create-save', $this->lng->txt($new_type . '_add'));
        $forms[self::CFORM_NEW]->addCommandButton('cancel', $this->lng->txt('cancel'));
 
        return $forms;
    }

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

Here is the call graph for this function:

insertObject()

ilObjChatroomGUI::insertObject

(

)

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

                                  : ilObjChatroom
    {
        $new_type = $this->type;
        $refId = $this->http->wrapper()->query()->retrieve('ref_id', $this->refinery->kindlyTo()->int());
        $title = '';
        if ($this->http->wrapper()->post()->has('title')) {
            $title = ilUtil::stripSlashes(
                $this->http->wrapper()->post()->retrieve(
                    'title',
                    $this->refinery->kindlyTo()->string()
                )
            );
        }
        $desc = '';
        if ($this->http->wrapper()->post()->has('desc')) {
            $desc = ilUtil::stripSlashes(
                $this->http->wrapper()->post()->retrieve(
                    'desc',
                    $this->refinery->kindlyTo()->string()
                )
            );
        }
 
        // create permission is already checked in createObject.
        // This check here is done to prevent hacking attempts
        if (!$this->rbac_system->checkAccess('create', $refId, $new_type)) {
            $this->ilias->raiseError(
                $this->lng->txt('no_create_permission'),
                $this->ilias->error_obj->MESSAGE
            );
        }
 
        // create and insert object in objecttree
        $class_name = 'ilObj' . $this->obj_definition->getClassName($new_type);
 
        $newObj = new $class_name();
        $newObj->setType($new_type);
        $newObj->setTitle($title);
        $newObj->setDescription($desc);
        $newObj->create();
        $newObj->createReference();
        $newObj->putInTree($refId);
        $newObj->setPermissions($refId);
 
        $objId = $newObj->getId();
 
        $room = new ilChatroom();
        $room->saveSettings([
            'object_id' => $objId,
            'autogen_usernames' => 'Autogen #',
            'display_past_msgs' => 20,
            'private_rooms_enabled' => 0
        ]);
 
        $rbac_log_roles = $this->rbac_review->getParentRoleIds($newObj->getRefId());
        $rbac_log = ilRbacLog::gatherFaPa($newObj->getRefId(), array_keys($rbac_log_roles), true);
        ilRbacLog::add(ilRbacLog::CREATE_OBJECT, $newObj->getRefId(), $rbac_log);
 
        $this->object = $newObj;
 
        return $newObj;
    }

References $objId, $refId, ilObjectGUI\$type, ilRbacLog\add(), ilRbacLog\CREATE_OBJECT, ilRbacLog\gatherFaPa(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ilUtil\stripSlashes().

Here is the call graph for this function:

settings()

ilObjChatroomGUI::settings

(

)

Calls prepareOutput method.

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

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

References ilObjectGUI\prepareOutput().

Here is the call graph for this function:

---

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

• Modules/Chatroom/classes/class.ilObjChatroomGUI.php