Button.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Implementation\Component\Button;

use ILIAS\UI\Component as C;
use ILIAS\UI\Component\Signal;
use ILIAS\UI\Implementation\Component\HasHelpTopics;
use ILIAS\UI\Implementation\Component\ComponentHelper;
use ILIAS\UI\Implementation\Component\JavaScriptBindable;
use ILIAS\UI\Implementation\Component\Triggerer;
use ILIAS\UI\Component\Symbol\Symbol;

abstract class Button implements C\Button\Button
{
    use ComponentHelper;
    use JavaScriptBindable;
    use Triggerer;
    use Engageable;
    use HasHelpTopics;

    protected ?Symbol $symbol = null;
    protected ?string $action;
    protected bool $active = true;
    protected string $aria_label = '';
    protected bool $aria_checked = false;


    public function __construct(
        protected string $label,
        $action
    ) {
        $this->checkStringOrSignalArg("action", $action);
        if (is_string($action)) {
            $this->action = $action;
        } else {
            $this->action = null;
            $this->setTriggeredSignal($action, "click");
        }
    }

    public function getLabel(): string
    {
        return $this->label;
    }

    public function withLabel(string $label): C\Button\Button
    {
        $clone = clone $this;
        $clone->label = $label;
        return $clone;
    }

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

    public function withSymbol(?Symbol $symbol): self
    {
        $clone = clone $this;
        $clone->symbol = $symbol;
        return $clone;
    }

    public function getAction()
    {
        if ($this->action !== null) {
            return $this->action;
        }
        return $this->getTriggeredSignalsFor("click");
    }

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

    public function withUnavailableAction(bool $flag = true): C\Button\Button
    {
        $clone = clone $this;
        $clone->active = !$flag;
        return $clone;
    }

    public function withOnClick(Signal $signal): C\Button\Button
    {
        $this->action = null;
        return $this->withTriggeredSignal($signal, 'click');
    }

    public function appendOnClick(Signal $signal): C\Clickable
    {
        return $this->appendTriggeredSignal($signal, 'click');
    }

    public function withOnHover(Signal $signal): C\Hoverable
    {
        // Note: The event 'hover' maps to 'mouseenter' in javascript. Although 'hover' is available in JQuery,
        // it encodes the 'mouseenter' and 'mouseleave' events and thus expects two event handlers.
        // In the context of this framework, the signal MUST only be triggered on the 'mouseenter' event.
        // See also: https://api.jquery.com/hover/
        return $this->withTriggeredSignal($signal, 'mouseenter');
    }

    public function appendOnHover(Signal $signal): C\Hoverable
    {
        return $this->appendTriggeredSignal($signal, 'mouseenter');
    }

    public function withAriaLabel(string $aria_label): C\Button\Button
    {
        $clone = clone $this;
        $clone->aria_label = $aria_label;
        return $clone;
    }

    public function getAriaLabel(): string
    {
        return $this->aria_label;
    }
}