This class represents a form user interface. More...

Inheritance diagram for ilFormGUI:

Collaboration diagram for ilFormGUI:

Public Member Functions
	setFormAction (string $a_formaction)

	getFormAction ()

	setTarget (string $a_target)

	getTarget ()

	setMultipart (bool $a_multipart)

	getMultipart ()

	setId (string $a_id)

	getId ()

	setName (string $a_name)

	getName ()

	setKeepOpen (bool $a_keepopen)

	getKeepOpen ()

	setOpenTag (bool $a_open)

	getOpenTag ()

	setCloseTag (bool $a_val)

	getCloseTag ()

	setPreventDoubleSubmission (bool $a_val)

	getPreventDoubleSubmission ()

	getHTML ()

	getContent ()

Protected Attributes
string	$formaction = ""

bool	$multipart = false

bool	$keepopen = false

bool	$opentag = true

string	$id = ''

string	$name = ''

string	$target = ''

bool	$prevent_double_submission = false

Detailed Description

This class represents a form user interface.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Deprecated:: 12 This component will be removed with ILIAS 12

Definition at line 26 of file class.ilFormGUI.php.

Member Function Documentation

◆ getCloseTag()

ilFormGUI::getCloseTag ( )

Definition at line 112 of file class.ilFormGUI.php.

                                 : bool
    {
        return !$this->getKeepOpen();
    }

References getKeepOpen().

Here is the call graph for this function:

◆ getContent()

ilFormGUI::getContent ( )

Reimplemented in ilPropertyFormGUI.

Definition at line 187 of file class.ilFormGUI.php.

                                : string
    {
        return "";
    }

Referenced by getHTML().

Here is the caller graph for this function:

◆ getFormAction()

ilFormGUI::getFormAction ( )

Definition at line 42 of file class.ilFormGUI.php.

                                   : string
    {
        return $this->formaction;
    }

References $formaction.

Referenced by ilDclBaseFieldModel\getConfirmationGUI(), and getHTML().

Here is the caller graph for this function:

◆ getHTML()

ilFormGUI::getHTML ( )

Reimplemented in ilPropertyFormGUI, ilLTIConsumerProviderSelectionFormTableGUI, and ilAssQuestionSkillAssignmentPropertyFormGUI.

Definition at line 127 of file class.ilFormGUI.php.

                             : string
    {
        $tpl = new ilTemplate("tpl.form.html", true, true, "components/ILIAS/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, "components/ILIAS/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();
    }

References getContent(), getFormAction(), getId(), getKeepOpen(), getMultipart(), getName(), getOpenTag(), getPreventDoubleSubmission(), and getTarget().

Here is the call graph for this function:

◆ getId()

ilFormGUI::getId ( )

Reimplemented in ilMStListCoursesGUI.

Definition at line 72 of file class.ilFormGUI.php.

                           : string
    {
        return $this->id;
    }

References $id.

Referenced by ilObjForumGUI\decorateWithAutosave(), and getHTML().

Here is the caller graph for this function:

◆ getKeepOpen()

ilFormGUI::getKeepOpen ( )

Definition at line 92 of file class.ilFormGUI.php.

                                 : bool
    {
        return $this->keepopen;
    }

References $keepopen.

Referenced by getCloseTag(), and getHTML().

Here is the caller graph for this function:

◆ getMultipart()

ilFormGUI::getMultipart ( )

Definition at line 62 of file class.ilFormGUI.php.

                                  : bool
    {
        return $this->multipart;
    }

References $multipart.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getName()

ilFormGUI::getName ( )

Definition at line 82 of file class.ilFormGUI.php.

                             : string
    {
        return $this->name;
    }

References $name.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getOpenTag()

ilFormGUI::getOpenTag ( )

Definition at line 102 of file class.ilFormGUI.php.

                                : bool
    {
        return $this->opentag;
    }

References $opentag.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getPreventDoubleSubmission()

ilFormGUI::getPreventDoubleSubmission ( )

Definition at line 122 of file class.ilFormGUI.php.

                                                : bool
    {
        return $this->prevent_double_submission;
    }

References $prevent_double_submission.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getTarget()

ilFormGUI::getTarget ( )

Definition at line 52 of file class.ilFormGUI.php.

                               : string
    {
        return $this->target;
    }

References $target.

Referenced by getHTML().

Here is the caller graph for this function:

◆ setCloseTag()

ilFormGUI::setCloseTag ( bool $a_val )

Definition at line 107 of file class.ilFormGUI.php.

                                            : void
    {
        $this->setKeepOpen(!$a_val);
    }

References setKeepOpen().

Referenced by ilObjContentObjectGUI\editMenuProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFormAction()

ilFormGUI::setFormAction ( string $a_formaction )

Definition at line 37 of file class.ilFormGUI.php.

                                                       : void
    {
        $this->formaction = $a_formaction;
    }

Referenced by ILIAS\components\OrgUnit\ARHelper\BaseForm\__construct(), FormMailCodesGUI\__construct(), ilOrgUnitPositionFormGUI\__construct(), ilTestRandomQuestionSetGeneralConfigFormGUI\build(), ilAssQuestionSkillAssignmentPropertyFormGUI\build(), ilTestRandomQuestionSetPoolDefinitionFormGUI\build(), assMultipleChoiceGUI\buildEditForm(), ilPCMediaObjectGUI\changeObjectReference(), ilPCTableGUI\editCellAlignment(), ilPCTableGUI\editCellStyle(), ilDidacticTemplateSettingsGUI\editImportForm(), ilObjCourseGUI\editMapSettingsObject(), ilObjGroupGUI\editMapSettingsObject(), ilPCMediaObjectGUI\editStyle(), ilForumThreadFormGUI\generateDefaultForm(), ilForumThreadFormGUI\generateMinimalForm(), ilObjStyleSheetGUI\getCloneForm(), ilLTIConsumeProviderFormGUI\getContentSelectionFrame(), ilObjStyleSheetGUI\getCreateForm(), ilObjStyleSheetGUI\getImportForm(), ilMailTemplateGUI\getTemplateForm(), ilMailOptionsFormGUI\init(), ilObjOrgUnitGUI\initAdvancedSettingsForm(), ilObjStudyProgrammeGUI\initAdvancedSettingsForm(), ilObjEmployeeTalkSeriesGUI\initCreateForm(), ilObjGlossaryGUI\initCreateForm(), ilObjSAHSLearningModuleGUI\initCreateForm(), ilLTIConsumeProviderFormGUI\initDynRegForm(), ilObjCourseGUI\initEditForm(), ilObjFolderGUI\initEditForm(), ilDidacticTemplateSettingsGUI\initEditTemplate(), ilAccessibilityDocumentFormGUI\initForm(), ilBiblLibraryFormGUI\initForm(), ilBiblFieldFilterFormGUI\initForm(), ilExtIdGUI\initForm(), ilOrgUnitTypeCustomIconsFormGUI\initForm(), ilRegistrationSettingsGUI\initForm(), ilStudyProgrammeTypeCustomIconsFormGUI\initForm(), ilWebDAVMountInstructionsDocumentFormGUI\initForm(), ilContainerReferenceGUI\initForm(), ilObjGroupGUI\initForm(), ilLTIConsumeProviderFormGUI\initForm(), ilLTIConsumerSettingsFormGUI\initForm(), ilCourseObjectivesGUI\initFormRandom(), ilMembershipAdministrationGUI\initFormSettings(), ilObjAdvancedEditingGUI\initGeneralPageSettingsForm(), ilCalendarCategoryGUI\initImportForm(), ilObjCourseGUI\initInfoEditor(), ilObjGroupGUI\initInfoEditor(), ilSkillRootGUI\initInputForm(), ilECSSettingsGUI\initMappingsForm(), ilObjectCustomUserFieldsGUI\initMemberForm(), ilObjContentObjectGUI\initMenuEntryForm(), ilObjContentObjectGUI\initMenuForm(), ilPageObjectGUI\initOpenedContentForm(), ilLTIConsumeProviderFormGUI\initToolConfigForm(), and ilObjSCORMLearningModuleGUI\initTrackingImportForm().

Here is the caller graph for this function:

◆ setId()

ilFormGUI::setId ( string $a_id )

Definition at line 67 of file class.ilFormGUI.php.

                                       : void
    {
        $this->id = $a_id;
    }

Referenced by ilTestRandomQuestionSetGeneralConfigFormGUI\build(), ilTestRandomQuestionSetPoolDefinitionFormGUI\build(), and assMultipleChoiceGUI\buildEditForm().

Here is the caller graph for this function:

◆ setKeepOpen()

ilFormGUI::setKeepOpen ( bool $a_keepopen )

Definition at line 87 of file class.ilFormGUI.php.

                                                 : void
    {
        $this->keepopen = $a_keepopen;
    }

Referenced by ilPCTableGUI\editCellAlignment(), ilPCTableGUI\editCellStyle(), and setCloseTag().

Here is the caller graph for this function:

◆ setMultipart()

ilFormGUI::setMultipart ( bool $a_multipart )

Definition at line 57 of file class.ilFormGUI.php.

                                                   : void
    {
        $this->multipart = $a_multipart;
    }

Referenced by ilObjCourseGUI\initInfoEditor().

Here is the caller graph for this function:

◆ setName()

ilFormGUI::setName ( string $a_name )

Definition at line 77 of file class.ilFormGUI.php.

                                           : void
    {
        $this->name = $a_name;
    }

◆ setOpenTag()

ilFormGUI::setOpenTag ( bool $a_open )

Definition at line 97 of file class.ilFormGUI.php.

                                            : void
    {
        $this->opentag = $a_open;
    }

Referenced by ilObjContentObjectGUI\editMenuProperties().

Here is the caller graph for this function:

◆ setPreventDoubleSubmission()

ilFormGUI::setPreventDoubleSubmission ( bool $a_val )

Definition at line 117 of file class.ilFormGUI.php.

                                                           : void
    {
        $this->prevent_double_submission = $a_val;
    }

Referenced by ilPropertyFormGUI\__construct().

Here is the caller graph for this function:

◆ setTarget()

ilFormGUI::setTarget ( string $a_target )

Definition at line 47 of file class.ilFormGUI.php.

                                               : void
    {
        $this->target = $a_target;
    }

Referenced by ILIAS\components\OrgUnit\ARHelper\BaseForm\__construct(), ilOrgUnitPositionFormGUI\__construct(), ilObjEmployeeTalkSeriesGUI\initCreateForm(), ilObjGlossaryGUI\initCreateForm(), ilObjSAHSLearningModuleGUI\initCreateForm(), and ilBiblFieldFilterFormGUI\initForm().

Here is the caller graph for this function:

Field Documentation

◆ $formaction

string ilFormGUI::$formaction = ""

protected

Definition at line 28 of file class.ilFormGUI.php.

Referenced by ilLTIConsumeProviderFormGUI\getContentSelectionFrame(), and getFormAction().

◆ $id

string ilFormGUI::$id = ''

protected

Definition at line 32 of file class.ilFormGUI.php.

Referenced by ilAssOrderingQuestionAuthoringFormGUI\addSpecificOrderingQuestionCommandButtons(), ilAssOrderingQuestionAuthoringFormGUI\buildCommandButtonId(), getId(), and ilOrgUnitPositionFormGUI\initFormElements().

◆ $keepopen

bool ilFormGUI::$keepopen = false

protected

Definition at line 30 of file class.ilFormGUI.php.

Referenced by getKeepOpen().

◆ $multipart

bool ilFormGUI::$multipart = false

protected

Definition at line 29 of file class.ilFormGUI.php.

Referenced by getMultipart().

◆ $name

string ilFormGUI::$name = ''

protected

Definition at line 33 of file class.ilFormGUI.php.

Referenced by getName(), and ilBiblLibraryFormGUI\initForm().

◆ $opentag

bool ilFormGUI::$opentag = true

protected

Definition at line 31 of file class.ilFormGUI.php.

Referenced by getOpenTag().

◆ $prevent_double_submission

bool ilFormGUI::$prevent_double_submission = false

protected

Definition at line 35 of file class.ilFormGUI.php.

Referenced by getPreventDoubleSubmission().

◆ $target

string ilFormGUI::$target = ''

protected

Definition at line 34 of file class.ilFormGUI.php.

Referenced by getTarget().

The documentation for this class was generated from the following file:

components/ILIAS/Form/classes/class.ilFormGUI.php

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ getCloseTag()

◆ getContent()

◆ getFormAction()

◆ getHTML()

◆ getId()

◆ getKeepOpen()

◆ getMultipart()

◆ getName()

◆ getOpenTag()

◆ getPreventDoubleSubmission()

◆ getTarget()

◆ setCloseTag()

◆ setFormAction()

◆ setId()

◆ setKeepOpen()

◆ setMultipart()

◆ setName()

◆ setOpenTag()

◆ setPreventDoubleSubmission()

◆ setTarget()

Field Documentation

◆ $formaction

◆ $id

◆ $keepopen

◆ $multipart

◆ $name

◆ $opentag

◆ $prevent_double_submission

◆ $target