ilObjChatroomGUI Class Reference

Class ilObjChatroomGUI GUI class for chatroom objects. More...

Inheritance diagram for ilObjChatroomGUI:

Collaboration diagram for ilObjChatroomGUI:

Public Member Functions
	__construct ($a_data=null, $a_id=null, $a_call_by_reference=true)
	{} More...
	getRefId ()
	Returns RefId. More...
	_forwards ()
	Returns an empty array. More...
	executeCommand ()
	{execute command} More...
	getConnector ()
	fallback ()
	Calls $this->prepareOutput method and sets template variable. More...
	settings ()
	Calls prepareOutput method. More...
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
	executeCommand ()
	execute command More...
	withReferences ()
	determines wether objects are referenced or not (got ref ids or not) More...
	setCreationMode ($a_mode=true)
	if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui More...
	getCreationMode ()
	get creation mode More...
	prepareOutput ($a_show_subobjects=true)
	prepare output More...
	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 @access public More...
	createObject ()
	create new object form More...
	cancelCreation ()
	cancel create action and go back to repository parent More...
	saveObject ()
	save object More...
	getDidacticTemplateVar ($a_type)
	Get didactic template setting from creation screen. More...
	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...
	editObject ()
	edit object More...
	addExternalEditFormCustom (ilPropertyFormGUI $a_form)
	updateObject ()
	updates object entry in object_data More...
	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g. More...
	isVisible ($a_ref_id, $a_type)
	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...
	deleteObject ($a_error=false)
	Display deletion confirmation screen. More...
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI. More...
	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html. More...
	addToDeskObject ()
	@inheritDoc More...
	removeFromDeskObject ()
	@inheritDoc More...
Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Static Public Member Functions
static	_goto ($params)
	Overwrites $_GET['ref_id'] with given $ref_id. More...
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot ($a_raise_error=false)
	Goto repository root. More...
static	_gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
	Goto repository root. More...

Protected Member Functions
	getObjectDefinition ()
	Returns object definition by calling getDefaultDefinition method in ilChatroomObjectDefinition. More...
	initCreationForms ($a_new_type)
	{Init creation froms.this will create the default creation forms: new, import, clone Parameters string $a_new_type Returns array } More...
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	getObjectDefinition ()
Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	Get object service. More...
	assignObject ()
	setTitleAndDescription ()
	called by prepare output More...
	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...
	insertHeaderAction ($a_list_gui)
	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 @access public More...
	setAdminTabs ()
	set admin tabs @access public More...
	setLocator ()
	set Locator More...
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator ($a_omit=true)
	addAdminLocatorItems ($a_do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	initCreationForms ($a_new_type)
	Init creation froms. More...
	getCreationFormsHTML (array $a_forms)
	Get HTML for creation forms (accordion) More...
	initCreateForm ($a_new_type)
	Init object creation form. More...
	initDidacticTemplate (ilPropertyFormGUI $form)
	Show didactic template types. More...
	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...
	afterSave (ilObject $a_new_object)
	Post (successful) object creation hook. More...
	initEditForm ()
	Init object edit form. More...
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...
	getEditFormValues ()
	Get values for edit form. More...
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...
	validateCustom (ilPropertyFormGUI $a_form)
	Validate custom values (if not possible with checkInput()) More...
	updateCustom (ilPropertyFormGUI $a_form)
	Insert custom update form values into object. More...
	afterUpdate ()
	Post (successful) object update hook. More...
	initImportForm ($a_new_type)
	Init object import form. More...
	importFileObject ($parent_id=null, $a_catch_errors=true)
	Import. More...
	afterImport (ilObject $a_new_object)
	Post (successful) object import hook. More...
	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command More...
	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g. More...
	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command More...
	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command More...
	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) More...
	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl. More...
	getTabs ()
	get tabs abstract method. More...
	__showButton ($a_cmd, $a_text, $a_target='')
	hitsperpageObject ()
&	__initTableGUI ()
	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	standard implementation for tables use 'from' variable use different initial setting of table More...
	redirectToRefId ($a_ref_id, $a_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 $_GET["ref_id"] value More...
	fillCloneTemplate ($a_tpl_varname, $a_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...
	setColumnSettings (ilColumnGUI $column_gui)
	May be overwritten in subclasses. More...
	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error. More...
	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission. More...
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...
	handleAutoRating (ilObject $a_new_obj)
	Activate rating automatically if parent container setting. More...

Additional Inherited Members
Data Fields inherited from ilObjectGUI
const	ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION
const	COPY_WIZARD_NEEDS_PAGE = 1
	$objDefinition
	$tpl
	$tree
	$lng
	$data
	$object
	$ref_id
	$obj_id
	$maxcount
	$formaction
	$return_location
	$target_frame
	$tab_target_script
	$actions
	$sub_objects
	$omit_locator = false
const	CFORM_NEW = 1
const	CFORM_IMPORT = 2
const	CFORM_CLONE = 3
Protected Attributes inherited from ilObjectGUI
const	UPLOAD_TYPE_LOCAL = 1
const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2
	$ilErr
	$locator
	$user
	$access
	$rbacsystem
	$settings
	$rbacreview
	$toolbar
	$tmp_import_dir
	$tabs_gui = null
	$ctrl
	$object_service
	$favourites
	$request

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 19 of file class.ilObjChatroomGUI.php.

Constructor & Destructor Documentation

__construct()

ilObjChatroomGUI::__construct	(		$a_data = null,
			$a_id = null,
			$a_call_by_reference = true
	)

{}

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

    {
        if (in_array($_REQUEST['cmd'], array('getOSDNotifications', 'removeOSDNotifications'))) {
            require_once 'Services/Notifications/classes/class.ilNotificationGUI.php';
            $notifications = new ilNotificationGUI();
            $notifications->{$_REQUEST['cmd'] . 'Object'}();
            exit;
        }
 
        if ($a_data == null) {
            if ($_GET['serverInquiry']) {
                require_once dirname(__FILE__) . '/class.ilChatroomServerHandler.php';
                new ilChatroomServerHandler();
                return;
            }
        }
 
        $this->type = 'chtr';
        parent::__construct($a_data, $a_id, $a_call_by_reference, false);
        $this->lng->loadLanguageModule('chatroom');
        $this->lng->loadLanguageModule('chatroom_adm');
    }

References exit.

Member Function Documentation

_forwards()

ilObjChatroomGUI::_forwards

(

)

Returns an empty array.

Returns

array

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

    {
        return array();
    }

_goto()

static ilObjChatroomGUI::_goto (   $params )

static

Overwrites $_GET['ref_id'] with given $ref_id.

Parameters

string

$params

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

    {
        global $DIC;
 
        $parts = explode('_', $params);
        $ref_id = $parts[0];
        $sub = $parts[1];
 
        if (ilChatroom::checkUserPermissions('read', $ref_id, false)) {
            if ($sub) {
                $_REQUEST['sub'] = $_GET['sub'] = (int) $sub;
            }
            ilObjectGUI::_gotoRepositoryNode($ref_id, 'view');
        } elseif (ilChatroom::checkUserPermissions('visible', $ref_id, false)) {
            $DIC->ctrl()->setParameterByClass(ilInfoScreenGUI::class, 'ref_id', $ref_id);
            $DIC->ctrl()->redirectByClass(
                [
                    ilRepositoryGUI::class,
                    ilObjChatroomGUI::class,
                    ilInfoScreenGUI::class
                ],
                'info'
            );
        } elseif ($DIC->rbac()->system()->checkAccess('read', ROOT_FOLDER_ID)) {
            ilUtil::sendInfo(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 $_GET, $DIC, ilObjectGUI\_gotoRepositoryNode(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilChatroom\checkUserPermissions(), ROOT_FOLDER_ID, and ilUtil\sendInfo().

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 105 of file class.ilObjChatroomGUI.php.

    {
        global $DIC;
 
        if (is_object($this->object)) {
            $DIC['ilLocator']->addItem($this->object->getTitle(), $this->ctrl->getLinkTarget($this, 'view'), '', $this->getRefId());
        }
    }

References $DIC.

executeCommand()

ilObjChatroomGUI::executeCommand

(

)

{execute command}

Reimplemented from ilObjectGUI.

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

    {
        global $DIC;
 
        if ('cancel' == $this->ctrl->getCmd() && $this->getCreationMode()) {
            parent::cancelCreation();
            return;
        }
 
        // add entry to navigation history
        if (!$this->getCreationMode() && $DIC->access()->checkAccess('read', '', (int) $_GET['ref_id'])) {
            $DIC['ilNavigationHistory']->addItem($_GET['ref_id'], './goto.php?target=' . $this->type . '_' . $_GET['ref_id'], $this->type);
        }
 
        $next_class = $this->ctrl->getNextClass();
 
        require_once 'Modules/Chatroom/classes/class.ilChatroomTabGUIFactory.php';
        if (!$this->getCreationMode()) {
            $tabFactory = new ilChatroomTabGUIFactory($this);
 
            if (strtolower($_GET['baseClass']) == 'iladministrationgui') {
                $tabFactory->getAdminTabsForCommand($this->ctrl->getCmd());
            } else {
                $DIC['ilHelp']->setScreenIdComponent("chtr");
                $tabFactory->getTabsForCommand($this->ctrl->getCmd());
            }
        }
 
        // #8701 - infoscreen actions
        if ($next_class == 'ilinfoscreengui' && $this->ctrl->getCmd() != 'info') {
            $this->ctrl->setCmd('info-' . $this->ctrl->getCmd());
        }
        // repository info call
        if ($this->ctrl->getCmd() == 'infoScreen') {
            $this->ctrl->setCmdClass('ilinfoscreengui');
            $this->ctrl->setCmd('info');
        }
 
        switch ($next_class) {
            case "ilpropertyformgui":
                include_once "Services/Form/classes/class.ilPropertyFormGUI.php";
 
                require_once 'Modules/Chatroom/classes/class.ilChatroomFormFactory.php';
                $factory = new ilChatroomFormFactory();
                $form = $factory->getClientSettingsForm();
 
                $this->ctrl->forwardCommand($form);
                break;
            case 'ilpermissiongui':
                include_once 'Services/AccessControl/classes/class.ilPermissionGUI.php';
                $this->prepareOutput();
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;
 
            case 'ilexportgui':
                $this->prepareOutput();
 
                $GLOBALS['DIC']->tabs()->setTabActive('export');
 
                require_once 'Services/Export/classes/class.ilExportGUI.php';
                $exp = new ilExportGUI($this);
                $exp->addFormat('xml');
                $this->ctrl->forwardCommand($exp);
                break;
 
            case 'ilobjectcopygui':
                $this->prepareOutput();
                include_once 'Services/Object/classes/class.ilObjectCopyGUI.php';
                $cp = new ilObjectCopyGUI($this);
                $cp->setType('chtr');
                $this->ctrl->forwardCommand($cp);
                break;
 
            case "ilcommonactiondispatchergui":
                include_once("Services/Object/classes/class.ilCommonActionDispatcherGUI.php");
                $this->prepareOutput();
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                $this->ctrl->forwardCommand($gui);
                break;
 
            default:
                try {
                    $res = explode('-', $this->ctrl->getCmd(), 2);
                    $result = $this->dispatchCall($res[0], isset($res[1]) ? $res[1] : '');
                    if (!$result && method_exists($this, $this->ctrl->getCmd() . 'Object')) {
                        $this->prepareOutput();
                        $this->{$this->ctrl->getCmd() . 'Object'}();
                    }
                } catch (Exception $e) {
                    $error = array(
                        'success' => false,
                        'reason' => $e->getMessage()
                    );
                    echo json_encode($error);
                    exit;
                }
                break;
        }
    }

References $_GET, $DIC, Vendor\Package\$e, $factory, $GLOBALS, $res, $result, exit, and ilCommonActionDispatcherGUI\getInstanceFromAjaxCall().

Here is the call graph for this function:

fallback()

ilObjChatroomGUI::fallback

(

)

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

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

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

getConnector()

ilObjChatroomGUI::getConnector

(

)

Returns

ilChatroomServerConnector

Reimplemented from ilChatroomObjectGUI.

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

    {
        require_once 'Modules/Chatroom/classes/class.ilChatroomServerConnector.php';
        require_once 'Modules/Chatroom/classes/class.ilChatroomServerSettings.php';
        require_once 'Modules/Chatroom/classes/class.ilChatroomAdmin.php';
 
        $settings = ilChatroomAdmin::getDefaultConfiguration()->getServerSettings();
        $connector = new ilChatroomServerConnector($settings);
 
        return $connector;
    }

References ilChatroomAdmin\getDefaultConfiguration().

Here is the call graph for this function:

getObjectDefinition()

ilObjChatroomGUI::getObjectDefinition ( )

protected

Returns object definition by calling getDefaultDefinition method in ilChatroomObjectDefinition.

Returns

ilChatroomObjectDefinition

Reimplemented from ilChatroomObjectGUI.

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

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

References ilChatroomObjectDefinition\getDefaultDefinition().

Here is the call graph for this function:

getRefId()

ilObjChatroomGUI::getRefId

(

)

Returns RefId.

Returns

integer

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

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

initCreationForms()

ilObjChatroomGUI::initCreationForms (   $a_new_type )

protected

{Init creation froms.this will create the default creation forms: new, import, clone

Parameters

string

$a_new_type

Returns

array

}

Reimplemented from ilObjectGUI.

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

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

settings()

ilObjChatroomGUI::settings

(

)

Calls prepareOutput method.

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

    {
        $this->prepareOutput();
    }

---

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

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