ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ilObjFolderGUI Class Reference

Class ilObjFolderGUI. More...

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

Public Member Functions

 __construct ( $a_data, int $a_id=0, bool $a_call_by_reference=true, bool $a_prepare_output=false)
 
 viewObject ()
 viewObject container presentation for "administration -> repository, trash, permissions" More...
 
 renderObject ()
 
 executeCommand ()
 
 setFolderTree (ilTree $a_tree)
 
 showSummaryObject ()
 this one is called from the info button in the repository not very nice to set cmdClass/Cmd manually, if everything works through ilCtrl in the future this may be changed More...
 
 infoScreenObject ()
 this one is called from the info button in the repository not very nice to set cmdClass/Cmd manually, if everything works through ilCtrl in the future this may be changed More...
 
 infoScreen ()
 
 modifyItemGUI (ilObjectListGUI $a_item_list_gui, array $a_item_data)
 
 editObject ()
 
 setSubTabs (string $a_tab)
 
 deleteObject (bool $error=false)
 Display deletion confirmation screen. More...
 
- Public Member Functions inherited from ilContainerGUI
 executeCommand ()
 
 forwardToPageObject ()
 
 addPageTabs ()
 
 getContainerPageHTML ()
 
 getContentGUI ()
 
 renderObject ()
 
 renderBlockAsynchObject ()
 render the object More...
 
 setContentSubTabs ()
 
 showAdministrationPanel ()
 
 showPermanentLink ()
 
 editPageFrameObject ()
 
 cancelPageContentObject ()
 
 showLinkListObject ()
 
 addHeaderRow (ilTemplate $a_tpl, string $a_type, bool $a_show_image=true)
 
 addMessageRow (ilTemplate $a_tpl, string $a_message, string $a_type)
 
 setPageEditorTabs ()
 
 addStandardContainerSubTabs (bool $a_include_view=true)
 Add standard container subtabs for view, manage, oderdering and text/media editor link. More...
 
 enableAdministrationPanelObject ()
 
 disableAdministrationPanelObject ()
 
 editOrderObject ()
 
 isActiveOrdering ()
 
 isActiveItemOrdering ()
 
 enableMultiDownloadObject ()
 
 isMultiDownloadEnabled ()
 
 cutObject ()
 cut object(s) out from a container and write the information to clipboard @access public More...
 
 copyObject ()
 Copy object(s) out from a container and write the information to clipboard It is not possible to copy multiple objects at once. More...
 
 downloadObject ()
 
 getBucketTitle ()
 
 linkObject ()
 create an new reference of an object in tree it's like a hard link of unix More...
 
 clearObject ()
 clear clipboard and go back to last object More...
 
 performPasteIntoMultipleObjectsObject ()
 
 initAndDisplayLinkIntoMultipleObjectsObject ()
 
 showPasteTreeObject ()
 
 cancelMoveLinkObject ()
 Cancel move|link empty clipboard and return to parent. More...
 
 keepObjectsInClipboardObject ()
 
 initAndDisplayCopyIntoMultipleObjectsObject ()
 
 initAndDisplayMoveIntoObjectObject ()
 
 pasteObject ()
 paste object from clipboard to current place Depending on the chosen command the object(s) are linked, copied or moved More...
 
 clipboardObject ()
 
 isActiveAdministrationPanel ()
 
 setColumnSettings (ilColumnGUI $column_gui)
 
 allowBlocksMoving ()
 Standard is to allow blocks moving. More...
 
 allowBlocksConfigure ()
 Standard is to allow blocks configuration. More...
 
 cloneAllObject ()
 Clone all object Overwritten method for copying container objects. More...
 
 saveSortingObject ()
 
 cloneNodes (int $srcRef, int $dstRef, array &$mapping, ?string $newName=null)
 Recursively clones all nodes of the RBAC tree. More...
 
 modifyItemGUI (ilObjectListGUI $a_item_list_gui, array $a_item_data)
 
 editStylePropertiesObject ()
 
 redrawListItemObject ()
 Redraw a list item (ajax) More...
 
 trashObject ()
 Show trash content of object. More...
 
 trashApplyFilterObject ()
 
 trashResetFilterObject ()
 
 removeFromSystemObject ()
 
 undeleteObject ()
 Get objects back from trash. More...
 
 confirmRemoveFromSystemObject ()
 
 setSideColumnReturn ()
 
 getAdminTabs ()
 administration tabs show only permissions and trash folder More...
 
 competencesObject ()
 
- Public Member Functions inherited from ilObjectGUI
 getRefId ()
 
 setAdminMode (string $mode)
 
 getAdminMode ()
 
 getObject ()
 
 executeCommand ()
 
 withReferences ()
 determines whether objects are referenced or not (got ref ids or not) More...
 
 setCreationMode (bool $mode=true)
 If true, a creation screen is displayed the current [ref_id] does belong to the parent class The mode is determined in ilRepositoryGUI. More...
 
 getCreationMode ()
 
 prepareOutput (bool $show_sub_objects=true)
 
 getAdminTabs ()
 administration tabs show only permissions and trash folder More...
 
 getHTML ()
 
 confirmedDeleteObject ()
 confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...
 
 cancelObject ()
 cancel action and go back to previous page More...
 
 createObject ()
 create new object form More...
 
 editAvailabilityPeriodObject ()
 
 saveAvailabilityPeriodObject ()
 
 cancelCreation ()
 cancel create action and go back to repository parent More...
 
 saveObject ()
 
 getDidacticTemplateVar (string $type)
 Get didactic template setting from creation screen. More...
 
 putObjectInTree (ilObject $obj, ?int $parent_node_id=null)
 Add object to tree at given position. More...
 
 editObject ()
 
 addExternalEditFormCustom (ilPropertyFormGUI $form)
 
 updateObject ()
 updates object entry in object_data More...
 
 getFormAction (string $cmd, string $default_form_action="")
 Get form action for command (command is method name without "Object", e.g. More...
 
 isVisible (int $ref_id, string $type)
 
 viewObject ()
 viewObject container presentation for "administration -> repository, trash, permissions" More...
 
 deleteObject (bool $error=false)
 Display deletion confirmation screen. More...
 
 setColumnSettings (ilColumnGUI $column_gui)
 
 addToDeskObject ()
 
 removeFromDeskObject ()
 
- Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
 callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)
 
- Public Member Functions inherited from ilDesktopItemHandling
 addToDeskObject ()
 
 removeFromDeskObject ()
 

Static Public Member Functions

static _goto ($a_target)
 goto target group More...
 
- Static Public Member Functions inherited from ilContainerGUI
static _buildPath (int $a_ref_id, int $a_course_ref_id)
 build path More...
 
- Static Public Member Functions inherited from ilObjectGUI
static _gotoRepositoryRoot (bool $raise_error=false)
 Goto repository root. More...
 
static _gotoRepositoryNode (int $ref_id, string $cmd="")
 
static _gotoSharedWorkspaceNode (int $wsp_id)
 

Data Fields

ilTree $folder_tree
 
- Data Fields inherited from ilContainerGUI
int $bl_cnt = 1
 
bool $multi_download_enabled = false
 
- Data Fields inherited from ilObjectGUI
const ADMIN_MODE_NONE = ""
 
const ADMIN_MODE_SETTINGS = "settings"
 
const ADMIN_MODE_REPOSITORY = "repository"
 
const UPLOAD_TYPE_LOCAL = 1
 
const UPLOAD_TYPE_UPLOAD_DIRECTORY = 2
 
const CFORM_NEW = 1
 
const CFORM_IMPORT = 2
 
const CFORM_CLONE = 3
 
const SUPPORTED_IMPORT_MIME_TYPES = [MimeType::APPLICATION__ZIP, MimeType::APPLICATION__X_ZIP_COMPRESSED]
 

Protected Member Functions

 initEditForm ()
 
 getEditFormCustomValues (array &$a_values)
 Add values to custom edit fields. More...
 
 updateCustom (ilPropertyFormGUI $form)
 Insert custom update form values into object. More...
 
 afterSave (ilObject $new_object)
 Post (successful) object creation hook. More...
 
 getTabs ()
 @abstract overwrite in derived GUI class of your object type More...
 
 showPossibleSubObjects ()
 show possible sub objects selection list More...
 
 forwardToTimingsView ()
 
- Protected Member Functions inherited from ilContainerGUI
 getModeManager ()
 
 getItemPresentation ( $include_empty_blocks=true, ?string $lang=null)
 
 getEditFormValues ()
 
 afterUpdate ()
 Post (successful) object update hook. More...
 
 setTitleAndDescription ()
 
 showPossibleSubObjects ()
 show possible sub objects (pull down menu) More...
 
 supportsPageEditor ()
 
 gotItems ()
 
 getTabs ()
 @abstract overwrite in derived GUI class of your object type More...
 
 showContainerPageTabs ()
 
 showPasswordInstructionObject (bool $a_init=true)
 
 initFormPasswordInstruction ()
 Init password form. More...
 
 savePasswordObject ()
 
 initEditForm ()
 
 initSortingForm (ilPropertyFormGUI $form, array $a_sorting_settings)
 Append sorting settings to property form. More...
 
 initListPresentationForm (ilPropertyFormGUI $form)
 Add list presentation settings to form. More...
 
 saveListPresentation (ilPropertyFormGUI $form)
 
 initSortingDirectionForm (ilContainerSortingSettings $sorting_settings, ilRadioOption $element, string $a_prefix)
 Add sorting direction. More...
 
 initManualSortingOptionForm (ilContainerSortingSettings $settings, ilRadioOption $element, string $a_prefix, array $a_sorting_settings)
 Add manual sorting options. More...
 
 saveSortingSettings (ilPropertyFormGUI $form)
 
 trashHandleFilter (bool $action_apply, bool $action_reset)
 
 restoreToNewLocationObject (?ilPropertyFormGUI $form=null)
 
 getTreeSelectorGUI (string $cmd)
 
 initFilter ()
 
 showContainerFilter ()
 
- Protected Member Functions inherited from ilObjectGUI
 getObjectService ()
 
 assignObject ()
 
 setTitleAndDescription ()
 
 createActionDispatcherGUI ()
 
 initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
 Add header action menu. More...
 
 insertHeaderAction (?ilObjectListGUI $list_gui=null)
 Insert header action into main template. More...
 
 addHeaderAction ()
 Add header action menu. More...
 
 redrawHeaderActionObject ()
 Ajax call: redraw action header only. More...
 
 setTabs ()
 set admin tabs More...
 
 setAdminTabs ()
 set admin tabs More...
 
 setLocator ()
 
 addLocatorItems ()
 should be overwritten to add object specific items (repository items are preloaded) More...
 
 omitLocator (bool $omit=true)
 
 addAdminLocatorItems (bool $do_not_add_object=false)
 should be overwritten to add object specific items (repository items are preloaded) More...
 
 getCreationFormsHTML (StandardForm|ilPropertyFormGUI|array $form)
 
 getTitleForCreationFormPage ()
 
 getCreationFormTitle ()
 
 initCreateForm (string $new_type)
 
 didacticTemplatesToForm ()
 
 initDidacticTemplate (ilPropertyFormGUI $form)
 
 retrieveAdditionalDidacticTemplateOptions ()
 
 addAdoptContentLinkToToolbar ()
 
 addImportButtonToToolbar ()
 
 addAvailabilityPeriodButtonToToolbar (ilToolbarGUI $toolbar)
 
 parseDidacticTemplateVar (string $var, string $type)
 
 afterSave (ilObject $new_object)
 Post (successful) object creation hook. More...
 
 initEditForm ()
 
 initEditCustomForm (ilPropertyFormGUI $a_form)
 Add custom fields to update form. More...
 
 getEditFormValues ()
 
 getEditFormCustomValues (array &$a_values)
 Add values to custom edit fields. More...
 
 validateCustom (ilPropertyFormGUI $form)
 Validate custom values (if not possible with checkInput()) More...
 
 updateCustom (ilPropertyFormGUI $form)
 Insert custom update form values into object. More...
 
 afterUpdate ()
 Post (successful) object update hook. More...
 
 routeImportCmdObject ()
 
 importFile (string $file_to_import, string $path_to_uploaded_file_in_temp_dir)
 
 deleteUploadedImportFile (string $path_to_uploaded_file_in_temp_dir)
 
 afterImport (ilObject $new_object)
 Post (successful) object import hook. More...
 
 setFormAction (string $cmd, string $form_action)
 
 getReturnLocation (string $cmd, string $default_location="")
 Get return location for command (command is method name without "Object", e.g. More...
 
 setReturnLocation (string $cmd, string $location)
 set specific return location for command More...
 
 getTargetFrame (string $cmd, string $default_target_frame="")
 get target frame for command (command is method name without "Object", e.g. More...
 
 setTargetFrame (string $cmd, string $target_frame)
 Set specific target frame for command. More...
 
 showPossibleSubObjects ()
 show possible sub objects (pull down menu) More...
 
 getTabs ()
 @abstract overwrite in derived GUI class of your object type More...
 
 redirectToRefId (int $ref_id, string $cmd="")
 redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current ["ref_id"] value of the request More...
 
 getCenterColumnHTML ()
 Get center column. More...
 
 getRightColumnHTML ()
 Display right column. More...
 
 checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
 
 checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
 
 enableDragDropFileUpload ()
 Enables the file upload into this object by dropping files. More...
 
 getCreatableObjectTypes ()
 
 buildAddNewItemElements (array $subtypes, string $create_target_class=ilRepositoryGUI::class, ?int $redirect_target_ref_id=null,)
 
 buildGroup (string $create_target_class, array $obj_types_in_group, string $title, array $subtypes)
 

Protected Attributes

ilHelpGUI $help
 
StandardGUIRequest $folder_request
 
- Protected Attributes inherited from ilContainerGUI
ILIAS Container InternalGUIService $gui
 
ILIAS Style Content GUIService $content_style_gui
 
ilRbacSystem $rbacsystem
 
ilRbacReview $rbacreview
 
ILIAS Container Content ItemPresentationManager $item_presentation = null
 
ILIAS Container InternalDomainService $domain
 
ilTabsGUI $tabs
 
ilErrorHandling $error
 
ilObjectDefinition $obj_definition
 
ilRbacAdmin $rbacadmin
 
ilPropertyFormGUI $form
 
ilLogger $log
 
ilObjectDataCache $obj_data_cache
 
Services $global_screen
 
ilAppEventHandler $app_event_handler
 
UIServices $ui
 
ilContainerFilterService $container_filter_service
 
ilContainerUserFilter $container_user_filter = null
 
Standard $ui_filter = null
 
bool $edit_order = false
 
bool $adminCommands = false
 
string $requested_redirectSource = ""
 
int $current_position = 0
 
ClipboardManager $clipboard
 
StandardGUIRequest $std_request
 
ModeManager $mode_manager = null
 
ilComponentFactory $component_factory
 
ILIAS Style Content DomainService $content_style_domain
 
- Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service $notes_service
 
GlobalHttpState $http
 
ServerRequestInterface $request
 
ilLocatorGUI $locator
 
ilObjUser $user
 
ilAccessHandler $access
 
ilSetting $settings
 
ilToolbarGUI $toolbar
 
ilRbacAdmin $rbac_admin
 
ilRbacSystem $rbac_system
 
ilRbacReview $rbac_review
 
ilObjectService $object_service
 
ilObjectDefinition $obj_definition
 
ilGlobalTemplateInterface $tpl
 
ilTree $tree
 
ilCtrl $ctrl
 
ilErrorHandling $error
 
ilLanguage $lng
 
ilTabsGUI $tabs_gui
 
ILIAS $ilias
 
ArrayBasedRequestWrapper $post_wrapper
 
RequestWrapper $request_wrapper
 
Refinery $refinery
 
ilFavouritesManager $favourites
 
CustomIconFactory $custom_icon_factory
 
UIFactory $ui_factory
 
UIRenderer $ui_renderer
 
Filesystem $temp_file_system
 
ilObject $object = null
 
bool $creation_mode = false
 
 $data
 
int $id
 
bool $call_by_reference = false
 
bool $prepare_output
 
int $ref_id
 
int $obj_id
 
int $maxcount
 
array $form_action = []
 
array $return_location = []
 
array $target_frame = []
 
string $tmp_import_dir
 
string $sub_objects = ""
 
bool $omit_locator = false
 
string $type = ""
 
string $admin_mode = self::ADMIN_MODE_NONE
 
int $requested_ref_id = 0
 
int $requested_crtptrefid = 0
 
int $requested_crtcb = 0
 
string $requested_new_type = ""
 
string $link_params
 
string $html = ""
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

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

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

47 {
48 global $DIC;
49
50 $this->tree = $DIC->repositoryTree();
51 $this->tabs = $DIC->tabs();
52 $this->user = $DIC->user();
53 $this->ctrl = $DIC->ctrl();
54 $this->lng = $DIC->language();
55 $this->access = $DIC->access();
56 $this->rbacsystem = $DIC->rbac()->system();
57 $this->help = $DIC["ilHelp"];
58 $this->error = $DIC["ilErr"];
59 $this->tpl = $DIC["tpl"];
60 $this->settings = $DIC->settings();
61 $this->type = "fold";
62 parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output);
63 $this->lng->loadLanguageModule("obj");
64 $this->folder_request = $DIC
65 ->folder()
66 ->internal()
67 ->gui()
68 ->standardRequest();
69 }
error(string $a_errmsg)
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc
global $DIC
Definition: shib_login.php:26

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

+ Here is the call graph for this function:

Member Function Documentation

◆ _goto()

static ilObjFolderGUI::_goto (   $a_target)
static

goto target group

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

494 : void
495 {
496 global $DIC;
497
498 $ilAccess = $DIC->access();
499 $ilErr = $DIC["ilErr"];
500 $lng = $DIC->language();
501
502 $a_target = (int) $a_target;
503
504 if ($ilAccess->checkAccess("read", "", $a_target)) {
506 }
507 if ($ilAccess->checkAccess("visible", "", $a_target)) {
508 ilObjectGUI::_gotoRepositoryNode($a_target, "infoScreen");
509 }
510 $ilErr->raiseError($lng->txt("msg_no_perm_read"), $ilErr->FATAL);
511 }
txt(string $a_topic, string $a_default_lang_fallback_mod="")
gets the text for a given topic if the topic is not in the list, the topic itself with "-" will be re...
static _gotoRepositoryNode(int $ref_id, string $cmd="")
ilLanguage $lng
$ilErr
Definition: raiseError.php:33

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

+ Here is the call graph for this function:

◆ afterSave()

ilObjFolderGUI::afterSave ( ilObject  $new_object)
protected

Post (successful) object creation hook.

Reimplemented from ilObjectGUI.

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

350 : void
351 {
352 $sort = new ilContainerSortingSettings($new_object->getId());
353 $sort->setSortMode(ilContainer::SORT_INHERIT);
354 $sort->update();
355
356 // always send a message
357 $this->tpl->setOnScreenMessage('success', $this->lng->txt("fold_added"), true);
358 $this->ctrl->setParameter($this, "ref_id", $new_object->getRefId());
359 $this->redirectToRefId($new_object->getRefId(), "");
360 }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
redirectToRefId(int $ref_id, string $cmd="")
redirects to (repository) view per ref id usually to a container and usually used at the end of a sav...

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

+ Here is the call graph for this function:

◆ deleteObject()

ilObjFolderGUI::deleteObject ( bool  $error = false)

Display deletion confirmation screen.

Only for referenced objects. For user,role & rolt overwrite this function in the appropriate Object folders classes (ilObjUserFolderGUI,ilObjRoleFolderGUI)

Reimplemented from ilObjectGUI.

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

607 : void
608 {
609 $this->tabs_gui->activateTab('view_content');
610 parent::deleteObject($error);
611 }
ilErrorHandling $error

References ilContainerGUI\$error.

◆ editObject()

ilObjFolderGUI::editObject ( )

Reimplemented from ilObjectGUI.

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

566 : void
567 {
568 $ilTabs = $this->tabs;
570
571 $this->setSubTabs("settings");
572 $ilTabs->activateTab("settings");
573
574 if (!$this->checkPermissionBool("write")) {
575 $ilErr->raiseError($this->lng->txt("msg_no_perm_write"), $ilErr->MESSAGE);
576 }
577
578 $form = $this->initEditForm();
579 $values = $this->getEditFormValues();
580 if ($values) {
581 $form->setValuesByArray($values, true);
582 }
583 $GLOBALS['tpl']->setContent($form->getHTML());
584 }
ilPropertyFormGUI $form
setSubTabs(string $a_tab)
checkPermissionBool(string $perm, string $cmd="", string $type="", ?int $ref_id=null)
setValuesByArray(array $a_values, bool $a_restrict_to_value_keys=false)
$GLOBALS["DIC"]
Definition: wac.php:54

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

+ Here is the call graph for this function:

◆ executeCommand()

ilObjFolderGUI::executeCommand ( )

Reimplemented from ilContainerGUI.

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

102 : void
103 {
104 $ilUser = $this->user;
105 $next_class = $this->ctrl->getNextClass($this);
106 $cmd = $this->ctrl->getCmd();
107
108 $header_action = true;
109 switch ($next_class) {
110 case strtolower(ilRepositoryTrashGUI::class):
111 $ru = new ilRepositoryTrashGUI($this);
112 $this->ctrl->setReturn($this, 'trash');
113 $this->ctrl->forwardCommand($ru);
114 break;
115
116 case 'ilpermissiongui':
117 $this->prepareOutput();
118 $this->tabs_gui->activateTab('perm_settings');
119 $perm_gui = new ilPermissionGUI($this);
120 $ret = $this->ctrl->forwardCommand($perm_gui);
121 break;
122
123
124 case 'ilcoursecontentgui':
125 $this->prepareOutput();
126 $course_content_obj = new ilCourseContentGUI($this);
127 $this->ctrl->forwardCommand($course_content_obj);
128 break;
129
130 case "illearningprogressgui":
131 $this->prepareOutput();
132
133 $new_gui = new ilLearningProgressGUI(
135 $this->object->getRefId(),
136 $this->folder_request->getUserId() ?: $ilUser->getId()
137 );
138 $this->ctrl->forwardCommand($new_gui);
139 $this->tabs_gui->setTabActive('learning_progress');
140 break;
141
142 // container page editing
143 case "ilcontainerpagegui":
144 $this->prepareOutput(false);
145 $ret = $this->forwardToPageObject();
146 if ($ret !== "") {
147 $this->tpl->setContent($ret);
148 }
149 $header_action = false;
150 break;
151
152 case 'ilinfoscreengui':
153 $this->prepareOutput();
154 $this->infoScreen();
155 break;
156
157 case 'ilobjectcopygui':
158 $this->prepareOutput();
159
160 $cp = new ilObjectCopyGUI($this);
161 $cp->setType('fold');
162 $this->ctrl->forwardCommand($cp);
163 break;
164
165 case "ilobjectcontentstylesettingsgui":
166 $this->checkPermission("write");
167 $this->setTitleAndDescription();
168 $this->showContainerPageTabs();
169 $settings_gui = $this->content_style_gui
170 ->objectSettingsGUIForRefId(
171 null,
172 $this->object->getRefId()
173 );
174 $this->ctrl->forwardCommand($settings_gui);
175 break;
176
177 case 'ilexportgui':
178 $this->prepareOutput();
179
180 $this->tabs_gui->setTabActive('export');
181 $exp = new ilExportGUI($this);
182 $exp->addFormat('xml');
183 $this->ctrl->forwardCommand($exp);
184 break;
185
186 case "ilcommonactiondispatchergui":
187 $this->prepareOutput();
189 $this->ctrl->forwardCommand($gui);
190 break;
191
192 case 'ildidactictemplategui':
193 $this->ctrl->setReturn($this, 'edit');
194 $did = new ilDidacticTemplateGUI($this);
195 $this->ctrl->forwardCommand($did);
196 break;
197 case 'ilcolumngui':
198 $this->tabs_gui->setTabActive('none');
199 $this->checkPermission("read");
200 $this->viewObject();
201 break;
202
203 case strtolower(TranslationGUI::class):
204 $this->checkPermissionBool("write");
205 $this->prepareOutput();
206 $this->setSubTabs("settings_trans");
207 $transgui = new TranslationGUI(
208 $this->getObject(),
209 $this->lng,
210 $this->access,
211 $this->user,
212 $this->ctrl,
213 $this->tpl,
214 $this->ui_factory,
215 $this->ui_renderer,
216 $this->http,
217 $this->refinery,
218 $this->toolbar
219 );
220 $this->ctrl->forwardCommand($transgui);
221 break;
222
223 default:
224
225 $this->prepareOutput();
226 // cognos-blu-patch: begin
227 // removed timings forward
228 // cognos-blu-patch: end
229
230 if (empty($cmd)) {
231 $cmd = "view";
232 }
233 $cmd .= "Object";
234 $this->$cmd();
235 break;
236 }
237
238 if ($header_action) {
239 $this->addHeaderAction();
240 }
241 }
static getInstanceFromAjaxCall()
(Re-)Build instance from ajax call
ILIAS Container InternalGUIService $gui
Class ilCourseContentGUI.
GUI class for didactic template settings inside repository objects.
Export User Interface Class.
Class ilObjUserTrackingGUI.
viewObject()
viewObject container presentation for "administration -> repository, trash, permissions"
GUI class for the workflow of copying objects.
checkPermission(string $perm, string $cmd="", string $type="", ?int $ref_id=null)
addHeaderAction()
Add header action menu.
prepareOutput(bool $show_sub_objects=true)
Repository GUI Utilities.
static http()
Fetches the global http state from ILIAS.

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

+ Here is the call graph for this function:

◆ forwardToTimingsView()

ilObjFolderGUI::forwardToTimingsView ( )
protected

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

546 : void
547 {
549
550 if (!$crs_ref = $tree->checkForParentType($this->ref_id, 'crs')) {
551 return;
552 }
554 if (!ilSession::has('crs_timings')) {
555 ilSession::set('crs_timings', true);
556 }
557
558 if (ilSession::get('crs_timings')) {
559 $this->ctrl->redirectByClass(ilCourseContentGUI::class, 'editUserTimings');
560 return;
561 }
562 }
563 ilSession::set('crs_timings', false);
564 }
static _lookupViewMode(int $a_id)
static _lookupObjId(int $ref_id)
static get(string $a_var)
static set(string $a_var, $a_val)
Set a value.
static has($a_var)
checkForParentType(int $a_ref_id, string $a_type, bool $a_exclude_source_check=false)
Check for parent type e.g check if a folder (ref_id 3) is in a parent course obj => checkForParentTyp...

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

+ Here is the call graph for this function:

◆ getEditFormCustomValues()

ilObjFolderGUI::getEditFormCustomValues ( array &  $a_values)
protected

Add values to custom edit fields.

Reimplemented from ilObjectGUI.

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

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

References ILIAS\Repository\object().

+ Here is the call graph for this function:

◆ getTabs()

ilObjFolderGUI::getTabs ( )
protected

@abstract overwrite in derived GUI class of your object type

Reimplemented from ilContainerGUI.

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

413 : void
414 {
417 $ilCtrl = $this->ctrl;
418 $ilAccess = $this->access;
419 $ilHelp = $this->help;
420
421 $this->ctrl->setParameter($this, "ref_id", $this->ref_id);
422
423 $ilHelp->setScreenIdComponent("fold");
424
425 $this->tabs_gui->setTabActive("");
426 if ($ilAccess->checkAccess('read', '', $this->ref_id)) {
427 $this->tabs_gui->addTab(
428 "view_content",
429 $lng->txt("content"),
430 $this->ctrl->getLinkTarget($this, "")
431 );
432
433 //BEGIN ChangeEvent add info tab to category object
434 $force_active = $this->ctrl->getNextClass() === "ilinfoscreengui"
435 || strtolower($this->ctrl->getCmdClass()) === "ilnotegui";
436 $this->tabs_gui->addTarget(
437 "info_short",
438 $this->ctrl->getLinkTargetByClass(
439 ["ilobjfoldergui", "ilinfoscreengui"],
440 "showSummary"
441 ),
442 ["showSummary", "", "infoScreen"],
443 "",
444 "",
445 $force_active
446 );
447 //END ChangeEvent add info tab to category object
448 }
449
450 if ($rbacsystem->checkAccess('write', $this->ref_id)) {
451 $this->tabs_gui->addTarget(
452 "settings",
453 $this->ctrl->getLinkTarget($this, "edit"),
454 "edit",
455 "",
456 "",
457 ($ilCtrl->getCmd() === "edit")
458 );
459 }
460
461 // learning progress
462 if (ilLearningProgressAccess::checkAccess($this->object->getRefId())) {
463 $this->tabs_gui->addTarget(
464 'learning_progress',
465 $this->ctrl->getLinkTargetByClass(['ilobjfoldergui', 'illearningprogressgui'], ''),
466 '',
467 ['illplistofobjectsgui', 'illplistofsettingsgui', 'illearningprogressgui', 'illplistofprogressgui']
468 );
469 }
470
471 if ($ilAccess->checkAccess('write', '', $this->object->getRefId())) {
472 $this->tabs_gui->addTarget(
473 'export',
474 $this->ctrl->getLinkTargetByClass('ilexportgui', ''),
475 'export',
476 'ilexportgui'
477 );
478 }
479
480
481 if ($rbacsystem->checkAccess('edit_permission', $this->ref_id)) {
482 $this->tabs_gui->addTarget(
483 "perm_settings",
484 $this->ctrl->getLinkTargetByClass([get_class($this), 'ilpermissiongui'], "perm"),
485 ["perm", "info", "owner"],
486 'ilpermissiongui'
487 );
488 }
489 }
ilRbacSystem $rbacsystem
static checkAccess(int $a_ref_id, bool $a_allow_only_read=true)
check access to learning progress
ilAccessHandler $access
checkAccess(string $a_operations, int $a_ref_id, string $a_type="")
checkAccess represents the main method of the RBAC-system in ILIAS3 developers want to use With this ...

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

+ Here is the call graph for this function:

◆ infoScreen()

ilObjFolderGUI::infoScreen ( )
Exceptions
ilPermissionException

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

375 : void
376 {
377 $ilAccess = $this->access;
378
379 if (!$ilAccess->checkAccess("visible", "", $this->ref_id)) {
380 throw new ilPermissionException($this->lng->txt("msg_no_perm_read"));
381 }
382
383 $info = new ilInfoScreenGUI($this);
384
385 $GLOBALS['ilTabs']->activateTab('info_short');
386
387 $info->enablePrivateNotes();
388
389 if ($ilAccess->checkAccess("read", "", $this->requested_ref_id)) {
390 $info->enableNews();
391 }
392
393 // no news editing for files, just notifications
394 $info->enableNewsEditing(false);
395 if ($ilAccess->checkAccess("write", "", $this->requested_ref_id)) {
396 $news_set = new ilSetting("news");
397 $enable_internal_rss = $news_set->get("enable_rss_for_internal");
398
399 if ($enable_internal_rss) {
400 $info->setBlockProperty("news", "settings", '1');
401 $info->setBlockProperty("news", "public_notifications_option", '1');
402 }
403 }
404
405
406 // standard meta data
407 $info->addMetaDataSections($this->object->getId(), 0, $this->object->getType());
408
409 // forward the command
410 $this->ctrl->forwardCommand($info);
411 }
Class ilInfoScreenGUI.
ILIAS Setting Class.
$info
Definition: entry_point.php:21

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

Referenced by executeCommand().

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

◆ infoScreenObject()

ilObjFolderGUI::infoScreenObject ( )

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

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

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

References ILIAS\Repository\ctrl().

+ Here is the call graph for this function:

◆ initEditForm()

ilObjFolderGUI::initEditForm ( )
protected

Reimplemented from ilContainerGUI.

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

249 {
251 $obj_service = $this->getObjectService();
252
253 $lng->loadLanguageModule($this->object->getType());
254
255 $form = new ilPropertyFormGUI();
256 $form->setFormAction($this->ctrl->getFormAction($this, "update"));
257 $form->setTitle($this->lng->txt($this->object->getType() . "_edit"));
258
259 // title
260 $ti = new ilTextInputGUI($this->lng->txt("title"), "title");
261 $ti->setSize(min(40, ilObject::TITLE_LENGTH));
262 $ti->setMaxLength(ilObject::TITLE_LENGTH);
263 $ti->setRequired(true);
264 $form->addItem($ti);
265
266 // description
267 $ta = new ilTextAreaInputGUI($this->lng->txt("description"), "desc");
268 $ta->setCols(40);
269 $ta->setRows(2);
270 $form->addItem($ta);
271
272 // Show didactic template type
274
275 $pres = new ilFormSectionHeaderGUI();
276 $pres->setTitle($this->lng->txt('fold_presentation'));
277 $form->addItem($pres);
278
279 // title and icon visibility
280 $form = $obj_service->commonSettings()->legacyForm($form, $this->object)->addTitleIconVisibility();
281
282 // top actions visibility
283 $form = $obj_service->commonSettings()->legacyForm($form, $this->object)->addTopActionsVisibility();
284
285 // custom icon
286 $form = $obj_service->commonSettings()->legacyForm($form, $this->object)->addIcon();
287
288 // tile image
289 $form = $obj_service->commonSettings()->legacyForm($form, $this->object)->addTileImage();
290
291 // list presentation
293
294 $this->initSortingForm(
295 $form,
296 [
301 ]
302 );
303
304 $form->addCommandButton("update", $this->lng->txt("save"));
305 //$this->form->addCommandButton("cancelUpdate", $lng->txt("cancel"));
306
307 return $form;
308 }
initSortingForm(ilPropertyFormGUI $form, array $a_sorting_settings)
Append sorting settings to property form.
initListPresentationForm(ilPropertyFormGUI $form)
Add list presentation settings to form.
setFormAction(string $a_formaction)
This class represents a section header in a property form.
loadLanguageModule(string $a_module)
Load language module.
initDidacticTemplate(ilPropertyFormGUI $form)
const TITLE_LENGTH
This class represents a property form user interface.
addCommandButton(string $a_cmd, string $a_text, string $a_id="")
This class represents a text area property in a property form.
This class represents a text property in a property form.

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

Referenced by editObject().

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

◆ modifyItemGUI()

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

Reimplemented from ilContainerGUI.

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

513 : void
514 {
516
517 // if folder is in a course, modify item list gui according to course requirements
518 if ($course_ref_id = $tree->checkForParentType($this->object->getRefId(), 'crs')) {
519 $course_obj_id = ilObject::_lookupObjId($course_ref_id);
521 $a_item_list_gui,
522 'ilcoursecontentgui',
523 $a_item_data,
524 ilObjCourse::_lookupAboStatus($course_obj_id),
525 $course_ref_id,
526 $course_obj_id,
527 $this->object->getRefId()
528 );
529 }
530 }
static _modifyItemGUI(ilObjectListGUI $a_item_list_gui, string $a_cmd_class, array $a_item_data, bool $a_abo_status, int $a_course_ref_id, int $a_course_obj_id, int $a_parent_ref_id=0)
static _lookupAboStatus(int $a_id)

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

+ Here is the call graph for this function:

◆ renderObject()

ilObjFolderGUI::renderObject ( )

Reimplemented from ilContainerGUI.

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

92 : void
93 {
94 $ilTabs = $this->tabs;
95
96 $this->checkPermission('read');
97
98 $ilTabs->activateTab("view_content");
99 parent::renderObject();
100 }

References ilContainerGUI\$tabs, 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 ( ilTree  $a_tree)

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

243 : void
244 {
245 $this->folder_tree = $a_tree;
246 }

◆ setSubTabs()

ilObjFolderGUI::setSubTabs ( string  $a_tab)

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

586 : void
587 {
588 $ilTabs = $this->tabs;
590
591 $ilTabs->addSubTab(
592 "settings",
593 $lng->txt("fold_settings"),
594 $this->ctrl->getLinkTarget($this, 'edit')
595 );
596
597 $this->tabs_gui->addSubTab(
598 "settings_trans",
599 $this->lng->txt("obj_multilinguality"),
600 $this->ctrl->getLinkTargetByClass(TranslationGUI::class, "")
601 );
602
603 $ilTabs->activateSubTab($a_tab);
604 $ilTabs->activateTab("settings");
605 }

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

Referenced by editObject(), and executeCommand().

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

◆ showPossibleSubObjects()

ilObjFolderGUI::showPossibleSubObjects ( )
protected

show possible sub objects selection list

Reimplemented from ilContainerGUI.

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

535 : void
536 {
540 )
541 );
542 $gui->render();
543 }
Render add new item selector.
buildAddNewItemElements(array $subtypes, string $create_target_class=ilRepositoryGUI::class, ?int $redirect_target_ref_id=null,)

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

+ Here is the call graph for this function:

◆ showSummaryObject()

ilObjFolderGUI::showSummaryObject ( )

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

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

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

References ILIAS\Repository\ctrl().

+ Here is the call graph for this function:

◆ updateCustom()

ilObjFolderGUI::updateCustom ( ilPropertyFormGUI  $form)
protected

Insert custom update form values into object.

Reimplemented from ilObjectGUI.

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

318 : void
319 {
320 $obj_service = $this->getObjectService();
321
322 // title icon visibility
323 $obj_service->commonSettings()->legacyForm($form, $this->object)->saveTitleIconVisibility();
324
325 // top actions visibility
326 $obj_service->commonSettings()->legacyForm($form, $this->object)->saveTopActionsVisibility();
327
328 // custom icon
329 $obj_service->commonSettings()->legacyForm($form, $this->object)->saveIcon();
330
331 // tile image
332 $obj_service->commonSettings()->legacyForm($form, $this->object)->saveTileImage();
333
334 // list presentation
335 $this->saveListPresentation($form);
336
337 $this->saveSortingSettings($form);
338 }
saveListPresentation(ilPropertyFormGUI $form)
saveSortingSettings(ilPropertyFormGUI $form)

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

+ Here is the call graph for this function:

◆ viewObject()

ilObjFolderGUI::viewObject ( )

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

Reimplemented from ilObjectGUI.

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

72 : void
73 {
74 $this->checkPermission('read');
75 if (strtolower($this->folder_request->getBaseClass()) === "iladministrationgui") {
76 parent::viewObject();
77 return;
78 }
79
80 // Trac access - see ilObjCourseGUI
82 $GLOBALS["ilUser"]->getId(),
83 $this->object->getId(),
84 $this->object->getRefId(),
85 'fold'
86 );
87
88 $this->renderObject();
89 $this->tabs_gui->setTabActive('view_content');
90 }
static _tracProgress(int $a_user_id, int $a_obj_id, int $a_ref_id, string $a_obj_type='')

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

Referenced by executeCommand().

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

Field Documentation

◆ $folder_request

StandardGUIRequest ilObjFolderGUI::$folder_request
protected

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

◆ $folder_tree

ilTree ilObjFolderGUI::$folder_tree

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

◆ $help

ilHelpGUI ilObjFolderGUI::$help
protected

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

Referenced by getTabs().


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