Inheritance diagram for ilAdministrationGUI:

Collaboration diagram for ilAdministrationGUI:

Public Member Functions
	__construct ()

	executeCommand ()

Private Member Functions
	forward ()
	Redirect in special cases. More...

	showTree ()
	Show the repository tree in the slate This command is used by ilAdministrationExplorerGUI the for administration mode of the repository. More...

	jumpToPluginSlot ()
	Special jump to plugin slot after ilCtrl has been reloaded Ths command is used by ilObjComponentSettingsGUI for plugin updates. More...

	jump ()
	Jump to the GUI of an administration node This command is used by AdministrationMainBarProvider for the nodes in the admin menu. More...

Private Attributes
const array	COMMANDS = ['forward', 'jump', 'jumpToPluginSlot', 'showTree']

readonly ilObjectDefinition	$obj_definition

readonly ilHelpGUI	$help

readonly ilLanguage	$lng

readonly ilGlobalTemplateInterface	$tpl

readonly ilTree	$tree

readonly ilAccessHandler	$access

readonly ilRbacReview	$rbac_review

readonly ilObjUser	$user

readonly ilCtrl	$ctrl

readonly AdminGUIRequest	$request

readonly GlobalScreen	$global_screen

readonly ilLogger	$logger

int	$cur_ref_id

string	$admin_mode = ""

int	$requested_obj_id = 0

ilObjectGUI	$gui_obj

Detailed Description

Class ilAdministrationGUI.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilAdministrationGUI::__construct ( )

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

    {
        global $DIC;
 
        $this->help = $DIC["ilHelp"];
        $this->logger = $DIC->logger()->root();
        $this->lng = $DIC->language();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->tree = $DIC->repositoryTree();
        $this->access = $DIC->access();
        $this->user = $DIC->user();
        $this->rbac_review = $DIC->rbac()->review();
        $this->obj_definition = $DIC["objDefinition"];
        $this->ctrl = $DIC->ctrl();
        $this->global_screen = $DIC->globalScreen();
 
        $this->lng->loadLanguageModule('administration');
        $this->lng->loadLanguageModule('benchmark');
 
        $context = $this->global_screen->tool()->context();
        $context->claim()->administration();
 
        $this->request = new AdminGUIRequest(
            $DIC->http(),
            $DIC->refinery()
        );
 
        $this->ctrl->saveParameter($this, array("ref_id", "admin_mode"));
 
        $this->admin_mode = $this->request->getAdminMode();
        if ($this->admin_mode !== ilObjectGUI::ADMIN_MODE_REPOSITORY) {
            $this->admin_mode = ilObjectGUI::ADMIN_MODE_SETTINGS;
        }
 
        $this->ctrl->setReturn($this, "");
 
        // determine current ref id and mode
        $ref_id = $this->request->getRefId();
        if ($this->tree->isInTree($ref_id)) {
            $this->cur_ref_id = $ref_id;
        } else {
            throw new ilPermissionException("Invalid ref id.");
        }
 
        $this->requested_obj_id = $this->request->getObjId();
    }

References $context, $DIC, $ref_id, ILIAS\Repository\access(), ilObjectGUI\ADMIN_MODE_REPOSITORY, ilObjectGUI\ADMIN_MODE_SETTINGS, ILIAS\Repository\ctrl(), ILIAS\Repository\help(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilAdministrationGUI::executeCommand ( )

Exceptions

ilCtrlException
ilPermissionException

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

                                    : void
    {
        // check the basic permission
        // - admin nodes and their childs (e.g. org units) must have read permission to be called
        // - admin mode for repository and trash is only available to the global admin role
        $has_access = false;
        if ($this->cur_ref_id === SYSTEM_FOLDER_ID || $this->tree->isGrandChild(SYSTEM_FOLDER_ID, $this->cur_ref_id)) {
            $has_access = $this->access->checkAccess('read', '', $this->cur_ref_id);
        } else {
            $has_access = $this->rbac_review->isAssigned($this->user->getId(), SYSTEM_ROLE_ID);
        }
        if (!$has_access) {
            $this->logger->log($this->lng->txt('permission_denied'), ilLogLevel::INFO);
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
            $this->ctrl->redirectToURL(
                ilUserUtil::getStartingPointAsUrl()
            );
        }
 
        // check creation mode
        // determined by "new_type" parameter
        // e.g. creation of a new role, user org unit, talk template
        $new_type = $this->request->getNewType();
        if ($new_type) {
            $creation_mode = true;
            $obj_type = $new_type;
            $class_name = $this->obj_definition->getClassName($obj_type);
            $next_class = strtolower("ilObj" . $class_name . "GUI");
        } else {
            $creation_mode = false;
        }
 
        // set next_class directly for page translations
        // (no cmdNode is given in translation link)
        if ($this->ctrl->getCmdClass() === "ilobjlanguageextgui") {
            $next_class = "ilobjlanguageextgui";
        } else {
            $next_class = $this->ctrl->getNextClass($this);
        }
 
        if ((
            $next_class === "iladministrationgui" || $next_class == ""
        ) && ($this->ctrl->getCmd() === "return")) {
            // get GUI of current object
            $obj_type = ilObject::_lookupType($this->cur_ref_id, true);
            $class_name = $this->obj_definition->getClassName($obj_type);
            $next_class = strtolower("ilObj" . $class_name . "GUI");
        }
 
        // forward all other classes to gui commands
        if ($next_class != "" && $next_class !== "iladministrationgui") {
            $class_path = $this->ctrl->lookupClassPath($next_class);
            if (is_file($class_path)) {
                require_once $class_path;   // note: org unit plugins still need the require
            }
            // get gui class instance
            $class_name = $this->ctrl->getClassForClasspath($class_path);
            if (($next_class === "ilobjrolegui" || $next_class === "ilobjusergui"
                || $next_class === "ilobjroletemplategui")) {
                if ($this->requested_obj_id > 0) {
                    $this->gui_obj = new $class_name(null, $this->requested_obj_id, false, false);
                    $this->gui_obj->setCreationMode(false);
                } else {
                    $this->gui_obj = new $class_name(null, $this->cur_ref_id, true, false);
                    $this->gui_obj->setCreationMode(true);
                }
            } else {
                if ($this->obj_definition->isPlugin(ilObject::_lookupType($this->cur_ref_id, true))) {
                    $this->gui_obj = new $class_name($this->cur_ref_id);
                } elseif (!$creation_mode) {
                    if (is_subclass_of($class_name, "ilObject2GUI")) {
                        $this->gui_obj = new $class_name($this->cur_ref_id, ilObject2GUI::REPOSITORY_NODE_ID);
                    } else {
                        $this->gui_obj = new $class_name(null, $this->cur_ref_id, true, false);
                    }
                } else {
                    if (is_subclass_of($class_name, "ilObject2GUI")) {
                        $this->gui_obj = new $class_name(null, ilObject2GUI::REPOSITORY_NODE_ID, $this->cur_ref_id);
                    } else {
                        $this->gui_obj = new $class_name("", 0, true, false);
                    }
                }
                $this->gui_obj->setCreationMode($creation_mode);
            }
            $this->gui_obj->setAdminMode($this->admin_mode);
            $this->help->setScreenIdComponent(ilObject::_lookupType($this->cur_ref_id, true));
            $this->showTree();
 
            $this->ctrl->setReturn($this, "return");
            $ret = $this->ctrl->forwardCommand($this->gui_obj);
            $html = $this->gui_obj->getHTML();
 
            if ($html != "") {
                $this->tpl->setVariable("OBJECTS", $html);
            }
            $this->tpl->printToStdout();
 
        } else {
            // local command
            $cmd = $this->ctrl->getCmd("forward");
            if (in_array($cmd, self::COMMANDS)) {
                $this->$cmd();
            }
        }
    }

References ilObject\_lookupType(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilUserUtil\getStartingPointAsUrl(), ILIAS\Repository\help(), ilLogLevel\INFO, ILIAS\Repository\lng(), ILIAS\Repository\logger(), ilObject2GUI\REPOSITORY_NODE_ID, showTree(), SYSTEM_FOLDER_ID, SYSTEM_ROLE_ID, and ILIAS\Repository\user().

Here is the call graph for this function:

◆ forward()

ilAdministrationGUI::forward ( )

private

Redirect in special cases.

Administration mode of the repository
Direct jump to user editing

Exceptions

ilCtrlException
ilPermissionException

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

                              : void
    {
        if ($this->admin_mode !== "repository") {       // settings
            if ($this->request->getRefId() == USER_FOLDER_ID) {
                $this->ctrl->setParameter($this, "ref_id", USER_FOLDER_ID);
                $this->ctrl->setParameterByClass("iladministrationgui", "admin_mode", "settings");
                if (ilObject::_lookupType($this->request->getJumpToUserId()) === "usr") {
                    $this->ctrl->setParameterByClass(
                        "ilobjuserfoldergui",
                        "jmpToUser",
                        $this->request->getJumpToUserId()
                    );
                    $this->ctrl->redirectByClass("ilobjuserfoldergui", "jumpToUser");
                } else {
                    $this->ctrl->redirectByClass("ilobjuserfoldergui", "view");
                }
            } else {
                // this code should not be necessary anymore...
                throw new ilPermissionException("Missing AdmiGUI parameter.");
            }
        } else {
            $this->ctrl->setParameter($this, "ref_id", ROOT_FOLDER_ID);
            $this->ctrl->setParameterByClass("iladministrationgui", "admin_mode", "repository");
            $this->ctrl->redirectByClass("ilobjrootfoldergui", "view");
        }
    }

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

Here is the call graph for this function:

◆ jump()

ilAdministrationGUI::jump ( )

private

Jump to the GUI of an administration node This command is used by AdministrationMainBarProvider for the nodes in the admin menu.

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

                           : void
    {
        $ref_id = $this->request->getRefId();
        $obj_id = ilObject::_lookupObjId($ref_id);
        $obj_type = ilObject::_lookupType($obj_id);
        $class_name = $this->obj_definition->getClassName($obj_type);
        $class = strtolower("ilObj" . $class_name . "GUI");
        $this->ctrl->setParameterByClass($class, "ref_id", $ref_id);
        $this->ctrl->redirectByClass($class, "view");
    }

References $ref_id, ilObject\_lookupObjId(), ilObject\_lookupType(), and ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ jumpToPluginSlot()

ilAdministrationGUI::jumpToPluginSlot ( )

private

Special jump to plugin slot after ilCtrl has been reloaded Ths command is used by ilObjComponentSettingsGUI for plugin updates.

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

                                       : void
    {
        $this->ctrl->redirectByClass("ilobjcomponentsettingsgui", "listPlugins");
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ showTree()

ilAdministrationGUI::showTree ( )

private

Show the repository tree in the slate This command is used by ilAdministrationExplorerGUI the for administration mode of the repository.

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

                               : void
    {
        if ($this->admin_mode !== "repository") {
            return;
        }
 
        $this->global_screen->tool()->context()->current()->addAdditionalData(ilAdminGSToolProvider::SHOW_ADMIN_TREE, true);
 
        $exp = new ilAdministrationExplorerGUI(self::class, "showTree");
        $exp->handleCommand();
    }