class.ilMMItemStorage.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\GlobalScreen\Scope\MainMenu\Factory\isItem;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\Item\Lost;
use ILIAS\GlobalScreen\Scope\MainMenu\Factory\isChild;

/******************************************************************************
 *
 * This file is part of ILIAS, a powerful learning management system.
 *
 * ILIAS is licensed with the GPL-3.0, you should have received a copy
 * of said license along with the source code.
 *
 * If this is not the case or you just want to try ILIAS, you'll find
 * us at:
 *      https://www.ilias.de
 *      https://github.com/ILIAS-eLearning
 *
 *****************************************************************************/
class ilMMItemStorage extends CachedActiveRecord
{
    public static function register(isItem $item): ilMMItemStorage
    {
        if ($item instanceof Lost) {
            return new self();
        }

        $mm_item = ilMMItemStorage::find($item->getProviderIdentification()->serialize());
        if ($mm_item === null) {
            $mm_item = new ilMMItemStorage();
            $mm_item->setPosition($item->getPosition());
            $mm_item->setIdentification($item->getProviderIdentification()->serialize());
            $mm_item->setActive(true);
            if ($item instanceof isChild) {
                $mm_item->setParentIdentification($item->getParent()->serialize());
            }
            $mm_item->create();
        }

        return $mm_item;
    }




    public function create(): void
    {
        if (self::find($this->getIdentification())) {
            $this->update();
        } else {
            parent::create();
        }
    }


    public function getCache(): ilGlobalCache
    {
        return ilGlobalCache::getInstance(ilGlobalCache::COMP_GLOBAL_SCREEN);
    }


    protected ?string $identification;
    protected bool $active = true;
    protected int $position = 0;
    protected ?string $parent_identification = '';
    protected ?string $icon_id = '';
    protected string $connector_container_name = "il_mm_items";


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


    public function setIdentification(string $identification)
    {
        $this->identification = $identification;
    }


    public function isActive(): bool
    {
        return $this->active;
    }


    public function setActive(bool $active)
    {
        $this->active = $active;
    }


    public function getPosition(): int
    {
        return $this->position;
    }


    public function setPosition(int $position)
    {
        $this->position = $position;
    }


    public function getParentIdentification(): string
    {
        return $this->parent_identification;
    }


    public function setParentIdentification(string $parent_identification)
    {
        $this->parent_identification = $parent_identification;
    }


    public function getIconId(): ?string
    {
        return $this->icon_id === '' ? null : $this->icon_id;
    }


    public function setIconId(string $icon_id): ilMMItemStorage
    {
        $this->icon_id = $icon_id;

        return $this;
    }
}