Slate.php

Go to the documentation of this file.

<?php

/* Copyright (c) 2018 Nils Haagen <nils.haagen@concepts-and-training.de> Extended GPL, see docs/LICENSE */

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;

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

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

    protected $name;

    protected $symbol;

    protected $toggle_signal;

    protected $engage_signal;

    protected $replace_signal;

    protected $engaged = false;

    protected $mainbar_tree_position;

    protected $aria_role;

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

    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()
    {
        $this->toggle_signal = $this->signal_generator->create();
        $this->engage_signal = $this->signal_generator->create();
        $this->replace_signal = $this->signal_generator->create(ReplaceSignalImplementation::class);
    }

    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() : ReplaceSignal
    {
        return $this->replace_signal;
    }

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

    public function appendOnFirstView(Signal $signal) : \ILIAS\UI\Component\MainControls\Slate\Slate
    {
        return $this->appendTriggeredSignal($signal, 'on_first_view');
    }


    abstract public function withMappedSubNodes(callable $f);

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

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

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

    public function withAriaRole(string $aria_role) : 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;
    }
}