class.ilFormGUI.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2010 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilFormGUI
{
        protected $formaction;
        protected $multipart = false;
        protected $keepopen = false;
        protected $opentag = true;
        protected $id;
        protected $name;
        protected $prevent_double_submission = false;

        function setFormAction($a_formaction)
        {
                $this->formaction = $a_formaction;
        }

        function getFormAction()
        {
                return $this->formaction;
        }

        function setTarget($a_target)
        {
                $this->target = $a_target;
        }

        function getTarget()
        {
                return $this->target;
        }

        function setMultipart($a_multipart)
        {
                $this->multipart = $a_multipart;
        }

        function getMultipart()
        {
                return $this->multipart;
        }

        function setId($a_id)
        {
                $this->id = $a_id;
        }

        function getId()
        {
                return $this->id;
        }
        
        function setName($a_name)
        {
                $this->name = $a_name;
        }

        function getName()
        {
                return $this->name;
        }

        function setKeepOpen($a_keepopen)
        {
                $this->keepopen = $a_keepopen;
        }

        function getKeepOpen()
        {
                return $this->keepopen;
        }

        function setOpenTag($a_open)
        {
                $this->opentag = $a_open;
        }

        function getOpenTag()
        {
                return $this->opentag;
        }
        
        function setCloseTag($a_val)
        {
                $this->setKeepOpen(!$a_val);
        }
        
        function getCloseTag()
        {
                return !$this->getKeepOpen();
        }
        
        function setPreventDoubleSubmission($a_val)
        {
                $this->prevent_double_submission = $a_val;
        }
        
        function getPreventDoubleSubmission()
        {
                return $this->prevent_double_submission;
        }
        
        function getHTML()
        {
                $tpl = new ilTemplate("tpl.form.html", true, true, "Services/Form");
                
                // this line also sets multipart, so it must be before the multipart check
                $content = $this->getContent();
                if ($this->getOpenTag())
                {
                        $opentpl = new ilTemplate('tpl.form_open.html', true, true, "Services/Form");
                        if ($this->getTarget() != "")
                        {
                                $opentpl->setCurrentBlock("form_target");
                                $opentpl->setVariable("FORM_TARGET", $this->getTarget());
                                $opentpl->parseCurrentBlock();
                        }
                        if ($this->getName() != "")
                        {
                                $opentpl->setCurrentBlock("form_name");
                                $opentpl->setVariable("FORM_NAME", $this->getName());
                                $opentpl->parseCurrentBlock();
                        }
                        if ($this->getPreventDoubleSubmission())
                        {
                                $opentpl->setVariable("FORM_CLASS", "preventDoubleSubmission");
                        }

                        if ($this->getMultipart())
                        {
                                $opentpl->touchBlock("multipart");
                                /*if (function_exists("apc_fetch"))
                                //
                                // Progress bar would need additional browser window (popup)
                                // to not be stopped, when form is submitted  (we can't work
                                // with an iframe or httprequest solution here)
                                //
                                {
                                        $tpl->touchBlock("onsubmit");
                                        
                                        //onsubmit="postForm('{ON_ACT}','form_{F_ID}',1); return false;"
                                        $tpl->setCurrentBlock("onsubmit");
                                        $tpl->setVariable("ON_ACT", $this->getFormAction());
                                        $tpl->setVariable("F_ID", $this->getId());
                                        $tpl->setVariable("F_ID", $this->getId());
                                        $tpl->parseCurrentBlock();
        
                                        $tpl->setCurrentBlock("hidden_progress");
                                        $tpl->setVariable("APC_PROGRESS_ID", uniqid());
                                        $tpl->setVariable("APC_FORM_ID", $this->getId());
                                        $tpl->parseCurrentBlock();
                                }*/
                        }
                        $opentpl->setVariable("FORM_ACTION", $this->getFormAction());
                        if ($this->getId() != "")
                        {
                                $opentpl->setVariable("FORM_ID", $this->getId());
                        }
                        $opentpl->parseCurrentBlock();
                        $tpl->setVariable('FORM_OPEN_TAG', $opentpl->get());
                }
                $tpl->setVariable("FORM_CONTENT", $content);
                if (!$this->getKeepOpen())
                {
                        $tpl->setVariable("FORM_CLOSE_TAG", "</form>");
                }
                return $tpl->get();
        }

        function getContent()
        {
                return "";
        }

}
?>