Modal.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Implementation\Component\Modal;

use ILIAS\UI\Component\Modal as M;
use ILIAS\UI\Component\Signal;
use ILIAS\UI\Component\Onloadable;
use ILIAS\UI\Implementation\Component\ComponentHelper;
use ILIAS\UI\Implementation\Component\JavaScriptBindable;
use ILIAS\UI\Implementation\Component\SignalGeneratorInterface;
use ILIAS\UI\Implementation\Component\Triggerer;

abstract class Modal implements M\Modal
{
    use ComponentHelper;
    use JavaScriptBindable;
    use Triggerer;

    protected SignalGeneratorInterface $signal_generator;
    protected Signal $show_signal;
    protected Signal $close_signal;
    protected string $async_render_url = '';
    protected bool $close_with_keyboard = true;

    public function __construct(SignalGeneratorInterface $signal_generator)
    {
        $this->signal_generator = $signal_generator;
        $this->initSignals();
    }

    public function getAsyncRenderUrl(): string
    {
        return $this->async_render_url;
    }

    public function withAsyncRenderUrl(string $url): M\Modal
    {
        $clone = clone $this;
        $clone->async_render_url = $url;
        return $clone;
    }

    public function withCloseWithKeyboard(bool $state): M\Modal
    {
        $clone = clone $this;
        $clone->close_with_keyboard = $state;
        return $clone;
    }

    public function getCloseWithKeyboard(): bool
    {
        return $this->close_with_keyboard;
    }

    public function getShowSignal(): Signal
    {
        return $this->show_signal;
    }

    public function getCloseSignal(): Signal
    {
        return $this->close_signal;
    }

    public function withResetSignals(): Modal
    {
        $clone = clone $this;
        $clone->initSignals();
        return $clone;
    }

    public function withOnLoad(Signal $signal): Onloadable
    {
        return $this->withTriggeredSignal($signal, 'ready');
    }

    public function appendOnLoad(Signal $signal): Onloadable
    {
        return $this->appendTriggeredSignal($signal, 'ready');
    }

    public function withOnClose(Signal $signal): self
    {
        return $this->withTriggeredSignal($signal, 'hidden.bs.modal');
    }

    public function appendOnClose(Signal $signal): self
    {
        return $this->withTriggeredSignal($signal, 'hidden.bs.modal');
    }

    public function initSignals(): void
    {
        $this->show_signal = $this->signal_generator->create();
        $this->close_signal = $this->signal_generator->create();
    }
}