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

Inheritance diagram for ilObjectGUI:

Collaboration diagram for ilObjectGUI:

Public Member Functions
	__construct ($data, int $id=0, bool $call_by_reference=true, bool $prepare_output=true)

	getRefId ()

	setAdminMode (string $mode)

	getAdminMode ()

	getObject ()

	executeCommand ()

	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...

	setCreationMode (bool $mode=true)
	If true, a creation screen is displayed the current [ref_id] does belong to the parent class The mode is determined in ilRepositoryGUI. More...

	getCreationMode ()

	prepareOutput (bool $show_sub_objects=true)

	getAdminTabs ()
	administration tabs show only permissions and trash folder More...

	getHTML ()

	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...

	cancelObject ()
	cancel action and go back to previous page More...

	createObject ()
	create new object form More...

	editAvailabilityPeriodObject ()

	saveAvailabilityPeriodObject ()

	cancelCreation ()
	cancel create action and go back to repository parent More...

	saveObject ()

	getDidacticTemplateVar (string $type)
	Get didactic template setting from creation screen. More...

	putObjectInTree (ilObject $obj, int $parent_node_id=null)
	Add object to tree at given position. More...

	editObject ()

	addExternalEditFormCustom (ilPropertyFormGUI $form)

	updateObject ()
	updates object entry in object_data More...

	getFormAction (string $cmd, string $default_form_action="")
	Get form action for command (command is method name without "Object", e.g. More...

	isVisible (int $ref_id, string $type)

	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...

	deleteObject (bool $error=false)
	Display deletion confirmation screen. More...

	setColumnSettings (ilColumnGUI $column_gui)

	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html Should be overwritten and redirect to settings screen. More...

	addToDeskObject ()

	removeFromDeskObject ()

Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Static Public Member Functions
static	_gotoRepositoryRoot (bool $raise_error=false)
	Goto repository root. More...

static	_gotoRepositoryNode (int $ref_id, string $cmd="")

static	_gotoSharedWorkspaceNode (int $wsp_id)

Data Fields
const	ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION

const	ADMIN_MODE_NONE = ""

const	ADMIN_MODE_SETTINGS = "settings"

const	ADMIN_MODE_REPOSITORY = "repository"

const	UPLOAD_TYPE_LOCAL = 1

const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2

const	CFORM_NEW = 1

const	CFORM_IMPORT = 2

const	CFORM_CLONE = 3

Protected Member Functions
	getObjectService ()

	assignObject ()

	setTitleAndDescription ()

	createActionDispatcherGUI ()

	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...

	insertHeaderAction (?ilObjectListGUI $list_gui=null)
	Insert header action into main template. More...

	addHeaderAction ()
	Add header action menu. More...

	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...

	setTabs ()
	set admin tabs More...

	setAdminTabs ()
	set admin tabs More...

	setLocator ()

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

	omitLocator (bool $omit=true)

	addAdminLocatorItems (bool $do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...

	initCreationForms (string $new_type)
	Init creation forms. More...

	getCreationFormsHTML (array $forms)
	Get HTML for creation forms (accordion) More...

	initCreateForm (string $new_type)

	initDidacticTemplate (ilPropertyFormGUI $form)

	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...

	addAdoptContentLinkToToolbar ()

	addAvailabilityPeriodButtonToToolbar (ilToolbarGUI $toolbar)

	afterSave (ilObject $new_object)
	Post (successful) object creation hook. More...

	initEditForm ()

	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...

	getEditFormValues ()

	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...

	validateCustom (ilPropertyFormGUI $form)
	Validate custom values (if not possible with checkInput()) More...

	updateCustom (ilPropertyFormGUI $form)
	Insert custom update form values into object. More...

	afterUpdate ()
	Post (successful) object update hook. More...

	initImportForm (string $new_type)

	importFileObject (int $parent_id=null)

	afterImport (ilObject $new_object)
	Post (successful) object import hook. More...

	setFormAction (string $cmd, string $form_action)

	getReturnLocation (string $cmd, string $default_location="")
	Get return location for command (command is method name without "Object", e.g. More...

	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...

	getTargetFrame (string $cmd, string $default_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...

	setTargetFrame (string $cmd, string $target_frame)
	Set specific target frame for command. More...

	showPossibleSubObjects ()
	show possible sub objects (pull down menu) More...

	getTabs ()
	overwrite in derived GUI class of your object type More...

	redirectToRefId (int $ref_id, string $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 ["ref_id"] value of the request More...

	getCenterColumnHTML ()
	Get center column. More...

	getRightColumnHTML ()
	Display right column. More...

	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...

Protected Attributes
ILIAS Notes Service	$notes_service

ServerRequestInterface	$request

ilLocatorGUI	$locator

ilObjUser	$user

ilAccessHandler	$access

ilSetting	$settings

ilToolbarGUI	$toolbar

ilRbacAdmin	$rbac_admin

ilRbacSystem	$rbac_system

ilRbacReview	$rbac_review

ilObjectService	$object_service

ilObjectDefinition	$obj_definition

ilGlobalTemplateInterface	$tpl

ilTree	$tree

ilCtrl	$ctrl

ilErrorHandling	$error

ilLanguage	$lng

ilTabsGUI	$tabs_gui

ILIAS	$ilias

ArrayBasedRequestWrapper	$post_wrapper

RequestWrapper	$request_wrapper

Factory	$refinery

ilFavouritesManager	$favourites

ilObjectCustomIconFactory	$custom_icon_factory

UIFactory	$ui_factory

UIRenderer	$ui_renderer

ilObject	$object = null

bool	$creation_mode = false

	$data

int	$id

bool	$call_by_reference = false

bool	$prepare_output

int	$ref_id

int	$obj_id

int	$maxcount

array	$form_action = []

array	$return_location = []

array	$target_frame = []

string	$tmp_import_dir

string	$sub_objects = ""

bool	$omit_locator = false

string	$type = ""

string	$admin_mode = self::ADMIN_MODE_NONE

int	$requested_ref_id = 0

int	$requested_crtptrefid = 0

int	$requested_crtcb = 0

string	$requested_new_type = ""

string	$link_params

string	$html = ""

Private Member Functions
	getMultiObjectPropertiesManipulator ()

	buildRefIdsFromData (array $data)

	buildDeleletionModal (array $request_ids)

	buildDeletionModalItems (array $ref_ids)

	buildInputsForAdditionalDeletionReferences (int $ref_id, ilPathGUI $path_gui)

	checkWritePermissionOnRefIdArray (array $ref_ids)

Private Attributes
ilObjectRequestRetriever	$retriever

MultiObjectPropertiesManipulator	$multi_object_manipulator

Detailed Description

Class ilObjectGUI Basic methods of all Output classes.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilObjectGUI::__construct	(		$data,
		int	$id = `0`,
		bool	$call_by_reference = `true`,
		bool	$prepare_output = `true`
	)

Parameters

mixed	$data
int	$id
bool	$call_by_reference
bool	$prepare_output

Exceptions

ilCtrlException

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

References $call_by_reference, $data, $DIC, $id, $params, $prepare_output, $ref_id, $refinery, $requested_ref_id, ILIAS\Repository\access(), assignObject(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\locator(), ILIAS\Repository\object(), prepareOutput(), ILIAS\Repository\refinery(), ILIAS\Repository\settings(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

     {
         global $DIC;
 
         $this->request = $DIC->http()->request();
         $this->locator = $DIC["ilLocator"];
         $this->user = $DIC->user();
         $this->access = $DIC->access();
         $this->settings = $DIC->settings();
         $this->toolbar = $DIC->toolbar();
         $this->rbac_admin = $DIC->rbac()->admin();
         $this->rbac_system = $DIC->rbac()->system();
         $this->rbac_review = $DIC->rbac()->review();
         $this->object_service = $DIC->object();
         $this->obj_definition = $DIC["objDefinition"];
         $this->tpl = $DIC["tpl"];
         $this->tree = $DIC->repositoryTree();
         $this->ctrl = $DIC->ctrl();
         $this->error = $DIC["ilErr"];
         $this->lng = $DIC->language();
         $this->tabs_gui = $DIC->tabs();
         $this->ilias = $DIC["ilias"];
         $this->post_wrapper = $DIC->http()->wrapper()->post();
         $this->request_wrapper = $DIC->http()->wrapper()->query();
         $this->refinery = $DIC->refinery();
         $this->retriever = new ilObjectRequestRetriever($DIC->http()->wrapper(), $this->refinery);
         $this->favourites = new ilFavouritesManager();
         $this->custom_icon_factory = $DIC['object.customicons.factory'];
         $this->ui_factory = $DIC['ui.factory'];
         $this->ui_renderer = $DIC['ui.renderer'];
 
         $this->data = $data;
         $this->id = $id;
         $this->call_by_reference = $call_by_reference;
         $this->prepare_output = $prepare_output;
 
         $this->lng->loadLanguageModule('obj');
 
         $params = ['ref_id'];
         if (!$call_by_reference) {
             $params = ['ref_id','obj_id'];
         }
         $this->ctrl->saveParameter($this, $params);
 
         if ($this->request_wrapper->has('ref_id')) {
             $this->requested_ref_id = $this->request_wrapper->retrieve('ref_id', $this->refinery->kindlyTo()->int());
         }
 
         $this->obj_id = $this->id;
         $this->ref_id = $this->requested_ref_id;
 
         if ($call_by_reference) {
             $this->ref_id = $this->id;
             $this->obj_id = 0;
             if ($this->request_wrapper->has('obj_id')) {
                 $this->obj_id = $this->request_wrapper->retrieve('obj_id', $this->refinery->kindlyTo()->int());
             }
         }
 
         // TODO: refactor this with post_wrapper or request_wrapper
         // callback after creation
         $this->requested_crtptrefid = $this->retriever->getMaybeInt('crtptrefid', 0);
         $this->requested_crtcb = $this->retriever->getMaybeInt('crtcb', 0);
         $this->requested_new_type = $this->retriever->getMaybeString('new_type', '');
 
 
         if ($this->id != 0) {
             $this->link_params = "ref_id=" . $this->ref_id;
         }
 
         $this->assignObject();
 
         if (is_object($this->object)) {
             if ($this->call_by_reference && $this->ref_id == $this->requested_ref_id) {
                 $this->ctrl->setContextObject(
                     $this->object->getId(),
                     $this->object->getType()
                 );
             }
         }
 
         if ($prepare_output) {
             $this->prepareOutput();
         }
 
         $this->notes_service = $DIC->notes();
     }

Here is the call graph for this function:

Member Function Documentation

◆ _gotoRepositoryNode()

static ilObjectGUI::_gotoRepositoryNode	(	int	$ref_id,
		string	$cmd = `""`
	)

static

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

References $DIC, ilCtrl\redirectByClass(), and ilCtrl\setParameterByClass().

Referenced by ilObjChatroomAdminGUI\_goto(), ilObjChatroomGUI\_goto(), ilObjContentPageGUI\_goto(), ilObjLearningSequenceGUI\_goto(), ilObjCmiXapiGUI\_goto(), ilObjDataCollectionGUI\_goto(), ilRemoteObjectBaseGUI\_goto(), ilObjIndividualAssessmentGUI\_goto(), ilObjLearningSequence\_goto(), ilObjSessionGUI\_goto(), ilObjFolderGUI\_goto(), ilObjBookingPoolGUI\_goto(), ilObjFileBasedLMGUI\_goto(), ilObjLTIConsumerGUI\_goto(), ilObjWikiGUI\_goto(), ilObjFileGUI\_goto(), ilObjCategoryGUI\_goto(), ilObjGroupGUI\_goto(), ilObjMediaCastGUI\_goto(), ilObjQuestionPoolGUI\_goto(), and ilObjCourseGUI\_goto().

                                                                              : void
     {
         global $DIC;
 
         $ctrl = $DIC->ctrl();
         $ctrl->setParameterByClass("ilRepositoryGUI", "ref_id", $ref_id);
         $ctrl->redirectByClass("ilRepositoryGUI", $cmd);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _gotoRepositoryRoot()

static ilObjectGUI::_gotoRepositoryRoot ( bool $raise_error = false )

static

Goto repository root.

Parameters

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

References $DIC, $ilErr, ilCtrl\redirectByClass(), ROOT_FOLDER_ID, ilCtrl\setParameterByClass(), and ilLanguage\txt().

Referenced by ilObjCmiXapiGUI\_goto(), ilObjDataCollectionGUI\_goto(), ilObjRootFolderGUI\_goto(), ilObjItemGroupGUI\_goto(), ilLMPageObjectGUI\_goto(), ilGlossaryTermGUI\_goto(), ilObjLearningSequence\_goto(), ilObjSessionGUI\_goto(), ilObjectPluginGUI\_goto(), ilStructureObjectGUI\_goto(), ilObjBookingPoolGUI\_goto(), ilObjFileBasedLMGUI\_goto(), ilObjLTIConsumerGUI\_goto(), ilObjSAHSLearningModuleGUI\_goto(), ilObjSurveyGUI\_goto(), ilObjSurveyQuestionPoolGUI\_goto(), ilObjWikiGUI\_goto(), ilObjFileGUI\_goto(), ilObjCategoryGUI\_goto(), ilObjGlossaryGUI\_goto(), ilObjGroupGUI\_goto(), ilObjMediaPoolGUI\_goto(), ilObjMediaCastGUI\_goto(), ilObjLinkResourceGUI\_goto(), ilObjSystemFolderGUI\_goto(), ilObjQuestionPoolGUI\_goto(), ilObjContentObjectGUI\_goto(), ilObjCourseGUI\_goto(), ilObjTestGUI\_goto(), ilObjUserFolderGUI\_goto(), and ilObjBibliographicGUI\handleNonAccess().

                                                                          : void
     {
         global $DIC;
 
         $ilAccess = $DIC->access();
         $ilErr = $DIC["ilErr"];
         $lng = $DIC->language();
         $ctrl = $DIC->ctrl();
 
         if ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID)) {
             $ctrl->setParameterByClass("ilRepositoryGUI", "ref_id", ROOT_FOLDER_ID);
             $ctrl->redirectByClass("ilRepositoryGUI");
         }
 
         if ($raise_error) {
             $ilErr->raiseError($lng->txt("msg_no_perm_read"), $ilErr->FATAL);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _gotoSharedWorkspaceNode()

static ilObjectGUI::_gotoSharedWorkspaceNode ( int $wsp_id )

static

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

References $DIC, ilCtrl\redirectByClass(), and ilCtrl\setParameterByClass().

Referenced by ilObjFileGUI\_goto(), and ilFileStaticURLHandler\handle().

                                                                 : void
     {
         global $DIC;
 
         $ctrl = $DIC->ctrl();
         $ctrl->setParameterByClass(ilSharedResourceGUI::class, "wsp_id", $wsp_id);
         $ctrl->redirectByClass(ilSharedResourceGUI::class, "");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addAdminLocatorItems()

ilObjectGUI::addAdminLocatorItems ( bool $do_not_add_object = false )

protected

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

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

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\locator(), ILIAS\Repository\object(), and SYSTEM_FOLDER_ID.

Referenced by prepareOutput().

                                                                             : void
     {
         if ($this->admin_mode == self::ADMIN_MODE_SETTINGS) {
             $this->ctrl->setParameterByClass(
                 "ilobjsystemfoldergui",
                 "ref_id",
                 SYSTEM_FOLDER_ID
             );
             $this->locator->addItem(
                 $this->lng->txt("administration"),
                 $this->ctrl->getLinkTargetByClass(["iladministrationgui", "ilobjsystemfoldergui"], "")
             );
             if ($this->object && ($this->object->getRefId() != SYSTEM_FOLDER_ID && !$do_not_add_object)) {
                 $this->locator->addItem(
                     $this->object->getTitle(),
                     $this->ctrl->getLinkTarget($this, "view")
                 );
             }
         } else {
             $this->ctrl->setParameterByClass(
                 "iladministrationgui",
                 "ref_id",
                 ""
             );
             $this->ctrl->setParameterByClass(
                 "iladministrationgui",
                 "admin_mode",
                 "settings"
             );
             $this->ctrl->clearParametersByClass("iladministrationgui");
             $this->locator->addAdministrationItems();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addAdoptContentLinkToToolbar()

ilObjectGUI::addAdoptContentLinkToToolbar ( )

protected

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

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

Referenced by ilObjCourseGUI\renderObject(), and ilObjGroupGUI\viewObject().

                                                      : void
     {
         $this->toolbar->addComponent(
             $this->ui_factory->link()->standard(
                 $this->lng->txt('cntr_adopt_content'),
                 $this->ctrl->getLinkTargetByClass(
                     'ilObjectCopyGUI',
                     'adoptContent'
                 )
             )
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addAvailabilityPeriodButtonToToolbar()

ilObjectGUI::addAvailabilityPeriodButtonToToolbar ( ilToolbarGUI $toolbar )

protected

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

References $toolbar, ilToolbarGUI\addComponent(), ilToolbarGUI\addSeparator(), and getMultiObjectPropertiesManipulator().

Referenced by ilContainerGUI\showAdministrationPanel().

                                                                                   : ilToolbarGUI
     {
         $toolbar->addSeparator();
 
         $toolbar->addComponent(
             $this->getMultiObjectPropertiesManipulator()->getAvailabilityPeriodButton()
         );
         return $toolbar;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addDidacticTemplateOptions()

ilObjectGUI::addDidacticTemplateOptions ( array & $a_options )

protected

Add custom templates.

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

Referenced by initDidacticTemplate().

                                                                     : void
     {
     }

Here is the caller graph for this function:

◆ addExternalEditFormCustom()

ilObjectGUI::addExternalEditFormCustom ( ilPropertyFormGUI $form )

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

Referenced by ilObjItemGroupGUI\edit(), ilObjMediaPoolGUI\edit(), ilObjDataCollectionGUI\editObject(), editObject(), and ilObjEmployeeTalkGUI\updateObject().

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

Here is the caller graph for this function:

◆ addHeaderAction()

ilObjectGUI::addHeaderAction ( )

protected

Add header action menu.

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

References initHeaderAction(), and insertHeaderAction().

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

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)

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

Referenced by setLocator().

                                         : void
     {
     }

Here is the caller graph for this function:

◆ addToDeskObject()

ilObjectGUI::addToDeskObject ( )

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

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\user().

                                      : void
     {
         $this->favourites->add(
             $this->user->getId(),
             $this->request_wrapper->retrieve("item_ref_id", $this->refinery->kindlyTo()->int())
         );
         $this->lng->loadLanguageModule("rep");
         $this->tpl->setOnScreenMessage("success", $this->lng->txt("rep_added_to_favourites"), true);
         $this->ctrl->redirectToURL(ilLink::_getLink($this->requested_ref_id));
     }

Here is the call graph for this function:

◆ afterImport()

ilObjectGUI::afterImport ( ilObject $new_object )

protected

Post (successful) object import hook.

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

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by importFileObject(), and ilObjBibliographicGUI\removeFromDesk().

                                                         : void
     {
         $this->tpl->setOnScreenMessage("success", $this->lng->txt("object_added"), true);
         $this->ctrl->returnToParent($this);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ afterSave()

ilObjectGUI::afterSave ( ilObject $new_object )

protected

Post (successful) object creation hook.

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

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by ilObjEmployeeTalkSeriesGUI\cancelObject(), ilObjPortfolioTemplateGUI\initDidacticTemplate(), ilObjExerciseVerificationGUI\save(), ilObjSCORMVerificationGUI\save(), ilObjCmiXapiVerificationGUI\save(), ilObjLTIConsumerVerificationGUI\save(), ilObjCourseVerificationGUI\save(), ilObjTestVerificationGUI\save(), ilObjEmployeeTalkSeriesGUI\saveObject(), and saveObject().

                                                       : void
     {
         $this->tpl->setOnScreenMessage("success", $this->lng->txt("object_added"), true);
         $this->ctrl->returnToParent($this);
     }

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.

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

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by ilObjEmployeeTalkGUI\updateObject(), and updateObject().

                                     : void
     {
         $this->tpl->setOnScreenMessage("success", $this->lng->txt("msg_obj_modified"), true);
         $this->ctrl->redirect($this, "edit");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ assignObject()

ilObjectGUI::assignObject ( )

protected

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildDeleletionModal()

ilObjectGUI::buildDeleletionModal ( array $request_ids )

private

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

References ILIAS\UI\Implementation\Component\Input\$inputs, buildDeletionModalItems(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\settings().

Referenced by confirmedDeleteObject(), and deleteObject().

                                                              : \ILIAS\UI\Component\Modal\RoundTrip
     {
         [$listing_items, $inputs, $has_additional_references] = $this->buildDeletionModalItems($request_ids);
 
         $msg = $this->lng->txt('info_delete_sure');
         if (!$this->settings->get('enable_trash')) {
             $msg .= "<br/>" . $this->lng->txt('info_delete_warning_no_trash');
         }
 
         $content = [
             $this->ui_factory->messageBox()->confirmation($msg),
             $this->ui_factory->listing()->unordered($listing_items)
         ];
 
         if ($has_additional_references) {
             $content[] = $this->ui_factory->messageBox()->confirmation(
                 $this->lng->txt('multiple_reference_deletion_info') . ' '
                 . $this->lng->txt('rep_multiple_reference_deletion_instruction')
             );
         }
 
         $this->ctrl->setParameterByClass(static::class, 'id', implode(',', $request_ids));
         $target_url = $this->ctrl->getFormActionByClass(static::class, 'confirmedDelete');
         $this->ctrl->clearParameterByClass(static::class, 'id');
 
         return $this->ui_factory->modal()->roundtrip(
             $this->lng->txt('confirm'),
             $content,
             $inputs,
             $target_url
         )->withSubmitLabel($this->lng->txt('delete'));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildDeletionModalItems()

ilObjectGUI::buildDeletionModalItems ( array $ref_ids )

private

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

References Vendor\Package\$c, ilObject\_lookupObjId(), ilObject\_lookupTitle(), and buildInputsForAdditionalDeletionReferences().

Referenced by buildDeleletionModal().

                                                             : array
     {
         $path_gui = new ilPathGUI();
         $path_gui->enableTextOnly(true);
         $path_gui->enableHideLeaf(false);
         return array_reduce(
             $ref_ids,
             function (array $c, int $v) use ($path_gui): array {
                 $c[0][] = ilObject::_lookupTitle(
                     ilObject::_lookupObjId($v)
                 );
                 $c[1][] = $this->ui_factory->input()->field()->hidden()->withValue($v);
 
                 $other_references = $this->buildInputsForAdditionalDeletionReferences($v, $path_gui);
                 if ($other_references !== []) {
                     $c[1][] = $this->ui_factory->input()->field()->multiSelect(
                         ilObject::_lookupTitle(
                             ilObject::_lookupObjId($v)
                         ),
                         $other_references
                     );
                     $c[2] = true;
                 }
                 return $c;
             },
             [[], [], false]
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildInputsForAdditionalDeletionReferences()

ilObjectGUI::buildInputsForAdditionalDeletionReferences	(	int	$ref_id,
		ilPathGUI	$path_gui
	)

private

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

References Vendor\Package\$c, ilObject\_getAllReferences(), ilObject\_lookupObjId(), ILIAS\Repository\access(), ilPathGUI\getPath(), and ROOT_FOLDER_ID.

Referenced by buildDeletionModalItems().

                                                                                                  : array
     {
         return array_reduce(
             ilObject::_getAllReferences(ilObject::_lookupObjId($ref_id)),
             function (array $c, int $v) use ($ref_id, $path_gui): array {
                 if ($v !== $ref_id
                     && !$this->tree->isDeleted($v)
                     && $this->access->checkAccess('delete', '', $v)) {
                     $c[$v] = $path_gui->getPath(ROOT_FOLDER_ID, $v);
                 }
                 return $c;
             },
             []
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildRefIdsFromData()

ilObjectGUI::buildRefIdsFromData ( array $data )

private

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

References Vendor\Package\$c, and ILIAS\Repository\refinery().

Referenced by confirmedDeleteObject().

                                                      : array
     {
         return array_reduce(
             $data,
             function (array $c, array|int|null $v): array {
                 if ($v === null) {
                     return $c;
                 }
 
                 if (is_array($v)) {
                     return array_merge(
                         $c,
                         $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())->transform($v)
                     );
                 }
 
                 $c[] = $this->refinery->kindlyTo()->int()->transform($v);
                 return $c;
             },
             []
         );
     }

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 934 of file class.ilObjectGUI.php.

References ILIAS\Repository\ctrl().

Referenced by ilObjChatroomGUI\executeCommand(), and ilObjLearningSequenceGUI\executeCommand().

                                     : void
     {
         $this->ctrl->redirectByClass("ilrepositorygui", "");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cancelObject()

ilObjectGUI::cancelObject ( )

cancel action and go back to previous page

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

References ilSession\clear(), and ILIAS\Repository\ctrl().

Referenced by ilObjFileBasedLMGUI\cancel().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkPermission()

ilObjectGUI::checkPermission	(	string	$perm,
		string	$cmd = `""`,
		string	$type = `""`,
		?int	$ref_id = `null`
	)

protected

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

References $_SERVER, checkPermissionBool(), ilSession\clear(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

                                                                                                               : void
     {
         if (!$this->checkPermissionBool($perm, $cmd, $type, $ref_id)) {
             if (!is_int(strpos($_SERVER["PHP_SELF"], "goto.php"))) {
                 if ($perm != "create" && !is_object($this->object)) {
                     return;
                 }
 
                 ilSession::clear("il_rep_ref_id");
 
                 $this->tpl->setOnScreenMessage('failure', $this->lng->txt('msg_no_perm_read'), true);
                 $parent_ref_id = $this->tree->getParentNodeData($this->object->getRefId())['ref_id'] ?? null;
                 $this->ctrl->redirectToURL(ilLink::_getLink($parent_ref_id));
             }
 
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('msg_no_perm_read'), true);
             self::_gotoRepositoryRoot();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkPermissionBool()

ilObjectGUI::checkPermissionBool	(	string	$perm,
		string	$cmd = `""`,
		string	$type = `""`,
		?int	$ref_id = `null`
	)

protected

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

References $requested_ref_id, and ILIAS\Repository\access().

                                                                                                                   : bool
     {
         if ($perm == "create") {
             if (!$ref_id) {
                 $ref_id = $this->requested_ref_id;
             }
             return $this->access->checkAccess($perm . "_" . $type, $cmd, $ref_id);
         }
 
         if (!is_object($this->object)) {
             return false;
         }
 
         if (!$ref_id) {
             $ref_id = $this->object->getRefId();
         }
 
         return $this->access->checkAccess($perm, $cmd, $ref_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkWritePermissionOnRefIdArray()

ilObjectGUI::checkWritePermissionOnRefIdArray ( array $ref_ids )

private

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

References ILIAS\Repository\access().

Referenced by editAvailabilityPeriodObject(), and saveAvailabilityPeriodObject().

                                                                      : bool
     {
         foreach ($ref_ids as $ref_id) {
             if (!$this->access->checkAccess('write', '', $ref_id)) {
                 return false;
             }
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmedDeleteObject()

ilObjectGUI::confirmedDeleteObject ( )

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

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

References $data, buildDeleletionModal(), buildRefIdsFromData(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by ilObjLearningSequenceGUI\executeCommand().

                                            : void
     {
         if (!$this->request_wrapper->has('id')) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('no_checkbox'), true);
             $this->ctrl->returnToParent($this);
         }
 
         $data = $this->buildDeleletionModal(
             explode(
                 ',',
                 $this->request_wrapper->retrieve(
                     'id',
                     $this->refinery->kindlyTo()->string()
                 )
             )
         )->withRequest($this->request)->getData();
 
         if ($data === null) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('no_checkbox'), true);
             $this->ctrl->returnToParent($this);
         }
 
         $ru = new ilRepositoryTrashGUI($this);
         $ru->deleteObjects($this->requested_ref_id, $this->buildRefIdsFromData($data));
 
         $this->ctrl->redirectByClass(static::class);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createActionDispatcherGUI()

ilObjectGUI::createActionDispatcherGUI ( )

protected

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

References $ref_id, ILIAS\Repository\access(), ILIAS\Repository\object(), and ilCommonActionDispatcherGUI\TYPE_REPOSITORY.

Referenced by initHeaderAction().

                                                   : ilCommonActionDispatcherGUI
     {
         return new ilCommonActionDispatcherGUI(
             ilCommonActionDispatcherGUI::TYPE_REPOSITORY,
             $this->access,
             $this->object->getType(),
             $this->ref_id,
             $this->object->getId()
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createObject()

ilObjectGUI::createObject ( )

create new object form

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

References $requested_new_type, checkPermissionBool(), ILIAS\Repository\ctrl(), getCreationFormsHTML(), initCreationForms(), and ILIAS\Repository\lng().

Referenced by ilObjLTIConsumerGUI\applyProviderFilter(), ilContainerGUI\cloneAllObject(), ilObjGlossaryGUI\importObject(), ilObjLTIConsumerGUI\resetProviderFilter(), ilObjRoleTemplateGUI\saveObject(), ilObjSessionGUI\saveObject(), and ilObjTestGUI\uploadTst().

                                   : void
     {
         $new_type = $this->requested_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)) {
             $this->error->raiseError($this->lng->txt("permission_denied"), $this->error->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 ($this->request_wrapper->has("cpfl") && isset($forms[self::CFORM_CLONE])) {
                 $forms = [self::CFORM_CLONE => $forms[self::CFORM_CLONE]];
             }
             $this->tpl->setContent($this->getCreationFormsHTML($forms));
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteObject()

ilObjectGUI::deleteObject ( bool $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)

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

References buildDeleletionModal(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Referenced by ilObjLearningSequenceGUI\executeCommand().

                                                      : void
     {
         $request_ids = [];
         if ($this->post_wrapper->has('id')) {
             $request_ids = $this->post_wrapper->retrieve(
                 'id',
                 $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
             );
         }
 
         if (
             $this->request_wrapper->has('item_ref_id')
             && $this->request_wrapper->retrieve('item_ref_id', $this->refinery->kindlyTo()->string()) !== ""
         ) {
             $request_ids = [$this->request_wrapper->retrieve('item_ref_id', $this->refinery->kindlyTo()->int())];
         }
 
         if ($request_ids === []) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('no_checkbox'), true);
             $this->ctrl->returnToParent($this);
         }
 
         $modal = $this->buildDeleletionModal(array_unique($request_ids));
         $this->tpl->setVariable(
             'IL_OBJECT_MODALS',
             $this->ui_renderer->render(
                 $modal->withOnLoad(
                     $modal->getShowSignal()
                 )
             )
         );
         $this->renderObject();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ editAvailabilityPeriodObject()

ilObjectGUI::editAvailabilityPeriodObject ( )

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

References checkPermissionBool(), checkWritePermissionOnRefIdArray(), getMultiObjectPropertiesManipulator(), and ILIAS\Repository\lng().

                                                   : void
     {
         $item_ref_ids = $this->retriever->getSelectedIdsFromObjectList();
         if (!$this->checkPermissionBool('write')
             && !$this->checkWritePermissionOnRefIdArray($item_ref_ids)) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('msg_no_perm_write'));
             return;
         }
 
         $availability_period_modal = $this->getMultiObjectPropertiesManipulator()->getEditAvailabilityPeriodPropertiesModal(
             $item_ref_ids,
             $this
         );
         if ($availability_period_modal !== null) {
             $this->tpl->setVariable(
                 'IL_OBJECT_MODALS',
                 $this->ui_renderer->render(
                     $availability_period_modal->withOnLoad(
                         $availability_period_modal->getShowSignal()
                     )
                 )
             );
         }
         $this->renderObject();
     }

Here is the call graph for this function:

◆ editObject()

ilObjectGUI::editObject ( )

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

References addExternalEditFormCustom(), checkPermissionBool(), getEditFormValues(), initEditForm(), and ILIAS\Repository\lng().

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

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

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 1779 of file class.ilObjectGUI.php.

Referenced by prepareOutput().

                                                  : void
     {
         $this->tpl->setFileUploadRefId($this->ref_id);
     }

Here is the caller graph for this function:

◆ executeCommand()

ilObjectGUI::executeCommand ( )

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

References ILIAS\Repository\ctrl(), and prepareOutput().

Referenced by ilObjAccessibilitySettingsGUI\__construct(), ilObjExerciseGUI\__construct(), ilObjContentObjectGUI\checkCtrlPath(), ilObjQuestionPoolGUI\getQueryParamInt(), ilObjForumGUI\getSafePostCommands(), ilObjForumGUI\performThreadsActionObject(), and ilObjMediaObjectGUI\returnToContextObject().

                                     : void
     {
         $cmd = $this->ctrl->getCmd();
 
         $this->prepareOutput();
         if (!$cmd) {
             $cmd = "view";
         }
         $cmd .= "Object";
         $this->$cmd();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAdminMode()

ilObjectGUI::getAdminMode ( )

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

References $admin_mode.

Referenced by ilObjRoleGUI\addAdminLocatorItems(), ilObjRoleGUI\addLocatorItems(), ilObjRoleGUI\getTabs(), and ilObjRoleGUI\userassignmentObject().

                                   : string
     {
         return $this->admin_mode;
     }

Here is the caller graph for this function:

◆ getAdminTabs()

ilObjectGUI::getAdminTabs ( )

administration tabs show only permissions and trash folder

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

References checkPermissionBool(), and ILIAS\Repository\ctrl().

Referenced by setAdminTabs(), and ilObjBibliographicAdminGUI\view().

                                   : void
     {
         if ($this->checkPermissionBool("visible,read")) {
             $this->tabs_gui->addTarget(
                 "view",
                 $this->ctrl->getLinkTarget($this, "view"),
                 ["", "view"],
                 get_class($this)
             );
         }
 
         if ($this->checkPermissionBool("edit_permission")) {
             $this->tabs_gui->addTarget(
                 "perm_settings",
                 $this->ctrl->getLinkTargetByClass([get_class($this), 'ilpermissiongui'], "perm"),
                 "",
                 "ilpermissiongui"
             );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCenterColumnHTML()

ilObjectGUI::getCenterColumnHTML ( )

protected

Get center column.

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

References ilObject\_lookupObjId(), ilObject\_lookupType(), ILIAS\Repository\ctrl(), ilColumnGUI\getCmdSide(), ILIAS\UI\Implementation\Component\Input\ViewControl\getContent(), ilColumnGUI\getScreenMode(), ILIAS\Repository\html(), IL_COL_LEFT, IL_COL_RIGHT, IL_SCREEN_SIDE, ILIAS\Repository\object(), and setColumnSettings().

Referenced by ilObjForumGUI\showThreadsObject().

                                             : string
     {
         $obj_id = ilObject::_lookupObjId($this->object->getRefId());
         $obj_type = ilObject::_lookupType($obj_id);
 
         if ($this->ctrl->getNextClass() != "ilcolumngui") {
             // normal command processing
             return $this->getContent();
         } else {
             if (!$this->ctrl->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 = $this->ctrl->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 = $this->ctrl->forwardCommand($column_gui);
                     }
                 } else {
                     // normal command processing
                     return $this->getContent();
                 }
             }
         }
         return "";
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCreationFormsHTML()

ilObjectGUI::getCreationFormsHTML ( array $forms )

protected

Get HTML for creation forms (accordion)

Parameters

array<int,ilPropertyFormGUI> $forms

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

References ilAccordionGUI\FIRST_OPEN, and ILIAS\Repository\lng().

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

                                                          : string
     {
         // #13168- sanity check
         foreach ($forms as $id => $form) {
             if (!$form instanceof ilPropertyFormGUI) {
                 unset($forms[$id]);
             }
         }
 
         $acc = new ilAccordionGUI();
         $acc->setBehaviour(ilAccordionGUI::FIRST_OPEN);
         $cnt = 1;
         foreach ($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('');
             $cf->setTitleIcon('');
             $cf->setTableWidth("100%");
 
             $acc->addItem($htpl->get(), $cf->getHTML());
 
             $cnt++;
         }
 
         return "<div class='ilCreationFormSection'>" . $acc->getHTML() . "</div>";
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCreationMode()

ilObjectGUI::getCreationMode ( )

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

References $creation_mode.

                                      : bool
     {
         return $this->creation_mode;
     }

Here is the caller graph for this function:

◆ getDidacticTemplateVar()

ilObjectGUI::getDidacticTemplateVar ( string $type )

Get didactic template setting from creation screen.

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

References ILIAS\Repository\refinery().

Referenced by ilObjSurveyGUI\afterSave(), ilObjTestGUI\afterSave(), ilContainerGUI\afterUpdate(), ilObjItemGroupGUI\afterUpdate(), ilObjBookingPoolGUI\afterUpdate(), ilObjSessionGUI\createRecurringSessions(), ilObjLTIConsumerGUI\saveCustom(), ilObjGlossaryGUI\saveObject(), ilObjSessionGUI\saveObject(), and saveObject().

                                                         : int
     {
         if (!$this->post_wrapper->has("didactic_type")) {
             return 0;
         }
 
         $tpl = $this->post_wrapper->retrieve("didactic_type", $this->refinery->kindlyTo()->string());
         if (substr($tpl, 0, strlen($type) + 1) != $type . "_") {
             return 0;
         }
 
         return (int) substr($tpl, strlen($type) + 1);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEditFormCustomValues()

ilObjectGUI::getEditFormCustomValues ( array & $a_values )

protected

Add values to custom edit fields.

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

Referenced by ilObjEmployeeTalkGUI\addChangeDateButtonsToToolbar(), and getEditFormValues().

                                                                 : void
     {
     }

Here is the caller graph for this function:

◆ getEditFormValues()

ilObjectGUI::getEditFormValues ( )

protected

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

References getEditFormCustomValues().

Referenced by ilObjItemGroupGUI\edit(), ilObjMediaPoolGUI\edit(), ilObjEmployeeTalkGUI\editObject(), ilObjBookingPoolGUI\editObject(), ilObjDataCollectionGUI\editObject(), and editObject().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFormAction()

ilObjectGUI::getFormAction	(	string	$cmd,
		string	$default_form_action = `""`
	)

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

"perm").

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

Referenced by ilObjCourseGUI\redirectLocToTestConfirmation().

                                                                                 : string
     {
         if ($this->form_action[$cmd] != "") {
             return $this->form_action[$cmd];
         }
 
         return $default_form_action;
     }

Here is the caller graph for this function:

◆ getHTML()

ilObjectGUI::getHTML ( )

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

References $html.

                              : string
     {
         return $this->html;
     }

◆ getMultiObjectPropertiesManipulator()

ilObjectGUI::getMultiObjectPropertiesManipulator ( )

private

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

References $multi_object_manipulator.

Referenced by addAvailabilityPeriodButtonToToolbar(), editAvailabilityPeriodObject(), and saveAvailabilityPeriodObject().

                                                           : MultiObjectPropertiesManipulator
     {
         if (!isset($this->multi_object_manipulator)) {
             $this->multi_object_manipulator = ilObjectDIC::dic()['multi_object_properties_manipulator'];
         }
         return $this->multi_object_manipulator;
     }

Here is the caller graph for this function:

◆ getObject()

ilObjectGUI::getObject ( )

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

References $object.

                                : ?ilObject
     {
         return $this->object;
     }

Here is the caller graph for this function:

◆ getObjectService()

ilObjectGUI::getObjectService ( )

protected

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

References $object_service.

Referenced by ilObjBlogGUI\initEditCustomForm(), ilObjBookingPoolGUI\initEditCustomForm(), ilObjFolderGUI\initEditForm(), ilObjRootFolderGUI\initEditForm(), ilObjCategoryGUI\initEditForm(), ilObjCourseGUI\initEditForm(), ilObjGroupGUI\initForm(), ilObjSCORM2004LearningModuleGUI\initPropertiesForm(), ilObjFileBasedLMGUI\initSettingsForm(), ilObjGlossaryGUI\initSettingsForm(), ilObjExerciseGUI\listAssignmentsObject(), ilObjFileBasedLMGUI\saveProperties(), ilObjSCORM2004LearningModuleGUI\saveProperties(), ilObjGlossaryGUI\saveProperties(), ilObjFolderGUI\updateCustom(), ilObjBookingPoolGUI\updateCustom(), ilObjBlogGUI\updateCustom(), ilObjExerciseGUI\updateCustom(), ilObjRootFolderGUI\updateObject(), ilObjGroupGUI\updateObject(), ilObjCourseGUI\updateObject(), and ilObjCategoryGUI\updateObject().

                                          : ilObjectService
     {
         return $this->object_service;
     }

Here is the caller graph for this function:

◆ getRefId()

ilObjectGUI::getRefId ( )

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

References $ref_id.

Referenced by ilBookingScheduleGUI\__construct(), ilCmiXapiLrsTypesTableGUI\__construct(), ilBookingParticipantGUI\__construct(), ilDclTableListGUI\__construct(), ilObjDataCollectionGUI\__construct(), ilObjDataCollectionGUI\executeCommand(), ilObjTestGUI\getTabs(), ilObjLearningSequenceGUI\learningProgress(), ilObjAssessmentFolderGUI\logAdminObject(), ilCourseContentGUI\managePersonalTimings(), ilCourseContentGUI\manageTimings(), ilObjSessionGUI\registerObject(), ilObjSessionGUI\showJoinRequestButton(), and ilObjSessionGUI\unregisterObject().

                               : int
     {
         return $this->ref_id;
     }

Here is the caller graph for this function:

◆ getReturnLocation()

ilObjectGUI::getReturnLocation	(	string	$cmd,
		string	$default_location = `""`
	)

protected

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

"perm")

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

Referenced by ilObjOrgUnitGUI\afterSave(), ilObjStudyProgrammeGUI\afterSave(), ilObjLearningSequenceGUI\afterSave(), ilObjCourseGUI\afterSave(), ilObjTestGUI\backToRepositoryObject(), and ilObjAuthSettingsGUI\setAuthModeObject().

                                                                                     : string
     {
         if (($this->return_location[$cmd] ?? "") !== "") {
             return $this->return_location[$cmd];
         } else {
             return $default_location;
         }
     }

Here is the caller graph for this function:

◆ getRightColumnHTML()

ilObjectGUI::getRightColumnHTML ( )

protected

Display right column.

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

References $html, ilObject\_lookupObjId(), ilObject\_lookupType(), ILIAS\Repository\ctrl(), IL_COL_RIGHT, IL_SCREEN_FULL, IL_SCREEN_SIDE, ILIAS\Repository\object(), and setColumnSettings().

Referenced by ilObjForumGUI\setSideBlocks().

                                            : string
     {
         $obj_id = ilObject::_lookupObjId($this->object->getRefId());
         $obj_type = ilObject::_lookupType($obj_id);
 
         $column_gui = new ilColumnGUI($obj_type, IL_COL_RIGHT);
 
         if ($column_gui->getScreenMode() == IL_SCREEN_FULL) {
             return "";
         }
 
         $this->setColumnSettings($column_gui);
 
         $html = "";
         if (
             $this->ctrl->getNextClass() == "ilcolumngui" &&
             $column_gui->getCmdSide() == IL_COL_RIGHT &&
             $column_gui->getScreenMode() == IL_SCREEN_SIDE
         ) {
             return $this->ctrl->forwardCommand($column_gui);
         }
 
         if (!$this->ctrl->isAsynch()) {
             return $this->ctrl->getHTML($column_gui);
         }
 
         return $html;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTabs()

ilObjectGUI::getTabs ( )

protected

overwrite in derived GUI class of your object type

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

Referenced by ilObjExerciseGUI\addContentSubTabs(), and setTabs().

                                 : void
     {
     }

Here is the caller graph for this function:

◆ getTargetFrame()

ilObjectGUI::getTargetFrame	(	string	$cmd,
		string	$default_target_frame = `""`
	)

protected

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

"perm")

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

                                                                                      : string
     {
         if (isset($this->target_frame[$cmd]) && $this->target_frame[$cmd] != "") {
             return $this->target_frame[$cmd];
         }
 
         if (!empty($default_target_frame)) {
             return "target=\"" . $default_target_frame . "\"";
         }
 
         return "";
     }

◆ importFileObject()

ilObjectGUI::importFileObject ( int $parent_id = null )

protected

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

References Vendor\Package\$e, $requested_new_type, $requested_ref_id, ilObject\_getAllReferences(), afterImport(), ILIAS\Object\ImplementsCreationCallback\callCreationCallback(), checkPermissionBool(), ILIAS\Repository\ctrl(), ilObjectFactory\getInstanceByObjId(), initImportForm(), ILIAS\Repository\lng(), putObjectInTree(), ILIAS\Repository\refinery(), ilImportDirectoryFactory\TYPE_EXPORT, and ILIAS\Repository\user().

Referenced by ilObjOrgUnitGUI\executeCommand(), and ilObjLearningSequenceGUI\executeCommand().

                                                               : void
     {
         if (!$parent_id) {
             $parent_id = $this->requested_ref_id;
         }
         $new_type = $this->requested_new_type;
         $upload_type = self::UPLOAD_TYPE_LOCAL;
         if ($this->post_wrapper->has("upload_type")) {
             $upload_type = $this->post_wrapper->retrieve("upload_type", $this->refinery->kindlyTo()->int());
         }
 
         // create permission is already checked in createObject. This check here is done to prevent hacking attempts
         if (!$this->checkPermissionBool("create", "", $new_type)) {
             $this->error->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 ($this->obj_definition->isContainer($new_type)) {
                 $imp = new ilImportContainer((int) $parent_id);
             } else {
                 $imp = new ilImport((int) $parent_id);
             }
 
             try {
                 if ($upload_type == self::UPLOAD_TYPE_LOCAL) {
                     $new_id = $imp->importObject(
                         null,
                         $_FILES["importfile"]["tmp_name"],
                         $_FILES["importfile"]["name"],
                         $new_type
                     );
                 } else {
                     $hash = $this->request->getParsedBody()['uploadFile'] ?? '';
                     $upload_factory = new ilImportDirectoryFactory();
                     $export_upload = $upload_factory->getInstanceForComponent(ilImportDirectoryFactory::TYPE_EXPORT);
                     $file = $export_upload->getAbsolutePathForHash($this->user->getId(), $new_type, $hash);
 
                     $new_id = $imp->importObject(
                         null,
                         $file,
                         basename($file),
                         $new_type,
                         '',
                         true
                     );
                 }
             } catch (ilException $e) {
                 $this->tmp_import_dir = $imp->getTemporaryImportDir();
                 $this->lng->loadLanguageModule('obj');
 
                 $this->tpl->setOnScreenMessage(
                     "failure",
                     $this->lng->txt("obj_import_file_error") . " <br />" . $e->getMessage()
                 );
                 $form->setValuesByPost();
                 $this->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 (!$this->obj_definition->isContainer($new_type)) {
                     $this->putObjectInTree($newObj);
                 } else {
                     $ref_ids = ilObject::_getAllReferences($newObj->getId());
                     if (count($ref_ids) === 1) {
                         $newObj->setRefId((int) current($ref_ids));
                     }
                     $this->callCreationCallback($newObj, $this->obj_definition, $this->requested_crtcb);   // see #24244
                 }
 
                 $this->afterImport($newObj);
             } else {
                 if ($this->obj_definition->isContainer($new_type)) {
                     $this->tpl->setOnScreenMessage("failure", $this->lng->txt("container_import_zip_file_invalid"));
                 } else {
                     // not enough information here...
                     return;
                 }
             }
         }
 
         $form->setValuesByPost();
         $this->tpl->setContent($form->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initCreateForm()

ilObjectGUI::initCreateForm ( string $new_type )

protected

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

References ILIAS\Repository\ctrl(), initDidacticTemplate(), ILIAS\Repository\lng(), ilObject\LONG_DESC_LENGTH, ilTextAreaInputGUI\setCols(), and ilObject\TITLE_LENGTH.

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

                                                        : ilPropertyFormGUI
     {
         $form = new ilPropertyFormGUI();
         $form->setTarget("_top");
         $form->setFormAction($this->ctrl->getFormAction($this, "save"));
         $form->setTitle($this->lng->txt($new_type . "_new"));
 
         $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);
 
         $ta = new ilTextAreaInputGUI($this->lng->txt("description"), "desc");
         $ta->setCols(40);
         $ta->setRows(2);
         $ta->setMaxNumOfChars(ilObject::LONG_DESC_LENGTH);
         $form->addItem($ta);
 
         $form = $this->initDidacticTemplate($form);
 
         $form->addCommandButton("save", $this->lng->txt($new_type . "_add"));
         $form->addCommandButton("cancel", $this->lng->txt("cancel"));
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initCreationForms()

ilObjectGUI::initCreationForms ( string $new_type )

protected

Init creation forms.

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

Returns: array<int, ilPropertyFormGUI>

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

References initCreateForm(), and initImportForm().

Referenced by createObject().

                                                           : array
     {
         $forms = [
             self::CFORM_NEW => $this->initCreateForm($new_type),
             self::CFORM_IMPORT => $this->initImportForm($new_type)
         ];
 
         return $forms;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initDidacticTemplate()

ilObjectGUI::initDidacticTemplate ( ilPropertyFormGUI $form )

protected

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

References $data, addDidacticTemplateOptions(), ilPropertyFormGUI\addItem(), getCreationMode(), ilDidacticTemplateSettings\getInstanceByObjectType(), ILIAS\Repository\lng(), ilDidacticTemplateObjSettings\lookupTemplateId(), and ILIAS\Repository\object().

Referenced by ilObjCmiXapiGUI\initCreateForm(), ilObjEmployeeTalkSeriesGUI\initCreateForm(), ilObjGlossaryGUI\initCreateForm(), initCreateForm(), ilObjItemGroupGUI\initEditCustomForm(), ilObjBookingPoolGUI\initEditCustomForm(), ilObjFolderGUI\initEditForm(), ilObjCategoryGUI\initEditForm(), ilObjCourseGUI\initEditForm(), ilObjSessionGUI\initForm(), and ilObjGroupGUI\initForm().

                                                                     : ilPropertyFormGUI
     {
         $this->lng->loadLanguageModule('didactic');
         $existing_exclusive = false;
         $options = [];
         $options['dtpl_0'] = [
             $this->lng->txt('didactic_default_type'),
             sprintf(
                 $this->lng->txt('didactic_default_type_info'),
                 $this->lng->txt('objs_' . $this->type)
             )
         ];
 
         $templates = ilDidacticTemplateSettings::getInstanceByObjectType($this->type)->getTemplates();
         if ($templates) {
             foreach ($templates as $template) {
                 if ($template->isEffective((int) $this->requested_ref_id)) {
                     $options["dtpl_" . $template->getId()] = [
                         $template->getPresentationTitle(),
                         $template->getPresentationDescription()
                     ];
 
                     if ($template->isExclusive()) {
                         $existing_exclusive = true;
                     }
                 }
             }
         }
 
         $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()) {
                 $value = 'dtpl_' . ilDidacticTemplateObjSettings::lookupTemplateId($this->object->getRefId());
 
                 $type->setValue($value);
 
                 if (!in_array($value, array_keys($options)) || ($existing_exclusive && $value == "dtpl_0")) {
                     //add or rename actual value to not available
                     $options[$value] = [$this->lng->txt('not_available')];
                 }
             } else {
                 if ($existing_exclusive) {
                     //if an exclusive template exists use the second template as default value
                     $keys = array_keys($options);
                     $type->setValue($keys[1]);
                 } else {
                     $type->setValue('dtpl_0');
                 }
             }
             $form->addItem($type);
 
             foreach ($options as $id => $data) {
                 $option = new ilRadioOption($data[0] ?? '', (string) $id, $data[1] ?? '');
                 if ($existing_exclusive && $id == 'dtpl_0') {
                     //set default disabled if an exclusive template exists
                     $option->setDisabled(true);
                 }
 
                 $type->addOption($option);
             }
         }
 
         return $form;
     }

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.

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

Referenced by initEditForm(), ilContainerGUI\initEditForm(), ilObjExerciseGUI\listAssignmentsObject(), and ilObjEmployeeTalkGUI\sendUpdateNotification().

                                                                     : void
     {
     }

Here is the caller graph for this function:

◆ initEditForm()

ilObjectGUI::initEditForm ( )

protected

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

References $lng, ILIAS\Repository\ctrl(), initEditCustomForm(), ILIAS\Repository\lng(), ilLanguage\loadLanguageModule(), ilObject\LONG_DESC_LENGTH, ILIAS\Repository\object(), ilTextAreaInputGUI\setCols(), and ilObject\TITLE_LENGTH.

Referenced by ilObjItemGroupGUI\edit(), ilObjMediaPoolGUI\edit(), ilObjEmployeeTalkGUI\editObject(), ilObjBookingPoolGUI\editObject(), editObject(), ilObjIndividualAssessmentGUI\getBaseEditForm(), ilObjEmployeeTalkGUI\sendUpdateNotification(), ilObjEmployeeTalkGUI\updateObject(), and updateObject().

                                      : ilPropertyFormGUI
     {
         $lng = $this->lng;
 
         $lng->loadLanguageModule($this->object->getType());
 
         $form = new ilPropertyFormGUI();
         $form->setFormAction($this->ctrl->getFormAction($this, "update"));
         $form->setTitle($this->lng->txt($this->object->getType() . "_edit"));
 
         $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);
 
         $ta = new ilTextAreaInputGUI($this->lng->txt("description"), "desc");
         $ta->setCols(40);
         $ta->setRows(2);
         $ta->setMaxNumOfChars(ilObject::LONG_DESC_LENGTH);
         $form->addItem($ta);
 
         $this->initEditCustomForm($form);
 
         $form->addCommandButton("update", $this->lng->txt("save"));
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initHeaderAction()

ilObjectGUI::initHeaderAction	(	?string	$sub_type = `null`,
		?int	$sub_id = `null`
	)

protected

Add header action menu.

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

References ILIAS\Repository\access(), createActionDispatcherGUI(), ILIAS\Repository\ctrl(), ILIAS\Repository\object(), and ilObjectListGUI\prepareJsLinks().

Referenced by addHeaderAction(), and redrawHeaderActionObject().

                                                                                       : ?ilObjectListGUI
     {
         if (!$this->creation_mode && $this->object) {
             $dispatcher = $this->createActionDispatcherGUI();
 
             $dispatcher->setSubObject($sub_type, $sub_id);
 
             ilObjectListGUI::prepareJsLinks(
                 $this->ctrl->getLinkTarget($this, "redrawHeaderAction", "", true),
                 "",
                 $this->ctrl->getLinkTargetByClass(["ilcommonactiondispatchergui", "iltagginggui"], "", "", true)
             );
 
             $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
                 if (
                     $this->access->checkAccess("write", "", $this->ref_id) ||
                     $this->access->checkAccess("edit_permissions", "", $this->ref_id) ||
                     $this->notes_service->domain()->commentsActive($this->object->getId())
                 ) {
                     $lg->enableComments(true);
                 }
 
                 $lg->enableNotes(true);
                 $lg->enableTags(true);
             }
 
             return $lg;
         }
         return null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initImportForm()

ilObjectGUI::initImportForm ( string $new_type )

protected

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

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilFileInputGUI\setSuffixes(), ilRadioGroupInputGUI\setValue(), ilImportDirectoryFactory\TYPE_EXPORT, and ILIAS\Repository\user().

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

                                                        : ilPropertyFormGUI
     {
         $import_directory_factory = new ilImportDirectoryFactory();
         $export_directory = $import_directory_factory->getInstanceForComponent(ilImportDirectoryFactory::TYPE_EXPORT);
         $upload_files = $export_directory->getFilesFor($this->user->getId(), $new_type);
         $has_upload_files = false;
         if (count($upload_files)) {
             $has_upload_files = true;
         }
 
         $form = new ilPropertyFormGUI();
         $form->setTarget("_top");
         $form->setFormAction($this->ctrl->getFormAction($this, "importFile"));
         $form->setTitle($this->lng->txt($new_type . "_import"));
 
         $fi = new ilFileInputGUI($this->lng->txt("import_file"), "importfile");
         $fi->setSuffixes(["zip"]);
         $fi->setRequired(true);
         if ($has_upload_files) {
             $this->lng->loadLanguageModule('content');
             $option = new ilRadioGroupInputGUI(
                 $this->lng->txt('cont_choose_file_source'),
                 'upload_type'
             );
             $option->setValue((string) self::UPLOAD_TYPE_LOCAL);
             $form->addItem($option);
 
             $direct = new ilRadioOption($this->lng->txt('cont_choose_local'), (string) self::UPLOAD_TYPE_LOCAL);
             $option->addOption($direct);
 
             $direct->addSubItem($fi);
             $upload = new ilRadioOption(
                 $this->lng->txt('cont_choose_upload_dir'),
                 (string) self::UPLOAD_TYPE_UPLOAD_DIRECTORY
             );
             $option->addOption($upload);
             $files = new ilSelectInputGUI(
                 $this->lng->txt('cont_choose_upload_dir'),
                 'uploadFile'
             );
             $upload_files[''] = $this->lng->txt('cont_select_from_upload_dir');
             $files->setOptions($upload_files);
             $files->setRequired(true);
             $upload->addSubItem($files);
         }
 
         if (!$has_upload_files) {
             $form->addItem($fi);
         }
 
         $form->addCommandButton("importFile", $this->lng->txt("import"));
         $form->addCommandButton("cancel", $this->lng->txt("cancel"));
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insertHeaderAction()

ilObjectGUI::insertHeaderAction ( ?ilObjectListGUI $list_gui = null )

protected

Insert header action into main template.

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

References ilContainer\_lookupContainerSetting(), and ILIAS\Repository\object().

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

                                                                             : void
     {
         if (
             !is_object($this->object) ||
             ilContainer::_lookupContainerSetting($this->object->getId(), "hide_top_actions")
         ) {
             return;
         }
 
         if (is_object($list_gui)) {
             $this->tpl->setHeaderActionMenu($list_gui->getHeaderAction());
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isVisible()

ilObjectGUI::isVisible	(	int	$ref_id,
		string	$type
	)

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

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

                                                         : bool
     {
         $visible = $this->checkPermissionBool("visible,read", "", "", $ref_id);
 
         if ($visible && $type == 'crs') {
             $tree = $this->tree;
             if ($crs_id = $tree->checkForParentType($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;
                     }
                 }
             }
         }
 
         return $visible;
     }

Here is the call graph for this function:

◆ omitLocator()

ilObjectGUI::omitLocator ( bool $omit = true )

protected

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

Referenced by ilObjEmployeeTalkSeriesGUI\__construct(), and ilObjEmployeeTalkGUI\__construct().

                                                      : void
     {
         $this->omit_locator = $omit;
     }

Here is the caller graph for this function:

◆ prepareOutput()

ilObjectGUI::prepareOutput ( bool $show_sub_objects = true )

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

References ilObject\_lookupType(), addAdminLocatorItems(), ILIAS\Repository\ctrl(), enableDragDropFileUpload(), getCreationMode(), ILIAS\Repository\refinery(), setAdminTabs(), setLocator(), setTabs(), and setTitleAndDescription().

                                                                 : bool
     {
         $this->tpl->loadStandardTemplate();
         $base_class = $this->request_wrapper->retrieve("baseClass", $this->refinery->kindlyTo()->string());
         if (strtolower($base_class) == "iladministrationgui") {
             $this->addAdminLocatorItems();
             $this->tpl->setLocator();
 
             $this->setTitleAndDescription();
 
             if ($this->getCreationMode() != true) {
                 $this->setAdminTabs();
             }
 
             return false;
         }
         $this->setLocator();
 
         // 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($this->requested_ref_id, true);
                 $class_name = $this->obj_definition->getClassName($obj_type);
                 $class = strtolower("ilObj" . $class_name . "GUI");
                 $class_path = $this->ctrl->lookupClassPath($class);
                 $class_name = $this->ctrl->getClassForClasspath($class_path);
             }
         } else {
             $this->setTitleAndDescription();
 
             // set tabs
             $this->setTabs();
 
             $file_upload_dropzone = new ilObjFileUploadDropzone($this->ref_id);
             if ($file_upload_dropzone->isUploadAllowed($this->object->getType())) {
                 $this->enableDragDropFileUpload();
             }
         }
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ putObjectInTree()

ilObjectGUI::putObjectInTree	(	ilObject	$obj,
		int	$parent_node_id = `null`
	)

Add object to tree at given position.

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

References $requested_crtptrefid, $requested_ref_id, ilChangeEvent\_recordWriteEvent(), ilRbacLog\add(), ILIAS\Object\ImplementsCreationCallback\callCreationCallback(), ilRbacLog\CREATE_OBJECT, ilObject\createReference(), ilRbacLog\gatherFaPa(), ilObject\getId(), ilObject\getRefId(), ilObject\putInTree(), ilObject\setPermissions(), and ILIAS\Repository\user().

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

                                                                               : void
     {
         if (!$parent_node_id) {
             $parent_node_id = $this->requested_ref_id;
         }
 
         // add new object to custom parent container
         if ($this->requested_crtptrefid > 0) {
             $parent_node_id = $this->requested_crtptrefid;
         }
 
         $obj->createReference();
         $obj->putInTree($parent_node_id);
         $obj->setPermissions($parent_node_id);
 
         $this->obj_id = $obj->getId();
         $this->ref_id = $obj->getRefId();
 
         // BEGIN ChangeEvent: Record save object.
         ilChangeEvent::_recordWriteEvent($this->obj_id, $this->user->getId(), 'create');
         // END ChangeEvent: Record save object.
 
         // rbac log
         $rbac_log_roles = $this->rbac_review->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
         $this->callCreationCallback($obj, $this->obj_definition, $this->requested_crtcb);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ redirectAfterCreation()

ilObjectGUI::redirectAfterCreation ( )

Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html Should be overwritten and redirect to settings screen.

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

References ILIAS\Repository\ctrl(), and ILIAS\Repository\object().

                                            : void
     {
         $link = ilLink::_getLink($this->object->getRefId());
         $this->ctrl->redirectToURL($link);
     }

Here is the call graph for this function:

◆ redirectToRefId()

ilObjectGUI::redirectToRefId	(	int	$ref_id,
		string	$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 ["ref_id"] value of the request

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

References ilObject\_lookupType(), and ILIAS\Repository\ctrl().

Referenced by ilObjFolderGUI\afterSave(), ilObjCategoryGUI\afterSave(), ilObjCloudGUI\executeCommand(), and ilObjSessionGUI\unregisterObject().

                                                                      : void
     {
         $obj_type = ilObject::_lookupType($ref_id, true);
         $class_name = $this->obj_definition->getClassName($obj_type);
         $class = strtolower("ilObj" . $class_name . "GUI");
         $this->ctrl->setParameterByClass("ilrepositorygui", "ref_id", $ref_id);
         $this->ctrl->redirectByClass(["ilrepositorygui", $class], $cmd);
     }

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 470 of file class.ilObjectGUI.php.

References exit, and initHeaderAction().

Referenced by ilObjLearningSequenceGUI\executeCommand(), and ilObjFileBasedLMGUI\redrawHeaderAction().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeFromDeskObject()

ilObjectGUI::removeFromDeskObject ( )

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

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\user().

                                           : void
     {
         $this->lng->loadLanguageModule("rep");
         $item_ref_id = $this->request_wrapper->retrieve("item_ref_id", $this->refinery->kindlyTo()->int());
         $this->favourites->remove($this->user->getId(), $item_ref_id);
         $this->tpl->setOnScreenMessage("success", $this->lng->txt("rep_removed_from_favourites"), true);
         $this->ctrl->redirectToURL(ilLink::_getLink($this->requested_ref_id));
     }

Here is the call graph for this function:

◆ saveAvailabilityPeriodObject()

ilObjectGUI::saveAvailabilityPeriodObject ( )

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

References checkPermissionBool(), checkWritePermissionOnRefIdArray(), getMultiObjectPropertiesManipulator(), and ILIAS\Repository\lng().

                                                   : void
     {
         $availability_period_modal = $this->getMultiObjectPropertiesManipulator()->saveEditAvailabilityPeriodPropertiesModal(
             $this,
             fn($ref_ids): bool => $this->checkPermissionBool('write') || $this->checkWritePermissionOnRefIdArray($ref_ids),
             $this->request
         );
         if ($availability_period_modal === true) {
             $this->tpl->setOnScreenMessage('success', $this->lng->txt('availability_period_changed'));
         } elseif ($availability_period_modal === false) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('msg_no_perm_write'));
         } else {
             $this->tpl->setVariable(
                 'IL_OBJECT_MODALS',
                 $this->ui_renderer->render(
                     $availability_period_modal->withOnLoad(
                         $availability_period_modal->getShowSignal()
                     )
                 )
             );
         }
         $this->renderObject();
     }

Here is the call graph for this function:

◆ saveObject()

ilObjectGUI::saveObject ( )

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

References afterSave(), checkPermissionBool(), ILIAS\Repository\ctrl(), getDidacticTemplateVar(), initCreateForm(), ILIAS\Repository\lng(), and putObjectInTree().

Referenced by ilObjSessionGUI\saveAndAssignMaterialsObject().

                                 : void
     {
         // create permission is already checked in createObject. This check here is done to prevent hacking attempts
         if (!$this->checkPermissionBool("create", "", $this->requested_new_type)) {
             $this->error->raiseError($this->lng->txt("no_create_permission"), $this->error->MESSAGE);
         }
 
         $this->lng->loadLanguageModule($this->requested_new_type);
         $this->ctrl->setParameter($this, "new_type", $this->requested_new_type);
 
         $form = $this->initCreateForm($this->requested_new_type);
         if ($form->checkInput()) {
             $this->ctrl->setParameter($this, "new_type", "");
 
             $class_name = "ilObj" . $this->obj_definition->getClassName($this->requested_new_type);
             $newObj = new $class_name();
             $newObj->setType($this->requested_new_type);
             $newObj->setTitle($form->getInput("title"));
             $newObj->setDescription($form->getInput("desc"));
             $newObj->processAutoRating();
             $newObj->create();
 
             $this->putObjectInTree($newObj);
 
             $dtpl = $this->getDidacticTemplateVar("dtpl");
             if ($dtpl) {
                 $newObj->applyDidacticTemplate($dtpl);
             }
 
             $this->afterSave($newObj);
         }
 
         $form->setValuesByPost();
         $this->tpl->setContent($form->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAdminMode()

ilObjectGUI::setAdminMode ( string $mode )

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

                                               : void
     {
         if (!in_array($mode, [
             self::ADMIN_MODE_NONE,
             self::ADMIN_MODE_REPOSITORY,
             self::ADMIN_MODE_SETTINGS
         ])) {
             throw new ilObjectException("Unknown Admin Mode $mode.");
         }
         $this->admin_mode = $mode;
     }

◆ setAdminTabs()

ilObjectGUI::setAdminTabs ( )

finalprotected

set admin tabs

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

References getAdminTabs().

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

                                            : void
     {
         $this->getAdminTabs();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setColumnSettings()

ilObjectGUI::setColumnSettings ( ilColumnGUI $column_gui )

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

References checkPermissionBool(), ilColumnGUI\setEnableEdit(), and ilColumnGUI\setRepositoryMode().

Referenced by getCenterColumnHTML(), and getRightColumnHTML().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCreationMode()

ilObjectGUI::setCreationMode ( bool $mode = true )

If true, a creation screen is displayed the current [ref_id] does belong to the parent class The mode is determined in ilRepositoryGUI.

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

Referenced by ilObjTalkTemplateGUI\executeCommand(), ilContainerReferenceGUI\executeCommand(), ilObjCategoryGUI\executeCommand(), and ilObjStyleSheetGUI\executeCommand().

                                                       : void
     {
         $this->creation_mode = $mode;
     }

Here is the caller graph for this function:

◆ setFormAction()

ilObjectGUI::setFormAction	(	string	$cmd,
		string	$form_action
	)

protected

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

References $form_action.

                                                                       : void
     {
         $this->form_action[$cmd] = $form_action;
     }

◆ setLocator()

ilObjectGUI::setLocator ( )

protected

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

References $locator, $requested_ref_id, $tpl, addLocatorItems(), and ilGlobalTemplateInterface\setLocator().

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

                                    : void
     {
         $ilLocator = $this->locator;
         $tpl = $this->tpl;
 
         if ($this->omit_locator) {
             return;
         }
 
         // repository vs. workspace
         if ($this->call_by_reference) {
             // todo: admin workaround
             // in the future, object gui classes should not be called in
             // admin section anymore (rbac/trash handling in own classes)
             $ref_id = $this->requested_ref_id;
             if ($this->requested_ref_id === 0) {
                 $ref_id = $this->object->getRefId();
             }
             $ilLocator->addRepositoryItems($ref_id);
         }
 
         if (!$this->creation_mode) {
             $this->addLocatorItems();
         }
 
         $tpl->setLocator();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setReturnLocation()

ilObjectGUI::setReturnLocation	(	string	$cmd,
		string	$location
	)

protected

set specific return location for command

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

References $location.

                                                                        : void
     {
         $this->return_location[$cmd] = $location;
     }

◆ setTabs()

ilObjectGUI::setTabs ( )

protected

set admin tabs

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

References getTabs().

                                 : void
     {
         $this->getTabs();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTargetFrame()

ilObjectGUI::setTargetFrame	(	string	$cmd,
		string	$target_frame
	)

protected

Set specific target frame for command.

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

                                                                         : void
     {
         $this->target_frame[$cmd] = "target=\"" . $target_frame . "\"";
     }

◆ setTitleAndDescription()

ilObjectGUI::setTitleAndDescription ( )

protected

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

References ilObject\_getIcon(), ilObjectListGUIFactory\_getListGUIByType(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ILIAS\Repository\refinery().

Referenced by ilObjContentObjectGUI\checkCtrlPath(), prepareOutput(), and ilObjFileBasedLMGUI\setTabs().

                                                : void
     {
         if (!is_object($this->object)) {
             if ($this->requested_crtptrefid > 0) {
                 $cr_obj_id = ilObject::_lookupObjId($this->requested_crtcb);
                 $this->tpl->setTitle(
                     strip_tags(
                         ilObject::_lookupTitle($cr_obj_id),
                         self::ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION
                     )
                 );
                 $this->tpl->setTitleIcon(ilObject::_getIcon($cr_obj_id));
             }
             return;
         }
         $this->tpl->setTitle(
             strip_tags(
                 $this->object->getPresentationTitle(),
                 self::ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION
             )
         );
         $this->tpl->setDescription(
             strip_tags(
                 $this->object->getLongDescription(),
                 self::ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION
             )
         );
 
         $base_class = $this->request_wrapper->retrieve("baseClass", $this->refinery->kindlyTo()->string());
         if (strtolower($base_class) === "iladministrationgui") {
             // alt text would be same as heading -> empty alt text
             $this->tpl->setTitleIcon(ilObject::_getIcon(0, "big", $this->object->getType()));
         } else {
             $this->tpl->setTitleIcon(
                 ilObject::_getIcon($this->object->getId(), "big", $this->object->getType()),
                 $this->lng->txt("obj_" . $this->object->getType())
             );
         }
         if (!$this->obj_definition->isAdministrationObject($this->object->getType())) {
             $lgui = ilObjectListGUIFactory::_getListGUIByType($this->object->getType());
             $lgui->initItem($this->object->getRefId(), $this->object->getId(), $this->object->getType());
             $this->tpl->setAlertProperties($lgui->getAlertProperties());
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showPossibleSubObjects()

ilObjectGUI::showPossibleSubObjects ( )

protected

show possible sub objects (pull down menu)

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

References $ref_id, $sub_objects, ilLegacyFormElementsUtil\formSelect(), ILIAS\Repository\lng(), ilObjectDefinition\MODE_REPOSITORY, and ILIAS\Repository\object().

                                                : void
     {
         if ($this->sub_objects == "") {
             $sub_objects = $this->obj_definition->getCreatableSubObjects(
                 $this->object->getType(),
                 ilObjectDefinition::MODE_REPOSITORY,
                 $this->ref_id
             );
         } else {
             $sub_objects = $this->sub_objects;
         }
 
         $subobj = [];
         if (count($sub_objects) > 0) {
             foreach ($sub_objects 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 (count($subobj) > 0) {
             $opts = ilLegacyFormElementsUtil::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();
         }
     }

Here is the call graph for this function:

◆ updateCustom()

ilObjectGUI::updateCustom ( ilPropertyFormGUI $form )

protected

Insert custom update form values into object.

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

Referenced by ilObjEmployeeTalkGUI\addChangeDateButtonsToToolbar(), ilObjEmployeeTalkGUI\updateObject(), and updateObject().

                                                             : void
     {
     }

Here is the caller graph for this function:

◆ updateObject()

ilObjectGUI::updateObject ( )

updates object entry in object_data

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

References afterUpdate(), checkPermissionBool(), initEditForm(), ILIAS\Repository\lng(), updateCustom(), and validateCustom().

Referenced by ilObjUserGUI\loadUserDefinedDataFromForm(), and ilObjFileBasedLMGUI\update().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validateCustom()

ilObjectGUI::validateCustom ( ilPropertyFormGUI $form )

protected

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

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

Referenced by updateObject().

                                                               : bool
     {
         return true;
     }

Here is the caller graph for this function:

◆ viewObject()

ilObjectGUI::viewObject ( )

viewObject container presentation for "administration -> repository, trash, permissions"

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

References ilChangeEvent\_recordReadEvent(), checkPermission(), checkPermissionBool(), ILIAS\Repository\ctrl(), ILIAS\Repository\object(), ILIAS\Repository\user(), and withReferences().

Referenced by ilObjLanguageExtGUI\applyFilterObject(), ilObjLanguageExtGUI\cancelObject(), ilObjCourseGUI\executeCommand(), ilObjCourseGUI\gatewayObject(), ilObjCourseGUI\leaveObject(), ilObjCourseGUI\renderObject(), ilObjLanguageExtGUI\resetFilterObject(), ilObjCourseGUI\resetObject(), ilObjLanguageExtGUI\saveObject(), and ilObjContentObjectGUI\view().

                                 : void
     {
         $this->checkPermission('visible') && $this->checkPermission('read');
 
         $this->tabs_gui->activateTab('view');
 
         ilChangeEvent::_recordReadEvent(
             $this->object->getType(),
             $this->object->getRefId(),
             $this->object->getId(),
             $this->user->getId()
         );
 
         if (!$this->withReferences()) {
             $this->ctrl->setParameter($this, 'obj_id', $this->obj_id);
         }
 
         $itab = new ilAdminSubItemsTableGUI(
             $this,
             "view",
             $this->requested_ref_id,
             $this->checkPermissionBool('write')
         );
 
         $this->tpl->setContent($itab->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withReferences()

ilObjectGUI::withReferences ( )

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

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

References $call_by_reference.

Referenced by viewObject().

                                     : bool
     {
         return $this->call_by_reference;
     }

Here is the caller graph for this function:

Field Documentation

◆ $access

ilAccessHandler ilObjectGUI::$access

protected

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

◆ $admin_mode

string ilObjectGUI::$admin_mode = self::ADMIN_MODE_NONE

protected

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

Referenced by getAdminMode().

◆ $call_by_reference

bool ilObjectGUI::$call_by_reference = false

protected

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

◆ $creation_mode

bool ilObjectGUI::$creation_mode = false

protected

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

Referenced by getCreationMode().

◆ $ctrl

ilCtrl ilObjectGUI::$ctrl

protected

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

◆ $custom_icon_factory

ilObjectCustomIconFactory ilObjectGUI::$custom_icon_factory

protected

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

◆ $data

ilObjectGUI::$data

protected

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

◆ $error

ilErrorHandling ilObjectGUI::$error

protected

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

Referenced by ilObjQuestionPoolGUI\getQueryParamInt(), ilObjSurveyGUI\importSurveyObject(), and ilObjSurveyQuestionPoolGUI\uploadQuestionsObject().

◆ $favourites

ilFavouritesManager ilObjectGUI::$favourites

protected

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

◆ $form_action

array ilObjectGUI::$form_action = []

protected

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

Referenced by ilObjContentObjectGUI\delete(), ilObjPortfolioAdministrationGUI\initAuthorshipForm(), ilObjLearningHistorySettingsGUI\initForm(), ilObjCommentsSettingsGUI\initForm(), ilObjNotesSettingsGUI\initForm(), ilObjSkillTreeGUI\initTreeForm(), ilObjUserFolderGUI\initUserRoleAssignmentForm(), setFormAction(), and ilObjGlossaryGUI\showSelectedGlossariesForCollection().

◆ $html

string ilObjectGUI::$html = ""

protected

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

Referenced by ilObjGroupGUI\executeCommand(), ilObjCourseGUI\executeCommand(), ilContainerGUI\getAsynchItemListObject(), getHTML(), ilObjForumGUI\getQuotationHTMLAsynchObject(), getRightColumnHTML(), ilContainerGUI\redrawListItemObject(), ilObjSessionGUI\showJoinRequestButton(), ilObjExerciseGUI\showOverviewObject(), ilObjSystemFolderGUI\showVcsInformationObject(), ilObjWikiGUI\viewPageObject(), and ilObjSurveyGUI\viewUserResultsObject().

◆ $id

int ilObjectGUI::$id

protected

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

Referenced by ilObjMDSettingsGUI\__construct(), ilObjChatroomAdminGUI\__construct(), ilObjCertificateSettingsGUI\__construct(), ilObjChatroomGUI\__construct(), ilObjFileServicesGUI\__construct(), ilObjLinkResourceGUI\__construct(), ilObjIndividualAssessmentGUI\__construct(), ilObjContentObjectGUI\__construct(), ilObjForumGUI\__construct(), ilObject2GUI\__construct(), __construct(), ilObjLearningSequenceGUI\_goto(), ilObjTestVerificationGUI\_goto(), ilObjCmiXapiVerificationGUI\_goto(), ilObjLTIConsumerVerificationGUI\_goto(), ilObjSCORMVerificationGUI\_goto(), ilObjCourseVerificationGUI\_goto(), ilObjBibliographicGUI\_goto(), ilObjCmiXapiGUI\_goto(), ilObjPollGUI\_goto(), ilObjLTIConsumerGUI\_goto(), ilObjSAHSLearningModuleGUI\_goto(), ilObjWorkspaceFolderGUI\_goto(), ilObjStudyProgrammeGUI\_goto(), ilObjPortfolioGUI\_goto(), ilObjBlogGUI\_goto(), ilObjContentObjectGUI\activatePages(), ilObjForumGUI\addActivationFormModal(), ilObjLanguageExtGUI\addNewEntryObject(), ilObjRoleGUI\adoptPermObject(), ilObjAuthSettingsGUI\authSettingsObject(), ilObjTestGUI\buildPageViewToolbar(), ilObjUserFolderGUI\confirmaccessFreeObject(), ilObjUserFolderGUI\confirmaccessRestrictObject(), ilObjUserFolderGUI\confirmactivateObject(), ilObjUserFolderGUI\confirmdeactivateObject(), ilObjUserFolderGUI\confirmdeleteObject(), ilObjTaxonomyGUI\confirmedDelete(), ilObjSkillTreeGUI\confirmedDelete(), ilObjContentObjectGUI\confirmedDelete(), ilObjSkillTreeGUI\confirmedDeleteTrees(), ilObjMediaCastGUI\confirmItemDeletionObject(), ilObjPortfolioBaseGUI\confirmPortfolioPageDeletion(), ilObjLanguageFolderGUI\confirmRefreshSelectedObject(), ilObjGlossaryGUI\confirmTermDeletion(), ilObjLanguageFolderGUI\confirmUninstallChangesObject(), ilObjLanguageFolderGUI\confirmUninstallObject(), ilObjTestGUI\copyQuestionObject(), ilObjQuestionPoolGUI\copyQuestions(), ilObjGlossaryGUI\copyTerms(), ilObjPortfolioTemplateGUI\createFromTemplate(), ilObjContentObjectGUI\delete(), ilObjTaxonomyGUI\deleteItems(), ilObjStyleSheetGUI\deleteMediaQueriesObject(), ilObjSkillTreeGUI\deleteNodes(), ilObjPortfolioBaseGUI\deletePortfolioPages(), ilObjRoleFolderGUI\deleteRoleObject(), ilObjGlossaryGUI\deleteTerms(), ilObjContentObjectGUI\deleteTooltips(), ilObjSCORMLearningModuleGUI\deleteTrackingForUser(), ilObjTypeDefinitionGUI\displayList(), ilObjExerciseVerificationGUI\downloadFromPortfolioPage(), ilObjTypeDefinitionGUI\editObject(), ilObjEmployeeTalkSeriesGUI\executeCommand(), ilObjBlogGUI\filterInactivePostings(), ilObjLanguageExtGUI\getId(), ilObjLinkResourceGUI\getLinkToListModal(), ilObjBlogGUI\getListItems(), ilObjTestGUI\getQuestionpoolCreationForm(), ilObjTestGUI\getTargetQuestionpoolForm(), ilObjDashboardSettingsGUI\getViewSectionSorting(), ilObjLanguageExtGUI\initAddNewEntryForm(), ilObjPortfolioTemplateGUI\initCopyPageFormOptions(), ilObjUserGUI\initForm(), ilObjForumGUI\initHeaderAction(), ilObjBadgeAdministrationGUI\initImageTemplateForm(), ilObjCmiXapiGUI\initMetadata(), ilObjLTIConsumerGUI\initMetadata(), ilObjRepositorySettingsGUI\initNewItemGroupForm(), ilObjContentObjectGUI\initSetPageLayoutForm(), ilObjUserFolderGUI\initUserRoleAssignmentForm(), ilObjQuestionPoolGUI\moveQuestions(), ilContainerGUI\redrawListItemObject(), ilObjGlossaryGUI\referenceTerms(), ilObjLanguageFolderGUI\refreshSelectedObject(), ilObjBlogGUI\renderNavigationByAuthors(), ilObjBlogGUI\renderNavigationByDate(), ilObjForumGUI\renderSplitButton(), ilObjSkillTreeGUI\saveAllTemplateTitles(), ilObjSkillTreeGUI\saveAllTitles(), ilObjLanguageExtGUI\saveNewEntryObject(), ilObjMediaCastGUI\saveOrderObject(), ilObjContentObjectGUI\savePageLayout(), ilObjFileServicesGUI\saveSettings(), ilObjContentObjectGUI\saveTooltips(), ilObjUserFolderGUI\showActionConfirmation(), ilObjBibliographicGUI\showDetails(), ilObjWorkspaceFolderGUI\showMoveIntoObjectTree(), ilObjLanguageFolderGUI\uninstallChangesObject(), and ilObjObjectFolderGUI\viewObject().

◆ $ilias

ILIAS ilObjectGUI::$ilias

protected

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

Referenced by ilObjQuestionPoolGUI\getQueryParamInt().

◆ $link_params

string ilObjectGUI::$link_params

protected

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

◆ $lng

ilLanguage ilObjectGUI::$lng

protected

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

◆ $locator

ilLocatorGUI ilObjectGUI::$locator

protected

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

Referenced by ilObjContentObjectGUI\addLocations(), ilContainerReferenceGUI\addLocatorItems(), ilObjFileBasedLMGUI\addLocatorItems(), ilObjBookingPoolGUI\addLocatorItems(), ilObjSurveyGUI\addLocatorItems(), ilObjSurveyQuestionPoolGUI\addLocatorItems(), ilObjExerciseGUI\addLocatorItems(), ilObjWikiGUI\addLocatorItems(), ilObjMediaCastGUI\addLocatorItems(), ilObjQuestionPoolGUI\addLocatorItems(), and setLocator().

◆ $maxcount

int ilObjectGUI::$maxcount

protected

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

◆ $multi_object_manipulator

MultiObjectPropertiesManipulator ilObjectGUI::$multi_object_manipulator

private

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

Referenced by getMultiObjectPropertiesManipulator().

◆ $notes_service

ILIAS Notes Service ilObjectGUI::$notes_service

protected

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

Referenced by ilObjQuestionPoolGUI\getTable().

◆ $obj_definition

ilObjectDefinition ilObjectGUI::$obj_definition

protected

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

Referenced by ilObjTestGUI\executeCommand().

◆ $obj_id

int ilObjectGUI::$obj_id

protected

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

Referenced by ilObjDataCollectionGUI\addHeaderAction(), ilObjContentObjectGUI\addLocations(), ilObjMediaPoolGUI\addLocatorItems(), ilObjFileGUI\buildInfoScreen(), ilObjLinkResourceGUI\callDirectLink(), ilObjPortfolioGUI\checkPermissionBool(), ilObjMediaPoolGUI\confirmRemove(), ilObjMediaPoolGUI\copyToClipboard(), ilObjWorkspaceFolderGUI\deleteConfirmation(), ilObjStudyProgrammeGUI\deliverCertificateObject(), ilObjGroupGUI\executeCommand(), ilContainerGUI\getAsynchItemListObject(), ilContainerReferenceGUI\getId(), ilObjDataCollectionGUI\getObjectId(), ilObjBlogGUI\initHeaderAction(), ilObjContentObjectGUI\initMenuEntryForm(), ilObjLanguageFolderGUI\installLocalObject(), ilObjLanguageFolderGUI\installObject(), ilObjAssessmentFolderGUI\logAdminObject(), ilObjSCORMLearningModuleGUI\newModuleVersion(), ilObjMediaPoolGUI\remove(), ilObjTypeDefinitionGUI\saveObject(), ilObjBlogGUI\setNotification(), ilObjLanguageFolderGUI\setSystemLanguageObject(), ilObjLanguageFolderGUI\setUserLanguageObject(), ilCourseContentGUI\showStartObjects(), ilObjFileGUI\toggleLearningProgress(), ilObjDataCollectionGUI\toggleNotification(), ilObjBibliographicGUI\toggleNotification(), and ilObjLanguageFolderGUI\uninstallObject().

◆ $object

ilObject ilObjectGUI::$object = null

protected

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

Referenced by ilObjLearningModuleGUI\__construct(), ilObjAccessibilitySettingsGUI\__construct(), ilObjMediaPoolGUI\__construct(), ilObjExerciseGUI\__construct(), ilObjCmiXapiGUI\_goto(), ilObjEmployeeTalkGUI\addChangeDateButtonsToToolbar(), ilObjBookingPoolGUI\addExternalEditFormCustom(), ilObjMediaPoolGUI\addMobsToPool(), ilObject2GUI\deleteConfirmedObjects(), ilObjPortfolioBaseGUI\deletePortfolioPages(), ilContainerGUI\downloadObject(), ilObjStyleSheetGUI\executeCommand(), ilObjMediaPoolGUI\executeCommand(), ilObjGlossaryGUI\executeCommand(), ilObjSurveyQuestionPoolGUI\exportObject(), ilObjBlogGUI\exportWithComments(), ilObjAssessmentFolderGUI\getAssessmentFolder(), ilObjForumGUI\getForumObjects(), getObject(), ilObjForumGUI\getSafePostCommands(), ilObjExerciseGUI\getService(), ilContainerGUI\linkObject(), ilObjExerciseGUI\listAssignmentsObject(), ilObjUserGUI\loadUserDefinedDataFromForm(), ilObjUserGUI\loadValuesFromForm(), ilObjSessionGUI\membersObject(), ilObjCourseGUI\renderObject(), ilObjForumGUI\renderPostContent(), ilObjMediaObjectGUI\returnToContextObject(), ilObjWikiGUI\setAsStartPageObject(), ilObjMediaObjectGUI\setPropertiesSubTabs(), ilObjContentPageGUI\setTabs(), ilObjMediaObjectGUI\showAllUsagesObject(), ilObjExerciseGUI\showOverviewObject(), ilObjExerciseGUI\startAssignmentObject(), ilObjTestGUI\uploadTst(), ilObjPortfolioBaseGUI\view(), and ilObjEmployeeTalkGUI\viewObject().

◆ $object_service

ilObjectService ilObjectGUI::$object_service

protected

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

Referenced by getObjectService(), ilObjPortfolioTemplateGUI\initEditCustomForm(), ilObjMediaPoolGUI\initEditCustomForm(), ilObjSurveyQuestionPoolGUI\initEditForm(), ilObjLinkResourceGUI\initFormSettings(), ilObjSCORMLearningModuleGUI\initPropertiesForm(), ilObjContentObjectGUI\initPropertiesForm(), ilObjWikiGUI\initSettingsForm(), ilObjMediaCastGUI\initSettingsForm(), ilObjSCORMLearningModuleGUI\saveProperties(), ilObjContentObjectGUI\saveProperties(), ilObjSurveyQuestionPoolGUI\savePropertiesObject(), ilObjLinkResourceGUI\saveSettings(), ilObjWikiGUI\saveSettingsObject(), ilObjMediaCastGUI\saveSettingsObject(), ilObjPortfolioTemplateGUI\updateCustom(), and ilObjMediaPoolGUI\updateCustom().

◆ $omit_locator

bool ilObjectGUI::$omit_locator = false

protected

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

◆ $post_wrapper

ArrayBasedRequestWrapper ilObjectGUI::$post_wrapper

protected

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

◆ $prepare_output

bool ilObjectGUI::$prepare_output

protected

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

Referenced by ilObjStudyProgrammeReferenceGUI\__construct(), ilObjMDSettingsGUI\__construct(), ilObjStudyProgrammeAdminGUI\__construct(), ilObjCertificateSettingsGUI\__construct(), ilObjLearningSequenceAdminGUI\__construct(), ilObjIndividualAssessmentGUI\__construct(), ilObjComponentSettingsGUI\__construct(), and __construct().

◆ $rbac_admin

ilRbacAdmin ilObjectGUI::$rbac_admin

protected

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

◆ $rbac_review

ilRbacReview ilObjectGUI::$rbac_review

protected

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

Referenced by ilObjSessionGUI\getDefaultMemberRole(), and ilObjSessionGUI\getLocalRoles().

◆ $rbac_system

ilRbacSystem ilObjectGUI::$rbac_system

protected

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

Referenced by ilObjQuestionPoolGUI\confirmDeleteQuestions(), ilObjQuestionPoolGUI\createExportExcel(), ilObjQuestionPoolGUI\deleteQuestionsObject(), ilObjNewsSettingsGUI\getAdminTabs(), ilObjLearningResourcesSettingsGUI\getAdminTabs(), and ilObjMediaCastSettingsGUI\getAdminTabs().

◆ $ref_id

int ilObjectGUI::$ref_id

protected

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

Referenced by ilObjLearningModuleGUI\__construct(), ilObjRoleTemplateGUI\__construct(), ilObjStyleSheetGUI\__construct(), ilObjStudyProgrammeGUI\__construct(), ilObjForumGUI\__construct(), __construct(), ilObjChatroomAdminGUI\_goto(), ilObjChatroomGUI\_goto(), ilObjStudyProgrammeAdminGUI\_goto(), ilObjDataCollectionGUI\_goto(), ilObjItemGroupGUI\_goto(), ilObjectPluginGUI\_goto(), ilObjPollGUI\_goto(), ilObjSurveyGUI\_goto(), ilObjWikiGUI\_goto(), ilObjMediaPoolGUI\_goto(), ilObjForumGUI\_goto(), ilObjRoleTemplateGUI\addAdminLocatorItems(), ilObjIndividualAssessmentGUI\addToNavigationHistory(), ilObjStudyProgrammeGUI\addToNavigationHistory(), ilObjLearningSequenceGUI\checkLPAccess(), ilObject2GUI\checkPermission(), ilObjWikiGUI\checkPermissionBool(), ilContainerGUI\clipboardObject(), ilContainerGUI\cloneAllObject(), ilObjEmployeeTalkGUI\confirmedDeleteObject(), ilObjLTIConsumerGUI\contentSelectionRequest(), ilObjLTIConsumerGUI\contentSelectionResponse(), ilContainerGUI\copyObject(), ilObjChatroomGUI\createActionDispatcherGUI(), createActionDispatcherGUI(), ilObjPortfolioTemplateGUI\createFromTemplate(), ilObjTestGUI\createQuestionPoolAndCopyObject(), ilContainerGUI\cutObject(), ilObjForumGUI\deleteSelectedDraft(), ilObjTypeDefinitionGUI\displayList(), ilObjForumGUI\doHistoryCheck(), ilObjTypeDefinitionGUI\editObject(), ilObjDataCollectionGUI\editObject(), ilRemoteObjectBaseGUI\executeCommand(), ilObjGroupGUI\executeCommand(), ilObjTestGUI\executeCommand(), ilContainerGUI\getAsynchItemListObject(), ilObjForumGUI\getContent(), ilObjQuestionPoolGUI\getQueryParamInt(), getRefId(), ilObjForumGUI\getSafePostCommands(), ilObjItemGroupGUI\gotoParent(), ilRemoteObjectBaseGUI\infoScreen(), ilObjForumGUI\initHeaderAction(), ilContainerGUI\linkObject(), ilObjAssessmentFolderGUI\logAdminObject(), ilContainerGUI\pasteObject(), ilContainerGUI\performPasteIntoMultipleObjectsObject(), ilObjRoleTemplateGUI\permSaveObject(), ilObjQuestionPoolGUI\questionsObject(), ilObjForumGUI\renderDraftContent(), ilObjBlogGUI\renderList(), ilObjForumGUI\saveAsDraftObject(), ilObjTypeDefinitionGUI\saveObject(), ilObjForumGUI\savePostObject(), ilObjOrgUnitGUI\setContentSubTabs(), ilOrgUnitExtensionGUI\setLocator(), ilObject2GUI\setLocator(), ilObjDataCollectionGUI\setTabs(), ilContainerGUI\showAdministrationPanel(), showPossibleSubObjects(), ilCourseContentGUI\showStartObjects(), ilObjForumGUI\showUserObject(), ilObjFileGUI\toggleLearningProgress(), ilObjForumGUI\updateDraftObject(), ilCourseContentGUI\updateManagedTimings(), ilCourseContentGUI\updatePersonalTimings(), and ilObjForumGUI\viewThreadObject().

◆ $refinery

Factory ilObjectGUI::$refinery

protected

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

Referenced by __construct(), and ilObjTestGUI\executeCommand().

◆ $request

ServerRequestInterface ilObjectGUI::$request

protected

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

Referenced by ilObjCmiXapiGUI\_goto(), ilObjLTIConsumerGUI\_goto(), ilObjSurveyGUI\_goto(), ilObjCmiXapiGUI\debug(), ilObjMediaPoolGUI\getPreviewModalHTML(), ilObjCmiXapiGUI\getXapiStatementsReport(), ilContainerGUI\initFilter(), ilObjSkillTreeGUI\save(), ilObjPortfolioAdministrationGUI\saveAuthorship(), ilObjLearningHistorySettingsGUI\saveSettings(), ilObjNotesSettingsGUI\saveSettings(), and ilObjCommentsSettingsGUI\saveSettings().

◆ $request_wrapper

RequestWrapper ilObjectGUI::$request_wrapper

protected

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

◆ $requested_crtcb

int ilObjectGUI::$requested_crtcb = 0

protected

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

◆ $requested_crtptrefid

int ilObjectGUI::$requested_crtptrefid = 0

protected

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

Referenced by putObjectInTree().

◆ $requested_new_type

string ilObjectGUI::$requested_new_type = ""

protected

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

Referenced by createObject(), and importFileObject().

◆ $requested_ref_id

int ilObjectGUI::$requested_ref_id = 0

protected

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

Referenced by __construct(), ilObjItemGroupGUI\addLocatorItems(), ilObjFileBasedLMGUI\addLocatorItems(), ilObjSurveyGUI\addLocatorItems(), ilObjMediaCastGUI\addLocatorItems(), checkPermissionBool(), ilContainerGUI\cloneAllObject(), ilContainerGUI\downloadObject(), ilObjMediaCastGUI\getFeedLink(), importFileObject(), putObjectInTree(), setLocator(), and ilContainerGUI\showAdministrationPanel().

◆ $retriever

ilObjectRequestRetriever ilObjectGUI::$retriever

private

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

◆ $return_location

array ilObjectGUI::$return_location = []

protected

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

◆ $settings

ilSetting ilObjectGUI::$settings

protected

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

Referenced by ilObjAccessibilitySettingsGUI\__construct(), ilObjMediaCastGUI\__construct(), ilObjEmployeeTalkGUI\addChangeDateButtonsToToolbar(), ilContainerGUI\addHeaderRow(), ilObjPortfolioAdministrationGUI\addToExternalSettingsForm(), ilObjRepositorySettingsGUI\addToExternalSettingsForm(), ilObjWikiGUI\afterSave(), ilObjStudyProgrammeGUI\afterSave(), ilObjCategoryGUI\afterSave(), ilObjLearningSequenceGUI\afterSave(), ilObjAuthSettingsGUI\apacheAuthSettingsObject(), ilObjSystemFolderGUI\checkObject(), ilObjPortfolioGUI\createPortfolioFromAssignment(), ilObjPortfolioGUI\createPortfolioFromTemplateProcess(), ilObjPortfolioBaseGUI\deletePortfolioPages(), ilObjAuthSettingsGUI\editScriptObject(), ilObjBlogAdministrationGUI\editSettings(), ilObjECSSettingsGUI\executeCommand(), ilObjUserFolderGUI\generalSettingsObject(), ilContainerGUI\getContainerPageHTML(), ilObjNewsSettingsGUI\getSettingsForm(), ilObjPersonalWorkspaceSettingsGUI\getSettingsForm(), ilObjSystemFolderGUI\initContactInformationForm(), ilObjPortfolioGUI\initCreateForm(), ilObjPortfolioGUI\initCreateFromTemplateForm(), ilObjPortfolioGUI\initCreatePortfolioFromTemplateForm(), ilObjRepositorySettingsGUI\initCustomIconsForm(), ilObjBlogGUI\initEditCustomForm(), ilObjCourseGUI\initEditForm(), ilObjUserGUI\initForm(), ilObjPortfolioAdministrationGUI\initFormSettings(), ilObjSystemFolderGUI\initJavaServerForm(), ilObjContentObjectGUI\initPropertiesForm(), ilObjSystemFolderGUI\initServerInfoForm(), ilObjRepositorySettingsGUI\initSettingsForm(), ilObjWikiGUI\initSettingsForm(), ilContainerGUI\initSortingForm(), ilObjUserGUI\isSettingChangeable(), ilObjSCORM2004LearningModuleGUI\properties(), ilObjBlogGUI\renderNavigation(), ilContainerGUI\renderObject(), ilObjLearningSequenceAdminGUI\save(), ilObjContentPageAdministrationGUI\save(), ilObjSearchSettingsGUI\saveAdvancedLuceneSettingsObject(), ilObjAuthSettingsGUI\saveApacheSettingsObject(), ilObjSystemFolderGUI\saveBasicSettingsObject(), ilObjSystemFolderGUI\saveCheckCronObject(), ilObjSystemFolderGUI\saveContactInformationObject(), ilObjRepositorySettingsGUI\saveCustomIcons(), ilObjSystemFolderGUI\saveJavaServerObject(), ilObjRepositorySettingsGUI\saveModules(), ilObjRepositorySettingsGUI\saveNewItemGroupOrder(), ilObjNotificationAdminGUI\saveOSDSettings(), ilObjAdvancedEditingGUI\savePageEditorSettingsObject(), ilObjSCORM2004LearningModuleGUI\saveProperties(), ilObjContentObjectGUI\saveProperties(), ilObjPortfolioAdministrationGUI\saveSettings(), ilObjTaggingSettingsGUI\saveSettings(), ilObjPersonalWorkspaceSettingsGUI\saveSettings(), ilObjNewsSettingsGUI\saveSettings(), ilObjRepositorySettingsGUI\saveSettings(), ilObjWikiGUI\saveSettingsObject(), ilContainerGUI\saveSortingSettings(), ilObjContentObjectGUI\setSubTabs(), ilObjSystemFolderGUI\showBasicSettingsObject(), ilObjNotificationAdminGUI\showOSDSettings(), ilObjCourseGUI\updateObject(), ilObjEmployeeTalkGUI\validateCustom(), and ilObjPortfolioBaseGUI\view().

◆ $sub_objects

string ilObjectGUI::$sub_objects = ""

protected

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

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

◆ $tabs_gui

ilTabsGUI ilObjectGUI::$tabs_gui

protected

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

Referenced by ilObjTestGUI\executeCommand(), ilObjPortfolioAdministrationGUI\getAdminTabs(), ilObjQuestionPoolGUI\getQueryParamInt(), ilObjBibliographicAdminGUI\getTabsGui(), ilObjDashboardSettingsGUI\setSettingsSubTabs(), and ilObjBibliographicAdminGUI\setTabsGui().

◆ $target_frame

array ilObjectGUI::$target_frame = []

protected

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

Referenced by ilObject2GUI\getTargetFrame().

◆ $tmp_import_dir

string ilObjectGUI::$tmp_import_dir

protected

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

◆ $toolbar

ilToolbarGUI ilObjectGUI::$toolbar

protected

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

◆ $tpl

ilGlobalTemplateInterface ilObjectGUI::$tpl

protected

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

◆ $tree

ilTree ilObjectGUI::$tree

protected

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

Referenced by ilObject2GUI\__construct(), ilContainerGUI\_buildPath(), ilObjItemGroupGUI\_goto(), ilObjPollGUI\_goto(), ilObjMediaPoolGUI\addLocatorItems(), ilObjMediaPoolGUI\addMobsToPool(), ilObjMediaPoolGUI\afterConstructor(), ilObjCategoryGUI\afterSave(), ilContainerGUI\cloneNodes(), ilObjContentObjectGUI\confirmedDelete(), ilObjMediaPoolGUI\createMediaFromUploadDir(), ilObjSkillTreeGUI\delete(), ilObjPortfolioBaseGUI\deletePortfolioPages(), ilObjContentObjectGUI\editPublicSection(), ilObjMediaPoolGUI\executeCommand(), ilObjTestGUI\executeCommand(), ilObjFolderGUI\forwardToTimingsView(), ilObjPortfolioGUI\getCreateInfoMessage(), ilObjCategoryGUI\getTaxonomiesForRefId(), ilObjItemGroupGUI\gotoParent(), ilObjMediaPoolGUI\handleUploadResult(), ilObjPortfolioGUI\initBlogForm(), ilObjPortfolioGUI\initCreatePortfolioFromTemplateForm(), isVisible(), ilObjItemGroupGUI\listMaterials(), ilObjTaxonomyGUI\listNodes(), ilObjFolderGUI\modifyItemGUI(), ilObjTaxonomyGUI\pasteItems(), ilContainerGUI\pasteObject(), ilObjWorkspaceFolderGUI\performPasteIntoMultipleObjects(), ilContainerGUI\performPasteIntoMultipleObjectsObject(), ilObjSCORM2004LearningModuleGUI\properties(), ilObjExerciseVerificationGUI\render(), ilObjSCORMVerificationGUI\render(), ilObjCmiXapiVerificationGUI\render(), ilObjLTIConsumerVerificationGUI\render(), ilObjTestVerificationGUI\render(), ilObjCourseVerificationGUI\render(), ilObjBlogGUI\renderFullScreen(), ilObjMediaPoolGUI\returnFromItem(), ilObjPortfolioGUI\saveBlog(), ilObjBlogGUI\setSettingsSubTabs(), ilObjItemGroupGUI\setTabs(), ilContainerGUI\showLinkListObject(), ilObjContentObjectGUI\showLMGlossarySelector(), ilObjWorkspaceFolderGUI\showMoveIntoObjectTree(), and ilOrgUnitExtensionGUI\showTree().

◆ $type

string ilObjectGUI::$type = ""

protected

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

Referenced by ilObjMediaObjectGUI\_getMediaInfoHTML(), ilObjBadgeAdministrationGUI\activateTypes(), ilContainerGUI\addMessageRow(), ilObjWikiGUI\checkPermissionBool(), ilObjTestGUI\copyAndLinkToQuestionpoolObject(), ilObjUserFolderGUI\exportObject(), ilObjLearningSequenceGUI\getAdditionalOKTypes(), ilContainerGUI\getAsynchItemListObject(), ilObjExternalToolsSettingsGUI\getMapsForm(), ilObjTalkTemplateGUI\getTabs(), ilObjStyleSheetGUI\getTemplateFormValues(), ilContainerGUI\getTreeSelectorGUI(), ilObjMDSettingsGUI\getType(), ilObjUserFolderGUI\getUserMultiCommands(), ilObjSurveyGUI\getUserResultsPlain(), ilObjBookingPoolGUI\initEditCustomForm(), ilObjBadgeAdministrationGUI\initImageTemplateForm(), ilObjUserTrackingGUI\initLPDefaultsForm(), ilObjContentObjectGUI\initMenuForm(), ilObjChatroomGUI\insertObject(), ilObjSCORMLearningModuleGUI\newModuleVersion(), ilObjQuestionPoolGUI\questionObject(), ilObjUserTrackingGUI\saveLPDefaultsObject(), ilObjMediaObjectGUI\savePropertiesObject(), ilObjMediaObjectGUI\setObjectPerCreationForm(), ilContainerGUI\showLinkListObject(), ilCourseContentGUI\showStartObjects(), and ilObjQuestionPoolGUI\uploadQplObject().

◆ $ui_factory

UIFactory ilObjectGUI::$ui_factory

protected

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

Referenced by ilObjContentObjectGUI\getMultiLangHeader(), ilObjQuestionPoolGUI\getTable(), ilObjBlogGUI\renderList(), and ilObjBlogGUI\renderNavigation().

◆ $ui_renderer

UIRenderer ilObjectGUI::$ui_renderer

protected

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

Referenced by ilObjContentObjectGUI\getMultiLangHeader(), ilObjQuestionPoolGUI\getTable(), ilObjBlogGUI\renderList(), and ilObjBlogGUI\renderNavigation().

◆ $user

ilObjUser ilObjectGUI::$user

protected

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

◆ ADMIN_MODE_NONE

const ilObjectGUI::ADMIN_MODE_NONE = ""

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

◆ ADMIN_MODE_REPOSITORY

const ilObjectGUI::ADMIN_MODE_REPOSITORY = "repository"

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

◆ ADMIN_MODE_SETTINGS

const ilObjectGUI::ADMIN_MODE_SETTINGS = "settings"

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

◆ ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION

const ilObjectGUI::ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION

Initial value:

= [
        '<b>',
        '<i>',
        '<strong>',
        '<em>',
        '<sub>',
        '<sup>',
        '<pre>',
        '<strike>',
        '<bdo>'
    ]

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

Referenced by ilLocatorGUI\addItem(), ilObjectOwnershipManagementTableGUI\fillRow(), ilObjectDataSet\getDependencies(), ilDataCollectionDataSet\getXmlNamespace(), ilObjTestGUI\infoScreen(), ilObjTestGUI\printObject(), ilObjLTIConsumer\registerClient(), ilObjTestGUI\reviewobject(), ilObjectListGUI\setDescription(), and ilObjectListGUI\setTitle().

◆ CFORM_CLONE

const ilObjectGUI::CFORM_CLONE = 3

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

◆ CFORM_IMPORT

const ilObjectGUI::CFORM_IMPORT = 2

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

◆ CFORM_NEW

const ilObjectGUI::CFORM_NEW = 1

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

◆ UPLOAD_TYPE_LOCAL

const ilObjectGUI::UPLOAD_TYPE_LOCAL = 1

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

◆ UPLOAD_TYPE_UPLOAD_DIRECTORY

const ilObjectGUI::UPLOAD_TYPE_UPLOAD_DIRECTORY = 2

Definition at line 57 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

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _gotoRepositoryNode()

◆ _gotoRepositoryRoot()

◆ _gotoSharedWorkspaceNode()

◆ addAdminLocatorItems()

◆ addAdoptContentLinkToToolbar()

◆ addAvailabilityPeriodButtonToToolbar()

◆ addDidacticTemplateOptions()

◆ addExternalEditFormCustom()

◆ addHeaderAction()

◆ addLocatorItems()

◆ addToDeskObject()

◆ afterImport()

◆ afterSave()

◆ afterUpdate()

◆ assignObject()

◆ buildDeleletionModal()

◆ buildDeletionModalItems()

◆ buildInputsForAdditionalDeletionReferences()

◆ buildRefIdsFromData()

◆ cancelCreation()

◆ cancelObject()

◆ checkPermission()

◆ checkPermissionBool()

◆ checkWritePermissionOnRefIdArray()

◆ confirmedDeleteObject()

◆ createActionDispatcherGUI()

◆ createObject()

◆ deleteObject()

◆ editAvailabilityPeriodObject()

◆ editObject()

◆ enableDragDropFileUpload()

◆ executeCommand()

◆ getAdminMode()

◆ getAdminTabs()

◆ getCenterColumnHTML()

◆ getCreationFormsHTML()

◆ getCreationMode()

◆ getDidacticTemplateVar()

◆ getEditFormCustomValues()

◆ getEditFormValues()

◆ getFormAction()

◆ getHTML()

◆ getMultiObjectPropertiesManipulator()

◆ getObject()

◆ getObjectService()

◆ getRefId()

◆ getReturnLocation()

◆ getRightColumnHTML()

◆ getTabs()

◆ getTargetFrame()

◆ importFileObject()

◆ initCreateForm()

◆ initCreationForms()

◆ initDidacticTemplate()

◆ initEditCustomForm()

◆ initEditForm()

◆ initHeaderAction()

◆ initImportForm()

◆ insertHeaderAction()

◆ isVisible()

◆ omitLocator()

◆ prepareOutput()

◆ putObjectInTree()

◆ redirectAfterCreation()

◆ redirectToRefId()

◆ redrawHeaderActionObject()

◆ removeFromDeskObject()

◆ saveAvailabilityPeriodObject()

◆ saveObject()