Class AdministrationMainBarProvider. More...

Inheritance diagram for ILIAS\Administration\AdministrationMainBarProvider:

Collaboration diagram for ILIAS\Administration\AdministrationMainBarProvider:

Public Member Functions
	getStaticTopItems ()

	getStaticSubItems ()

Protected Member Functions
	getIconForGroup (string $group, string $title)

Private Member Functions
	getGroups ()

Detailed Description

Class AdministrationMainBarProvider.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 33 of file AdministrationMainBarProvider.php.

Member Function Documentation

◆ getGroups()

ILIAS\Administration\AdministrationMainBarProvider::getGroups ( )

private

Definition at line 135 of file AdministrationMainBarProvider.php.

References $c, Vendor\Package\$e, $lng, ROOT_FOLDER_ID, and SYSTEM_FOLDER_ID.

Referenced by ILIAS\Administration\AdministrationMainBarProvider\getStaticSubItems().

                                 : array
     {
         if (!$this->dic->offsetExists('tree')) { // isDependencyAvailable does not work, Fatal error: Uncaught Error: Call to undefined method ILIAS\DI\Container::tree() in /var/www/html/components/ILIAS/DI/src/Container.php on line 294
             return [[], []];
         }
         $tree = $this->dic->repositoryTree();
         $lng = $this->dic->language();
 
         $admin_request = new AdminGUIRequest(
             $this->dic->http(),
             $this->dic->refinery()
         );
 
 
         $objects = $tree->getChilds(SYSTEM_FOLDER_ID);
 
         foreach ($objects as $object) {
             $new_objects[$object["title"] . ":" . $object["child"]]
                 = $object;
             // have to set it manually as translation type of main node cannot be "sys" as this type is a orgu itself.
             if ($object["type"] === "orgu") {
                 $new_objects[$object["title"] . ":" . $object["child"]]["title"] = $lng->txt("objs_orgu");
             }
         }
 
         // add entry for switching to repository admin
         // note: please see showChilds methods which prevents infinite look
         $new_objects[$lng->txt("repository_admin") . ":" . ROOT_FOLDER_ID]
             = array(
             "tree" => 1,
             "child" => ROOT_FOLDER_ID,
             "ref_id" => ROOT_FOLDER_ID,
             "depth" => 3,
             "type" => "root",
             "title" => $lng->txt("repository_admin"),
             "description" => $lng->txt("repository_admin_desc"),
             "desc" => $lng->txt("repository_admin_desc"),
         );
 
         $new_objects[$lng->txt("general_settings") . ":" . SYSTEM_FOLDER_ID]
             = array(
             "tree" => 1,
             "child" => SYSTEM_FOLDER_ID,
             "ref_id" => SYSTEM_FOLDER_ID,
             "depth" => 2,
             "type" => "adm",
             "title" => $lng->txt("general_settings"),
         );
         ksort($new_objects);
 
         // determine items to show
         $items = array();
         foreach ($new_objects as $c) {
             // check visibility
             if ($c["type"] !== "adm" && $tree->getParentId((int) $c["ref_id"]) === ROOT_FOLDER_ID
                 && $admin_request->getAdminMode() !== "repository"
             ) {
                 continue;
             }
             // these objects may exist due to test cases that didnt clear
             // data properly
             if ($c["type"] == "" || $c["type"] === "objf"
                 || $c["type"] === "xxx"
             ) {
                 continue;
             }
             $items[] = $c;
         }
 
         $titems = array();
         foreach ($items as $i) {
             $titems[$i["type"]] = $i;
         }
 
         // admin menu layout
         $layout = array(
             "maintenance" =>
                 array("adm", "lngf", "hlps", "wfe", 'fils', 'logs', 'sysc', "recf", "root"),
             "layout_and_navigation" =>
                 array("mme", "gsfo", "dshs", "stys", "adve"),
             "legal_regulations" =>
                 array("impr" ,"tos", "accs", 'dpro'),
             "user_administration" =>
                 array("usrf", "rolf", "otpl", "auth", "ps"),
             "personal_workspace" =>
                 array("tags", "cals", "prfa", "prss", "nots"),
             "achievements" =>
                 array("lhts", "skmg", "trac", "bdga", "cert"),
             "communication" =>
                 array("mail", "cadm", "nwss", "coms", "adn", "awra", "nota"),
             "search_and_find" =>
                 array("seas", "mds", "taxs"),
             "extending_ilias" =>
                 array('ecss', "ltis", "wbdv", "cmis", "cmps", "extt"),
             "repository_and_objects" =>
                 array("reps", "crss", "grps", "prgs", "bibs", "blga", "cpad", "chta", "facs", "frma", "lrss", 'lsos',
                       "mcts", "mobs", "svyf", "assf", "wbrs"),
         );
         $groups = [];
         // now get all items and groups that are accessible
         foreach ($layout as $group => $entries) {
             $groups[$group] = array();
             $entries_since_last_sep = false;
             foreach ($entries as $e) {
                 if ($e === "---" || (isset($titems[$e]["type"]) && $titems[$e]["type"] != "")) {
                     if ($e === "---" && $entries_since_last_sep) {
                         $groups[$group][] = $e;
                         $entries_since_last_sep = false;
                     } else {
                         if ($e !== "---") {
                             $groups[$group][] = $e;
                             $entries_since_last_sep = true;
                         }
                     }
                 }
             }
         }
 
         return [$groups, $titems];
     }

Here is the caller graph for this function:

◆ getIconForGroup()

ILIAS\Administration\AdministrationMainBarProvider::getIconForGroup	(	string	$group,
		string	$title
	)

protected

Definition at line 117 of file AdministrationMainBarProvider.php.

References ilUtil\getImagePath().

Referenced by ILIAS\Administration\AdministrationMainBarProvider\getStaticSubItems().

                                                                     : Icon
     {
         $icon_map = array(
             "maintenance" => "icon_sysa",
             "layout_and_navigation" => "icon_laya",
             "repository_and_objects" => "icon_repa",
             "personal_workspace" => "icon_pwsa",
             "achievements" => "icon_achva",
             "communication" => "icon_coma",
             "user_administration" => "icon_usra",
             "search_and_find" => "icon_safa",
             "extending_ilias" => "icon_exta",
             'legal_regulations' => 'icon_lega',
         );
         $icon_path = \ilUtil::getImagePath("standard/" . $icon_map[$group] . ".svg");
         return $this->dic->ui()->factory()->symbol()->icon()->custom($icon_path, $title);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStaticSubItems()

ILIAS\Administration\AdministrationMainBarProvider::getStaticSubItems ( )

Definition at line 41 of file AdministrationMainBarProvider.php.

References $ref_id, ILIAS\Administration\AdministrationMainBarProvider\getGroups(), ILIAS\Administration\AdministrationMainBarProvider\getIconForGroup(), ILIAS\Repository\globalScreen(), if, ROOT_FOLDER_ID, ILIAS\GlobalScreen\Scope\withAvailableCallable(), and ILIAS\GlobalScreen\Scope\withVisibilityCallable().

                                        : array
     {
         $access_helper = BasicAccessCheckClosuresSingleton::getInstance();
         $top = StandardTopItemsProvider::getInstance()->getAdministrationIdentification();
 
         if (!$access_helper->isUserLoggedIn()() || !$access_helper->hasAdministrationAccess()()) {
             return [];
         }
 
         $entries = [];
         $this->dic->language()->loadLanguageModule('administration');
 
         $admin_request = new AdminGUIRequest(
             $this->dic->http(),
             $this->dic->refinery()
         );
 
         [$groups, $titems] = $this->getGroups();
         $position = 1;
         foreach ($groups as $group => $group_items) {
             // Is Group
             if (is_array($group_items) && count($group_items) > 0) {
                 // Entries
                 $links = [];
                 foreach ($group_items as $group_item) {
                     if ($group_item === "---") {
                         continue;
                     }
 
                     $icon = $this->dic->ui()->factory()->symbol()->icon()->standard($titems[$group_item]["type"], $titems[$group_item]["title"]);
 
                     $ref_id = $titems[$group_item]["ref_id"];
                     if ($admin_request->getAdminMode() !== 'repository' && $ref_id == ROOT_FOLDER_ID) {
                         $identification = $this->if->identifier('mm_adm_rep');
                         $action = "ilias.php?baseClass=ilAdministrationGUI&ref_id=" . $ref_id . "&admin_mode=repository";
                     } else {
                         $identification = $this->if->identifier("mm_adm_" . $titems[$group_item]["type"]);
                         $action = "ilias.php?baseClass=ilAdministrationGUI&ref_id=" . $ref_id . "&cmd=jump";
                     }
 
                     $links[] = $this->globalScreen()
                         ->mainBar()
                         ->link($identification)
                         ->withTitle($titems[$group_item]["title"])
                         ->withAction($action)
                         ->withSymbol($icon)
                         ->withVisibilityCallable(function () use ($ref_id) {
                             return $this->dic->rbac()->system()->checkAccess('visible,read', (int) $ref_id);
                         });
                 }
 
                 // Main entry
                 $title = $this->dic->language()->txt("adm_" . $group);
                 $entries[] = $this->globalScreen()
                     ->mainBar()
                     ->linkList($this->if->identifier('adm_content_' . $group))
                     ->withSupportsAsynchronousLoading(true)
                     ->withLinks($links)
                     ->withTitle($title)
                     ->withSymbol($this->getIconForGroup($group, $title))
                     ->withParent($top)
                     ->withPosition($position * 10)
                     ->withAlwaysAvailable(true)
                     ->withNonAvailableReason($this->dic->ui()->factory()->legacy("{$this->dic->language()->txt('item_must_be_always_active')}"))
                     ->withVisibilityCallable(
                         $access_helper->hasAdministrationAccess()
                     )->withAvailableCallable(
                         $access_helper->isUserLoggedIn()
                     );
                 $position++;
             }
         }
 
         return $entries;
     }

Here is the call graph for this function:

◆ getStaticTopItems()

ILIAS\Administration\AdministrationMainBarProvider::getStaticTopItems ( )

Definition at line 35 of file AdministrationMainBarProvider.php.

                                        : array
     {
         return [];
     }

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

components/ILIAS/Administration/GlobalScreen/classes/AdministrationMainBarProvider.php

Public Member Functions