class.ilAsyncPropertyFormGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\HTTP\Wrapper\RequestWrapper;

class ilAsyncPropertyFormGUI extends ilPropertyFormGUI
{
    protected static string $js_path = "./Modules/StudyProgramme/templates/js/";

    protected static string $default_from_name = "async_form";

    protected static array $js_on_load_added = array();

    protected bool $has_errors = false;

    protected bool $is_async = true;

    protected RequestWrapper $request_wrapper;

    public function __construct(RequestWrapper $request_wrapper, array $config = array(), bool $is_async = true)
    {
        parent::__construct();

        foreach ($config as $key => $value) {
            $setterMethod = "set" . ucfirst($key);
            if (method_exists($this, $setterMethod)) {
                $setterMethod($value);
            }
        }

        $this->request_wrapper = $request_wrapper;
        $this->setAsync($is_async);
        $this->setName(self::$default_from_name);
    }


    public static function addJavaScript(bool $add_form_loader = false, string $js_base_path = null): void
    {
        global $DIC;
        $tpl = $DIC['tpl'];

        $js_path = $js_base_path ?? self::$js_path;

        $tpl->addJavaScript($js_path . 'ilAsyncPropertyFormGUI.js');

        $global_config =
            "$.ilAsyncPropertyForm.global_config.error_message_template = '" .
            self::getErrorMessageTemplate() .
            "'; $.ilAsyncPropertyForm.global_config.async_form_name = '" .
            self::$default_from_name . "';"
        ;

        self::addOnLoadCode('global_config', $global_config);

        if ($add_form_loader) {
            self::addOnLoadCode('form_loader', '$("body").ilAsyncPropertyForm();');
        }
    }

    public function checkInput(): bool
    {
        $result = parent::checkInput();
        $this->has_errors = $result;

        return $result;
    }

    public function getErrors(): array
    {
        if (!$this->check_input_called) {
            $this->checkInput();
        }

        $errors = array();
        foreach ($this->getItems() as $item) {
            // We call method exists as there are items in the form (ilFormSectionHeaderGUI)
            // that do not have alerts. (#16956)
            if (method_exists($item, "getAlert") && $item->getAlert() !== "") {
                $errors[] = array('key' => $item->getFieldId(), 'message' => $item->getAlert());
            }
        }
        return $errors;
    }

    public function hasErrors(): bool
    {
        return $this->has_errors;
    }

    public static function getErrorMessageTemplate(): string
    {
        global $DIC;
        $lng = $DIC['lng'];

        $tpl = new ilTemplate("tpl.property_form.html", true, true, "Services/Form");

        $tpl->setCurrentBlock("alert");
        // TODO: DW -> refactor getImagePath
        $tpl->setVariable("IMG_ALERT", ilUtil::getImagePath("standard/icon_alert.svg"));
        $tpl->setVariable("ALT_ALERT", $lng->txt("alert"));
        $tpl->setVariable("TXT_ALERT", "[TXT_ALERT]");
        $tpl->parseCurrentBlock();
        return trim($tpl->get("alert"));
    }

    public function cloneForm(ilPropertyFormGUI $form_to_clone): ilAsyncPropertyFormGUI
    {
        if (count($this->getItems()) > 0) {
            throw new ilException("You cannot clone into a already filled form!");
        }

        $reflect = new ReflectionClass($this);
        $properties = $reflect->getProperties(ReflectionProperty::IS_PUBLIC);

        foreach ($properties as $property) {
            $this->{$property->getName()} = $property->getValue($form_to_clone);
        }

        foreach ($form_to_clone->getItems() as $item) {
            $this->addItem($item);
        }

        foreach ($form_to_clone->getCommandButtons() as $button) {
            $this->addCommandButton($button['cmd'], $button['text']);
        }

        return $this;
    }

    protected static function addOnLoadCode(string $id, string $content): void
    {
        global $DIC;
        $tpl = $DIC['tpl'];

        if (!isset(self::$js_on_load_added[$id])) {
            $tpl->addOnLoadCode($content);
            self::$js_on_load_added[$id] = $content;
        }
    }

    public function getHTML(): string
    {
        self::addJavaScript($this->isAsync());

        return parent::getHTML();
    }

    public function isSubmitted(): bool
    {
        if ($this->request_wrapper->has("cmd")) {
            return true;
        }
        return false;
    }

    public function setFormAction(string $a_formaction): void
    {
        if ($this->isAsync()) {
            $a_formaction .= "&cmdMode=asynch";
        }

        $this->formaction = $a_formaction;
    }

    public function getJsPath(): ?string
    {
        return self::$js_path;
    }

    public function setJsPath(string $js_path): void
    {
        self::$js_path = $js_path;
    }

    public function getDefaultFormName(): string
    {
        return self::$default_from_name;
    }

    public function isAsync(): bool
    {
        return $this->is_async;
    }

    public function setAsync(bool $is_async): void
    {
        $this->is_async = $is_async;
    }

    public function setName(string $a_name): void
    {
        self::$default_from_name = $a_name;

        parent::setName($a_name);
    }
}