ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilObjFolderGUI Class Reference

Class ilObjFolderGUI. More...

+ Inheritance diagram for ilObjFolderGUI:
+ Collaboration diagram for ilObjFolderGUI:

Public Member Functions

 ilObjFolderGUI ($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 ()
 Import object. 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 (&$tabs_gui)
 Get tabs. More...
 
 downloadFolderObject ()
 
 modifyItemGUI ($a_item_list_gui, $a_item_data, $a_show_path)
 Modify Item ListGUI for presentation in container. 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
 ilObjectGUI ($a_data, $a_id=0, $a_call_by_reference=true, $a_prepare_output=true)
 Constructor public. More...
 
executeCommand ()
 execute command More...
 
 withReferences ()
 determines wether objects are referenced or not (got ref ids or not) More...
 
 setCreationMode ($a_mode=true)
 if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui More...
 
 getCreationMode ()
 get creation mode More...
 
 getAdminTabs (&$tabs_gui)
 administration tabs show only permissions and trash folder More...
 
 getHTML ()
 
 confirmedDeleteObject ()
 confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...
 
 cancelDeleteObject ()
 cancel deletion of object More...
 
 cancelObject ($in_rep=false)
 cancel action and go back to previous page 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
 ilContainerGUI ($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 (&$tabs_gui)
 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 ()
 Copy object(s) out from a container and write the information to clipboard It is not possible to copy multiple objects at once. 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 ($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 Item ListGUI for presentation in container. 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...
 

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)
 
 getEditFormCustomValues (array &$a_values)
 
 updateCustom (ilPropertyFormGUI $a_form)
 
 afterSave (ilObject $a_new_object)
 
 forwardToTimingsView ()
 
- Protected Member Functions inherited from ilObjectGUI
 assignObject ()
 
 prepareOutput ()
 prepare output More...
 
 setTitleAndDescription ()
 called by prepare output More...
 
 initHeaderAction ($a_sub_type=null, $a_sub_id=null)
 Add header action menu. More...
 
 insertHeaderAction ($a_list_gui)
 Insert header action into main template. More...
 
 addHeaderAction ()
 Add header action menu. More...
 
 redrawHeaderActionObject ()
 Ajax call: redraw action header only. More...
 
 showMountWebfolderIcon ()
 
 setTabs ()
 set admin tabs 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...
 
 getDidacticTemplateVar ($a_type)
 Get didactic template setting from creation screen. More...
 
 putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
 Add object to tree at given position. More...
 
 afterSave (ilObject $a_new_object)
 Post (successful) object creation hook. More...
 
 initEditForm ()
 Init object edit form. More...
 
 initEditCustomForm (ilPropertyFormGUI $a_form)
 Add custom fields to update form. More...
 
 getEditFormValues ()
 Get values for edit form. More...
 
 getEditFormCustomValues (array &$a_values)
 Add values to custom edit fields. More...
 
 validateCustom (ilPropertyFormGUI $a_form)
 Validate custom values (if not possible with checkInput()) More...
 
 updateCustom (ilPropertyFormGUI $a_form)
 Insert custom update form values into object. More...
 
 afterUpdate ()
 Post (successful) object update hook. More...
 
 initImportForm ($a_new_type)
 Init object import form. More...
 
 importFileObject ($parent_id=null, $a_catch_errors=true)
 Import. More...
 
 afterImport (ilObject $a_new_object)
 Post (successful) object import hook. More...
 
 setFormAction ($a_cmd, $a_formaction)
 set specific form action for command More...
 
 getReturnLocation ($a_cmd, $a_location="")
 get return location for command (command is method name without "Object", e.g. More...
 
 setReturnLocation ($a_cmd, $a_location)
 set specific return location for command More...
 
 getTargetFrame ($a_cmd, $a_target_frame="")
 get target frame for command (command is method name without "Object", e.g. More...
 
 setTargetFrame ($a_cmd, $a_target_frame)
 set specific target frame for command More...
 
 showPossibleSubObjects ()
 show possible subobjects (pulldown menu) More...
 
 getTemplateFile ($a_cmd, $a_type="")
 get a template blockfile format: tpl. More...
 
 getTitlesByRefId ($a_ref_ids)
 get Titles of objects this method is used for error messages in methods cut/copy/paste More...
 
 getTabs (&$tabs_gui)
 get tabs abstract method. More...
 
 __showButton ($a_cmd, $a_text, $a_target='')
 
 hitsperpageObject ()
 
__initTableGUI ()
 
 __setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
 standard implementation for tables use 'from' variable use different initial setting of table More...
 
 redirectToRefId ($a_ref_id, $a_cmd="")
 redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current $_GET["ref_id"] value More...
 
 fillCloneTemplate ($a_tpl_varname, $a_type)
 Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More...
 
 getCenterColumnHTML ()
 Get center column. More...
 
 getRightColumnHTML ()
 Display right column. More...
 
 setColumnSettings ($column_gui)
 May be overwritten in subclasses. More...
 
 checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
 Check permission and redirect on error. More...
 
 checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
 Check permission. More...
 
 enableDragDropFileUpload ()
 Enables the file upload into this object by dropping files. More...
 
 handleAutoRating (ilObject $a_new_obj)
 Activate rating automatically if parent container setting. More...
 
- Protected 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)
 

Additional Inherited Members

- Protected Attributes inherited from ilObjectGUI
 $tmp_import_dir
 

Detailed Description

Member Function Documentation

◆ _goto()

static ilObjFolderGUI::_goto (   $a_target)
static

goto target group

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

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

405  {
406  global $ilAccess, $ilErr, $lng;
407 
408  if ($ilAccess->checkAccess("read", "", $a_target))
409  {
411  }
412  $ilErr->raiseError($lng->txt("msg_no_perm_read"), $ilErr->FATAL);
413  }
static _gotoRepositoryNode($a_ref_id, $a_cmd="frameset")
Goto repository root.
+ Here is the call graph for this function:

◆ afterSave()

ilObjFolderGUI::afterSave ( ilObject  $a_new_object)
protected

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

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

260  {
261  include_once './Services/Container/classes/class.ilContainerSortingSettings.php';
262  $sort = new ilContainerSortingSettings($a_new_object->getId());
264  $sort->update();
265 
266  // always send a message
267  ilUtil::sendSuccess($this->lng->txt("fold_added"),true);
268  $this->ctrl->setParameter($this, "ref_id", $a_new_object->getRefId());
269  $this->redirectToRefId($a_new_object->getRefId(), "");
270  }
static sendSuccess($a_info="", $a_keep=false)
Send Success Message to Screen.
getId()
get object id public
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 public
+ Here is the call graph for this function:

◆ downloadFolderObject()

ilObjFolderGUI::downloadFolderObject ( )

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

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

416  {
417  global $ilAccess, $ilErr, $lng;
418 
419  if (!$ilAccess->checkAccess("read", "", $this->ref_id))
420  {
421  $this->ilias->raiseError($this->lng->txt("msg_no_perm_read"),$this->ilias->error_obj->MESSAGE);
422  }
423  $filename = $this->object->downloadFolder();
424  ilUtil::deliverFile($filename, ilUtil::getASCIIFilename($this->object->getTitle().".zip"));
425  }
static getASCIIFilename($a_filename)
convert utf8 to ascii filename
redirection script todo: (a better solution should control the processing via a xml file) ...
static deliverFile($a_file, $a_filename, $a_mime='', $isInline=false, $removeAfterDelivery=false, $a_exit_after=true)
deliver file for download via browser.
$filename
Definition: buildRTE.php:89
+ Here is the call graph for this function:

◆ editIconsObject()

ilObjFolderGUI::editIconsObject (   $a_form = null)

Edit folder icons.

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

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

Referenced by updateIconsObject().

534  {
535  global $tpl;
536 
537  $this->checkPermission('write');
538 
539  $this->tabs_gui->setTabActive('settings');
540 
541  if(!$a_form)
542  {
543  $a_form = $this->initIconsForm();
544  }
545 
546  $tpl->setContent($a_form->getHTML());
547  }
checkPermission($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
Check permission and redirect on error.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ editObject()

ilObjFolderGUI::editObject ( )

Edit.

Parameters

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

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

481  {
482  global $ilTabs, $ilErr;
483 
484  $this->setSubTabs("settings");
485  $ilTabs->activateTab("settings");
486 
487  if (!$this->checkPermissionBool("write"))
488  {
489  $ilErr->raiseError($this->lng->txt("msg_no_perm_write"),$ilErr->MESSAGE);
490  }
491 
492  $form = $this->initEditForm();
493  $values = $this->getEditFormValues();
494  if($values)
495  {
496  $form->setValuesByArray($values,TRUE);
497  }
498  $GLOBALS['tpl']->setContent($form->getHTML());
499  }
setSubTabs($a_tab)
Set sub tabs.
getEditFormValues()
Get values for edit form.
initEditForm()
Init object edit form.
$GLOBALS['PHPCAS_CLIENT']
This global variable is used by the interface class phpCAS.
Definition: CAS.php:276
checkPermissionBool($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
Check permission.
+ Here is the call graph for this function:

◆ executeCommand()

& ilObjFolderGUI::executeCommand ( )

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

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

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

◆ forwardToTimingsView()

ilObjFolderGUI::forwardToTimingsView ( )
protected

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

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

Referenced by executeCommand().

447  {
448  global $tree;
449 
450  if(!$crs_ref = $tree->checkForParentType($this->ref_id, 'crs'))
451  {
452  return false;
453  }
454  include_once './Modules/Course/classes/class.ilObjCourse.php';
455  if(!$this->ctrl->getCmd() and ilObjCourse::_lookupViewMode(ilObject::_lookupObjId($crs_ref)) == ilContainer::VIEW_TIMING)
456  {
457  if(!isset($_SESSION['crs_timings'])) {
458  $_SESSION['crs_timings'] = true;
459  }
460 
461  if($_SESSION['crs_timings'] == true) {
462  include_once './Modules/Course/classes/class.ilCourseContentGUI.php';
463  $course_content_obj = new ilCourseContentGUI($this);
464  $this->ctrl->setCmdClass(get_class($course_content_obj));
465  $this->ctrl->setCmd('editUserTimings');
466  $this->ctrl->forwardCommand($course_content_obj);
467  return true;
468  }
469  }
470  $_SESSION['crs_timings'] = false;
471  return false;
472  }
$_SESSION["AccountId"]
static _lookupObjId($a_id)
Class ilCourseContentGUI.
+ 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 232 of file class.ilObjFolderGUI.php.

References ilContainerSortingSettings\getSortMode().

233  {
234  // we cannot use $this->object->getOrderType()
235  // if set to inherit it will be translated to parent setting
236  include_once './Services/Container/classes/class.ilContainerSortingSettings.php';
237  $sort = new ilContainerSortingSettings($this->object->getId());
238  $a_values["sor"] = $sort->getSortMode();
239  }
+ Here is the call graph for this function:

◆ getTabs()

ilObjFolderGUI::getTabs ( $tabs_gui)

Get tabs.

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

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

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

◆ ilObjFolderGUI()

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

Constructor public.

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

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

◆ importFileObject()

ilObjFolderGUI::importFileObject ( )

Import object.

Returns

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

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

204  {
205  global $lng;
206 
207  if(parent::importFileObject())
208  {
209  ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
210  $this->ctrl->returnToParent($this);
211  }
212  }
static sendSuccess($a_info="", $a_keep=false)
Send Success Message to Screen.
+ Here is the call graph for this function:

◆ infoScreen()

ilObjFolderGUI::infoScreen ( )

show information screen

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

References $_GET, and $info.

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

288  {
289  global $ilAccess;
290 
291  if (!$ilAccess->checkAccess("visible", "", $this->ref_id))
292  {
293  $this->ilias->raiseError($this->lng->txt("msg_no_perm_read"),$this->ilias->error_obj->MESSAGE);
294  }
295 
296  include_once("./Services/InfoScreen/classes/class.ilInfoScreenGUI.php");
297  $info = new ilInfoScreenGUI($this);
298 
299  $info->enablePrivateNotes();
300 
301  if ($ilAccess->checkAccess("read", "", $_GET["ref_id"]))
302  {
303  $info->enableNews();
304  }
305 
306  // no news editing for files, just notifications
307  $info->enableNewsEditing(false);
308  if ($ilAccess->checkAccess("write", "", $_GET["ref_id"]))
309  {
310  $news_set = new ilSetting("news");
311  $enable_internal_rss = $news_set->get("enable_rss_for_internal");
312 
313  if ($enable_internal_rss)
314  {
315  $info->setBlockProperty("news", "settings", true);
316  $info->setBlockProperty("news", "public_notifications_option", true);
317  }
318  }
319 
320 
321  // standard meta data
322  $info->addMetaDataSections($this->object->getId(),0, $this->object->getType());
323 
324  // forward the command
325  $this->ctrl->forwardCommand($info);
326  }
ILIAS Setting Class.
Class ilInfoScreenGUI.
$_GET["client_id"]
$info
Definition: example_052.php:80
redirection script todo: (a better solution should control the processing via a xml file) ...
+ 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 277 of file class.ilObjFolderGUI.php.

References infoScreen().

278  {
279  $this->ctrl->setCmd("showSummary");
280  $this->ctrl->setCmdClass("ilinfoscreengui");
281  $this->infoScreen();
282  }
infoScreen()
show information screen
+ Here is the call graph for this function:

◆ initEditCustomForm()

ilObjFolderGUI::initEditCustomForm ( ilPropertyFormGUI  $a_form)
protected

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

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

217  {
218  // Show didactic template type
219  $this->initDidacticTemplate($a_form);
220 
221  $this->initSortingForm(
222  $a_form,
223  array(
228  )
229  );
230  }
initDidacticTemplate(ilPropertyFormGUI $form)
Show didactic template types.
initSortingForm(ilPropertyFormGUI $form, array $a_sorting_settings)
Append sorting settings to property form.
+ Here is the call graph for this function:

◆ initIconsForm()

ilObjFolderGUI::initIconsForm ( )

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

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

Referenced by editIconsObject(), and updateIconsObject().

550  {
551  $this->setSubTabs("icons");
552 
553  include_once "Services/Form/classes/class.ilPropertyFormGUI.php";
554  $form = new ilPropertyFormGUI();
555  $form->setFormAction($this->ctrl->getFormAction($this));
556 
557  $this->showCustomIconsEditing(1, $form);
558 
559  // $form->setTitle($this->lng->txt('edit_grouping'));
560  $form->addCommandButton('updateIcons', $this->lng->txt('save'));
561 
562  return $form;
563  }
setSubTabs($a_tab)
Set sub tabs.
This class represents a property form user interface.
showCustomIconsEditing($a_input_colspan=1, ilPropertyFormGUI $a_form=null, $a_as_section=true)
show edit section of custom icons for container
+ 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.

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

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

431  {
432  global $tree;
433 
434  // if folder is in a course, modify item list gui according to course requirements
435  if ($course_ref_id = $tree->checkForParentType($this->object->getRefId(),'crs'))
436  {
437  include_once("./Modules/Course/classes/class.ilObjCourse.php");
438  include_once("./Modules/Course/classes/class.ilObjCourseGUI.php");
439  $course_obj_id = ilObject::_lookupObjId($course_ref_id);
440  ilObjCourseGUI::_modifyItemGUI($a_item_list_gui, 'ilcoursecontentgui', $a_item_data, $a_show_path,
441  ilObjCourse::_lookupAboStatus($course_obj_id), $course_ref_id, $course_obj_id,
442  $this->object->getRefId());
443  }
444  }
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 _lookupObjId($a_id)
+ Here is the call graph for this function:

◆ renderObject()

ilObjFolderGUI::renderObject ( )

Render folder.

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

References $ret, and ilObjectGUI\checkPermission().

Referenced by viewObject().

66  {
67  global $ilTabs;
68 
69  $this->checkPermission('read');
70 
71  $ilTabs->activateTab("view_content");
72  $ret = parent::renderObject();
73  return $ret;
74  }
checkPermission($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
Check permission and redirect on error.
+ 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 194 of file class.ilObjFolderGUI.php.

195  {
196  $this->folder_tree =& $a_tree;
197  }

◆ setSubTabs()

ilObjFolderGUI::setSubTabs (   $a_tab)

Set sub tabs.

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

References ilObjectGUI\$lng.

Referenced by editObject(), and initIconsForm().

506  {
507  global $ilTabs, $lng;
508 
509  $ilTabs->addSubTab("settings",
510  $lng->txt("fold_settings"),
511  $this->ctrl->getLinkTarget($this,'edit'));
512 
513  // custom icon
514  if ($this->ilias->getSetting("custom_icons"))
515  {
516  $ilTabs->addSubTab("icons",
517  $lng->txt("icon_settings"),
518  $this->ctrl->getLinkTarget($this,'editIcons'));
519  }
520 
521  $ilTabs->activateSubTab($a_tab);
522  $ilTabs->activateTab("settings");
523  }
redirection script todo: (a better solution should control the processing via a xml file) ...
+ 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 252 of file class.ilObjFolderGUI.php.

References infoScreen().

253  {
254  $this->ctrl->setCmd("showSummary");
255  $this->ctrl->setCmdClass("ilinfoscreengui");
256  $this->infoScreen();
257  }
infoScreen()
show information screen
+ Here is the call graph for this function:

◆ updateCustom()

ilObjFolderGUI::updateCustom ( ilPropertyFormGUI  $a_form)
protected

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

References ilContainerGUI\saveSortingSettings().

242  {
243  $this->saveSortingSettings($a_form);
244  }
saveSortingSettings(ilPropertyFormGUI $form)
Save sorting settings.
+ Here is the call graph for this function:

◆ updateIconsObject()

ilObjFolderGUI::updateIconsObject ( )

update container icons

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

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

569  {
570  global $ilSetting;
571 
572  $this->checkPermission('write');
573 
574  $form = $this->initIconsForm();
575  if($form->checkInput())
576  {
577  //save custom icons
578  if ($ilSetting->get("custom_icons"))
579  {
580  if($_POST["cont_icon_delete"])
581  {
582  $this->object->removeCustomIcon();
583  }
584  $this->object->saveIcons($_FILES["cont_icon"]['tmp_name']);
585  }
586  if ($_FILES["cont_icon"]['tmp_name'] || $_POST["cont_icon_delete"])
587  {
588  ilUtil::sendSuccess($this->lng->txt("msg_obj_modified"),true);
589  }
590  $this->ctrl->redirect($this,"editIcons");
591  }
592 
593  $form->setValuesByPost();
594  $this->editIconsObject($form);
595  }
static sendSuccess($a_info="", $a_keep=false)
Send Success Message to Screen.
$_POST['username']
Definition: cron.php:12
global $ilSetting
Definition: privfeed.php:40
checkPermission($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
Check permission and redirect on error.
editIconsObject($a_form=null)
Edit folder icons.
+ Here is the call graph for this function:

◆ viewObject()

ilObjFolderGUI::viewObject ( )

View folder.

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

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

Referenced by executeCommand().

41  {
42  global $tree;
43 
44  $this->checkPermission('read');
45 
46  if (strtolower($_GET["baseClass"]) == "iladministrationgui")
47  {
48  parent::viewObject();
49  return true;
50  }
51 
52  // Trac access - see ilObjCourseGUI
53  include_once 'Services/Tracking/classes/class.ilLearningProgress.php';
54  ilLearningProgress::_tracProgress($GLOBALS["ilUser"]->getId(),$this->object->getId(),
55  $this->object->getRefId(),'fold');
56 
57  $this->renderObject();
58  $this->tabs_gui->setTabActive('view_content');
59  return true;
60  }
$_GET["client_id"]
static _tracProgress($a_user_id, $a_obj_id, $a_ref_id, $a_obj_type='')
renderObject()
Render folder.
checkPermission($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
Check permission and redirect on error.
$GLOBALS['PHPCAS_CLIENT']
This global variable is used by the interface class phpCAS.
Definition: CAS.php:276
+ 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 24 of file class.ilObjFolderGUI.php.


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