ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilFormPropertyGUI Class Reference

This class represents a property in a property form. More...

+ Inheritance diagram for ilFormPropertyGUI:
+ Collaboration diagram for ilFormPropertyGUI:

Public Member Functions

 __construct ($a_title="", $a_postvar="")
 Constructor. More...
 
executeCommand ()
 Execute command. More...
 
 getType ()
 Get Type. More...
 
 setTitle ($a_title)
 Set Title. More...
 
 getTitle ()
 Get Title. More...
 
 setPostVar ($a_postvar)
 Set Post Variable. More...
 
 getPostVar ()
 Get Post Variable. More...
 
 getFieldId ()
 Get Post Variable. More...
 
 setInfo ($a_info)
 Set Information Text. More...
 
 getInfo ()
 Get Information Text. More...
 
 setAlert ($a_alert)
 Set Alert Text. More...
 
 getAlert ()
 Get Alert Text. More...
 
 setRequired ($a_required)
 Set Required. More...
 
 getRequired ()
 Get Required. More...
 
 setDisabled ($a_disabled)
 Set Disabled. More...
 
 getDisabled ()
 Get Disabled. More...
 
 checkInput ()
 Check input, strip slashes etc. More...
 
 setParentForm ($a_parentform)
 Set Parent Form. More...
 
 getParentForm ()
 Get Parent Form. More...
 
 setParent ($a_val)
 Set Parent GUI object. More...
 
 getParent ()
 Get Parent GUI object. More...
 
 getSubForm ()
 Get sub form html. More...
 
 hideSubForm ()
 Sub form hidden on init? More...
 
 setHiddenTitle ($a_val)
 Set hidden title (for screenreaders) More...
 
 getHiddenTitle ()
 Get hidden title. More...
 
 getItemByPostVar ($a_post_var)
 Get item by post var. More...
 
 serializeData ()
 serialize data More...
 
 unserializeData ($a_data)
 unserialize data More...
 
 writeToSession ()
 Write to session. More...
 
 clearFromSession ()
 Clear session value. More...
 
 readFromSession ()
 Read from session. More...
 
 getHiddenTag ($a_post_var, $a_value)
 Get hidden tag (used for disabled properties) More...
 
 setMulti ($a_multi, $a_sortable=false, $a_addremove=true)
 Set Multi. More...
 
 getMulti ()
 Get Multi. More...
 
 setMultiValues (array $a_values)
 Set multi values. More...
 
 getMultiValues ()
 Get multi values. More...
 
 getContentOutsideFormTag ()
 Get content that has to reside outside of the parent form tag, e.g. More...
 
 removeProhibitedCharacters ($a_text)
 Remove prohibited characters see #19159. More...
 
 stripSlashesAddSpaceFallback ($a_str)
 Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...
 

Protected Member Functions

 setType ($a_type)
 Set Type. More...
 
 getMultiIconsHTML ()
 Get HTML for multiple value icons. More...
 

Protected Attributes

 $type
 
 $title
 
 $postvar
 
 $info
 
 $alert
 
 $required = false
 
 $parentgui
 
 $parentform
 
 $hidden_title = ""
 
 $multi = false
 
 $multi_sortable = false
 
 $multi_addremove = true
 
 $multi_values
 

Detailed Description

This class represents a property in a property form.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

Definition at line 11 of file class.ilFormPropertyGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilFormPropertyGUI::__construct (   $a_title = "",
  $a_postvar = "" 
)

Constructor.

Parameters
string$a_titleTitle
string$a_postvarPost Variable

Reimplemented in ilRecurrenceInputGUI, ilLuceneQueryInputGUI, ilGloAdvColSortInputGUI, ilScheduleInputGUI, ilCategoryWizardInputGUI, ilMatrixRowWizardInputGUI, ilRandomTestROInputGUI, ilAnswerWizardInputGUI, ilErrorTextWizardInputGUI, ilImagemapFileInputGUI, ilImageWizardInputGUI, ilKprimChoiceWizardInputGUI, ilKVPWizardInputGUI, ilMatchingPairWizardInputGUI, ilMatchingWizardInputGUI, ilSingleChoiceWizardInputGUI, ilSuggestedSolutionSelectorGUI, ilAdvSelectInputGUI, ilAlphabetInputGUI, ilCheckboxGroupInputGUI, ilCheckboxInputGUI, ilColorPickerInputGUI, ilCountrySelectInputGUI, ilCSSRectInputGUI, ilCustomInputGUI, ilDateDurationInputGUI, ilDateTimeInputGUI, ilDragDropFileInputGUI, ilDurationInputGUI, ilEMailInputGUI, ilFeedUrlInputGUI, ilFileInputGUI, ilFileWizardInputGUI, ilFlashFileInputGUI, ilImageFileInputGUI, ilLinkInputGUI, ilLocationInputGUI, ilMultiSelectInputGUI, ilNestedListInputGUI, ilNumberInputGUI, ilPasswordInputGUI, ilRadioGroupInputGUI, ilRegExpInputGUI, ilRepositorySelectorInputGUI, ilSelectBuilderInputGUI, ilSelectInputGUI, ilTagInputGUI, ilTextAreaInputGUI, ilTextInputGUI, ilTextWizardInputGUI, ilUserLoginInputGUI, ilWidthHeightInputGUI, ilCopyrightInputGUI, ilTypicalLearningTimeInputGUI, ilBackgroundImageInputGUI, ilBackgroundPositionInputGUI, ilFontSizeInputGUI, ilNumericStyleValueInputGUI, ilTRBLBorderStyleInputGUI, ilTRBLBorderWidthInputGUI, ilTRBLColorPickerInputGUI, ilTRBLNumericStyleValueInputGUI, and ilCaptchaInputGUI.

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

34 {
35 $this->setTitle($a_title);
36 $this->setPostVar($a_postvar);
37 $this->setDisabled(false);
38 }
setTitle($a_title)
Set Title.
setDisabled($a_disabled)
Set Disabled.
setPostVar($a_postvar)
Set Post Variable.

References setDisabled(), setPostVar(), and setTitle().

+ Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilFormPropertyGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns
boolean Input ok, true/false

Reimplemented in ilScheduleInputGUI, ilChatroomSmiliesCurrentSmileyFormElement, ilDclCheckboxInputGUI, ilGloAdvColSortInputGUI, ilCategoryWizardInputGUI, ilMatrixRowWizardInputGUI, ilRandomTestROInputGUI, ilAnswerWizardInputGUI, ilErrorTextWizardInputGUI, ilEssayKeywordWizardInputGUI, ilImagemapFileInputGUI, ilImageWizardInputGUI, ilKprimChoiceWizardInputGUI, ilKVPWizardInputGUI, ilMatchingPairWizardInputGUI, ilMatchingWizardInputGUI, ilMultipleChoiceWizardInputGUI, ilNestedOrderingGUI, ilSingleChoiceWizardInputGUI, ilSolutionTitleInputGUI, ilSuggestedSolutionSelectorGUI, ilClozeGapInputBuilderGUI, ilRecurrenceInputGUI, ilCaptchaInputGUI, ilAdvSelectInputGUI, ilAlphabetInputGUI, ilBirthdayInputGUI, ilCheckboxGroupInputGUI, ilCheckboxInputGUI, ilColorPickerInputGUI, ilCombinationInputGUI, ilCSSRectInputGUI, ilCustomInputGUI, ilDateDurationInputGUI, ilDateTimeInputGUI, ilDragDropFileInputGUI, ilDurationInputGUI, ilEMailInputGUI, ilFeedUrlInputGUI, ilFileInputGUI, ilFileWizardInputGUI, ilFlashFileInputGUI, ilFormulaInputGUI, ilHiddenInputGUI, ilLinkInputGUI, ilLocationInputGUI, ilMultiSelectInputGUI, ilNestedListInputGUI, ilNonEditableValueGUI, ilNumberInputGUI, ilPasswordInputGUI, ilRadioGroupInputGUI, ilRegExpInputGUI, ilRepositorySelectorInputGUI, ilSelectBuilderInputGUI, ilSelectInputGUI, ilTagInputGUI, ilTextAreaInputGUI, ilTextInputGUI, ilTextWizardInputGUI, ilUserLoginInputGUI, ilMailQuickFilterInputGUI, ilManualPlaceholderInputGUI, ilWidthHeightInputGUI, ilCopyrightInputGUI, ilTypicalLearningTimeInputGUI, ilLuceneQueryInputGUI, ilBackgroundImageInputGUI, ilBackgroundPositionInputGUI, ilFontSizeInputGUI, ilNumericStyleValueInputGUI, ilTRBLBorderStyleInputGUI, ilTRBLBorderWidthInputGUI, ilTRBLColorPickerInputGUI, ilTRBLNumericStyleValueInputGUI, ilTermsOfServiceSignedDocumentFormElementGUI, ilCharSelectorRadioGroupInputGUI, and ilExplorerSelectInputGUI.

Definition at line 211 of file class.ilFormPropertyGUI.php.

212 {
213 return false; // please overwrite
214 }

◆ clearFromSession()

ilFormPropertyGUI::clearFromSession ( )

Clear session value.

Definition at line 351 of file class.ilFormPropertyGUI.php.

352 {
353 $parent = $this->getParent();
354 if (!is_object($parent))
355 {
356 die("You must set parent for ".get_class($this)." to use serialize feature.");
357 }
358 $_SESSION["form_".$parent->getId()][$this->getFieldId()] = false;
359 }
$_SESSION["AccountId"]
getFieldId()
Get Post Variable.
getParent()
Get Parent GUI object.

References $_SESSION, getFieldId(), and getParent().

+ Here is the call graph for this function:

◆ executeCommand()

& ilFormPropertyGUI::executeCommand ( )

Execute command.

Reimplemented in ilLinkInputGUI.

Definition at line 43 of file class.ilFormPropertyGUI.php.

44 {
45 global $ilCtrl;
46
47 $next_class = $ilCtrl->getNextClass($this);
48 $cmd = $ilCtrl->getCmd();
49
50 return $this->$cmd();
51 }
global $ilCtrl
Definition: ilias.php:18
$cmd
Definition: sahs_server.php:35

References $cmd, and $ilCtrl.

◆ getAlert()

ilFormPropertyGUI::getAlert ( )

Get Alert Text.

Returns
string Alert Text

Definition at line 161 of file class.ilFormPropertyGUI.php.

162 {
163 return $this->alert;
164 }

References $alert.

◆ getContentOutsideFormTag()

ilFormPropertyGUI::getContentOutsideFormTag ( )

Get content that has to reside outside of the parent form tag, e.g.

panels/layers

Returns
string

Reimplemented in ilLinkInputGUI.

Definition at line 481 of file class.ilFormPropertyGUI.php.

482 {
483
484 }

◆ getDisabled()

◆ getFieldId()

ilFormPropertyGUI::getFieldId ( )

Get Post Variable.

Returns
string Post Variable

Definition at line 118 of file class.ilFormPropertyGUI.php.

119 {
120 $id = str_replace("[", "__", $this->getPostVar());
121 $id = str_replace("]", "__", $id);
122
123 return $id;
124 }
getPostVar()
Get Post Variable.

References getPostVar().

Referenced by ilADTSearchBridge\addToParentElement(), clearFromSession(), getMultiIconsHTML(), ilColorPickerInputGUI\insert(), ilSelectBuilderInputGUI\insert(), ilTRBLColorPickerInputGUI\insert(), ilCategoryWizardInputGUI\insert(), ilMatrixRowWizardInputGUI\insert(), ilAnswerWizardInputGUI\insert(), ilEssayKeywordWizardInputGUI\insert(), ilImagemapFileInputGUI\insert(), ilImageWizardInputGUI\insert(), ilKVPWizardInputGUI\insert(), ilMatchingPairWizardInputGUI\insert(), ilMatchingWizardInputGUI\insert(), ilMultipleChoiceWizardInputGUI\insert(), ilSingleChoiceWizardInputGUI\insert(), ilCSSRectInputGUI\insert(), ilFileWizardInputGUI\insert(), ilFlashFileInputGUI\insert(), ilHiddenInputGUI\insert(), ilImageFileInputGUI\insert(), ilTextAreaInputGUI\insert(), ilTextWizardInputGUI\insert(), ilUserLoginInputGUI\insert(), ilCopyrightInputGUI\insert(), ilEMailInputGUI\insert(), ilScheduleInputGUI\render(), ilFileInputGUI\render(), ilSelectInputGUI\render(), ilTagInputGUI\render(), ilRepositorySelectorInputGUI\render(), ilExplorerSelectInputGUI\render(), ilCheckboxGroupInputGUI\render(), ilCheckboxInputGUI\render(), ilMailTemplateSelectInputGUI\render(), ilGloAdvColSortInputGUI\render(), ilDateTimeInputGUI\render(), ilMultiSelectInputGUI\render(), ilNonEditableValueGUI\render(), ilNumberInputGUI\render(), ilPasswordInputGUI\render(), ilRadioGroupInputGUI\render(), ilNestedOrderingGUI\renderAnswerOutput(), ilRepositorySelectorInputGUI\reset(), ilRepositorySelectorInputGUI\selectRepositoryItem(), ilSelectInputGUI\setHideSubForm(), and writeToSession().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getHiddenTag()

ilFormPropertyGUI::getHiddenTag (   $a_post_var,
  $a_value 
)

Get hidden tag (used for disabled properties)

Definition at line 377 of file class.ilFormPropertyGUI.php.

378 {
379 return '<input type="hidden" name="'.$a_post_var.'" value="'.ilUtil::prepareFormOutput($a_value).'" />';
380 }
static prepareFormOutput($a_str, $a_strip=false)
prepares string output for html forms @access public

References ilUtil\prepareFormOutput().

Referenced by ilTextAreaInputGUI\insert(), ilCopyrightInputGUI\insert(), ilEMailInputGUI\insert(), ilSelectInputGUI\render(), and ilRadioGroupInputGUI\render().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getHiddenTitle()

ilFormPropertyGUI::getHiddenTitle ( )

Get hidden title.

Returns
string hidden title

Definition at line 289 of file class.ilFormPropertyGUI.php.

References $hidden_title.

◆ getInfo()

ilFormPropertyGUI::getInfo ( )

Get Information Text.

Returns
string Information Text

Reimplemented in ilNonEditableValueGUI.

Definition at line 141 of file class.ilFormPropertyGUI.php.

142 {
143 return $this->info;
144 }

References $info.

Referenced by ilDateTimeInputGUI\render().

+ Here is the caller graph for this function:

◆ getItemByPostVar()

ilFormPropertyGUI::getItemByPostVar (   $a_post_var)

Get item by post var.

Returns
mixed false or item object

Reimplemented in ilCheckboxGroupInputGUI, ilRadioGroupInputGUI, and ilSubEnabledFormPropertyGUI.

Definition at line 299 of file class.ilFormPropertyGUI.php.

300 {
301 if ($this->getPostVar() == $a_post_var)
302 {
303 return $this;
304 }
305
306 return false;
307 }

References getPostVar().

+ Here is the call graph for this function:

◆ getMulti()

◆ getMultiIconsHTML()

ilFormPropertyGUI::getMultiIconsHTML ( )
protected

Get HTML for multiple value icons.

Parameters
bool$a_sortable
Returns
string;

Definition at line 439 of file class.ilFormPropertyGUI.php.

440 {
441 global $lng;
442
443 $id = $this->getFieldId();
444
445 $tpl = new ilTemplate("tpl.multi_icons.html", true, true, "Services/Form");
446
447 $html = "";
448 if ($this->multi_addremove)
449 {
450 $tpl->setCurrentBlock("addremove");
451 $tpl->setVariable("ID", $id);
452 $tpl->setVariable("TXT_ADD", $lng->txt("add"));
453 $tpl->setVariable("TXT_REMOVE", $lng->txt("remove"));
454 include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
455 $tpl->setVariable("SRC_ADD", ilGlyphGUI::get(ilGlyphGUI::ADD));
456 $tpl->setVariable("SRC_REMOVE", ilGlyphGUI::get(ilGlyphGUI::REMOVE));
457 $tpl->parseCurrentBlock();
458 }
459
460 if ($this->multi_sortable)
461 {
462
463 $tpl->setCurrentBlock("sortable");
464 $tpl->setVariable("ID", $id);
465 $tpl->setVariable("TXT_DOWN", $lng->txt("down"));
466 $tpl->setVariable("TXT_UP", $lng->txt("up"));
467 include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
468 $tpl->setVariable("SRC_UP", ilGlyphGUI::get(ilGlyphGUI::UP));
469 $tpl->setVariable("SRC_DOWN", ilGlyphGUI::get(ilGlyphGUI::DOWN));
470 $tpl->parseCurrentBlock();
471 }
472
473 return $tpl->get();
474 }
global $tpl
Definition: ilias.php:8
static get($a_glyph, $a_text="")
Get glyph html.
special template class to simplify handling of ITX/PEAR
$html
Definition: example_001.php:87
global $lng
Definition: privfeed.php:40

References $html, $lng, $tpl, ilGlyphGUI\ADD, ilGlyphGUI\DOWN, ilGlyphGUI\get(), getFieldId(), ilGlyphGUI\REMOVE, and ilGlyphGUI\UP.

Referenced by ilSelectInputGUI\render(), and ilNonEditableValueGUI\render().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getMultiValues()

ilFormPropertyGUI::getMultiValues ( )

Get multi values.

Returns
array

Definition at line 428 of file class.ilFormPropertyGUI.php.

References $multi_values.

Referenced by ilSelectInputGUI\render().

+ Here is the caller graph for this function:

◆ getParent()

ilFormPropertyGUI::getParent ( )

Get Parent GUI object.

Returns
object parent gui object

Definition at line 251 of file class.ilFormPropertyGUI.php.

252 {
253 return $this->parent_gui;
254 }

Referenced by clearFromSession(), getParentForm(), readFromSession(), ilRepositorySelectorInputGUI\render(), ilLinkInputGUI\render(), and writeToSession().

+ Here is the caller graph for this function:

◆ getParentForm()

ilFormPropertyGUI::getParentForm ( )

Get Parent Form.

Returns
object Parent Form

Definition at line 231 of file class.ilFormPropertyGUI.php.

232 {
233 return $this->getParent();
234 }

References getParent().

Referenced by ilCheckboxGroupInputGUI\render(), and ilRadioGroupInputGUI\render().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getPostVar()

ilFormPropertyGUI::getPostVar ( )

Get Post Variable.

Returns
string Post Variable

Definition at line 108 of file class.ilFormPropertyGUI.php.

109 {
110 return $this->postvar;
111 }

References $postvar.

Referenced by ilTypicalLearningTimeInputGUI\__buildDaysSelect(), ilTypicalLearningTimeInputGUI\__buildMonthsSelect(), ilScheduleInputGUI\checkInput(), ilDclCheckboxInputGUI\checkInput(), ilGloAdvColSortInputGUI\checkInput(), ilCategoryWizardInputGUI\checkInput(), ilMatrixRowWizardInputGUI\checkInput(), ilAnswerWizardInputGUI\checkInput(), ilErrorTextWizardInputGUI\checkInput(), ilEssayKeywordWizardInputGUI\checkInput(), ilImagemapFileInputGUI\checkInput(), ilImageWizardInputGUI\checkInput(), ilKprimChoiceWizardInputGUI\checkInput(), ilKVPWizardInputGUI\checkInput(), ilMatchingPairWizardInputGUI\checkInput(), ilMatchingWizardInputGUI\checkInput(), ilMultipleChoiceWizardInputGUI\checkInput(), ilSingleChoiceWizardInputGUI\checkInput(), ilSuggestedSolutionSelectorGUI\checkInput(), ilCaptchaInputGUI\checkInput(), ilAdvSelectInputGUI\checkInput(), ilAlphabetInputGUI\checkInput(), ilBirthdayInputGUI\checkInput(), ilCheckboxGroupInputGUI\checkInput(), ilCheckboxInputGUI\checkInput(), ilColorPickerInputGUI\checkInput(), ilCSSRectInputGUI\checkInput(), ilCustomInputGUI\checkInput(), ilDateDurationInputGUI\checkInput(), ilDateTimeInputGUI\checkInput(), ilDragDropFileInputGUI\checkInput(), ilDurationInputGUI\checkInput(), ilEMailInputGUI\checkInput(), ilFeedUrlInputGUI\checkInput(), ilFileInputGUI\checkInput(), ilFileWizardInputGUI\checkInput(), ilFlashFileInputGUI\checkInput(), ilFormulaInputGUI\checkInput(), ilLinkInputGUI\checkInput(), ilLocationInputGUI\checkInput(), ilMultiSelectInputGUI\checkInput(), ilNonEditableValueGUI\checkInput(), ilNumberInputGUI\checkInput(), ilPasswordInputGUI\checkInput(), ilRadioGroupInputGUI\checkInput(), ilRegExpInputGUI\checkInput(), ilRepositorySelectorInputGUI\checkInput(), ilSelectBuilderInputGUI\checkInput(), ilSelectInputGUI\checkInput(), ilTagInputGUI\checkInput(), ilTextAreaInputGUI\checkInput(), ilTextInputGUI\checkInput(), ilTextWizardInputGUI\checkInput(), ilUserLoginInputGUI\checkInput(), ilMailQuickFilterInputGUI\checkInput(), ilWidthHeightInputGUI\checkInput(), ilCopyrightInputGUI\checkInput(), ilTypicalLearningTimeInputGUI\checkInput(), ilLuceneQueryInputGUI\checkInput(), ilBackgroundImageInputGUI\checkInput(), ilBackgroundPositionInputGUI\checkInput(), ilFontSizeInputGUI\checkInput(), ilNumericStyleValueInputGUI\checkInput(), ilTRBLBorderStyleInputGUI\checkInput(), ilTRBLBorderWidthInputGUI\checkInput(), ilTRBLColorPickerInputGUI\checkInput(), ilTRBLNumericStyleValueInputGUI\checkInput(), ilExplorerSelectInputGUI\checkInput(), ilKprimChoiceWizardInputGUI\checkUploads(), ilKprimChoiceWizardInputGUI\collectValidFiles(), ilFileInputGUI\getDeletionFlag(), ilFlashFileInputGUI\getDeletionFlag(), ilImageFileInputGUI\getDeletionFlag(), getFieldId(), ilDataCollectionTreePickInputGUI\getHtml(), ilCheckboxGroupInputGUI\getItemByPostVar(), getItemByPostVar(), ilRadioGroupInputGUI\getItemByPostVar(), ilSubEnabledFormPropertyGUI\getItemByPostVar(), ilDateTimeInputGUI\getPostValueForComparison(), ilNumberInputGUI\getPostValueForComparison(), ilColorPickerInputGUI\insert(), ilSelectBuilderInputGUI\insert(), ilWidthHeightInputGUI\insert(), ilTRBLColorPickerInputGUI\insert(), ilCategoryWizardInputGUI\insert(), ilMatrixRowWizardInputGUI\insert(), ilRandomTestROInputGUI\insert(), ilAnswerWizardInputGUI\insert(), ilErrorTextWizardInputGUI\insert(), ilEssayKeywordWizardInputGUI\insert(), ilImagemapFileInputGUI\insert(), ilImageWizardInputGUI\insert(), ilKVPWizardInputGUI\insert(), ilMatchingPairWizardInputGUI\insert(), ilMatchingWizardInputGUI\insert(), ilMultipleChoiceWizardInputGUI\insert(), ilSingleChoiceWizardInputGUI\insert(), ilSuggestedSolutionSelectorGUI\insert(), ilAdvSelectInputGUI\insert(), ilCSSRectInputGUI\insert(), ilFileWizardInputGUI\insert(), ilFlashFileInputGUI\insert(), ilHiddenInputGUI\insert(), ilImageFileInputGUI\insert(), ilLocationInputGUI\insert(), ilTextAreaInputGUI\insert(), ilTextWizardInputGUI\insert(), ilUserLoginInputGUI\insert(), ilCopyrightInputGUI\insert(), ilTypicalLearningTimeInputGUI\insert(), ilBackgroundImageInputGUI\insert(), ilBackgroundPositionInputGUI\insert(), ilFontSizeInputGUI\insert(), ilNumericStyleValueInputGUI\insert(), ilTRBLBorderStyleInputGUI\insert(), ilTRBLBorderWidthInputGUI\insert(), ilTRBLNumericStyleValueInputGUI\insert(), ilEMailInputGUI\insert(), ilScheduleInputGUI\render(), ilFileInputGUI\render(), ilSelectInputGUI\render(), ilTagInputGUI\render(), ilRepositorySelectorInputGUI\render(), ilExplorerSelectInputGUI\render(), ilCheckboxGroupInputGUI\render(), ilCheckboxInputGUI\render(), ilGloAdvColSortInputGUI\render(), ilBirthdayInputGUI\render(), ilDateDurationInputGUI\render(), ilDateTimeInputGUI\render(), ilDurationInputGUI\render(), ilLinkInputGUI\render(), ilMultiSelectInputGUI\render(), ilNestedListInputGUI\render(), ilNonEditableValueGUI\render(), ilNumberInputGUI\render(), ilPasswordInputGUI\render(), ilRadioGroupInputGUI\render(), ilNestedOrderingGUI\renderAnswerOutput(), ilAnswerWizardInputGUI\sanitizeSuperGlobalSubmitValue(), ilLogicalAnswerComparisonExpressionInputGUI\sanitizeSuperGlobalSubmitValue(), ilTaxAssignInputGUI\saveInput(), ilScheduleInputGUI\setValueByArray(), ilGloAdvColSortInputGUI\setValueByArray(), ilImagemapFileInputGUI\setValueByArray(), ilSuggestedSolutionSelectorGUI\setValueByArray(), ilCaptchaInputGUI\setValueByArray(), ilAdvSelectInputGUI\setValueByArray(), ilAlphabetInputGUI\setValueByArray(), ilBirthdayInputGUI\setValueByArray(), ilCheckboxGroupInputGUI\setValueByArray(), ilCheckboxInputGUI\setValueByArray(), ilCSSRectInputGUI\setValueByArray(), ilDateDurationInputGUI\setValueByArray(), ilDateTimeInputGUI\setValueByArray(), ilDurationInputGUI\setValueByArray(), ilEMailInputGUI\setValueByArray(), ilFileInputGUI\setValueByArray(), ilFlashFileInputGUI\setValueByArray(), ilHiddenInputGUI\setValueByArray(), ilLinkInputGUI\setValueByArray(), ilLocationInputGUI\setValueByArray(), ilMultiSelectInputGUI\setValueByArray(), ilNonEditableValueGUI\setValueByArray(), ilNumberInputGUI\setValueByArray(), ilPasswordInputGUI\setValueByArray(), ilRadioGroupInputGUI\setValueByArray(), ilRepositorySelectorInputGUI\setValueByArray(), ilSelectBuilderInputGUI\setValueByArray(), ilSelectInputGUI\setValueByArray(), ilTagInputGUI\setValueByArray(), ilTextAreaInputGUI\setValueByArray(), ilTextInputGUI\setValueByArray(), ilUserLoginInputGUI\setValueByArray(), ilManualPlaceholderInputGUI\setValueByArray(), ilWidthHeightInputGUI\setValueByArray(), ilCopyrightInputGUI\setValueByArray(), ilTypicalLearningTimeInputGUI\setValueByArray(), ilBackgroundImageInputGUI\setValueByArray(), ilBackgroundPositionInputGUI\setValueByArray(), ilFontSizeInputGUI\setValueByArray(), ilNumericStyleValueInputGUI\setValueByArray(), ilTRBLBorderStyleInputGUI\setValueByArray(), ilTRBLBorderWidthInputGUI\setValueByArray(), ilTRBLNumericStyleValueInputGUI\setValueByArray(), ilExplorerSelectInputGUI\setValueByArray(), ilDataCollectionTreePickInputGUI\setValueByArray(), and ilRepositorySelectorInputGUI\showRepositorySelection().

+ Here is the caller graph for this function:

◆ getRequired()

ilFormPropertyGUI::getRequired ( )

Get Required.

Returns
boolean Required

Definition at line 181 of file class.ilFormPropertyGUI.php.

182 {
183 return $this->required;
184 }

References $required.

Referenced by ilScheduleInputGUI\checkInput(), ilDclCheckboxInputGUI\checkInput(), ilCategoryWizardInputGUI\checkInput(), ilMatrixRowWizardInputGUI\checkInput(), ilErrorTextWizardInputGUI\checkInput(), ilImagemapFileInputGUI\checkInput(), ilImageWizardInputGUI\checkInput(), ilKVPWizardInputGUI\checkInput(), ilMatchingPairWizardInputGUI\checkInput(), ilMatchingWizardInputGUI\checkInput(), ilMultipleChoiceWizardInputGUI\checkInput(), ilSingleChoiceWizardInputGUI\checkInput(), ilSuggestedSolutionSelectorGUI\checkInput(), ilCaptchaInputGUI\checkInput(), ilAdvSelectInputGUI\checkInput(), ilAlphabetInputGUI\checkInput(), ilBirthdayInputGUI\checkInput(), ilCheckboxGroupInputGUI\checkInput(), ilCSSRectInputGUI\checkInput(), ilCustomInputGUI\checkInput(), ilDateTimeInputGUI\checkInput(), ilEMailInputGUI\checkInput(), ilFeedUrlInputGUI\checkInput(), ilFileInputGUI\checkInput(), ilFileWizardInputGUI\checkInput(), ilFlashFileInputGUI\checkInput(), ilFormulaInputGUI\checkInput(), ilLinkInputGUI\checkInput(), ilLocationInputGUI\checkInput(), ilMultiSelectInputGUI\checkInput(), ilNumberInputGUI\checkInput(), ilPasswordInputGUI\checkInput(), ilRadioGroupInputGUI\checkInput(), ilRegExpInputGUI\checkInput(), ilRepositorySelectorInputGUI\checkInput(), ilSelectBuilderInputGUI\checkInput(), ilSelectInputGUI\checkInput(), ilTagInputGUI\checkInput(), ilTextAreaInputGUI\checkInput(), ilTextInputGUI\checkInput(), ilTextWizardInputGUI\checkInput(), ilUserLoginInputGUI\checkInput(), ilTypicalLearningTimeInputGUI\checkInput(), ilBackgroundImageInputGUI\checkInput(), ilFontSizeInputGUI\checkInput(), ilNumericStyleValueInputGUI\checkInput(), ilExplorerSelectInputGUI\checkInput(), and ilKprimChoiceWizardInputGUI\checkUploads().

+ Here is the caller graph for this function:

◆ getSubForm()

ilFormPropertyGUI::getSubForm ( )

Get sub form html.

Reimplemented in ilSubEnabledFormPropertyGUI.

Definition at line 260 of file class.ilFormPropertyGUI.php.

261 {
262 return "";
263 }

◆ getTitle()

ilFormPropertyGUI::getTitle ( )

Get Title.

Returns
string Title

Reimplemented in ilNonEditableValueGUI.

Definition at line 88 of file class.ilFormPropertyGUI.php.

References $title.

◆ getType()

ilFormPropertyGUI::getType ( )

Get Type.

Returns
string Type

Reimplemented in ilNonEditableValueGUI.

Definition at line 68 of file class.ilFormPropertyGUI.php.

References $type.

◆ hideSubForm()

ilFormPropertyGUI::hideSubForm ( )

Sub form hidden on init?

Reimplemented in ilCheckboxInputGUI, and ilSelectInputGUI.

Definition at line 269 of file class.ilFormPropertyGUI.php.

270 {
271 return false;
272 }

◆ readFromSession()

ilFormPropertyGUI::readFromSession ( )

Read from session.

Definition at line 364 of file class.ilFormPropertyGUI.php.

365 {
366 $parent = $this->getParent();
367 if (!is_object($parent))
368 {
369 die("You must set parent for ".get_class($this)." to use serialize feature.");
370 }
371 $this->unserializeData($_SESSION["form_".$parent->getId()][$this->getFieldId()]);
372 }
unserializeData($a_data)
unserialize data

References $_SESSION, getParent(), and unserializeData().

+ Here is the call graph for this function:

◆ removeProhibitedCharacters()

ilFormPropertyGUI::removeProhibitedCharacters (   $a_text)

Remove prohibited characters see #19159.

Parameters
string$a_text
Returns
string

Definition at line 493 of file class.ilFormPropertyGUI.php.

494 {
495 return str_replace("\x0B", "", $a_text);
496 }

Referenced by ilTextAreaInputGUI\checkInput().

+ Here is the caller graph for this function:

◆ serializeData()

ilFormPropertyGUI::serializeData ( )

serialize data

Reimplemented in ilCheckboxInputGUI, ilCombinationInputGUI, ilDateTimeInputGUI, and ilDurationInputGUI.

Definition at line 312 of file class.ilFormPropertyGUI.php.

313 {
314 return serialize($this->getValue());
315 }

Referenced by writeToSession().

+ Here is the caller graph for this function:

◆ setAlert()

ilFormPropertyGUI::setAlert (   $a_alert)

Set Alert Text.

Parameters
string$a_alertAlert Text

Definition at line 151 of file class.ilFormPropertyGUI.php.

152 {
153 $this->alert = $a_alert;
154 }

Referenced by ilScheduleInputGUI\checkInput(), ilDclCheckboxInputGUI\checkInput(), ilCategoryWizardInputGUI\checkInput(), ilMatrixRowWizardInputGUI\checkInput(), ilAnswerWizardInputGUI\checkInput(), ilErrorTextWizardInputGUI\checkInput(), ilEssayKeywordWizardInputGUI\checkInput(), ilImagemapFileInputGUI\checkInput(), ilImageWizardInputGUI\checkInput(), ilKprimChoiceWizardInputGUI\checkInput(), ilKVPWizardInputGUI\checkInput(), ilMatchingPairWizardInputGUI\checkInput(), ilMatchingWizardInputGUI\checkInput(), ilMultipleChoiceWizardInputGUI\checkInput(), ilSingleChoiceWizardInputGUI\checkInput(), ilSuggestedSolutionSelectorGUI\checkInput(), ilRecurrenceInputGUI\checkInput(), ilCaptchaInputGUI\checkInput(), ilAdvSelectInputGUI\checkInput(), ilAlphabetInputGUI\checkInput(), ilBirthdayInputGUI\checkInput(), ilCheckboxGroupInputGUI\checkInput(), ilCSSRectInputGUI\checkInput(), ilCustomInputGUI\checkInput(), ilDateDurationInputGUI\checkInput(), ilDateTimeInputGUI\checkInput(), ilDragDropFileInputGUI\checkInput(), ilEMailInputGUI\checkInput(), ilFeedUrlInputGUI\checkInput(), ilFileInputGUI\checkInput(), ilFileWizardInputGUI\checkInput(), ilFlashFileInputGUI\checkInput(), ilFormulaInputGUI\checkInput(), ilLinkInputGUI\checkInput(), ilLocationInputGUI\checkInput(), ilMultiSelectInputGUI\checkInput(), ilNumberInputGUI\checkInput(), ilPasswordInputGUI\checkInput(), ilRadioGroupInputGUI\checkInput(), ilRegExpInputGUI\checkInput(), ilRepositorySelectorInputGUI\checkInput(), ilSelectBuilderInputGUI\checkInput(), ilSelectInputGUI\checkInput(), ilTagInputGUI\checkInput(), ilTextAreaInputGUI\checkInput(), ilTextInputGUI\checkInput(), ilTextWizardInputGUI\checkInput(), ilUserLoginInputGUI\checkInput(), ilMailQuickFilterInputGUI\checkInput(), ilTypicalLearningTimeInputGUI\checkInput(), ilLuceneQueryInputGUI\checkInput(), ilBackgroundImageInputGUI\checkInput(), ilBackgroundPositionInputGUI\checkInput(), ilFontSizeInputGUI\checkInput(), ilNumericStyleValueInputGUI\checkInput(), ilTRBLBorderWidthInputGUI\checkInput(), ilTRBLNumericStyleValueInputGUI\checkInput(), ilCharSelectorRadioGroupInputGUI\checkInput(), ilExplorerSelectInputGUI\checkInput(), ilAssQuestionSkillAssignmentsGUI\checkSolutionCompareExpressionInput(), and ilKprimChoiceWizardInputGUI\checkUploads().

+ Here is the caller graph for this function:

◆ setDisabled()

ilFormPropertyGUI::setDisabled (   $a_disabled)

Set Disabled.

Parameters
boolean$a_disabledDisabled

Definition at line 191 of file class.ilFormPropertyGUI.php.

192 {
193 $this->disabled = $a_disabled;
194 }

Referenced by __construct(), and ilADTFormBridge\addBasicFieldProperties().

+ Here is the caller graph for this function:

◆ setHiddenTitle()

ilFormPropertyGUI::setHiddenTitle (   $a_val)

Set hidden title (for screenreaders)

Parameters
stringhidden title

Definition at line 279 of file class.ilFormPropertyGUI.php.

280 {
281 $this->hidden_title = $a_val;
282 }

Referenced by ilFileInputGUI\__construct(), and ilImageFileInputGUI\__construct().

+ Here is the caller graph for this function:

◆ setInfo()

ilFormPropertyGUI::setInfo (   $a_info)

Set Information Text.

Parameters
string$a_infoInformation Text

Reimplemented in ilNonEditableValueGUI.

Definition at line 131 of file class.ilFormPropertyGUI.php.

132 {
133 $this->info = $a_info;
134 }

Referenced by ilADTFormBridge\addBasicFieldProperties(), and ilDateTimeInputGUI\render().

+ Here is the caller graph for this function:

◆ setMulti()

ilFormPropertyGUI::setMulti (   $a_multi,
  $a_sortable = false,
  $a_addremove = true 
)

Set Multi.

Parameters
bool$a_multiMulti

Definition at line 387 of file class.ilFormPropertyGUI.php.

388 {
389 if(!$this instanceof ilMultiValuesItem)
390 {
391 require_once 'Services/Form/exceptions/class.ilFormException.php';
392 throw new ilFormException(sprintf(
393 "%s not supported for form property type %s",
394 __FUNCTION__, get_class($this)
395 ));
396 }
397
398 $this->multi = (bool)$a_multi;
399 $this->multi_sortable = (bool)$a_sortable;
400 $this->multi_addremove = (bool)$a_addremove;
401 }
Class ilFormException.
Interface for multi values support.

Referenced by ilTaxAssignInputGUI\__construct().

+ Here is the caller graph for this function:

◆ setMultiValues()

ilFormPropertyGUI::setMultiValues ( array  $a_values)

Set multi values.

Parameters
array$a_values

Reimplemented in ilTextInputGUI.

Definition at line 418 of file class.ilFormPropertyGUI.php.

419 {
420 $this->multi_values = array_unique($a_values);
421 }

Referenced by ilNonEditableValueGUI\setValue(), ilSelectInputGUI\setValue(), and ilManualPlaceholderInputGUI\setValue().

+ Here is the caller graph for this function:

◆ setParent()

ilFormPropertyGUI::setParent (   $a_val)

Set Parent GUI object.

Parameters
objectparent gui object

Definition at line 241 of file class.ilFormPropertyGUI.php.

242 {
243 $this->parent_gui = $a_val;
244 }

Referenced by setParentForm().

+ Here is the caller graph for this function:

◆ setParentForm()

ilFormPropertyGUI::setParentForm (   $a_parentform)

Set Parent Form.

Parameters
object$a_parentformParent Form

Definition at line 221 of file class.ilFormPropertyGUI.php.

222 {
223 $this->setParent($a_parentform);
224 }
setParent($a_val)
Set Parent GUI object.

References setParent().

+ Here is the call graph for this function:

◆ setPostVar()

ilFormPropertyGUI::setPostVar (   $a_postvar)

Set Post Variable.

Parameters
string$a_postvarPost Variable

Definition at line 98 of file class.ilFormPropertyGUI.php.

99 {
100 $this->postvar = $a_postvar;
101 }

Referenced by __construct().

+ Here is the caller graph for this function:

◆ setRequired()

ilFormPropertyGUI::setRequired (   $a_required)

Set Required.

Parameters
boolean$a_requiredRequired

Definition at line 171 of file class.ilFormPropertyGUI.php.

172 {
173 $this->required = $a_required;
174 }

Referenced by ilRandomTestROInputGUI\__construct(), and ilADTFormBridge\addBasicFieldProperties().

+ Here is the caller graph for this function:

◆ setTitle()

ilFormPropertyGUI::setTitle (   $a_title)

Set Title.

Parameters
string$a_titleTitle

Reimplemented in ilNonEditableValueGUI.

Definition at line 78 of file class.ilFormPropertyGUI.php.

79 {
80 $this->title = $a_title;
81 }

Referenced by __construct().

+ Here is the caller graph for this function:

◆ setType()

ilFormPropertyGUI::setType (   $a_type)
protected

Set Type.

Parameters
string$a_typeType

Reimplemented in ilNonEditableValueGUI.

Definition at line 58 of file class.ilFormPropertyGUI.php.

59 {
60 $this->type = $a_type;
61 }

Referenced by ilHiddenInputGUI\__construct(), ilTaxAssignInputGUI\__construct(), ilTaxSelectInputGUI\__construct(), ilExplorerSelectInputGUI\__construct(), ilGloAdvColSortInputGUI\__construct(), ilSuggestedSolutionSelectorGUI\__construct(), ilAdvSelectInputGUI\__construct(), ilCheckboxGroupInputGUI\__construct(), ilCheckboxInputGUI\__construct(), ilColorPickerInputGUI\__construct(), ilCountrySelectInputGUI\__construct(), ilCustomInputGUI\__construct(), ilDateDurationInputGUI\__construct(), ilDateTimeInputGUI\__construct(), ilDurationInputGUI\__construct(), ilFeedUrlInputGUI\__construct(), ilFileInputGUI\__construct(), ilFlashFileInputGUI\__construct(), ilImageFileInputGUI\__construct(), ilLinkInputGUI\__construct(), ilLocationInputGUI\__construct(), ilMultiSelectInputGUI\__construct(), ilNestedListInputGUI\__construct(), ilRadioGroupInputGUI\__construct(), ilRegExpInputGUI\__construct(), ilRepositorySelectorInputGUI\__construct(), ilSelectInputGUI\__construct(), ilTagInputGUI\__construct(), ilTextAreaInputGUI\__construct(), ilTextInputGUI\__construct(), ilWidthHeightInputGUI\__construct(), ilCopyrightInputGUI\__construct(), ilTypicalLearningTimeInputGUI\__construct(), ilBackgroundImageInputGUI\__construct(), ilBackgroundPositionInputGUI\__construct(), ilFontSizeInputGUI\__construct(), ilNumericStyleValueInputGUI\__construct(), ilTRBLBorderStyleInputGUI\__construct(), ilTRBLBorderWidthInputGUI\__construct(), ilTRBLColorPickerInputGUI\__construct(), ilTRBLNumericStyleValueInputGUI\__construct(), and ilCaptchaInputGUI\__construct().

+ Here is the caller graph for this function:

◆ stripSlashesAddSpaceFallback()

ilFormPropertyGUI::stripSlashesAddSpaceFallback (   $a_str)

Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727.

Parameters
string$a_strstring
Returns
string

Definition at line 504 of file class.ilFormPropertyGUI.php.

505 {
506 $str = ilUtil::stripSlashes($a_str);
507 if ($str != $a_str)
508 {
509 $str = ilUtil::stripSlashes(str_replace("<", "< ", $a_str));
510 }
511 return $str;
512 }
static stripSlashes($a_str, $a_strip_html=true, $a_allow="")
strip slashes if magic qoutes is enabled

References ilUtil\stripSlashes().

Referenced by ilTextAreaInputGUI\checkInput(), and ilTextInputGUI\checkInput().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ unserializeData()

ilFormPropertyGUI::unserializeData (   $a_data)

unserialize data

Reimplemented in ilCheckboxInputGUI, ilCombinationInputGUI, ilDateTimeInputGUI, and ilDurationInputGUI.

Definition at line 320 of file class.ilFormPropertyGUI.php.

321 {
322 $data = unserialize($a_data);
323
324 if ($data)
325 {
326 $this->setValue($data);
327 }
328 else
329 {
330 $this->setValue(false);
331 }
332 }
$data

References $data.

Referenced by readFromSession().

+ Here is the caller graph for this function:

◆ writeToSession()

ilFormPropertyGUI::writeToSession ( )

Write to session.

Definition at line 337 of file class.ilFormPropertyGUI.php.

338 {
339 $parent = $this->getParent();
340 if (!is_object($parent))
341 {
342 die("You must set parent for ".get_class($this)." to use serialize feature.");
343 }
344 $_SESSION["form_".$parent->getId()][$this->getFieldId()] =
345 $this->serializeData();
346 }

References $_SESSION, getFieldId(), getParent(), and serializeData().

Referenced by ilRepositorySelectorInputGUI\reset(), ilRepositorySelectorInputGUI\selectRepositoryItem(), and ilTable2GUI\SetFilterValue().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $alert

ilFormPropertyGUI::$alert
protected

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

Referenced by getAlert().

◆ $hidden_title

ilFormPropertyGUI::$hidden_title = ""
protected

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

Referenced by getHiddenTitle().

◆ $info

ilFormPropertyGUI::$info
protected

Definition at line 16 of file class.ilFormPropertyGUI.php.

Referenced by getInfo().

◆ $multi

ilFormPropertyGUI::$multi = false
protected

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

Referenced by getMulti().

◆ $multi_addremove

ilFormPropertyGUI::$multi_addremove = true
protected

Definition at line 24 of file class.ilFormPropertyGUI.php.

◆ $multi_sortable

ilFormPropertyGUI::$multi_sortable = false
protected

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

◆ $multi_values

ilFormPropertyGUI::$multi_values
protected

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

Referenced by getMultiValues().

◆ $parentform

ilFormPropertyGUI::$parentform
protected

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

◆ $parentgui

ilFormPropertyGUI::$parentgui
protected

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

◆ $postvar

ilFormPropertyGUI::$postvar
protected

◆ $required

ilFormPropertyGUI::$required = false
protected

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

Referenced by getRequired().

◆ $title

◆ $type


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