ILIAS  release_9 Revision v9.13-25-g2c18ec4c24f
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
 

Private Attributes

readonly ilErrorHandling $error
 

Detailed Description

Class ilAdministratioGUI.

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

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

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

Member Function Documentation

◆ executeCommand()

ilAdministrationGUI::executeCommand ( )
Exceptions
ilCtrlException
ilPermissionException

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

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.

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

◆ forward()

ilAdministrationGUI::forward ( )

Forward to class/command.

Exceptions
ilCtrlException
ilPermissionException

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

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

251  : void
252  {
253  if ($this->admin_mode !== "repository") { // settings
254  if ($this->request->getRefId() == USER_FOLDER_ID) {
255  $this->ctrl->setParameter($this, "ref_id", USER_FOLDER_ID);
256  $this->ctrl->setParameterByClass("iladministrationgui", "admin_mode", "settings");
257  if (ilObject::_lookupType($this->request->getJumpToUserId()) === "usr") {
258  $this->ctrl->setParameterByClass(
259  "ilobjuserfoldergui",
260  "jmpToUser",
261  $this->request->getJumpToUserId()
262  );
263  $this->ctrl->redirectByClass("ilobjuserfoldergui", "jumpToUser");
264  } else {
265  $this->ctrl->redirectByClass("ilobjuserfoldergui", "view");
266  }
267  } else {
268  // this code should not be necessary anymore...
269  throw new ilPermissionException("Missing AdmiGUI parameter.");
270 
271  /*
272  $this->ctrl->setParameter($this, "ref_id", SYSTEM_FOLDER_ID);
273  $this->ctrl->setParameterByClass("iladministrationgui", "admin_mode", "settings");
274 
275 
276  if ($_GET['fr']) {
277  // Security check: We do only allow relative urls
278  $url_parts = parse_url(base64_decode(rawurldecode($_GET['fr'])));
279  if ($url_parts['http'] || $url_parts['host']) {
280  throw new ilPermissionException($this->lng->txt('permission_denied'));
281  }
282 
283  $fs_gui->setMainFrameSource(
284  base64_decode(rawurldecode($_GET['fr']))
285  );
286  ilUtil::redirect(ILIAS_HTTP_PATH . '/' . base64_decode(rawurldecode($_GET['fr'])));
287  } else {
288  $fs_gui->setMainFrameSource(
289  $this->ctrl->getLinkTargetByClass("ilobjsystemfoldergui", "view")
290  );
291  $this->ctrl->redirectByClass("ilobjsystemfoldergui", "view");
292  }*/
293  }
294  } else {
295  $this->ctrl->setParameter($this, "ref_id", ROOT_FOLDER_ID);
296  $this->ctrl->setParameterByClass("iladministrationgui", "admin_mode", "repository");
297  $this->ctrl->redirectByClass("ilobjrootfoldergui", "view");
298  }
299  }
const USER_FOLDER_ID
Definition: constants.php:33
const ROOT_FOLDER_ID
Definition: constants.php:32
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
static _lookupType(int $id, bool $reference=false)
+ Here is the call graph for this function:

◆ jump()

ilAdministrationGUI::jump ( )

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

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

323  : void
324  {
325  $ilCtrl = $this->ctrl;
327 
328  $ref_id = $this->request->getRefId();
329  $obj_id = ilObject::_lookupObjId($ref_id);
330  $obj_type = ilObject::_lookupType($obj_id);
331  $class_name = $objDefinition->getClassName($obj_type);
332  $class = strtolower("ilObj" . $class_name . "GUI");
333  $ilCtrl->setParameterByClass($class, "ref_id", $ref_id);
334  $ilCtrl->redirectByClass($class, "view");
335  }
static _lookupObjId(int $ref_id)
$ref_id
Definition: ltiauth.php:67
getClassName(string $obj_name)
ilObjectDefinition $objDefinition
static _lookupType(int $id, bool $reference=false)
+ Here is the call graph for this function:

◆ jumpToPluginSlot()

ilAdministrationGUI::jumpToPluginSlot ( )

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

References $ctrl, and ilCtrl\redirectByClass().

316  : void
317  {
318  $ilCtrl = $this->ctrl;
319  $ilCtrl->redirectByClass("ilobjcomponentsettingsgui", "listPlugins");
320  }
redirectByClass( $a_class, string $a_cmd=null, string $a_anchor=null, bool $is_async=false)
+ Here is the call graph for this function:

◆ showTree()

ilAdministrationGUI::showTree ( )

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

References $DIC, and ilAdminGSToolProvider\SHOW_ADMIN_TREE.

Referenced by executeCommand().

301  : void
302  {
303  global $DIC;
304 
305  if ($this->admin_mode !== "repository") {
306  return;
307  }
308 
309  $DIC->globalScreen()->tool()->context()->current()->addAdditionalData(ilAdminGSToolProvider::SHOW_ADMIN_TREE, true);
310 
311  $exp = new ilAdministrationExplorerGUI(self::class, "showTree");
312  $exp->handleCommand();
313  }
global $DIC
Definition: feed.php:28
Administration explorer GUI class.
+ 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().

◆ $error

readonly ilErrorHandling ilAdministrationGUI::$error
private

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

◆ $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: