Slate.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Implementation\Component\MainControls\Slate;

use ILIAS\UI\Component\MainControls\Slate as ISlate;
use ILIAS\UI\Component\Signal;
use ILIAS\UI\Component\ReplaceSignal;
use ILIAS\UI\Component\Symbol\Symbol;
use ILIAS\UI\Implementation\Component\SignalGeneratorInterface;
use ILIAS\UI\Implementation\Component\ComponentHelper;
use ILIAS\UI\Implementation\Component\JavaScriptBindable;
use ILIAS\UI\Implementation\Component\ReplaceSignal as ReplaceSignalImplementation;
use ILIAS\UI\Implementation\Component\Triggerer;
use ILIAS\UI\Implementation\Component\HasHelpTopics;

abstract class Slate implements ISlate\Slate
{
    use ComponentHelper;
    use JavaScriptBindable;
    use Triggerer;
    use HasHelpTopics;

    // allowed ARIA roles
    public const MENU = 'menu';

    protected static array $allowed_aria_roles = array(
        self::MENU
    );

    protected string $name;
    protected Symbol $symbol;
    protected Signal $toggle_signal;
    protected Signal $engage_signal;
    protected ?Signal $replace_signal = null;
    protected bool $engaged = false;
    protected ?string $mainbar_tree_position = null;
    protected ?string $aria_role = null;
    protected SignalGeneratorInterface $signal_generator;

    public function __construct(
        SignalGeneratorInterface $signal_generator,
        string $name,
        Symbol $symbol
    ) {
        $this->signal_generator = $signal_generator;
        $this->name = $name;
        $this->symbol = $symbol;

        $this->initSignals();
    }

    protected function initSignals(): void
    {
        $this->toggle_signal = $this->signal_generator->create();
        $this->engage_signal = $this->signal_generator->create();
        $signal = $this->signal_generator->create(ReplaceSignalImplementation::class);
        $this->replace_signal = $signal;
    }

    public function getName(): string
    {
        return $this->name;
    }

    public function getSymbol(): Symbol
    {
        return $this->symbol;
    }

    public function getToggleSignal(): Signal
    {
        return $this->toggle_signal;
    }

    public function getEngageSignal(): Signal
    {
        return $this->engage_signal;
    }

    public function withEngaged(bool $state): ISlate\Slate
    {
        $clone = clone $this;
        $clone->engaged = $state;
        return $clone;
    }

    public function getEngaged(): bool
    {
        return $this->engaged;
    }

    abstract public function getContents(): array;

    public function getReplaceSignal(): ?Signal
    {
        return $this->replace_signal;
    }

    public function appendOnInView(Signal $signal): ISlate\Slate
    {
        return $this->appendTriggeredSignal($signal, 'in_view');
    }


    abstract public function withMappedSubNodes(callable $f): ISlate\Slate;

    public function withMainBarTreePosition(string $tree_pos): ISlate\Slate
    {
        $clone = clone $this;
        $clone->mainbar_tree_position = $tree_pos;
        return $clone;
    }

    public function getMainBarTreePosition(): ?string
    {
        return $this->mainbar_tree_position;
    }

    public function getMainBarTreeDepth(): int
    {
        $pos = explode(':', $this->mainbar_tree_position);
        return count($pos) - 1;
    }

    public function withAriaRole(string $aria_role): ISlate\Slate
    {
        $this->checkArgIsElement(
            "role",
            $aria_role,
            self::$allowed_aria_roles,
            implode('/', self::$allowed_aria_roles)
        );
        $clone = clone $this;
        $clone->aria_role = $aria_role;
        return $clone;
    }

    public function getAriaRole(): ?string
    {
        return $this->aria_role;
    }
}