Inheritance diagram for ilObjFolderGUI:

Collaboration diagram for ilObjFolderGUI:

Public Member Functions
	__construct ( $a_data, int $a_id=0, bool $a_call_by_reference=true, bool $a_prepare_output=false)

	viewObject ()

	renderObject ()

	executeCommand ()

	setFolderTree (ilTree $a_tree)

	showSummaryObject ()
	this one is called from the info button in the repository not very nice to set cmdClass/Cmd manually, if everything works through ilCtrl in the future this may be changed More...

	infoScreenObject ()
	this one is called from the info button in the repository not very nice to set cmdClass/Cmd manually, if everything works through ilCtrl in the future this may be changed More...

	infoScreen ()

	modifyItemGUI (ilObjectListGUI $a_item_list_gui, array $a_item_data)

	editObject ()

	setSubTabs (string $a_tab)

	deleteObject (bool $error=false)

Public Member Functions inherited from ilContainerGUI
	executeCommand ()

	forwardToPageObject ()

	addPageTabs ()

	getContainerPageHTML ()

	getContentGUI ()

	renderObject ()

	renderBlockAsynchObject ()
	render the object More...

	setContentSubTabs ()

	showAdministrationPanel ()

	showPermanentLink ()

	editPageFrameObject ()

	cancelPageContentObject ()

	showLinkListObject ()

	addHeaderRow (ilTemplate $a_tpl, string $a_type, bool $a_show_image=true)

	addMessageRow (ilTemplate $a_tpl, string $a_message, string $a_type)

	setPageEditorTabs ()

	addStandardContainerSubTabs (bool $a_include_view=true)
	Add standard container subtabs for view, manage, oderdering and text/media editor link. More...

	enableAdministrationPanelObject ()

	disableAdministrationPanelObject ()

	editOrderObject ()

	isActiveOrdering ()

	isActiveItemOrdering ()

	enableMultiDownloadObject ()

	isMultiDownloadEnabled ()

	cutObject ()
	cut object(s) out from a container and write the information to clipboard public More...

	copyObject ()
	Copy object(s) out from a container and write the information to clipboard It is not possible to copy multiple objects at once. More...

	downloadObject ()

	getBucketTitle ()

	linkObject ()
	create an new reference of an object in tree it's like a hard link of unix More...

	clearObject ()
	clear clipboard and go back to last object More...

	performPasteIntoMultipleObjectsObject ()

	initAndDisplayLinkIntoMultipleObjectsObject ()

	showPasteTreeObject ()

	cancelMoveLinkObject ()
	Cancel move\|link empty clipboard and return to parent. More...

	keepObjectsInClipboardObject ()

	initAndDisplayCopyIntoMultipleObjectsObject ()

	initAndDisplayMoveIntoObjectObject ()

	pasteObject ()
	paste object from clipboard to current place Depending on the chosen command the object(s) are linked, copied or moved More...

	clipboardObject ()

	isActiveAdministrationPanel ()

	setColumnSettings (ilColumnGUI $column_gui)

	allowBlocksMoving ()
	Standard is to allow blocks moving. More...

	allowBlocksConfigure ()
	Standard is to allow blocks configuration. More...

	cloneAllObject ()
	Clone all object Overwritten method for copying container objects. More...

	saveSortingObject ()

	cloneNodes (int $srcRef, int $dstRef, array &$mapping, ?string $newName=null)
	Recursively clones all nodes of the RBAC tree. More...

	modifyItemGUI (ilObjectListGUI $a_item_list_gui, array $a_item_data)

	editStylePropertiesObject ()

	redrawListItemObject ()
	Redraw a list item (ajax) More...

	trashObject ()
	Show trash content of object. More...

	trashApplyFilterObject ()

	trashResetFilterObject ()

	removeFromSystemObject ()

	undeleteObject ()
	Get objects back from trash. More...

	confirmRemoveFromSystemObject ()

	setSideColumnReturn ()

	getAdminTabs ()

	competencesObject ()

Public Member Functions inherited from ilObjectGUI
	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)

	addToDeskObject ()

	removeFromDeskObject ()

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

Public Member Functions inherited from ilDesktopItemHandling
	addToDeskObject ()

	removeFromDeskObject ()

Static Public Member Functions
static	_goto ($a_target)
	goto target group More...

Static Public Member Functions inherited from ilContainerGUI
static	_buildPath (int $a_ref_id, int $a_course_ref_id)
	build path More...

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

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

static	_gotoSharedWorkspaceNode (int $wsp_id)

Data Fields
ilTree	$folder_tree

Data Fields inherited from ilContainerGUI
int	$bl_cnt = 1

bool	$multi_download_enabled = false

Data Fields inherited from ilObjectGUI
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

const	SUPPORTED_IMPORT_MIME_TYPES = [MimeType::APPLICATION__ZIP, MimeType::APPLICATION__X_ZIP_COMPRESSED]

Protected Member Functions
	initEditForm ()

	getEditFormCustomValues (array &$a_values)

	updateCustom (ilPropertyFormGUI $form)

	afterSave (ilObject $new_object)

	getTabs ()

	showPossibleSubObjects ()
	show possible sub objects selection list More...

	forwardToTimingsView ()

Protected Member Functions inherited from ilContainerGUI
	getModeManager ()

	getItemPresentation ( $include_empty_blocks=true, ?string $lang=null)

	getEditFormValues ()

	afterUpdate ()

	setTitleAndDescription ()

	showPossibleSubObjects ()

	supportsPageEditor ()

	gotItems ()

	getTabs ()

	showContainerPageTabs ()

	showPasswordInstructionObject (bool $a_init=true)

	initFormPasswordInstruction ()
	Init password form. More...

	savePasswordObject ()

	initEditForm ()

	initSortingForm (ilPropertyFormGUI $form, array $a_sorting_settings)
	Append sorting settings to property form. More...

	initListPresentationForm (ilPropertyFormGUI $form)
	Add list presentation settings to form. More...

	saveListPresentation (ilPropertyFormGUI $form)

	initSortingDirectionForm (ilContainerSortingSettings $sorting_settings, ilRadioOption $element, string $a_prefix)
	Add sorting direction. More...

	initManualSortingOptionForm (ilContainerSortingSettings $settings, ilRadioOption $element, string $a_prefix, array $a_sorting_settings)
	Add manual sorting options. More...

	saveSortingSettings (ilPropertyFormGUI $form)

	trashHandleFilter (bool $action_apply, bool $action_reset)

	restoreToNewLocationObject (?ilPropertyFormGUI $form=null)

	getTreeSelectorGUI (string $cmd)

	initFilter ()

	showContainerFilter ()

Protected Member Functions inherited from ilObjectGUI
	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...

	getCreationFormsHTML (StandardForm\|ilPropertyFormGUI\|array $form)

	getTitleForCreationFormPage ()

	getCreationFormTitle ()

	initCreateForm (string $new_type)

	didacticTemplatesToForm ()

	initDidacticTemplate (ilPropertyFormGUI $form)

	retrieveAdditionalDidacticTemplateOptions ()

	addAdoptContentLinkToToolbar ()

	addImportButtonToToolbar ()

	addAvailabilityPeriodButtonToToolbar (ilToolbarGUI $toolbar)

	parseDidacticTemplateVar (string $var, string $type)

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

	routeImportCmdObject ()

	importFile (string $file_to_import, string $path_to_uploaded_file_in_temp_dir)

	deleteUploadedImportFile (string $path_to_uploaded_file_in_temp_dir)

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

	getCreatableObjectTypes ()

	buildAddNewItemElements (array $subtypes, string $create_target_class=ilRepositoryGUI::class, ?int $redirect_target_ref_id=null,)

	buildGroup (string $create_target_class, array $obj_types_in_group, string $title, array $subtypes)

Protected Attributes
ilHelpGUI	$help

StandardGUIRequest	$folder_request

Protected Attributes inherited from ilContainerGUI
ILIAS Container InternalGUIService	$gui

ILIAS Style Content GUIService	$content_style_gui

ilRbacSystem	$rbacsystem

ilRbacReview	$rbacreview

ILIAS Container Content ItemPresentationManager	$item_presentation = null

ILIAS Container InternalDomainService	$domain

ilTabsGUI	$tabs

ilErrorHandling	$error

ilObjectDefinition	$obj_definition

ilRbacAdmin	$rbacadmin

ilPropertyFormGUI	$form

ilLogger	$log

ilObjectDataCache	$obj_data_cache

Services	$global_screen

ilAppEventHandler	$app_event_handler

UIServices	$ui

ilContainerFilterService	$container_filter_service

ilContainerUserFilter	$container_user_filter = null

Standard	$ui_filter = null

bool	$edit_order = false

bool	$adminCommands = false

string	$requested_redirectSource = ""

int	$current_position = 0

ClipboardManager	$clipboard

StandardGUIRequest	$std_request

ModeManager	$mode_manager = null

ilComponentFactory	$component_factory

ILIAS Style Content DomainService	$content_style_domain

Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service

GlobalHttpState	$http

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

Refinery	$refinery

ilFavouritesManager	$favourites

CustomIconFactory	$custom_icon_factory

UIFactory	$ui_factory

UIRenderer	$ui_renderer

Filesystem	$temp_file_system

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 = ""

Detailed Description

Class ilObjFolderGUI.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

ilObjFolderGUI: ilPermissionGUI ilObjFolderGUI: ilCourseContentGUI, ilLearningProgressGUI ilObjFolderGUI: ilInfoScreenGUI, ilContainerPageGUI, ilColumnGUI ilObjFolderGUI: ilObjectCopyGUI, ilObjectContentStyleSettingsGUI ilObjFolderGUI: ilExportGUI, ilCommonActionDispatcherGUI, ilDidacticTemplateGUI ilObjFolderGUI: ilBackgroundTaskHub, ILIAS, ilRepositoryTrashGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilObjFolderGUI::__construct	(		$a_data,
		int	$a_id = `0`,
		bool	$a_call_by_reference = `true`,
		bool	$a_prepare_output = `false`
	)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\help(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), ILIAS\Repository\tabs(), and ILIAS\Repository\user().

       {
         global $DIC;
 
         $this->tree = $DIC->repositoryTree();
         $this->tabs = $DIC->tabs();
         $this->user = $DIC->user();
         $this->ctrl = $DIC->ctrl();
         $this->lng = $DIC->language();
         $this->access = $DIC->access();
         $this->rbacsystem = $DIC->rbac()->system();
         $this->help = $DIC["ilHelp"];
         $this->error = $DIC["ilErr"];
         $this->tpl = $DIC["tpl"];
         $this->settings = $DIC->settings();
         $this->type = "fold";
         parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output);
         $this->lng->loadLanguageModule("obj");
         $this->folder_request = $DIC
             ->folder()
             ->internal()
             ->gui()
             ->standardRequest();
     }

Here is the call graph for this function:

Member Function Documentation

◆ _goto()

static ilObjFolderGUI::_goto ( $a_target )

static

goto target group

Definition at line 494 of file class.ilObjFolderGUI.php.

References $DIC, $ilErr, ilObjectGUI\$lng, ilObjectGUI\_gotoRepositoryNode(), ILIAS\Repository\int(), and ilLanguage\txt().

                                            : void
     {
         global $DIC;
 
         $ilAccess = $DIC->access();
         $ilErr = $DIC["ilErr"];
         $lng = $DIC->language();
 
         $a_target = (int) $a_target;
 
         if ($ilAccess->checkAccess("read", "", $a_target)) {
             ilObjectGUI::_gotoRepositoryNode($a_target);
         }
         if ($ilAccess->checkAccess("visible", "", $a_target)) {
             ilObjectGUI::_gotoRepositoryNode($a_target, "infoScreen");
         }
         $ilErr->raiseError($lng->txt("msg_no_perm_read"), $ilErr->FATAL);
     }

Here is the call graph for this function:

◆ afterSave()

ilObjFolderGUI::afterSave ( ilObject $new_object )

protected

Definition at line 350 of file class.ilObjFolderGUI.php.

References ILIAS\Repository\ctrl(), ilObject\getId(), ilObject\getRefId(), ILIAS\Repository\lng(), ilObjectGUI\redirectToRefId(), ilContainerSortingSettings\setSortMode(), and ilContainer\SORT_INHERIT.

                                                       : void
     {
         $sort = new ilContainerSortingSettings($new_object->getId());
         $sort->setSortMode(ilContainer::SORT_INHERIT);
         $sort->update();
 
         // always send a message
         $this->tpl->setOnScreenMessage('success', $this->lng->txt("fold_added"), true);
         $this->ctrl->setParameter($this, "ref_id", $new_object->getRefId());
         $this->redirectToRefId($new_object->getRefId(), "");
     }

Here is the call graph for this function:

◆ deleteObject()

ilObjFolderGUI::deleteObject ( bool $error = false )

Definition at line 607 of file class.ilObjFolderGUI.php.

References ilContainerGUI\$error.

                                                      : void
     {
         $this->tabs_gui->activateTab('view_content');
         parent::deleteObject($error);
     }

◆ editObject()

ilObjFolderGUI::editObject ( )

Definition at line 566 of file class.ilObjFolderGUI.php.

References ilContainerGUI\$error, ilContainerGUI\$form, $GLOBALS, $ilErr, ilContainerGUI\$tabs, ilObjectGUI\checkPermissionBool(), ilContainerGUI\getEditFormValues(), ilPropertyFormGUI\getHTML(), initEditForm(), ILIAS\Repository\lng(), setSubTabs(), and ilPropertyFormGUI\setValuesByArray().

                                 : void
     {
         $ilTabs = $this->tabs;
         $ilErr = $this->error;
 
         $this->setSubTabs("settings");
         $ilTabs->activateTab("settings");
 
         if (!$this->checkPermissionBool("write")) {
             $ilErr->raiseError($this->lng->txt("msg_no_perm_write"), $ilErr->MESSAGE);
         }
 
         $form = $this->initEditForm();
         $values = $this->getEditFormValues();
         if ($values) {
             $form->setValuesByArray($values, true);
         }
         $GLOBALS['tpl']->setContent($form->getHTML());
     }

Here is the call graph for this function:

◆ executeCommand()

ilObjFolderGUI::executeCommand ( )

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

References ilContainerGUI\$gui, ilObjectGUI\$user, ILIAS\Repository\access(), ilObjectGUI\addHeaderAction(), ilObjectGUI\checkPermission(), ilObjectGUI\checkPermissionBool(), ILIAS\Repository\ctrl(), ilContainerGUI\forwardToPageObject(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), ilObjectGUI\getObject(), ILIAS\FileDelivery\http(), infoScreen(), ILIAS\Repository\lng(), ilLearningProgressBaseGUI\LP_CONTEXT_REPOSITORY, null, ILIAS\Repository\object(), ilObjectGUI\prepareOutput(), ILIAS\Repository\refinery(), setSubTabs(), ilContainerGUI\setTitleAndDescription(), ilContainerGUI\showContainerPageTabs(), ILIAS\Repository\toolbar(), ILIAS\Repository\user(), and viewObject().

                                     : void
     {
         $ilUser = $this->user;
         $next_class = $this->ctrl->getNextClass($this);
         $cmd = $this->ctrl->getCmd();
 
         $header_action = true;
         switch ($next_class) {
             case strtolower(ilRepositoryTrashGUI::class):
                 $ru = new ilRepositoryTrashGUI($this);
                 $this->ctrl->setReturn($this, 'trash');
                 $this->ctrl->forwardCommand($ru);
                 break;
 
             case 'ilpermissiongui':
                 $this->prepareOutput();
                 $this->tabs_gui->activateTab('perm_settings');
                 $perm_gui = new ilPermissionGUI($this);
                 $ret = $this->ctrl->forwardCommand($perm_gui);
                 break;
 
 
             case 'ilcoursecontentgui':
                 $this->prepareOutput();
                 $course_content_obj = new ilCourseContentGUI($this);
                 $this->ctrl->forwardCommand($course_content_obj);
                 break;
 
             case "illearningprogressgui":
                 $this->prepareOutput();
 
                 $new_gui = new ilLearningProgressGUI(
                     ilLearningProgressBaseGUI::LP_CONTEXT_REPOSITORY,
                     $this->object->getRefId(),
                     $this->folder_request->getUserId() ?: $ilUser->getId()
                 );
                 $this->ctrl->forwardCommand($new_gui);
                 $this->tabs_gui->setTabActive('learning_progress');
                 break;
 
                 // container page editing
             case "ilcontainerpagegui":
                 $this->prepareOutput(false);
                 $ret = $this->forwardToPageObject();
                 if ($ret !== "") {
                     $this->tpl->setContent($ret);
                 }
                 $header_action = false;
                 break;
 
             case 'ilinfoscreengui':
                 $this->prepareOutput();
                 $this->infoScreen();
                 break;
 
             case 'ilobjectcopygui':
                 $this->prepareOutput();
 
                 $cp = new ilObjectCopyGUI($this);
                 $cp->setType('fold');
                 $this->ctrl->forwardCommand($cp);
                 break;
 
             case "ilobjectcontentstylesettingsgui":
                 $this->checkPermission("write");
                 $this->setTitleAndDescription();
                 $this->showContainerPageTabs();
                 $settings_gui = $this->content_style_gui
                     ->objectSettingsGUIForRefId(
                         null,
                         $this->object->getRefId()
                     );
                 $this->ctrl->forwardCommand($settings_gui);
                 break;
 
             case 'ilexportgui':
                 $this->prepareOutput();
 
                 $this->tabs_gui->setTabActive('export');
                 $exp = new ilExportGUI($this);
                 $exp->addFormat('xml');
                 $this->ctrl->forwardCommand($exp);
                 break;
 
             case "ilcommonactiondispatchergui":
                 $this->prepareOutput();
                 $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                 $this->ctrl->forwardCommand($gui);
                 break;
 
             case 'ildidactictemplategui':
                 $this->ctrl->setReturn($this, 'edit');
                 $did = new ilDidacticTemplateGUI($this);
                 $this->ctrl->forwardCommand($did);
                 break;
             case 'ilcolumngui':
                 $this->tabs_gui->setTabActive('none');
                 $this->checkPermission("read");
                 $this->viewObject();
                 break;
 
             case strtolower(TranslationGUI::class):
                 $this->checkPermissionBool("write");
                 $this->prepareOutput();
                 $this->setSubTabs("settings_trans");
                 $transgui = new TranslationGUI(
                     $this->getObject(),
                     $this->lng,
                     $this->access,
                     $this->user,
                     $this->ctrl,
                     $this->tpl,
                     $this->ui_factory,
                     $this->ui_renderer,
                     $this->http,
                     $this->refinery,
                     $this->toolbar
                 );
                 $this->ctrl->forwardCommand($transgui);
                 break;
 
             default:
 
                 $this->prepareOutput();
                 // cognos-blu-patch: begin
                 // removed timings forward
                 // cognos-blu-patch: end
 
                 if (empty($cmd)) {
                     $cmd = "view";
                 }
                 $cmd .= "Object";
                 $this->$cmd();
                 break;
         }
 
         if ($header_action) {
             $this->addHeaderAction();
         }
     }

Here is the call graph for this function:

◆ forwardToTimingsView()

ilObjFolderGUI::forwardToTimingsView ( )

protected

Definition at line 546 of file class.ilObjFolderGUI.php.

References ilObjectGUI\$tree, ilObject\_lookupObjId(), ilObjCourse\_lookupViewMode(), ilTree\checkForParentType(), ILIAS\Repository\ctrl(), ilSession\get(), ilSession\has(), ilSession\set(), and ilContainer\VIEW_TIMING.

                                              : void
     {
         $tree = $this->tree;
 
         if (!$crs_ref = $tree->checkForParentType($this->ref_id, 'crs')) {
             return;
         }
         if (!$this->ctrl->getCmd() && ilObjCourse::_lookupViewMode(ilObject::_lookupObjId($crs_ref)) === ilContainer::VIEW_TIMING) {
             if (!ilSession::has('crs_timings')) {
                 ilSession::set('crs_timings', true);
             }
 
             if (ilSession::get('crs_timings')) {
                 $this->ctrl->redirectByClass(ilCourseContentGUI::class, 'editUserTimings');
                 return;
             }
         }
         ilSession::set('crs_timings', false);
     }

Here is the call graph for this function:

◆ getEditFormCustomValues()

ilObjFolderGUI::getEditFormCustomValues ( array & $a_values )

protected

Definition at line 310 of file class.ilObjFolderGUI.php.

References ilContainerSortingSettings\getSortMode(), and ILIAS\Repository\object().

                                                                 : void
     {
         // we cannot use $this->object->getOrderType()
         // if set to inherit it will be translated to parent setting
         $sort = new ilContainerSortingSettings($this->object->getId());
         $a_values["sor"] = $sort->getSortMode();
     }

Here is the call graph for this function:

◆ getTabs()

ilObjFolderGUI::getTabs ( )

protected

Definition at line 413 of file class.ilObjFolderGUI.php.

References ilObjectGUI\$access, ilObjectGUI\$ctrl, $help, ilObjectGUI\$lng, ilContainerGUI\$rbacsystem, ilLearningProgressAccess\checkAccess(), ilRbacSystem\checkAccess(), ILIAS\Repository\ctrl(), ILIAS\Repository\object(), and ilLanguage\txt().

                                 : void
     {
         $rbacsystem = $this->rbacsystem;
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
         $ilAccess = $this->access;
         $ilHelp = $this->help;
 
         $this->ctrl->setParameter($this, "ref_id", $this->ref_id);
 
         $ilHelp->setScreenIdComponent("fold");
 
         $this->tabs_gui->setTabActive("");
         if ($ilAccess->checkAccess('read', '', $this->ref_id)) {
             $this->tabs_gui->addTab(
                 "view_content",
                 $lng->txt("content"),
                 $this->ctrl->getLinkTarget($this, "")
             );
 
             //BEGIN ChangeEvent add info tab to category object
             $force_active = $this->ctrl->getNextClass() === "ilinfoscreengui"
                 || strtolower($this->ctrl->getCmdClass()) === "ilnotegui";
             $this->tabs_gui->addTarget(
                 "info_short",
                 $this->ctrl->getLinkTargetByClass(
                     ["ilobjfoldergui", "ilinfoscreengui"],
                     "showSummary"
                 ),
                 ["showSummary", "", "infoScreen"],
                 "",
                 "",
                 $force_active
             );
             //END ChangeEvent add info tab to category object
         }
 
         if ($rbacsystem->checkAccess('write', $this->ref_id)) {
             $this->tabs_gui->addTarget(
                 "settings",
                 $this->ctrl->getLinkTarget($this, "edit"),
                 "edit",
                 "",
                 "",
                 ($ilCtrl->getCmd() === "edit")
             );
         }
 
         // learning progress
         if (ilLearningProgressAccess::checkAccess($this->object->getRefId())) {
             $this->tabs_gui->addTarget(
                 'learning_progress',
                 $this->ctrl->getLinkTargetByClass(['ilobjfoldergui', 'illearningprogressgui'], ''),
                 '',
                 ['illplistofobjectsgui', 'illplistofsettingsgui', 'illearningprogressgui', 'illplistofprogressgui']
             );
         }
 
         if ($ilAccess->checkAccess('write', '', $this->object->getRefId())) {
             $this->tabs_gui->addTarget(
                 'export',
                 $this->ctrl->getLinkTargetByClass('ilexportgui', ''),
                 'export',
                 'ilexportgui'
             );
         }
 
 
         if ($rbacsystem->checkAccess('edit_permission', $this->ref_id)) {
             $this->tabs_gui->addTarget(
                 "perm_settings",
                 $this->ctrl->getLinkTargetByClass([get_class($this), 'ilpermissiongui'], "perm"),
                 ["perm", "info", "owner"],
                 'ilpermissiongui'
             );
         }
     }

Here is the call graph for this function:

◆ infoScreen()

ilObjFolderGUI::infoScreen ( )

Exceptions

ilPermissionException

Definition at line 375 of file class.ilObjFolderGUI.php.

References ilObjectGUI\$access, $GLOBALS, $info, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

Referenced by executeCommand().

                                 : void
     {
         $ilAccess = $this->access;
 
         if (!$ilAccess->checkAccess("visible", "", $this->ref_id)) {
             throw new ilPermissionException($this->lng->txt("msg_no_perm_read"));
         }
 
         $info = new ilInfoScreenGUI($this);
 
         $GLOBALS['ilTabs']->activateTab('info_short');
 
         $info->enablePrivateNotes();
 
         if ($ilAccess->checkAccess("read", "", $this->requested_ref_id)) {
             $info->enableNews();
         }
 
         // no news editing for files, just notifications
         $info->enableNewsEditing(false);
         if ($ilAccess->checkAccess("write", "", $this->requested_ref_id)) {
             $news_set = new ilSetting("news");
             $enable_internal_rss = $news_set->get("enable_rss_for_internal");
 
             if ($enable_internal_rss) {
                 $info->setBlockProperty("news", "settings", '1');
                 $info->setBlockProperty("news", "public_notifications_option", '1');
             }
         }
 
 
         // standard meta data
         $info->addMetaDataSections($this->object->getId(), 0, $this->object->getType());
 
         // forward the command
         $this->ctrl->forwardCommand($info);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ infoScreenObject()

ilObjFolderGUI::infoScreenObject ( )

this one is called from the info button in the repository not very nice to set cmdClass/Cmd manually, if everything works through ilCtrl in the future this may be changed

Definition at line 367 of file class.ilObjFolderGUI.php.

References ILIAS\Repository\ctrl().

                                       : void
     {
         $this->ctrl->redirectByClass(ilInfoScreenGUI::class, "showSummary");
     }

Here is the call graph for this function:

◆ initEditForm()

ilObjFolderGUI::initEditForm ( )

protected

Definition at line 248 of file class.ilObjFolderGUI.php.

References ilContainerGUI\$form, ilObjectGUI\$lng, ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), ILIAS\Repository\ctrl(), ilObjectGUI\getObjectService(), ilObjectGUI\initDidacticTemplate(), ilContainerGUI\initListPresentationForm(), ilContainerGUI\initSortingForm(), ILIAS\Repository\lng(), ilLanguage\loadLanguageModule(), ILIAS\Repository\object(), ilTextAreaInputGUI\setCols(), ilFormGUI\setFormAction(), ilPropertyFormGUI\setTitle(), ilContainer\SORT_CREATION, ilContainer\SORT_INHERIT, ilContainer\SORT_MANUAL, ilContainer\SORT_TITLE, and ilObject\TITLE_LENGTH.

Referenced by editObject().

                                      : ilPropertyFormGUI
     {
         $lng = $this->lng;
         $obj_service = $this->getObjectService();
 
         $lng->loadLanguageModule($this->object->getType());
 
         $form = new ilPropertyFormGUI();
         $form->setFormAction($this->ctrl->getFormAction($this, "update"));
         $form->setTitle($this->lng->txt($this->object->getType() . "_edit"));
 
         // title
         $ti = new ilTextInputGUI($this->lng->txt("title"), "title");
         $ti->setSize(min(40, ilObject::TITLE_LENGTH));
         $ti->setMaxLength(ilObject::TITLE_LENGTH);
         $ti->setRequired(true);
         $form->addItem($ti);
 
         // description
         $ta = new ilTextAreaInputGUI($this->lng->txt("description"), "desc");
         $ta->setCols(40);
         $ta->setRows(2);
         $form->addItem($ta);
 
         // Show didactic template type
         $this->initDidacticTemplate($form);
 
         $pres = new ilFormSectionHeaderGUI();
         $pres->setTitle($this->lng->txt('fold_presentation'));
         $form->addItem($pres);
 
         // title and icon visibility
         $form = $obj_service->commonSettings()->legacyForm($form, $this->object)->addTitleIconVisibility();
 
         // top actions visibility
         $form = $obj_service->commonSettings()->legacyForm($form, $this->object)->addTopActionsVisibility();
 
         // custom icon
         $form = $obj_service->commonSettings()->legacyForm($form, $this->object)->addIcon();
 
         // tile image
         $form = $obj_service->commonSettings()->legacyForm($form, $this->object)->addTileImage();
 
         // list presentation
         $form = $this->initListPresentationForm($form);
 
         $this->initSortingForm(
             $form,
             [
                 ilContainer::SORT_INHERIT,
                 ilContainer::SORT_TITLE,
                 ilContainer::SORT_CREATION,
                 ilContainer::SORT_MANUAL
             ]
         );
 
         $form->addCommandButton("update", $this->lng->txt("save"));
         //$this->form->addCommandButton("cancelUpdate", $lng->txt("cancel"));
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ modifyItemGUI()

ilObjFolderGUI::modifyItemGUI	(	ilObjectListGUI	$a_item_list_gui,
		array	$a_item_data
	)

Definition at line 513 of file class.ilObjFolderGUI.php.

References ilObjectGUI\$tree, ilObjCourse\_lookupAboStatus(), ilObject\_lookupObjId(), ilObjCourseGUI\_modifyItemGUI(), ilTree\checkForParentType(), and ILIAS\Repository\object().

                                                                                        : void
     {
         $tree = $this->tree;
 
         // if folder is in a course, modify item list gui according to course requirements
         if ($course_ref_id = $tree->checkForParentType($this->object->getRefId(), 'crs')) {
             $course_obj_id = ilObject::_lookupObjId($course_ref_id);
             ilObjCourseGUI::_modifyItemGUI(
                 $a_item_list_gui,
                 'ilcoursecontentgui',
                 $a_item_data,
                 ilObjCourse::_lookupAboStatus($course_obj_id),
                 $course_ref_id,
                 $course_obj_id,
                 $this->object->getRefId()
             );
         }
     }

Here is the call graph for this function:

◆ renderObject()

ilObjFolderGUI::renderObject ( )

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

References ilContainerGUI\$tabs, and ilObjectGUI\checkPermission().

Referenced by viewObject().

                                   : void
     {
         $ilTabs = $this->tabs;
 
         $this->checkPermission('read');
 
         $ilTabs->activateTab("view_content");
         parent::renderObject();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFolderTree()

ilObjFolderGUI::setFolderTree ( ilTree $a_tree )

Definition at line 243 of file class.ilObjFolderGUI.php.

                                                  : void
     {
         $this->folder_tree = $a_tree;
     }

◆ setSubTabs()

ilObjFolderGUI::setSubTabs ( string $a_tab )

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

References ilObjectGUI\$lng, ilContainerGUI\$tabs, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilLanguage\txt().

Referenced by editObject(), and executeCommand().

                                              : void
     {
         $ilTabs = $this->tabs;
         $lng = $this->lng;
 
         $ilTabs->addSubTab(
             "settings",
             $lng->txt("fold_settings"),
             $this->ctrl->getLinkTarget($this, 'edit')
         );
 
         $this->tabs_gui->addSubTab(
             "settings_trans",
             $this->lng->txt("obj_multilinguality"),
             $this->ctrl->getLinkTargetByClass(TranslationGUI::class, "")
         );
 
         $ilTabs->activateSubTab($a_tab);
         $ilTabs->activateTab("settings");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showPossibleSubObjects()

ilObjFolderGUI::showPossibleSubObjects ( )

protected

show possible sub objects selection list

Definition at line 535 of file class.ilObjFolderGUI.php.

References ilContainerGUI\$gui, ilObjectGUI\buildAddNewItemElements(), and ilObjectGUI\getCreatableObjectTypes().

                                                : void
     {
         $gui = new ILIAS\ILIASObject\Creation\AddNewItemGUI(
             $this->buildAddNewItemElements(
                 $this->getCreatableObjectTypes()
             )
         );
         $gui->render();
     }

Here is the call graph for this function:

◆ showSummaryObject()

ilObjFolderGUI::showSummaryObject ( )

this one is called from the info button in the repository not very nice to set cmdClass/Cmd manually, if everything works through ilCtrl in the future this may be changed

Definition at line 345 of file class.ilObjFolderGUI.php.

References ILIAS\Repository\ctrl().

                                        : void
     {
         $this->ctrl->redirectByClass(ilInfoScreenGUI::class, "showSummary");
     }

Here is the call graph for this function:

◆ updateCustom()

ilObjFolderGUI::updateCustom ( ilPropertyFormGUI $form )

protected

Definition at line 318 of file class.ilObjFolderGUI.php.

References ilObjectGUI\getObjectService(), ilContainerGUI\saveListPresentation(), and ilContainerGUI\saveSortingSettings().

                                                             : void
     {
         $obj_service = $this->getObjectService();
 
         // title icon visibility
         $obj_service->commonSettings()->legacyForm($form, $this->object)->saveTitleIconVisibility();
 
         // top actions visibility
         $obj_service->commonSettings()->legacyForm($form, $this->object)->saveTopActionsVisibility();
 
         // custom icon
         $obj_service->commonSettings()->legacyForm($form, $this->object)->saveIcon();
 
         // tile image
         $obj_service->commonSettings()->legacyForm($form, $this->object)->saveTileImage();
 
         // list presentation
         $this->saveListPresentation($form);
 
         $this->saveSortingSettings($form);
     }

Here is the call graph for this function:

◆ viewObject()

ilObjFolderGUI::viewObject ( )

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

References $GLOBALS, ilLearningProgress\_tracProgress(), ilObjectGUI\checkPermission(), ILIAS\Survey\Mode\getId(), ILIAS\Repository\object(), and renderObject().

Referenced by executeCommand().

                                 : void
     {
         $this->checkPermission('read');
         if (strtolower($this->folder_request->getBaseClass()) === "iladministrationgui") {
             parent::viewObject();
             return;
         }
 
         // Trac access - see ilObjCourseGUI
         ilLearningProgress::_tracProgress(
             $GLOBALS["ilUser"]->getId(),
             $this->object->getId(),
             $this->object->getRefId(),
             'fold'
         );
 
         $this->renderObject();
         $this->tabs_gui->setTabActive('view_content');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $folder_request

StandardGUIRequest ilObjFolderGUI::$folder_request

protected

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

◆ $folder_tree

ilTree ilObjFolderGUI::$folder_tree

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

◆ $help

ilHelpGUI ilObjFolderGUI::$help

protected

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

Referenced by getTabs().

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

components/ILIAS/Folder/classes/class.ilObjFolderGUI.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _goto()

◆ afterSave()

◆ deleteObject()

◆ editObject()

◆ executeCommand()

◆ forwardToTimingsView()

◆ getEditFormCustomValues()

◆ getTabs()

◆ infoScreen()

◆ infoScreenObject()

◆ initEditForm()

◆ modifyItemGUI()

◆ renderObject()

◆ setFolderTree()

◆ setSubTabs()

◆ showPossibleSubObjects()

◆ showSummaryObject()

◆ updateCustom()

◆ viewObject()

Field Documentation

◆ $folder_request

◆ $folder_tree

◆ $help