Inheritance diagram for ilObjRecoveryFolderGUI:

Collaboration diagram for ilObjRecoveryFolderGUI:

Public Member Functions
	ilObjRecoveryFolderGUI ($a_data, $a_id, $a_call_by_reference)
	Constructor public.
	saveObject ()
	save object public
	removeFromSystemObject ()
	remove objects from trash bin and all entries therefore every object needs a specific deleteObject() method
&	executeCommand ()
	execute command
	showPossibleSubObjects ()
	show possible subobjects (pulldown menu)
	getActions ()
	Get Actions.
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
	assignObject ()
	prepareOutput ()
	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
	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)
	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.
	getCenterColumnHTML ()
	Get center column.
	getRightColumnHTML ()
	Display right column.
	checkPermission ($a_perm, $a_cmd="")
Public Member Functions inherited from ilContainerGUI
	ilContainerGUI ($a_data, $a_id, $a_call_by_reference=true, $a_prepare_output=true)
	Constructor public.
&	forwardToPageObject ()
	forward command to page object
	getContainerPageHTML ()
	Get container page HTML.
	prepareOutput ($a_show_subobjects=true)
	prepare output
	showTreeFlatIcon ()
	setTitleAndDescription ()
	called by prepare output
	renderObject ()
	render the object
	showAdministrationPanel (&$tpl)
	get container content (list of subitems) (this should include multiple lists in the future that together build the blocks of a container page)
	__showTimingsButton (&$tpl)
	showPermanentLink (&$tpl)
	show permanent link
	switchToStdEditorObject ()
	Switch to standard page editor.
	switchToOldEditorObject ()
	Switch to old page editor.
	useNewEditorObject ()
	Use new editor (-> delete xhtml content page)
	editPageFrameObject ()
	show page editor frameset
	editPageContentObject ()
	edit page content (for repository root node and categories)
	savePageContentObject ()
	cancelPageContentObject ()
	renderItemList ($a_type="all")
	showLinkListObject ()
	clearAdminCommandsDetermination ()
	cleaer administration commands determination
&	newBlockTemplate ()
	determin admin commands
	addHeaderRow (&$a_tpl, $a_type, $a_show_image=true)
	adds a header row to a block template
	addStandardRow (&$a_tpl, $a_html, $a_item_ref_id="", $a_item_obj_id="", $a_image_type="")
	adds a standard row to a block template
	addMessageRow (&$a_tpl, $a_message, $a_type)
	add message row
	resetRowType ()
	addSeparatorRow (&$a_tpl)
	setPageEditorTabs ()
	getTabs (&$tabs_gui)
	common tabs for all container objects (should be called at the end of child getTabs() method
	enableAdministrationPanelObject ()
	enable administration panel
	disableAdministrationPanelObject ()
	enable administration panel
	addToDeskObject ()
	subscribe item
	lockObject ()
	removeFromDeskObject ()
	unsubscribe item
	cutObject ()
	cut object(s) out from a container and write the information to clipboard
	linkObject ()
	create an new reference of an object in tree it's like a hard link of unix
	clearObject ()
	clear clipboard and go back to last object
	pasteObject ()
	paste object from clipboard to current place Depending on the chosen command the object(s) are linked, copied or moved
	copyObject ()
	copy object(s) out from a container and write the information to clipboard
	clipboardObject ()
	show clipboard
	showCustomIconsEditing ($a_input_colspan=1)
	show edit section of custom icons for container
	isActiveAdministrationPanel ()
	setColumnSettings ($column_gui)
	May be overwritten in subclasses.
	allowBlocksMoving ()
	Standard is to allow blocks moving.
	allowBlocksConfigure ()
	Standard is to allow blocks configuration.
	cloneWizardPageTreeObject ()
	public
	cloneWizardPageListObject ()
	public
	cloneWizardPageObject ($a_tree_view=true)
	Show clone wizard page for container objects.
	cloneAllObject ()
	Clone all object Overwritten method for copying container objects.
	copyWizardHasOptions ($a_mode)
	public
	saveSortingObject ()
	Save Sorting.
	cloneNodes ($srcRef, $dstRef, &$mapping, $newName=null)
	Recursively clones all nodes of the RBAC tree.
	modifyItemGUI (&$a_item_list_gui, $a_item_data, $a_show_path)
	Modify Item ListGUI for presentation in container.

Protected Member Functions
	isMediaFolder ($a_obj_id)
Protected Member Functions inherited from ilObjectGUI
	searchCloneSourceObject ()
	Search clone source by title.
	buildCloneSelect ($existing_objs)
	Build a select box for clonable objects (permission write)

Additional Inherited Members
Static Public Member Functions inherited from ilContainerGUI
static	_buildPath ($a_ref_id, $a_course_ref_id)
	build path
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

Detailed Description

Class ilObjRecoveryFolderGUI.

Author: Sascha Hofmann shofm.nosp@m.ann@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Version

Id:: class.ilObjRecoveryFolderGUI.php 20930 2009-08-06 11:53:48Z smeyer

ilObjRecoveryFolderGUI: ilPermissionGUI

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

Member Function Documentation

& ilObjRecoveryFolderGUI::executeCommand ( )

execute command

Reimplemented from ilObjectGUI.

Definition at line 125 of file class.ilObjRecoveryFolderGUI.php.

References $cmd, $ret, and ilObjectGUI\prepareOutput().

        {
                $next_class = $this->ctrl->getNextClass($this);
                $cmd = $this->ctrl->getCmd();
                $this->prepareOutput();
                switch($next_class)
                {
                        case 'ilpermissiongui':
                                include_once("./classes/class.ilPermissionGUI.php");
                                $perm_gui =& new ilPermissionGUI($this);
                                $ret =& $this->ctrl->forwardCommand($perm_gui);
                                break;
                        default:
                                if(!$cmd)
                                {
                                        $cmd = "view";
                                }
                                $cmd .= "Object";
                                $this->$cmd();
                                break;
                }
                return true;
        }

Here is the call graph for this function:

ilObjRecoveryFolderGUI::getActions ( )

Get Actions.

Reimplemented from ilObjectGUI.

Definition at line 161 of file class.ilObjRecoveryFolderGUI.php.

        {
                // standard actions for container
                return array(
                        "cut" => array("name" => "cut", "lng" => "cut"),
                        "clear" => array("name" => "clear", "lng" => "clear"),
                        "removeFromSystem" => array("name" => "removeFromSystem", "lng" => "btn_remove_system")
                );
        }

ilObjRecoveryFolderGUI::ilObjRecoveryFolderGUI	(	$a_data,
		$a_id,
		$a_call_by_reference
	)

Constructor public.

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

References ilObjectGUI\ilObjectGUI().

        {
                $this->type = "recf";
                $this->ilObjectGUI($a_data,$a_id,$a_call_by_reference,false);
        }

Here is the call graph for this function:

ilObjRecoveryFolderGUI::isMediaFolder ( $a_obj_id )

protected

Definition at line 171 of file class.ilObjRecoveryFolderGUI.php.

References $res, and DB_FETCHMODE_OBJECT.

Referenced by removeFromSystemObject().

        {
                global $ilDB;
                
                if(!is_array($this->media_pool_ids))
                {
                        $this->media_pool_ids = array();
                        $query = "SELECT child FROM mep_tree ";
                        $res = $ilDB->query($query);
                        while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                        {
                                $this->media_pool_ids[] = $row->child;
                        }
                }
                return in_array($a_obj_id,$this->media_pool_ids) ? true : false;
        }

Here is the caller graph for this function:

ilObjRecoveryFolderGUI::removeFromSystemObject ( )

remove objects from trash bin and all entries therefore every object needs a specific deleteObject() method

public

Reimplemented from ilObjectGUI.

Definition at line 72 of file class.ilObjRecoveryFolderGUI.php.

References $_GET, isMediaFolder(), ilObjectGUI\removeDeletedNodes(), and ilUtil\sendInfo().

        {
                global $rbacsystem;
                
                // AT LEAST ONE OBJECT HAS TO BE CHOSEN.
                if (!isset($_POST["id"]))
                {
                        $this->ilias->raiseError($this->lng->txt("no_checkbox"),$this->ilias->error_obj->MESSAGE);
                }
                $this->object->notify("removeFromSystem", $_GET["ref_id"],$_GET["parent_non_rbac_id"],$_GET["ref_id"],$_POST["trash_id"]);
                $affected_ids = array();
                
                // DELETE THEM
                foreach ($_POST["id"] as $id)
                {
                        // GET COMPLETE NODE_DATA OF ALL SUBTREE NODES
                        $node_data = $this->tree->getNodeData($id);
                        $subtree_nodes = $this->tree->getSubTree($node_data);
                        // remember already checked deleted node_ids
                        $checked[] = $id;
                        // dive in recursive manner in each already deleted subtrees and remove these objects too
                        $this->removeDeletedNodes($id, $checked, true, $affected_ids);
                        foreach ($subtree_nodes as $node)
                        {
                                $node_obj =& $this->ilias->obj_factory->getInstanceByRefId($node["ref_id"]);
                                
                                // this is due to bug #1860 (even if this will not completely fix it)
                                // and the fact, that media pool folders may find their way into
                                // the recovery folder (what results in broken pools, if the are deleted)
                                // Alex, 2006-07-21
                                #if ($node_obj->getType() != "fold")
                                
                                if($node_obj->getType() == 'fold' and $this->isMediaFolder($node_obj->getId()))
                                {
                                        continue;       
                                }
                                $node_obj->delete();
                        }
                        // FIRST DELETE ALL ENTRIES IN RBAC TREE
                        $this->tree->deleteTree($node_data);
                }
                
                ilUtil::sendInfo($this->lng->txt("msg_removed"),true);
                $this->ctrl->redirect($this, "view");
        }

Here is the call graph for this function:

ilObjRecoveryFolderGUI::saveObject ( )

save object public

Reimplemented from ilObjectGUI.

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

References exit, 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);
                exit();
        }

Here is the call graph for this function:

ilObjRecoveryFolderGUI::showPossibleSubObjects ( )

show possible subobjects (pulldown menu)

public

Reimplemented from ilObjectGUI.

Definition at line 153 of file class.ilObjRecoveryFolderGUI.php.

        {
                $this->sub_objects = "";
        }

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

Services/Administration/classes/class.ilObjRecoveryFolderGUI.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation