This class represents a key value pair wizard property in a property form. More...

Inheritance diagram for ilKVPWizardInputGUI:

Collaboration diagram for ilKVPWizardInputGUI:

Public Member Functions
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

	setValue ($a_value)
	Set Value. More...

	setKeySize ($a_size)
	Set key size. More...

	getKeySize ()
	Get key size. More...

	setValueSize ($a_size)
	Set value size. More...

	getValueSize ()
	Get value size. More...

	setKeyMaxlength ($a_maxlength)
	Set key maxlength. More...

	getKeyMaxlength ()
	Get key maxlength. More...

	setValueMaxlength ($a_maxlength)
	Set value maxlength. More...

	getValueMaxlength ()
	Get value maxlength. More...

	setValueName ($a_name)
	Set value name. More...

	getValueName ()
	Get value name. More...

	setKeyName ($a_name)
	Set key name. More...

	getKeyName ()
	Get key name. More...

	setValues ($a_values)
	Set Values. More...

	getValues ()
	Get Values. More...

	setAllowMove ($a_allow_move)
	Set allow move. More...

	getAllowMove ()
	Get allow move. More...

	checkInput ()
	Check input, strip slashes etc. More...

	insert (&$a_tpl)
	Insert property html. More...

Public Member Functions inherited from ilTextInputGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

	setValue ($a_value)
	Set Value. More...

	getValue ()
	Get Value. More...

	setValidationFailureMessage ($a_msg)
	Set message string for validation failure. More...

	getValidationFailureMessage ()

	setValidationRegexp ($a_value)
	Set validation regexp. More...

	getValidationRegexp ()
	Get validation regexp. More...

	setMaxLength ($a_maxlength)
	Set Max Length. More...

	getMaxLength ()
	Get Max Length. More...

	setSize ($a_size)
	Set Size. More...

	setInlineStyle ($a_style)
	Set inline style. More...

	getInlineStyle ()
	Get inline style. More...

	setCssClass ($a_class)

	getCssClass ()

	setValueByArray ($a_values)
	Set value by array. More...

	getSize ()
	Get Size. More...

	setSuffix ($a_value)
	Set suffix. More...

	getSuffix ()
	Get suffix. More...

	setInputType ($a_type)
	set input type More...

	getInputType ()
	get input type More...

	setSubmitFormOnEnter ($a_val)
	Set submit form on enter. More...

	getSubmitFormOnEnter ()
	Get submit form on enter. More...

	checkInput ()
	Check input, strip slashes etc. More...

	getDataSource ()
	get datasource link for js autocomplete More...

	setDataSource ($href, $a_delimiter=null)
	set datasource link for js autocomplete More...

	setDataSourceSubmitOnSelection ($a_stat)

	getDataSourceSubmitOnSelection ()

	setDataSourceSubmitUrl ($a_url)

	getDataSourceSubmitUrl ()

	setMultiValues (array $a_values)

	insert (&$a_tpl)
	Insert property html. More...

	getTableFilterHTML ()
	Get HTML for table filter. More...

	getToolbarHTML ()
	Get HTML for toolbar. More...

	setDisableHtmlAutoComplete ($autocomplete)

	isHtmlAutoCompleteDisabled ()

Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem ($a_item)
	Add Subitem. More...

	getSubItems ()
	Get Subitems. More...

	getSubInputItemsRecursive ()
	returns a flat array of possibly existing subitems recursively More...

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()
	Get sub form html. More...

	getItemByPostVar ($a_post_var)
	Get item by post var. More...

Public Member Functions inherited from ilFormPropertyGUI
	__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 Attributes
	$values = array()

	$allowMove = false

	$key_size = 20

	$value_size = 20

	$key_maxlength = 255

	$value_maxlength = 255

	$key_name = ""

	$value_name = ""

Protected Attributes inherited from ilTextInputGUI
	$value

	$maxlength = 200

	$size = 40

	$validationRegexp

	$validationFailureMessage = ''

	$suffix

	$style_css

	$css_class

	$ajax_datasource

	$ajax_datasource_delimiter

	$ajax_datasource_commit = FALSE

	$ajax_datasource_commit_url

	$submit_form_on_enter = false

	$autocomplete_disabled = false

Protected Attributes inherited from ilSubEnabledFormPropertyGUI
	$sub_items = array()

Protected Attributes inherited from ilFormPropertyGUI
	$type

	$title

	$postvar

	$info

	$alert

	$required = false

	$parentgui

	$parentform

	$hidden_title = ""

	$multi = false

	$multi_sortable = false

	$multi_addremove = true

	$multi_values

Additional Inherited Members
Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type. More...

	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...

Detailed Description

This class represents a key value pair wizard property in a property form.

Author: Helmut Schottmüller ilias.nosp@m.@aur.nosp@m.ealis.nosp@m..de

Version: $Id$

Definition at line 13 of file class.ilKVPWizardInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilKVPWizardInputGUI::__construct	(	$a_title = `""`,
		$a_postvar = `""`
	)

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

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

         {
                 parent::__construct($a_title, $a_postvar);
         }

Member Function Documentation

◆ checkInput()

ilKVPWizardInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

Definition at line 220 of file class.ilKVPWizardInputGUI.php.

References $_POST, $lng, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), and ilUtil\stripSlashesRecursive().

         {
                 global $lng;
                 
                 if (is_array($_POST[$this->getPostVar()])) $_POST[$this->getPostVar()] = ilUtil::stripSlashesRecursive($_POST[$this->getPostVar()]);
                 $foundvalues = $_POST[$this->getPostVar()];
                 if (is_array($foundvalues))
                 {
                         // check answers
                         if (is_array($foundvalues['key']) && is_array($foundvalues['value']))
                         {
                                 foreach ($foundvalues['key'] as $val)
                                 {
                                         if ($this->getRequired() && (strlen($val)) == 0) 
                                         {
                                                 $this->setAlert($lng->txt("msg_input_is_required"));
                                                 return FALSE;
                                         }
                                 }
                                 foreach ($foundvalues['value'] as $val)
                                 {
                                         if ($this->getRequired() && (strlen($val)) == 0) 
                                         {
                                                 $this->setAlert($lng->txt("msg_input_is_required"));
                                                 return FALSE;
                                         }
                                 }
                         }
                         else
                         {
                                 if ($this->getRequired())
                                 {
                                         $this->setAlert($lng->txt("msg_input_is_required"));
                                         return FALSE;
                                 }
                         }
                 }
                 else
                 {
                         if ($this->getRequired())
                         {
                                 $this->setAlert($lng->txt("msg_input_is_required"));
                                 return FALSE;
                         }
                 }
                 return $this->checkSubItemsInput();
         }

Here is the call graph for this function:

◆ getAllowMove()

ilKVPWizardInputGUI::getAllowMove ( )

Get allow move.

Returns: boolean Allow move

Definition at line 210 of file class.ilKVPWizardInputGUI.php.

References $allowMove.

Referenced by insert().

         {
                 return $this->allowMove;
         }

Here is the caller graph for this function:

◆ getKeyMaxlength()

ilKVPWizardInputGUI::getKeyMaxlength ( )

Get key maxlength.

Returns: integer Key maxlength

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

References $key_maxlength.

Referenced by insert().

         {
                 return $this->key_maxlength;
         }

Here is the caller graph for this function:

◆ getKeyName()

ilKVPWizardInputGUI::getKeyName ( )

Get key name.

Returns: string value name

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

References $key_name.

Referenced by insert().

         {
                 return $this->key_name;
         }

Here is the caller graph for this function:

◆ getKeySize()

ilKVPWizardInputGUI::getKeySize ( )

Get key size.

Returns: integer Key size

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

References $key_size.

Referenced by insert().

         {
                 return $this->key_size;
         }

Here is the caller graph for this function:

◆ getValueMaxlength()

ilKVPWizardInputGUI::getValueMaxlength ( )

Get value maxlength.

Returns: integer value maxlength

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

References $value_maxlength.

Referenced by insert().

         {
                 return $this->value_maxlength;
         }

Here is the caller graph for this function:

◆ getValueName()

ilKVPWizardInputGUI::getValueName ( )

Get value name.

Returns: string value name

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

References $value_name.

Referenced by insert().

         {
                 return $this->value_name;
         }

Here is the caller graph for this function:

◆ getValues()

ilKVPWizardInputGUI::getValues ( )

Get Values.

Returns: array Values

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

References $values.

         {
                 return $this->values;
         }

◆ getValueSize()

ilKVPWizardInputGUI::getValueSize ( )

Get value size.

Returns: integer value size

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

References $value_size.

Referenced by insert().

         {
                 return $this->value_size;
         }

Here is the caller graph for this function:

◆ insert()

ilKVPWizardInputGUI::insert ( & $a_tpl )

Insert property html.

Returns: int Size

Definition at line 273 of file class.ilKVPWizardInputGUI.php.

References $lng, $tpl, ilTextInputGUI\$value, ilGlyphGUI\ADD, ilGlyphGUI\DOWN, ilGlyphGUI\get(), getAllowMove(), ilFormPropertyGUI\getFieldId(), getKeyMaxlength(), getKeyName(), getKeySize(), ilFormPropertyGUI\getPostVar(), getValueMaxlength(), getValueName(), getValueSize(), ilUtil\prepareFormOutput(), ilGlyphGUI\REMOVE, and ilGlyphGUI\UP.

         {
                 global $lng;
                 
                 $tpl = new ilTemplate("tpl.prop_kvpwizardinput.html", true, true, "Modules/TestQuestionPool");
                 $i = 0;
                 foreach ($this->values as $value)
                 {
                         if (is_array($value))
                         {
                                 $tpl->setCurrentBlock("prop_key_propval");
                                 $tpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput($value[0]));
                                 $tpl->parseCurrentBlock();
                                 $tpl->setCurrentBlock("prop_value_propval");
                                 $tpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput($value[1]));
                                 $tpl->parseCurrentBlock();
                         }
                         if ($this->getAllowMove())
                         {
                                 $tpl->setCurrentBlock("move");
                                 $tpl->setVariable("CMD_UP", "cmd[up" . $this->getFieldId() . "][$i]");
                                 $tpl->setVariable("CMD_DOWN", "cmd[down" . $this->getFieldId() . "][$i]");
                                 $tpl->setVariable("ID", $this->getPostVar() . "[$i]");
                                 $tpl->setVariable("UP_BUTTON", ilGlyphGUI::get(ilGlyphGUI::UP));
                                 $tpl->setVariable("DOWN_BUTTON", ilGlyphGUI::get(ilGlyphGUI::DOWN));
                                 $tpl->parseCurrentBlock();
                         }
 
                         $tpl->setCurrentBlock("row");
                         $class = ($i % 2 == 0) ? "even" : "odd";
                         if ($i == 0) $class .= " first";
                         if ($i == count($this->values)-1) $class .= " last";
                         $tpl->setVariable("ROW_CLASS", $class);
                         $tpl->setVariable("ROW_NUMBER", $i);
                         
                         $tpl->setVariable("KEY_SIZE", $this->getKeySize());
                         $tpl->setVariable("KEY_ID", $this->getPostVar() . "[key][$i]");
                         $tpl->setVariable("KEY_MAXLENGTH", $this->getKeyMaxlength());
 
                         $tpl->setVariable("VALUE_SIZE", $this->getValueSize());
                         $tpl->setVariable("VALUE_ID", $this->getPostVar() . "[value][$i]");
                         $tpl->setVariable("VALUE_MAXLENGTH", $this->getValueMaxlength());
 
                         $tpl->setVariable("ID", $this->getPostVar() . "[$i]");
                         $tpl->setVariable("CMD_ADD", "cmd[add" . $this->getFieldId() . "][$i]");
                         $tpl->setVariable("CMD_REMOVE", "cmd[remove" . $this->getFieldId() . "][$i]");
                         $tpl->setVariable("ADD_BUTTON", ilGlyphGUI::get(ilGlyphGUI::ADD));
                         $tpl->setVariable("REMOVE_BUTTON", ilGlyphGUI::get(ilGlyphGUI::REMOVE));
 
                         $tpl->setVariable("POST_VAR", $this->getPostVar());
 
                         $tpl->parseCurrentBlock();
 
                         $i++;
                 }
                 $tpl->setVariable("ELEMENT_ID", $this->getPostVar());
                 $tpl->setVariable("KEY_TEXT", $this->getKeyName());
                 $tpl->setVariable("VALUE_TEXT", $this->getValueName());
 
                 $a_tpl->setCurrentBlock("prop_generic");
                 $a_tpl->setVariable("PROP_GENERIC", $tpl->get());
                 $a_tpl->parseCurrentBlock();
                 
                 global $tpl;
                 $tpl->addJavascript("./Services/Form/js/ServiceFormWizardInput.js");
                 $tpl->addJavascript("./Modules/TestQuestionPool/templates/default/kvpwizard.js");
         }

Here is the call graph for this function:

◆ setAllowMove()

ilKVPWizardInputGUI::setAllowMove ( $a_allow_move )

Set allow move.

Parameters

boolean $a_allow_move Allow move

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

         {
                 $this->allowMove = $a_allow_move;
         }

◆ setKeyMaxlength()

ilKVPWizardInputGUI::setKeyMaxlength ( $a_maxlength )

Set key maxlength.

Parameters

integer $a_size Key maxlength

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

         {
                 $this->key_maxlength = $a_maxlength;
         }

◆ setKeyName()

ilKVPWizardInputGUI::setKeyName ( $a_name )

Set key name.

Parameters

string $a_name value name

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

         {
                 $this->key_name = $a_name;
         }

◆ setKeySize()

ilKVPWizardInputGUI::setKeySize ( $a_size )

Set key size.

Parameters

integer $a_size Key size

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

         {
                 $this->key_size = $a_size;
         }

◆ setValue()

ilKVPWizardInputGUI::setValue ( $a_value )

Set Value.

Parameters

string $a_value Value

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

         {
                 $this->values = array();
                 if (is_array($a_value))
                 {
                         if (is_array($a_value['key']))
                         {
                                 foreach ($a_value['key'] as $idx => $key)
                                 {
                                         array_push($this->values, array($key, $a_value['value'][$idx]));
                                 }
                         }
                 }
         }

◆ setValueMaxlength()

ilKVPWizardInputGUI::setValueMaxlength ( $a_maxlength )

Set value maxlength.

Parameters

integer $a_size value maxlength

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

         {
                 $this->value_maxlength = $a_maxlength;
         }

◆ setValueName()

ilKVPWizardInputGUI::setValueName ( $a_name )

Set value name.

Parameters

string $a_name value name

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

         {
                 $this->value_name = $a_name;
         }

◆ setValues()

ilKVPWizardInputGUI::setValues ( $a_values )

Set Values.

Parameters

array $a_value Value

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

         {
                 $this->values = $a_values;
         }

◆ setValueSize()

ilKVPWizardInputGUI::setValueSize ( $a_size )

Set value size.

Parameters

integer $a_size value size

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

         {
                 $this->value_size = $a_size;
         }

Field Documentation

◆ $allowMove

ilKVPWizardInputGUI::$allowMove = false

protected

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

Referenced by getAllowMove().

◆ $key_maxlength

ilKVPWizardInputGUI::$key_maxlength = 255

protected

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

Referenced by getKeyMaxlength().

◆ $key_name

ilKVPWizardInputGUI::$key_name = ""

protected

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

Referenced by getKeyName().

◆ $key_size

ilKVPWizardInputGUI::$key_size = 20

protected

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

Referenced by getKeySize().

◆ $value_maxlength

ilKVPWizardInputGUI::$value_maxlength = 255

protected

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

Referenced by getValueMaxlength().

◆ $value_name

ilKVPWizardInputGUI::$value_name = ""

protected

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

Referenced by getValueName().

◆ $value_size

ilKVPWizardInputGUI::$value_size = 20

protected

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

Referenced by getValueSize().

◆ $values

ilKVPWizardInputGUI::$values = array()

protected

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

Referenced by getValues().

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

Modules/TestQuestionPool/classes/class.ilKVPWizardInputGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getAllowMove()

◆ getKeyMaxlength()

◆ getKeyName()

◆ getKeySize()

◆ getValueMaxlength()

◆ getValueName()

◆ getValues()

◆ getValueSize()

◆ insert()

◆ setAllowMove()

◆ setKeyMaxlength()

◆ setKeyName()

◆ setKeySize()

◆ setValue()

◆ setValueMaxlength()

◆ setValueName()

◆ setValues()

◆ setValueSize()

Field Documentation

◆ $allowMove

◆ $key_maxlength

◆ $key_name

◆ $key_size

◆ $value_maxlength

◆ $value_name

◆ $value_size

◆ $values