AbstractBaseItem.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\GlobalScreen\Scope\MainMenu\Factory;

use ILIAS\GlobalScreen\Identification\IdentificationInterface;
use ILIAS\GlobalScreen\Identification\NullIdentification;
use ILIAS\GlobalScreen\Scope\ComponentDecoratorTrait;
use ILIAS\GlobalScreen\Scope\MainMenu\Collector\Information\TypeInformation;
use ILIAS\UI\Component\Legacy\Legacy;
use Closure;

abstract class AbstractBaseItem implements isItem
{
    use ComponentDecoratorTrait;

    protected int $position = 0;

    private ?bool $is_visible_static = null;

    protected IdentificationInterface $provider_identification;
    protected ?Closure $available_callable = null;
    protected ?Closure $active_callable = null;
    protected ?Closure $visiblility_callable = null;
    protected bool $is_always_available = false;
    protected ?TypeInformation $type_information = null;
    protected ?Legacy $non_available_reason = null;

    public function __construct(IdentificationInterface $provider_identification)
    {
        $this->provider_identification = $provider_identification;
    }

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

    public function withVisibilityCallable(callable $is_visible): isItem
    {
        $clone = clone($this);
        $clone->visiblility_callable = $is_visible;
        $clone->is_visible_static = null;

        return $clone;
    }

    public function isVisible(): bool
    {
        if (isset($this->is_visible_static)) {
            return $this->is_visible_static;
        }
        if (!$this->isAvailable()) {
            return $this->is_visible_static = false;
        }
        if (is_callable($this->visiblility_callable)) {
            $callable = $this->visiblility_callable;

            $value = (bool) $callable();

            return $this->is_visible_static = $value;
        }

        return $this->is_visible_static = true;
    }

    public function withAvailableCallable(callable $is_available): isItem
    {
        $clone = clone($this);
        $clone->available_callable = $is_available;

        return $clone;
    }

    public function isAvailable(): bool
    {
        if ($this->isAlwaysAvailable() === true) {
            return true;
        }
        if (is_callable($this->available_callable)) {
            $callable = $this->available_callable;

            return (bool) $callable();
        }

        return true;
    }

    public function withNonAvailableReason(Legacy $element): isItem
    {
        $clone = clone $this;
        $clone->non_available_reason = $element;

        return $clone;
    }

    public function getNonAvailableReason(): Legacy
    {
        global $DIC;

        return $this->non_available_reason instanceof Legacy ? $this->non_available_reason : $DIC->ui()->factory()->legacy("");
    }

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

    public function withAlwaysAvailable(bool $always_active): isItem
    {
        $clone = clone($this);
        $clone->is_always_available = $always_active;

        return $clone;
    }

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

    public function withPosition(int $position): isItem
    {
        $clone = clone($this);
        $clone->position = $position;

        return $clone;
    }

    public function setTypeInformation(TypeInformation $information): isItem
    {
        $this->type_information = $information;

        return $this;
    }

    public function getTypeInformation(): ?TypeInformation
    {
        return $this->type_information;
    }

    public function isTop(): bool
    {
        if ($this instanceof isInterchangeableItem) {
            $changed = $this->hasChanged();
            if ($this instanceof isChild) {
                return $changed;
            } elseif ($this instanceof isTopItem) {
                return !$changed;
            }
        }

        return $this instanceof isTopItem;
    }
}