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...

	stripSlashesAddSpaceFallback ($a_str)
	Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...

Static Public Member Functions
static	removeProhibitedCharacters ($a_text)
	Remove prohibited characters see #19159. 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_title	Title
string	$a_postvar	Post Variable

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

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

         {
                 $this->setTitle($a_title);
                 $this->setPostVar($a_postvar);
                 $this->setDisabled(false);
         }

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

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

Referenced by ilChatroomAuthInputGUI\setValueByArray().

         {
                 return false;           // please overwrite
         }

Here is the caller graph for this function:

◆ clearFromSession()

ilFormPropertyGUI::clearFromSession ( )

Clear session value.

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

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

         {
                 $parent = $this->getParent();
                 if (!is_object($parent))
                 {
                         die("You must set parent for ".get_class($this)." to use serialize feature.");
                 }
                 $_SESSION["form_".$parent->getId()][$this->getFieldId()] = false;
         }

Here is the call graph for this function:

◆ executeCommand()

ilFormPropertyGUI::executeCommand ( )

Execute command.

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

References $cmd, and $ilCtrl.

         {
                 global $ilCtrl;
                 
                 $next_class = $ilCtrl->getNextClass($this);
                 $cmd = $ilCtrl->getCmd();
                 
                 return $this->$cmd();
         }

◆ getAlert()

ilFormPropertyGUI::getAlert ( )

Get Alert Text.

Returns: string Alert Text

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

References $alert.

         {
                 return $this->alert;
         }

◆ getContentOutsideFormTag()

ilFormPropertyGUI::getContentOutsideFormTag ( )

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

panels/layers

Returns: string

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

         {
                 
         }

◆ getDisabled()

ilFormPropertyGUI::getDisabled ( )

Get Disabled.

Returns: boolean Disabled

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

         {
                 return $this->disabled;
         }

Here is the caller graph for this function:

◆ getFieldId()

ilFormPropertyGUI::getFieldId ( )

Get Post Variable.

Returns: string Post Variable

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

References getPostVar().

         {
                 $id = str_replace("[", "__", $this->getPostVar());
                 $id = str_replace("]", "__", $id);
                 
                 return $id;
         }

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.

References ilUtil\prepareFormOutput().

Referenced by ilMailQuickFilterInputGUI\checkInput(), ilCopyrightInputGUI\insert(), ilEMailInputGUI\insert(), ilTextAreaInputGUI\insert(), ilRadioGroupInputGUI\render(), ilSelectInputGUI\render(), and ilTextInputGUI\setMultiValues().

         {
                 return '<input type="hidden" name="'.$a_post_var.'" value="'.ilUtil::prepareFormOutput($a_value).'" />';
         }

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.

         {
                 return $this->hidden_title;
         }

◆ getInfo()

ilFormPropertyGUI::getInfo ( )

Get Information Text.

Returns: string Information Text

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

References $info.

Referenced by ilDclBaseFieldRepresentation\setupInputField().

         {
                 return $this->info;
         }

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

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

References getPostVar().

         {
                 if ($this->getPostVar() == $a_post_var)
                 {
                         return $this;
                 }
                 
                 return false;
         }

Here is the call graph for this function:

◆ getMulti()

ilFormPropertyGUI::getMulti ( )

Get Multi.

Returns: bool Multi

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

References $multi.

Referenced by ilMailQuickFilterInputGUI\checkInput(), ilSelectInputGUI\checkInput(), ilTextInputGUI\checkInput(), ilNonEditableValueGUI\render(), ilSelectInputGUI\render(), ilTaxAssignInputGUI\saveInput(), ilTaxAssignInputGUI\setCurrentValues(), ilTextInputGUI\setMultiValues(), ilTextInputGUI\setValue(), ilSelectInputGUI\setValue(), ilManualPlaceholderInputGUI\setValue(), and ilNonEditableValueGUI\setValue().

         {
                 return $this->multi;
         }

Here is the caller graph for this function:

◆ 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.

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

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

         {
                 global $lng;
                 
                 $id = $this->getFieldId();
                 
                 $tpl = new ilTemplate("tpl.multi_icons.html", true, true, "Services/Form");
                 
                 $html = "";
                 if ($this->multi_addremove)
                 {
                         $tpl->setCurrentBlock("addremove");
                         $tpl->setVariable("ID", $id);
                         $tpl->setVariable("TXT_ADD", $lng->txt("add"));
                         $tpl->setVariable("TXT_REMOVE", $lng->txt("remove"));
                         include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
                         $tpl->setVariable("SRC_ADD", ilGlyphGUI::get(ilGlyphGUI::ADD));
                         $tpl->setVariable("SRC_REMOVE", ilGlyphGUI::get(ilGlyphGUI::REMOVE));
                         $tpl->parseCurrentBlock();
                 }
                 
                 if ($this->multi_sortable)
                 {
                         
                         $tpl->setCurrentBlock("sortable");
                         $tpl->setVariable("ID", $id);                   
                         $tpl->setVariable("TXT_DOWN", $lng->txt("down"));               
                         $tpl->setVariable("TXT_UP", $lng->txt("up"));                   
                         include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
                         $tpl->setVariable("SRC_UP", ilGlyphGUI::get(ilGlyphGUI::UP));
                         $tpl->setVariable("SRC_DOWN", ilGlyphGUI::get(ilGlyphGUI::DOWN));                       
                         $tpl->parseCurrentBlock();
                 }
                 
                 return $tpl->get();
         }

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 ilMailQuickFilterInputGUI\checkInput(), ilSelectInputGUI\render(), and ilTextInputGUI\setMultiValues().

         {
                 return $this->multi_values;
         }

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.

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

         {
                 return $this->parent_gui;
         }

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.

References getParent().

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

         {
                 return $this->getParent();
         }

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.

References $postvar.

         {
                 return $this->postvar;
         }

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.

References $required.

         {
                 return $this->required;
         }

Here is the caller graph for this function:

◆ getSubForm()

ilFormPropertyGUI::getSubForm ( )

Get sub form html.

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

         {
                 return "";
         }

◆ getTitle()

ilFormPropertyGUI::getTitle ( )

Get Title.

Returns: string Title

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

References $title.

         {
                 return $this->title;
         }

◆ getType()

ilFormPropertyGUI::getType ( )

Get Type.

Returns: string Type

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

References $type.

         {
                 return $this->type;
         }

◆ hideSubForm()

ilFormPropertyGUI::hideSubForm ( )

Sub form hidden on init?

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

         {
                 return false;
         }

◆ readFromSession()

ilFormPropertyGUI::readFromSession ( )

Read from session.

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

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

Referenced by arIndexTableGUI\addFilterField().

         {
                 $parent = $this->getParent();
                 if (!is_object($parent))
                 {
                         die("You must set parent for ".get_class($this)." to use serialize feature.");
                 }
                 $this->unserializeData($_SESSION["form_".$parent->getId()][$this->getFieldId()]);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeProhibitedCharacters()

static ilFormPropertyGUI::removeProhibitedCharacters ( $a_text )

static

Remove prohibited characters see #19159.

Parameters

string $a_text

Returns: string

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

Referenced by ilLMObject\saveTitles().

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

Here is the caller graph for this function:

◆ serializeData()

ilFormPropertyGUI::serializeData ( )

serialize data

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

Referenced by writeToSession().

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

Here is the caller graph for this function:

◆ setAlert()

ilFormPropertyGUI::setAlert ( $a_alert )

Set Alert Text.

Parameters

string $a_alert Alert Text

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

         {
                 $this->alert = $a_alert;
         }

Here is the caller graph for this function:

◆ setDisabled()

ilFormPropertyGUI::setDisabled ( $a_disabled )

Set Disabled.

Parameters

boolean $a_disabled Disabled

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

Referenced by __construct(), ilADTFormBridge\addBasicFieldProperties(), ilObjTestSettingsGeneralGUI\addGeneralProperties(), ilObjTestSettingsGeneralGUI\addQuestionBehaviourProperties(), ilUserProfile\addStandardFieldsToForm(), ilECSMappingSettingsGUI\dInitFormTreeSettings(), ilSetupGUI\displayDatabase(), ilMarkSchemaGUI\getEctsForm(), ilCustomUserFieldsGUI\initForm(), ilCalendarCategoryGUI\initFormCategory(), ilAuthShibbolethSettingsGUI\initFormRoleAssignment(), ilLDAPSettingsGUI\initFormRoleAssignments(), ilObjRoleGUI\initFormRoleProperties(), ilCloudPluginSettingsGUI\initSettingsForm(), and ilSettingsTemplateGUI\initSettingsTemplateForm().

         {
                 $this->disabled = $a_disabled;
         }

Here is the caller graph for this function:

◆ setHiddenTitle()

ilFormPropertyGUI::setHiddenTitle ( $a_val )

Set hidden title (for screenreaders)

Parameters

string hidden title

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

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

         {
                 $this->hidden_title = $a_val;
         }

Here is the caller graph for this function:

◆ setInfo()

ilFormPropertyGUI::setInfo ( $a_info )

Set Information Text.

Parameters

string $a_info Information Text

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

         {
                 $this->info = $a_info;
         }

Here is the caller graph for this function:

◆ setMulti()

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

Set Multi.

Parameters

bool $a_multi Multi

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

Referenced by ilTaxAssignInputGUI\__construct(), ilUserProfile\addStandardFieldsToForm(), ilObjUserGUI\getValues(), ilRegistrationSettingsGUI\initAddCodesForm(), ilAttendanceList\initForm(), and ilECSMappingSettingsGUI\initFormCSettings().

         {
                 if(!$this instanceof ilMultiValuesItem)
                 {
                         require_once 'Services/Form/exceptions/class.ilFormException.php';
                         throw new ilFormException(sprintf(
                                 "%s not supported for form property type %s",
                                 __FUNCTION__, get_class($this)
                         ));
                 }
                 
                 $this->multi = (bool)$a_multi;
                 $this->multi_sortable = (bool)$a_sortable;
                 $this->multi_addremove = (bool)$a_addremove;
         }

Here is the caller graph for this function:

◆ setMultiValues()

ilFormPropertyGUI::setMultiValues ( array $a_values )

Set multi values.

Parameters

array $a_values

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

Referenced by ilObjBlogGUI\initEditCustomForm(), ilSelectInputGUI\setValue(), ilManualPlaceholderInputGUI\setValue(), ilNonEditableValueGUI\setValue(), and ilPersonalProfileGUI\showPublicProfileFields().

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

Here is the caller graph for this function:

◆ setParent()

ilFormPropertyGUI::setParent ( $a_val )

Set Parent GUI object.

Parameters

object parent gui object

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

Referenced by ilLanguageExtTableGUI\initFilter(), ilPCSectionGUI\initForm(), and setParentForm().

         {
                 $this->parent_gui = $a_val;
         }

Here is the caller graph for this function:

◆ setParentForm()

ilFormPropertyGUI::setParentForm ( $a_parentform )

Set Parent Form.

Parameters

object $a_parentform Parent Form

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

References setParent().

         {
                 $this->setParent($a_parentform);
         }

Here is the call graph for this function:

◆ setPostVar()

ilFormPropertyGUI::setPostVar ( $a_postvar )

Set Post Variable.

Parameters

string $a_postvar Post Variable

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

Referenced by __construct(), ilIdentifiedMultiValuesInputGUI\getFieldIdFromPostVar(), ilObjMediaCastGUI\initAddCastItemForm(), ilLDAPSettingsGUI\initRoleMappingForm(), and ilLDAPSettingsGUI\roleMapping().

         {
                 $this->postvar = $a_postvar;
         }

Here is the caller graph for this function:

◆ setRequired()

ilFormPropertyGUI::setRequired ( $a_required )

Set Required.

Parameters

boolean $a_required Required

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

         {
                 $this->required = $a_required;
         }

Here is the caller graph for this function:

◆ setTitle()

ilFormPropertyGUI::setTitle ( $a_title )

Set Title.

Parameters

string $a_title Title

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

Referenced by __construct(), ilObjSCORM2004LearningModuleGUI\initGlossaryCreationForm(), assOrderingQuestion\initOrderingElementFormFieldLabels(), ilPersonalProfileGUI\initPersonalDataImportForm(), ilObjContentObjectGUI\initPropertiesForm(), assQuestionGUI\populateTaxonomyFormSection(), and ilDclBaseFieldRepresentation\setupFilterInputField().

         {
                 $this->title = $a_title;
         }

Here is the caller graph for this function:

◆ setType()

ilFormPropertyGUI::setType ( $a_type )

protected

Set Type.

Parameters

string $a_type Type

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

References $a_type.

         {
                 $this->type = $a_type;
         }

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_str string

Returns: string

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

References ilUtil\stripSlashes().

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

         {
                 $str = ilUtil::stripSlashes($a_str);
                 if ($str != $a_str)
                 {
                         $str = ilUtil::stripSlashes(str_replace("<", "< ", $a_str));
                 }
                 return $str;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unserializeData()

ilFormPropertyGUI::unserializeData ( $a_data )

unserialize data

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

References $data.

Referenced by readFromSession().

         {
                 $data = unserialize($a_data);
 
                 if ($data)
                 {
                         $this->setValue($data);
                 }
                 else
                 {
                         $this->setValue(false);
                 }
         }

Here is the caller graph for this function:

◆ writeToSession()

ilFormPropertyGUI::writeToSession ( )

Write to session.

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

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

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

         {
                 $parent = $this->getParent();
                 if (!is_object($parent))
                 {
                         die("You must set parent for ".get_class($this)." to use serialize feature.");
                 }
                 $_SESSION["form_".$parent->getId()][$this->getFieldId()] =
                         $this->serializeData();
         }