ilObject2GUI Class Reference

New implementation of ilObjectGUI. More...

Inheritance diagram for ilObject2GUI:

Collaboration diagram for ilObject2GUI:

Public Member Functions
	__construct ($a_id=0, $a_id_type=self::REPOSITORY_NODE_ID, $a_parent_node_id=0)
	Constructor. More...
	executeCommand ()
	execute command More...
	delete ()
	Display delete confirmation form (repository/workspace switch) More...
	confirmedDelete ()
	Delete objects (repository/workspace switch) More...
	getHTML ()
	withReferences ()
	Final/Private declaration of unchanged parent methods. More...
	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 More...
	getCreationMode ()
	get creation mode More...
	prepareOutput ($a_show_subobjects=true)
	prepare output More...
	isVisible ($a_ref_id, $a_type)
	trash ()
	undelete ()
	cancelDelete ()
	removeFromSystem ()
	cloneAll ()
	view ()
	view object content (repository/workspace switch) More...
	getType ()
	Functions that must be overwritten. More...
	create ()
	Deleted in ilObject. More...
	save ()
	edit ()
	update ()
	cancel ()
	importFile ()
	Import. More...
Public Member Functions inherited from ilObjectGUI
	executeCommand ()
	execute command More...
	withReferences ()
	determines wether objects are referenced or not (got ref ids or not) More...
	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 More...
	getCreationMode ()
	get creation mode More...
	prepareOutput ($a_show_subobjects=true)
	prepare output More...
	getAdminTabs ()
	administration tabs show only permissions and trash folder More...
	getHTML ()
	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...
	cancelDeleteObject ()
	cancel deletion of object More...
	cancelObject ()
	cancel action and go back to previous page @access public More...
	createObject ()
	create new object form More...
	cancelCreation ()
	cancel create action and go back to repository parent More...
	saveObject ()
	save object More...
	editObject ()
	edit object More...
	addExternalEditFormCustom (ilPropertyFormGUI $a_form)
	updateObject ()
	updates object entry in object_data More...
	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g. More...
	isVisible ($a_ref_id, $a_type)
	viewObject ()
	list childs of current object More...
	deleteObject ($a_error=false)
	Display deletion confirmation screen. More...
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI. More...

Static Public Member Functions
static	handleAfterSaveCallback (ilObject $a_obj, $a_callback_ref_id)
	After creation callback. More...
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot ($a_raise_error=false)
	Goto repository root. More...
static	_gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
	Goto repository root. More...

Data Fields
	$tree
const	OBJECT_ID = 0
const	REPOSITORY_NODE_ID = 1
const	WORKSPACE_NODE_ID = 2
const	REPOSITORY_OBJECT_ID = 3
const	WORKSPACE_OBJECT_ID = 4
const	PORTFOLIO_OBJECT_ID = 5
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
	afterConstructor ()
	Do anything that should be done after constructor in here. More...
	assignObject ()
	create object instance as internal property (repository/workspace switch) More...
	getAccessHandler ()
	Get access handler. More...
	setLocator ()
	set Locator More...
	deleteConfirmation ()
	Display delete confirmation form (workspace specific) More...
	deleteConfirmedObjects ()
	Delete objects (workspace specific) More...
	setTitleAndDescription ()
	called by prepare output More...
	showUpperIcon ()
	omitLocator ($a_omit=true)
	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command More...
	getCenterColumnHTML ()
	Get center column. More...
	getRightColumnHTML ()
	Display right column. More...
	setColumnSettings (ilColumnGUI $column_gui)
	May be overwritten in subclasses. More...
	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error. More...
	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) More...
	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 More...
	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. More...
	fillCloneSearchTemplate ($a_tpl_varname, $a_type)
	searchCloneSource ()
	buildCloneSelect ($existing_objs)
	addAdminLocatorItems ($a_do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	setTabs ()
	create tabs (repository/workspace switch) More...
	getReturnLocation ($a_cmd, $a_location="")
	Deprecated functions. More...
	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command More...
	showActions ()
	getTabs ()
	get tabs abstract method. More...
	__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 More...
	addLocatorItems ()
	Functions to be overwritten. More...
	initCreationForms ($a_new_type)
	Init creation froms. More...
	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...
	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_node_id=null)
	Check permission. More...
	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...
	redrawHeaderAction ()
	Updating icons after ajax call. More...
	getPermanentLinkWidget ($a_append=null, $a_center=false)
	handleAutoRating (ilObject $a_new_obj)
	Activate rating automatically if parent container setting. More...
Protected Member Functions inherited from ilObjectGUI
	assignObject ()
	setTitleAndDescription ()
	called by prepare output More...
	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...
	insertHeaderAction ($a_list_gui)
	Insert header action into main template. More...
	addHeaderAction ()
	Add header action menu. More...
	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...
	showMountWebfolderIcon ()
	setTabs ()
	set admin tabs @access public More...
	setAdminTabs ()
	set admin tabs @access public More...
	setLocator ()
	set Locator More...
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator ($a_omit=true)
	addAdminLocatorItems ($a_do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	initCreationForms ($a_new_type)
	Init creation froms. More...
	getCreationFormsHTML (array $a_forms)
	Get HTML for creation forms (accordion) More...
	initCreateForm ($a_new_type)
	Init object creation form. More...
	initDidacticTemplate (ilPropertyFormGUI $form)
	Show didactic template types. More...
	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...
	getDidacticTemplateVar ($a_type)
	Get didactic template setting from creation screen. More...
	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...
	afterSave (ilObject $a_new_object)
	Post (successful) object creation hook. More...
	initEditForm ()
	Init object edit form. More...
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...
	getEditFormValues ()
	Get values for edit form. More...
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...
	validateCustom (ilPropertyFormGUI $a_form)
	Validate custom values (if not possible with checkInput()) More...
	updateCustom (ilPropertyFormGUI $a_form)
	Insert custom update form values into object. More...
	afterUpdate ()
	Post (successful) object update hook. More...
	initImportForm ($a_new_type)
	Init object import form. More...
	importFileObject ($parent_id=null, $a_catch_errors=true)
	Import. More...
	afterImport (ilObject $a_new_object)
	Post (successful) object import hook. More...
	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command More...
	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g. More...
	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command More...
	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command More...
	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) More...
	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl. More...
	getTabs ()
	get tabs abstract method. More...
	__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 More...
	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 More...
	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. More...
	getCenterColumnHTML ()
	Get center column. More...
	getRightColumnHTML ()
	Display right column. More...
	setColumnSettings (ilColumnGUI $column_gui)
	May be overwritten in subclasses. More...
	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error. More...
	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission. More...
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...
	handleAutoRating (ilObject $a_new_obj)
	Activate rating automatically if parent container setting. More...

Protected Attributes
	$object_id
	$node_id
	$creation_forms = array()
	$id_type = array()
	$parent_id
	$access_handler
Protected Attributes inherited from ilObjectGUI
	$tmp_import_dir
	$tabs_gui = null
	$ctrl

Private Member Functions
	displayList ()

Detailed Description

New implementation of ilObjectGUI.

(beta)

Differences to the ilObject implementation:

• no $this->ilias anymore
• no $this->tree anymore
• no $this->formaction anymore
• no $this->return_location anymore
• no $this->target_frame anymore
• no $this->actions anymore
• no $this->sub_objects anymore
• no $this->data anymore
• no $this->prepare_output anymore

All new modules should derive from this class.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 28 of file class.ilObject2GUI.php.

Constructor & Destructor Documentation

__construct()

ilObject2GUI::__construct	(		$a_id = 0,
			$a_id_type = self::REPOSITORY_NODE_ID,
			$a_parent_node_id = 0
	)

Constructor.

Parameters

int	$a_id
int	$a_id_type
int	$a_parent_node_id

Reimplemented in ilObjBibliographicGUI, ilObjBlogGUI, ilObjCloudGUI, ilObjFileGUI, ilObjPollGUI, ilObjPortfolioBaseGUI, ilObjRemoteCategoryGUI, ilObjRemoteCourseGUI, ilObjRemoteFileGUI, ilObjRemoteGlossaryGUI, ilObjRemoteGroupGUI, ilObjRemoteLearningModuleGUI, ilObjRemoteTestGUI, ilObjRemoteWikiGUI, ilObjContactAdministrationGUI, ilRemoteObjectBaseGUI, ilOrgUnitExtensionGUI, and ilObjectPluginGUI.

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

        {
                global $objDefinition, $tpl, $ilCtrl, $ilErr, $lng, $ilTabs, $tree, $ilAccess;
                
                if (!isset($ilErr))
                {
                        $ilErr = new ilErrorHandling();
                        $ilErr->setErrorHandling(PEAR_ERROR_CALLBACK,array($ilErr,'errorHandler'));
                }
                else
                {
                        $this->ilErr =& $ilErr;
                }
 
                $this->id_type = $a_id_type;
                $this->parent_id = $a_parent_node_id;
                $this->type = $this->getType();
                $this->html = "";
                
                // use globals instead?
                $this->tabs_gui = $ilTabs;
                $this->objDefinition = $objDefinition;
                $this->tpl = $tpl;
                $this->ctrl = $ilCtrl;
                $this->lng = $lng;
 
                $params = array();              
                switch($this->id_type)
                {
                        case self::REPOSITORY_NODE_ID:
                                $this->node_id = $a_id;
                                $this->object_id = ilObject::_lookupObjectId($this->node_id);
                                $this->tree = $tree;
                                $this->access_handler = $ilAccess;
                                $this->call_by_reference = true;  // needed for prepareOutput()
                                $params[] = "ref_id";
                                break;
 
                        case self::REPOSITORY_OBJECT_ID:
                                $this->object_id = $a_id;
                                $this->tree = $tree;
                                $this->access_handler = $ilAccess;
                                $params[] = "obj_id"; // ???
                                break;
 
                        case self::WORKSPACE_NODE_ID:
                                global $ilUser;
                                $this->node_id = $a_id;
                                include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceTree.php";
                                $this->tree = new ilWorkspaceTree($ilUser->getId());
                                $this->object_id = $this->tree->lookupObjectId($this->node_id);                         
                                include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceAccessHandler.php";
                                $this->access_handler = new ilWorkspaceAccessHandler($this->tree);
                                $params[] = "wsp_id";
                                break;
 
                        case self::WORKSPACE_OBJECT_ID:
                                global $ilUser;
                                $this->object_id = $a_id;
                                include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceTree.php";
                                $this->tree = new ilWorkspaceTree($ilUser->getId());
                                include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceAccessHandler.php";
                                $this->access_handler = new ilWorkspaceAccessHandler($this->tree);
                                $params[] = "obj_id"; // ???
                                break;
                        
                        case self::PORTFOLIO_OBJECT_ID:
                                $this->object_id = $a_id;
                                include_once('./Modules/Portfolio/classes/class.ilPortfolioAccessHandler.php');
                                $this->access_handler = new ilPortfolioAccessHandler();
                                $params[] = "prt_id";
                                break;
 
                        case self::OBJECT_ID:
                                $this->object_id = $a_id;
                                include_once "Services/Object/classes/class.ilDummyAccessHandler.php";
                            $this->access_handler = new ilDummyAccessHandler();
                                $params[] = "obj_id";
                                break;
                }
                $this->ctrl->saveParameter($this, $params);
 
 
                
                // old stuff for legacy code (obsolete?)
                if(!$this->object_id)
                {
                        $this->creation_mode = true;
                }
                if($this->node_id)
                {
                        // add parent node id if missing
                        if(!$this->parent_id && $this->tree)
                        {
                                $this->parent_id = $this->tree->getParentId($this->node_id);
                        }
                }
                $this->ref_id = $this->node_id;
                $this->obj_id = $this->object_id;
                
 
 
                $this->assignObject();
                
                // set context
                if (is_object($this->object))
                {
                        $this->ctrl->setContext($this->object->getId(), $this->object->getType());
                }
                
                $this->afterConstructor();
        }

References $ilCtrl, $ilErr, $ilUser, ilObjectGUI\$lng, $node_id, ilObjectGUI\$objDefinition, $object_id, $params, ilObjectGUI\$tpl, $tree, ilObject\_lookupObjectId(), afterConstructor(), assignObject(), getType(), OBJECT_ID, PEAR_ERROR_CALLBACK, PORTFOLIO_OBJECT_ID, REPOSITORY_NODE_ID, REPOSITORY_OBJECT_ID, WORKSPACE_NODE_ID, and WORKSPACE_OBJECT_ID.

Here is the call graph for this function:

Member Function Documentation

__initTableGUI()

& ilObject2GUI::__initTableGUI ( )

finalprotected

Reimplemented from ilObjectGUI.

Definition at line 556 of file class.ilObject2GUI.php.

{ die("ilObject2GUI::__initTableGUI() is deprecated."); }

__setTableGUIBasicData()

ilObject2GUI::__setTableGUIBasicData ( &  $tbl, &  $result_set,   $a_from = ""  )

finalprotected

standard implementation for tables use 'from' variable use different initial setting of table

Reimplemented from ilObjectGUI.

Definition at line 557 of file class.ilObject2GUI.php.

{ die("ilObject2GUI::__setTableGUIBasicData() is deprecated."); }

__showButton()

ilObject2GUI::__showButton (   $a_cmd,   $a_text,   $a_target = ''  )

finalprotected

Reimplemented from ilObjectGUI.

Definition at line 554 of file class.ilObject2GUI.php.

{ die("ilObject2GUI::__showButton() is deprecated."); }

addAdminLocatorItems()

ilObject2GUI::addAdminLocatorItems (   $a_do_not_add_object = false )

finalprotected

should be overwritten to add object specific items (repository items are preloaded)

Parameters

bool

$a_do_not_add_object

Reimplemented from ilObjectGUI.

Definition at line 486 of file class.ilObject2GUI.php.

{ return parent::addAdminLocatorItems($a_do_not_add_object); }

Referenced by ilObjectPluginGUI\executeCommand().

Here is the caller graph for this function:

addLocatorItems()

ilObject2GUI::addLocatorItems ( )

protected

Functions to be overwritten.

Reimplemented from ilObjectGUI.

Reimplemented in ilObjBibliographicGUI, ilObjBlogGUI, ilObjCloudGUI, ilObjDataCollectionGUI, ilObjFileGUI, ilObjItemGroupGUI, ilObjMediaPoolGUI, ilObjPollGUI, ilObjPortfolioBaseGUI, ilObjLinkResourceGUI, and ilObjectPluginGUI.

Definition at line 562 of file class.ilObject2GUI.php.

{}

Referenced by setLocator().

Here is the caller graph for this function:

afterConstructor()

ilObject2GUI::afterConstructor ( )

protected

Do anything that should be done after constructor in here.

Reimplemented in ilObjItemGroupGUI, and ilObjMediaPoolGUI.

Definition at line 168 of file class.ilObject2GUI.php.

        {
        }

Referenced by __construct().

Here is the caller graph for this function:

assignObject()

ilObject2GUI::assignObject ( )

finalprotected

create object instance as internal property (repository/workspace switch)

Reimplemented from ilObjectGUI.

Definition at line 211 of file class.ilObject2GUI.php.

        {
                if ($this->object_id != 0)
                {
                        switch($this->id_type)
                        {                               
                                case self::OBJECT_ID:
                                case self::REPOSITORY_OBJECT_ID:
                                case self::WORKSPACE_OBJECT_ID:
                                case self::PORTFOLIO_OBJECT_ID:
                                        $this->object = ilObjectFactory::getInstanceByObjId($this->object_id);
                                        break;
 
                                case self::REPOSITORY_NODE_ID:
                                        $this->object = ilObjectFactory::getInstanceByRefId($this->node_id);
                                        break;
 
                                case self::WORKSPACE_NODE_ID:
                                        // to be discussed
                                        $this->object = ilObjectFactory::getInstanceByObjId($this->object_id);
                                        break;
                        }
                }
        }

References ilObjectFactory\getInstanceByObjId(), ilObjectFactory\getInstanceByRefId(), OBJECT_ID, PORTFOLIO_OBJECT_ID, REPOSITORY_NODE_ID, REPOSITORY_OBJECT_ID, WORKSPACE_NODE_ID, and WORKSPACE_OBJECT_ID.

Referenced by __construct(), and ilObjWorkflowEngineGUI\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

buildCloneSelect()

ilObject2GUI::buildCloneSelect (   $existing_objs )

finalprotected

Definition at line 480 of file class.ilObject2GUI.php.

{ return parent::buildCloneSelect($existing_objs); }

cancel()

ilObject2GUI::cancel

(

)

Reimplemented in ilObjTaxonomyGUI.

Definition at line 590 of file class.ilObject2GUI.php.

{ parent::cancelObject(); }

cancelDelete()

ilObject2GUI::cancelDelete ( )

final

Definition at line 471 of file class.ilObject2GUI.php.

{ return parent::cancelDeleteObject(); } // ok

checkPermission()

ilObject2GUI::checkPermission (   $a_perm,   $a_cmd = "",   $a_type = "",   $a_ref_id = null  )

finalprotected

Check permission and redirect on error.

Parameters

string	$a_perm
string	$a_cmd
string	$a_type
int	$a_ref_id

Exceptions

ilObjectException

Returns

bool

Reimplemented from ilObjectGUI.

Definition at line 463 of file class.ilObject2GUI.php.

{ return parent::checkPermission($a_perm, $a_cmd, $a_type, $a_ref_id); }

References $a_type.

Referenced by ilObjLinkResourceGUI\addLink(), ilObjMediaPoolGUI\allMedia(), ilObjLinkResourceGUI\confirmDeleteLink(), ilObjMediaPoolGUI\confirmRemove(), ilObjMediaPoolGUI\copyToClipboard(), ilObjMediaPoolGUI\createFolderForm(), ilObjMediaPoolGUI\createMediaFromUploadDir(), ilObjMediaPoolGUI\createMediaPoolPage(), ilObjLinkResourceGUI\deactivateLink(), ilObjLinkResourceGUI\deleteLinks(), ilObjLinkResourceGUI\deleteParameter(), ilObjLinkResourceGUI\deleteParameterForm(), ilObjMediaPoolGUI\editFolder(), ilObjLinkResourceGUI\editLink(), ilObjMediaPoolGUI\editMediaPoolPage(), ilObjBlogGUI\editStyleProperties(), ilObjPortfolioBaseGUI\editStyleProperties(), ilObjCloudGUI\executeCommand(), ilObjMediaPoolGUI\executeCommand(), ilObjPortfolioGUI\executeCommand(), ilObjLinkResourceGUI\executeCommand(), ilObjectPluginGUI\executeCommand(), ilObjLinkResourceGUI\history(), ilObjectPluginGUI\infoScreen(), ilObjBlogGUI\infoScreenForward(), ilObjPortfolioTemplateGUI\infoScreenForward(), ilObjLinkResourceGUI\infoScreenForward(), ilObjMediaPoolGUI\insertFromClipboard(), ilObjLinkResourceGUI\linkChecker(), ilObjItemGroupGUI\listMaterials(), ilObjMediaPoolGUI\listMedia(), ilObjLinkResourceGUI\manage(), ilObjMediaPoolGUI\openClipboard(), ilObjMediaPoolGUI\remove(), ilObjLinkResourceGUI\saveAddLink(), ilObjContactAdministrationGUI\saveConfigurationForm(), ilObjMediaPoolGUI\saveFolder(), ilObjItemGroupGUI\saveItemAssignment(), ilObjMediaPoolGUI\saveMediaPoolPage(), ilObjLinkResourceGUI\saveSettings(), ilObjLinkResourceGUI\saveSorting(), ilObjMediaPoolGUI\selectUploadDirFiles(), ilObjLinkResourceGUI\settings(), ilObjContactAdministrationGUI\showConfigurationForm(), ilObjLinkResourceGUI\showLinks(), ilObjMediaPoolGUI\showMedia(), ilObjMediaPoolGUI\showMediaPoolPageUsages(), ilObjMediaPoolGUI\showPreview(), ilObjLinkResourceGUI\sort(), ilObjMediaPoolGUI\updateFolder(), ilObjLinkResourceGUI\updateLinks(), ilObjMediaPoolGUI\updateMediaPoolPage(), and ilObjLinkResourceGUI\view().

Here is the caller graph for this function:

checkPermissionBool()

ilObject2GUI::checkPermissionBool (   $a_perm,   $a_cmd = "",   $a_type = "",   $a_node_id = null  )

protected

Check permission.

Parameters

string	$a_perm
string	$a_cmd
string	$a_type
int	$a_node_id

Returns

bool

Reimplemented from ilObjectGUI.

Reimplemented in ilObjPortfolioGUI, and ilObjTaxonomyGUI.

Definition at line 731 of file class.ilObject2GUI.php.

        {
                global $ilUser;
                
                if($a_perm == "create")
                {
                        if(!$a_node_id)
                        {
                                $a_node_id = $this->parent_id;
                        }
                        if($a_node_id)
                        {
                                return $this->getAccessHandler()->checkAccess($a_perm."_".$a_type, $a_cmd, $a_node_id);
                        }
                }
                else
                {
 
                        if (!$a_node_id)
                        {
                                $a_node_id = $this->node_id;
                        }
                        if($a_node_id)
                        {
                                return $this->getAccessHandler()->checkAccess($a_perm, $a_cmd, $a_node_id);
                        }
                }
                
                // if we do not have a node id, check if current user is owner
                if($this->obj_id && $this->object->getOwner() == $ilUser->getId())
                {
                        return true;
                }               
                return false;
        }

References $a_type, $ilUser, $node_id, $parent_id, and getAccessHandler().

Referenced by ilObjLinkResourceGUI\activateTabs(), ilObjBlogGUI\addContributor(), ilObjCloudGUI\asyncGetActionListContent(), ilObjPollGUI\confirmDeleteAllVotes(), ilObjFileGUI\confirmDeleteFile(), ilObjFileGUI\confirmDeleteVersions(), ilObjBlogGUI\contributors(), ilObjWorkspaceFolderGUI\cut(), ilObjBlogGUI\deactivateAdmin(), ilObjPollGUI\deleteAllVotes(), deleteConfirmation(), ilObjPortfolioBaseGUI\deletePortfolioPages(), ilObjPortfolioBaseGUI\determinePageCall(), ilObjFileGUI\edit(), ilRemoteObjectBaseGUI\editObject(), ilObjHelpSettingsGUI\editSettings(), ilObjWikiSettingsGUI\editSettings(), ilObjBlogGUI\executeCommand(), ilObjCloudGUI\executeCommand(), ilObjFileGUI\executeCommand(), ilObjWikiSettingsGUI\getAdminTabs(), ilObjContactAdministrationGUI\getAdminTabs(), ilObjHelpSettingsGUI\getAdminTabs(), ilObjContactAdministrationGUI\getConfigurationForm(), ilObjCloudGUI\getFile(), ilObjFileGUI\handleFileUpload(), ilRemoteObjectBaseGUI\infoScreen(), ilObjBibliographicGUI\infoScreenForward(), ilObjBlogGUI\infoScreenForward(), ilObjCloudGUI\infoScreenForward(), ilObjDataCollectionGUI\infoScreenForward(), ilObjFileGUI\infoScreenForward(), ilObjPortfolioTemplateGUI\infoScreenForward(), ilObjWikiSettingsGUI\initForm(), ilObjBlogGUI\isAdmin(), ilObjBlogGUI\mayContribute(), ilObjBlogGUI\mayEditPosting(), ilObjWorkspaceFolderGUI\performPasteIntoMultipleObjects(), ilObjPortfolioBaseGUI\preview(), ilObjPortfolioTemplateGUI\preview(), ilObjBlogGUI\preview(), ilObjPollGUI\render(), ilObjBlogGUI\render(), ilObjCloudGUI\render(), ilObjFileGUI\rollbackVersion(), ilObjFileGUI\save(), ilObjPortfolioBaseGUI\savePortfolioPagesOrdering(), ilObjFileGUI\saveUnzip(), ilObjFileGUI\sendFile(), ilObjHelpSettingsGUI\setMode(), ilObjWorkspaceFolderGUI\setTabs(), ilObjBlogGUI\setTabs(), ilObjFileGUI\setTabs(), ilObjPollGUI\setTabs(), ilObjPortfolioTemplateGUI\setTabs(), ilObjLinkResourceGUI\setTabs(), setTabs(), ilRemoteObjectBaseGUI\setTabs(), ilObjPollGUI\showParticipants(), ilObjPollGUI\showParticipantVotes(), ilObjLinkResourceGUI\showToolbar(), ilRemoteObjectBaseGUI\updateObject(), ilObjFileGUI\uploadFiles(), ilObjHelpSettingsGUI\uploadHelpFile(), ilObjFileGUI\versions(), and ilObjPortfolioBaseGUI\view().

Here is the call graph for this function:

Here is the caller graph for this function:

cloneAll()

ilObject2GUI::cloneAll ( )

final

Definition at line 479 of file class.ilObject2GUI.php.

{ return parent::cloneAllObject(); }

confirmedDelete()

ilObject2GUI::confirmedDelete

(

)

Delete objects (repository/workspace switch)

Reimplemented in ilObjTaxonomyGUI.

Definition at line 377 of file class.ilObject2GUI.php.

        {
                switch($this->id_type)
                {
                        case self::REPOSITORY_NODE_ID:
                        case self::REPOSITORY_OBJECT_ID:
                                return parent::confirmedDeleteObject();
 
                        case self::WORKSPACE_NODE_ID:
                        case self::WORKSPACE_OBJECT_ID:
                                return $this->deleteConfirmedObjects();
 
                        case self::OBJECT_ID:
                        case self::PORTFOLIO_OBJECT_ID:
                                // :TODO: should this ever occur?
                                break;
                }
        }

References deleteConfirmedObjects(), OBJECT_ID, PORTFOLIO_OBJECT_ID, REPOSITORY_NODE_ID, REPOSITORY_OBJECT_ID, WORKSPACE_NODE_ID, and WORKSPACE_OBJECT_ID.

Here is the call graph for this function:

create()

ilObject2GUI::create

(

)

Deleted in ilObject.

CRUD

Reimplemented in ilObjCourseVerificationGUI, ilObjExerciseVerificationGUI, ilObjSCORMVerificationGUI, and ilObjTestVerificationGUI.

Definition at line 586 of file class.ilObject2GUI.php.

{ parent::createObject(); }

Referenced by ilObjTaxonomyGUI\createAssignedTaxonomy().

Here is the caller graph for this function:

delete()

ilObject2GUI::delete

(

)

Display delete confirmation form (repository/workspace switch)

Definition at line 299 of file class.ilObject2GUI.php.

        {
                switch($this->id_type)
                {
                        case self::REPOSITORY_NODE_ID:
                        case self::REPOSITORY_OBJECT_ID:
                                return parent::deleteObject();
 
                        case self::WORKSPACE_NODE_ID:
                        case self::WORKSPACE_OBJECT_ID:
                                return $this->deleteConfirmation();
 
                        case self::OBJECT_ID:
                        case self::PORTFOLIO_OBJECT_ID:
                                // :TODO: should this ever occur? 
                                break;
                }
        }

References deleteConfirmation(), OBJECT_ID, PORTFOLIO_OBJECT_ID, REPOSITORY_NODE_ID, REPOSITORY_OBJECT_ID, WORKSPACE_NODE_ID, and WORKSPACE_OBJECT_ID.

Here is the call graph for this function:

deleteConfirmation()

ilObject2GUI::deleteConfirmation ( )

protected

Display delete confirmation form (workspace specific)

This should probably be moved elsewhere as done with RepUtil

Definition at line 323 of file class.ilObject2GUI.php.

        {
                global $lng, $tpl, $objDefinition;
 
                $node_id = (int)$_REQUEST["item_ref_id"];
                if (!$node_id)
                {
                        ilUtil::sendFailure($lng->txt("no_checkbox"), true);
                        $this->ctrl->redirect($this, "");
                }
 
                // on cancel or fail we return to parent node
                $parent_node = $this->tree->getParentId($node_id);
                $this->ctrl->setParameter($this, "wsp_id", $parent_node);
 
                include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
                $cgui = new ilConfirmationGUI();
                $cgui->setHeaderText($lng->txt("info_delete_sure")."<br/>".
                        $lng->txt("info_delete_warning_no_trash"));
 
                $cgui->setFormAction($this->ctrl->getFormAction($this));
                $cgui->setCancel($lng->txt("cancel"), "cancelDelete");
                $cgui->setConfirm($lng->txt("confirm"), "confirmedDelete");
 
            $a_ids = array($node_id);
                foreach ($a_ids as $node_id)
                {
                        $children = $this->tree->getSubTree($this->tree->getNodeData($node_id));
                        foreach($children as $child)
                        {
                                $node_id = $child["wsp_id"];
                                $obj_id = $this->tree->lookupObjectId($node_id);
                                $type = ilObject::_lookupType($obj_id);
                                $title = call_user_func(array(ilObjectFactory::getClassByType($type),'_lookupTitle'), $obj_id);
 
                                // if anything fails, abort the whole process
                                if(!$this->checkPermissionBool("delete", "", "", $node_id))
                                {
                                        ilUtil::sendFailure($lng->txt("msg_no_perm_delete")." ".$title, true);
                                        $this->ctrl->redirect($this);
                                }
 
                                $cgui->addItem("id[]", $node_id, $title,
                                        ilObject::_getIcon($obj_id, "small", $type),
                                        $lng->txt("icon")." ".$lng->txt("obj_".$type));
                        }
                }
                
                $tpl->setContent($cgui->getHTML());
        }

References ilObjectGUI\$lng, $node_id, ilObjectGUI\$obj_id, ilObjectGUI\$objDefinition, $title, ilObjectGUI\$tpl, ilObject\_getIcon(), ilObject\_lookupType(), checkPermissionBool(), ilObjectFactory\getClassByType(), and ilUtil\sendFailure().

Referenced by delete().

Here is the call graph for this function:

Here is the caller graph for this function:

deleteConfirmedObjects()

ilObject2GUI::deleteConfirmedObjects ( )

protected

Delete objects (workspace specific)

This should probably be moved elsewhere as done with RepUtil

Definition at line 401 of file class.ilObject2GUI.php.

        {
                global $lng, $objDefinition;
 
                if(sizeof($_POST["id"]))
                {                       
                        // #18797 - because of parent/child relations gather all nodes first
                        $del_nodes = array();
                        foreach($_POST["id"] as $node_id)
                        {                               
                                $del_nodes[$node_id] = $this->tree->getNodeData($node_id);                              
                        }
                                                                
                        foreach($del_nodes as $node_id => $node)
                        {                               
                                // tree/reference
                                $this->tree->deleteReference($node_id);
                                if($this->tree->isInTree($node_id))
                                {                                                                       
                                        $this->tree->deleteTree($node);
                                }
                                
                                // permission
                                $this->getAccessHandler()->removePermission($node_id);
 
                                // object
                                $object = ilObjectFactory::getInstanceByObjId($node["obj_id"], false);
                                if($object)
                                {
                                        $object->delete();
                                }                       
                        }
 
                        ilUtil::sendSuccess($lng->txt("msg_removed"), true);
                }
                else
                {
                        ilUtil::sendFailure($lng->txt("no_checkbox"), true);
                }
 
                $this->ctrl->redirect($this, "");
        }

References $_POST, ilObjectGUI\$lng, $node_id, ilObjectGUI\$objDefinition, ilObjectGUI\$object, getAccessHandler(), ilObjectFactory\getInstanceByObjId(), ilUtil\sendFailure(), and ilUtil\sendSuccess().

Referenced by confirmedDelete().

Here is the call graph for this function:

Here is the caller graph for this function:

displayList()

ilObject2GUI::displayList ( )

finalprivate

Definition at line 483 of file class.ilObject2GUI.php.

{ return parent::displayList(); }

edit()

ilObject2GUI::edit

(

)

Reimplemented in ilObjFileGUI, ilObjMediaPoolGUI, and ilObjWorkspaceFolderGUI.

Definition at line 588 of file class.ilObject2GUI.php.

{ parent::editObject(); }

executeCommand()

ilObject2GUI::executeCommand

(

)

execute command

Reimplemented from ilObjectGUI.

Reimplemented in ilObjBibliographicGUI, ilObjBlogGUI, ilObjCloudGUI, ilObjFileGUI, ilObjItemGroupGUI, ilObjMediaPoolGUI, ilObjPollGUI, ilObjPortfolioGUI, ilObjPortfolioTemplateGUI, ilObjLinkResourceGUI, ilObjWikiSettingsGUI, ilObjWorkspaceFolderGUI, ilObjContactAdministrationGUI, ilObjHelpSettingsGUI, ilObjectPluginGUI, ilObjTaxonomyGUI, ilObjTermsOfServiceGUI, ilRemoteObjectBaseGUI, and ilObjWorkflowEngineGUI.

Definition at line 175 of file class.ilObject2GUI.php.

        {
                global $rbacsystem;
 
                $next_class = $this->ctrl->getNextClass($this);
                $cmd = $this->ctrl->getCmd();
                
                $this->prepareOutput(); 
 
                switch($next_class)
                {
                        case "ilworkspaceaccessgui";            
                                if($this->node_id)
                                {
                                        $this->tabs_gui->activateTab("id_permissions");
 
                                        include_once('./Services/PersonalWorkspace/classes/class.ilWorkspaceAccessGUI.php');
                                        $wspacc = new ilWorkspaceAccessGUI($this->node_id, $this->getAccessHandler());
                                        $this->ctrl->forwardCommand($wspacc);
                                        break;
                                }
                        
                        default:                                
                                if(!$cmd)
                                {
                                        $cmd = "render";
                                }
                                return $this->$cmd();
                }
 
                return true;
        }

References $cmd, getAccessHandler(), and prepareOutput().

Referenced by ilObjPortfolioTemplateGUI\executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

fillCloneSearchTemplate()

ilObject2GUI::fillCloneSearchTemplate (   $a_tpl_varname,   $a_type  )

finalprotected

Definition at line 477 of file class.ilObject2GUI.php.

{ return parent::fillCloneSearchTemplate($a_tpl_varname,$a_type); }

References $a_type.

fillCloneTemplate()

ilObject2GUI::fillCloneTemplate (   $a_tpl_varname,   $a_type  )

finalprotected

Fill object clone template This method can be called from any object GUI class that wants to offer object cloning.

@access public

Parameters

string	template variable name that will be filled
string	type of new object

Reimplemented from ilObjectGUI.

Definition at line 476 of file class.ilObject2GUI.php.

{ return parent::fillCloneTemplate($a_tpl_varname,$a_type); }

References $a_type.

Referenced by ilObjFileGUI\initCreationForms(), and ilObjectPluginGUI\initCreationForms().

Here is the caller graph for this function:

getAccessHandler()

ilObject2GUI::getAccessHandler ( )

protected

Get access handler.

Returns

object

Definition at line 241 of file class.ilObject2GUI.php.

        {
                return $this->access_handler;
        }

References $access_handler.

Referenced by ilObjWorkspaceFolderGUI\applyShareFilter(), checkPermissionBool(), ilObjWorkspaceFolderGUI\copyShared(), deleteConfirmedObjects(), ilObjBlogGUI\executeCommand(), ilObjFileGUI\executeCommand(), ilObjPollGUI\executeCommand(), ilObjPortfolioTemplateGUI\executeCommand(), executeCommand(), ilObjFileGUI\handleFileUpload(), initHeaderAction(), ilObjWorkspaceFolderGUI\initPasswordForm(), ilObjWorkspaceFolderGUI\listSharedResourcesOfOtherUser(), ilObjWorkspaceFolderGUI\performPasteIntoMultipleObjects(), putObjectInTree(), ilObjCourseVerificationGUI\render(), ilObjExerciseVerificationGUI\render(), ilObjSCORMVerificationGUI\render(), ilObjTestVerificationGUI\render(), ilObjWorkspaceFolderGUI\render(), ilObjBlogGUI\renderList(), ilObjWorkspaceFolderGUI\resetShareFilter(), ilObjFileGUI\saveUnzip(), ilObjWorkspaceFolderGUI\setTabs(), and ilObjWorkspaceFolderGUI\share().

Here is the caller graph for this function:

getCenterColumnHTML()

ilObject2GUI::getCenterColumnHTML ( )

finalprotected

Get center column.

Reimplemented from ilObjectGUI.

Definition at line 460 of file class.ilObject2GUI.php.

{ return parent::getCenterColumnHTML(); }

getCreationMode()

ilObject2GUI::getCreationMode ( )

final

get creation mode

Reimplemented from ilObjectGUI.

Definition at line 451 of file class.ilObject2GUI.php.

{ return parent::getCreationMode(); }

Referenced by ilObjMediaPoolGUI\addLocatorItems(), ilObjectPluginGUI\addLocatorItems(), ilObjBlogGUI\executeCommand(), ilObjFileGUI\executeCommand(), ilObjMediaPoolGUI\executeCommand(), ilObjPollGUI\executeCommand(), ilObjPortfolioTemplateGUI\executeCommand(), ilObjLinkResourceGUI\executeCommand(), ilObjectPluginGUI\executeCommand(), ilOrgUnitExtensionGUI\setLocator(), and ilObjLinkResourceGUI\setTabs().

Here is the caller graph for this function:

getHTML()

ilObject2GUI::getHTML

(

)

Reimplemented from ilObjectGUI.

Reimplemented in ilObjBlogGUI, and ilObjPollGUI.

Definition at line 444 of file class.ilObject2GUI.php.

{ return parent::getHTML(); }

getPermanentLinkWidget()

ilObject2GUI::getPermanentLinkWidget (   $a_append = null,   $a_center = false  )

protected

Definition at line 826 of file class.ilObject2GUI.php.

        {
                if($this->id_type == self::WORKSPACE_NODE_ID)
                {
                        $a_append .= "_wsp";
                }
                
                include_once('Services/PermanentLink/classes/class.ilPermanentLinkGUI.php');
                $plink = new ilPermanentLinkGUI($this->getType(), $this->node_id , $a_append);
                $plink->setIncludePermanentLinkText(false);
                $plink->setAlignCenter($a_center);
                return $plink->getHTML();
        }

References getType().

Here is the call graph for this function:

getReturnLocation()

ilObject2GUI::getReturnLocation (   $a_cmd,   $a_location = ""  )

finalprotected

Deprecated functions.

Reimplemented from ilObjectGUI.

Definition at line 550 of file class.ilObject2GUI.php.

{ die("ilObject2GUI::getReturnLocation() is deprecated."); }

getRightColumnHTML()

ilObject2GUI::getRightColumnHTML ( )

finalprotected

Display right column.

Reimplemented from ilObjectGUI.

Definition at line 461 of file class.ilObject2GUI.php.

{ return parent::getRightColumnHTML(); }

getTabs()

ilObject2GUI::getTabs ( )

finalprotected

get tabs abstract method.

@abstract overwrite in derived GUI class of your object type @access public

Parameters

object

instance of ilTabsGUI

Reimplemented from ilObjectGUI.

Definition at line 553 of file class.ilObject2GUI.php.

{nj(); die("ilObject2GUI::getTabs() is deprecated."); }

getTargetFrame()

ilObject2GUI::getTargetFrame (   $a_cmd,   $a_target_frame = ""  )

finalprotected

get target frame for command (command is method name without "Object", e.g.

"perm")

Parameters

string	$a_cmd	command
string	$a_target_frame	default target frame (is returned, if no special target frame was set) @access public

Reimplemented from ilObjectGUI.

Definition at line 457 of file class.ilObject2GUI.php.

{ return parent::getTargetFrame($a_cmd, $a_target_frame); }

Referenced by ilObjFileGUI\initMultiUploadForm(), ilObjFileGUI\initSingleUploadForm(), and ilObjFileGUI\initZipUploadForm().

Here is the caller graph for this function:

getType()

ilObject2GUI::getType ( )

abstract

Functions that must be overwritten.

Reimplemented in ilObjBibliographicGUI, ilObjBlogGUI, ilObjCloudGUI, ilObjCourseVerificationGUI, ilObjDataCollectionGUI, ilObjExerciseVerificationGUI, ilObjFileGUI, ilObjItemGroupGUI, ilObjMediaPoolGUI, ilObjPollGUI, ilObjPortfolioGUI, ilObjPortfolioTemplateGUI, ilObjRemoteCategoryGUI, ilObjRemoteCourseGUI, ilObjRemoteFileGUI, ilObjRemoteGlossaryGUI, ilObjRemoteGroupGUI, ilObjRemoteLearningModuleGUI, ilObjRemoteTestGUI, ilObjRemoteWikiGUI, ilObjSCORMVerificationGUI, ilObjTestVerificationGUI, ilObjLinkResourceGUI, ilObjWikiSettingsGUI, ilObjWorkspaceFolderGUI, ilObjWorkspaceRootFolderGUI, ilObjContactAdministrationGUI, ilObjHelpSettingsGUI, ilObjTaxonomyGUI, ilObjTermsOfServiceGUI, and ilObjWorkflowEngineGUI.

Referenced by __construct(), ilRemoteObjectBaseGUI\callObject(), ilObjectPluginGUI\executeCommand(), ilObjectPluginGUI\getCreationFormTitle(), getPermanentLinkWidget(), ilOrgUnitExtensionGUI\getPlugin(), ilObjectPluginGUI\getPlugin(), ilRemoteObjectBaseGUI\infoScreen(), ilRemoteObjectBaseGUI\initEditForm(), initHeaderAction(), ilObjPortfolioBaseGUI\preview(), ilObjPortfolioBaseGUI\setSettingsSubTabs(), ilRemoteObjectBaseGUI\updateObject(), and ilObjPortfolioBaseGUI\view().

Here is the caller graph for this function:

handleAfterSaveCallback()

static ilObject2GUI::handleAfterSaveCallback ( ilObject  $a_obj,   $a_callback_ref_id  )

static

After creation callback.

Parameters

ilObject	$a_obj
int	$a_callback_ref_id

Definition at line 699 of file class.ilObject2GUI.php.

        {
                global $objDefinition;
                
                $a_callback_ref_id = (int)$a_callback_ref_id;           
                if($a_callback_ref_id)
                {
                        $callback_type = ilObject::_lookupType($a_callback_ref_id, true);
                        $class_name = "ilObj".$objDefinition->getClassName($callback_type)."GUI";
                        $location = $objDefinition->getLocation($callback_type);
                        include_once($location."/class.".$class_name.".php");
                        if (in_array(strtolower($class_name), array("ilobjitemgroupgui")))
                        {
                                $callback_obj = new $class_name($a_callback_ref_id);
                        }
                        else
                        {
                                $callback_obj = new $class_name(null, $a_callback_ref_id, true, false);
                        }
                        $callback_obj->afterSaveCallback($a_obj);
                }
        }

References $location, ilObjectGUI\$objDefinition, and ilObject\_lookupType().

Referenced by putObjectInTree(), and ilObjFileGUI\uploadFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

handleAutoRating()

ilObject2GUI::handleAutoRating ( ilObject  $a_new_obj )

protected

Activate rating automatically if parent container setting.

Parameters

ilObject

$a_new_obj

Reimplemented from ilObjectGUI.

Definition at line 841 of file class.ilObject2GUI.php.

        {
                // only needed in repository
                if($this->id_type == self::REPOSITORY_NODE_ID)
                {
                        parent::handleAutoRating($a_new_obj);
                }                               
        }

Referenced by ilObjFileGUI\handleFileUpload(), and ilObjFileGUI\save().

Here is the caller graph for this function:

hitsperpageObject()

ilObject2GUI::hitsperpageObject ( )

finalprotected

Reimplemented from ilObjectGUI.

Definition at line 555 of file class.ilObject2GUI.php.

{ die("ilObject2GUI::hitsperpageObject() is deprecated."); }

importFile()

ilObject2GUI::importFile

(

)

Import.

@access public

Definition at line 618 of file class.ilObject2GUI.php.

        {
                parent::importFileObject($this->parent_id);
        }

initCreationForms()

ilObject2GUI::initCreationForms (   $a_new_type )

protected

Init creation froms.

this will create the default creation forms: new, import, clone

Parameters

string

$a_new_type

Returns

array

Reimplemented from ilObjectGUI.

Reimplemented in ilObjBibliographicGUI, ilObjBlogGUI, ilObjCloudGUI, ilObjDataCollectionGUI, ilObjFileGUI, ilObjItemGroupGUI, ilObjMediaPoolGUI, ilObjPortfolioGUI, ilObjWorkspaceFolderGUI, ilObjectPluginGUI, and ilObjTaxonomyGUI.

Definition at line 600 of file class.ilObject2GUI.php.

        {
                $forms = parent::initCreationForms($a_new_type);
                
                // cloning doesn't work in workspace yet
                if($this->id_type == self::WORKSPACE_NODE_ID)
                {
                        unset($forms[self::CFORM_CLONE]);
                }
 
                return $forms;
        }

initHeaderAction()

ilObject2GUI::initHeaderAction (   $a_sub_type = null,   $a_sub_id = null  )

protected

Add header action menu.

Parameters

string	$a_sub_type
int	$a_sub_id

Returns

ilObjectListGUI

Reimplemented from ilObjectGUI.

Reimplemented in ilObjFileGUI.

Definition at line 774 of file class.ilObject2GUI.php.

        {
                global $ilAccess; 
                
                if($this->id_type == self::WORKSPACE_NODE_ID)
                {
                        if(!$this->creation_mode && $this->object_id)
                        {
                                include_once "Services/Object/classes/class.ilCommonActionDispatcherGUI.php";
                                $dispatcher = new ilCommonActionDispatcherGUI(ilCommonActionDispatcherGUI::TYPE_WORKSPACE, 
                                        $this->getAccessHandler(), $this->getType(), $this->node_id, $this->object_id);
                                
                                $dispatcher->setSubObject($a_sub_type, $a_sub_id);
                                
                                include_once "Services/Object/classes/class.ilObjectListGUI.php";
                                ilObjectListGUI::prepareJSLinks($this->ctrl->getLinkTarget($this, "redrawHeaderAction", "", true), 
                                        $this->ctrl->getLinkTargetByClass(array("ilcommonactiondispatchergui", "ilnotegui"), "", "", true, false), 
                                        $this->ctrl->getLinkTargetByClass(array("ilcommonactiondispatchergui", "iltagginggui"), "", "", true, false));
                                
                                $lg = $dispatcher->initHeaderAction();
                                
                                if(is_object($lg))
                                {                                                               
                                        // to enable add to desktop / remove from desktop
                                        if($this instanceof ilDesktopItemHandling)
                                        {
                                                $lg->setContainerObject($this);
                                        }
 
                                        // for activation checks see ilObjectGUI
                                        // $lg->enableComments(true);
                                        $lg->enableNotes(true);
                                        // $lg->enableTags(true);
                                }
 
                                return $lg;
                        }
                }
                else
                {
                        return parent::initHeaderAction();
                }
        }

References $lg, getAccessHandler(), getType(), and ilCommonActionDispatcherGUI\TYPE_WORKSPACE.

Referenced by ilObjCloudGUI\addHeaderAction().

Here is the call graph for this function:

Here is the caller graph for this function:

isVisible()

ilObject2GUI::isVisible (   $a_ref_id,   $a_type  )

final

Reimplemented from ilObjectGUI.

Definition at line 459 of file class.ilObject2GUI.php.

{ return parent::isVisible($a_ref_id,$a_type); }

References $a_type.

omitLocator()

ilObject2GUI::omitLocator (   $a_omit = true )

finalprotected

Reimplemented from ilObjectGUI.

Definition at line 456 of file class.ilObject2GUI.php.

{ return parent::omitLocator($a_omit); }

prepareOutput()

ilObject2GUI::prepareOutput (   $a_show_subobjects = true )

final

prepare output

Reimplemented from ilObjectGUI.

Definition at line 452 of file class.ilObject2GUI.php.

{ return parent::prepareOutput($a_show_subobjects); }

Referenced by ilObjBibliographicGUI\executeCommand(), ilObjBlogGUI\executeCommand(), ilObjCloudGUI\executeCommand(), ilObjFileGUI\executeCommand(), ilObjItemGroupGUI\executeCommand(), ilObjMediaPoolGUI\executeCommand(), ilObjPollGUI\executeCommand(), ilObjPortfolioTemplateGUI\executeCommand(), ilObjLinkResourceGUI\executeCommand(), ilObjWikiSettingsGUI\executeCommand(), ilObjWorkspaceFolderGUI\executeCommand(), ilObjContactAdministrationGUI\executeCommand(), ilObjHelpSettingsGUI\executeCommand(), executeCommand(), ilObjTermsOfServiceGUI\executeCommand(), and ilRemoteObjectBaseGUI\executeCommand().

Here is the caller graph for this function:

putObjectInTree()

ilObject2GUI::putObjectInTree ( ilObject  $a_obj,   $a_parent_node_id = null  )

protected

Add object to tree at given position.

Parameters

ilObject	$a_obj
int	$a_parent_node_id

Reimplemented from ilObjectGUI.

Definition at line 629 of file class.ilObject2GUI.php.

        {
                global $rbacreview, $ilUser, $objDefinition;
 
                $this->object_id = $a_obj->getId();
 
                if(!$a_parent_node_id)
                {
                        $a_parent_node_id = $this->parent_id;
                }               
                
                // add new object to custom parent container
                if((int)$_REQUEST["crtptrefid"])
                {
                        $a_parent_node_id = (int)$_REQUEST["crtptrefid"];
                }
 
                switch($this->id_type)
                {
                        case self::REPOSITORY_NODE_ID:
                        case self::REPOSITORY_OBJECT_ID:
                                if(!$this->node_id)
                                {
                                        $a_obj->createReference();
                                        $this->node_id = $a_obj->getRefId();
                                }
                                $a_obj->putInTree($a_parent_node_id);
                                $a_obj->setPermissions($a_parent_node_id);
 
                                // rbac log
                                include_once "Services/AccessControl/classes/class.ilRbacLog.php";
                                $rbac_log_roles = $rbacreview->getParentRoleIds($this->node_id, false);
                                $rbac_log = ilRbacLog::gatherFaPa($this->node_id, array_keys($rbac_log_roles), true);
                                ilRbacLog::add(ilRbacLog::CREATE_OBJECT, $this->node_id, $rbac_log);
 
                                $this->ctrl->setParameter($this, "ref_id", $this->node_id);
                                break;
 
                        case self::WORKSPACE_NODE_ID:
                        case self::WORKSPACE_OBJECT_ID:
                                if(!$this->node_id)
                                {
                                        $this->node_id = $this->tree->insertObject($a_parent_node_id, $this->object_id);
                                }
                                $this->getAccessHandler()->setPermissions($a_parent_node_id, $this->node_id);
 
                                $this->ctrl->setParameter($this, "wsp_id", $this->node_id);
                                break;
 
                        case self::OBJECT_ID:
                        case self::PORTFOLIO_OBJECT_ID:
                                // do nothing
                                break;
                }
                
                // BEGIN ChangeEvent: Record save object.
                require_once('Services/Tracking/classes/class.ilChangeEvent.php');
                ilChangeEvent::_recordWriteEvent($this->object_id, $ilUser->getId(), 'create');
                // END ChangeEvent: Record save object.
                        
                // use forced callback after object creation            
                self::handleAfterSaveCallback($a_obj, $_REQUEST["crtcb"]);              
        }

References $ilUser, ilObjectGUI\$objDefinition, $parent_id, ilChangeEvent\_recordWriteEvent(), ilRbacLog\add(), ilRbacLog\CREATE_OBJECT, ilObject\createReference(), ilRbacLog\gatherFaPa(), getAccessHandler(), ilObject\getId(), ilObject\getRefId(), handleAfterSaveCallback(), OBJECT_ID, PORTFOLIO_OBJECT_ID, ilObject\putInTree(), REPOSITORY_NODE_ID, REPOSITORY_OBJECT_ID, ilObject\setPermissions(), WORKSPACE_NODE_ID, and WORKSPACE_OBJECT_ID.

Referenced by ilObjFileGUI\handleFileUpload(), ilObjCourseVerificationGUI\save(), ilObjExerciseVerificationGUI\save(), ilObjFileGUI\save(), ilObjSCORMVerificationGUI\save(), and ilObjTestVerificationGUI\save().

Here is the call graph for this function:

Here is the caller graph for this function:

redirectToRefId()

ilObject2GUI::redirectToRefId (   $a_ref_id,   $a_cmd = ""  )

finalprotected

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

Parameters

int

$a_ref_id

reference id

Reimplemented from ilObjectGUI.

Definition at line 473 of file class.ilObject2GUI.php.

{ return parent::redirectToRefId(); } // ok

redrawHeaderAction()

ilObject2GUI::redrawHeaderAction ( )

protected

Updating icons after ajax call.

Definition at line 821 of file class.ilObject2GUI.php.

        {
                parent::redrawHeaderActionObject();
        }

removeFromSystem()

ilObject2GUI::removeFromSystem ( )

final

Definition at line 472 of file class.ilObject2GUI.php.

{ return parent::removeFromSystemObject(); } // done 

save()

ilObject2GUI::save

(

)

Reimplemented in ilObjBibliographicGUI, ilObjCourseVerificationGUI, ilObjExerciseVerificationGUI, ilObjFileGUI, ilObjPortfolioGUI, ilObjSCORMVerificationGUI, ilObjTestVerificationGUI, ilObjLinkResourceGUI, and ilObjTaxonomyGUI.

Definition at line 587 of file class.ilObject2GUI.php.

{ parent::saveObject(); }

searchCloneSource()

ilObject2GUI::searchCloneSource ( )

finalprotected

Definition at line 478 of file class.ilObject2GUI.php.

{ return parent::searchCloneSourceObject(); }

setColumnSettings()

ilObject2GUI::setColumnSettings ( ilColumnGUI  $column_gui )

finalprotected

May be overwritten in subclasses.

Reimplemented from ilObjectGUI.

Definition at line 462 of file class.ilObject2GUI.php.

{ return parent::setColumnSettings($column_gui); }

setCreationMode()

ilObject2GUI::setCreationMode (   $a_mode = true )

final

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

Reimplemented from ilObjectGUI.

Definition at line 450 of file class.ilObject2GUI.php.

{ return parent::setCreationMode($a_mode); }

Referenced by ilObjMediaPoolGUI\executeCommand().

Here is the caller graph for this function:

setLocator()

ilObject2GUI::setLocator ( )

protected

set Locator

Reimplemented from ilObjectGUI.

Reimplemented in ilOrgUnitExtensionGUI.

Definition at line 249 of file class.ilObject2GUI.php.

        {
                global $ilLocator, $tpl;
 
                if ($this->omit_locator)
                {
                        return;
                }
 
                switch($this->id_type)
                {
                        case self::REPOSITORY_NODE_ID:
                                $ref_id = $this->node_id
                                        ? $this->node_id
                                        : $this->parent_id;
                                $ilLocator->addRepositoryItems($ref_id);
                                
                                // not so nice workaround: todo: handle $ilLocator as tabs in ilTemplate
                                if ($_GET["admin_mode"] == "" &&
                                        strtolower($this->ctrl->getCmdClass()) == "ilobjrolegui")
                                {
                                        $this->ctrl->setParameterByClass("ilobjrolegui",
                                                "rolf_ref_id", $_GET["rolf_ref_id"]);
                                        $this->ctrl->setParameterByClass("ilobjrolegui",
                                                "obj_id", $_GET["obj_id"]);
                                        $ilLocator->addItem($this->lng->txt("role"),
                                                $this->ctrl->getLinkTargetByClass(array("ilpermissiongui",
                                                        "ilobjrolegui"), "perm"));
                                }
                                
                                // in workspace this is done in ilPersonalWorkspaceGUI
                                if($this->object_id)
                                {
                                        $this->addLocatorItems();
                                }
                                $tpl->setLocator();
                                
                                break;
 
                        case self::WORKSPACE_NODE_ID:
                                // :TODO:
                                break;
                }
 
                
        }

References $_GET, $parent_id, ilObjectGUI\$ref_id, ilObjectGUI\$tpl, addLocatorItems(), REPOSITORY_NODE_ID, and WORKSPACE_NODE_ID.

Referenced by ilObjBlogGUI\executeCommand(), ilObjMediaPoolGUI\executeCommand(), and ilObjectPluginGUI\executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

setReturnLocation()

ilObject2GUI::setReturnLocation (   $a_cmd,   $a_location  )

finalprotected

set specific return location for command

Parameters

string	$a_cmd	command
string	$a_location	default return location (is returned, if no special return location was set) @access public

Reimplemented from ilObjectGUI.

Definition at line 551 of file class.ilObject2GUI.php.

{ die("ilObject2GUI::setReturnLocation() is deprecated."); }

setTabs()

ilObject2GUI::setTabs ( )

protected

create tabs (repository/workspace switch)

this had to be moved here because of the context-specific permission tab

Reimplemented from ilObjectGUI.

Reimplemented in ilObjBlogGUI, ilObjCloudGUI, ilObjDataCollectionGUI, ilObjFileGUI, ilObjItemGroupGUI, ilObjMediaPoolGUI, ilObjPollGUI, ilObjPortfolioGUI, ilObjPortfolioTemplateGUI, ilObjLinkResourceGUI, and ilRemoteObjectBaseGUI.

Definition at line 515 of file class.ilObject2GUI.php.

        {
                global $ilTabs, $lng;
 
                switch($this->id_type)
                {
                        case self::REPOSITORY_NODE_ID:
                        case self::REPOSITORY_OBJECT_ID:
                                if ($this->checkPermissionBool("edit_permission"))
                                {
                                        $ilTabs->addTab("id_permissions",
                                                $lng->txt("perm_settings"),
                                                $this->ctrl->getLinkTargetByClass(array(get_class($this), "ilpermissiongui"), "perm"));
                                }
                                break;
 
                        case self::WORKSPACE_NODE_ID:
                        case self::WORKSPACE_OBJECT_ID:
                                // only files and blogs can be shared for now
                                if ($this->checkPermissionBool("edit_permission") && in_array($this->type, array("file", "blog")) && $this->node_id)
                                {
                                        $ilTabs->addTab("id_permissions",
                                                $lng->txt("wsp_permissions"),
                                                $this->ctrl->getLinkTargetByClass(array(get_class($this), "ilworkspaceaccessgui"), "share"));
                                }
                                break;
                }
        }

References ilObjectGUI\$lng, checkPermissionBool(), REPOSITORY_NODE_ID, REPOSITORY_OBJECT_ID, WORKSPACE_NODE_ID, and WORKSPACE_OBJECT_ID.

Referenced by ilObjTaxonomyGUI\createTaxNode(), ilObjTaxonomyGUI\deleteItems(), ilObjTaxonomyGUI\editSettings(), ilObjectPluginGUI\executeCommand(), ilObjTaxonomyGUI\listAssignedItems(), ilObjTaxonomyGUI\listNodes(), ilObjTaxonomyGUI\moveItems(), and ilObjPortfolioTemplateGUI\setTabs().

Here is the call graph for this function:

Here is the caller graph for this function:

setTargetFrame()

ilObject2GUI::setTargetFrame (   $a_cmd,   $a_target_frame  )

finalprotected

set specific target frame for command

Parameters

string	$a_cmd	command
string	$a_target_frame	default target frame (is returned, if no special target frame was set) @access public

Reimplemented from ilObjectGUI.

Definition at line 458 of file class.ilObject2GUI.php.

{ return parent::setTargetFrame($a_cmd, $a_target_frame); }

setTitleAndDescription()

ilObject2GUI::setTitleAndDescription ( )

protected

called by prepare output

Reimplemented from ilObjectGUI.

Reimplemented in ilObjPortfolioGUI, and ilObjWorkspaceRootFolderGUI.

Definition at line 453 of file class.ilObject2GUI.php.

{ return parent::setTitleAndDescription(); }

showActions()

ilObject2GUI::showActions ( )

finalprotected

Definition at line 552 of file class.ilObject2GUI.php.

{ die("ilObject2GUI::showActions() is deprecated."); }

showPossibleSubObjects()

ilObject2GUI::showPossibleSubObjects ( )

finalprotected

show possible subobjects (pulldown menu)

@access public

Reimplemented from ilObjectGUI.

Definition at line 466 of file class.ilObject2GUI.php.

{ return parent::showPossibleSubObjects(); }

showUpperIcon()

ilObject2GUI::showUpperIcon ( )

finalprotected

Definition at line 454 of file class.ilObject2GUI.php.

{ return parent::showUpperIcon(); }

trash()

ilObject2GUI::trash ( )

final

Definition at line 468 of file class.ilObject2GUI.php.

{ return parent::trashObject(); }               // done

undelete()

ilObject2GUI::undelete ( )

final

Definition at line 470 of file class.ilObject2GUI.php.

{ return parent::undeleteObject(); } // done

update()

ilObject2GUI::update

(

)

Reimplemented in ilObjFileGUI, and ilObjWorkspaceFolderGUI.

Definition at line 589 of file class.ilObject2GUI.php.

{ parent::updateObject(); }

view()

ilObject2GUI::view

(

)

view object content (repository/workspace switch)

Reimplemented in ilObjBibliographicGUI, ilObjPortfolioBaseGUI, and ilObjLinkResourceGUI.

Definition at line 491 of file class.ilObject2GUI.php.

        {
                switch($this->id_type)
                {
                        case self::REPOSITORY_NODE_ID:
                        case self::REPOSITORY_OBJECT_ID:
                                return parent::viewObject();
 
                        case self::WORKSPACE_NODE_ID:
                        case self::WORKSPACE_OBJECT_ID:
                                return $this->render();
 
                        case self::OBJECT_ID:
                        case self::PORTFOLIO_OBJECT_ID:
                                // :TODO: should this ever occur?  do nothing or edit() ?!
                                break;
                }
        }

References OBJECT_ID, PORTFOLIO_OBJECT_ID, REPOSITORY_NODE_ID, REPOSITORY_OBJECT_ID, WORKSPACE_NODE_ID, and WORKSPACE_OBJECT_ID.

withReferences()

ilObject2GUI::withReferences ( )

final

Final/Private declaration of unchanged parent methods.

Reimplemented from ilObjectGUI.

Definition at line 449 of file class.ilObject2GUI.php.

{ return parent::withReferences(); }

Field Documentation

$access_handler

ilObject2GUI::$access_handler

protected

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

Referenced by getAccessHandler(), ilObjFileGUI\handleFileUpload(), ilObjCourseVerificationGUI\render(), ilObjExerciseVerificationGUI\render(), ilObjSCORMVerificationGUI\render(), ilObjTestVerificationGUI\render(), and ilObjFileGUI\saveUnzip().

$creation_forms

ilObject2GUI::$creation_forms = array()

protected

Definition at line 32 of file class.ilObject2GUI.php.

$id_type

ilObject2GUI::$id_type = array()

protected

Definition at line 33 of file class.ilObject2GUI.php.

$node_id

ilObject2GUI::$node_id

protected

Definition at line 31 of file class.ilObject2GUI.php.

Referenced by __construct(), ilObjWorkspaceFolderGUI\checkPassword(), checkPermissionBool(), ilObjWorkspaceFolderGUI\copy(), ilObjWorkspaceFolderGUI\cut(), deleteConfirmation(), deleteConfirmedObjects(), ilObjWorkspaceFolderGUI\performPasteIntoMultipleObjects(), ilObjBlogGUI\renderNavigation(), ilObjCourseVerificationGUI\save(), ilObjExerciseVerificationGUI\save(), ilObjSCORMVerificationGUI\save(), and ilObjTestVerificationGUI\save().

$object_id

ilObject2GUI::$object_id

protected

Definition at line 30 of file class.ilObject2GUI.php.

Referenced by __construct().

$parent_id

ilObject2GUI::$parent_id

protected

Definition at line 34 of file class.ilObject2GUI.php.

Referenced by checkPermissionBool(), ilObjTaxonomyGUI\pasteItems(), ilObjWorkspaceFolderGUI\performPasteIntoMultipleObjects(), ilObjPortfolioBaseGUI\preview(), putObjectInTree(), ilObjBlogGUI\renderFullScreen(), ilObjCourseVerificationGUI\save(), ilObjExerciseVerificationGUI\save(), ilObjSCORMVerificationGUI\save(), ilObjTestVerificationGUI\save(), ilOrgUnitExtensionGUI\setLocator(), and setLocator().

$tree

ilObject2GUI::$tree

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

Referenced by __construct(), ilObjItemGroupGUI\_goto(), ilObjPollGUI\_goto(), ilObjMediaPoolGUI\addLocatorItems(), ilObjMediaPoolGUI\allMedia(), ilObjMediaPoolGUI\createMediaFromUploadDir(), ilObjMediaPoolGUI\executeCommand(), ilObjItemGroupGUI\gotoParent(), ilObjFileGUI\handleFileUpload(), ilObjPortfolioGUI\initBlogForm(), ilObjPortfolioGUI\initCreateForm(), ilObjPortfolioGUI\initCreatePortfolioFromTemplateForm(), ilObjItemGroupGUI\listMaterials(), ilObjMediaPoolGUI\listMedia(), ilObjTaxonomyGUI\pasteItems(), ilObjPortfolioBaseGUI\preview(), ilObjCourseVerificationGUI\render(), ilObjExerciseVerificationGUI\render(), ilObjSCORMVerificationGUI\render(), ilObjTestVerificationGUI\render(), ilObjBlogGUI\render(), ilObjBlogGUI\renderFullScreen(), ilObjMediaPoolGUI\saveMediaPoolPage(), ilObjFileGUI\saveUnzip(), ilObjItemGroupGUI\setTabs(), ilObjWorkspaceFolderGUI\showMoveIntoObjectTree(), ilOrgUnitExtensionGUI\showTree(), ilObjPollGUI\subscribe(), ilObjPollGUI\unsubscribe(), ilObjPortfolioBaseGUI\view(), and ilObjPollGUI\vote().

OBJECT_ID

const ilObject2GUI::OBJECT_ID = 0

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

Referenced by ilObjTaxonomyGUI\__construct(), __construct(), assignObject(), confirmedDelete(), delete(), putObjectInTree(), and view().

PORTFOLIO_OBJECT_ID

const ilObject2GUI::PORTFOLIO_OBJECT_ID = 5

Definition at line 43 of file class.ilObject2GUI.php.

Referenced by __construct(), assignObject(), confirmedDelete(), delete(), ilSharedResourceGUI\executeCommand(), putObjectInTree(), and view().

REPOSITORY_NODE_ID

const ilObject2GUI::REPOSITORY_NODE_ID = 1

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

Referenced by __construct(), assignObject(), confirmedDelete(), delete(), ilLinkResourceHandlerGUI\executeCommand(), ilAdministrationGUI\executeCommand(), ilRepositoryGUI\executeCommand(), ilAdministrationSettingsFormHandler\getSettingsGUIInstance(), putObjectInTree(), setLocator(), setTabs(), and view().

REPOSITORY_OBJECT_ID

const ilObject2GUI::REPOSITORY_OBJECT_ID = 3

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

Referenced by __construct(), assignObject(), confirmedDelete(), delete(), putObjectInTree(), setTabs(), and view().

WORKSPACE_NODE_ID

const ilObject2GUI::WORKSPACE_NODE_ID = 2

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

Referenced by __construct(), assignObject(), confirmedDelete(), delete(), ilPortfolioPageGUI\executeCommand(), ilPersonalWorkspaceGUI\executeCommand(), ilSharedResourceGUI\executeCommand(), ilObjFileGUI\infoScreenForward(), putObjectInTree(), setLocator(), setTabs(), ilExSubmissionObjectGUI\submitBlog(), and view().

WORKSPACE_OBJECT_ID

const ilObject2GUI::WORKSPACE_OBJECT_ID = 4

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

Referenced by __construct(), assignObject(), confirmedDelete(), delete(), ilPortfolioPageGUI\dlcrsv(), ilPortfolioPageGUI\dlexcv(), ilPortfolioPageGUI\dlscov(), ilPortfolioPageGUI\dltstv(), ilPortfolioHTMLExport\exportHTMLPages(), ilObjFileGUI\infoScreenForward(), putObjectInTree(), ilPortfolioPageGUI\renderBlog(), ilPortfolioPageGUI\renderVerification(), setTabs(), and view().

---

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

• Services/Object/classes/class.ilObject2GUI.php