ILIAS\Repository\Provider\RepositoryMainBarProvider Class Reference

Repository related main menu items. More...

Inheritance diagram for ILIAS\Repository\Provider\RepositoryMainBarProvider:

Collaboration diagram for ILIAS\Repository\Provider\RepositoryMainBarProvider:

Public Member Functions
	__construct (Container $dic)
	getStaticTopItems ()
	getStaticSubItems ()
	getNoLastVisitedMessage ()
Public Member Functions inherited from ILIAS\GlobalScreen\Scope\MainMenu\Provider\AbstractStaticMainMenuProvider
	__construct (Container $dic)
	getAllIdentifications ()
	provideTypeInformation ()
Public Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	__construct (protected Container $dic)
	getFullyQualifiedClassName ()
	getProviderNameForPresentation ()

Protected Member Functions
	renderLastVisited ()
	renderRepoTree (int $ref_id)
Protected Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	globalScreen ()

Protected Attributes
StandardGUIRequest	$request
Protected Attributes inherited from ILIAS\GlobalScreen\Scope\MainMenu\Provider\AbstractStaticMainMenuProvider
Container	$dic
IdentificationProviderInterface	$if
MainMenuItemFactory	$mainmenu

Private Member Functions
	getHomeItem ()

Detailed Description

Repository related main menu items.

• Repository Home
• Repository Tree
• Last Visited

Note: The Favourites menut item is currently part of the Dashboard PDMainBarProvider and should be moved here, since the Favourites services is implemented as a sub-service of the repository service.

Author

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

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 54 of file RepositoryMainBarProvider.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Repository\Provider\RepositoryMainBarProvider::__construct

(

Container

$dic

)

Definition at line 58 of file RepositoryMainBarProvider.php.

References ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\DI\Container\repository().

    {
        parent::__construct($dic);
        $this->request = $dic->repository()->internal()->gui()->standardRequest();
    }

Here is the call graph for this function:

Member Function Documentation

getHomeItem()

ILIAS\Repository\Provider\RepositoryMainBarProvider::getHomeItem ( )

private

Definition at line 152 of file RepositoryMainBarProvider.php.

References ILIAS\GlobalScreen\Scope\MainMenu\Provider\AbstractStaticMainMenuProvider\$dic, Vendor\Package\$e, $nd, ilObject\_getIcon(), ilObject\_lookupObjId(), if, ilUtil\img(), ILIAS\DI\Container\language(), null, ROOT_FOLDER_ID, ILIAS\GlobalScreen\Scope\Footer\Factory\withAction(), and ILIAS\GlobalScreen\Scope\Footer\Factory\withTitle().

Referenced by ILIAS\Repository\Provider\RepositoryMainBarProvider\getStaticSubItems().

                                  : Link
    {
        $dic = $this->dic;

        $title = static function () use ($dic): string {
            try {
                $nd = $dic['tree']->getNodeData(ROOT_FOLDER_ID);
                $title = ($nd["title"] === "ILIAS" ? $dic->language()->txt("repository") : $nd["title"]);
                $icon = ilUtil::img(ilObject::_getIcon(ilObject::_lookupObjId(1), "tiny"));
            } catch (InvalidArgumentException $e) {
                return "";
            }

            return $title . " - " . $dic->language()->txt("rep_main_page");
        };

        $action = static function (): string {
            try {
                $static_link = (string) (new StandardURIBuilder(ILIAS_HTTP_PATH))->build('', null, ['?target=root_1']);
            } catch (InvalidArgumentException $e) {
                return "";
            }

            return $static_link;
        };

        return $this->mainmenu->link($this->if->identifier('rep_main_page'))
            ->withTitle($title())
            ->withAction($action());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getNoLastVisitedMessage()

ILIAS\Repository\Provider\RepositoryMainBarProvider::getNoLastVisitedMessage

(

)

Definition at line 225 of file RepositoryMainBarProvider.php.

References $DIC, $lng, and $txt.

Referenced by ILIAS\Repository\Provider\RepositoryMainBarProvider\renderLastVisited().

                                             : MessageBox
    {
        global $DIC;

        $lng = $DIC->language();
        $ui = $DIC->ui();
        $lng->loadLanguageModule("rep");
        $txt = $lng->txt("rep_no_last_visited_mess");
        $mbox = $ui->factory()->messageBox()->info($txt);

        return $mbox;
    }

Here is the caller graph for this function:

getStaticSubItems()

ILIAS\Repository\Provider\RepositoryMainBarProvider::getStaticSubItems

(

)

Returns

isItem[] These are Entries which will be available for configuration.

Implements ILIAS\GlobalScreen\Scope\MainMenu\Provider\StaticMainMenuProvider.

Definition at line 69 of file RepositoryMainBarProvider.php.

References ILIAS\GlobalScreen\Scope\MainMenu\Provider\AbstractStaticMainMenuProvider\$dic, Vendor\Package\$f, $ref_id, ILIAS\Repository\Provider\RepositoryMainBarProvider\getHomeItem(), ilUtil\getImagePath(), ILIAS\GlobalScreen\Helper\BasicAccessCheckClosuresSingleton\getInstance(), ILIAS\MainMenu\Provider\StandardTopItemsProvider\getInstance(), ilRepositoryExplorerGUI\getTopNodeForRefId(), if, ilExplorerBaseGUI\init(), ILIAS\Repository\Provider\RepositoryMainBarProvider\renderRepoTree(), ILIAS\UI\Component\Symbol\Icon\Standard\ROOT, ILIAS\DI\Container\settings(), ILIAS\DI\Container\user(), ILIAS\GlobalScreen\Scope\Footer\Factory\withParent(), ILIAS\GlobalScreen\Scope\Footer\Factory\withTitle(), and ILIAS\GlobalScreen\Scope\withVisibilityCallable().

                                       : array
    {
        $dic = $this->dic;
        $f = $this->dic->ui()->factory();

        $top = StandardTopItemsProvider::getInstance()->getRepositoryIdentification();
        $access_helper = BasicAccessCheckClosuresSingleton::getInstance();

        $title = $this->getHomeItem()->getTitle();
        $icon = $this->dic->ui()->factory()->symbol()->icon()->standard(Standard::ROOT, $title);

        // Home
        $entries[] = $this->getHomeItem()
            ->withVisibilityCallable($access_helper->isRepositoryVisible())
            ->withParent($top)
            ->withSymbol($icon)
            ->withPosition(10);

        // Tree-View
        $title = $this->dic->language()->txt("mm_repo_tree_view");

        $icon = $this->dic->ui()->factory()->symbol()->icon()->custom(ilUtil::getImagePath("standard/icon_reptr.svg"), $title);

        \ilRepositoryExplorerGUI::init();
        $ref_id = $this->request->getRefId();
        $top_node = \ilRepositoryExplorerGUI::getTopNodeForRefId($ref_id);
        $asynch = ($top_node === 0);
        $entries[]
            = $this->mainmenu->complex($this->if->identifier('rep_tree_view'))
            ->withVisibilityCallable($access_helper->isRepositoryVisible())
            ->withContentWrapper(function () use ($ref_id): Content {
                return $this->dic->ui()->factory()->legacy()->content($this->renderRepoTree($ref_id));
            })
            ->withSupportsAsynchronousLoading($asynch)
            ->withTitle($title)
            ->withSymbol($icon)
            ->withParent($top)
            ->withPosition(20);

        $icon = $this->dic->ui()->factory()->symbol()->icon()->custom(ilUtil::getImagePath("standard/icon_lstv.svg"), $title);

        $p = $this;
        $entries[] = $this->mainmenu
            ->complex($this->if->identifier('last_visited'))
            ->withTitle($this->dic->language()->txt('last_visited'))
            ->withSupportsAsynchronousLoading(true)
            ->withVisibilityCallable($access_helper->isUserLoggedIn($access_helper->isRepositoryReadable()))
            ->withPosition(30)
            ->withSymbol($icon)
            ->withParent($top)
            ->withContentWrapper(function () use ($p): Content {
                return $this->dic->ui()->factory()->legacy()->content($p->renderLastVisited());
            });

        $title = $this->dic->language()->txt("mm_favorites");
        $icon = $this->dic->ui()->factory()->symbol()->icon()->custom(ilUtil::getImagePath("standard/icon_fav.svg"), $title);

        $entries[] = $this->mainmenu->complex($this->if->identifier('mm_pd_sel_items'))
                                    ->withSupportsAsynchronousLoading(true)
                                    ->withTitle($title)
                                    ->withSymbol($icon)
                                    ->withContentWrapper(
                                        static fn(): Legacy =>
                                            $f->legacy()->content((new ilFavouritesListGUI())->render())
                                    )
                                    ->withParent(StandardTopItemsProvider::getInstance()->getPersonalWorkspaceIdentification())
                                    ->withPosition(10)
                                    ->withAvailableCallable(
                                        static fn(): bool =>
                                            (bool) $dic->settings()->get('rep_favourites', "0")
                                    )
                                    ->withVisibilityCallable(
                                        $access_helper->isUserLoggedIn($access_helper->isRepositoryReadable(
                                            static function () use ($dic): bool {
                                                $pdItemsViewSettings = new ilPDSelectedItemsBlockViewSettings($dic->user());
                                                return $pdItemsViewSettings->allViewsEnabled() || $pdItemsViewSettings->enabledSelectedItems();
                                            }
                                        ))
                                    );
        return $entries;
    }

Here is the call graph for this function:

getStaticTopItems()

ILIAS\Repository\Provider\RepositoryMainBarProvider::getStaticTopItems

(

)

Returns

TopParentItem[] These are Slates which will be available for configuration.

Implements ILIAS\GlobalScreen\Scope\MainMenu\Provider\StaticMainMenuProvider.

Definition at line 64 of file RepositoryMainBarProvider.php.

                                       : array
    {
        return [];
    }

renderLastVisited()

ILIAS\Repository\Provider\RepositoryMainBarProvider::renderLastVisited ( )

protected

Definition at line 183 of file RepositoryMainBarProvider.php.

References Vendor\Package\$f, ilObject\_getIcon(), ilObject\_lookupObjectId(), ILIAS\Repository\Provider\RepositoryMainBarProvider\getNoLastVisitedMessage(), ILIAS\Repository\int(), and ilStr\shortenTextExtended().

                                          : string
    {
        $nav_items = [];
        if (isset($this->dic['ilNavigationHistory'])) {
            $nav_items = $this->dic['ilNavigationHistory']->getItems();
        }
        reset($nav_items);
        $cnt = 0;
        $first = true;
        $item_groups = [];
        $items = [];

        $f = $this->dic->ui()->factory();
        foreach ($nav_items as $k => $nav_item) {
            if ($cnt++ >= 10) {
                break;
            }

            if (!isset($nav_item["ref_id"]) || $this->request->getRefId() === 0
                || ((int) $nav_item["ref_id"] !== $this->request->getRefId() || !$first)
            ) {            // do not list current item
                $ititle = ilStr::shortenTextExtended(strip_tags($nav_item["title"]), 50, true); // #11023
                $obj_id = ilObject::_lookupObjectId((int) $nav_item["ref_id"]);
                $icon = $f->symbol()->icon()->custom(ilObject::_getIcon($obj_id), $ititle);
                $icon->setLabel("");
                $items[] = $f->item()->standard(
                    $f->link()->standard($ititle, $nav_item["link"])
                )->withLeadIcon($icon);
            }
            $first = false;
        }

        if (count($items) > 0) {
            $item_groups[] = $f->item()->group("", $items);
            $panel = $f->panel()->secondary()->listing("", $item_groups);
            return $this->dic->ui()->renderer()->render([$panel]);
        }

        return $this->dic->ui()->renderer()->render($this->getNoLastVisitedMessage());
    }

Here is the call graph for this function:

renderRepoTree()

ILIAS\Repository\Provider\RepositoryMainBarProvider::renderRepoTree ( int  $ref_id )

protected

Definition at line 238 of file RepositoryMainBarProvider.php.

References $DIC.

Referenced by ILIAS\Repository\Provider\RepositoryMainBarProvider\getStaticSubItems().

                                                  : string
    {
        global $DIC;
        $tree = $DIC->repositoryTree();
        if ($ref_id <= 0 || $this->request->getBaseClass() === "ilAdministrationGUI" || !$tree->isInTree($ref_id)) {
            $ref_id = $tree->readRootId();
        }
        $DIC->ctrl()->setParameterByClass("ilrepositorygui", "ref_id", $ref_id);
        $exp = new \ilRepositoryExplorerGUI("ilrepositorygui", "showRepTree");
        $exp->setSkipRootNode(true);
        return $exp->getHTML() . "<script>" . $exp->getOnLoadCode() . "</script>";
    }

Here is the caller graph for this function:

Field Documentation

$request

StandardGUIRequest ILIAS\Repository\Provider\RepositoryMainBarProvider::$request

protected

Definition at line 56 of file RepositoryMainBarProvider.php.

---

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

• components/ILIAS/Repository/GlobalScreen/classes/RepositoryMainBarProvider.php