StandardTopItemsProvider.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\MainMenu\Provider;

use ILIAS\DI\Container;
use ILIAS\GlobalScreen\Helper\BasicAccessCheckClosuresSingleton;
use ILIAS\GlobalScreen\Identification\IdentificationInterface;
use ILIAS\GlobalScreen\Scope\MainMenu\Provider\AbstractStaticMainMenuProvider;
use ILIAS\UI\Component\Symbol\Icon\Standard;
use ILIAS\GlobalScreen\Scope\MainMenu\Collector\Renderer\TopParentItemDrilldownRenderer;
use ILIAS\GlobalScreen\Scope\MainMenu\Collector\Information\TypeInformation;
use ILIAS\GlobalScreen\Helper\BasicAccessCheckClosures;

class StandardTopItemsProvider extends AbstractStaticMainMenuProvider
{
    private static StandardTopItemsProvider $instance;

    private BasicAccessCheckClosures $basic_access_helper;

    private IdentificationInterface $administration_identification;

    private IdentificationInterface $organisation_identification;

    private IdentificationInterface $communication_identification;

    private IdentificationInterface $achievements_identification;

    private IdentificationInterface $personal_workspace_identification;

    private IdentificationInterface $repository_identification;


    public static function getInstance(): StandardTopItemsProvider
    {
        global $DIC;
        if (!isset(self::$instance)) {
            self::$instance = new self($DIC);
        }

        return self::$instance;
    }


    public function __construct(Container $dic)
    {
        parent::__construct($dic);
        $this->basic_access_helper = BasicAccessCheckClosuresSingleton::getInstance();
        $this->repository_identification = $this->if->identifier('repository');
        $this->personal_workspace_identification = $this->if->identifier('personal_workspace');
        $this->achievements_identification = $this->if->identifier('achievements');
        $this->communication_identification = $this->if->identifier('communication');
        $this->organisation_identification = $this->if->identifier('organisation');
        $this->administration_identification = $this->if->identifier('administration');
    }


    public function getStaticTopItems(): array
    {
        $f = (fn($id): string => $this->dic->language()->txt($id));

        // Dashboard
        $title = $this->dic->language()->txt("mm_dashboard");
        $icon = $this->dic->ui()->factory()->symbol()->icon()->standard(Standard::DSHS, $title);
        $dashboard = $this->mainmenu->topLinkItem($this->if->identifier('mm_pd_crs_grp'))
            ->withSymbol($icon)
            ->withTitle($title)
            ->withAction("ilias.php?baseClass=ilDashboardGUI&cmd=jumpToMemberships")
            ->withPosition(10)
            ->withNonAvailableReason($this->dic->ui()->factory()->legacy()->content("{$this->dic->language()->txt('component_not_active')}"))
            ->withAvailableCallable(
                fn(): true => true
            )
            ->withVisibilityCallable(
                $this->basic_access_helper->isUserLoggedIn()
            );

        $title = $f("mm_repository");
        $icon = $this->dic->ui()->factory()->symbol()->icon()->standard(Standard::REP, $title);

        $repository = $this->mainmenu->topParentItem($this->getRepositoryIdentification())
            ->withVisibilityCallable($this->basic_access_helper->isRepositoryReadable())
            ->withSymbol($icon)
            ->withTitle($title)
            ->withPosition(20);

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

        $personal_workspace = $this->mainmenu->topParentItem($this->getPersonalWorkspaceIdentification())
            ->withVisibilityCallable($this->basic_access_helper->isUserLoggedIn())
            ->withSymbol($icon)
            ->withTitle($title)
            ->withPosition(30);

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

        $achievements = $this->mainmenu->topParentItem($this->getAchievementsIdentification())
            ->withVisibilityCallable($this->basic_access_helper->isUserLoggedIn())
            ->withSymbol($icon)
            ->withTitle($title)
            ->withPosition(40);

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

        $communication = $this->mainmenu->topParentItem($this->getCommunicationIdentification())
            ->withVisibilityCallable($this->basic_access_helper->isUserLoggedIn())
            ->withSymbol($icon)
            ->withTitle($title)
            ->withPosition(50);

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

        $organisation = $this->mainmenu->topParentItem($this->getOrganisationIdentification())
            ->withVisibilityCallable($this->basic_access_helper->isUserLoggedIn())
            ->withSymbol($icon)
            ->withTitle($title)
            ->withPosition(60);

        $title = $f("mm_administration");
        $icon = $this->dic->ui()->factory()->symbol()->icon()->standard("adm", $title);

        $administration = $this->mainmenu->topParentItem($this->getAdministrationIdentification())
            ->withSupportsAsynchronousLoading(false)
            ->withAvailableCallable($this->basic_access_helper->isUserLoggedIn())
            ->withSymbol($icon)
            ->withTitle($title)
            ->withPosition(70)
            ->withVisibilityCallable($this->basic_access_helper->hasAdministrationAccess());

        $dd_renderer = new TopParentItemDrilldownRenderer();
        $ti = new TypeInformation($administration::class, $administration::class);
        $ti->setRenderer($dd_renderer);
        $administration = $administration->setTypeInformation($ti);


        return [
            $dashboard,
            $repository,
            $personal_workspace,
            $achievements,
            $communication,
            $organisation,
            $administration
        ];
    }


    #[\Override]
    public function getProviderNameForPresentation(): string
    {
        return "Default";
    }


    public function getStaticSubItems(): array
    {
        return [];
    }


    public function getAdministrationIdentification(): IdentificationInterface
    {
        return $this->administration_identification;
    }


    public function getOrganisationIdentification(): IdentificationInterface
    {
        return $this->organisation_identification;
    }


    public function getCommunicationIdentification(): IdentificationInterface
    {
        return $this->communication_identification;
    }


    public function getAchievementsIdentification(): IdentificationInterface
    {
        return $this->achievements_identification;
    }


    public function getPersonalWorkspaceIdentification(): IdentificationInterface
    {
        return $this->personal_workspace_identification;
    }


    public function getRepositoryIdentification(): IdentificationInterface
    {
        return $this->repository_identification;
    }
}