ilContainerReferenceGUI Class Reference

Inheritance diagram for ilContainerReferenceGUI:

Collaboration diagram for ilContainerReferenceGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference=true, $a_prepare_output=true)
	Constructor.
	redirectObject ()
	redirect to target
	createObject ()
	Create object.
	saveObject ()
	save object
	editObject ()
	edit object
	updateObject ()
	update object
	getTargetType ()
	get target type
	getReferenceType ()
	get reference type
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
	cancelObject ($in_rep=false)
	cancel action and go back to previous page public
	importObject ()
	import new object form
	displayEditForm ($fields)
	display edit form (usually called by editObject)
	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="")

Static Public Member Functions
static	_prepareSelection ($a_ref_ids, $a_target_type)
	Prepare selection of target objects.

Protected Member Functions
	showSelection ()
	show selection of containers
	initFormSelection ()
	init form selection
	initFormEditSelection ()
	init form selection
Protected Member Functions inherited from ilObjectGUI
	searchCloneSourceObject ()
	Search clone source by title.
	buildCloneSelect ($existing_objs)
	Build a select box for clonable objects (permission write)

Protected Attributes
	$existing_objects = array()

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

Detailed Description

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

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

Constructor & Destructor Documentation

ilContainerReferenceGUI::__construct	(		$a_data,
			$a_id,
			$a_call_by_reference = true,
			$a_prepare_output = true
	)

Constructor.

Parameters

@return

Reimplemented in ilObjCategoryReferenceGUI, and ilObjCourseReferenceGUI.

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

        {
                 parent::__construct($a_data, $a_id,$a_call_by_reference,$a_prepare_output);
        }

Member Function Documentation

static ilContainerReferenceGUI::_prepareSelection (   $a_ref_ids,   $a_target_type  )

static

Prepare selection of target objects.

public

Parameters

array

int array of ref ids

Definition at line 291 of file class.ilContainerReferenceGUI.php.

References ilObjectGUI\$lng, $res, $title, DB_FETCHMODE_OBJECT, and ilUtil\quoteArray().

        {
                global $ilDB,$lng;
                
                $query = "SELECT obj_data.title as obj_title,path_data.title as path_title,child FROM tree ".
                        "JOIN object_reference as obj_ref ON child = obj_ref.ref_id ".
                        "JOIN object_data as obj_data ON obj_ref.obj_id = obj_data.obj_id ".
                        "JOIN object_reference as path_ref ON parent = path_ref.ref_id ".
                        "JOIN object_data as path_data ON path_ref.obj_id = path_data.obj_id ".
                        "WHERE child IN (".implode(',',ilUtil::quoteArray($a_ref_ids)).") ".
                        "ORDER BY obj_data.title ";
                $res = $ilDB->query($query);
                
                $options[0] = $lng->txt('obj_'.$a_target_type.'_select');
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        if(strlen($title = $row->obj_title) > 40)
                        {
                                $title = substr($title,0,40).'...';
                        }
                        if(strlen($path = $row->path_title) > 40)
                        {
                                $path = substr($path,0,40).'...';
                        }
                        $options[$row->child] = ($title.' ('.$lng->txt('path').': '.$path.')');
                }
                return $options ? $options : array();
        }

Here is the call graph for this function:

ilContainerReferenceGUI::createObject

(

)

Create object.

Returns

void

Reimplemented from ilObjectGUI.

Definition at line 64 of file class.ilContainerReferenceGUI.php.

References $_GET, $ilErr, $ilSetting, ilUtil\_getObjectsByOperations(), getTargetType(), and showSelection().

Referenced by saveObject().

        {
                global $ilUser,$ilAccess,$ilErr,$ilSetting;
                
                $new_type = $_POST["new_type"] ? $_POST["new_type"] : $_GET["new_type"];
                if(!$ilAccess->checkAccess("create_".$this->getReferenceType(),'',$_GET["ref_id"], $new_type))
                {
                        $ilErr->raiseError($this->lng->txt("permission_denied"),$ilErr->MESSAGE);
                }

                $max_entries = $ilSetting->get('search_max_hits',100);
                $max_entries = 10000;
                
                if(!count($this->existing_objects = ilUtil::_getObjectsByOperations($this->getTargetType(),'read',$ilUser->getId(),$max_entries)))
                {
                        // TODO: No Objects with read permission found => send error message 
                        return false;
                }
                
                if(count($this->existing_objs) >= $max_entries)
                {
                        return $this->showSearchSelection(); 
                }
                else
                {
                        return $this->showSelection();
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilContainerReferenceGUI::editObject

(

)

edit object

public

Parameters

@return

Reimplemented from ilObjectGUI.

Definition at line 136 of file class.ilContainerReferenceGUI.php.

References $ilSetting, ilUtil\_getObjectsByOperations(), getTargetType(), and initFormEditSelection().

Referenced by updateObject().

        {
                global $ilUser,$ilSetting,$ilTabs;
                
                $ilTabs->setTabActive('edit');
                
                $max_entries = $ilSetting->get('search_max_hits',10000);
                $max_entries = 10000;
                if(!count($this->existing_objects = ilUtil::_getObjectsByOperations($this->getTargetType(),'read',$ilUser->getId(),$max_entries)))
                {
                        // TODO: No Objects with read permission found => send error message 
                        return false;
                }
                
                $this->initFormEditSelection();
                $this->tpl->setContent($this->form->getHTML());
                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilContainerReferenceGUI::getReferenceType

(

)

get reference type

public

Parameters

@return

Definition at line 278 of file class.ilContainerReferenceGUI.php.

Referenced by initFormEditSelection(), and initFormSelection().

        {
                return $this->reference_type;
        }

Here is the caller graph for this function:

ilContainerReferenceGUI::getTargetType

(

)

get target type

public

Parameters

@return

Definition at line 266 of file class.ilContainerReferenceGUI.php.

References $target_type.

Referenced by createObject(), editObject(), initFormEditSelection(), and initFormSelection().

        {
                return $this->target_type;
        }

Here is the caller graph for this function:

ilContainerReferenceGUI::initFormEditSelection ( )

protected

init form selection

protected

Returns

Definition at line 236 of file class.ilContainerReferenceGUI.php.

References ilUtil\getImagePath(), getReferenceType(), and getTargetType().

Referenced by editObject().

        {
                if(is_object($this->form))
                {
                        return true;
                }
                include_once('./Services/Form/classes/class.ilPropertyFormGUI.php');
                $this->form = new ilPropertyFormGUI();
                $this->form->setFormAction($this->ctrl->getFormAction($this));
                $this->form->setTitle($this->lng->txt($this->getReferenceType().'_edit'));
                $this->form->setTitleIcon(ilUtil::getImagePath('icon_'.$this->getReferenceType().'.gif'));
                
                // Show selection
                $select = new ilSelectInputGUI($this->lng->txt('objs_'.$this->getTargetType()),'target_id');
                $select->setValue($this->object->getTargetRefId());
                $select->setOptions(self::_prepareSelection($this->existing_objects,$this->getTargetType()));
                $select->setInfo($this->lng->txt($this->object->getType().'_edit_info'));
                $this->form->addItem($select);          
                
                $this->form->addCommandButton('update',$this->lng->txt('save'));
                $this->form->addCommandButton('cancel',$this->lng->txt('cancel'));
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilContainerReferenceGUI::initFormSelection ( )

protected

init form selection

protected

Returns

Definition at line 207 of file class.ilContainerReferenceGUI.php.

References ilUtil\getImagePath(), getReferenceType(), and getTargetType().

Referenced by showSelection().

        {
                if(is_object($this->form))
                {
                        return true;
                }
                include_once('./Services/Form/classes/class.ilPropertyFormGUI.php');
                $this->form = new ilPropertyFormGUI();
                $this->ctrl->setParameter($this,'new_type',$this->getReferenceType());
                $this->form->setFormAction($this->ctrl->getFormAction($this));
                $this->form->setTitle($this->lng->txt($this->getReferenceType().'_new'));
                $this->form->setTitleIcon(ilUtil::getImagePath('icon_'.$this->getReferenceType().'.gif'));
                
                // Show selection
                $select = new ilSelectInputGUI($this->lng->txt('objs_'.$this->getTargetType()),'target_id');
                $select->setOptions(self::_prepareSelection($this->existing_objects,$this->getTargetType()));
                $select->setInfo($this->lng->txt($_POST['new_type'].'_edit_info'));
                $this->form->addItem($select);          
                
                $this->form->addCommandButton('save',$this->lng->txt('save'));
                $this->form->addCommandButton('cancel',$this->lng->txt('cancel'));
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilContainerReferenceGUI::redirectObject

(

)

redirect to target

Parameters

@return

Definition at line 54 of file class.ilContainerReferenceGUI.php.

References ilUtil\redirect().

        {
                ilUtil::redirect('repository.php?ref_id='.$this->object->getTargetRefId());
        }

Here is the call graph for this function:

ilContainerReferenceGUI::saveObject

(

)

save object

public

Parameters

@return

Reimplemented from ilObjectGUI.

Definition at line 101 of file class.ilContainerReferenceGUI.php.

References ilObjectGUI\$ref_id, ilObjectGUI\$tree, ilObject\_lookupObjId(), createObject(), ilUtil\redirect(), and ilUtil\sendInfo().

        {
                global $ilAccess,$tree;
                
                if(!(int) $_POST['target_id'])
                {
                        ilUtil::sendInfo($this->lng->txt('select_one'));
                        $this->createObject();
                        return false;   
                }
                if(!$ilAccess->checkAccess('read','',(int) $_POST['target_id']))
                {
                        ilUtil::sendInfo($this->lng->txt('permission_denied'));
                        $this->createObject();
                        return false;   
                }
                
                $ref = parent::saveObject();
                
                $target_obj_id = ilObject::_lookupObjId((int) $_POST['target_id']);
                $ref->setTargetId($target_obj_id);
                $ref->update();
                
                $ref_id = $ref->getRefId();
                $parent = $tree->getParentId($ref_id);
                ilUtil::redirect('repository.php?ref_id='.$parent);
        }

Here is the call graph for this function:

ilContainerReferenceGUI::showSelection ( )

protected

show selection of containers

protected

Returns

Definition at line 194 of file class.ilContainerReferenceGUI.php.

References initFormSelection().

Referenced by createObject().

        {
                $this->initFormSelection();
                $this->tpl->setContent($this->form->getHTML());
                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilContainerReferenceGUI::updateObject

(

)

update object

public

Parameters

@return

Reimplemented from ilObjectGUI.

Definition at line 162 of file class.ilContainerReferenceGUI.php.

References ilObject\_lookupObjId(), editObject(), and ilUtil\sendInfo().

        {
                global $ilAccess;
                
                if(!(int) $_POST['target_id'])
                {
                        ilUtil::sendInfo($this->lng->txt('select_one'));
                        $this->editObject();
                        return false;   
                }
                if(!$ilAccess->checkAccess('edit','',(int) $_POST['target_id']))
                {
                        ilUtil::sendInfo($this->lng->txt('permission_denied'));
                        $this->editObject();
                        return false;   
                }

                $target_obj_id = ilObject::_lookupObjId((int) $_POST['target_id']);
                $this->object->setTargetId($target_obj_id);
                $this->object->update();
                
                ilUtil::sendInfo($this->lng->txt('settings_saved'));
                $this->editObject();
        }

Here is the call graph for this function:

Field Documentation

ilContainerReferenceGUI::$existing_objects = array()

protected

Definition at line 37 of file class.ilContainerReferenceGUI.php.

---

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

• Services/ContainerReference/classes/class.ilContainerReferenceGUI.php