Modal.php

Go to the documentation of this file.

<?php
namespace ILIAS\UI\Implementation\Component\Modal;

use ILIAS\UI\Component as Component;
use ILIAS\UI\Component\Signal;
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 Component\Modal\Modal
{
    use ComponentHelper;
    use JavaScriptBindable;
    use Triggerer;

    protected $signal_generator;

    protected $show_signal;

    protected $close_signal;
    protected $async_render_url = '';

    protected $close_with_keyboard = true;

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

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

    public function withAsyncRenderUrl($url)
    {
        $this->checkStringArg('url', $url);
        $clone = clone $this;
        $clone->async_render_url = $url;
        return $clone;
    }

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

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


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

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

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

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

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


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