Inheritance diagram for ilObjectGUIAdapter:

Collaboration diagram for ilObjectGUIAdapter:

Public Member Functions
	ilObjectGUIAdapter ($a_id, $a_call_by_reference, $a_prepare_output=true, $a_cmd= '')
	Constructor public.
	getId ()
	setCommand ($a_cmd)
	getCommand ()
	getType ()
	setType ($a_type)
	performAction ()
	__initGUIObject ($a_call_by_reference, $a_prepare_output=true)
	set admin 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
	saveObject ()
	save object
	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
	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="")
	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="")

Data Fields
	$gui_obj
	$ilias
	$tpl
	$lng
	$objDefinition
	$cmd
	$id
	$call_by_reference
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

Additional Inherited Members
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 ilObjectGUIAdapter.

Author: Stefan Meyer smeye.nosp@m.r@da.nosp@m.tabay.nosp@m..de

Id:: class.ilObjectGUIAdapter.php 15736 2008-01-16 12:47:06Z akill

Definition at line 36 of file class.ilObjectGUIAdapter.php.

Member Function Documentation

ilObjectGUIAdapter::__initGUIObject	(	$a_call_by_reference,
		$a_prepare_output = `true`
	)

set admin tabs public

Definition at line 215 of file class.ilObjectGUIAdapter.php.

References $location, $objDefinition, getId(), ilObjectFactory\getInstanceByObjId(), ilObjectFactory\getInstanceByRefId(), getType(), and setType().

Referenced by ilObjectGUIAdapter().

        {
                global $objDefinition;
                include_once "./classes/class.ilObjectFactory.php";
                // GET TYPE
                if($a_call_by_reference)
                {
                        $tmp_obj =& ilObjectFactory::getInstanceByRefId($this->getId());
                }
                else
                {
                        $tmp_obj =& ilObjectFactory::getInstanceByObjId($this->getId());
                }
                $this->setType($tmp_obj->getType());
                // INITIATE GUI CLASS
                $class_name = $objDefinition->getClassName($this->getType());
                $location = $objDefinition->getLocation($this->getType());
                $class_constr = "ilObj".$class_name."GUI";
                //INCLUDE CLASS
                include_once $location."/class.ilObj".$class_name."GUI.php";
                // CALL CONSTRUCTOR
                $this->gui_obj =& new $class_constr(array(),$this->getId(),$a_call_by_reference,$a_prepare_output);
                
                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjectGUIAdapter::getCommand ( )

Definition at line 84 of file class.ilObjectGUIAdapter.php.

References $cmd.

Referenced by performAction().

        {
                return $this->cmd;
        }

Here is the caller graph for this function:

ilObjectGUIAdapter::getId ( )

Definition at line 69 of file class.ilObjectGUIAdapter.php.

References $id.

Referenced by __initGUIObject().

        {
                return $this->id;
        }

Here is the caller graph for this function:

ilObjectGUIAdapter::getType ( )

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

Referenced by __initGUIObject(), and performAction().

        {
                return $this->type;
        }

Here is the caller graph for this function:

ilObjectGUIAdapter::ilObjectGUIAdapter	(	$a_id,
		$a_call_by_reference,
		$a_prepare_output = `true`,
		$a_cmd = `''`
	)

Constructor public.

Definition at line 52 of file class.ilObjectGUIAdapter.php.

References $ilias, $lng, $objDefinition, $tpl, __initGUIObject(), and setCommand().

        {
                global $ilias,$tpl,$objDefinition,$lng;
                $this->ilias =& $ilias;
                $this->tpl =& $tpl;
                $this->lng =& $lng;
                $this->objDefinition =& $objDefinition;
                $this->setCommand($a_cmd);
                $this->id = $a_id;
                $this->call_by_reference = $a_call_by_reference;
                $this->__initGUIObject($a_call_by_reference,$a_prepare_output);
        }

Here is the call graph for this function:

ilObjectGUIAdapter::performAction ( )

Definition at line 97 of file class.ilObjectGUIAdapter.php.

References getCommand(), and getType().

        {
                if($this->getCommand())
                {
                        $method = $this->getCommand()."Object";
                }
                else
                {
                        $method = $this->objDefinition->getFirstProperty($this->getType())."Object";
                }
                $this->gui_obj->$method();
                return true;
        }

Here is the call graph for this function:

ilObjectGUIAdapter::setCommand ( $a_cmd )

Definition at line 73 of file class.ilObjectGUIAdapter.php.

Referenced by ilObjectGUIAdapter().

        {
                if($a_cmd == "gateway" || $a_cmd == "post")
                {
                        @$this->cmd = key($_POST["cmd"]);
                }
                else
                {
                        $this->cmd = $a_cmd;
                }
        }

Here is the caller graph for this function:

ilObjectGUIAdapter::setType ( $a_type )

Definition at line 92 of file class.ilObjectGUIAdapter.php.

Referenced by __initGUIObject().

        {
                $this->type = $a_type;
        }

Here is the caller graph for this function:

Field Documentation

ilObjectGUIAdapter::$call_by_reference

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

ilObjectGUIAdapter::$cmd

Definition at line 44 of file class.ilObjectGUIAdapter.php.

Referenced by getCommand().

ilObjectGUIAdapter::$gui_obj

Definition at line 38 of file class.ilObjectGUIAdapter.php.

ilObjectGUIAdapter::$id

Definition at line 45 of file class.ilObjectGUIAdapter.php.

Referenced by getId().

ilObjectGUIAdapter::$ilias

Definition at line 39 of file class.ilObjectGUIAdapter.php.

Referenced by ilObjectGUIAdapter().

ilObjectGUIAdapter::$lng

Definition at line 41 of file class.ilObjectGUIAdapter.php.

Referenced by ilObjectGUIAdapter().

ilObjectGUIAdapter::$objDefinition

Definition at line 42 of file class.ilObjectGUIAdapter.php.

Referenced by __initGUIObject(), and ilObjectGUIAdapter().

ilObjectGUIAdapter::$tpl

Definition at line 40 of file class.ilObjectGUIAdapter.php.

Referenced by ilObjectGUIAdapter().

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

classes/class.ilObjectGUIAdapter.php

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Member Function Documentation

Field Documentation