Inheritance diagram for ilObjChatroomGUI:

Collaboration diagram for ilObjChatroomGUI:

Public Member Functions
	__construct ($a_data=null, $a_id=null, $a_call_by_reference=true)
	Constructor.
	_forwards ()
	Returns an empty array.
	executeCommand ()
	Dispatches the command to the related executor class.
	getConnector ()
	Returns default connector for this room.
	fallback ()
	Calls $this->prepareOutput method and sets template variable.
	settings ()
	Calls prepareOutput method.
	insertObject ()
	Instantiates, prepares and returns object.
	getRefId ()
	Returns RefId.
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded)
Public Member Functions inherited from ilDBayObjectGUI
	switchToVisibleMode ()
	Calls $this->prepareOutput() method.
	getAdminTabs (&$tabs_gui)
	administration tabs show only permissions and trash folder
Public Member Functions inherited from ilObjectGUI
	ilObjectGUI ($a_data, $a_id=0, $a_call_by_reference=true, $a_prepare_output=true)
	Constructor public.
	withReferences ()
	determines wether objects are referenced or not (got ref ids or not)
	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
	getCreationMode ()
	get creation mode
	getHTML ()
	undeleteObject ()
	Get objects back from trash.
	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled
	cancelDeleteObject ()
	cancel deletion of object
	removeFromSystemObject ()
	remove objects from trash bin and all entries therefore every object needs a specific deleteObject() method
	cancelObject ($in_rep=false)
	cancel action and go back to previous page public
	createObject ()
	create new object form
	cancelCreation ()
	cancel create action and go back to repository parent
	saveObject ()
	save object
	editObject ()
	edit object
	updateObject ()
	updates object entry in object_data
	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g.
	isVisible ($a_ref_id, $a_type)
	viewObject ()
	list childs of current object
	deleteObject ($a_error=false)
	Display deletion confirmation screen.
	trashObject ()
	Show trash content of object.
	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl.
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI.
	copyWizardHasOptions ($a_mode)
	Check if there is any modules specific option.

Protected Member Functions
	getObjectDefinition ()
	Returns object definition by calling getDefaultDefinition method in ilDBayObjectDefinition.
	initCreationForms ($a_new_type)
	Init creation froms.
Protected Member Functions inherited from ilDBayObjectGUI
	dispatchCall ($task, $method)
	Loads end executes given $task.
Protected Member Functions inherited from ilObjectGUI
	assignObject ()
	prepareOutput ()
	prepare output
	setTitleAndDescription ()
	called by prepare output
	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu.
	insertHeaderAction ($a_list_gui)
	Insert header action into main template.
	addHeaderAction ()
	Add header action menu.
	redrawHeaderActionObject ()
	Ajax call: redraw action header only.
	showUpperIcon ()
	setTabs ()
	set admin tabs public
	setAdminTabs ()
	set admin tabs public
	setLocator ()
	set Locator
	omitLocator ($a_omit=true)
	addAdminLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded)
	getCreationFormsHTML (array $a_forms)
	Get HTML for creation forms (accordion)
	initCreateForm ($a_new_type)
	Init object creation form.
	initDidacticTemplate (ilPropertyFormGUI $form)
	Show didactic template types.
	addDidacticTemplateOptions (array &$a_options)
	Add custom templates.
	getDidacticTemplateVar ($a_type)
	Get didactic template setting from creation screen.
	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position.
	afterSave (ilObject $a_new_object)
	Post (successful) object creation hook.
	initEditForm ()
	Init object edit form.
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form.
	getEditFormValues ()
	Get values for edit form.
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields.
	updateCustom (ilPropertyFormGUI $a_form)
	Insert custom update form values into object.
	afterUpdate ()
	Post (successful) object update hook.
	initImportForm ($a_new_type)
	Init object import form.
	importFileObject ($parent_id=null)
	Import.
	afterImport (ilObject $a_new_object)
	Post (successful) object import hook.
	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command
	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g.
	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command
	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g.
	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command
	showPossibleSubObjects ()
	show possible subobjects (pulldown menu)
	getTitlesByRefId ($a_ref_ids)
	get Titles of objects this method is used for error messages in methods cut/copy/paste
	getTabs (&$tabs_gui)
	get tabs abstract method.
	__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
	__showClipboardTable ($a_result_set, $a_from="")
	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
	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.
	getCenterColumnHTML ()
	Get center column.
	getRightColumnHTML ()
	Display right column.
	setColumnSettings ($column_gui)
	May be overwritten in subclasses.
	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error.
	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission.

Additional Inherited Members
Data Fields inherited from ilObjectGUI
const	COPY_WIZARD_NEEDS_PAGE = 1
	$ilias
	$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

Detailed Description

Class ilObjChatroomGUI.

GUI class for chatroom objects.

Author: Jan Posselt <jposselt at databay.de>

Version: $Id$

ilObjChatroomGUI: ilMDEditorGUI, ilInfoScreenGUI, ilPermissionGUI, ilObjectCopyGUI ilObjChatroomGUI: ilExportGUI ilObjChatroomGUI: ilRepositoryGUI, ilpersonaldesktopgui, iladministrationgui, ilobjrootfoldergui

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

Constructor & Destructor Documentation

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

Constructor.

Parameters

array	$a_data
integer	$a_id
boolean	$a_call_by_reference

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

References $_REQUEST, and exit.

        {
                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;
                        }
                }
                /*require_once 'Modules/Chatroom/classes/class.ilChatroomServerConnector.php';
                 var_dump(  ilChatroomServerConnector::checkServerConnection());*/
                $this->type = 'chtr';
                $this->ilObjectGUI( $a_data, $a_id, $a_call_by_reference, false );
                $this->lng->loadLanguageModule( 'chatroom' );
                $this->lng->loadLanguageModule( 'chatroom_adm' );
        }

Member Function Documentation

ilObjChatroomGUI::_forwards ( )

Returns an empty array.

Returns: array

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

        {
                return array();
        }

ilObjChatroomGUI::addLocatorItems ( )

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

Reimplemented from ilObjectGUI.

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

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

ilObjChatroomGUI::executeCommand ( )

Dispatches the command to the related executor class.

ilCtrl2 $ilCtrl

Reimplemented from ilObjectGUI.

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

References $_GET, $ilCtrl, $res, $ret, and exit.

        {
                global $ilAccess, $ilNavigationHistory, $ilCtrl;
                if ('cancel' == $ilCtrl->getCmd() && $this->getCreationMode()) {
                    parent::cancelCreation();
                    return;
                }
                // add entry to navigation history
                if(!$this->getCreationMode() && $ilAccess->checkAccess('read', '', $_GET['ref_id']))
                {
                        $ilNavigationHistory->addItem($_GET['ref_id'], './goto.php?target=' . $this->type . '_' . $_GET['ref_id'], $this->type);
                }
                
                $next_class = $ilCtrl->getNextClass();
                require_once 'Modules/Chatroom/classes/class.ilChatroomTabFactory.php';
                if (!$this->getCreationMode()) {
                    $tabFactory = new ilChatroomTabFactory( $this );
                    
                    if(strtolower($_GET["baseClass"]) == "iladministrationgui") {
                        $tabFactory->getAdminTabsForCommand( $ilCtrl->getCmd() );
                    }
                    else {
                        $tabFactory->getTabsForCommand( $ilCtrl->getCmd() );
                    }
                }
                
                // #8701 - infoscreen actions
                if($next_class == "ilinfoscreengui" && $ilCtrl->getCmd() != "info")
                {
                        $ilCtrl->setCmd("info-".$ilCtrl->getCmd());
                }
                // repository info call
                if($ilCtrl->getCmd() == "infoScreen")
                {
                        $ilCtrl->setCmdClass("ilinfoscreengui");
                        $ilCtrl->setCmd("info"); 
                }
                switch($next_class)
                {                                                               
                        case 'ilpermissiongui':
                                include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
                                $this->prepareOutput();
                                $perm_gui = & new ilPermissionGUI( $this );
                                $ret = & $this->ctrl->forwardCommand( $perm_gui );
                                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;
                        default:
                                try
                                {
                                        $res = split( '-', $ilCtrl->getCmd(), 2 );
                                        $this->dispatchCall( $res[0], $res[1] ? $res[1] : '' );
                                }
                                catch (Exception $e)
                                {
                                        $error = array(
                                                'success' => false,
                                                'reason' => $e->getMessage()
                                        );
                                        echo json_encode($error);
                                        exit;
                                }
                }
        }

ilObjChatroomGUI::fallback ( )

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

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

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

ilObjChatroomGUI::getConnector ( )

Returns default connector for this room.

Returns: ilChatroomServerConnector

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

References ilChatroomAdmin\getDefaultConfiguration().

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

Here is the call graph for this function:

ilObjChatroomGUI::getObjectDefinition ( )

protected

Returns object definition by calling getDefaultDefinition method in ilDBayObjectDefinition.

Returns: ilDBayObjectDefinition

Reimplemented from ilDBayObjectGUI.

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

References ilDBayObjectDefinition\getDefaultDefinition().

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

Here is the call graph for this function:

ilObjChatroomGUI::getRefId ( )

Returns RefId.

Returns: integer

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

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

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

        {
                $forms = parent::initCreationForms($a_new_type);
                unset($forms[self::CFORM_IMPORT]);
                //unset($forms[self::CFORM_CLONE]);
                
                $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;
        }

ilObjChatroomGUI::insertObject ( )

Instantiates, prepares and returns object.

$class_name = "ilObj" . $objDefinition->getClassName( $new_type ). Fetches title from $_POST["title"], description from $_POST["desc"] and RefID from $_GET["ref_id"].

ilRbacSystem $rbacsystem ilObjectDefinition $objDefinition ilRbacReview $rbacreview

Returns: class_name

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

References $_GET, $_POST, $location, ilRbacLog\add(), ilRbacLog\CREATE_OBJECT, ilRbacLog\gatherFaPa(), and ilUtil\stripSlashes().

        {
                global $rbacsystem, $objDefinition, $rbacreview;
                $new_type = $this->type;
                // create permission is already checked in createObject.
                // This check here is done to prevent hacking attempts
                if( !$rbacsystem->checkAccess( "create", $_GET["ref_id"], $new_type ) )
                {
                        $this->ilias->raiseError(
                        $this->lng->txt( "no_create_permission" ),
                        $this->ilias->error_obj->MESSAGE
                        );
                }
                $location = $objDefinition->getLocation( $new_type );
                // create and insert object in objecttree
                $class_name = "ilObj" . $objDefinition->getClassName( $new_type );
                include_once($location . "/class." . $class_name . ".php");
                $newObj = new $class_name();
                $newObj->setType( $new_type );
                $newObj->setTitle( ilUtil::stripSlashes( $_POST["title"] ) );
                $newObj->setDescription( ilUtil::stripSlashes( $_POST["desc"] ) );
                $newObj->create();
                $newObj->createReference();
                $newObj->putInTree( $_GET["ref_id"] );
                $newObj->setPermissions( $_GET["ref_id"] );
                $objId = $newObj->getId();
                $room = new ilChatroom();
                $room->saveSettings(
                        array(
                        'object_id'                     => $objId,
                        'autogen_usernames'             => 'Autogen #',
                        'display_past_msgs'             => 20,
                        'private_rooms_enabled'         => 0
                ));
                // rbac log
                include_once "Services/AccessControl/classes/class.ilRbacLog.php";
                $rbac_log_roles = $rbacreview->getParentRoleIds( $newObj->getRefId(), false );
                $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;
        }

Here is the call graph for this function:

ilObjChatroomGUI::settings ( )

Calls prepareOutput method.

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

        {
                $this->prepareOutput();
        }

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

Modules/Chatroom/classes/class.ilObjChatroomGUI.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation