Inheritance diagram for GUI:

Collaboration diagram for GUI:

Public Member Functions
ilObj< module_name >	GUI ($a_data, $a_id, $a_call_by_reference, $a_prepare_output=true)
	Constructor public.
	saveObject ()
	save object public
	getTabs (&$tabs_gui)
	get tabs public
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
	assignObject ()
	prepareOutput ()
	prepare output
	setTitleAndDescription ()
	called by prepare output
	showUpperIcon ()
	showMountWebfolderIcon ()
	setTabs ()
	set admin tabs public
	setAdminTabs ()
	set admin tabs public
	getAdminTabs (&$tabs_gui)
	administration tabs show only permissions and trash folder
	getHTML ()
	setActions ($a_actions="")
	set possible actions for objects in list.
	setSubObjects ($a_sub_objects="")
	set possible subobjects for this object.
	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)
	undeleteObject ()
	get object back from trash
	insertSavedNodes ($a_source_id, $a_dest_id, $a_tree_id, &$a_affected_ids)
	recursive method to insert all saved nodes of the clipboard (maybe this function could be moved to a rbac class ?)
	confirmedDeleteObject ()
	confirmed deletion if object -> objects are moved to trash
	cancelDeleteObject ()
	cancel deletion of object
	removeFromSystemObject ()
	remove objects from trash bin and all entries therefore every object needs a specific deleteObject() method
	removeDeletedNodes ($a_node_id, $a_checked, $a_delete_objects, &$a_affected_ids)
	remove already deleted objects within the objects in trash recursive function
	createObject ()
	create new object form
	cancelObject ($in_rep=false)
	cancel action and go back to previous page public
	importObject ()
	import new object form
	editObject ()
	edit object
	displayEditForm ($fields)
	display edit form (usually called by editObject)
	updateObject ()
	updates object entry in object_data
	afterUpdate ()
	permObject ()
	show permissions of current node
	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g.
	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
	permSaveObject ()
	save permissions
	isVisible ($a_ref_id, $a_type)
	displayList ()
	display object list
	viewObject ()
	list childs of current object
	deleteObject ($a_error=false)
	display deletion confirmation screen only for referenced objects.
	trashObject ()
	show trash content of object
	addRoleObject ()
	adds a local role This method is only called when choose the option 'you may add local roles'.
	showActions ($with_subobjects=false)
	show possible action (form buttons)
	getActions ()
	Get Actions.
	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
	__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="")
	infoObject ()
	__buildRoleFilterSelect ()
	__filterRoles ($a_roles, $a_filter)
	ownerObject ()
	changeOwnerObject ()
	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.
	fillCloneSearchTemplate ($a_tpl_varname, $a_type)
	Add an object search in case the number of existing objects is too big to offer a selection list.
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI.
	copyWizardHasOptions ($a_mode)
	Check if there is any modules specific option.
	getCenterColumnHTML ()
	Get center column.
	getRightColumnHTML ()
	Display right column.
	setColumnSettings ($column_gui)
	May be overwritten in subclasses.
	checkPermission ($a_perm, $a_cmd="")

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
Protected Member Functions inherited from ilObjectGUI
	searchCloneSourceObject ()
	Search clone source by title.
	buildCloneSelect ($existing_objs)
	Build a select box for clonable objects (permission write)

Detailed Description

Class ilObj<module_name>GUI.

Author: your name <your email>="">

Version

Id:: template.class.ilObjModuleNameGUI.php 13125 2007-01-29 15:37:36Z smeyer

Definition at line 35 of file template.class.ilObjModuleNameGUI.php.

Member Function Documentation

GUI::getTabs ( & $tabs_gui )

get tabs public

Parameters

object tabs gui object

Reimplemented from ilObjectGUI.

Definition at line 77 of file template.class.ilObjModuleNameGUI.php.

        {
                // tabs are defined manually here. The autogeneration via objects.xml will be deprecated in future
                // for usage examples see ilObjGroupGUI or ilObjSystemFolderGUI
        }

ilObj<module_name> GUI::GUI	(	$a_data,
		$a_id,
		$a_call_by_reference,
		$a_prepare_output = `true`
	)

Constructor public.

Definition at line 41 of file template.class.ilObjModuleNameGUI.php.

References ilObjectGUI\ilObjectGUI().

        {
                $this->type = "<type ID>";
                $this->ilObjectGUI($a_data,$a_id,$a_call_by_reference,$a_prepare_output);
        }

Here is the call graph for this function:

GUI::saveObject ( )

save object public

Reimplemented from ilObjectGUI.

Definition at line 51 of file template.class.ilObjModuleNameGUI.php.

References ilObjectGUI\getReturnLocation(), ilUtil\redirect(), and ilUtil\sendInfo().

        {
                global $rbacadmin;
                // create and insert forum in objecttree
                $newObj = parent::saveObject();
                // setup rolefolder & default local roles
                //$roles = $newObj->initDefaultRoles();
                // ...finally assign role to creator of object
                //$rbacadmin->assignUser($roles[0], $newObj->getOwner(), "y");
                // put here object specific stuff
                        
                // always send a message
                ilUtil::sendInfo($this->lng->txt("object_added"),true);
                
                ilUtil::redirect($this->getReturnLocation("save",$this->ctrl->getLinkTarget($this,"")));
        }

Here is the call graph for this function:

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

classes/template.class.ilObjModuleNameGUI.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation