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)
	Constructor.
	_forwards ()
	Returns an empty array.
	getConnector ()
	fallback ()
	Calls $this->prepareOutput method and sets template variable.
	settings ()
	Calls prepareOutput method.
	getRefId ()
	Returns RefId.
Public Member Functions inherited from ilDBayObjectGUI
	switchToVisibleMode ()
	Calls $this->prepareOutput() method.
Public Member Functions inherited from ilObjectGUI
	ilObjectGUI ($a_data, $a_id=0, $a_call_by_reference=true, $a_prepare_output=true)
	Constructor public.
&	executeCommand ()
	execute command
	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
	getAdminTabs (&$tabs_gui)
	administration tabs show only permissions and trash folder
	getHTML ()
	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled
	cancelDeleteObject ()
	cancel deletion of object
	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.
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI.

Protected Member Functions
	getObjectDefinition ()
	Returns object definition by calling getDefaultDefinition method in ilDBayObjectDefinition.
	initCreationForms ($a_new_type)
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.
	setTabs ()
	set admin tabs public
	setAdminTabs ()
	set admin tabs public
	setLocator ()
	set Locator
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded)
	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)
	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl.
	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
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot ($a_raise_error=false)
	Goto repository root.
static	_gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
	Goto repository root.
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, ilCommonActionDispatcherGUI

Definition at line 19 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 27 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;
                        }
                }
                $this->type = 'chtr';
                parent::__construct($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 67 of file class.ilObjChatroomGUI.php.

        {
                return array();
        }

ilObjChatroomGUI::fallback ( )

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

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

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

ilObjChatroomGUI::getConnector ( )

Returns: ilChatroomServerConnector

Reimplemented from ilDBayObjectGUI.

Definition at line 170 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;
        }

ilObjChatroomGUI::getObjectDefinition ( )

protected

Returns object definition by calling getDefaultDefinition method in ilDBayObjectDefinition.

Returns: ilDBayObjectDefinition

Reimplemented from ilDBayObjectGUI.

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

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

ilObjChatroomGUI::initCreationForms ( $a_new_type )

protected

Parameters

string $a_new_type

Returns: array

Reimplemented from ilObjectGUI.

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

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

Calls prepareOutput method.

Definition at line 194 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