class.ilAsyncOutputHandler.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Filesystem\Stream\Streams;
use ILIAS\HTTP\Response\ResponseHeader;

class ilAsyncOutputHandler
{
    private const OUTPUT_MODAL = "output_modal";
    private const OUTPUT_EMPTY = "output_empty";

    protected $content;

    protected $heading;

    protected array $window_properties;

    public function __construct($content = null, $heading = null, array $windows_properties = array())
    {
        $this->content = $content;
        $this->heading = $heading;
        $this->window_properties = $windows_properties;
    }

    public function terminate(string $type = self::OUTPUT_MODAL): void
    {
        if ($type === self::OUTPUT_MODAL) {
            $tpl = new ilTemplate('tpl.modal_content.html', false, false, 'Modules/StudyProgramme');
            $tpl->setVariable('HEADING', $this->getHeading());
            $tpl->setVariable('BODY', $this->getContent());

            //TODO: implement window properties
            /*foreach($this->window_properties as $key => $value) {
                if($value) {
                    $tpl->activeBlock($key);
                } else {
                    $tpl->removeBlockData($key);
                }
            }*/

            echo $tpl->get();
            exit();
        }

        if ($type === self::OUTPUT_EMPTY) {
            echo $this->getContent();// TODO PHP8-REVIEW I sugges to use the HTTP service instead of echo/exit
            exit();
        }
    }

    public static function encodeAsyncResponse(array $data = array()): string
    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];

        $data['cmd'] = $ilCtrl->getCmd();

        return json_encode($data, JSON_THROW_ON_ERROR);
    }

    public static function handleAsyncOutput(
        string $normal_content,
        string $async_content = null,
        bool $apply_to_tpl = true
    ) {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $tpl = $DIC['tpl'];
        $http = $DIC['http'];

        $content = ($ilCtrl->isAsynch() && $async_content !== null) ? $async_content : $normal_content;

        if ($ilCtrl->isAsynch()) {
            $http->saveResponse(
                $http->response()
                    ->withHeader(ResponseHeader::CONTENT_TYPE, 'text/html')
                    ->withBody(Streams::ofString($content))
            );
            $http->sendResponse();
            $http->close();
            exit();
        } elseif ($apply_to_tpl) {
            $tpl->setContent($content);
        } else {
            return $content;
        }
    }

    public function getContent()
    {
        return $this->content;
    }

    public function setContent($content): void
    {
        $this->content = $content;
    }

    public function getHeading()
    {
        return $this->heading;
    }

    public function setHeading($heading): void
    {
        $this->heading = $heading;
    }

    public function getWindowProperties(): array
    {
        return $this->window_properties;
    }

    public function setWindowProperties(array $window_properties): void
    {
        $this->window_properties = $window_properties;
    }
}