ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
ilObjFolderGUI Class Reference

Class ilObjFolderGUI. More...

+ 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 @access public. More...
 
 viewObject ()
 View folder. More...
 
 renderObject ()
 Render folder. More...
 
 executeCommand ()
 execute command note: this method is overwritten in all container objects More...
 
 setFolderTree ($a_tree)
 set tree More...
 
 importFileObject ($parent_id=null, $a_catch_errors=true)
 Import file object @global 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 @global 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 @access public More...
 
 createObject ()
 create new object form More...
 
 cancelCreation ()
 cancel create action and go back to repository parent More...
 
 saveObject ()
 save object More...
 
 editObject ()
 edit object More...
 
 addExternalEditFormCustom (ilPropertyFormGUI $a_form)
 
 updateObject ()
 updates object entry in object_data More...
 
 getFormAction ($a_cmd, $a_formaction="")
 get form action for command (command is method name without "Object", e.g. More...
 
 isVisible ($a_ref_id, $a_type)
 
 viewObject ()
 list childs of current object More...
 
 deleteObject ($a_error=false)
 Display deletion confirmation screen. More...
 
 cloneAllObject ()
 Clone single (not container object) Method is overwritten in ilContainerGUI. More...
 
- Public Member Functions inherited from ilContainerGUI
 __construct ($a_data, $a_id, $a_call_by_reference=true, $a_prepare_output=true)
 Constructor @access 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...
 
 getAllNestedCategories ($ref_id)
 
 __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 ()
 @access public More...
 
 cloneWizardPageListObject ()
 @access 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 @global 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...
 
 addToDeskObject ()
 Add desktop item @access public. More...
 
 removeFromDeskObject ()
 Remove from desktop @access public. 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
 
 $ilias
 
 $objDefinition
 
 $tpl
 
 $tree
 
 $lng
 
 $data
 
 $object
 
 $ref_id
 
 $obj_id
 
 $maxcount
 
 $formaction
 
 $return_location
 
 $target_frame
 
 $tab_target_script
 
 $actions
 
 $sub_objects
 
 $omit_locator = false
 
const CFORM_NEW = 1
 
const CFORM_IMPORT = 2
 
const CFORM_CLONE = 3
 
- Data Fields inherited from ilContainerGUI
 $bl_cnt = 1
 
 $multi_download_enabled = false
 

Protected Member Functions

 initEditCustomForm (ilPropertyFormGUI $a_form)
 Add custom fields to update form. More...
 
 getEditFormCustomValues (array &$a_values)
 Add values to custom edit fields. More...
 
 updateCustom (ilPropertyFormGUI $a_form)
 Insert custom update form values into object. More...
 
 afterSave (ilObject $a_new_object)
 Post (successful) object creation hook. More...
 
 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 @access public More...
 
 setAdminTabs ()
 set admin tabs @access public More...
 
 setLocator ()
 set Locator More...
 
 addLocatorItems ()
 should be overwritten to add object specific items (repository items are preloaded) More...
 
 omitLocator ($a_omit=true)
 
 addAdminLocatorItems ($a_do_not_add_object=false)
 should be overwritten to add object specific items (repository items are preloaded) More...
 
 initCreationForms ($a_new_type)
 Init creation froms. More...
 
 getCreationFormsHTML (array $a_forms)
 Get HTML for creation forms (accordion) More...
 
 initCreateForm ($a_new_type)
 Init object creation form. More...
 
 initDidacticTemplate (ilPropertyFormGUI $form)
 Show didactic template types. More...
 
 addDidacticTemplateOptions (array &$a_options)
 Add custom templates. More...
 
 getDidacticTemplateVar ($a_type)
 Get didactic template setting from creation screen. More...
 
 putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
 Add object to tree at given position. More...
 
 afterSave (ilObject $a_new_object)
 Post (successful) object creation hook. More...
 
 initEditForm ()
 Init object edit form. More...
 
 initEditCustomForm (ilPropertyFormGUI $a_form)
 Add custom fields to update form. More...
 
 getEditFormValues ()
 Get values for edit form. More...
 
 getEditFormCustomValues (array &$a_values)
 Add values to custom edit fields. More...
 
 validateCustom (ilPropertyFormGUI $a_form)
 Validate custom values (if not possible with checkInput()) More...
 
 updateCustom (ilPropertyFormGUI $a_form)
 Insert custom update form values into object. More...
 
 afterUpdate ()
 Post (successful) object update hook. More...
 
 initImportForm ($a_new_type)
 Init object import form. More...
 
 importFileObject ($parent_id=null, $a_catch_errors=true)
 Import. More...
 
 afterImport (ilObject $a_new_object)
 Post (successful) object import hook. More...
 
 setFormAction ($a_cmd, $a_formaction)
 set specific form action for command More...
 
 getReturnLocation ($a_cmd, $a_location="")
 get return location for command (command is method name without "Object", e.g. More...
 
 setReturnLocation ($a_cmd, $a_location)
 set specific return location for command More...
 
 getTargetFrame ($a_cmd, $a_target_frame="")
 get target frame for command (command is method name without "Object", e.g. More...
 
 setTargetFrame ($a_cmd, $a_target_frame)
 set specific target frame for command More...
 
 showPossibleSubObjects ()
 show possible subobjects (pulldown menu) More...
 
 getTemplateFile ($a_cmd, $a_type="")
 get a template blockfile format: tpl. More...
 
 getTabs ()
 get tabs abstract method. More...
 
 __showButton ($a_cmd, $a_text, $a_target='')
 
 hitsperpageObject ()
 
__initTableGUI ()
 
 __setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
 standard implementation for tables use 'from' variable use different initial setting of table More...
 
 redirectToRefId ($a_ref_id, $a_cmd="")
 redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current $_GET["ref_id"] value More...
 
 fillCloneTemplate ($a_tpl_varname, $a_type)
 Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More...
 
 getCenterColumnHTML ()
 Get center column. More...
 
 getRightColumnHTML ()
 Display right column. More...
 
 setColumnSettings (ilColumnGUI $column_gui)
 May be overwritten in subclasses. More...
 
 checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
 Check permission and redirect on error. More...
 
 checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
 Check permission. More...
 
 enableDragDropFileUpload ()
 Enables the file upload into this object by dropping files. More...
 
 handleAutoRating (ilObject $a_new_obj)
 Activate rating automatically if parent container setting. More...
 
- Protected Member Functions inherited from ilContainerGUI
 getEditFormValues ()
 Get values for edit form. More...
 
 afterUpdate ()
 Post (successful) object update hook. More...
 
 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)
 

Additional Inherited Members

- Protected Attributes inherited from ilObjectGUI
 $tmp_import_dir
 
 $tabs_gui = null
 
 $ctrl
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

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

Constructor @access public.

Reimplemented from ilContainerGUI.

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

32 {
33 $this->type = "fold";
34 parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output, false);
35 }

Member Function Documentation

◆ _goto()

static ilObjFolderGUI::_goto (   $a_target)
static

goto target group

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

416 {
417 global $ilAccess, $ilErr, $lng;
418
419 if ($ilAccess->checkAccess("read", "", $a_target))
420 {
422 }
423 $ilErr->raiseError($lng->txt("msg_no_perm_read"), $ilErr->FATAL);
424 }
static _gotoRepositoryNode($a_ref_id, $a_cmd="frameset")
Goto repository root.
global $ilErr
Definition: raiseError.php:16

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

+ Here is the call graph for this function:

◆ afterSave()

ilObjFolderGUI::afterSave ( ilObject  $a_new_object)
protected

Post (successful) object creation hook.

Parameters
ilObject$a_new_object

Reimplemented from ilObjectGUI.

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

269 {
270 include_once './Services/Container/classes/class.ilContainerSortingSettings.php';
271 $sort = new ilContainerSortingSettings($a_new_object->getId());
272 $sort->setSortMode(ilContainer::SORT_INHERIT);
273 $sort->update();
274
275 // always send a message
276 ilUtil::sendSuccess($this->lng->txt("fold_added"),true);
277 $this->ctrl->setParameter($this, "ref_id", $a_new_object->getRefId());
278 $this->redirectToRefId($a_new_object->getRefId(), "");
279 }
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 sav...
getRefId()
get reference id @access public
getId()
get object id @access public
static sendSuccess($a_info="", $a_keep=false)
Send Success Message to Screen.

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

+ Here is the call graph for this function:

◆ downloadFolderObject()

ilObjFolderGUI::downloadFolderObject ( )

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

427 {
428 global $ilAccess, $ilErr, $lng;
429
430 if (!$ilAccess->checkAccess("read", "", $this->ref_id))
431 {
432 $this->ilias->raiseError($this->lng->txt("msg_no_perm_read"),$this->ilias->error_obj->MESSAGE);
433 }
434 $filename = $this->object->downloadFolder();
435 ilUtil::deliverFile($filename, ilUtil::getASCIIFilename($this->object->getTitle().".zip"));
436 }
static getASCIIFilename($a_filename)
convert utf8 to ascii filename
static deliverFile($a_file, $a_filename, $a_mime='', $isInline=false, $removeAfterDelivery=false, $a_exit_after=true)
deliver file for download via browser.
redirection script todo: (a better solution should control the processing via a xml file)

References $filename, $ilErr, ilObjectGUI\$lng, ilUtil\deliverFile(), and ilUtil\getASCIIFilename().

+ Here is the call graph for this function:

◆ editIconsObject()

ilObjFolderGUI::editIconsObject (   $a_form = null)

Edit folder icons.

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

556 {
557 global $tpl;
558
559 $this->checkPermission('write');
560
561 $this->tabs_gui->setTabActive('settings');
562
563 if(!$a_form)
564 {
565 $a_form = $this->initIconsForm();
566 }
567
568 $tpl->setContent($a_form->getHTML());
569 }
checkPermission($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
Check permission and redirect on error.

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

Referenced by updateIconsObject().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ editObject()

ilObjFolderGUI::editObject ( )

Edit.

Parameters

return

Reimplemented from ilObjectGUI.

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

503 {
504 global $ilTabs, $ilErr;
505
506 $this->setSubTabs("settings");
507 $ilTabs->activateTab("settings");
508
509 if (!$this->checkPermissionBool("write"))
510 {
511 $ilErr->raiseError($this->lng->txt("msg_no_perm_write"),$ilErr->MESSAGE);
512 }
513
514 $form = $this->initEditForm();
515 $values = $this->getEditFormValues();
516 if($values)
517 {
518 $form->setValuesByArray($values,TRUE);
519 }
520 $GLOBALS['tpl']->setContent($form->getHTML());
521 }
getEditFormValues()
Get values for edit form.
setSubTabs($a_tab)
Set sub tabs.
checkPermissionBool($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
Check permission.
initEditForm()
Init object edit form.
$GLOBALS['loaded']
Global hash that tracks already loaded includes.

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

+ Here is the call graph for this function:

◆ executeCommand()

ilObjFolderGUI::executeCommand ( )

execute command note: this method is overwritten in all container objects

Reimplemented from ilContainerGUI.

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

78 {
79 global $ilUser,$ilCtrl;
80
81 $next_class = $this->ctrl->getNextClass($this);
82 $cmd = $this->ctrl->getCmd();
83
84 // show repository tree
85 $this->showRepTree();
86
87 switch ($next_class)
88 {
89 case 'ilpermissiongui':
90 $this->prepareOutput();
91 $this->tabs_gui->setTabActive('perm_settings');
92 include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
93 $perm_gui = new ilPermissionGUI($this);
94 $ret =& $this->ctrl->forwardCommand($perm_gui);
95 break;
96
97 case 'ilcoursecontentgui':
98 $this->prepareOutput();
99 include_once './Modules/Course/classes/class.ilCourseContentGUI.php';
100 $course_content_obj = new ilCourseContentGUI($this);
101 $this->ctrl->forwardCommand($course_content_obj);
102 break;
103
104 case "illearningprogressgui":
105 $this->prepareOutput();
106 include_once './Services/Tracking/classes/class.ilLearningProgressGUI.php';
107
109 $this->object->getRefId(),
110 $_GET['user_id'] ? $_GET['user_id'] : $ilUser->getId());
111 $this->ctrl->forwardCommand($new_gui);
112 $this->tabs_gui->setTabActive('learning_progress');
113 break;
114
115 // container page editing
116 case "ilcontainerpagegui":
117 $this->prepareOutput(false);
118 $ret = $this->forwardToPageObject();
119 if ($ret != "")
120 {
121 $this->tpl->setContent($ret);
122 }
123 break;
124
125 case 'ilinfoscreengui':
126 $this->prepareOutput();
127 $this->infoScreen();
128 break;
129
130 case 'ilobjectcopygui':
131 $this->prepareOutput();
132
133 include_once './Services/Object/classes/class.ilObjectCopyGUI.php';
134 $cp = new ilObjectCopyGUI($this);
135 $cp->setType('fold');
136 $this->ctrl->forwardCommand($cp);
137 break;
138
139 case "ilobjstylesheetgui":
140 $this->forwardToStyleSheet();
141 break;
142
143 case 'ilexportgui':
144 $this->prepareOutput();
145
146 $this->tabs_gui->setTabActive('export');
147 include_once './Services/Export/classes/class.ilExportGUI.php';
148 $exp = new ilExportGUI($this);
149 $exp->addFormat('xml');
150 $this->ctrl->forwardCommand($exp);
151 break;
152
153 case "ilcommonactiondispatchergui":
154 include_once("Services/Object/classes/class.ilCommonActionDispatcherGUI.php");
156 $this->ctrl->forwardCommand($gui);
157 break;
158
159 case 'ildidactictemplategui':
160 $this->ctrl->setReturn($this,'edit');
161 include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateGUI.php';
162 $did = new ilDidacticTemplateGUI($this);
163 $this->ctrl->forwardCommand($did);
164 break;
165 case 'ilcolumngui':
166 $this->tabs_gui->setTabActive('none');
167 $this->checkPermission("read");
168 $this->viewObject();
169 break;
170
171 case 'ilbackgroundtaskhub':
172 include_once './Services/BackgroundTask/classes/class.ilBackgroundTaskHub.php';
173 $bggui = new ilBackgroundTaskHub();
174 $this->ctrl->forwardCommand($bggui);
175 break;
176
177 default:
178
179 $this->prepareOutput();
180 // Dirty hack for course timings view
181 if($this->forwardToTimingsView())
182 {
183 break;
184 }
185
186 if (empty($cmd))
187 {
188 $cmd = "view";
189 }
190 $cmd .= "Object";
191 $this->$cmd();
192 break;
193 }
194
195 $this->addHeaderAction();
196 }
$_GET["client_id"]
background task hub (aka ajax handler, GUI)
static getInstanceFromAjaxCall()
(Re-)Build instance from ajax call
& forwardToPageObject()
forward command to page object
prepareOutput($a_show_subobjects=true)
prepare output
forwardToStyleSheet()
Forward to style object.
Class ilCourseContentGUI.
GUI class for didactic template settings inside repository objects.
Export User Interface Class.
Class ilObjUserTrackingGUI.
viewObject()
View folder.
infoScreen()
show information screen
GUI class for the workflow of copying objects.
addHeaderAction()
Add header action menu.
New PermissionGUI (extends from old ilPermission2GUI) RBAC related output.
global $ilCtrl
Definition: ilias.php:18
$ret
Definition: parser.php:6
$cmd
Definition: sahs_server.php:35
$ilUser
Definition: imgupload.php:18

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

+ Here is the call graph for this function:

◆ forwardToTimingsView()

ilObjFolderGUI::forwardToTimingsView ( )
protected

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

469 {
470 global $tree;
471
472 if(!$crs_ref = $tree->checkForParentType($this->ref_id, 'crs'))
473 {
474 return false;
475 }
476 include_once './Modules/Course/classes/class.ilObjCourse.php';
477 if(!$this->ctrl->getCmd() and ilObjCourse::_lookupViewMode(ilObject::_lookupObjId($crs_ref)) == ilContainer::VIEW_TIMING)
478 {
479 if(!isset($_SESSION['crs_timings'])) {
480 $_SESSION['crs_timings'] = true;
481 }
482
483 if($_SESSION['crs_timings'] == true) {
484 include_once './Modules/Course/classes/class.ilCourseContentGUI.php';
485 $course_content_obj = new ilCourseContentGUI($this);
486 $this->ctrl->setCmdClass(get_class($course_content_obj));
487 $this->ctrl->setCmd('editUserTimings');
488 $this->ctrl->forwardCommand($course_content_obj);
489 return true;
490 }
491 }
492 $_SESSION['crs_timings'] = false;
493 return false;
494 }
$_SESSION["AccountId"]
static _lookupViewMode($a_id)
lookup view mode of container
static _lookupObjId($a_id)

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

Referenced by executeCommand().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getEditFormCustomValues()

ilObjFolderGUI::getEditFormCustomValues ( array &  $a_values)
protected

Add values to custom edit fields.

Parameters
array$a_values

Reimplemented from ilObjectGUI.

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

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

◆ getTabs()

ilObjFolderGUI::getTabs ( )

Get tabs.

Reimplemented from ilContainerGUI.

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

344 {
345 global $rbacsystem, $lng, $ilCtrl,$ilAccess, $ilHelp;
346
347 $this->ctrl->setParameter($this,"ref_id",$this->ref_id);
348
349 $ilHelp->setScreenIdComponent("fold");
350
351 $this->tabs_gui->setTabActive("");
352 if ($rbacsystem->checkAccess('read',$this->ref_id))
353 {
354 $this->tabs_gui->addTab("view_content", $lng->txt("content"),
355 $this->ctrl->getLinkTarget($this, ""));
356
357 //BEGIN ChangeEvent add info tab to category object
358 $force_active = ($this->ctrl->getNextClass() == "ilinfoscreengui"
359 || strtolower($_GET["cmdClass"]) == "ilnotegui")
360 ? true
361 : false;
362 $this->tabs_gui->addTarget("info_short",
363 $this->ctrl->getLinkTargetByClass(
364 array("ilobjfoldergui", "ilinfoscreengui"), "showSummary"),
365 array("showSummary","", "infoScreen"),
366 "", "", $force_active);
367 //END ChangeEvent add info tab to category object
368 }
369
370 if ($rbacsystem->checkAccess('write',$this->ref_id))
371 {
372 $this->tabs_gui->addTarget("settings",
373 $this->ctrl->getLinkTarget($this, "edit"), "edit", "", "", ($ilCtrl->getCmd() == "edit"));
374 }
375
376 // learning progress
377 include_once './Services/Tracking/classes/class.ilLearningProgressAccess.php';
378 if(ilLearningProgressAccess::checkAccess($this->object->getRefId()))
379 {
380 $this->tabs_gui->addTarget('learning_progress',
381 $this->ctrl->getLinkTargetByClass(array('ilobjfoldergui','illearningprogressgui'),''),
382 '',
383 array('illplistofobjectsgui','illplistofsettingsgui','illearningprogressgui','illplistofprogressgui'));
384 }
385
386 if($ilAccess->checkAccess('write','',$this->object->getRefId()))
387 {
388 $this->tabs_gui->addTarget(
389 'export',
390 $this->ctrl->getLinkTargetByClass('ilexportgui',''),
391 'export',
392 'ilexportgui'
393 );
394 }
395
396
397 if ($rbacsystem->checkAccess('edit_permission',$this->ref_id))
398 {
399 $this->tabs_gui->addTarget("perm_settings",
400 $this->ctrl->getLinkTargetByClass(array(get_class($this),'ilpermissiongui'), "perm"), array("perm","info","owner"), 'ilpermissiongui');
401 }
402
403 // show clipboard in repository
404 if ($_GET["baseClass"] == "ilRepositoryGUI" and !empty($_SESSION['il_rep_clipboard']))
405 {
406 $this->tabs_gui->addTarget("clipboard",
407 $this->ctrl->getLinkTarget($this, "clipboard"), "clipboard", get_class($this));
408 }
409
410 }
static checkAccess($a_ref_id, $a_allow_only_read=true)
check access to learning progress

References $_GET, $_SESSION, $ilCtrl, ilObjectGUI\$lng, and ilLearningProgressAccess\checkAccess().

+ Here is the call graph for this function:

◆ importFileObject()

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

Import file object @global type $lng.

Parameters
type$parent_id
type$a_catch_errors

Reimplemented from ilObjectGUI.

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

213 {
214 global $lng;
215
216 if(parent::importFileObject($parent_id, $a_catch_errors))
217 {
218 ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
219 $this->ctrl->returnToParent($this);
220 }
221 }

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

+ Here is the call graph for this function:

◆ infoScreen()

ilObjFolderGUI::infoScreen ( )

show information screen

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

297 {
298 global $ilAccess;
299
300 if (!$ilAccess->checkAccess("visible", "", $this->ref_id))
301 {
302 $this->ilias->raiseError($this->lng->txt("msg_no_perm_read"),$this->ilias->error_obj->MESSAGE);
303 }
304
305 include_once("./Services/InfoScreen/classes/class.ilInfoScreenGUI.php");
306 $info = new ilInfoScreenGUI($this);
307
308 $GLOBALS['ilTabs']->activateTab('info_short');
309
310 $info->enablePrivateNotes();
311
312 if ($ilAccess->checkAccess("read", "", $_GET["ref_id"]))
313 {
314 $info->enableNews();
315 }
316
317 // no news editing for files, just notifications
318 $info->enableNewsEditing(false);
319 if ($ilAccess->checkAccess("write", "", $_GET["ref_id"]))
320 {
321 $news_set = new ilSetting("news");
322 $enable_internal_rss = $news_set->get("enable_rss_for_internal");
323
324 if ($enable_internal_rss)
325 {
326 $info->setBlockProperty("news", "settings", true);
327 $info->setBlockProperty("news", "public_notifications_option", true);
328 }
329 }
330
331
332 // standard meta data
333 $info->addMetaDataSections($this->object->getId(),0, $this->object->getType());
334
335 // forward the command
336 $this->ctrl->forwardCommand($info);
337 }
Class ilInfoScreenGUI.
ILIAS Setting Class.
$info
Definition: example_052.php:80

References $_GET, $GLOBALS, and $info.

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

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

287 {
288 $this->ctrl->setCmd("showSummary");
289 $this->ctrl->setCmdClass("ilinfoscreengui");
290 $this->infoScreen();
291 }

References infoScreen().

+ Here is the call graph for this function:

◆ initEditCustomForm()

ilObjFolderGUI::initEditCustomForm ( ilPropertyFormGUI  $a_form)
protected

Add custom fields to update form.

Parameters
ilPropertyFormGUI$a_form

Reimplemented from ilObjectGUI.

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

226 {
227 // Show didactic template type
228 $this->initDidacticTemplate($a_form);
229
230 $this->initSortingForm(
231 $a_form,
232 array(
237 )
238 );
239 }
initSortingForm(ilPropertyFormGUI $form, array $a_sorting_settings)
Append sorting settings to property form.
initDidacticTemplate(ilPropertyFormGUI $form)
Show didactic template types.

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

+ Here is the call graph for this function:

◆ initIconsForm()

ilObjFolderGUI::initIconsForm ( )

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

572 {
573 $this->setSubTabs("icons");
574
575 include_once "Services/Form/classes/class.ilPropertyFormGUI.php";
576 $form = new ilPropertyFormGUI();
577 $form->setFormAction($this->ctrl->getFormAction($this));
578
579 $this->showCustomIconsEditing(1, $form);
580
581 // $form->setTitle($this->lng->txt('edit_grouping'));
582 $form->addCommandButton('updateIcons', $this->lng->txt('save'));
583
584 return $form;
585 }
showCustomIconsEditing($a_input_colspan=1, ilPropertyFormGUI $a_form=null, $a_as_section=true)
show edit section of custom icons for container
This class represents a property form user interface.

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

Referenced by editIconsObject(), and updateIconsObject().

+ 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 @global type $tree.

Parameters
type$a_item_list_gui
type$a_item_data
type$a_show_path

Reimplemented from ilContainerGUI.

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

446 {
447 global $tree;
448
449 // if folder is in a course, modify item list gui according to course requirements
450 if ($course_ref_id = $tree->checkForParentType($this->object->getRefId(),'crs'))
451 {
452 include_once("./Modules/Course/classes/class.ilObjCourse.php");
453 include_once("./Modules/Course/classes/class.ilObjCourseGUI.php");
454 $course_obj_id = ilObject::_lookupObjId($course_ref_id);
456 $a_item_list_gui,
457 'ilcoursecontentgui',
458 $a_item_data,
459 $a_show_path,
460 ilObjCourse::_lookupAboStatus($course_obj_id),
461 $course_ref_id,
462 $course_obj_id,
463 $this->object->getRefId()
464 );
465 }
466 }
static _modifyItemGUI($a_item_list_gui, $a_cmd_class, $a_item_data, $a_show_path, $a_abo_status, $a_course_ref_id, $a_course_obj_id, $a_parent_ref_id=0)
We need a static version of this, e.g.
static _lookupAboStatus($a_id)

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

+ Here is the call graph for this function:

◆ renderObject()

ilObjFolderGUI::renderObject ( )

Render folder.

Reimplemented from ilContainerGUI.

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

67 {
68 global $ilTabs;
69
70 $this->checkPermission('read');
71
72 $ilTabs->activateTab("view_content");
73 $ret = parent::renderObject();
74 return $ret;
75 }

References $ret, and ilObjectGUI\checkPermission().

Referenced by viewObject().

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

202 {
203 $this->folder_tree =& $a_tree;
204 }

◆ setSubTabs()

ilObjFolderGUI::setSubTabs (   $a_tab)

Set sub tabs.

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

528 {
529 global $ilTabs, $lng;
530
531 $ilTabs->addSubTab("settings",
532 $lng->txt("fold_settings"),
533 $this->ctrl->getLinkTarget($this,'edit'));
534
535 // custom icon
536 if ($this->ilias->getSetting("custom_icons"))
537 {
538 $ilTabs->addSubTab("icons",
539 $lng->txt("icon_settings"),
540 $this->ctrl->getLinkTarget($this,'editIcons'));
541 }
542
543 $ilTabs->activateSubTab($a_tab);
544 $ilTabs->activateTab("settings");
545 }

References ilObjectGUI\$lng.

Referenced by editObject(), and initIconsForm().

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

262 {
263 $this->ctrl->setCmd("showSummary");
264 $this->ctrl->setCmdClass("ilinfoscreengui");
265 $this->infoScreen();
266 }

References infoScreen().

+ Here is the call graph for this function:

◆ updateCustom()

ilObjFolderGUI::updateCustom ( ilPropertyFormGUI  $a_form)
protected

Insert custom update form values into object.

Parameters
ilPropertyFormGUI$a_form

Reimplemented from ilObjectGUI.

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

251 {
252 $this->saveSortingSettings($a_form);
253 }
saveSortingSettings(ilPropertyFormGUI $form)
Save sorting settings.

References ilContainerGUI\saveSortingSettings().

+ Here is the call graph for this function:

◆ updateIconsObject()

ilObjFolderGUI::updateIconsObject ( )

update container icons

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

591 {
592 global $ilSetting;
593
594 $this->checkPermission('write');
595
596 $form = $this->initIconsForm();
597 if($form->checkInput())
598 {
599 //save custom icons
600 if ($ilSetting->get("custom_icons"))
601 {
602 if($_POST["cont_icon_delete"])
603 {
604 $this->object->removeCustomIcon();
605 }
606 $this->object->saveIcons($_FILES["cont_icon"]['tmp_name']);
607 }
608 if ($_FILES["cont_icon"]['tmp_name'] || $_POST["cont_icon_delete"])
609 {
610 ilUtil::sendSuccess($this->lng->txt("msg_obj_modified"),true);
611 }
612 $this->ctrl->redirect($this,"editIcons");
613 }
614
615 $form->setValuesByPost();
616 $this->editIconsObject($form);
617 }
$_POST["username"]
editIconsObject($a_form=null)
Edit folder icons.
global $ilSetting
Definition: privfeed.php:17

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

+ Here is the call graph for this function:

◆ viewObject()

ilObjFolderGUI::viewObject ( )

View folder.

Reimplemented from ilObjectGUI.

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

42 {
43 global $tree;
44
45 $this->checkPermission('read');
46
47 if (strtolower($_GET["baseClass"]) == "iladministrationgui")
48 {
49 parent::viewObject();
50 return true;
51 }
52
53 // Trac access - see ilObjCourseGUI
54 include_once 'Services/Tracking/classes/class.ilLearningProgress.php';
55 ilLearningProgress::_tracProgress($GLOBALS["ilUser"]->getId(),$this->object->getId(),
56 $this->object->getRefId(),'fold');
57
58 $this->renderObject();
59 $this->tabs_gui->setTabActive('view_content');
60 return true;
61 }
static _tracProgress($a_user_id, $a_obj_id, $a_ref_id, $a_obj_type='')
renderObject()
Render folder.

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

Referenced by executeCommand().

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


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