Inheritance diagram for ilObjFolderGUI:

Collaboration diagram for ilObjFolderGUI:

Public Member Functions
	__construct ($a_data, $a_id=0, $a_call_by_reference=true, $a_prepare_output=false)
	Constructor public. More...

	viewObject ()
	View folder. More...

	renderObject ()
	Render folder. More...

	executeCommand ()

	setFolderTree ($a_tree)
	set tree More...

	importFileObject ($parent_id=null, $a_catch_errors=true)
	Import file object type $lng. More...

	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 ()
	show information screen More...

	getTabs ()
	Get tabs. More...

	downloadFolderObject ()

	modifyItemGUI ($a_item_list_gui, $a_item_data, $a_show_path)
	Modify Item ListGUI for presentation in container type $tree. More...

	editObject ()
	Edit. More...

	setSubTabs ($a_tab)
	Set sub tabs. More...

	editIconsObject ($a_form=null)
	Edit folder icons. More...

	initIconsForm ()

	updateIconsObject ()
	update container icons More...

Public Member Functions inherited from ilObjectGUI
	executeCommand ()
	execute command More...

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

	setCreationMode ($a_mode=true)
	if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui More...

	getCreationMode ()
	get creation mode More...

	prepareOutput ($a_show_subobjects=true)
	prepare output More...

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

	getHTML ()

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

	cancelDeleteObject ()
	cancel deletion of object More...

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

	createObject ()
	create new object form More...

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

	saveObject ()
	save object More...

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

	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...

	editObject ()
	edit object More...

	addExternalEditFormCustom (ilPropertyFormGUI $a_form)

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

	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g. More...

	isVisible ($a_ref_id, $a_type)

	viewObject ()
	list childs of current object More...

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

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

Public Member Functions inherited from ilContainerGUI
	__construct ($a_data, $a_id, $a_call_by_reference=true, $a_prepare_output=true)
	Constructor public. More...

	executeCommand ()
	execute command note: this method is overwritten in all container objects More...

	forwardToStyleSheet ()
	Forward to style object. More...

&	forwardToPageObject ()
	forward command to page object More...

	addPageTabs ()
	Add page tabs. More...

	getContainerPageHTML ()
	Get container page HTML. More...

	prepareOutput ($a_show_subobjects=true)
	prepare output More...

	showTreeFlatIcon ()

	setTitleAndDescription ()
	called by prepare output More...

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

	getContentGUI ()
	Get content gui object. More...

	renderObject ()
	render the object More...

	setContentSubTabs ()
	Set content sub tabs. More...

	showAdministrationPanel (&$tpl)
	show administration panel More...

	__showTimingsButton (&$tpl)

	showPermanentLink (&$tpl)
	show permanent link More...

	switchToStdEditorObject ()
	Switch to standard page editor. More...

	switchToOldEditorObject ()
	Switch to old page editor. More...

	useNewEditorObject ()
	Use new editor (-> delete xhtml content page) More...

	editPageFrameObject ()
	show page editor frameset More...

	editPageContentObject ()
	edit page content (for repository root node and categories) More...

	savePageContentObject ()

	cancelPageContentObject ()

	showLinkListObject ()

	clearAdminCommandsDetermination ()
	cleaer administration commands determination More...

&	newBlockTemplate ()
	determin admin commands More...

	addHeaderRow (&$a_tpl, $a_type, $a_show_image=true)
	adds a header row to a block template More...

	addStandardRow (&$a_tpl, $a_html, $a_item_ref_id="", $a_item_obj_id="", $a_image_type="")
	adds a standard row to a block template More...

	addMessageRow (&$a_tpl, $a_message, $a_type)
	add message row More...

	resetRowType ()

	setPageEditorTabs ()
	Add page editor tabs. More...

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

	getTabs ()
	common tabs for all container objects (should be called at the end of child getTabs() method More...

	enableAdministrationPanelObject ()
	enable administration panel More...

	disableAdministrationPanelObject ()
	enable administration panel More...

	editOrderObject ()
	Edit order. More...

	isActiveOrdering ()
	Check if ordering is enabled. More...

	isActiveItemOrdering ()
	Check if item ordering is enabled. More...

	addToDeskObject ()

	removeFromDeskObject ()

	enableMultiDownloadObject ()

	isMultiDownloadEnabled ()

	lockObject ()

	cutObject ()
	cut object(s) out from a container and write the information to clipboard 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 ()

	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 ()
	Show paste tree. More...

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

	keepObjectsInClipboardObject ()
	Keep objects in the clipboard. More...

	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 ()
	show clipboard More...

	showCustomIconsEditing ($a_input_colspan=1, ilPropertyFormGUI $a_form=null, $a_as_section=true)
	show edit section of custom icons for container More...

	isActiveAdministrationPanel ()

	setColumnSettings (ilColumnGUI $column_gui)
	May be overwritten in subclasses. More...

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

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

	cloneWizardPageTreeObject ()
	public More...

	cloneWizardPageListObject ()
	public More...

	cloneWizardPageObject ($a_tree_view=true)
	Show clone wizard page for container objects. More...

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

	saveSortingObject ()
	Save Sorting. More...

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

	modifyItemGUI ($a_item_list_gui, $a_item_data, $a_show_path)
	Modify list gui for presentation in container type $lng. More...

	editStylePropertiesObject ()
	Edit style properties. More...

	initStylePropertiesForm ()
	Init style properties form. More...

	createStyleObject ()
	Create Style. More...

	editStyleObject ()
	Edit Style. More...

	deleteStyleObject ()
	Delete Style. More...

	saveStyleSettingsObject ()
	Save style settings. More...

	getAsynchItemListObject ()
	Get item list command drop down asynchronously. More...

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

	showRepTree ()
	Show tree. More...

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

	removeFromSystemObject ()
	remove objects from trash bin and all entries therefore every object needs a specific deleteObject() method More...

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

	confirmRemoveFromSystemObject ()
	confirmation screen remove from system More...

	setSideColumnReturn ()
	Set return point for side column actions. More...

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

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

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

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

Data Fields
	$folder_tree

Data Fields inherited from ilObjectGUI
const	COPY_WIZARD_NEEDS_PAGE = 1

	$objDefinition

	$tpl

	$tree

	$lng

	$data

	$object

	$ref_id

	$obj_id

	$maxcount

	$formaction

	$return_location

	$target_frame

	$tab_target_script

	$actions

	$sub_objects

	$omit_locator = false

const	CFORM_NEW = 1

const	CFORM_IMPORT = 2

const	CFORM_CLONE = 3

Data Fields inherited from ilContainerGUI
	$bl_cnt = 1

	$multi_download_enabled = false

Protected Member Functions
	initEditCustomForm (ilPropertyFormGUI $a_form)

	getEditFormCustomValues (array &$a_values)

	updateCustom (ilPropertyFormGUI $a_form)

	afterSave (ilObject $a_new_object)

	forwardToTimingsView ()

Protected Member Functions inherited from ilObjectGUI
	assignObject ()

	setTitleAndDescription ()
	called by prepare output More...

	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...

	insertHeaderAction ($a_list_gui)
	Insert header action into main template. More...

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

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

	showMountWebfolderIcon ()

	setTabs ()
	set admin tabs public More...

	setAdminTabs ()
	set admin tabs public More...

	setLocator ()
	set Locator More...

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

	omitLocator ($a_omit=true)

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

	initCreationForms ($a_new_type)
	Init creation froms. More...

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

	initCreateForm ($a_new_type)
	Init object creation form. More...

	initDidacticTemplate (ilPropertyFormGUI $form)
	Show didactic template types. More...

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

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

	initEditForm ()
	Init object edit form. More...

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

	getEditFormValues ()
	Get values for edit form. More...

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

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

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

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

	initImportForm ($a_new_type)
	Init object import form. More...

	importFileObject ($parent_id=null, $a_catch_errors=true)
	Import. More...

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

	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command More...

	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g. More...

	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command More...

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

	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command More...

	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) More...

	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl. More...

	getTabs ()
	get tabs abstract method. More...

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

	hitsperpageObject ()

&	__initTableGUI ()

	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	standard implementation for tables use 'from' variable use different initial setting of table More...

	redirectToRefId ($a_ref_id, $a_cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current $_GET["ref_id"] value More...

	fillCloneTemplate ($a_tpl_varname, $a_type)
	Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More...

	getCenterColumnHTML ()
	Get center column. More...

	getRightColumnHTML ()
	Display right column. More...

	setColumnSettings (ilColumnGUI $column_gui)
	May be overwritten in subclasses. More...

	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error. More...

	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission. More...

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

	handleAutoRating (ilObject $a_new_obj)
	Activate rating automatically if parent container setting. More...

Protected Member Functions inherited from ilContainerGUI
	getEditFormValues ()
	Get values for edit form. More...

	afterUpdate ()

	showPasswordInstructionObject ($a_init=true)
	Show webdav password instruction. More...

	initFormPasswordInstruction ()
	Init password form. More...

	savePasswordObject ()
	Save password. More...

	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add file manager link. More...

	fileManagerLaunchObject ()
	Launch jnlp. More...

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

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

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

	saveSortingSettings (ilPropertyFormGUI $form)
	Save sorting settings. More...

	getTreeSelectorGUI ($cmd)

Protected Attributes
	$help

Protected Attributes inherited from ilObjectGUI
	$ilErr

	$locator

	$user

	$access

	$settings

	$rbacreview

	$toolbar

	$rbacsystem

	$tmp_import_dir

	$tabs_gui = null

	$ctrl

Protected Attributes inherited from ilContainerGUI
	$rbacsystem

	$tabs

	$settings

	$user

	$db

	$access

	$error

	$obj_definition

	$rbacadmin

	$rbacreview

	$log

	$obj_data_cache

	$toolbar

	$plugin_admin

	$app_event_handler

Detailed Description

Class ilObjFolderGUI.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e $Id$

ilObjFolderGUI: ilPermissionGUI ilObjFolderGUI: ilCourseContentGUI, ilLearningProgressGUI ilObjFolderGUI: ilInfoScreenGUI, ilContainerPageGUI, ilColumnGUI ilObjFolderGUI: ilObjectCopyGUI, ilObjStyleSheetGUI ilObjFolderGUI: ilExportGUI, ilCommonActionDispatcherGUI, ilDidacticTemplateGUI ilObjFolderGUI: ilBackgroundTaskHub

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor public.

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

References $DIC, settings(), and 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, false);
     }

Here is the call graph for this function:

Member Function Documentation

◆ _goto()

static ilObjFolderGUI::_goto ( $a_target )

static

goto target group

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

References $DIC, ilObjectGUI\$ilErr, ilObjectGUI\$lng, and ilObjectGUI\_gotoRepositoryNode().

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

Here is the call graph for this function:

◆ afterSave()

ilObjFolderGUI::afterSave ( ilObject $a_new_object )

protected

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

References ilObject\getId(), ilObject\getRefId(), ilObjectGUI\redirectToRefId(), ilUtil\sendSuccess(), ilContainerSortingSettings\setSortMode(), and ilContainer\SORT_INHERIT.

     {
         include_once './Services/Container/classes/class.ilContainerSortingSettings.php';
         $sort = new ilContainerSortingSettings($a_new_object->getId());
         $sort->setSortMode(ilContainer::SORT_INHERIT);
         $sort->update();
         
         // always send a message
         ilUtil::sendSuccess($this->lng->txt("fold_added"), true);
         $this->ctrl->setParameter($this, "ref_id", $a_new_object->getRefId());
         $this->redirectToRefId($a_new_object->getRefId(), "");
     }

Here is the call graph for this function:

◆ downloadFolderObject()

ilObjFolderGUI::downloadFolderObject ( )

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

References ilContainerGUI\$access, ilContainerGUI\$error, $filename, ilObjectGUI\$ilErr, ilObjectGUI\$lng, ilUtil\deliverFile(), ilUtil\getASCIIFilename(), and object.

     {
         $ilAccess = $this->access;
         $ilErr = $this->error;
         $lng = $this->lng;
             
         if (!$ilAccess->checkAccess("read", "", $this->ref_id)) {
             $this->ilias->raiseError($this->lng->txt("msg_no_perm_read"), $this->ilias->error_obj->MESSAGE);
         }
         $filename = $this->object->downloadFolder();
         ilUtil::deliverFile($filename, ilUtil::getASCIIFilename($this->object->getTitle() . ".zip"));
     }

Here is the call graph for this function:

◆ editIconsObject()

ilObjFolderGUI::editIconsObject ( $a_form = null )

Edit folder icons.

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

References ilObjectGUI\$tpl, ilObjectGUI\checkPermission(), and initIconsForm().

Referenced by updateIconsObject().

     {
         $tpl = $this->tpl;
 
         $this->checkPermission('write');
     
         $this->tabs_gui->setTabActive('settings');
         
         if (!$a_form) {
             $a_form = $this->initIconsForm();
         }
         
         $tpl->setContent($a_form->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ editObject()

ilObjFolderGUI::editObject ( )

Edit.

Parameters

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

References ilContainerGUI\$error, $form, $GLOBALS, ilObjectGUI\$ilErr, ilContainerGUI\$tabs, ilObjectGUI\checkPermissionBool(), ilContainerGUI\getEditFormValues(), ilObjectGUI\initEditForm(), and setSubTabs().

     {
         $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 98 of file class.ilObjFolderGUI.php.

References $_GET, ilObjectGUI\$ctrl, $ilCtrl, $ilUser, $ret, ilContainerGUI\$user, ilObjectGUI\addHeaderAction(), ilObjectGUI\checkPermission(), ilContainerGUI\forwardToPageObject(), ilContainerGUI\forwardToStyleSheet(), forwardToTimingsView(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), infoScreen(), ilLearningProgressBaseGUI\LP_CONTEXT_REPOSITORY, object, ilContainerGUI\prepareOutput(), ilContainerGUI\showRepTree(), and viewObject().

     {
         $ilUser = $this->user;
         $ilCtrl = $this->ctrl;
 
         $next_class = $this->ctrl->getNextClass($this);
         $cmd = $this->ctrl->getCmd();
         
         // show repository tree
         $this->showRepTree();
 
         switch ($next_class) {
             case 'ilpermissiongui':
                 $this->prepareOutput();
                 $this->tabs_gui->setTabActive('perm_settings');
                 include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
                 $perm_gui = new ilPermissionGUI($this);
                 $ret =&$this->ctrl->forwardCommand($perm_gui);
                 break;
 
             case 'ilcoursecontentgui':
                 $this->prepareOutput();
                 include_once './Modules/Course/classes/class.ilCourseContentGUI.php';
                 $course_content_obj = new ilCourseContentGUI($this);
                 $this->ctrl->forwardCommand($course_content_obj);
                 break;
             
             case "illearningprogressgui":
                 $this->prepareOutput();
                 include_once './Services/Tracking/classes/class.ilLearningProgressGUI.php';
                 
                 $new_gui = new ilLearningProgressGUI(
                     ilLearningProgressGUI::LP_CONTEXT_REPOSITORY,
                     $this->object->getRefId(),
                     $_GET['user_id'] ? $_GET['user_id'] : $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);
                 }
                 break;
 
             case 'ilinfoscreengui':
                 $this->prepareOutput();
                 $this->infoScreen();
                 break;
 
             case 'ilobjectcopygui':
                 $this->prepareOutput();
 
                 include_once './Services/Object/classes/class.ilObjectCopyGUI.php';
                 $cp = new ilObjectCopyGUI($this);
                 $cp->setType('fold');
                 $this->ctrl->forwardCommand($cp);
                 break;
 
             case "ilobjstylesheetgui":
                 $this->forwardToStyleSheet();
                 break;
                 
             case 'ilexportgui':
                 $this->prepareOutput();
                     
                 $this->tabs_gui->setTabActive('export');
                 include_once './Services/Export/classes/class.ilExportGUI.php';
                 $exp = new ilExportGUI($this);
                 $exp->addFormat('xml');
                 $this->ctrl->forwardCommand($exp);
                 break;
             
             case "ilcommonactiondispatchergui":
                 include_once("Services/Object/classes/class.ilCommonActionDispatcherGUI.php");
                 $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                 $this->ctrl->forwardCommand($gui);
                 break;
 
             case 'ildidactictemplategui':
                 $this->ctrl->setReturn($this, 'edit');
                 include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateGUI.php';
                 $did = new ilDidacticTemplateGUI($this);
                 $this->ctrl->forwardCommand($did);
                 break;
             case 'ilcolumngui':
                 $this->tabs_gui->setTabActive('none');
                 $this->checkPermission("read");
                 $this->viewObject();
                 break;
             
             case 'ilbackgroundtaskhub':
                 include_once './Services/BackgroundTask/classes/class.ilBackgroundTaskHub.php';
                 $bggui = new ilBackgroundTaskHub();
                 $this->ctrl->forwardCommand($bggui);
                 break;
 
             default:
 
                 $this->prepareOutput();
                 // Dirty hack for course timings view
                 if ($this->forwardToTimingsView()) {
                     break;
                 }
 
                 if (empty($cmd)) {
                     $cmd = "view";
                 }
                 $cmd .= "Object";
                 $this->$cmd();
                 break;
         }
         
         $this->addHeaderAction();
     }

Here is the call graph for this function:

◆ forwardToTimingsView()

ilObjFolderGUI::forwardToTimingsView ( )

protected

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

References $_SESSION, ilObjectGUI\$tree, ilObject\_lookupObjId(), ilObjCourse\_lookupViewMode(), and ilContainer\VIEW_TIMING.

Referenced by executeCommand().

     {
         $tree = $this->tree;
         
         if (!$crs_ref = $tree->checkForParentType($this->ref_id, 'crs')) {
             return false;
         }
         include_once './Modules/Course/classes/class.ilObjCourse.php';
         if (!$this->ctrl->getCmd() and ilObjCourse::_lookupViewMode(ilObject::_lookupObjId($crs_ref)) == ilContainer::VIEW_TIMING) {
             if (!isset($_SESSION['crs_timings'])) {
                 $_SESSION['crs_timings'] = true;
             }
             
             if ($_SESSION['crs_timings'] == true) {
                 include_once './Modules/Course/classes/class.ilCourseContentGUI.php';
                 $course_content_obj = new ilCourseContentGUI($this);
                 $this->ctrl->setCmdClass(get_class($course_content_obj));
                 $this->ctrl->setCmd('editUserTimings');
                 $this->ctrl->forwardCommand($course_content_obj);
                 return true;
             }
         }
         $_SESSION['crs_timings'] = false;
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEditFormCustomValues()

ilObjFolderGUI::getEditFormCustomValues ( array & $a_values )

protected

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

References ilContainerSortingSettings\getSortMode(), and object.

     {
         // we cannot use $this->object->getOrderType()
         // if set to inherit it will be translated to parent setting
         include_once './Services/Container/classes/class.ilContainerSortingSettings.php';
         $sort = new ilContainerSortingSettings($this->object->getId());
         $a_values["sor"] = $sort->getSortMode();
     }

Here is the call graph for this function:

◆ getTabs()

ilObjFolderGUI::getTabs ( )

Get tabs.

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

References $_GET, $_SESSION, ilContainerGUI\$access, ilObjectGUI\$ctrl, $help, $ilCtrl, ilObjectGUI\$lng, ilContainerGUI\$rbacsystem, array, ilLearningProgressAccess\checkAccess(), and object.

     {
         $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 ($rbacsystem->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($_GET["cmdClass"]) == "ilnotegui")
                 ? true
                 : false;
             $this->tabs_gui->addTarget(
                 "info_short",
                 $this->ctrl->getLinkTargetByClass(
                     array("ilobjfoldergui", "ilinfoscreengui"),
                     "showSummary"
                 ),
                 array("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
         include_once './Services/Tracking/classes/class.ilLearningProgressAccess.php';
         if (ilLearningProgressAccess::checkAccess($this->object->getRefId())) {
             $this->tabs_gui->addTarget(
                 'learning_progress',
                 $this->ctrl->getLinkTargetByClass(array('ilobjfoldergui','illearningprogressgui'), ''),
                 '',
                 array('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(array(get_class($this),'ilpermissiongui'), "perm"),
                 array("perm","info","owner"),
                 'ilpermissiongui'
             );
         }
 
         // show clipboard in repository
         if ($_GET["baseClass"] == "ilRepositoryGUI" and !empty($_SESSION['il_rep_clipboard'])) {
             $this->tabs_gui->addTarget(
                 "clipboard",
                 $this->ctrl->getLinkTarget($this, "clipboard"),
                 "clipboard",
                 get_class($this)
             );
         }
     }

Here is the call graph for this function:

◆ importFileObject()

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

Import file object type $lng.

Parameters

type	$parent_id
type	$a_catch_errors

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

References ilObjectGUI\$lng, and ilUtil\sendSuccess().

     {
         $lng = $this->lng;
         
         if (parent::importFileObject($parent_id, $a_catch_errors)) {
             ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
             $this->ctrl->returnToParent($this);
         }
     }

Here is the call graph for this function:

◆ infoScreen()

ilObjFolderGUI::infoScreen ( )

show information screen

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

References $_GET, ilContainerGUI\$access, $GLOBALS, $info, and object.

Referenced by executeCommand(), infoScreenObject(), and showSummaryObject().

     {
         $ilAccess = $this->access;
 
         if (!$ilAccess->checkAccess("visible", "", $this->ref_id)) {
             $this->ilias->raiseError($this->lng->txt("msg_no_perm_read"), $this->ilias->error_obj->MESSAGE);
         }
 
         include_once("./Services/InfoScreen/classes/class.ilInfoScreenGUI.php");
         $info = new ilInfoScreenGUI($this);
         
         $GLOBALS['ilTabs']->activateTab('info_short');
 
         $info->enablePrivateNotes();
         
         if ($ilAccess->checkAccess("read", "", $_GET["ref_id"])) {
             $info->enableNews();
         }
 
         // no news editing for files, just notifications
         $info->enableNewsEditing(false);
         if ($ilAccess->checkAccess("write", "", $_GET["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", true);
                 $info->setBlockProperty("news", "public_notifications_option", true);
             }
         }
 
         
         // standard meta data
         $info->addMetaDataSections($this->object->getId(), 0, $this->object->getType());
         
         // forward the command
         $this->ctrl->forwardCommand($info);
     }

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 305 of file class.ilObjFolderGUI.php.

References infoScreen().

     {
         $this->ctrl->setCmd("showSummary");
         $this->ctrl->setCmdClass("ilinfoscreengui");
         $this->infoScreen();
     }

Here is the call graph for this function:

◆ initEditCustomForm()

ilObjFolderGUI::initEditCustomForm ( ilPropertyFormGUI $a_form )

protected

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

References array, ilObjectGUI\initDidacticTemplate(), ilContainerGUI\initSortingForm(), ilContainer\SORT_CREATION, ilContainer\SORT_INHERIT, ilContainer\SORT_MANUAL, and ilContainer\SORT_TITLE.

     {
         // Show didactic template type
         $this->initDidacticTemplate($a_form);
         
         $this->initSortingForm(
             $a_form,
             array(
                 ilContainer::SORT_INHERIT,
                 ilContainer::SORT_TITLE,
                 ilContainer::SORT_CREATION,
                 ilContainer::SORT_MANUAL
             )
         );
     }

Here is the call graph for this function:

◆ initIconsForm()

ilObjFolderGUI::initIconsForm ( )

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

References $form, setSubTabs(), and ilContainerGUI\showCustomIconsEditing().

Referenced by editIconsObject(), and updateIconsObject().

     {
         $this->setSubTabs("icons");
         
         include_once "Services/Form/classes/class.ilPropertyFormGUI.php";
         $form = new ilPropertyFormGUI();
         $form->setFormAction($this->ctrl->getFormAction($this));
         
         $this->showCustomIconsEditing(1, $form);
         
         // $form->setTitle($this->lng->txt('edit_grouping'));
         $form->addCommandButton('updateIcons', $this->lng->txt('save'));
         
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ modifyItemGUI()

ilObjFolderGUI::modifyItemGUI	(	$a_item_list_gui,
		$a_item_data,
		$a_show_path
	)

Modify Item ListGUI for presentation in container type $tree.

Parameters

type	$a_item_list_gui
type	$a_item_data
type	$a_show_path

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

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

     {
         $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')) {
             include_once("./Modules/Course/classes/class.ilObjCourse.php");
             include_once("./Modules/Course/classes/class.ilObjCourseGUI.php");
             $course_obj_id = ilObject::_lookupObjId($course_ref_id);
             ilObjCourseGUI::_modifyItemGUI(
                 $a_item_list_gui,
                 'ilcoursecontentgui',
                 $a_item_data,
                 $a_show_path,
                 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 ( )

Render folder.

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

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

Referenced by viewObject().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFolderTree()

ilObjFolderGUI::setFolderTree ( $a_tree )

set tree

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

     {
         $this->folder_tree =&$a_tree;
     }

◆ setSubTabs()

ilObjFolderGUI::setSubTabs ( $a_tab )

Set sub tabs.

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

References ilObjectGUI\$lng, and ilContainerGUI\$tabs.

Referenced by editObject(), and initIconsForm().

     {
         $ilTabs = $this->tabs;
         $lng = $this->lng;
         
         $ilTabs->addSubTab(
             "settings",
             $lng->txt("fold_settings"),
             $this->ctrl->getLinkTarget($this, 'edit')
         );
         
         // custom icon
         if ($this->ilias->getSetting("custom_icons")) {
             $ilTabs->addSubTab(
                 "icons",
                 $lng->txt("icon_settings"),
                 $this->ctrl->getLinkTarget($this, 'editIcons')
             );
         }
         
         $ilTabs->activateSubTab($a_tab);
         $ilTabs->activateTab("settings");
     }

Here is the caller 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 280 of file class.ilObjFolderGUI.php.

References infoScreen().

     {
         $this->ctrl->setCmd("showSummary");
         $this->ctrl->setCmdClass("ilinfoscreengui");
         $this->infoScreen();
     }

Here is the call graph for this function:

◆ updateCustom()

ilObjFolderGUI::updateCustom ( ilPropertyFormGUI $a_form )

protected

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

References ilContainerGUI\saveSortingSettings().

     {
         $this->saveSortingSettings($a_form);
     }

Here is the call graph for this function:

◆ updateIconsObject()

ilObjFolderGUI::updateIconsObject ( )

update container icons

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

References $_POST, $form, $ilSetting, ilContainerGUI\$settings, ilObjectGUI\checkPermission(), editIconsObject(), initIconsForm(), and ilUtil\sendSuccess().

     {
         $ilSetting = $this->settings;
 
         $this->checkPermission('write');
         
         $form = $this->initIconsForm();
         if ($form->checkInput()) {
             //save custom icons
             if ($ilSetting->get("custom_icons")) {
                 if ($_POST["cont_icon_delete"]) {
                     $this->object->removeCustomIcon();
                 }
                 $this->object->saveIcons($_FILES["cont_icon"]['tmp_name']);
             }
             if ($_FILES["cont_icon"]['tmp_name'] || $_POST["cont_icon_delete"]) {
                 ilUtil::sendSuccess($this->lng->txt("msg_obj_modified"), true);
             }
             $this->ctrl->redirect($this, "editIcons");
         }
 
         $form->setValuesByPost();
         $this->editIconsObject($form);
     }

Here is the call graph for this function:

◆ viewObject()

ilObjFolderGUI::viewObject ( )

View folder.

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

References $_GET, $GLOBALS, ilObjectGUI\$tree, ilLearningProgress\_tracProgress(), ilObjectGUI\checkPermission(), object, and renderObject().

Referenced by executeCommand().

     {
         $tree = $this->tree;
         
         $this->checkPermission('read');
 
         if (strtolower($_GET["baseClass"]) == "iladministrationgui") {
             parent::viewObject();
             return true;
         }
         
         // Trac access - see ilObjCourseGUI
         include_once 'Services/Tracking/classes/class.ilLearningProgress.php';
         ilLearningProgress::_tracProgress(
             $GLOBALS["ilUser"]->getId(),
             $this->object->getId(),
             $this->object->getRefId(),
             'fold'
         );
         
         $this->renderObject();
         $this->tabs_gui->setTabActive('view_content');
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $folder_tree

ilObjFolderGUI::$folder_tree

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

◆ $help

ilObjFolderGUI::$help

protected

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

Referenced by getTabs().

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

Modules/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()

◆ downloadFolderObject()

◆ editIconsObject()

◆ editObject()

◆ executeCommand()

◆ forwardToTimingsView()

◆ getEditFormCustomValues()

◆ getTabs()

◆ importFileObject()

◆ infoScreen()

◆ infoScreenObject()

◆ initEditCustomForm()

◆ initIconsForm()

◆ modifyItemGUI()

◆ renderObject()

◆ setFolderTree()

◆ setSubTabs()

◆ showSummaryObject()

◆ updateCustom()

◆ updateIconsObject()

◆ viewObject()

Field Documentation

◆ $folder_tree

◆ $help