ilFormGUI Class Reference

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

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

Member Function Documentation

getCloseTag()

ilFormGUI::getCloseTag

(

)

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

References getKeepOpen().

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

Here is the call graph for this function:

getContent()

ilFormGUI::getContent

(

)

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

Referenced by getHTML().

                                : string
    {
        return "";
    }

Here is the caller graph for this function:

getFormAction()

ilFormGUI::getFormAction

(

)

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

References $formaction.

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

                                   : string
    {
        return $this->formaction;
    }

Here is the caller graph for this function:

getHTML()

ilFormGUI::getHTML

(

)

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

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

                             : 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();
    }

Here is the call graph for this function:

getId()

ilFormGUI::getId

(

)

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

References $id.

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

                           : string
    {
        return $this->id;
    }

Here is the caller graph for this function:

getKeepOpen()

ilFormGUI::getKeepOpen

(

)

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

References $keepopen.

Referenced by getCloseTag(), and getHTML().

                                 : bool
    {
        return $this->keepopen;
    }

Here is the caller graph for this function:

getMultipart()

ilFormGUI::getMultipart

(

)

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

References $multipart.

Referenced by ilPropertyFormGUI\getContent(), and getHTML().

                                  : bool
    {
        return $this->multipart;
    }

Here is the caller graph for this function:

getName()

ilFormGUI::getName

(

)

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

References $name.

Referenced by getHTML().

                             : string
    {
        return $this->name;
    }

Here is the caller graph for this function:

getOpenTag()

ilFormGUI::getOpenTag

(

)

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

References $opentag.

Referenced by getHTML().

                                : bool
    {
        return $this->opentag;
    }

Here is the caller graph for this function:

getPreventDoubleSubmission()

ilFormGUI::getPreventDoubleSubmission

(

)

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

References $prevent_double_submission.

Referenced by getHTML().

                                                : bool
    {
        return $this->prevent_double_submission;
    }

Here is the caller graph for this function:

getTarget()

ilFormGUI::getTarget

(

)

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

References $target.

Referenced by getHTML().

                               : string
    {
        return $this->target;
    }

Here is the caller graph for this function:

setCloseTag()

ilFormGUI::setCloseTag

(

bool

$a_val

)

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

References setKeepOpen().

Referenced by ilObjContentObjectGUI\editMenuProperties(), and ilObjMediaPoolGUI\initMediaBulkForm().

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

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 36 of file class.ilFormGUI.php.

Referenced by FormMailCodesGUI\__construct(), ILIAS\components\OrgUnit\ARHelper\BaseForm\__construct(), ilOrgUnitPositionFormGUI\__construct(), ilTestRandomQuestionSetGeneralConfigFormGUI\build(), ilTestRandomQuestionSetPoolDefinitionFormGUI\build(), ilAssQuestionSkillAssignmentPropertyFormGUI\build(), assMultipleChoiceGUI\buildEditForm(), ilPCMediaObjectGUI\changeObjectReference(), ilPCTableGUI\editCellAlignment(), ilPCTableGUI\editCellStyle(), ilObjGroupGUI\editMapSettingsObject(), ilObjCourseGUI\editMapSettingsObject(), ilPCMediaObjectGUI\editStyle(), ilForumThreadFormGUI\generateDefaultForm(), ilForumThreadFormGUI\generateMinimalForm(), ilObjStyleSheetGUI\getCloneForm(), ilLTIConsumeProviderFormGUI\getContentSelectionFrame(), ilObjStyleSheetGUI\getCreateForm(), ilObjStyleSheetGUI\getImportForm(), ilMailTemplateGUI\getTemplateForm(), ilObjAdvancedEditingGUI\getTinyForm(), ilMailOptionsFormGUI\init(), ilObjUserFolderGUI\initAccessRestrictionForm(), ilWikiPageGUI\initAdvancedMetaDataForm(), ilObjStudyProgrammeGUI\initAdvancedSettingsForm(), ilObjOrgUnitGUI\initAdvancedSettingsForm(), ilPCDataTableGUI\initCellPropertiesForm(), ilAdvancedMDSettingsGUI\initComplexOptionForm(), ilObjEmployeeTalkSeriesGUI\initCreateForm(), ilObjSAHSLearningModuleGUI\initCreateForm(), ilObjGlossaryGUI\initCreateForm(), ilPCDataTableGUI\initCreationForm(), ilBlogPostingGUI\initDateForm(), ilLTIConsumeProviderFormGUI\initDynRegForm(), ilObjFolderGUI\initEditForm(), ilObjRootFolderGUI\initEditForm(), ilObjCategoryGUI\initEditForm(), ilObjCourseGUI\initEditForm(), ilContainerGUI\initEditForm(), ilPCDataTableGUI\initEditingForm(), ilAdvancedMDSettingsGUI\initFieldForm(), ilDclTableViewEditFormGUI\initForm(), ilWebDAVMountInstructionsDocumentFormGUI\initForm(), ilLTIConsumerSettingsFormGUI\initForm(), ilBiblFieldFilterFormGUI\initForm(), ilBiblLibraryFormGUI\initForm(), ilLTIConsumeProviderFormGUI\initForm(), ilOrgUnitTypeCustomIconsFormGUI\initForm(), ilAccessibilityDocumentFormGUI\initForm(), ilExtIdGUI\initForm(), ilStudyProgrammeTypeCustomIconsFormGUI\initForm(), ilRegistrationSettingsGUI\initForm(), ilContainerReferenceGUI\initForm(), ilObjGroupGUI\initForm(), ilCalendarAppointmentGUI\initFormConfirmBooking(), ilCourseObjectivesGUI\initFormRandom(), ilMembershipAdministrationGUI\initFormSettings(), ilObjAdvancedEditingGUI\initGeneralPageSettingsForm(), ilPCDataTableGUI\initImportForm(), ilCalendarCategoryGUI\initImportForm(), ilObjCourseGUI\initInfoEditor(), ilObjGroupGUI\initInfoEditor(), ilSkillRootGUI\initInputForm(), ilECSSettingsGUI\initMappingsForm(), ilMediaPoolPageGUI\initMediaPoolPageForm(), ilObjectCustomUserFieldsGUI\initMemberForm(), ilObjContentObjectGUI\initMenuEntryForm(), ilObjContentObjectGUI\initMenuForm(), ilObjUserFolderGUI\initNewAccountMailForm(), ilPageObjectGUI\initOpenedContentForm(), ilConsultationHoursGUI\initSettingsForm(), ilObjAdvancedEditingGUI\initTagsForm(), ilBlogPostingGUI\initTitleForm(), ilLTIConsumeProviderFormGUI\initToolConfigForm(), ilObjSCORMLearningModuleGUI\initTrackingImportForm(), ilPCMediaObjectGUI\insert(), ilStudyProgrammeTypeAdvancedMetaDataFormGUI\saveObject(), ilObjOrgUnitSettingsFormGUI\saveObject(), ilObjEmployeeTalkGUI\sendUpdateNotification(), and ilAccessibilityCriterionFormGUI\setCheckInputCalled().

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

Here is the caller graph for this function:

setId()

ilFormGUI::setId

(

string

$a_id

)

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

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

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

Here is the caller graph for this function:

setKeepOpen()

ilFormGUI::setKeepOpen

(

bool

$a_keepopen

)

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

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

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

Here is the caller graph for this function:

setMultipart()

ilFormGUI::setMultipart

(

bool

$a_multipart

)

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

Referenced by ilObjCourseGUI\initInfoEditor(), and ilPropertyFormGUI\insertItem().

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

Here is the caller graph for this function:

setName()

ilFormGUI::setName

(

string

$a_name

)

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

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

setOpenTag()

ilFormGUI::setOpenTag

(

bool

$a_open

)

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

Referenced by ilObjContentObjectGUI\editMenuProperties(), and ilObjMediaPoolGUI\initMediaBulkForm().

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

Here is the caller graph for this function:

setPreventDoubleSubmission()

ilFormGUI::setPreventDoubleSubmission

(

bool

$a_val

)

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

Referenced by ilPropertyFormGUI\__construct().

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

Here is the caller graph for this function:

setTarget()

ilFormGUI::setTarget

(

string

$a_target

)

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

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

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

Here is the caller graph for this function:

Field Documentation

$formaction

string ilFormGUI::$formaction = ""

protected

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

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

$id

string ilFormGUI::$id = ''

protected

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

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

$keepopen

bool ilFormGUI::$keepopen = false

protected

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

Referenced by getKeepOpen().

$multipart

bool ilFormGUI::$multipart = false

protected

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

Referenced by getMultipart().

$name

string ilFormGUI::$name = ''

protected

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

Referenced by getName(), ilBiblLibraryFormGUI\initForm(), ilDclPropertyFormGUI\rebuildTempFileByHash(), and ilPropertyFormGUI\rebuildUploadedFiles().

$opentag

bool ilFormGUI::$opentag = true

protected

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

Referenced by getOpenTag().

$prevent_double_submission

bool ilFormGUI::$prevent_double_submission = false

protected

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

Referenced by getPreventDoubleSubmission().

$target

string ilFormGUI::$target = ''

protected

Definition at line 33 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