ILIAS  trunk Revision v12.0_alpha-377-g3641b37b9db
ilObjHelpSettingsGUI Class Reference

@ilCtrl_Calls ilObjHelpSettingsGUI: ilPermissionGUI, ilGuidedTourAdminGUI @ilCtrl_isCalledBy ilObjHelpSettingsGUI: ilAdministrationGUI More...

+ Inheritance diagram for ilObjHelpSettingsGUI:
+ Collaboration diagram for ilObjHelpSettingsGUI:

Public Member Functions

 __construct (int $a_id=0, int $a_id_type=self::REPOSITORY_NODE_ID, int $a_parent_node_id=0)
 
 getType ()
 Functions that must be overwritten. More...
 
 executeCommand ()
 execute command More...
 
 editSettings ()
 
 getAdminTabs ()
 administration tabs show only permissions and trash folder More...
 
 uploadHelpFile ()
 
 confirmHelpModulesDeletion ()
 
 deleteHelpModules ()
 
 activateModule ()
 
 deactivateModule ()
 
 setMode ()
 
 saveOrdering ()
 
- Public Member Functions inherited from ilObject2GUI
 __construct (int $id=0, int $id_type=self::REPOSITORY_NODE_ID, int $parent_node_id=0)
 
 executeCommand ()
 execute command More...
 
 getIdType ()
 
 delete ()
 Display delete confirmation form (repository/workspace switch) More...
 
 confirmedDelete ()
 Delete objects (repository/workspace switch) More...
 
 getHTML ()
 
 withReferences ()
 Final/Private declaration of unchanged parent methods. 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)
 
 isVisible (int $ref_id, string $type)
 
 setColumnSettings (ilColumnGUI $column_gui)
 
 view ()
 view object content (repository/workspace switch) More...
 
 getType ()
 Functions that must be overwritten. More...
 
 create ()
 CRUD. More...
 
 save ()
 
 edit ()
 
 update ()
 
 cancel ()
 
 putObjectInTree (ilObject $obj, ?int $parent_node_id=null)
 Add object to tree at given position. More...
 
- 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)
 

Protected Attributes

ILIAS Help InternalGUIService $gui
 
ILIAS Help InternalDomainService $domain
 
StandardGUIRequest $help_request
 
ilTabsGUI $tabs
 
- Protected Attributes inherited from ilObject2GUI
ilObjectDefinition $obj_definition
 
ilGlobalTemplateInterface $tpl
 
ilCtrl $ctrl
 
ilLanguage $lng
 
ilTabsGUI $tabs_gui
 
ilFavouritesManager $favourites
 
ilErrorHandling $error
 
ilLocatorGUI $locator
 
ilObjUser $user
 
ilAccessHandler $access
 
ilToolbarGUI $toolbar
 
Factory $refinery
 
ilRbacAdmin $rbac_admin
 
ilRbacSystem $rbac_system
 
ilRbacReview $rbac_review
 
int $request_ref_id
 
int $id_type
 
int $parent_id
 
string $type
 
string $html
 
int $object_id
 
int $node_id = null
 
array $creation_forms = []
 
 $access_handler
 
- 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 = ""
 

Additional Inherited Members

- Static Public Member Functions inherited from ilObject2GUI
static handleAfterSaveCallback (ilObject $obj, ?int $callback_ref_id)
 After creation callback. 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 inherited from ilObject2GUI
const OBJECT_ID = 0
 
const REPOSITORY_NODE_ID = 1
 
const WORKSPACE_NODE_ID = 2
 
const REPOSITORY_OBJECT_ID = 3
 
const WORKSPACE_OBJECT_ID = 4
 
const PORTFOLIO_OBJECT_ID = 5
 
- 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 inherited from ilObject2GUI
 afterConstructor ()
 Do anything that should be done after constructor in here. More...
 
 assignObject ()
 create object instance as internal property (repository/workspace switch) More...
 
 getAccessHandler ()
 
 setLocator ()
 set Locator More...
 
 deleteConfirmedObjects ()
 Delete objects (workspace specific) This should probably be moved elsewhere as done with RepUtil. More...
 
 setTitleAndDescription ()
 
 omitLocator (bool $omit=true)
 
 getTargetFrame (string $cmd, string $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...
 
 getCenterColumnHTML ()
 Get center column. More...
 
 getRightColumnHTML ()
 Display right column. More...
 
 checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
 
 showPossibleSubObjects ()
 show possible sub objects (pull down menu) 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...
 
 addAdminLocatorItems (bool $do_not_add_object=false)
 should be overwritten to add object specific items (repository items are preloaded) More...
 
 setTabs ()
 create tabs (repository/workspace switch) More...
 
 getReturnLocation (string $cmd, string $location="")
 Deprecated functions. More...
 
 setReturnLocation (string $cmd, string $location)
 set specific return location for command More...
 
 showActions ()
 
 getTabs ()
 @abstract overwrite in derived GUI class of your object type More...
 
 addLocatorItems ()
 Functions to be overwritten. More...
 
 checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $node_id=null)
 
 initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
 Add header action menu. More...
 
 redrawHeaderAction ()
 Updating icons after ajax call. More...
 
- 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)
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

ilObjHelpSettingsGUI::__construct ( int  $a_id = 0,
int  $a_id_type = self::REPOSITORY_NODE_ID,
int  $a_parent_node_id = 0 
)

Reimplemented from ilObject2GUI.

Definition at line 32 of file class.ilObjHelpSettingsGUI.php.

36 {
37 global $DIC;
38
39 parent::__construct($a_id, $a_id_type, $a_parent_node_id);
40
41 $service = $DIC->help()->internal();
42
43 $this->domain = $domain = $service->domain();
44 $this->gui = $gui = $service->gui();
45
46 $this->access = $domain->access();
47 $this->lng = $domain->lng();
48 $this->settings = $domain->settings();
49
50 $this->ctrl = $gui->ctrl();
51 $this->tabs = $gui->tabs();
52 $this->toolbar = $gui->toolbar();
53 $this->tpl = $gui->ui()->mainTemplate();
54
55 $this->help_request = $gui->standardRequest();
56 }
ILIAS Help InternalGUIService $gui
ILIAS Help InternalDomainService $domain
$service
Definition: ltiresult.php:36
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc
global $DIC
Definition: shib_login.php:26

References $DIC, $domain, $gui, $service, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), ILIAS\Repository\tabs(), and ILIAS\Repository\toolbar().

+ Here is the call graph for this function:

Member Function Documentation

◆ activateModule()

ilObjHelpSettingsGUI::activateModule ( )

Definition at line 208 of file class.ilObjHelpSettingsGUI.php.

208 : void
209 {
210 $this->checkPermission("write");
211 $this->domain->module()->activate($this->help_request->getHelpModuleId());
212 $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
213 $this->ctrl->redirect($this, "editSettings");
214 }
checkPermission(string $perm, string $cmd="", string $type="", ?int $ref_id=null)

References ilObject2GUI\checkPermission(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

+ Here is the call graph for this function:

◆ confirmHelpModulesDeletion()

ilObjHelpSettingsGUI::confirmHelpModulesDeletion ( )

Definition at line 174 of file class.ilObjHelpSettingsGUI.php.

174 : void
175 {
176 $this->checkPermission("write");
177
178 $ids = $this->help_request->getIds();
179
180 if (count($ids) === 0) {
181 $this->tpl->setOnScreenMessage('info', $this->lng->txt("no_checkbox"), true);
182 $this->ctrl->redirect($this, "editSettings");
183 } else {
184 $cgui = new ilConfirmationGUI();
185 $cgui->setFormAction($this->ctrl->getFormAction($this));
186 $cgui->setHeaderText($this->lng->txt("help_sure_delete_help_modules"));
187 $cgui->setCancel($this->lng->txt("cancel"), "editSettings");
188 $cgui->setConfirm($this->lng->txt("delete"), "deleteHelpModules");
189
190 foreach ($ids as $i) {
191 $cgui->addItem("id[]", $i, $this->domain->module()->lookupModuleLmId($i));
192 }
193
194 $this->tpl->setContent($cgui->getHTML());
195 }
196 }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...

References ilObject2GUI\checkPermission(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

+ Here is the call graph for this function:

◆ deactivateModule()

ilObjHelpSettingsGUI::deactivateModule ( )

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

216 : void
217 {
218 $this->checkPermission("write");
219 $this->domain->module()->deactivate($this->help_request->getHelpModuleId());
220 $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
221 $this->ctrl->redirect($this, "editSettings");
222 }

References ilObject2GUI\checkPermission(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

+ Here is the call graph for this function:

◆ deleteHelpModules()

ilObjHelpSettingsGUI::deleteHelpModules ( )

Definition at line 198 of file class.ilObjHelpSettingsGUI.php.

198 : void
199 {
200 $this->checkPermission("write");
201 $ids = $this->help_request->getIds();
202 foreach ($ids as $i) {
203 $this->domain->module()->deleteModule((int) $i);
204 }
205 $this->ctrl->redirect($this, "editSettings");
206 }

References ilObject2GUI\checkPermission(), and ILIAS\Repository\ctrl().

+ Here is the call graph for this function:

◆ editSettings()

ilObjHelpSettingsGUI::editSettings ( )

Definition at line 99 of file class.ilObjHelpSettingsGUI.php.

99 : void
100 {
101 $this->tabs->activateTab("settings");
102
103 if ($this->domain->module()->isAuthoringMode()) {
104 $this->tpl->setOnScreenMessage('info', "This installation is used for online help authoring. Help modules cannot be imported.");
105 return;
106 }
107
108 if ($this->checkPermissionBool("write")) {
109 // help file
110 $fi = new ilFileInputGUI($this->lng->txt("help_help_file"), "help_file");
111 $fi->setSuffixes(array("zip"));
112 $this->toolbar->addInputItem($fi, true);
113 $this->toolbar->addFormButton($this->lng->txt("upload"), "uploadHelpFile");
114 $this->toolbar->addSeparator();
115
116 // help mode
117 $options = array(
118 "" => $this->lng->txt("help_tooltips_and_help"),
119 "1" => $this->lng->txt("help_help_only"),
120 "2" => $this->lng->txt("help_tooltips_only")
121 );
122 $si = new ilSelectInputGUI($this->lng->txt("help_mode"), "help_mode");
123 $si->setOptions($options);
124 $si->setValue($this->settings->get("help_mode"));
125 $this->toolbar->addInputItem($si);
126
127 $this->toolbar->addFormButton($this->lng->txt("help_set_mode"), "setMode");
128 }
129 $this->toolbar->setFormAction($this->ctrl->getFormAction($this), true);
130
131 $table = new ilHelpModuleTableGUI($this, "editSettings", $this->checkPermissionBool("write"));
132
133 $this->tpl->setContent($table->getHTML());
134 }
This class represents a file property in a property form.
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
checkPermissionBool(string $perm, string $cmd="", string $type="", ?int $node_id=null)
This class represents a selection list property in a property form.

References ILIAS\UI\Implementation\Component\Input\Field\$options, ilObject2GUI\checkPermissionBool(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), ILIAS\Repository\tabs(), and ILIAS\Repository\toolbar().

+ Here is the call graph for this function:

◆ executeCommand()

ilObjHelpSettingsGUI::executeCommand ( )

execute command

Reimplemented from ilObject2GUI.

Definition at line 63 of file class.ilObjHelpSettingsGUI.php.

63 : void
64 {
65 $this->lng->loadLanguageModule("help");
66
67 $next_class = $this->ctrl->getNextClass($this);
68 $cmd = $this->ctrl->getCmd();
69
70 $this->prepareOutput();
71
72 if (!$this->rbac_system->checkAccess("read", $this->object->getRefId())) {
73 throw new ilPermissionException($this->lng->txt('no_permission'));
74 }
75
76 switch ($next_class) {
77
78 case strtolower(ilGuidedTourAdminGUI::class):
79 $this->tabs_gui->setTabActive('guided_tour');
80 $gui = $this->gui->guidedTour()->adminGUI();
81 $this->ctrl->forwardCommand($gui);
82 break;
83
84 case strtolower(ilPermissionGUI::class):
85 $this->tabs_gui->setTabActive('perm_settings');
86 $perm_gui = new ilPermissionGUI($this);
87 $this->ctrl->forwardCommand($perm_gui);
88 break;
89
90 default:
91 if (!$cmd || $cmd === 'view') {
92 $cmd = "editSettings";
93 }
94 $this->$cmd();
95 break;
96 }
97 }
prepareOutput(bool $show_sub_objects=true)

References $gui, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilObject2GUI\prepareOutput().

+ Here is the call graph for this function:

◆ getAdminTabs()

ilObjHelpSettingsGUI::getAdminTabs ( )

administration tabs show only permissions and trash folder

Reimplemented from ilObjectGUI.

Definition at line 136 of file class.ilObjHelpSettingsGUI.php.

136 : void
137 {
138 if ($this->checkPermissionBool("read")) {
139 $this->tabs_gui->addTab(
140 "settings",
141 $this->lng->txt("settings"),
142 $this->ctrl->getLinkTarget($this, "editSettings")
143 );
144 $this->tabs_gui->addTab(
145 "guided_tour",
146 $this->lng->txt("guided_tour"),
147 $this->ctrl->getLinkTargetByClass(ilGuidedTourAdminGUI::class)
148 );
149 }
150
151 if ($this->checkPermissionBool("edit_permission")) {
152 $this->tabs_gui->addTab(
153 "perm_settings",
154 $this->lng->txt("perm_settings"),
155 $this->ctrl->getLinkTargetByClass(array(get_class($this),'ilpermissiongui'), "perm")
156 );
157 }
158 }

References ilObject2GUI\checkPermissionBool(), and ILIAS\Repository\lng().

+ Here is the call graph for this function:

◆ getType()

ilObjHelpSettingsGUI::getType ( )

Functions that must be overwritten.

Reimplemented from ilObject2GUI.

Definition at line 58 of file class.ilObjHelpSettingsGUI.php.

58 : string
59 {
60 return "hlps";
61 }

◆ saveOrdering()

ilObjHelpSettingsGUI::saveOrdering ( )

Definition at line 238 of file class.ilObjHelpSettingsGUI.php.

238 : void
239 {
240 $this->checkPermission("write");
241 $this->domain->module()->saveOrder($this->help_request->getOrder());
242 $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
243 $this->ctrl->redirect($this, "editSettings");
244 }

References ilObject2GUI\checkPermission(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

+ Here is the call graph for this function:

◆ setMode()

ilObjHelpSettingsGUI::setMode ( )

Definition at line 224 of file class.ilObjHelpSettingsGUI.php.

224 : void
225 {
226 $this->checkPermission("write");
227 if ($this->checkPermissionBool("write")) {
228 $this->settings->set(
229 "help_mode",
230 $this->help_request->getHelpMode()
231 );
232 $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
233 }
234
235 $this->ctrl->redirect($this, "editSettings");
236 }

References ilObject2GUI\checkPermission(), ilObject2GUI\checkPermissionBool(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\settings().

+ Here is the call graph for this function:

◆ uploadHelpFile()

ilObjHelpSettingsGUI::uploadHelpFile ( )

Definition at line 160 of file class.ilObjHelpSettingsGUI.php.

160 : void
161 {
162 if (!isset($_FILES["help_file"]["tmp_name"]) || $_FILES["help_file"]["tmp_name"] === "") {
163 $this->tpl->setOnScreenMessage('failure', $this->lng->txt("help_select_a_file"), true);
164 $this->ctrl->redirect($this, "editSettings");
165 }
166 if ($this->checkPermissionBool("write")) {
167 $this->domain->module()->upload($_FILES["help_file"]);
168 $this->tpl->setOnScreenMessage('success', $this->lng->txt("help_module_uploaded"), true);
169 }
170
171 $this->ctrl->redirect($this, "editSettings");
172 }

References ilObject2GUI\checkPermissionBool(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

+ Here is the call graph for this function:

Field Documentation

◆ $domain

ILIAS Help InternalDomainService ilObjHelpSettingsGUI::$domain
protected

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

Referenced by __construct().

◆ $gui

ILIAS Help InternalGUIService ilObjHelpSettingsGUI::$gui
protected

Definition at line 27 of file class.ilObjHelpSettingsGUI.php.

Referenced by __construct(), and executeCommand().

◆ $help_request

StandardGUIRequest ilObjHelpSettingsGUI::$help_request
protected

Definition at line 29 of file class.ilObjHelpSettingsGUI.php.

◆ $tabs

ilTabsGUI ilObjHelpSettingsGUI::$tabs
protected

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


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