class.ilMMAbstractItemFacade.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\GlobalScreen\Identification\IdentificationInterface;
use ILIAS\GlobalScreen\Identification\NullIdentification;
use ILIAS\GlobalScreen\Scope\MainMenu\Collector\Information\TypeInformation;
use ILIAS\GlobalScreen\Scope\MainMenu\Collector\MainMenuMainCollector as Main;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\hasSymbol;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\isChild;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\isInterchangeableItem;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\isItem;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\isTopItem;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\Item\Complex;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\Item\LinkList;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\Item\Lost;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\Item\RepositoryLink;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\Item\Separator;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\TopItem\TopLinkItem;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\TopItem\TopParentItem;
use ILIAS\UI\Component\Link\Link;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\isParent;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\hasTitle;

abstract class ilMMAbstractItemFacade implements ilMMItemFacadeInterface
{
    protected bool $role_based_visibility = false;

    protected array $global_role_ids = [];

    protected TypeInformation $type_information;

    protected ilMMItemStorage $mm_item;
    protected isItem $filtered_item;
    protected isItem $raw_item;
    protected string $default_title = "-";

    public function __construct(
        protected IdentificationInterface $identification,
        Main $collector
    ) {
        $this->raw_item = $collector->getSingleItemFromRaw($this->identification);
        $this->filtered_item = $collector->getSingleItemFromFilter($this->identification);
        $this->type_information = $collector->getTypeInformationCollection()->get($this->raw_item::class);
        $this->mm_item = ilMMItemStorage::register($this->raw_item);
    }

    public function getId(): string
    {
        return $this->identification->serialize();
    }

    public function hasStorage(): bool
    {
        return ilMMItemStorage::find($this->getId()) !== null;
    }

    public function supportsRoleBasedVisibility(): bool
    {
        return false;
    }

    public function hasRoleBasedVisibility(): bool
    {
        return $this->role_based_visibility;
    }

    public function setRoleBasedVisibility(bool $role_based_visibility): void
    {
        $this->role_based_visibility = $role_based_visibility;
    }

    public function getGlobalRoleIDs(): array
    {
        return $this->global_role_ids;
    }

    public function setGlobalRoleIDs(array $global_role_ids): void
    {
        $this->global_role_ids = $global_role_ids;
    }

    public function isEmpty(): bool
    {
        return $this->mm_item->getIdentification() === '';
    }

    public function itemStorage(): ilMMItemStorage
    {
        return $this->mm_item;
    }

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

    public function getRawItem(): isItem
    {
        return $this->raw_item;
    }
    public function getFilteredItem(): isItem
    {
        return $this->filtered_item;
    }

    public function getAmountOfChildren(): int
    {
        if ($this->filtered_item instanceof isParent) {
            return count($this->filtered_item->getChildren());
        }

        return 0;
    }

    public function isAvailable(): bool
    {
        if ($this->filtered_item->isAvailable()) {
            return true;
        }
        return $this->filtered_item->isAlwaysAvailable();
    }

    public function isActivated(): bool
    {
        if ($this->mm_item->isActive() && $this->getRawItem()->isAvailable()) {
            return true;
        }
        return $this->getRawItem()->isAlwaysAvailable();
    }

    public function isAlwaysAvailable(): bool
    {
        return $this->getRawItem()->isAlwaysAvailable();
    }

    public function getProviderNameForPresentation(): string
    {
        return $this->identification->getProviderNameForPresentation();
    }

    public function getDefaultTitle(): string
    {
        $default_translation = ilMMItemTranslationStorage::getDefaultTranslation($this->identification);
        if ($default_translation !== "") {
            return $default_translation;
        }
        if ($this->default_title === "-" && $this->raw_item instanceof hasTitle) {
            $this->default_title = $this->raw_item->getTitle();
        }

        return $this->default_title;
    }

    public function setDefaultTitle(string $default_title): void
    {
        $this->default_title = $default_title;
    }

    public function getStatus(): string
    {
        global $DIC;
        if (!$this->raw_item->isAvailable() || $this->raw_item->isAlwaysAvailable()) {
            return $DIC->ui()->renderer()->render($this->raw_item->getNonAvailableReason());
        }

        return "";
    }

    public function getTypeForPresentation(): string
    {
        return $this->type_information->getTypeNameForPresentation();
    }

    public function getParentIdentificationString(): string
    {
        if ($this->getFilteredItem() instanceof isChild || $this->getFilteredItem() instanceof isInterchangeableItem) {
            $provider_name_for_presentation = $this->raw_item->getParent()->serialize();

            $storage_parent = $this->mm_item->getParentIdentification();
            if ($storage_parent !== $provider_name_for_presentation) {
                return $storage_parent;
            }

            return $provider_name_for_presentation;
        }

        return "";
    }

    public function isCustomType(): bool
    {
        $known_core_types = [
            Complex::class,
            Link::class,
            LinkList::class,
            Lost::class,
            RepositoryLink::class,
            Separator::class,
            TopLinkItem::class,
            TopParentItem::class,
        ];
        return !in_array($this->raw_item::class, $known_core_types, true);
    }

    public function isTopItem(): bool
    {
        return $this->raw_item instanceof isTopItem;
    }

    public function isChild(): bool
    {
        $item = $this->getFilteredItem();
        return $item instanceof isChild
            || ($item instanceof isInterchangeableItem && $item->hasChanged());
    }

    public function isInLostItem(): bool
    {
        if ($this->raw_item instanceof isChild) {
            return $this->raw_item->getParent() instanceof NullIdentification;
        }

        return false;
    }

    public function setIsTopItm(bool $top_item): void
    {
        // TODO: Implement setIsTopItm() method.
    }

    public function isInterchangeable(): bool
    {
        return $this->raw_item instanceof isInterchangeableItem;
    }

    public function getType(): string
    {
        return $this->type_information->getType();
    }

    public function setParent(string $parent): void
    {
        $this->mm_item->setParentIdentification($parent);
    }

    public function setPosition(int $position): void
    {
        $this->mm_item->setPosition($position);
    }

    public function setActiveStatus(bool $status): void
    {
        $this->mm_item->setActive($status);
    }

    public function supportsCustomIcon(): bool
    {
        return $this->raw_item instanceof hasSymbol;
    }

    public function getIconID(): ?string
    {
        return $this->mm_item->getIconId();
    }

    public function setIconID(string $icon_id): void
    {
        $this->mm_item->setIconId($icon_id);
    }

    // CRUD

    public function update(): void
    {
        ilMMItemTranslationStorage::storeDefaultTranslation($this->identification, $this->default_title);
        $this->mm_item->update();
    }

    public function create(): void
    {
        ilMMItemTranslationStorage::storeDefaultTranslation($this->identification, $this->default_title);
        $this->mm_item->create();
        ilMMItemStorage::register($this->raw_item);
    }

    protected function deleteAssociatedTranslations(): void
    {
        $ts = ilMMItemTranslationStorage::where([
            'identification' => $this->identification->serialize(),
        ], '=')->get();

        if (!empty($ts)) {
            foreach ($ts as $translation) {
                if ($translation instanceof ilMMItemTranslationStorage) {
                    $translation->delete();
                }
            }
        }
    }

    public function delete(): void
    {
        if ($this->isDeletable()) {
            $this->deleteAssociatedTranslations();
            $serialize = $this->identification->serialize();
            $mm = ilMMItemStorage::find($serialize);
            if ($mm instanceof ilMMItemStorage) {
                $mm->delete();
            }
        }
    }
}