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
	editReferenceObject ()
	updateObject ()
	update object
	getTargetType ()
	get target type
	getReferenceType ()
	get reference type
	showTargetSelectionTreeObject ()
	Show target selection.
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 ()
	undeleteObject ()
	Get objects back from trash.
	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled
	cancelDeleteObject ()
	cancel deletion of object
	removeFromSystemObject ()
	remove objects from trash bin and all entries therefore every object needs a specific deleteObject() method
	cancelObject ($in_rep=false)
	cancel action and go back to previous page public
	cancelCreation ()
	cancel create action and go back to repository parent
	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.
	trashObject ()
	Show trash content of object.
	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl.
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI.
	copyWizardHasOptions ($a_mode)
	Check if there is any modules specific option.

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

Data Fields
const	MAX_SELECTION_ENTRIES = 50
const	MODE_CREATE = 1
const	MODE_EDIT = 2
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

Protected Member Functions
	initCreateForm ($a_new_type)
	Init object creation form.
	afterSave (ilObject $a_new_object)
	Post (successful) object creation hook.
	showSelection ()
	show selection of containers
	initFormSelection ()
	init form selection
	initFormEditSelection ()
	init form selection
	initTargetSelection ($a_mode=self::MODE_CREATE)
	Init copy from repository/search list commands.
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.
	showUpperIcon ()
	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)
	initCreationForms ($a_new_type)
	Init creation froms.
	getCreationFormsHTML (array $a_forms)
	Get HTML for creation forms (accordion)
	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.
	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)
	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.

Protected Attributes
	$existing_objects = array()

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 49 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 321 of file class.ilContainerReferenceGUI.php.

References $ilDB, ilObjectGUI\$lng, $path, $query, $res, $row, $title, and DB_FETCHMODE_OBJECT.

        {
                global $ilDB,$lng;
                
                $query = "SELECT obj_data.title obj_title,path_data.title path_title,child FROM tree ".
                        "JOIN object_reference obj_ref ON child = obj_ref.ref_id ".
                        "JOIN object_data obj_data ON obj_ref.obj_id = obj_data.obj_id ".
                        "JOIN object_reference path_ref ON parent = path_ref.ref_id ".
                        "JOIN object_data path_data ON path_ref.obj_id = path_data.obj_id ".
                        "WHERE ".$ilDB->in('child',$a_ref_ids,false,'integer').' '.
                        "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();
        }

ilContainerReferenceGUI::afterSave ( ilObject $a_new_object )

protected

Post (successful) object creation hook.

Parameters

ilObject $a_new_object

Reimplemented from ilObjectGUI.

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

References $_REQUEST, ilObject\_lookupObjId(), ilUtil\sendSuccess(), and ilObject\update().

        {               
                $target_obj_id = ilObject::_lookupObjId((int) $_REQUEST['target_id']);
                $a_new_object->setTargetId($target_obj_id);
                $a_new_object->update();
                
                ilUtil::sendSuccess($this->lng->txt("object_added"), true);
                $this->ctrl->returnToParent($this);
        }

Here is the call graph for this function:

ilContainerReferenceGUI::createObject ( )

Create object.

Returns: void

Reimplemented from ilObjectGUI.

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

References $_GET, $_REQUEST, $ilErr, $ilSetting, and initTargetSelection().

Referenced by saveObject().

        {
                global $ilUser,$ilAccess,$ilErr,$ilSetting;
                
                $new_type = $_REQUEST["new_type"];
                if(!$ilAccess->checkAccess("create_".$this->getReferenceType(),'',$_GET["ref_id"], $new_type))
                {
                        $ilErr->raiseError($this->lng->txt("permission_denied"),$ilErr->MESSAGE);
                }
                return $this->initTargetSelection(self::MODE_CREATE);
                
                /*
                if(!count($this->existing_objects = ilUtil::_getObjectsByOperations(
                        $this->getTargetType(),
                        'read',
                        $ilUser->getId(),
                        self::MAX_SELECTION_ENTRIES)))
                {
                        // TODO: No Objects with read permission found => send error message 
                        return false;
                }
                
                if(count($this->existing_objs) >= $max_entries)
                {
                        return $this->initTargetSelection();
                }
                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 155 of file class.ilContainerReferenceGUI.php.

References $ilSetting, and initTargetSelection().

Referenced by editReferenceObject(), and updateObject().

        {
                global $ilUser,$ilSetting,$ilTabs;
                
                $ilTabs->setTabActive('edit');
                
                $this->initTargetSelection(self::MODE_EDIT);
                
                /*
                $max_entries = $ilSetting->get('search_max_hits',10);
                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::editReferenceObject ( )

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

References editObject().

        {
                $this->editObject();
        }

Here is the call graph for this function:

ilContainerReferenceGUI::getReferenceType ( )

get reference type

public

Parameters

@return

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

Referenced by initFormEditSelection(), initFormSelection(), and showTargetSelectionTreeObject().

        {
                return $this->reference_type;
        }

Here is the caller graph for this function:

ilContainerReferenceGUI::getTargetType ( )

get target type

public

Parameters

@return

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

References $target_type.

Referenced by initFormEditSelection(), initFormSelection(), and showTargetSelectionTreeObject().

        {
                return $this->target_type;
        }

Here is the caller graph for this function:

ilContainerReferenceGUI::initCreateForm ( $a_new_type )

protected

Init object creation form.

Parameters

string $a_new_type

Returns: ilPropertyFormGUI

Reimplemented from ilObjectGUI.

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

        {
                include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
                $form = new ilPropertyFormGUI();
                return $form;
        }       

ilContainerReferenceGUI::initFormEditSelection ( )

protected

init form selection

protected

Returns

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

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

        {
                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:

ilContainerReferenceGUI::initFormSelection ( )

protected

init form selection

protected

Returns

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

References $_POST, 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::initTargetSelection ( $a_mode = self::MODE_CREATE )

protected

Init copy from repository/search list commands.

Returns

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

References $_GET, $_SESSION, $ilCtrl, $path, ilObjectGUI\$tree, and showTargetSelectionTreeObject().

Referenced by createObject(), and editObject().

        {
                global $ilCtrl, $tree;
                
                // empty session on init
                $_SESSION['ref_repexpand'] = array();
                
                // copy opened nodes from repository explorer           
                $_SESSION['ref_repexpand'] = is_array($_SESSION['repexpand']) ? $_SESSION['repexpand'] : array();
                
                // open current position
                
                if($a_mode == self::MODE_CREATE)
                {
                        $target = (int) $_GET['ref_id'];
                }
                else
                {
                        $target = (int) $this->object->getTargetRefId();
                }
                
                $path = $tree->getPathId($target);
                foreach((array) $path as $node_id)
                {
                        if(!in_array($node_id, $_SESSION['ref_repexpand']))
                        {
                                $_SESSION['ref_repexpand'][] = $node_id;
                        }
                }
                
                $_SESSION['ref_mode'] = $a_mode;
                
                $this->showTargetSelectionTreeObject();
        }

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 59 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 111 of file class.ilContainerReferenceGUI.php.

References $_REQUEST, createObject(), and ilUtil\sendFailure().

        {
                global $ilAccess;
                
                if(!(int) $_REQUEST['target_id'])
                {
                        ilUtil::sendFailure($this->lng->txt('select_one'));
                        $this->createObject();
                        return false;   
                }
                if(!$ilAccess->checkAccess('visible','',(int) $_REQUEST['target_id']))
                {
                        ilUtil::sendFailure($this->lng->txt('permission_denied'));
                        $this->createObject();
                        return false;   
                }
                
                parent::saveObject();           
        }

Here is the call graph for this function:

ilContainerReferenceGUI::showSelection ( )

protected

show selection of containers

protected

Returns

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

References initFormSelection().

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

Here is the call graph for this function:

ilContainerReferenceGUI::showTargetSelectionTreeObject ( )

Show target selection.

Returns

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

References $_GET, $_SESSION, $cmd, $ilCtrl, ilObjectGUI\$objDefinition, ilObjectGUI\$tpl, ilObjectGUI\$tree, getReferenceType(), getTargetType(), ilUtil\sendInfo(), and ilExplorer\setExpand().

Referenced by initTargetSelection().

        {
                global $ilTabs, $ilToolbar, $ilCtrl, $tree, $tpl, $objDefinition;
        
                include_once './Services/ContainerReference/classes/class.ilContainerSelectionExplorer.php';
                
                ilUtil::sendInfo($this->lng->txt($this->getReferenceType().'_edit_info'));
                if($_SESSION['ref_mode'] == self::MODE_CREATE)
                {
                        $ilToolbar->addButton($this->lng->txt('back'), $ilCtrl->getLinkTarget($this,'cancel'));
                        $this->ctrl->setParameter($this,'new_type',$this->getReferenceType());
                        $cmd = 'save';
                }
                else
                {
                        $ilTabs->setTabActive('edit');
                        $cmd = 'update';
                }
                $explorer = new ilContainerSelectionExplorer($this->ctrl->getLinkTarget($this,$cmd));
                
                if(isset($_GET['ref_repexpand']))
                {
                        $explorer->setExpand((int) $_GET['ref_repexpand']);
                }
                else
                {
                        $explorer->setExpand(ROOT_FOLDER_ID);
                }
                $explorer->setFrameTarget('_self');
                $explorer->setExpandTarget($this->ctrl->getLinkTarget($this,'showTargetSelectionTree'));
                $explorer->setTargetGet('target_id');
                $explorer->setTargetType($this->getTargetType());
                $explorer->setOutput(0);
                $this->tpl->setContent($explorer->getOutput());
        }

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 190 of file class.ilContainerReferenceGUI.php.

References $_REQUEST, ilObject\_lookupObjId(), ilObjectGUI\checkPermission(), editObject(), ilUtil\sendFailure(), and ilUtil\sendSuccess().

        {
                global $ilAccess;
                
                if(!(int) $_REQUEST['target_id'])
                {
                        ilUtil::sendFailure($this->lng->txt('select_one'));
                        $this->editObject();
                        return false;   
                }
                if(!$ilAccess->checkAccess('visible','',(int) $_REQUEST['target_id']))
                {
                        ilUtil::sendFailure($this->lng->txt('permission_denied'));
                        $this->editObject();
                        return false;   
                }
                $this->checkPermission('write');
                $target_obj_id = ilObject::_lookupObjId((int) $_REQUEST['target_id']);
                $this->object->setTargetId($target_obj_id);
                $this->object->update();
                
                ilUtil::sendSuccess($this->lng->txt('settings_saved'));
                $this->ctrl->redirect($this,'edit');
        }