Class ilObjectGUI Basic methods of all Output classes. More...

Inheritance diagram for ilObjectGUI:

Collaboration diagram for ilObjectGUI:

Public Member Functions
	ilObjectGUI ($a_data, $a_id=0, $a_call_by_reference=true, $a_prepare_output=true)
	Constructor @access public. More...

&	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...

	getAdminTabs (&$tabs_gui)
	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 ($in_rep=false)
	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	_gotoRepositoryRoot ($a_raise_error=false)
	Goto repository root. More...

static	_gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
	Goto repository root. More...

Data Fields
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
	assignObject ()

	prepareOutput ()
	prepare output More...

	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...

	getTitlesByRefId ($a_ref_ids)
	get Titles of objects this method is used for error messages in methods cut/copy/paste More...

	getTabs (&$tabs_gui)
	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 ($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
	$tmp_import_dir

Private Member Functions
	setActions ($a_actions="")
	set possible actions for objects in list. More...

	setSubObjects ($a_sub_objects="")
	set possible subobjects for this object. More...

Detailed Description

Class ilObjectGUI Basic methods of all Output classes.

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

Version: $Id$

Definition at line 13 of file class.ilObjectGUI.php.

Member Function Documentation

◆ __initTableGUI()

& ilObjectGUI::__initTableGUI ( )

protected

Reimplemented in ilObjCategoryGUI, ilObjCourseGUI, ilObjOrgUnitGUI, ilObject2GUI, and ilObjUserFolderGUI.

Definition at line 1718 of file class.ilObjectGUI.php.

        {
                include_once "./Services/Table/classes/class.ilTableGUI.php";
 
                return new ilTableGUI(0,false);
        }

◆ __setTableGUIBasicData()

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

protected

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

Reimplemented in ilObjCourseGUI, and ilObjUserFolderGUI.

Definition at line 1730 of file class.ilObjectGUI.php.

        {
                switch ($a_from)
                {
                        case "clipboardObject":
                                $offset = $_GET["offset"];
                                $order = $_GET["sort_by"];
                                $direction = $_GET["sort_order"];
                                $tbl->disable("footer");
                                break;
 
                        default:
                                $offset = $_GET["offset"];
                                $order = $_GET["sort_by"];
                                $direction = $_GET["sort_order"];
                                break;
                }
 
                $tbl->setOrderColumn($order);
                $tbl->setOrderDirection($direction);
                $tbl->setOffset($offset);
                $tbl->setLimit($_GET["limit"]);
                $tbl->setFooter("tblfooter",$this->lng->txt("previous"),$this->lng->txt("next"));
                $tbl->setData($result_set);
        }

References $_GET, and $tbl.

◆ __showButton()

ilObjectGUI::__showButton	(	$a_cmd,
		$a_text,
		$a_target = `''`
	)

protected

Definition at line 1704 of file class.ilObjectGUI.php.

        {
                global $ilToolbar;
                
                $ilToolbar->addButton($a_text, $this->ctrl->getLinkTarget($this, $a_cmd), $a_target);
        }

Referenced by ilObjSessionGUI\eventsListObject(), ilObjRoleGUI\listDesktopItemsObject(), ilObjRoleGUI\listUsersRoleObject(), and ilObjRoleGUI\selectDesktopItemObject().

Here is the caller graph for this function:

◆ _gotoRepositoryNode()

static ilObjectGUI::_gotoRepositoryNode	(	$a_ref_id,
		$a_cmd = `"frameset"`
	)

static

Goto repository root.

Parameters

return

Definition at line 2069 of file class.ilObjectGUI.php.

        {
                global $ilAccess, $ilErr;
 
                $_GET["cmd"] = $a_cmd;
                $_GET["target"] = "";
                $_GET["ref_id"] = $a_ref_id;
                $_GET["baseClass"] = "ilRepositoryGUI";
                include("ilias.php");
                exit;
        }

References $_GET, $ilErr, and exit.

Referenced by ilObjBookingPoolGUI\_goto(), ilObjCategoryGUI\_goto(), ilObjFolderGUI\_goto(), ilObjFileBasedLMGUI\_goto(), ilObjMediaCastGUI\_goto(), ilObjSessionGUI\_goto(), ilObjWikiGUI\_goto(), ilObjCourseGUI\_goto(), ilObjGroupGUI\_goto(), ilObjFileGUI\_goto(), and ilObjChatroomAdminGUI\_goto().

Here is the caller graph for this function:

◆ _gotoRepositoryRoot()

static ilObjectGUI::_gotoRepositoryRoot ( $a_raise_error = false )

static

Goto repository root.

Parameters

return

Definition at line 2043 of file class.ilObjectGUI.php.

        {
                global $ilAccess, $ilErr;
                
                if ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID))
                {
                        $_GET["cmd"] = "frameset";
                        $_GET["target"] = "";
                        $_GET["ref_id"] = ROOT_FOLDER_ID;
                        $_GET["baseClass"] = "ilRepositoryGUI";
                        include("ilias.php");
                        exit;
                }
 
                if ($a_raise_error)
                {
                        $ilErr->raiseError($lng->txt("msg_no_perm_read"), $ilErr->FATAL);
                }
        }

References $_GET, $ilErr, $lng, and exit.

Referenced by ilObjBookingPoolGUI\_goto(), ilObjCategoryGUI\_goto(), ilObjGlossaryGUI\_goto(), ilObjFileBasedLMGUI\_goto(), ilObjItemGroupGUI\_goto(), ilLMPageObjectGUI\_goto(), ilObjContentObjectGUI\_goto(), ilObjMediaCastGUI\_goto(), ilObjMediaPoolGUI\_goto(), ilObjRootFolderGUI\_goto(), ilObjSAHSLearningModuleGUI\_goto(), ilObjSurveyQuestionPoolGUI\_goto(), ilObjTestGUI\_goto(), ilObjQuestionPoolGUI\_goto(), ilObjWikiGUI\_goto(), ilObjectPluginGUI\_goto(), ilObjSurveyGUI\_goto(), ilObjCourseGUI\_goto(), ilObjGroupGUI\_goto(), ilObjFileGUI\_goto(), ilObjLinkResourceGUI\_goto(), ilObjExerciseGUI\_goto(), ilGlossaryTermGUI\_goto(), ilStructureObjectGUI\_goto(), ilObjUserFolderGUI\_goto(), ilObjSystemFolderGUI\_goto(), ilObjBibliographicGUI\sendFile(), ilObjBibliographicGUI\showContent(), ilObjBibliographicGUI\showDetails(), and ilObjBibliographicGUI\updateCustom().

Here is the caller graph for this function:

◆ addAdminLocatorItems()

ilObjectGUI::addAdminLocatorItems ( $a_do_not_add_object = false )

protected

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

Parameters

bool $a_do_not_add_object

Definition at line 633 of file class.ilObjectGUI.php.

        {
                global $ilLocator;
                
                if ($_GET["admin_mode"] == "settings")  // system settings
                {               
                        $this->ctrl->setParameterByClass("ilobjsystemfoldergui",
                                "ref_id", SYSTEM_FOLDER_ID);
                        $ilLocator->addItem($this->lng->txt("administration"),
                                $this->ctrl->getLinkTargetByClass(array("iladministrationgui", "ilobjsystemfoldergui"), "")
                                );
                        if ($this->object->getRefId() != SYSTEM_FOLDER_ID && !$a_do_not_add_object)
                        {
                                $ilLocator->addItem($this->object->getTitle(),
                                        $this->ctrl->getLinkTarget($this, "view"));
                        }
                }
                else                                                    // repository administration
                {
                        $this->ctrl->setParameterByClass("iladministrationgui",
                                "ref_id", "");
                        $this->ctrl->setParameterByClass("iladministrationgui",
                                "admin_mode", "settings");
                        //$ilLocator->addItem($this->lng->txt("administration"),
                        //      $this->ctrl->getLinkTargetByClass("iladministrationgui", "frameset"),
                        //      ilFrameTargetInfo::_getFrame("MainContent"));
                        $this->ctrl->clearParametersByClass("iladministrationgui");
                        $ilLocator->addAdministrationItems();
                }
 
        }

References $_GET.

Referenced by prepareOutput().

Here is the caller graph for this function:

◆ addDidacticTemplateOptions()

ilObjectGUI::addDidacticTemplateOptions ( array & $a_options )

protected

Add custom templates.

Parameters

array $a_options

Reimplemented in ilObjSurveyGUI, and ilObjTestGUI.

Definition at line 939 of file class.ilObjectGUI.php.

        {
                
        }

Referenced by initDidacticTemplate().

Here is the caller graph for this function:

◆ addExternalEditFormCustom()

ilObjectGUI::addExternalEditFormCustom ( ilPropertyFormGUI $a_form )

Reimplemented in ilObjBookingPoolGUI.

Definition at line 1132 of file class.ilObjectGUI.php.

        {
                // has to be done AFTER setValuesByArray() ...
        }

Referenced by editObject().

Here is the caller graph for this function:

◆ addHeaderAction()

ilObjectGUI::addHeaderAction ( )

protected

Add header action menu.

Reimplemented in ilObjCloudGUI.

Definition at line 425 of file class.ilObjectGUI.php.

        {       
                $this->insertHeaderAction($this->initHeaderAction());
        }

References initHeaderAction(), and insertHeaderAction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addLocatorItems()

ilObjectGUI::addLocatorItems ( )

protected

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

Reimplemented in ilObjBibliographicGUI, ilObjBlogGUI, ilObjBookingPoolGUI, ilObjCloudGUI, ilObjCourseGUI, ilObjDataCollectionGUI, ilObjExerciseGUI, ilObjFileGUI, ilObjFileBasedLMGUI, ilObjItemGroupGUI, ilObjMediaCastGUI, ilObjMediaPoolGUI, ilObjPollGUI, ilObjPortfolioBaseGUI, ilObjSAHSLearningModuleGUI, ilObjSessionGUI, ilObjSurveyGUI, ilObjSurveyQuestionPoolGUI, ilObjTestGUI, ilObjQuestionPoolGUI, ilObjLinkResourceGUI, ilObjWikiGUI, ilContainerReferenceGUI, ilObjNotificationAdminGUI, ilObject2GUI, and ilObjectPluginGUI.

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

619 {

620 }

Referenced by setLocator().

Here is the caller graph for this function:

◆ afterImport()

ilObjectGUI::afterImport ( ilObject $a_new_object )

protected

Post (successful) object import hook.

Parameters

ilObject $a_new_object

Reimplemented in ilObjCourseGUI.

Definition at line 1390 of file class.ilObjectGUI.php.

        {
                ilUtil::sendSuccess($this->lng->txt("object_added"), true);
                $this->ctrl->returnToParent($this);
        }

References ilUtil\sendSuccess().

Referenced by importFileObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ afterSave()

ilObjectGUI::afterSave ( ilObject $a_new_object )

protected

Post (successful) object creation hook.

Parameters

ilObject $a_new_object

Reimplemented in ilObjBlogGUI, ilObjBookingPoolGUI, ilObjCategoryGUI, ilObjCourseGUI, ilObjDataCollectionGUI, ilObjExerciseGUI, ilObjFolderGUI, ilObjItemGroupGUI, ilObjContentObjectGUI, ilObjPollGUI, ilObjPortfolioGUI, ilObjPortfolioTemplateGUI, ilObjStudyProgrammeGUI, ilObjSurveyGUI, ilObjSurveyQuestionPoolGUI, ilObjTestGUI, ilObjQuestionPoolGUI, ilObjLinkResourceGUI, ilContainerReferenceGUI, and ilObjTaxonomyGUI.

Definition at line 1098 of file class.ilObjectGUI.php.

        {
                ilUtil::sendSuccess($this->lng->txt("object_added"), true);
                $this->ctrl->returnToParent($this);
        }

References ilUtil\sendSuccess().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ afterUpdate()

ilObjectGUI::afterUpdate ( )

protected

Post (successful) object update hook.

Reimplemented in ilObjExternalFeedGUI, and ilContainerGUI.

Definition at line 1262 of file class.ilObjectGUI.php.

        {
                ilUtil::sendSuccess($this->lng->txt("msg_obj_modified"),true);
                $this->ctrl->redirect($this, "edit");
        }

References ilUtil\sendSuccess().

Referenced by updateObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ assignObject()

ilObjectGUI::assignObject ( )

protected

Reimplemented in ilObjGlossaryGUI, ilObjDlBookGUI, ilObjLearningModuleGUI, ilObjSCORM2004LearningModuleGUI, ilObjAICCLearningModuleGUI, ilObjHACPLearningModuleGUI, ilObjSCORMLearningModuleGUI, ilObjLanguageExtGUI, ilObjMediaObjectGUI, and ilObject2GUI.

Definition at line 221 of file class.ilObjectGUI.php.

        {
                // TODO: it seems that we always have to pass only the ref_id
//echo "<br>ilObjectGUIassign:".get_class($this).":".$this->id.":<br>";
                if ($this->id != 0)
                {
                        if ($this->call_by_reference)
                        {
                                $this->object = ilObjectFactory::getInstanceByRefId($this->id);
                        }
                        else
                        {
                                $this->object = ilObjectFactory::getInstanceByObjId($this->id);
                        }
                }
        }

References ilObjectFactory\getInstanceByObjId(), and ilObjectFactory\getInstanceByRefId().

Referenced by ilObjectGUI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cancelCreation()

ilObjectGUI::cancelCreation ( )

cancel create action and go back to repository parent

Definition at line 947 of file class.ilObjectGUI.php.

        {
                global $ilCtrl;
                
                $ilCtrl->redirectByClass("ilrepositorygui", "frameset");
        }

References $ilCtrl.

◆ cancelDeleteObject()

ilObjectGUI::cancelDeleteObject ( )

cancel deletion of object

@access public

Reimplemented in ilObjStyleSettingsGUI, and ilObjStyleSheetGUI.

Definition at line 690 of file class.ilObjectGUI.php.

        {
                ilSession::clear("saved_post");
                $this->ctrl->returnToParent($this);
        }

References ilSession\clear().

Here is the call graph for this function:

◆ cancelObject()

ilObjectGUI::cancelObject ( $in_rep = false )

cancel action and go back to previous page @access public

Reimplemented in ilObjForumGUI.

Definition at line 702 of file class.ilObjectGUI.php.

        {
                ilSession::clear("saved_post");
                $this->ctrl->returnToParent($this);
        }

References ilSession\clear().

Referenced by ilObjFileBasedLMGUI\cancel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkPermission()

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

protected

Check permission and redirect on error.

Parameters

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

Returns: bool

Definition at line 1960 of file class.ilObjectGUI.php.

        {
                if (!$this->checkPermissionBool($a_perm, $a_cmd, $a_type, $a_ref_id))
                {
                        if (!is_int(strpos($_SERVER["PHP_SELF"], "goto.php")))
                        {
                                // create: redirect to parent
                                if($a_perm == "create")
                                {
                                        if(!$a_ref_id)
                                        {
                                                $a_ref_id = $_GET["ref_id"];
                                        }
                                        $type = ilObject::_lookupType($a_ref_id, true);                                 
                                }
                                else
                                {
                                        // does this make sense?
                                        if (!is_object($this->object))
                                        {
                                                return;
                                        }
                                        if (!$a_ref_id)
                                        {
                                                $a_ref_id = $this->object->getRefId();
                                        }
                                        $type = $this->object->getType();
                                }
 
                                ilSession::clear("il_rep_ref_id");
                                ilUtil::sendFailure($this->lng->txt("permission_denied"), true);
                                ilUtil::redirect("goto.php?target=".$type."_".$a_ref_id);
                        }
                        // we should never be here
                        else    
                        {
                                die("Permission Denied.");
                        }
                }
        }

References $_GET, $_SERVER, ilObject\_lookupType(), checkPermissionBool(), ilSession\clear(), ilUtil\redirect(), and ilUtil\sendFailure().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkPermissionBool()

ilObjectGUI::checkPermissionBool	(	$a_perm,
		$a_cmd = `""`,
		$a_type = `""`,
		$a_ref_id = `null`
	)

protected

Check permission.

Parameters

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

Returns: bool

Reimplemented in ilObjPortfolioGUI, ilObject2GUI, ilObjTaxonomyGUI, and ilObjWikiGUI.

Definition at line 2010 of file class.ilObjectGUI.php.

        {
                global $ilAccess;
 
                if($a_perm == "create")
                {
                        if(!$a_ref_id)
                        {
                                $a_ref_id = $_GET["ref_id"];
                        }
                        return $ilAccess->checkAccess($a_perm."_".$a_type, $a_cmd, $a_ref_id);
                }
                else
                {
                        // does this make sense?
                        if (!is_object($this->object))
                        {
                                return false;
                        }
                        if (!$a_ref_id)
                        {
                                $a_ref_id = $this->object->getRefId();
                        }
                        return $ilAccess->checkAccess($a_perm, $a_cmd, $a_ref_id);
                }
        }

References $_GET.

Referenced by checkPermission(), cloneAllObject(), ilObjFileBasedLMGUI\createFromDirectory(), createObject(), ilObjFolderGUI\editObject(), editObject(), ilObjSkillManagementGUI\editSettings(), ilObjBookingPoolGUI\executeCommand(), ilObjCategoryGUI\executeCommand(), ilObjCourseGUI\executeCommand(), ilObjGroupGUI\executeCommand(), ilObjRootFolderGUI\executeCommand(), ilObjSystemFolderGUI\executeCommand(), ilObjRoleFolderGUI\getAdminTabs(), getAdminTabs(), ilObjObjectTemplateAdministrationGUI\getAdminTabs(), ilObjCourseGUI\hasAdminPermission(), importFileObject(), ilObjSurveyGUI\importFileObject(), ilObjSurveyQuestionPoolGUI\importFileObject(), isVisible(), ilObjExerciseGUI\listAssignmentsObject(), ilObjGlossaryGUI\saveObject(), saveObject(), ilObjSkillManagementGUI\saveSettings(), ilObjRoleFolderGUI\saveSettingsObject(), ilObjCategoryGUI\saveTranslationsObject(), ilObjRootFolderGUI\saveTranslationsObject(), setColumnSettings(), ilObjCategoryGUI\updateObject(), ilObjRootFolderGUI\updateObject(), updateObject(), and viewObject().

Here is the caller graph for this function:

◆ cloneAllObject()

ilObjectGUI::cloneAllObject ( )

Clone single (not container object) Method is overwritten in ilContainerGUI.

@access public

Reimplemented in ilContainerGUI.

Definition at line 1806 of file class.ilObjectGUI.php.

        {
                include_once('./Services/Link/classes/class.ilLink.php');
                include_once('Services/CopyWizard/classes/class.ilCopyWizardOptions.php');
                
                global $ilErr,$ilUser;
                
                $new_type = $_REQUEST['new_type'];
                if(!$this->checkPermissionBool("create", "", $new_type))
                {
                        $ilErr->raiseError($this->lng->txt('permission_denied'));
                }
                if(!(int) $_REQUEST['clone_source'])
                {
                        ilUtil::sendFailure($this->lng->txt('select_one'));
                        $this->createObject();
                        return false;
                }
                if(!$this->checkPermissionBool("write", "", $new_type, (int)$_REQUEST['clone_source']))
                {
                        $ilErr->raiseError($this->lng->txt('permission_denied'));
                }
                
                // Save wizard options
                $copy_id = ilCopyWizardOptions::_allocateCopyId();
                $wizard_options = ilCopyWizardOptions::_getInstance($copy_id);
                $wizard_options->saveOwner($ilUser->getId());
                $wizard_options->saveRoot((int) $_REQUEST['clone_source']);
                
                $options = $_POST['cp_options'] ? $_POST['cp_options'] : array();
                foreach($options as $source_id => $option)
                {
                        $wizard_options->addEntry($source_id,$option);
                }
                $wizard_options->read();
                
                $orig = ilObjectFactory::getInstanceByRefId((int) $_REQUEST['clone_source']);
                $new_obj = $orig->cloneObject((int) $_GET['ref_id'],$copy_id);
                
                // Delete wizard options
                $wizard_options->deleteAll();
 
                ilUtil::sendSuccess($this->lng->txt("object_duplicated"),true);
                ilUtil::redirect(ilLink::_getLink($new_obj->getRefId()));
        }

References $_GET, $_POST, $_REQUEST, $ilErr, $ilUser, $options, ilCopyWizardOptions\_allocateCopyId(), ilCopyWizardOptions\_getInstance(), ilLink\_getLink(), checkPermissionBool(), createObject(), ilObjectFactory\getInstanceByRefId(), ilUtil\redirect(), ilUtil\sendFailure(), and ilUtil\sendSuccess().

Here is the call graph for this function:

◆ confirmedDeleteObject()

ilObjectGUI::confirmedDeleteObject ( )

confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled

Reimplemented in ilObjStyleSettingsGUI, and ilObjStyleSheetGUI.

Definition at line 669 of file class.ilObjectGUI.php.

        {
                global $ilSetting, $lng;
                
                if(isset($_POST["mref_id"]))
                {
                        $_SESSION["saved_post"] = array_unique(array_merge($_SESSION["saved_post"], $_POST["mref_id"]));
                }
                
                include_once("./Services/Repository/classes/class.ilRepUtilGUI.php");
                $ru = new ilRepUtilGUI($this);
                $ru->deleteObjects($_GET["ref_id"], ilSession::get("saved_post"));
                ilSession::clear("saved_post");
                $this->ctrl->returnToParent($this);
        }

References $_GET, $_POST, $_SESSION, $ilSetting, $lng, ilSession\clear(), and ilSession\get().

Here is the call graph for this function:

◆ createObject()

ilObjectGUI::createObject ( )

create new object form

@access public

Reimplemented in ilObjExternalFeedGUI, ilObjRoleFolderGUI, ilObjRoleGUI, ilContainerReferenceGUI, ilObjMediaObjectGUI, ilObjStyleSheetGUI, and ilObjUserGUI.

Definition at line 713 of file class.ilObjectGUI.php.

        {
                global $tpl, $ilErr;
 
                $new_type = $_REQUEST["new_type"];
 
                
                // add new object to custom parent container
                $this->ctrl->saveParameter($this, "crtptrefid");
                // use forced callback after object creation
                $this->ctrl->saveParameter($this, "crtcb");
                
                if (!$this->checkPermissionBool("create", "", $new_type))
                {
                        $ilErr->raiseError($this->lng->txt("permission_denied"),$ilErr->MESSAGE);
                }
                else
                {
                        $this->lng->loadLanguageModule($new_type);
                        $this->ctrl->setParameter($this, "new_type", $new_type);
                        
                        $forms = $this->initCreationForms($new_type);
                        
                        // copy form validation error: do not show other creation forms
                        if($_GET["cpfl"] && isset($forms[self::CFORM_CLONE]))
                        {
                                $forms = array(self::CFORM_CLONE => $forms[self::CFORM_CLONE]);
                        }
                        $tpl->setContent($this->getCreationFormsHTML($forms));
                }
        }

References $_GET, $_REQUEST, $ilErr, $tpl, checkPermissionBool(), getCreationFormsHTML(), and initCreationForms().

Referenced by ilContainerGUI\cloneAllObject(), cloneAllObject(), ilContainerGUI\cloneWizardPageObject(), ilObjForumGUI\cloneWizardPageObject(), ilObjGroupGUI\importFileObject2(), ilObjGlossaryGUI\importObject(), ilObjContentObjectGUI\importObject(), ilObjSessionGUI\saveObject(), ilObjGroupGUI\saveObject(), ilObjRoleTemplateGUI\saveObject(), and ilObjTestGUI\uploadTstObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteObject()

ilObjectGUI::deleteObject ( $a_error = false )

Display deletion confirmation screen.

Only for referenced objects. For user,role & rolt overwrite this function in the appropriate Object folders classes (ilObjUserFolderGUI,ilObjRoleFolderGUI)

@access public

Reimplemented in ilObjStyleSheetGUI.

Definition at line 1572 of file class.ilObjectGUI.php.

        {
                global $ilCtrl;
                
                if ($_GET["item_ref_id"] != "")
                {
                        $_POST["id"] = array($_GET["item_ref_id"]);
                }
                
                if(is_array($_POST["id"]))
                {
                        foreach($_POST["id"] as $idx => $id)
                        {
                                $_POST["id"][$idx] = (int)$id;
                        }
                }
 
                // SAVE POST VALUES (get rid of this
                ilSession::set("saved_post", $_POST["id"]);
 
                include_once("./Services/Repository/classes/class.ilRepUtilGUI.php");
                $ru = new ilRepUtilGUI($this);
                if (!$ru->showDeleteConfirmation($_POST["id"], $a_error))
                {
                        $ilCtrl->returnToParent($this);
                }
        }

References $_GET, $_POST, $ilCtrl, and ilSession\set().

Here is the call graph for this function:

◆ editObject()

ilObjectGUI::editObject ( )

edit object

@access public

Reimplemented in ilObjBookingPoolGUI, ilObjCourseGUI, ilObjExerciseGUI, ilObjFolderGUI, ilObjFileBasedLMGUI, ilObjSessionGUI, ilObjRoleGUI, ilObjMediaObjectGUI, ilObjTypeDefinitionGUI, ilObjStyleSheetGUI, and ilObjUserGUI.

Definition at line 1109 of file class.ilObjectGUI.php.

        {
                global $tpl, $ilTabs;
 
                if (!$this->checkPermissionBool("write"))
                {
                        $this->ilias->raiseError($this->lng->txt("msg_no_perm_write"),$this->ilias->error_obj->MESSAGE);
                }
 
                $ilTabs->activateTab("settings");
 
                $form = $this->initEditForm();
                $values = $this->getEditFormValues();
                if($values)
                {
                        $form->setValuesByArray($values);
                }
                
                $this->addExternalEditFormCustom($form);
                
                $tpl->setContent($form->getHTML());
        }

References $tpl, addExternalEditFormCustom(), checkPermissionBool(), getEditFormValues(), and initEditForm().

Referenced by ilContainerReferenceGUI\editReferenceObject(), ilContainerReferenceGUI\firstEditObject(), ilObjGroupGUI\updateObject(), ilObjRoleTemplateGUI\updateObject(), ilContainerReferenceGUI\updateObject(), and ilRemoteObjectBaseGUI\updateObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enableDragDropFileUpload()

ilObjectGUI::enableDragDropFileUpload ( )

protected

Enables the file upload into this object by dropping files.

Definition at line 2084 of file class.ilObjectGUI.php.

        {
                include_once("./Services/FileUpload/classes/class.ilFileUploadGUI.php");
                ilFileUploadGUI::initFileUpload();
                
                $this->tpl->enableDragDropFileUpload($this->ref_id);
        }

References ilFileUploadGUI\initFileUpload().

Referenced by prepareOutput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

& ilObjectGUI::executeCommand ( )

execute command

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

        {
                $next_class = $this->ctrl->getNextClass($this);
                $cmd = $this->ctrl->getCmd();
 
                switch($next_class)
                {
                        default:
                                $this->prepareOutput();
                                if(!$cmd)
                                {
                                        $cmd = "view";
                                }
                                $cmd .= "Object";
                                $this->$cmd();
                                        
                                break;
                }
 
                return true;
        }

References $cmd, and prepareOutput().

Here is the call graph for this function:

◆ fillCloneTemplate()

ilObjectGUI::fillCloneTemplate	(	$a_tpl_varname,
		$a_type
	)

protected

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 in ilObject2GUI.

Definition at line 1784 of file class.ilObjectGUI.php.

        {
                include_once './Services/Object/classes/class.ilObjectCopyGUI.php';
                $cp = new ilObjectCopyGUI($this);
                $cp->setType($a_type);
                $cp->setTarget($_GET['ref_id']);
                if($a_tpl_varname)
                {
                        $cp->showSourceSearch($a_tpl_varname);
                }
                else
                {
                        return $cp->showSourceSearch(null);
                }
        }

References $_GET.

Referenced by ilObjMediaCastGUI\initCreationForms(), ilObjWikiGUI\initCreationForms(), and initCreationForms().

Here is the caller graph for this function:

◆ getAdminTabs()

ilObjectGUI::getAdminTabs ( & $tabs_gui )

administration tabs show only permissions and trash folder

Reimplemented in ilObjSurveyAdministrationGUI, ilObjSystemFolderGUI, ilObjAssessmentFolderGUI, ilObjRoleFolderGUI, ilObjRoleGUI, ilObjRoleTemplateGUI, ilObjExternalToolsSettingsGUI, ilObjAdvancedEditingGUI, ilObjAuthSettingsGUI, ilObjHelpSettingsGUI, ilObjLanguageExtGUI, ilObjLanguageFolderGUI, ilObjMailGUI, ilObjSearchSettingsGUI, ilObjStyleSettingsGUI, ilObjStyleSheetGUI, ilObjUserTrackingGUI, ilObjUserFolderGUI, and ilObjUserGUI.

Definition at line 482 of file class.ilObjectGUI.php.

        {
                global $tree;
 
/*              if ($_GET["admin_mode"] == "repository")
                {
                        $this->ctrl->setParameterByClass("iladministrationgui", "admin_mode", "settings");
                        $tabs_gui->setBackTarget($this->lng->txt("administration"),
                                $this->ctrl->getLinkTargetByClass("iladministrationgui", "frameset"),
                                ilFrameTargetInfo::_getFrame("MainContent"));
                        $this->ctrl->setParameterByClass("iladministrationgui", "admin_mode", "repository");
                }*/
                
                if ($this->checkPermissionBool("visible,read"))
                {
                        $tabs_gui->addTarget("view",
                                $this->ctrl->getLinkTarget($this, "view"), array("", "view"), get_class($this));
 
                }
                
                if ($this->checkPermissionBool("edit_permission"))
                {
                        $tabs_gui->addTarget("perm_settings",
                                $this->ctrl->getLinkTargetByClass(array(get_class($this),'ilpermissiongui'), "perm"), "", "ilpermissiongui");
                }
                        
                if ($tree->getSavedNodeData($this->object->getRefId()))
                {
                        $tabs_gui->addTarget("trash",
                                $this->ctrl->getLinkTarget($this, "trash"), "trash", get_class($this));
                }
        }

References $tree, and checkPermissionBool().

Referenced by setAdminTabs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCenterColumnHTML()

ilObjectGUI::getCenterColumnHTML ( )

protected

Get center column.

Reimplemented in ilObject2GUI.

Definition at line 1856 of file class.ilObjectGUI.php.

        {
                global $ilCtrl;
 
                include_once("Services/Block/classes/class.ilColumnGUI.php");
 
                $obj_id = ilObject::_lookupObjId($this->object->getRefId());
                $obj_type = ilObject::_lookupType($obj_id);
 
                if ($ilCtrl->getNextClass() != "ilcolumngui")
                {
                        // normal command processing    
                        return $this->getContent();
                }
                else
                {
                        if (!$ilCtrl->isAsynch())
                        {
                                //if ($column_gui->getScreenMode() != IL_SCREEN_SIDE)
                                if (ilColumnGUI::getScreenMode() != IL_SCREEN_SIDE)
                                {
                                        // right column wants center
                                        if (ilColumnGUI::getCmdSide() == IL_COL_RIGHT)
                                        {
                                                $column_gui = new ilColumnGUI($obj_type, IL_COL_RIGHT);
                                                $this->setColumnSettings($column_gui);
                                                $this->html = $ilCtrl->forwardCommand($column_gui);
                                        }
                                        // left column wants center
                                        if (ilColumnGUI::getCmdSide() == IL_COL_LEFT)
                                        {
                                                $column_gui = new ilColumnGUI($obj_type, IL_COL_LEFT);
                                                $this->setColumnSettings($column_gui);
                                                $this->html = $ilCtrl->forwardCommand($column_gui);
                                        }
                                }
                                else
                                {
                                        // normal command processing    
                                        return $this->getContent();
                                }
                        }
                }
        }

References $ilCtrl, $obj_id, ilObject\_lookupObjId(), ilObject\_lookupType(), ilColumnGUI\getCmdSide(), ilColumnGUI\getScreenMode(), IL_COL_LEFT, IL_COL_RIGHT, IL_SCREEN_SIDE, and setColumnSettings().

Referenced by ilObjForumGUI\showThreadsObject(), ilObjForumGUI\sortThreadsObject(), and ilCourseContentGUI\view().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCreationFormsHTML()

ilObjectGUI::getCreationFormsHTML ( array $a_forms )

finalprotected

Get HTML for creation forms (accordion)

Parameters

array $a_forms

Definition at line 769 of file class.ilObjectGUI.php.

        {
                global $tpl;
                
                // #13168- sanity check
                foreach($a_forms as $id => $form)
                {
                        if(!$form instanceof ilPropertyFormGUI)
                        {
                                unset($a_forms[$id]);
                        }
                }
                
                // no accordion if there is just one form
                if(sizeof($a_forms) == 1)
                {
                        $form_type = key($a_forms);
                        $a_forms = array_shift($a_forms);
 
                        // see bug #0016217
                        if(method_exists($this, "getCreationFormTitle"))
                        {
                                $form_title = $this->getCreationFormTitle($form_type);
                                if ($form_title != "")
                                {
                                        $a_forms->setTitle($form_title);
                                }
                        }
                        return $a_forms->getHTML();
                }
                else
                {
                        include_once("./Services/Accordion/classes/class.ilAccordionGUI.php");
 
                        $acc = new ilAccordionGUI();
                        $acc->setBehaviour(ilAccordionGUI::FIRST_OPEN);
                        $cnt = 1;
                        foreach ($a_forms as $form_type => $cf)
                        {                               
                                $htpl = new ilTemplate("tpl.creation_acc_head.html", true, true, "Services/Object");
 
                                // using custom form titles (used for repository plugins)
                                $form_title = "";
                                if(method_exists($this, "getCreationFormTitle"))
                                {
                                        $form_title = $this->getCreationFormTitle($form_type);
                                }
                                if(!$form_title)
                                {
                                        $form_title = $cf->getTitle();
                                }
 
                                // move title from form to accordion
                                $htpl->setVariable("TITLE", $this->lng->txt("option")." ".$cnt.": ".
                                        $form_title);
                                $cf->setTitle(null);
                                $cf->setTitleIcon(null);
                                $cf->setTableWidth("100%");
 
                                $acc->addItem($htpl->get(), $cf->getHTML());
 
                                $cnt++;                         
                        }
 
                        return "<div class='ilCreationFormSection'>".$acc->getHTML()."</div>";
                }
        }

References $tpl, and ilAccordionGUI\FIRST_OPEN.

Referenced by createObject(), and ilObjStyleSheetGUI\createObject().

Here is the caller graph for this function:

◆ getCreationMode()

ilObjectGUI::getCreationMode ( )

get creation mode

Reimplemented in ilObject2GUI.

Definition at line 216 of file class.ilObjectGUI.php.

        {
                return $this->creation_mode;
        }

Here is the caller graph for this function:

◆ getDidacticTemplateVar()

ilObjectGUI::getDidacticTemplateVar ( $a_type )

protected

Get didactic template setting from creation screen.

Parameters

string $a_type

Returns: string

Definition at line 1025 of file class.ilObjectGUI.php.

        {
                $tpl = $_POST["didactic_type"];
                if($tpl && substr($tpl, 0, strlen($a_type)+1) == $a_type."_")
                {
                        return (int)substr($tpl, strlen($a_type)+1);
                }
        }

References $_POST, and $tpl.

Referenced by ilObjSurveyGUI\afterSave(), ilObjTestGUI\afterSave(), ilContainerGUI\afterUpdate(), and saveObject().

Here is the caller graph for this function:

◆ getEditFormCustomValues()

ilObjectGUI::getEditFormCustomValues ( array & $a_values )

protected

Add values to custom edit fields.

Parameters

array $a_values

Reimplemented in ilObjBibliographicGUI, ilObjBlogGUI, ilObjBookingPoolGUI, ilObjDataCollectionGUI, ilObjExerciseGUI, ilObjFolderGUI, ilObjMediaPoolGUI, ilObjPollGUI, ilObjPortfolioBaseGUI, ilObjPortfolioGUI, and ilObjPortfolioTemplateGUI.

Definition at line 1202 of file class.ilObjectGUI.php.

        {
 
        }

Referenced by getEditFormValues().

Here is the caller graph for this function:

◆ getEditFormValues()

ilObjectGUI::getEditFormValues ( )

protected

Get values for edit form.

Returns: array

Reimplemented in ilObjCategoryGUI, ilObjCourseGUI, ilObjRootFolderGUI, and ilContainerGUI.

Definition at line 1189 of file class.ilObjectGUI.php.

        {
                $values["title"] = $this->object->getTitle();
                $values["desc"] = $this->object->getLongDescription();
                $this->getEditFormCustomValues($values);
                return $values;
        }

References getEditFormCustomValues().

Referenced by editObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFormAction()

ilObjectGUI::getFormAction	(	$a_cmd,
		$a_formaction = `""`
	)

get form action for command (command is method name without "Object", e.g.

"perm")

Parameters

string	$a_cmd	command
string	$a_formaction	default formaction (is returned, if no special formaction was set) @access public

Returns: string

Definition at line 1404 of file class.ilObjectGUI.php.

        {
                if ($this->formaction[$a_cmd] != "")
                {
                        return $this->formaction[$a_cmd];
                }
                else
                {
                        return $a_formaction;
                }
        }

Referenced by ilObjGroupGUI\exportObject(), and ilObjCourseGUI\redirectLocToTestConfirmation().

Here is the caller graph for this function:

◆ getHTML()

ilObjectGUI::getHTML ( )

Reimplemented in ilObjBlogGUI, ilObjPollGUI, and ilObject2GUI.

Definition at line 516 of file class.ilObjectGUI.php.

        {
                return $this->html;
        }

References $html.

◆ getReturnLocation()

ilObjectGUI::getReturnLocation	(	$a_cmd,
		$a_location = `""`
	)

protected

get return location for command (command is method name without "Object", e.g.

"perm")

Parameters

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

Definition at line 1436 of file class.ilObjectGUI.php.

        {
                if ($this->return_location[$a_cmd] != "")
                {
                        return $this->return_location[$a_cmd];
                }
                else
                {
                        return $a_location;
                }
        }

Referenced by ilObjCourseGUI\afterSave(), ilObjStudyProgrammeGUI\afterSave(), ilObjTestGUI\backToRepositoryObject(), ilObjStyleSettingsGUI\confirmedDeleteObject(), ilObjStyleSettingsGUI\saveObject(), and ilObjAuthSettingsGUI\setAuthModeObject().

Here is the caller graph for this function:

◆ getRightColumnHTML()

ilObjectGUI::getRightColumnHTML ( )

protected

Display right column.

Reimplemented in ilCourseContentGUI, and ilObject2GUI.

Definition at line 1904 of file class.ilObjectGUI.php.

        {
                global $ilUser, $lng, $ilCtrl;
                
                $obj_id = ilObject::_lookupObjId($this->object->getRefId());
                $obj_type = ilObject::_lookupType($obj_id);
 
                include_once("Services/Block/classes/class.ilColumnGUI.php");
                $column_gui = new ilColumnGUI($obj_type, IL_COL_RIGHT);
                
                if ($column_gui->getScreenMode() == IL_SCREEN_FULL)
                {
                        return "";
                }
                
                $this->setColumnSettings($column_gui);
                
                if ($ilCtrl->getNextClass() == "ilcolumngui" &&
                        $column_gui->getCmdSide() == IL_COL_RIGHT &&
                        $column_gui->getScreenMode() == IL_SCREEN_SIDE)
                {
                        $html = $ilCtrl->forwardCommand($column_gui);
                }
                else
                {
                        if (!$ilCtrl->isAsynch())
                        {
                                $html = $ilCtrl->getHTML($column_gui);
                        }
                }
 
                return $html;
        }

References $html, $ilCtrl, $ilUser, $lng, $obj_id, ilObject\_lookupObjId(), ilObject\_lookupType(), IL_COL_RIGHT, IL_SCREEN_FULL, IL_SCREEN_SIDE, and setColumnSettings().

Referenced by ilObjForumGUI\setSideBlocks().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTabs()

ilObjectGUI::getTabs ( & $tabs_gui )

protected

get tabs abstract method.

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

Parameters

object instance of ilTabsGUI

Reimplemented in ilObjCategoryGUI, ilObjCourseGUI, ilObjFolderGUI, ilObjGlossaryGUI, ilObjGroupGUI, ilObjRootFolderGUI, ilObjSCORM2004LearningModuleGUI, ilObjSAHSLearningModuleGUI, ilObjSurveyAdministrationGUI, ilObjSurveyGUI, ilObjSurveyQuestionPoolGUI, ilObjAssessmentFolderGUI, ilObjTestGUI, ilObjQuestionPoolGUI, ilObjRoleGUI, ilObjRoleTemplateGUI, ilObjExternalToolsSettingsGUI, ilObjAdvancedEditingGUI, ilObjAuthSettingsGUI, ilContainerGUI, ilObjLanguageFolderGUI, ilObjMediaObjectGUI, ilObjObjectFolderGUI, ilObjTypeDefinitionGUI, ilObjSearchSettingsGUI, ilObjStyleSettingsGUI, ilObjStyleSheetGUI, ilObjUserTrackingGUI, ilObjUserFolderGUI, and ilObjUserGUI.

Definition at line 1697 of file class.ilObjectGUI.php.

        {
                // please define your tabs here
 
        }

Referenced by ilObjMailGUI\getAdminTabs(), and setTabs().

Here is the caller graph for this function:

◆ getTargetFrame()

ilObjectGUI::getTargetFrame	(	$a_cmd,
		$a_target_frame = `""`
	)

protected

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 in ilObject2GUI.

Definition at line 1468 of file class.ilObjectGUI.php.

        {
                if ($this->target_frame[$a_cmd] != "")
                {
                        return $this->target_frame[$a_cmd];
                }
                elseif (!empty($a_target_frame))
                {
                        return "target=\"".$a_target_frame."\"";
                }
                else
                {
                        return;
                }
        }

◆ getTemplateFile()

ilObjectGUI::getTemplateFile	(	$a_cmd,
		$a_type = `""`
	)

finalprotected

get a template blockfile format: tpl.

<objtype>_<command>.html

Parameters

string	command
string	object type definition @access public

Definition at line 1664 of file class.ilObjectGUI.php.

        {
                mk(); die("ilObjectGUI::getTemplateFile() is deprecated.");
        }

◆ getTitlesByRefId()

ilObjectGUI::getTitlesByRefId ( $a_ref_ids )

protected

get Titles of objects this method is used for error messages in methods cut/copy/paste

Parameters

array Array of ref_ids (integer)

Returns: array Array of titles (string) @access private

Definition at line 1677 of file class.ilObjectGUI.php.

        {
                foreach ($a_ref_ids as $id)
                {
                        // GET OBJECT TITLE
                        $tmp_obj =& $this->ilias->obj_factory->getInstanceByRefId($id);
                        $title[] = $tmp_obj->getTitle();
                        unset($tmp_obj);
                }
 
                return $title ? $title : array();
        }

Referenced by ilContainerGUI\copyObject(), and ilContainerGUI\cutObject().

Here is the caller graph for this function:

◆ handleAutoRating()

ilObjectGUI::handleAutoRating ( ilObject $a_new_obj )

protected

Activate rating automatically if parent container setting.

Parameters

ilObject $a_new_obj

Reimplemented in ilObject2GUI.

Definition at line 2097 of file class.ilObjectGUI.php.

        {                               
                if(ilObject::hasAutoRating($a_new_obj->getType(), $a_new_obj->getRefId()) && 
                        method_exists($a_new_obj, "setRating"))
                {                                                       
                        $a_new_obj->setRating(true);
                        $a_new_obj->update();
                }               
        }

References ilObject\getRefId(), ilObject\getType(), ilObject\hasAutoRating(), and ilObject\update().

Referenced by saveObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hitsperpageObject()

ilObjectGUI::hitsperpageObject ( )

protected

Reimplemented in ilObject2GUI, ilObjUserFolderGUI, and ilObjUserGUI.

Definition at line 1711 of file class.ilObjectGUI.php.

        {
        ilSession::set("tbl_limit", $_POST["hitsperpage"]);
        $_GET["limit"] = $_POST["hitsperpage"];
        }

References $_GET, $_POST, and ilSession\set().

Here is the call graph for this function:

◆ ilObjectGUI()

ilObjectGUI::ilObjectGUI	(	$a_data,
		$a_id = `0`,
		$a_call_by_reference = `true`,
		$a_prepare_output = `true`
	)

Constructor @access public.

Parameters

array	??
integer	object id
boolean	call be reference

Definition at line 91 of file class.ilObjectGUI.php.

        {
                global $ilias, $objDefinition, $tpl, $tree, $ilCtrl, $ilErr, $lng, $ilTabs;
 
                $this->tabs_gui =& $ilTabs;
 
                if (!isset($ilErr))
                {
                        $ilErr = new ilErrorHandling();
                        $ilErr->setErrorHandling(PEAR_ERROR_CALLBACK,array($ilErr,'errorHandler'));
                }
                else
                {
                        $this->ilErr =& $ilErr;
                }
 
                $this->ilias =& $ilias;
                $this->objDefinition =& $objDefinition;
                $this->tpl =& $tpl;
                $this->html = "";
                $this->ctrl =& $ilCtrl;
 
                $params = array("ref_id");
 
                if (!$a_call_by_reference)
                {
                        $params = array("ref_id","obj_id");
                }
 
                $this->ctrl->saveParameter($this, $params);
 
                $this->lng = $lng;
                $this->tree =& $tree;
                $this->formaction = array();
                $this->return_location = array();
                $this->target_frame = array();
                $this->actions = "";
                $this->sub_objects = "";
 
                $this->data = $a_data;
                $this->id = $a_id;
                $this->call_by_reference = $a_call_by_reference;
                $this->prepare_output = $a_prepare_output;
                $this->creation_mode = false;
 
                $this->ref_id = ($this->call_by_reference) ? $this->id : $_GET["ref_id"];
                $this->obj_id = ($this->call_by_reference) ? $_GET["obj_id"] : $this->id;
 
                if ($this->id != 0)
                {
                        $this->link_params = "ref_id=".$this->ref_id;
                }
 
                // get the object
                $this->assignObject();
                
                // set context
                if (is_object($this->object))
                {
                        if ($this->call_by_reference && $this->ref_id == $_GET["ref_id"])
                        {
                                $this->ctrl->setContext($this->object->getId(), 
                                        $this->object->getType());
                        }
                }
 
                // use global $lng instead, when creating new objects object is not available
                //$this->lng =& $this->object->lng;
 
                //prepare output
                if ($a_prepare_output)
                {
                        $this->prepareOutput();
                }
        }

References $_GET, $ilCtrl, $ilErr, $ilias, $lng, $objDefinition, $params, $tpl, $tree, assignObject(), PEAR_ERROR_CALLBACK, and prepareOutput().

Referenced by ilObjBookingPoolGUI\__construct(), ilObjPaymentSettingsGUI\__construct(), ilObjRoleGUI\__construct(), ilObjNotificationAdminGUI\__construct(), ilContainerGUI\ilContainerGUI(), ilObjAdvancedEditingGUI\ilObjAdvancedEditingGUI(), ilObjAICCLearningModuleGUI\ilObjAICCLearningModuleGUI(), ilObjAssessmentFolderGUI\ilObjAssessmentFolderGUI(), ilObjAuthSettingsGUI\ilObjAuthSettingsGUI(), ilObjExerciseGUI\ilObjExerciseGUI(), ilObjExternalFeedGUI\ilObjExternalFeedGUI(), ilObjExternalToolsSettingsGUI\ilObjExternalToolsSettingsGUI(), ilObjFileAccessSettingsGUI\ilObjFileAccessSettingsGUI(), ilObjHACPLearningModuleGUI\ilObjHACPLearningModuleGUI(), ilObjLanguageExtGUI\ilObjLanguageExtGUI(), ilObjLanguageFolderGUI\ilObjLanguageFolderGUI(), ilObjLanguageGUI\ilObjLanguageGUI(), ilObjMediaCastGUI\ilObjMediaCastGUI(), ilObjObjectFolderGUI\ilObjObjectFolderGUI(), ilObjQuestionPoolGUI\ilObjQuestionPoolGUI(), ilObjRecoveryFolderGUI\ilObjRecoveryFolderGUI(), ilObjRoleFolderGUI\ilObjRoleFolderGUI(), ilObjRoleTemplateGUI\ilObjRoleTemplateGUI(), ilObjSAHSLearningModuleGUI\ilObjSAHSLearningModuleGUI(), ilObjSCORM2004LearningModuleGUI\ilObjSCORM2004LearningModuleGUI(), ilObjSCORMLearningModuleGUI\ilObjSCORMLearningModuleGUI(), ilObjSearchSettingsGUI\ilObjSearchSettingsGUI(), ilObjStyleSettingsGUI\ilObjStyleSettingsGUI(), ilObjStyleSheetGUI\ilObjStyleSheetGUI(), ilObjSurveyAdministrationGUI\ilObjSurveyAdministrationGUI(), ilObjSurveyQuestionPoolGUI\ilObjSurveyQuestionPoolGUI(), ilObjSystemFolderGUI\ilObjSystemFolderGUI(), ilObjTestGUI\ilObjTestGUI(), ilObjTypeDefinitionGUI\ilObjTypeDefinitionGUI(), ilObjUserFolderGUI\ilObjUserFolderGUI(), ilObjUserGUI\ilObjUserGUI(), ilObjUserTrackingGUI\ilObjUserTrackingGUI(), and ilObjWikiGUI\ilObjWikiGUI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importFileObject()

ilObjectGUI::importFileObject	(	$parent_id = `null`,
		$a_catch_errors = `true`
	)

protected

Import.

Definition at line 1297 of file class.ilObjectGUI.php.

        {
                global $objDefinition, $tpl, $ilErr;
 
                if(!$parent_id)
                {
                        $parent_id = $_GET["ref_id"];
                }
                $new_type = $_REQUEST["new_type"];
 
                // create permission is already checked in createObject. This check here is done to prevent hacking attempts
                if (!$this->checkPermissionBool("create", "", $new_type))
                {
                        $ilErr->raiseError($this->lng->txt("no_create_permission"));
                }
 
                $this->lng->loadLanguageModule($new_type);
                $this->ctrl->setParameter($this, "new_type", $new_type);
                
                $form = $this->initImportForm($new_type);
                if ($form->checkInput())
                {
                        // :todo: make some check on manifest file
 
                        if($objDefinition->isContainer($new_type))
                        {
                                include_once './Services/Export/classes/class.ilImportContainer.php';
                                $imp = new ilImportContainer((int)$parent_id);
                        }
                        else
                        {
                                include_once("./Services/Export/classes/class.ilImport.php");
                                $imp = new ilImport((int)$parent_id);
                        }
 
                        try
                        {
                                $new_id = $imp->importObject(null, $_FILES["importfile"]["tmp_name"],
                                        $_FILES["importfile"]["name"], $new_type);
                        }
                        catch (ilException $e)
                        {
                                $this->tmp_import_dir = $imp->getTemporaryImportDir();
                                if (!$a_catch_errors)
                                {
                                        throw $e;
                                }
                                // display message and form again
                                ilUtil::sendFailure($this->lng->txt("obj_import_file_error")." <br />".$e->getMessage());
                                $form->setValuesByPost();
                                $tpl->setContent($form->getHtml());
                                return;
                        }
 
                        if ($new_id > 0)
                        {
                                $this->ctrl->setParameter($this, "new_type", "");
 
                                $newObj = ilObjectFactory::getInstanceByObjId($new_id);
 
                                // put new object id into tree - already done in import for containers
                                if(!$objDefinition->isContainer($new_type))
                                {
                                        $this->putObjectInTree($newObj);
                                }
                                
                                $this->afterImport($newObj);
                        }
                        // import failed
                        else 
                        {
                                if($objDefinition->isContainer($new_type))
                                {
                                        ilUtil::sendFailure($this->lng->txt("container_import_zip_file_invalid"));
                                }
                                else
                                {
                                        // not enough information here...
                                        return;
                                }
                        }
                }
 
                // display form to correct errors
                $form->setValuesByPost();
                $tpl->setContent($form->getHtml());
        }

References $_GET, $_REQUEST, $ilErr, $objDefinition, $tpl, afterImport(), checkPermissionBool(), ilObjectFactory\getInstanceByObjId(), initImportForm(), putObjectInTree(), and ilUtil\sendFailure().

Referenced by ilObjOrgUnitGUI\executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initCreateForm()

ilObjectGUI::initCreateForm ( $a_new_type )

protected

Init object creation form.

Parameters

string $a_new_type

Returns: ilPropertyFormGUI

Reimplemented in ilObjCloudGUI, ilObjGlossaryGUI, ilObjGroupGUI, ilObjItemGroupGUI, ilObjPortfolioGUI, ilObjSessionGUI, ilObjLinkResourceGUI, ilContainerReferenceGUI, and ilObjectPluginGUI.

Definition at line 843 of file class.ilObjectGUI.php.

        {
                include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
                $form = new ilPropertyFormGUI();
                $form->setTarget("_top");
                $form->setFormAction($this->ctrl->getFormAction($this, "save"));
                $form->setTitle($this->lng->txt($a_new_type."_new"));
 
                // title
                $ti = new ilTextInputGUI($this->lng->txt("title"), "title");
                $ti->setSize(min(40, ilObject::TITLE_LENGTH));
                $ti->setMaxLength(ilObject::TITLE_LENGTH);
                $ti->setRequired(true);
                $form->addItem($ti);
 
                // description
                $ta = new ilTextAreaInputGUI($this->lng->txt("description"), "desc");
                $ta->setCols(40);
                $ta->setRows(2);
                $form->addItem($ta);
 
                $form = $this->initDidacticTemplate($form);
 
                $form->addCommandButton("save", $this->lng->txt($a_new_type."_add"));
                $form->addCommandButton("cancel", $this->lng->txt("cancel"));
 
                return $form;
        }

References initDidacticTemplate(), and ilObject\TITLE_LENGTH.

Referenced by ilObjFileBasedLMGUI\initCreationForms(), ilObjMediaCastGUI\initCreationForms(), ilObjMediaPoolGUI\initCreationForms(), ilObjOrgUnitGUI\initCreationForms(), ilObjStudyProgrammeGUI\initCreationForms(), ilObjSurveyQuestionPoolGUI\initCreationForms(), ilObjWorkspaceFolderGUI\initCreationForms(), initCreationForms(), ilObjTaxonomyGUI\initCreationForms(), and saveObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initCreationForms()

ilObjectGUI::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 in ilObjBibliographicGUI, ilObjBlogGUI, ilObjBookingPoolGUI, ilObjCategoryGUI, ilObjChatroomGUI, ilObjCloudGUI, ilObjDataCollectionGUI, ilObjFileBasedLMGUI, ilObjItemGroupGUI, ilObjMediaCastGUI, ilObjMediaPoolGUI, ilObjOrgUnitGUI, ilObjPortfolioGUI, ilObjSAHSLearningModuleGUI, ilObjStudyProgrammeGUI, ilObjSurveyQuestionPoolGUI, ilObjWikiGUI, ilObjWorkspaceFolderGUI, ilObject2GUI, and ilObjectPluginGUI.

Definition at line 753 of file class.ilObjectGUI.php.

        {
                $forms = array(
                        self::CFORM_NEW => $this->initCreateForm($a_new_type),
                        self::CFORM_IMPORT => $this->initImportForm($a_new_type),
                        self::CFORM_CLONE => $this->fillCloneTemplate(null, $a_new_type)
                        );
                
                return $forms;
        }

References fillCloneTemplate(), initCreateForm(), and initImportForm().

Referenced by createObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initDidacticTemplate()

ilObjectGUI::initDidacticTemplate ( ilPropertyFormGUI $form )

protected

Show didactic template types.

Parameters

ilPropertyFormGUI $form

Returns: ilPropertyFormGUI $form

Reimplemented in ilObjPortfolioTemplateGUI.

Definition at line 877 of file class.ilObjectGUI.php.

        {
                global $lng;
                
                $lng->loadLanguageModule('didactic');
                                        
                $options = array();
                $options['dtpl_0'] = array($this->lng->txt('didactic_default_type'),
                        sprintf(
                                $this->lng->txt('didactic_default_type_info'),
                                $this->lng->txt('objs_'.$this->type)
                        ));
                
                include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateSettings.php';
                $templates = ilDidacticTemplateSettings::getInstanceByObjectType($this->type)->getTemplates();
                if($templates)
                {
                        foreach($templates as $template)
                        {
                                $options["dtpl_".$template->getId()] = array($template->getTitle(),
                                        $template->getDescription());                   
                        }
                }
                
                $this->addDidacticTemplateOptions($options);
                
                if(sizeof($options) > 1)
                {
                        $type = new ilRadioGroupInputGUI(
                                $this->lng->txt('type'),
                                'didactic_type'
                        );
                        // workaround for containers in edit mode
                        if(!$this->getCreationMode())
                        {
                                include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateObjSettings.php';
                                $type->setValue(
                                        'dtpl_'.ilDidacticTemplateObjSettings::lookupTemplateId($this->object->getRefId())
                                );
                        }
                        else
                        {
                                $type->setValue('dtpl_0');
                        }
                        $form->addItem($type);          
 
                        ilUtil::sortArray($options, 0);
                        foreach($options as $id => $data)
                        {
                                $option = new ilRadioOption($data[0], $id, $data[1]);
                                $type->addOption($option);
                        }
                }
                                                        
                return $form;
        }

References $data, $lng, $options, addDidacticTemplateOptions(), ilPropertyFormGUI\addItem(), getCreationMode(), ilDidacticTemplateSettings\getInstanceByObjectType(), ilDidacticTemplateObjSettings\lookupTemplateId(), and ilUtil\sortArray().

Referenced by ilObjCloudGUI\initCreateForm(), initCreateForm(), ilObjFolderGUI\initEditCustomForm(), ilObjCategoryGUI\initEditForm(), and ilObjCourseGUI\initEditForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initEditCustomForm()

ilObjectGUI::initEditCustomForm ( ilPropertyFormGUI $a_form )

protected

Add custom fields to update form.

Parameters

ilPropertyFormGUI $a_form

Reimplemented in ilObjBibliographicGUI, ilObjBlogGUI, ilObjBookingPoolGUI, ilObjDataCollectionGUI, ilObjExerciseGUI, ilObjFolderGUI, ilObjMediaPoolGUI, ilObjPollGUI, ilObjPortfolioBaseGUI, and ilObjPortfolioTemplateGUI.

Definition at line 1179 of file class.ilObjectGUI.php.

        {
                
        }

Referenced by initEditForm().

Here is the caller graph for this function:

◆ initEditForm()

ilObjectGUI::initEditForm ( )

protected

Init object edit form.

Returns: ilPropertyFormGUI

Reimplemented in ilObjBibliographicGUI, ilObjCategoryGUI, ilObjCourseGUI, ilObjPortfolioGUI, ilObjRootFolderGUI, ilObjSurveyQuestionPoolGUI, ilObjectPluginGUI, and ilRemoteObjectBaseGUI.

Definition at line 1142 of file class.ilObjectGUI.php.

        {
                global $lng, $ilCtrl;
 
                $lng->loadLanguageModule($this->object->getType());
 
                include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
                $form = new ilPropertyFormGUI();
                $form->setFormAction($this->ctrl->getFormAction($this, "update"));
                $form->setTitle($this->lng->txt($this->object->getType()."_edit"));
 
                // title
                $ti = new ilTextInputGUI($this->lng->txt("title"), "title");
                $ti->setSize(min(40, ilObject::TITLE_LENGTH));
                $ti->setMaxLength(ilObject::TITLE_LENGTH);
                $ti->setRequired(true);
                $form->addItem($ti);
 
                // description
                $ta = new ilTextAreaInputGUI($this->lng->txt("description"), "desc");
                $ta->setCols(40);
                $ta->setRows(2);
                $form->addItem($ta);
 
                $this->initEditCustomForm($form);
 
                $form->addCommandButton("update", $this->lng->txt("save"));
                //$this->form->addCommandButton("cancelUpdate", $lng->txt("cancel"));
 
                return $form;
        }

References $ilCtrl, $lng, initEditCustomForm(), and ilObject\TITLE_LENGTH.

Referenced by ilObjFolderGUI\editObject(), editObject(), and updateObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initHeaderAction()

ilObjectGUI::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 in ilObjCourseGUI, ilObjFileGUI, ilObjGroupGUI, ilContainerGUI, and ilObject2GUI.

Definition at line 361 of file class.ilObjectGUI.php.

        {
                global $ilAccess; 
                
                if(!$this->creation_mode && $this->object)
                {
                        include_once "Services/Object/classes/class.ilCommonActionDispatcherGUI.php";
                        $dispatcher = new ilCommonActionDispatcherGUI(ilCommonActionDispatcherGUI::TYPE_REPOSITORY, 
                                $ilAccess, $this->object->getType(), $this->ref_id, $this->object->getId());
                        
                        $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);
                                }                       
                                
                                // enable multi download
                                $lg->enableMultiDownload(true);
                                
                                // comments settings are always on (for the repository)
                                // should only be shown if active or permission to toggle
                                include_once "Services/Notes/classes/class.ilNote.php";
                                if($ilAccess->checkAccess("write", "", $this->ref_id) ||
                                        $ilAccess->checkAccess("edit_permissions", "", $this->ref_id) ||
                                        ilNote::commentsActivated($this->object->getId(), 0, $this->object->getType()))
                                {
                                        $lg->enableComments(true);
                                }
                                
                                $lg->enableNotes(true);
                                $lg->enableTags(true);
                        }
                        
                        return $lg;
                }
        }

References $lg, ilNote\commentsActivated(), and ilCommonActionDispatcherGUI\TYPE_REPOSITORY.

Referenced by addHeaderAction(), and redrawHeaderActionObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initImportForm()

ilObjectGUI::initImportForm ( $a_new_type )

protected

Init object import form.

Parameters

string new type

Returns: ilPropertyFormGUI

Reimplemented in ilObjSurveyGUI, ilObjSurveyQuestionPoolGUI, ilObjTestGUI, ilObjQuestionPoolGUI, and ilObjectPluginGUI.

Definition at line 1274 of file class.ilObjectGUI.php.

        {
                include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
                $form = new ilPropertyFormGUI();
                $form->setTarget("_top");
                $form->setFormAction($this->ctrl->getFormAction($this, "importFile"));
                $form->setTitle($this->lng->txt($a_new_type."_import"));
 
                include_once("./Services/Form/classes/class.ilFileInputGUI.php");
                $fi = new ilFileInputGUI($this->lng->txt("import_file"), "importfile");
                $fi->setSuffixes(array("zip"));
                $fi->setRequired(true);
                $form->addItem($fi);
 
                $form->addCommandButton("importFile", $this->lng->txt("import"));
                $form->addCommandButton("cancel", $this->lng->txt("cancel"));
        
                return $form;
        }

Referenced by importFileObject(), ilObjFileBasedLMGUI\initCreationForms(), ilObjMediaCastGUI\initCreationForms(), ilObjMediaPoolGUI\initCreationForms(), ilObjOrgUnitGUI\initCreationForms(), ilObjWikiGUI\initCreationForms(), initCreationForms(), and ilObjFileGUI\initCreationForms().

Here is the caller graph for this function:

◆ insertHeaderAction()

ilObjectGUI::insertHeaderAction ( $a_list_gui )

protected

Insert header action into main template.

Parameters

ilObjectListGUI $a_list_gui

Definition at line 414 of file class.ilObjectGUI.php.

        {
                if(is_object($a_list_gui))
                {
                        $this->tpl->setHeaderActionMenu($a_list_gui->getHeaderAction());
                }
        }

Referenced by ilObjBlogGUI\addHeaderAction(), ilObjCloudGUI\addHeaderAction(), and addHeaderAction().

Here is the caller graph for this function:

◆ isVisible()

ilObjectGUI::isVisible	(	$a_ref_id,
		$a_type
	)

Definition at line 1497 of file class.ilObjectGUI.php.

        {
                global $ilBench;
                
                $ilBench->start("Explorer", "setOutput_isVisible");
                $visible = $this->checkPermissionBool("visible,read", "", "", $a_ref_id);
                
                if ($visible && $a_type == 'crs') {
                        global $tree;
                        if($crs_id = $tree->checkForParentType($a_ref_id,'crs'))
                        {
                                if(!$this->checkPermissionBool("write", "", "", $crs_id))
                                {
                                        // Show only activated courses
                                        $tmp_obj =& ilObjectFactory::getInstanceByRefId($crs_id,false);
        
                                        if(!$tmp_obj->isActivated())
                                        {
                                                unset($tmp_obj);
                                                $visible = false;
                                        }
                                        if(($crs_id != $a_ref_id) and $tmp_obj->isArchived())
                                        {
                                                $visible = false;
                                        }                                       
                                }
                        }
                }
                
                $ilBench->stop("Explorer", "setOutput_isVisible");
 
                return $visible;
        }

References $ilBench, $tree, checkPermissionBool(), and ilObjectFactory\getInstanceByRefId().

Here is the call graph for this function:

◆ omitLocator()

ilObjectGUI::omitLocator ( $a_omit = true )

protected

Reimplemented in ilObject2GUI.

Definition at line 622 of file class.ilObjectGUI.php.

        {
                $this->omit_locator = $a_omit;
        }

◆ prepareOutput()

ilObjectGUI::prepareOutput ( )

protected

prepare output

Reimplemented in ilObjCourseGUI, ilObjGroupGUI, ilObjSessionGUI, and ilObject2GUI.

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

        {
                global $ilLocator, $tpl, $ilUser;
 
                $this->tpl->getStandardTemplate();
                // administration prepare output
                if (strtolower($_GET["baseClass"]) == "iladministrationgui")
                {
                        $this->addAdminLocatorItems();
                        $tpl->setLocator();
 
//                      ilUtil::sendInfo();
                        ilUtil::infoPanel();
 
                        $this->setTitleAndDescription();
 
                        if ($this->getCreationMode() != true)
                        {
                                $this->setAdminTabs();
                        }
                        
                        return false;
                }
                // set locator
                $this->setLocator();
                // catch feedback message
//              ilUtil::sendInfo();
                ilUtil::infoPanel();
 
                // in creation mode (parent) object and gui object
                // do not fit
                if ($this->getCreationMode() == true)
                {
                        // repository vs. workspace
                        if($this->call_by_reference)
                        {
                                // get gui class of parent and call their title and description method
                                $obj_type = ilObject::_lookupType($_GET["ref_id"],true);
                                $class_name = $this->objDefinition->getClassName($obj_type);
                                $class = strtolower("ilObj".$class_name."GUI");
                                $class_path = $this->ctrl->lookupClassPath($class);
                                include_once($class_path);
                                $class_name = $this->ctrl->getClassForClasspath($class_path);
//echo "<br>instantiating parent for title and description";
                                $this->parent_gui_obj = new $class_name("", $_GET["ref_id"], true, false);
                                // the next line prevents the header action menu being shown
                                $this->parent_gui_obj->setCreationMode(true);
                                $this->parent_gui_obj->setTitleAndDescription();
                        }
                }
                else
                {
                        // set title and description and title icon
                        $this->setTitleAndDescription();
        
                        // set tabs
                        $this->setTabs();
 
                        // BEGIN WebDAV: Display Mount Webfolder icon.
                        require_once 'Services/WebDAV/classes/class.ilDAVServer.php';
                        if (ilDAVServer::_isActive() && 
                                $ilUser->getId() != ANONYMOUS_USER_ID)
                        {
                                $this->showMountWebfolderIcon();
                        }
                        // END WebDAV: Display Mount Webfolder icon.
                        
                        // fileupload support
                        require_once './Services/FileUpload/classes/class.ilFileUploadUtil.php';
                        if (ilFileUploadUtil::isUploadAllowed($this->ref_id, $this->object->getType()))
                        {
                                $this->enableDragDropFileUpload();              
                        }
                }
                
                return true;
        }

References $_GET, $ilUser, $tpl, ilDAVServer\_isActive(), ilObject\_lookupType(), addAdminLocatorItems(), enableDragDropFileUpload(), getCreationMode(), ilUtil\infoPanel(), ilFileUploadUtil\isUploadAllowed(), setAdminTabs(), setLocator(), setTabs(), setTitleAndDescription(), and showMountWebfolderIcon().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ putObjectInTree()

ilObjectGUI::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 in ilObject2GUI.

Definition at line 1040 of file class.ilObjectGUI.php.

        {
                global $rbacreview, $ilUser, $objDefinition;
 
                if(!$a_parent_node_id)
                {
                        $a_parent_node_id = $_GET["ref_id"];
                }
                
                // add new object to custom parent container
                if((int)$_REQUEST["crtptrefid"])
                {
                        $a_parent_node_id = (int)$_REQUEST["crtptrefid"];
                }
 
                $a_obj->createReference();
                $a_obj->putInTree($a_parent_node_id);
                $a_obj->setPermissions($a_parent_node_id);
 
                $this->obj_id = $a_obj->getId();
                $this->ref_id = $a_obj->getRefId();
 
                // BEGIN ChangeEvent: Record save object.
                require_once('Services/Tracking/classes/class.ilChangeEvent.php');
                ilChangeEvent::_recordWriteEvent($this->obj_id, $ilUser->getId(), 'create');
                // END ChangeEvent: Record save object.
 
                // rbac log
                include_once "Services/AccessControl/classes/class.ilRbacLog.php";
                $rbac_log_roles = $rbacreview->getParentRoleIds($this->ref_id, false);
                $rbac_log = ilRbacLog::gatherFaPa($this->ref_id, array_keys($rbac_log_roles), true);
                ilRbacLog::add(ilRbacLog::CREATE_OBJECT, $this->ref_id, $rbac_log);
                
                // use forced callback after object creation
                if($_REQUEST["crtcb"])
                {
                        $callback_type = ilObject::_lookupType((int)$_REQUEST["crtcb"], 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((int)$_REQUEST["crtcb"]);
                        }
                        else
                        {
                                // #10368
                                $callback_obj = new $class_name(null, (int)$_REQUEST["crtcb"], true, false);
                        }
                        $callback_obj->afterSaveCallback($a_obj);
                }
        }

References $_GET, $_REQUEST, $ilUser, $location, $objDefinition, ilObject\_lookupType(), ilChangeEvent\_recordWriteEvent(), ilRbacLog\add(), ilRbacLog\CREATE_OBJECT, ilObject\createReference(), ilRbacLog\gatherFaPa(), ilObject\getId(), ilObject\getRefId(), ilObject\putInTree(), and ilObject\setPermissions().

Referenced by ilObjFileBasedLMGUI\createFromDirectory(), importFileObject(), ilObjSurveyGUI\importFileObject(), ilObjSurveyQuestionPoolGUI\importFileObject(), ilObjGlossaryGUI\saveObject(), ilObjGroupGUI\saveObject(), and saveObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ redirectToRefId()

ilObjectGUI::redirectToRefId	(	$a_ref_id,
		$a_cmd = `""`
	)

protected

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 in ilObjOrgUnitGUI.

Definition at line 1765 of file class.ilObjectGUI.php.

        {
                $obj_type = ilObject::_lookupType($a_ref_id,true);
                $class_name = $this->objDefinition->getClassName($obj_type);
                $class = strtolower("ilObj".$class_name."GUI");
                $this->ctrl->setParameterByClass("ilrepositorygui", "ref_id", $a_ref_id);
                $this->ctrl->redirectByClass(array("ilrepositorygui", $class), $a_cmd);
        }

References ilObject\_lookupType().

Referenced by ilObjCloudGUI\afterSave(), ilObjCategoryGUI\afterSave(), ilObjFolderGUI\afterSave(), ilObjCloudGUI\afterServiceAuth(), ilObjExternalFeedGUI\afterUpdate(), ilObjExternalFeedGUI\cancelUpdate(), ilObjCloudGUI\executeCommand(), and ilObjCloudGUI\serviceAuth().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ redrawHeaderActionObject()

ilObjectGUI::redrawHeaderActionObject ( )

protected

Ajax call: redraw action header only.

Definition at line 433 of file class.ilObjectGUI.php.

        {
                global $tpl;
                
                $lg = $this->initHeaderAction();
                echo $lg->getHeaderAction();            
                
                // we need to add onload code manually (rating, comments, etc.)
                echo $tpl->getOnLoadCodeForAsynch();            
                
                exit;
        }

References $lg, $tpl, exit, and initHeaderAction().

Here is the call graph for this function:

◆ saveObject()

ilObjectGUI::saveObject ( )

save object

@access public

Reimplemented in ilObjGlossaryGUI, ilObjGroupGUI, ilObjSAHSLearningModuleGUI, ilObjSurveyAdministrationGUI, ilObjAssessmentFolderGUI, ilObjWikiGUI, ilObjRoleFolderGUI, ilObjRoleGUI, ilObjRoleTemplateGUI, ilObjRecoveryFolderGUI, ilObjAdvancedEditingGUI, ilContainerReferenceGUI, ilObjLanguageExtGUI, ilObjMailGUI, ilObjMediaObjectGUI, ilObjTypeDefinitionGUI, ilObjStyleSettingsGUI, ilObjStyleSheetGUI, and ilObjUserGUI.

Definition at line 959 of file class.ilObjectGUI.php.

        {
                global $objDefinition, $tpl;
 
                $new_type = $_REQUEST["new_type"];
 
                // create permission is already checked in createObject. This check here is done to prevent hacking attempts
                if (!$this->checkPermissionBool("create", "", $new_type))
                {
                        $this->ilias->raiseError($this->lng->txt("no_create_permission"), $this->ilias->error_obj->MESSAGE);
                }
 
                $this->lng->loadLanguageModule($new_type);
                $this->ctrl->setParameter($this, "new_type", $new_type);
                
                $form = $this->initCreateForm($new_type);
                if ($form->checkInput())
                {
                        $this->ctrl->setParameter($this, "new_type", "");
 
                        // create instance
                        $class_name = "ilObj".$objDefinition->getClassName($new_type);
                        $location = $objDefinition->getLocation($new_type);
                        include_once($location."/class.".$class_name.".php");
                        $newObj = new $class_name();
                        $newObj->setType($new_type);
                        $newObj->setTitle($form->getInput("title"));
                        $newObj->setDescription($form->getInput("desc"));
                        $newObj->create();
                        
                        $this->putObjectInTree($newObj);
 
                        // apply didactic template?
                        $dtpl = $this->getDidacticTemplateVar("dtpl");
                        if($dtpl)
                        {
                                $newObj->applyDidacticTemplate($dtpl);
                        }
                        
                        // auto rating
                        $this->handleAutoRating($newObj);
                        
                        // additional paramters are added to afterSave()
                        $args = func_get_args();
                        if($args)
                        {
                                $this->afterSave($newObj, $args);
                        }
                        else
                        {
                                $this->afterSave($newObj);
                        }
                        return;
                }
 
                // display only this form to correct input
                $form->setValuesByPost();
                $tpl->setContent($form->getHtml());
        }

References $_REQUEST, $location, $objDefinition, $tpl, afterSave(), checkPermissionBool(), getDidacticTemplateVar(), handleAutoRating(), initCreateForm(), and putObjectInTree().

Referenced by ilObjSessionGUI\saveAndAssignMaterialsObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setActions()

ilObjectGUI::setActions ( $a_actions = "" )

finalprivate

set possible actions for objects in list.

if actions are set via this method, the values of objects.xml are ignored.

Parameters

array $a_actions array with $command => $lang_var pairs

Definition at line 528 of file class.ilObjectGUI.php.

        {
                if (is_array($a_actions))
                {
                        foreach ($a_actions as $name => $lng)
                        {
                                $this->actions[$name] = array("name" => $name, "lng" => $lng);
                        }
                }
                else
                {
                        $this->actions = "";
                }
        }

References $lng.

◆ setAdminTabs()

ilObjectGUI::setAdminTabs ( )

finalprotected

set admin tabs @access public

Definition at line 474 of file class.ilObjectGUI.php.

        {
                $this->getAdminTabs($this->tabs_gui);
        }

References getAdminTabs().

Referenced by ilObjectPluginGUI\executeCommand(), and prepareOutput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setColumnSettings()

ilObjectGUI::setColumnSettings ( $column_gui )

protected

May be overwritten in subclasses.

Reimplemented in ilCourseContentGUI, ilContainerGUI, and ilObject2GUI.

Definition at line 1941 of file class.ilObjectGUI.php.

        {
                $column_gui->setRepositoryMode(true);
                $column_gui->setEnableEdit(false);
                if ($this->checkPermissionBool("write"))
                {
                        $column_gui->setEnableEdit(true);
                }
        }

References checkPermissionBool().

Referenced by getCenterColumnHTML(), and getRightColumnHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCreationMode()

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

Reimplemented in ilObject2GUI.

Definition at line 208 of file class.ilObjectGUI.php.

        {
                $this->creation_mode = $a_mode;
        }

Referenced by ilObjStyleSheetGUI\executeCommand().

Here is the caller graph for this function:

◆ setFormAction()

ilObjectGUI::setFormAction	(	$a_cmd,
		$a_formaction
	)

protected

set specific form action for command

Parameters

string	$a_cmd	command
string	$a_formaction	default formaction (is returned, if no special formaction was set) @access public

Definition at line 1424 of file class.ilObjectGUI.php.

        {
                $this->formaction[$a_cmd] = $a_formaction;
        }

Referenced by ilObjFileBasedLMGUI\perm(), and ilObjContentObjectGUI\perm().

Here is the caller graph for this function:

◆ setLocator()

ilObjectGUI::setLocator ( )

protected

set Locator

Parameters

object	tree object
integer	reference id
scriptanme	that is used for linking; @access public

Reimplemented in ilObject2GUI.

Definition at line 572 of file class.ilObjectGUI.php.

        {
                global $ilLocator, $tpl;
                
                if ($this->omit_locator)
                {
                        return;
                }
 
                // repository vs. workspace
                if($this->call_by_reference)
                {
                        // todo: admin workaround
                        // in the future, objectgui classes should not be called in
                        // admin section anymore (rbac/trash handling in own classes)
                        $ref_id = ($_GET["ref_id"] != "")
                                ? $_GET["ref_id"]
                                : $this->object->getRefId();
                        $ilLocator->addRepositoryItems($ref_id);
                }
                
                if(!$this->creation_mode)
                {
                        $this->addLocatorItems();
                }
                
                // 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"));
                }
 
                $tpl->setLocator();
        }

References $_GET, $ref_id, $tpl, and addLocatorItems().

Referenced by ilObjGlossaryGUI\executeCommand(), ilObjFileBasedLMGUI\executeCommand(), ilObjSCORM2004LearningModuleGUI\executeCommand(), ilObjSAHSLearningModuleGUI\executeCommand(), ilObjTestGUI\executeCommand(), prepareOutput(), ilObjTestGUI\prepareSubGuiOutput(), and ilObjGlossaryGUI\showInfoScreen().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setReturnLocation()

ilObjectGUI::setReturnLocation	(	$a_cmd,
		$a_location
	)

protected

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

Definition at line 1455 of file class.ilObjectGUI.php.

        {
//echo "-".$a_cmd."-".$a_location."-";
                $this->return_location[$a_cmd] = $a_location;
        }

Referenced by ilObjContentObjectGUI\addRole(), and ilObjContentObjectGUI\permSave().

Here is the caller graph for this function:

◆ setSubObjects()

ilObjectGUI::setSubObjects ( $a_sub_objects = "" )

finalprivate

set possible subobjects for this object.

if subobjects are set via this method, the values of objects.xml are ignored.

Parameters

array $a_actions array with $command => $lang_var pairs

Definition at line 549 of file class.ilObjectGUI.php.

        {
                if (is_array($a_sub_objects))
                {
                        foreach ($a_sub_objects as $name => $options)
                        {
                                $this->sub_objects[$name] = array("name" => $name, "max" => $options["max"]);
                        }
                }
                else
                {
                        $this->sub_objects = "";
                }
        }

References $options.

◆ setTabs()

ilObjectGUI::setTabs ( )

protected

set admin tabs @access public

Reimplemented in ilObjBlogGUI, ilObjBookingPoolGUI, ilObjCloudGUI, ilObjDataCollectionGUI, ilObjExternalFeedGUI, ilObjFileGUI, ilObjGlossaryGUI, ilObjFileBasedLMGUI, ilObjItemGroupGUI, ilObjMediaCastGUI, ilObjMediaPoolGUI, ilObjPollGUI, ilObjPortfolioGUI, ilObjPortfolioTemplateGUI, ilObjSAHSLearningModuleGUI, ilObjLinkResourceGUI, ilObjWorkspaceRootFolderGUI, ilObjMediaObjectGUI, ilObjNotificationAdminGUI, ilObject2GUI, ilObjStyleSettingsGUI, ilObjStyleSheetGUI, and ilRemoteObjectBaseGUI.

Definition at line 465 of file class.ilObjectGUI.php.

        {
                $this->getTabs($this->tabs_gui);
        }

References getTabs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTargetFrame()

ilObjectGUI::setTargetFrame	(	$a_cmd,
		$a_target_frame
	)

protected

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 in ilObject2GUI.

Definition at line 1491 of file class.ilObjectGUI.php.

        {
                $this->target_frame[$a_cmd] = "target=\"".$a_target_frame."\"";
        }

◆ setTitleAndDescription()

ilObjectGUI::setTitleAndDescription ( )

protected

called by prepare output

Reimplemented in ilObjOrgUnitGUI, ilObjPortfolioGUI, ilObjRootFolderGUI, ilObjQuestionPoolGUI, ilObjWorkspaceRootFolderGUI, ilContainerGUI, ilObjLanguageExtGUI, ilObject2GUI, ilObjUserGUI, and ilObjFileAccessSettingsGUI.

Definition at line 322 of file class.ilObjectGUI.php.

        {
                if (!is_object($this->object))
                {
                        if ((int) $_REQUEST["crtptrefid"] > 0)
                        {
                                $cr_obj_id = ilObject::_lookupObjId((int) $_REQUEST["crtcb"]);
                                $this->tpl->setTitle(ilObject::_lookupTitle($cr_obj_id));
                                $this->tpl->setTitleIcon(ilObject::_getIcon($cr_obj_id));
                        }
                        return;
                }
                $this->tpl->setTitle($this->object->getPresentationTitle());
                $this->tpl->setDescription($this->object->getLongDescription());
                        
                if (strtolower($_GET["baseClass"]) == "iladministrationgui")
                {
                        // alt text would be same as heading -> empty alt text
                        $this->tpl->setTitleIcon(ilObject::_getIcon("", "big", $this->object->getType()));
                }
                else
                {
                        $this->tpl->setTitleIcon(ilObject::_getIcon("", "big", $this->object->getType()),
                                $this->lng->txt("obj_" . $this->object->getType()));
                }
 
                include_once './Services/Object/classes/class.ilObjectListGUIFactory.php';
                $lgui = ilObjectListGUIFactory::_getListGUIByType($this->object->getType());
                $lgui->initItem($this->object->getRefId(), $this->object->getId());
                $this->tpl->setAlertProperties($lgui->getAlertProperties());            
        }

References $_GET, $_REQUEST, ilObject\_getIcon(), ilObjectListGUIFactory\_getListGUIByType(), ilObject\_lookupObjId(), and ilObject\_lookupTitle().

Referenced by prepareOutput(), and ilObjTestGUI\prepareSubGuiOutput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showMountWebfolderIcon()

ilObjectGUI::showMountWebfolderIcon ( )

protected

Definition at line 447 of file class.ilObjectGUI.php.

        {
                global $tree, $tpl, $objDefinition;
 
                if ($this->object->getRefId() == "")
                {
                        return;
                }
 
                $tpl->setMountWebfolderIcon($this->object->getRefId());
        }

References $objDefinition, $tpl, and $tree.

Referenced by prepareOutput(), and ilObjTestGUI\prepareSubGuiOutput().

Here is the caller graph for this function:

◆ showPossibleSubObjects()

ilObjectGUI::showPossibleSubObjects ( )

protected

show possible subobjects (pulldown menu)

@access public

Reimplemented in ilObjCourseGUI, ilObjOrgUnitGUI, ilObjRecoveryFolderGUI, ilContainerGUI, ilObject2GUI, and ilObjUserFolderGUI.

Definition at line 1605 of file class.ilObjectGUI.php.

        {
                if ($this->sub_objects == "")
                {
                        $d = $this->objDefinition->getCreatableSubObjects($this->object->getType(), ilObjectDefinition::MODE_REPOSITORY, $this->ref_id);
                }
                else
                {
                        $d = $this->sub_objects;
                }
 
                $import = false;
 
                if (count($d) > 0)
                {
                        foreach ($d as $row)
                        {
                            $count = 0;
 
                                if ($row["max"] > 0)
                                {
                                        //how many elements are present?
                                        for ($i=0; $i<count($this->data["ctrl"]); $i++)
                                        {
                                                if ($this->data["ctrl"][$i]["type"] == $row["name"])
                                                {
                                                    $count++;
                                                }
                                        }
                                }
 
                                if ($row["max"] == "" || $count < $row["max"])
                                {
                                        $subobj[] = $row["name"];
                                }
                        }
                }
 
                if (is_array($subobj))
                {
 
                        //build form
                        $opts = ilUtil::formSelect(12,"new_type",$subobj);
                        $this->tpl->setCurrentBlock("add_object");
                        $this->tpl->setVariable("SELECT_OBJTYPE", $opts);
                        $this->tpl->setVariable("BTN_NAME", "create");
                        $this->tpl->setVariable("TXT_ADD", $this->lng->txt("add"));
                        $this->tpl->parseCurrentBlock();
                }
        }

References $d, $row, $sub_objects, ilUtil\formSelect(), and ilObjectDefinition\MODE_REPOSITORY.

Referenced by ilObjStyleSettingsGUI\showActions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateCustom()

ilObjectGUI::updateCustom ( ilPropertyFormGUI $a_form )

protected

Insert custom update form values into object.

Parameters

ilPropertyFormGUI $a_form

Reimplemented in ilObjBibliographicGUI, ilObjBlogGUI, ilObjBookingPoolGUI, ilObjDataCollectionGUI, ilObjExerciseGUI, ilObjFolderGUI, ilObjItemGroupGUI, ilObjMediaPoolGUI, ilObjPollGUI, ilObjPortfolioBaseGUI, ilObjPortfolioGUI, and ilObjPortfolioTemplateGUI.

Definition at line 1254 of file class.ilObjectGUI.php.

        {
 
        }

Referenced by updateObject().

Here is the caller graph for this function:

◆ updateObject()

ilObjectGUI::updateObject ( )

updates object entry in object_data

Reimplemented in ilObjCategoryGUI, ilObjCourseGUI, ilObjGroupGUI, ilObjRootFolderGUI, ilObjSessionGUI, ilObjSurveyQuestionPoolGUI, ilObjQuestionPoolGUI, ilObjRoleGUI, ilObjRoleTemplateGUI, ilContainerReferenceGUI, ilObjStyleSheetGUI, ilObjUserGUI, and ilRemoteObjectBaseGUI.

Definition at line 1210 of file class.ilObjectGUI.php.

        {
                global $ilTabs, $tpl;
                
                if (!$this->checkPermissionBool("write"))
                {
                        $this->ilias->raiseError($this->lng->txt("permission_denied"),$this->ilias->error_obj->MESSAGE);
                }
 
                $form = $this->initEditForm();
                if($form->checkInput() && 
                        $this->validateCustom($form))
                {
                        $this->object->setTitle($form->getInput("title"));
                        $this->object->setDescription($form->getInput("desc"));
                        $this->updateCustom($form);
                        $this->object->update();
                        
                        $this->afterUpdate();
                        return;
                }
 
                // display form again to correct errors
                $ilTabs->activateTab("settings");
                $form->setValuesByPost();
                $tpl->setContent($form->getHtml());
        }

References $tpl, afterUpdate(), checkPermissionBool(), initEditForm(), and updateCustom().

Referenced by ilObjFileBasedLMGUI\update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validateCustom()

ilObjectGUI::validateCustom ( ilPropertyFormGUI $a_form )

protected

Validate custom values (if not possible with checkInput())

Parameters

ilPropertyFormGUI $a_form

Returns: boolean

Reimplemented in ilObjPollGUI.

Definition at line 1244 of file class.ilObjectGUI.php.

        {
                return true;
        }

◆ viewObject()

ilObjectGUI::viewObject ( )

list childs of current object

@access public

Reimplemented in ilObjCourseGUI, ilObjExerciseGUI, ilObjFolderGUI, ilObjGlossaryGUI, ilObjGroupGUI, ilObjSAHSLearningModuleGUI, ilObjSystemFolderGUI, ilObjWikiGUI, ilObjRoleFolderGUI, ilObjAuthSettingsGUI, ilObjLanguageExtGUI, ilObjLanguageFolderGUI, ilObjMailGUI, ilObjObjectFolderGUI, ilObjTypeDefinitionGUI, and ilObjStyleSheetGUI.

Definition at line 1537 of file class.ilObjectGUI.php.

        {
                global$tpl;
 
                if (!$this->checkPermissionBool("visible,read"))
                {
                        $this->ilias->raiseError($this->lng->txt("permission_denied"),$this->ilias->error_obj->MESSAGE);
                }
                
                // BEGIN ChangeEvent: record read event.
                require_once('Services/Tracking/classes/class.ilChangeEvent.php');
                global $ilUser;
                ilChangeEvent::_recordReadEvent(
                        $this->object->getType(),
                        $this->object->getRefId(),
                        $this->object->getId(), $ilUser->getId());              
                // END ChangeEvent: record read event.
 
                include_once("./Services/Repository/classes/class.ilAdminSubItemsTableGUI.php");
                if (!$this->call_by_reference)
                {
                        $this->ctrl->setParameter($this, "obj_id", $this->obj_id); 
                }
                $itab = new ilAdminSubItemsTableGUI($this, "view", $_GET["ref_id"]);
                
                $tpl->setContent($itab->getHTML());
        }

References $_GET, $ilUser, $tpl, ilChangeEvent\_recordReadEvent(), and checkPermissionBool().

Referenced by ilObjUserFolderGUI\applyFilterObject(), ilObjectPluginGUI\executeCommand(), ilObjUserFolderGUI\hitsperpageObject(), ilObjUserFolderGUI\initAccessRestrictionForm(), ilObjUserFolderGUI\mailObject(), ilObjUserFolderGUI\resetFilterObject(), ilObjUserFolderGUI\usrExportCsvObject(), ilObjUserFolderGUI\usrExportX86Object(), ilObjUserFolderGUI\usrExportXmlObject(), and ilObjContentObjectGUI\view().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withReferences()

ilObjectGUI::withReferences ( )

determines wether objects are referenced or not (got ref ids or not)

Reimplemented in ilObject2GUI.

Definition at line 197 of file class.ilObjectGUI.php.

        {
                return $this->call_by_reference;
        }

Field Documentation

◆ $actions

ilObjectGUI::$actions

Definition at line 76 of file class.ilObjectGUI.php.

Referenced by ilObjCourseGUI\__showWaitingListTable(), ilObjContentObjectGUI\formatInvalidLinkArray(), ilObjLinkResourceGUI\formatInvalidLinkArray(), ilCourseArchivesGUI\selectArchiveLanguage(), and ilObjUserFolderGUI\showActions().

◆ $data

ilObjectGUI::$data

Definition at line 59 of file class.ilObjectGUI.php.

Referenced by ilCourseContentGUI\__buildPath(), ilObjPaymentSettingsGUI\__getHTMLPath(), ilContainerGUI\_buildPath(), ilObjFileBasedLMGUI\addBibItemObject(), ilObjContentObjectGUI\addBibItemObject(), ilObjTestGUI\addQuestionObject(), ilObjTestGUI\areSkillLevelThresholdsMissing(), ilObjQuestionPoolGUI\buildCreateQuestionForm(), ilObjQuestionPoolGUI\buildQuestionBrowserTableGUI(), ilObjSystemFolderGUI\changeHeaderTitleObject(), ilContainerGUI\clipboardObject(), ilObjSCORM2004LearningModuleGUI\confirmDeleteExportFile(), ilObjSurveyQuestionPoolGUI\confirmDeleteExportFileObject(), ilObjSurveyQuestionPoolGUI\deleteQuestionsObject(), ilObjObjectFolderGUI\displayList(), ilObjTypeDefinitionGUI\displayList(), ilObjStyleSettingsGUI\editContentStylesObject(), ilObjTypeDefinitionGUI\editObject(), ilObjRootFolderGUI\editTranslationsObject(), ilObjCategoryGUI\editTranslationsObject(), ilObjGroupGUI\exportMembersObject(), ilObjSurveyQuestionPoolGUI\exportObject(), ilContainerGUI\getAsynchItemListObject(), ilObjGroupGUI\getAttendanceListUserData(), ilObjSessionGUI\getAttendanceListUserData(), ilObjUserGUI\getValues(), initDidacticTemplate(), ilObjAssessmentFolderGUI\logAdminObject(), ilObjPaymentSettingsGUI\objectsObject(), ilObjTestGUI\participantsObject(), ilObjSurveyQuestionPoolGUI\questionsObject(), ilObjTestGUI\questionsObject(), ilObjRoleGUI\readRoleProperties(), ilObjTestGUI\removeQuestionsForm(), ilObjSystemFolderGUI\saveHeaderTitleObject(), ilObjDlBookGUI\showCitation(), ilObjSCORM2004LearningModuleGUI\showExportList(), ilObjSystemFolderGUI\showHeaderTitleObject(), ilObjLanguageExtGUI\statisticsObject(), ilObjFileGUI\update(), ilObjLinkResourceGUI\updateLinks(), ilCourseContentGUI\updateTimings(), ilCourseContentGUI\updateUserTimings(), ilObjFileAccessSettingsGUI\viewDiskQuotaReport(), and ilObjLanguageExtGUI\viewObject().

◆ $formaction

ilObjectGUI::$formaction

Definition at line 70 of file class.ilObjectGUI.php.

◆ $ilias

ilObjectGUI::$ilias

Definition at line 24 of file class.ilObjectGUI.php.

Referenced by ilObjBibliographicGUI\__construct(), ilObjUserGUI\__sendProfileMail(), ilObjUserFolderGUI\appliedUsersObject(), ilObjSystemFolderGUI\checkObject(), ilContainerGUI\cloneNodes(), ilObjStyleSettingsGUI\confirmedDeleteObject(), ilObjStyleSheetGUI\confirmedDeleteObject(), ilObjStyleSheetGUI\copyStyleObject(), ilObjStyleSettingsGUI\editContentStylesObject(), ilObjUserGUI\editObject(), ilObjStyleSettingsGUI\editSystemStylesObject(), ilObjSurveyQuestionPoolGUI\executeCommand(), ilObjTestGUI\executeCommand(), ilObjQuestionPoolGUI\executeCommand(), ilObjFileAccessSettingsGUI\executeCommand(), ilObjContentObjectGUI\explorer(), ilObjUserFolderGUI\exportObject(), ilExcelWriterAdapter\ilExcelWriterAdapter(), ilObjectGUI(), ilObjContentObjectGUI\linkChecker(), ilObjLinkResourceGUI\linkChecker(), ilObjSCORM2004LearningModuleGUI\preview(), ilObjTestGUI\printobject(), ilObjUserFolderGUI\saveGlobalUserSettingsObject(), ilObjContentObjectGUI\saveMenuProperties(), ilObjUserFolderGUI\settingsObject(), ilContainerGUI\setTitleAndDescription(), ilCourseContentGUI\showStartObjects(), ilObjSCORM2004LearningModuleGUI\showTree(), ilObjUserGUI\updateObject(), and ilObjUserGUI\updateObjectOld().

◆ $lng

ilObjectGUI::$lng

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

◆ $maxcount

ilObjectGUI::$maxcount

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

◆ $obj_id

ilObjectGUI::$obj_id

Definition at line 68 of file class.ilObjectGUI.php.

Referenced by ilCourseContentGUI\__forwardToColumnGUI(), ilCourseContentGUI\__loadFromPost(), ilObjContentObjectGUI\addLocations(), ilObjMediaPoolGUI\addLocatorItems(), ilObjBibliographicGUI\addNews(), ilObjLinkResourceGUI\callDirectLink(), ilObjLinkResourceGUI\callLink(), ilObjPortfolioGUI\checkPermissionBool(), ilObjBookingPoolGUI\confirmedBookingNumbersObject(), ilObjMediaPoolGUI\confirmRemove(), ilContainerGUI\copyFile(), ilObjMediaPoolGUI\copyToClipboard(), ilObject2GUI\deleteConfirmation(), ilContainerGUI\editPageContentObject(), ilContainerGUI\getAsynchItemListObject(), getCenterColumnHTML(), ilCourseContentGUI\getRightColumnHTML(), getRightColumnHTML(), ilObjContentObjectGUI\initMenuEntryForm(), ilObjLanguageFolderGUI\installLocalObject(), ilObjLanguageFolderGUI\installObject(), ilObjAssessmentFolderGUI\logAdminObject(), ilObjSCORMLearningModuleGUI\newModuleVersion(), ilObjMediaPoolGUI\remove(), ilObjUserGUI\roleassignmentObject(), ilObjBookingPoolGUI\rsvConfirmCancelObject(), ilObjPaymentSettingsGUI\saveCustomerObject(), ilObjLanguageFolderGUI\setSystemLanguageObject(), ilObjLanguageFolderGUI\setUserLanguageObject(), ilCourseContentGUI\showStartObjects(), ilObjLanguageFolderGUI\uninstallObject(), and ilCourseContentGUI\view().

◆ $objDefinition

ilObjectGUI::$objDefinition

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

Referenced by ilObject2GUI\__construct(), ilShopPurchaseGUI\__getCourseItemsHTML(), ilObjSystemFolderGUI\checkObject(), ilContainerGUI\copyObject(), ilObject2GUI\deleteConfirmation(), ilObject2GUI\deleteConfirmedObjects(), ilObject2GUI\handleAfterSaveCallback(), ilObjectGUI(), importFileObject(), ilObjSessionGUI\materialsObject(), ilObjWorkspaceFolderGUI\performPasteIntoMultipleObjects(), ilObjRoleGUI\permObject(), ilObjRoleTemplateGUI\permObject(), ilObjRoleGUI\permSaveObject(), ilObjRoleTemplateGUI\permSaveObject(), ilObject2GUI\putObjectInTree(), putObjectInTree(), ilObjFileGUI\save(), saveObject(), ilObjNotificationAdminGUI\saveObject2(), ilObjRoleGUI\showDefaultPermissionSettings(), showMountWebfolderIcon(), ilContainerReferenceGUI\showTargetSelectionTreeObject(), and ilObjStyleSheetGUI\showUpperIcon().

◆ $object

ilObjectGUI::$object

Definition at line 66 of file class.ilObjectGUI.php.

Referenced by ilObjBibliographicGUI\__construct(), ilObject2GUI\deleteConfirmedObjects(), ilContainerGUI\downloadMultipleObjects(), ilContainerGUI\downloadObject(), ilObjSessionGUI\getCurrentObject(), ilObjFileGUI\handleFileUpload(), ilContainerGUI\linkObject(), ilObjUserGUI\loadValuesFromForm(), ilObjBookingPoolGUI\processBooking(), ilObjMediaObjectGUI\saveObject(), and ilObjCloudGUI\serviceAuth().

◆ $omit_locator

ilObjectGUI::$omit_locator = false

Definition at line 78 of file class.ilObjectGUI.php.

◆ $ref_id

ilObjectGUI::$ref_id

Definition at line 67 of file class.ilObjectGUI.php.

Referenced by ilObjExternalFeedGUI\_goto(), ilObjItemGroupGUI\_goto(), ilObjMediaPoolGUI\_goto(), ilObjPollGUI\_goto(), ilObjWikiGUI\_goto(), ilObjectPluginGUI\_goto(), ilObjChatroomAdminGUI\_goto(), ilObjOrgUnitGUI\_goto(), ilObjStudyProgrammeAdminGUI\_goto(), ilObjTestGUI\applyFilterCriteria(), ilContainerGUI\clipboardObject(), ilContainerGUI\cloneAllObject(), ilContainerGUI\copyObject(), ilObjTestGUI\createQuestionPoolAndCopyObject(), ilContainerGUI\cutObject(), ilContainerGUI\downloadMultipleObjects(), ilContainerGUI\downloadObject(), ilObjQuestionPoolGUI\executeCommand(), ilContainerGUI\getAsynchItemListObject(), ilObjItemGroupGUI\gotoParent(), ilObjRoleTemplateGUI\ilObjRoleTemplateGUI(), ilObjUserGUI\ilObjUserGUI(), ilObjGroupGUI\importFileObject2(), ilContainerGUI\linkObject(), ilObjAssessmentFolderGUI\logAdminObject(), ilContainerGUI\pasteObject(), ilContainerGUI\performPasteIntoMultipleObjectsObject(), ilObjQuestionPoolGUI\questionsObject(), ilObjUserGUI\roleassignmentObject(), ilObject2GUI\setLocator(), setLocator(), ilCourseContentGUI\showStartObjects(), ilObjPaymentSettingsGUI\statisticObject(), ilCourseContentGUI\updateTimings(), and ilCourseContentGUI\updateUserTimings().

◆ $return_location

ilObjectGUI::$return_location

Definition at line 71 of file class.ilObjectGUI.php.

Referenced by ilObjGroupGUI\canceledObject(), and ilObjCourseGUI\cancelMemberObject().

◆ $sub_objects

ilObjectGUI::$sub_objects

Definition at line 77 of file class.ilObjectGUI.php.

Referenced by ilObjSystemCheckGUI\initFormTrash(), and showPossibleSubObjects().

◆ $tab_target_script

ilObjectGUI::$tab_target_script

Definition at line 75 of file class.ilObjectGUI.php.

◆ $target_frame

ilObjectGUI::$target_frame

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

◆ $tmp_import_dir

ilObjectGUI::$tmp_import_dir

protected

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

◆ $tpl

ilObjectGUI::$tpl

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

◆ $tree

ilObjectGUI::$tree

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

◆ CFORM_CLONE

const ilObjectGUI::CFORM_CLONE = 3

Definition at line 82 of file class.ilObjectGUI.php.

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

◆ CFORM_IMPORT

const ilObjectGUI::CFORM_IMPORT = 2

Definition at line 81 of file class.ilObjectGUI.php.

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

◆ CFORM_NEW

const ilObjectGUI::CFORM_NEW = 1

Definition at line 80 of file class.ilObjectGUI.php.

Referenced by ilObjectPluginGUI\getCreationFormTitle(), ilObjBibliographicGUI\initCreationForms(), ilObjSAHSLearningModuleGUI\initCreationForms(), and ilObjBibliographicGUI\save().

◆ COPY_WIZARD_NEEDS_PAGE

const ilObjectGUI::COPY_WIZARD_NEEDS_PAGE = 1

Definition at line 15 of file class.ilObjectGUI.php.

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

Services/Object/classes/class.ilObjectGUI.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Function Documentation

◆ __initTableGUI()

◆ __setTableGUIBasicData()

◆ __showButton()

◆ _gotoRepositoryNode()

◆ _gotoRepositoryRoot()

◆ addAdminLocatorItems()

◆ addDidacticTemplateOptions()

◆ addExternalEditFormCustom()

◆ addHeaderAction()

◆ addLocatorItems()

◆ afterImport()

◆ afterSave()

◆ afterUpdate()

◆ assignObject()

◆ cancelCreation()

◆ cancelDeleteObject()

◆ cancelObject()

◆ checkPermission()

◆ checkPermissionBool()

◆ cloneAllObject()

◆ confirmedDeleteObject()

◆ createObject()

◆ deleteObject()

◆ editObject()

◆ enableDragDropFileUpload()

◆ executeCommand()

◆ fillCloneTemplate()

◆ getAdminTabs()

◆ getCenterColumnHTML()

◆ getCreationFormsHTML()

◆ getCreationMode()

◆ getDidacticTemplateVar()

◆ getEditFormCustomValues()

◆ getEditFormValues()

◆ getFormAction()

◆ getHTML()

◆ getReturnLocation()

◆ getRightColumnHTML()

◆ getTabs()

◆ getTargetFrame()

◆ getTemplateFile()

◆ getTitlesByRefId()

◆ handleAutoRating()

◆ hitsperpageObject()

◆ ilObjectGUI()

◆ importFileObject()

◆ initCreateForm()

◆ initCreationForms()

◆ initDidacticTemplate()

◆ initEditCustomForm()

◆ initEditForm()

◆ initHeaderAction()

◆ initImportForm()

◆ insertHeaderAction()

◆ isVisible()

◆ omitLocator()

◆ prepareOutput()

◆ putObjectInTree()

◆ redirectToRefId()

◆ redrawHeaderActionObject()

◆ saveObject()

◆ setActions()

◆ setAdminTabs()

◆ setColumnSettings()

◆ setCreationMode()

◆ setFormAction()

◆ setLocator()

◆ setReturnLocation()

◆ setSubObjects()

◆ setTabs()

◆ setTargetFrame()

◆ setTitleAndDescription()