class.ilMMCustomItemFacade.php

Go to the documentation of this file.

<?php
declare(strict_types=1);

use ILIAS\GlobalScreen\Scope\MainMenu\Factory\isItem;
use ILIAS\GlobalScreen\Identification\IdentificationInterface;
use ILIAS\GlobalScreen\Scope\MainMenu\Collector\MainMenuMainCollector as Main;

class ilMMCustomItemFacade extends ilMMAbstractItemFacade
{
    protected ?ilMMCustomItemStorage $custom_item_storage;

    protected string $action = '';

    protected string $type = '';

    protected bool $top_item = false;

    public function __construct(IdentificationInterface $identification, Main $collector)
    {
        parent::__construct($identification, $collector);
        $this->custom_item_storage = $this->getCustomStorage();
        if ($this->custom_item_storage instanceof ilMMCustomItemStorage) {
            if ($this->custom_item_storage->getType() !== '' && $this->custom_item_storage->getType() !== '0') {
                $this->type = $this->custom_item_storage->getType();
            }
            $this->role_based_visibility = $this->custom_item_storage->hasRoleBasedVisibility();
            if ($this->custom_item_storage->hasRoleBasedVisibility()) {
                $this->global_role_ids = $this->custom_item_storage->getGlobalRoleIDs();
            }
        }
    }

    #[\Override]
    public function update(): void
    {
        if ($this->isCustom()) {
            $mm = $this->getCustomStorage();
            if ($mm instanceof ilMMCustomItemStorage) {
                if ($this->default_title === '-') {
                    $this->default_title = ilMMItemTranslationStorage::getDefaultTranslation($this->identification());
                }
                $mm->setDefaultTitle($this->default_title);
                $mm->setType($this->getType());
                $mm->setRoleBasedVisibility($this->role_based_visibility);
                if ($this->role_based_visibility) {
                    $mm->setGlobalRoleIDs($this->global_role_ids);
                }
                $mm->update();
            }
        }
        parent::update();
    }

    #[\Override]
    public function delete(): void
    {
        if (!$this->isDeletable()) {
            throw new LogicException("Non Custom items can't be deleted");
        }

        $cm = $this->getCustomStorage();
        if ($cm instanceof ilMMCustomItemStorage) {
            $cm->delete();
        }
        parent::delete();
    }

    private function getCustomStorage(): ?ilMMCustomItemStorage
    {
        $id = $this->raw_item->getProviderIdentification()->getInternalIdentifier();
        $mm = ilMMCustomItemStorage::find($id);

        return $mm;
    }

    #[\Override]
    public function supportsRoleBasedVisibility(): bool
    {
        return true;
    }

    public function isCustom(): bool
    {
        return true;
    }

    public function isEditable(): bool
    {
        return true;
    }

    public function isDeletable(): bool
    {
        return true;
    }

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

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

    public function setAction(string $action): void
    {
        $this->action = $action;
    }

    #[\Override]
    public function getType(): string
    {
        return $this->type;
    }

    public function setType(string $type): void
    {
        $this->type = $type;
    }

    #[\Override]
    public function isTopItem(): bool
    {
        if ($this->raw_item instanceof isItem) {
            return parent::isTopItem();
        }

        return $this->top_item;
    }

    #[\Override]
    public function setIsTopItm(bool $top_item): void
    {
        $this->top_item = $top_item;
    }
}