ilFormGUI Class Reference

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

Inheritance diagram for ilFormGUI:

Collaboration diagram for ilFormGUI:

Public Member Functions
	setFormAction ($a_formaction)
	Set FormAction. More...
	getFormAction ()
	Get FormAction. More...
	setTarget ($a_target)
	Set Target. More...
	getTarget ()
	Get Target. More...
	setMultipart ($a_multipart)
	Set Enctype Multipart/Formdata true/false. More...
	getMultipart ()
	Get Enctype Multipart/Formdata true/false. More...
	setId ($a_id)
	Set Id. More...
	getId ()
	Get Id. More...
	setName ($a_name)
	Set Name. More...
	getName ()
	Get Name. More...
	setKeepOpen ($a_keepopen)
	Set Keep Form Tag Open. More...
	getKeepOpen ()
	Get Keep Form Tag Open. More...
	setOpenTag ($a_open)
	Enable/Disable Open Form Tag. More...
	getOpenTag ()
	Get Open Form Tag Enabled. More...
	setCloseTag ($a_val)
	Set close tag. More...
	getCloseTag ()
	Get close tag. More...
	setPreventDoubleSubmission ($a_val)
	Set prevent double submission. More...
	getPreventDoubleSubmission ()
	Get prevent double submission. More...
	getHTML ()
	Get HTML. More...
	getContent ()
	Get Content. More...

Protected Attributes
	$formaction
	$multipart = false
	$keepopen = false
	$opentag = true
	$id
	$name
	$prevent_double_submission = false

Detailed Description

This class represents a form user interface.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

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

Member Function Documentation

getCloseTag()

ilFormGUI::getCloseTag

(

)

Get close tag.

Returns

boolean close tag true/false

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

References getKeepOpen().

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

Here is the call graph for this function:

getContent()

ilFormGUI::getContent

(

)

Get Content.

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

Referenced by getHTML().

    {
        return "";
    }

Here is the caller graph for this function:

getFormAction()

ilFormGUI::getFormAction

(

)

Get FormAction.

Returns

string FormAction

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

References $formaction.

Referenced by ilOrgUnitDefaultPermissionFormGUI\__construct(), ILIAS\Modules\OrgUnit\ARHelper\BaseForm\__construct(), ilDclBaseFieldModel\getConfirmationGUI(), ilTermsOfServiceDocumentGUI\getCriterionForm(), ilTermsOfServiceDocumentGUI\getDocumentForm(), and getHTML().

    {
        return $this->formaction;
    }

Here is the caller graph for this function:

getHTML()

ilFormGUI::getHTML

(

)

Get HTML.

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

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

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

Here is the call graph for this function:

getId()

ilFormGUI::getId

(

)

Get Id.

Returns

string Id

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

References $id.

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

    {
        return $this->id;
    }

Here is the caller graph for this function:

getKeepOpen()

ilFormGUI::getKeepOpen

(

)

Get Keep Form Tag Open.

Returns

boolean Keep Form Tag Open

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

References $keepopen.

Referenced by getCloseTag(), and getHTML().

    {
        return $this->keepopen;
    }

Here is the caller graph for this function:

getMultipart()

ilFormGUI::getMultipart

(

)

Get Enctype Multipart/Formdata true/false.

Returns

boolean Enctype Multipart/Formdata true/false

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

References $multipart.

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

    {
        return $this->multipart;
    }

Here is the caller graph for this function:

getName()

ilFormGUI::getName

(

)

Get Name.

Returns

string Name

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

References $name.

Referenced by getHTML().

    {
        return $this->name;
    }

Here is the caller graph for this function:

getOpenTag()

ilFormGUI::getOpenTag

(

)

Get Open Form Tag Enabled.

Returns

boolean open form tag enabled

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

References $opentag.

Referenced by getHTML().

    {
        return $this->opentag;
    }

Here is the caller graph for this function:

getPreventDoubleSubmission()

ilFormGUI::getPreventDoubleSubmission

(

)

Get prevent double submission.

Returns

bool prevent double submission

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

References $prevent_double_submission.

Referenced by getHTML().

    {
        return $this->prevent_double_submission;
    }

Here is the caller graph for this function:

getTarget()

ilFormGUI::getTarget

(

)

Get Target.

Returns

string Target

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

References $target.

Referenced by getHTML().

    {
        return $this->target;
    }

Here is the caller graph for this function:

setCloseTag()

ilFormGUI::setCloseTag

(

$a_val

)

Set close tag.

Parameters

boolean

close tag true/false

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

References setKeepOpen().

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

Here is the call graph for this function:

setFormAction()

ilFormGUI::setFormAction

(

$a_formaction

)

Set FormAction.

Parameters

string

$a_formaction

FormAction

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

Referenced by arConfigFormGUI\__construct(), ilOrgUnitDefaultPermissionFormGUI\__construct(), ILIAS\Modules\OrgUnit\ARHelper\BaseForm\__construct(), FormMailCodesGUI\__construct(), ilFileVersionFormGUI\__construct(), ilTestRandomQuestionSetGeneralConfigFormGUI\build(), ilTestRandomQuestionSetPoolDefinitionFormGUI\build(), ilAssQuestionSkillAssignmentPropertyFormGUI\build(), ilObjContentObjectGUI\chapters(), ilMailOptionsFormGUI\init(), ilMemcacheServerFormGUI\initForm(), ilBiblLibraryFormGUI\initForm(), ilDclTableViewEditFormGUI\initForm(), ilBiblFieldFilterFormGUI\initForm(), ilTermsOfServiceSettingsFormGUI\initForm(), ilForumThreadFormGUI\initForm(), ilOrgUnitTypeFormGUI\initForm(), ilStudyProgrammeTypeFormGUI\initForm(), ilOrgUnitTypeCustomIconsFormGUI\initForm(), ilStudyProgrammeTypeCustomIconsFormGUI\initForm(), ilTermsOfServiceDocumentFormGUI\initForm(), ilPersonalChatSettingsFormGUI\initForm(), arEditGUI\initFormAction(), ilObjUserFolderGUI\initLoginSettingsForm(), ilOrgUnitTypeAdvancedMetaDataFormGUI\saveObject(), ilStudyProgrammeTypeAdvancedMetaDataFormGUI\saveObject(), ilObjOrgUnitSettingsFormGUI\saveObject(), ilTermsOfServiceCriterionFormGUI\setCheckInputCalled(), and ilStructureObjectGUI\showHierarchy().

    {
        $this->formaction = $a_formaction;
    }

Here is the caller graph for this function:

setId()

ilFormGUI::setId

(

$a_id

)

Set Id.

If you use multiple forms on a screen you should set this value.

Parameters

string

$a_id

Id

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

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

    {
        $this->id = $a_id;
    }

Here is the caller graph for this function:

setKeepOpen()

ilFormGUI::setKeepOpen

(

$a_keepopen

)

Set Keep Form Tag Open.

Parameters

boolean

$a_keepopen

Keep Form Tag Open

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

Referenced by setCloseTag().

    {
        $this->keepopen = $a_keepopen;
    }

Here is the caller graph for this function:

setMultipart()

ilFormGUI::setMultipart

(

$a_multipart

)

Set Enctype Multipart/Formdata true/false.

Parameters

boolean

$a_multipart

Enctype Multipart/Formdata true/false

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

Referenced by ilPropertyFormGUI\insertItem().

    {
        $this->multipart = $a_multipart;
    }

Here is the caller graph for this function:

setName()

ilFormGUI::setName

(

$a_name

)

Set Name.

Useful for Javascript

Parameters

string

$a_name

Name

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

    {
        $this->name = $a_name;
    }

setOpenTag()

ilFormGUI::setOpenTag

(

$a_open

)

Enable/Disable Open Form Tag.

Parameters

boolean

$a_keepopen

enable/disable form open tag

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

    {
        $this->opentag = $a_open;
    }

setPreventDoubleSubmission()

ilFormGUI::setPreventDoubleSubmission

(

$a_val

)

Set prevent double submission.

Parameters

bool

$a_val

prevent double submission

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

Referenced by ilPropertyFormGUI\__construct().

    {
        $this->prevent_double_submission = $a_val;
    }

Here is the caller graph for this function:

setTarget()

ilFormGUI::setTarget

(

$a_target

)

Set Target.

Parameters

string

$a_target

Target

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

Referenced by ilOrgUnitDefaultPermissionFormGUI\__construct(), ILIAS\Modules\OrgUnit\ARHelper\BaseForm\__construct(), ilFileVersionFormGUI\__construct(), ilMemcacheServerFormGUI\initForm(), and ilBiblFieldFilterFormGUI\initForm().

    {
        $this->target = $a_target;
    }

Here is the caller graph for this function:

Field Documentation

$formaction

ilFormGUI::$formaction

protected

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

Referenced by getFormAction().

$id

ilFormGUI::$id

protected

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

Referenced by ilAsyncPropertyFormGUI\addOnLoadCode(), ilOrgUnitPositionFormGUI\fillForm(), ilOrgUnitDefaultPermissionFormGUI\fillForm(), ilOrgUnitDefaultPermissionFormGUI\fillObject(), getId(), ilOrgUnitPositionFormGUI\initFormElements(), and ilOrgUnitDefaultPermissionFormGUI\initFormElements().

$keepopen

ilFormGUI::$keepopen = false

protected

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

Referenced by getKeepOpen().

$multipart

ilFormGUI::$multipart = false

protected

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

Referenced by getMultipart().

$name

ilFormGUI::$name

protected

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

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

$opentag

ilFormGUI::$opentag = true

protected

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

Referenced by getOpenTag().

$prevent_double_submission

ilFormGUI::$prevent_double_submission = false

protected

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

Referenced by getPreventDoubleSubmission().

---

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

• Services/Form/classes/class.ilFormGUI.php