ILIAS  release_8 Revision v8.24
ilAdministrationGUI Class Reference

Class ilAdministratioGUI. More...

+ Inheritance diagram for ilAdministrationGUI:
+ Collaboration diagram for ilAdministrationGUI:

Public Member Functions

 executeCommand ()
 
 forward ()
 Forward to class/command. More...
 
 showTree ()
 
 jumpToPluginSlot ()
 
 jump ()
 

Data Fields

ilLanguage $lng
 
ilGlobalTemplateInterface $tpl
 
ilTree $tree
 
ilRbacSystem $rbacsystem
 
int $cur_ref_id
 
string $cmd
 
ilCtrl $ctrl
 

Protected Attributes

ilObjectDefinition $objDefinition
 
ilHelpGUI $help
 
ilDBInterface $db
 
string $admin_mode = ""
 
bool $creation_mode = false
 
int $requested_obj_id = 0
 
AdminGUIRequest $request
 
ilObjectGUI $gui_obj
 

Detailed Description

Class ilAdministratioGUI.

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

@ilCtrl_Calls ilAdministrationGUI: ilObjGroupGUI, ilObjFolderGUI, ilObjFileGUI, ilObjCourseGUI, ilCourseObjectivesGUI @ilCtrl_Calls ilAdministrationGUI: ilObjSAHSLearningModuleGUI, ilObjChatroomGUI, ilObjForumGUI @ilCtrl_Calls ilAdministrationGUI: ilObjLearningModuleGUI, ilObjGlossaryGUI @ilCtrl_Calls ilAdministrationGUI: ilObjQuestionPoolGUI, ilObjSurveyQuestionPoolGUI, ilObjTestGUI @ilCtrl_Calls ilAdministrationGUI: ilObjSurveyGUI, ilObjExerciseGUI, ilObjMediaPoolGUI, ilObjFileBasedLMGUI @ilCtrl_Calls ilAdministrationGUI: ilObjCategoryGUI, ilObjUserGUI, ilObjRoleGUI, ilObjUserFolderGUI @ilCtrl_Calls ilAdministrationGUI: ilObjLinkResourceGUI @ilCtrl_Calls ilAdministrationGUI: ilObjRoleTemplateGUI @ilCtrl_Calls ilAdministrationGUI: ilObjRootFolderGUI, ilObjSessionGUI, ilObjPortfolioTemplateGUI @ilCtrl_Calls ilAdministrationGUI: ilObjSystemFolderGUI, ilObjRoleFolderGUI, ilObjAuthSettingsGUI @ilCtrl_Calls ilAdministrationGUI: ilObjLanguageFolderGUI, ilObjMailGUI @ilCtrl_Calls ilAdministrationGUI: ilObjObjectFolderGUI, ilObjRecoveryFolderGUI @ilCtrl_Calls ilAdministrationGUI: ilObjSearchSettingsGUI, ilObjStyleSettingsGUI @ilCtrl_Calls ilAdministrationGUI: ilObjAssessmentFolderGUI, ilObjExternalToolsSettingsGUI, ilObjUserTrackingGUI @ilCtrl_Calls ilAdministrationGUI: ilObjAdvancedEditingGUI, ilObjPrivacySecurityGUI, ilObjNewsSettingsGUI @ilCtrl_Calls ilAdministrationGUI: ilObjMediaCastGUI @ilCtrl_Calls ilAdministrationGUI: ilObjLanguageExtGUI, ilObjMDSettingsGUI, ilObjComponentSettingsGUI @ilCtrl_Calls ilAdministrationGUI: ilObjCalendarSettingsGUI, ilObjSurveyAdministrationGUI @ilCtrl_Calls ilAdministrationGUI: ilObjCategoryReferenceGUI, ilObjCourseReferenceGUI, ilObjRemoteCourseGUI, ilObjGroupReferenceGUI @ilCtrl_Calls ilAdministrationGUI: ilObjForumAdministrationGUI, ilObjBlogGUI, ilObjPollGUI, ilObjDataCollectionGUI @ilCtrl_Calls ilAdministrationGUI: ilObjRemoteCategoryGUI, ilObjRemoteWikiGUI, ilObjRemoteLearningModuleGUI @ilCtrl_Calls ilAdministrationGUI: ilObjRemoteGlossaryGUI, ilObjRemoteFileGUI, ilObjRemoteGroupGUI, ilObjECSSettingsGUI @ilCtrl_Calls ilAdministrationGUI: ilObjCloudGUI, ilObjRepositorySettingsGUI, ilObjWebResourceAdministrationGUI @ilCtrl_Calls ilAdministrationGUI: ilObjCourseAdministrationGUI, ilObjGroupAdministrationGUI, ilObjExerciseAdministrationGUI @ilCtrl_Calls ilAdministrationGUI: ilObjTaxonomyAdministrationGUI, ilObjLoggingSettingsGUI @ilCtrl_Calls ilAdministrationGUI: ilObjBibliographicAdminGUI, ilObjBibliographicGUI @ilCtrl_Calls ilAdministrationGUI: ilObjStudyProgrammeAdminGUI, ilObjStudyProgrammeGUI @ilCtrl_Calls ilAdministrationGUI: ilObjBadgeAdministrationGUI, ilMemberExportSettingsGUI @ilCtrl_Calls ilAdministrationGUI: ilObjFileAccessSettingsGUI, ilPermissionGUI, ilObjRemoteTestGUI, ilPropertyFormGUI @ilCtrl_Calls ilAdministrationGUI: ilObjCmiXapiAdministrationGUI, ilObjCmiXapiGUI, ilObjLTIConsumerGUI @ilCtrl_Calls ilAdministrationGUI: ilObjLearningSequenceAdminGUI, ilObjContentPageAdministrationGUI, ilObjPDFGenerationGUI @ilCtrl_Calls ilAdministrationGUI: ilObjIndividualAssessmentGUI

Definition at line 61 of file class.ilAdministrationGUI.php.

Member Function Documentation

◆ executeCommand()

ilAdministrationGUI::executeCommand ( )
Exceptions
ilCtrlException
ilPermissionException

Definition at line 134 of file class.ilAdministrationGUI.php.

134 : void
135 {
138 $ilHelp = $this->help;
140
141 // permission checks
142 if (!$rbacsystem->checkAccess("visible", SYSTEM_FOLDER_ID) &&
144 throw new ilPermissionException($this->lng->txt('permission_denied'));
145 }
146
147 // check creation mode
148 // determined by "new_type" parameter
149 $new_type = $this->request->getNewType();
150 if ($new_type) {
151 $this->creation_mode = true;
152 }
153 // determine next class
154 if ($this->creation_mode) {
155 $obj_type = $new_type;
156 $class_name = $this->objDefinition->getClassName($obj_type);
157 $next_class = strtolower("ilObj" . $class_name . "GUI");
158 $this->ctrl->setCmdClass($next_class);
159 }
160
161 // set next_class directly for page translations
162 // (no cmdNode is given in translation link)
163 if ($this->ctrl->getCmdClass() === "ilobjlanguageextgui") {
164 $next_class = "ilobjlanguageextgui";
165 } else {
166 $next_class = $this->ctrl->getNextClass($this);
167 }
168
169 if ((
170 $next_class === "iladministrationgui" || $next_class == ""
171 ) && ($this->ctrl->getCmd() === "return")) {
172 // get GUI of current object
173 $obj_type = ilObject::_lookupType($this->cur_ref_id, true);
174 $class_name = $this->objDefinition->getClassName($obj_type);
175 $next_class = strtolower("ilObj" . $class_name . "GUI");
176 $this->ctrl->setCmdClass($next_class);
177 $this->ctrl->setCmd("view");
178 }
179
180 $cmd = $this->ctrl->getCmd("forward");
181
182 //echo "<br>cmd:$cmd:nextclass:$next_class:-".$_GET["cmdClass"]."-".$_GET["cmd"]."-";
183 switch ($next_class) {
184 default:
185
186 // forward all other classes to gui commands
187 if ($next_class != "" && $next_class !== "iladministrationgui") {
188 // check db update
189 $dbupdate = new ilDBUpdate($ilDB);
190 if (!$dbupdate->getDBVersionStatus()) {
191 $this->tpl->setOnScreenMessage('failure', $this->lng->txt("db_need_update"));
192 } elseif ($dbupdate->hotfixAvailable()) {
193 $this->tpl->setOnScreenMessage('failure', $this->lng->txt("db_need_hotfix"));
194 }
195
196 $class_path = $this->ctrl->lookupClassPath($next_class);
197 if (is_file($class_path)) {
198 require_once $class_path; // note: org unit plugins still need the require
199 }
200 // get gui class instance
201 $class_name = $this->ctrl->getClassForClasspath($class_path);
202 if (($next_class === "ilobjrolegui" || $next_class === "ilobjusergui"
203 || $next_class === "ilobjroletemplategui")) {
204 if ($this->requested_obj_id > 0) {
205 $this->gui_obj = new $class_name(null, $this->requested_obj_id, false, false);
206 $this->gui_obj->setCreationMode(false);
207 } else {
208 $this->gui_obj = new $class_name(null, $this->cur_ref_id, true, false);
209 $this->gui_obj->setCreationMode(true);
210 }
211 } else {
212 if ($objDefinition->isPlugin(ilObject::_lookupType($this->cur_ref_id, true))) {
213 $this->gui_obj = new $class_name($this->cur_ref_id);
214 } else {
215 if (!$this->creation_mode) {
216 if (is_subclass_of($class_name, "ilObject2GUI")) {
217 $this->gui_obj = new $class_name($this->cur_ref_id, ilObject2GUI::REPOSITORY_NODE_ID);
218 } else {
219 $this->gui_obj = new $class_name(null, $this->cur_ref_id, true, false);
220 }
221 } else {
222 if (is_subclass_of($class_name, "ilObject2GUI")) {
223 $this->gui_obj = new $class_name(null, ilObject2GUI::REPOSITORY_NODE_ID, $this->cur_ref_id);
224 } else {
225 $this->gui_obj = new $class_name("", 0, true, false);
226 }
227 }
228 }
229 $this->gui_obj->setCreationMode($this->creation_mode);
230 }
231 $this->gui_obj->setAdminMode($this->admin_mode);
232 $tabs_out = true;
233 $ilHelp->setScreenIdComponent(ilObject::_lookupType($this->cur_ref_id, true));
234 $this->showTree();
235
236 $this->ctrl->setReturn($this, "return");
237 $ret = $this->ctrl->forwardCommand($this->gui_obj);
238 $html = $this->gui_obj->getHTML();
239
240 if ($html != "") {
241 $this->tpl->setVariable("OBJECTS", $html);
242 }
243 $this->tpl->printToStdout();
244 } else { //
245 $cmd = $this->ctrl->getCmd("forward");
246 $this->$cmd();
247 }
248 break;
249 }
250 }
ilObjectDefinition $objDefinition
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
isPlugin(string $obj_name)
get RBAC status by type returns true if object type is an (activated) plugin type
static _lookupType(int $id, bool $reference=false)
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
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 ...
const SYSTEM_FOLDER_ID
Definition: constants.php:35

References $cmd, $db, $help, $ilDB, $objDefinition, $rbacsystem, ilObject\_lookupType(), ilRbacSystem\checkAccess(), ILIAS\Repository\ctrl(), ilObjectDefinition\isPlugin(), ILIAS\Repository\lng(), ilObject2GUI\REPOSITORY_NODE_ID, showTree(), and SYSTEM_FOLDER_ID.

+ Here is the call graph for this function:

◆ forward()

ilAdministrationGUI::forward ( )

Forward to class/command.

Exceptions
ilCtrlException
ilPermissionException

Definition at line 257 of file class.ilAdministrationGUI.php.

257 : void
258 {
259 if ($this->admin_mode !== "repository") { // settings
260 if ($this->request->getRefId() == USER_FOLDER_ID) {
261 $this->ctrl->setParameter($this, "ref_id", USER_FOLDER_ID);
262 $this->ctrl->setParameterByClass("iladministrationgui", "admin_mode", "settings");
263 if (ilObject::_lookupType($this->request->getJumpToUserId()) === "usr") {
264 $this->ctrl->setParameterByClass(
265 "ilobjuserfoldergui",
266 "jmpToUser",
267 $this->request->getJumpToUserId()
268 );
269 $this->ctrl->redirectByClass("ilobjuserfoldergui", "jumpToUser");
270 } else {
271 $this->ctrl->redirectByClass("ilobjuserfoldergui", "view");
272 }
273 } else {
274
275 // this code should not be necessary anymore...
276 throw new ilPermissionException("Missing AdmiGUI parameter.");
277
278 /*
279 $this->ctrl->setParameter($this, "ref_id", SYSTEM_FOLDER_ID);
280 $this->ctrl->setParameterByClass("iladministrationgui", "admin_mode", "settings");
281
282
283 if ($_GET['fr']) {
284 // Security check: We do only allow relative urls
285 $url_parts = parse_url(base64_decode(rawurldecode($_GET['fr'])));
286 if ($url_parts['http'] || $url_parts['host']) {
287 throw new ilPermissionException($this->lng->txt('permission_denied'));
288 }
289
290 $fs_gui->setMainFrameSource(
291 base64_decode(rawurldecode($_GET['fr']))
292 );
293 ilUtil::redirect(ILIAS_HTTP_PATH . '/' . base64_decode(rawurldecode($_GET['fr'])));
294 } else {
295 $fs_gui->setMainFrameSource(
296 $this->ctrl->getLinkTargetByClass("ilobjsystemfoldergui", "view")
297 );
298 $this->ctrl->redirectByClass("ilobjsystemfoldergui", "view");
299 }*/
300 }
301 } else {
302 $this->ctrl->setParameter($this, "ref_id", ROOT_FOLDER_ID);
303 $this->ctrl->setParameterByClass("iladministrationgui", "admin_mode", "repository");
304 $this->ctrl->redirectByClass("ilobjrootfoldergui", "view");
305 }
306 }
const USER_FOLDER_ID
Definition: constants.php:33
const ROOT_FOLDER_ID
Definition: constants.php:32

References ilObject\_lookupType(), ILIAS\Repository\ctrl(), ROOT_FOLDER_ID, and USER_FOLDER_ID.

+ Here is the call graph for this function:

◆ jump()

ilAdministrationGUI::jump ( )

Definition at line 330 of file class.ilAdministrationGUI.php.

330 : void
331 {
332 $ilCtrl = $this->ctrl;
334
335 $ref_id = $this->request->getRefId();
337 $obj_type = ilObject::_lookupType($obj_id);
338 $class_name = $objDefinition->getClassName($obj_type);
339 $class = strtolower("ilObj" . $class_name . "GUI");
340 $ilCtrl->setParameterByClass($class, "ref_id", $ref_id);
341 $ilCtrl->redirectByClass($class, "view");
342 }
getClassName(string $obj_name)
static _lookupObjId(int $ref_id)
$ref_id
Definition: ltiauth.php:67

References $ctrl, $objDefinition, $ref_id, ilObject\_lookupObjId(), ilObject\_lookupType(), and ilObjectDefinition\getClassName().

+ Here is the call graph for this function:

◆ jumpToPluginSlot()

ilAdministrationGUI::jumpToPluginSlot ( )

Definition at line 323 of file class.ilAdministrationGUI.php.

323 : void
324 {
325 $ilCtrl = $this->ctrl;
326 $ilCtrl->redirectByClass("ilobjcomponentsettingsgui", "listPlugins");
327 }
redirectByClass( $a_class, string $a_cmd=null, string $a_anchor=null, bool $is_async=false)
@inheritDoc

References $ctrl, and ilCtrl\redirectByClass().

+ Here is the call graph for this function:

◆ showTree()

ilAdministrationGUI::showTree ( )

Definition at line 308 of file class.ilAdministrationGUI.php.

308 : void
309 {
310 global $DIC;
311
312 if ($this->admin_mode !== "repository") {
313 return;
314 }
315
316 $DIC->globalScreen()->tool()->context()->current()->addAdditionalData(ilAdminGSToolProvider::SHOW_ADMIN_TREE, true);
317
318 $exp = new ilAdministrationExplorerGUI(self::class, "showTree");
319 $exp->handleCommand();
320 }
Administration explorer GUI class.
global $DIC
Definition: feed.php:28

References $DIC, and ilAdminGSToolProvider\SHOW_ADMIN_TREE.

Referenced by executeCommand().

+ Here is the caller graph for this function:

Field Documentation

◆ $admin_mode

string ilAdministrationGUI::$admin_mode = ""
protected

Definition at line 73 of file class.ilAdministrationGUI.php.

◆ $cmd

string ilAdministrationGUI::$cmd

Definition at line 71 of file class.ilAdministrationGUI.php.

Referenced by executeCommand().

◆ $creation_mode

bool ilAdministrationGUI::$creation_mode = false
protected

Definition at line 74 of file class.ilAdministrationGUI.php.

◆ $ctrl

ilCtrl ilAdministrationGUI::$ctrl

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

Referenced by jump(), and jumpToPluginSlot().

◆ $cur_ref_id

int ilAdministrationGUI::$cur_ref_id

Definition at line 70 of file class.ilAdministrationGUI.php.

◆ $db

ilDBInterface ilAdministrationGUI::$db
protected

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

Referenced by executeCommand().

◆ $gui_obj

ilObjectGUI ilAdministrationGUI::$gui_obj
protected

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

◆ $help

ilHelpGUI ilAdministrationGUI::$help
protected

Definition at line 64 of file class.ilAdministrationGUI.php.

Referenced by executeCommand().

◆ $lng

ilLanguage ilAdministrationGUI::$lng

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

◆ $objDefinition

ilObjectDefinition ilAdministrationGUI::$objDefinition
protected

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

Referenced by executeCommand(), and jump().

◆ $rbacsystem

ilRbacSystem ilAdministrationGUI::$rbacsystem

Definition at line 69 of file class.ilAdministrationGUI.php.

Referenced by executeCommand().

◆ $request

AdminGUIRequest ilAdministrationGUI::$request
protected

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

◆ $requested_obj_id

int ilAdministrationGUI::$requested_obj_id = 0
protected

Definition at line 75 of file class.ilAdministrationGUI.php.

◆ $tpl

ilGlobalTemplateInterface ilAdministrationGUI::$tpl

Definition at line 67 of file class.ilAdministrationGUI.php.

◆ $tree

ilTree ilAdministrationGUI::$tree

Definition at line 68 of file class.ilAdministrationGUI.php.


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