class.ilAsyncPropertyFormGUI.php

Go to the documentation of this file.

<?php
require_once("./Services/Form/classes/class.ilPropertyFormGUI.php");

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

        protected static $default_from_name = "async_form";

        protected static $js_on_load_added = array();

        protected $has_errors = false;

        protected $is_async = true;

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

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

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


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

                $js_path = (isset($js_base_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() {
                $result = parent::checkInput();
                $this->has_errors = $result;

                return $result;
        }

        public function getErrors() {
                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() {
                return $this->has_errors;
        }


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

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

                $tpl->setCurrentBlock("alert");
                $tpl->setVariable("IMG_ALERT", ilUtil::getImagePath("icon_alert.svg"));
                $tpl->setVariable("ALT_ALERT", $lng->txt("alert"));
                $tpl->setVariable("TXT_ALERT", "[TXT_ALERT]");
                $tpl->parseCurrentBlock();
                $content = trim($tpl->get("alert"));

                return $content;
        }

        public function cloneForm(ilPropertyFormGUI $form_to_clone) {
                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($id, $content) {
                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() {
                self::addJavaScript($this->isAsync());

                return parent::getHTML();
        }

        public function isSubmitted() {
                if(isset($_POST['cmd'])) {
                        return true;
                }
                return false;
        }


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

                $this->formaction = $a_formaction;
        }

        public function getJsPath() {
                return $this->js_path;
        }

        public function setJsPath($js_path) {
                $this->js_path = $js_path;
        }

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

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


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


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

                parent::setName($a_name);
        }
}