This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilKVPWizardInputGUI:

Collaboration diagram for ilKVPWizardInputGUI:

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

	setValue ($a_value)

	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 (ilTemplate $a_tpl)
	Insert property html. More...

Public Member Functions inherited from ilTextInputGUI
	__construct (string $a_title="", string $a_postvar="")

	setValue ($a_value)

	getValue ()

	setValidationFailureMessage (string $a_msg)

	getValidationFailureMessage ()

	setValidationRegexp (string $a_value)

	getValidationRegexp ()

	setMaxLength (?int $a_maxlength)

	getMaxLength ()

	setSize (int $a_size)

	setInlineStyle (string $a_style)

	getInlineStyle ()

	setCssClass (string $a_class)

	getCssClass ()

	setValueByArray (array $a_values)

	getSize ()

	setSuffix (string $a_value)

	getSuffix ()

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

	getInputType ()

	setSubmitFormOnEnter (bool $a_val)

	getSubmitFormOnEnter ()

	checkInput ()

	getInput ()

	getDataSource ()

	setDataSource (string $href, string $a_delimiter=null)

	setDataSourceSubmitOnSelection (bool $a_stat)

	getDataSourceSubmitOnSelection ()

	setDataSourceSubmitUrl (string $a_url)

	getDataSourceSubmitUrl ()

	setMultiValues (array $a_values)

	render (string $a_mode="")

	insert (ilTemplate $a_tpl)

	getTableFilterHTML ()
	Get input item HTML to be inserted into table filters. More...

	getToolbarHTML ()
	Get input item HTML to be inserted into ilToolbarGUI. More...

	setDisableHtmlAutoComplete (bool $autocomplete)

	isHtmlAutoCompleteDisabled ()

	getPostValueForComparison ()

Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem (ilFormPropertyGUI $a_item)

	getSubItems ()

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

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()

	getItemByPostVar (string $a_post_var)

Public Member Functions inherited from ilFormPropertyGUI
	__construct (string $a_title="", string $a_postvar="")

	executeCommand ()

	getType ()

	setTitle (string $a_title)

	getTitle ()

	setPostVar (string $a_postvar)

	getPostVar ()

	getFieldId ()

	setInfo (string $a_info)

	getInfo ()

	setAlert (string $a_alert)

	getAlert ()

	setRequired (bool $a_required)

	getRequired ()

	setDisabled (bool $a_disabled)

	getDisabled ()

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

	setParentForm (ilPropertyFormGUI $a_parentform)

	getParentForm ()

	setParent (ilFormPropertyGUI $a_val)

	getParent ()

	getSubForm ()

	hideSubForm ()

	setHiddenTitle (string $a_val)

	getHiddenTitle ()

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

	serializeData ()

	unserializeData (string $a_data)

	setParentTable ($a_val)
	Set parent table. More...

	getParentTable ()
	Get parent table. More...

	writeToSession ()

	clearFromSession ()

	readFromSession ()

	getHiddenTag (string $a_post_var, string $a_value)

	setMulti (bool $a_multi, bool $a_sortable=false, bool $a_addremove=true)

	getMulti ()

	setMultiValues (array $a_values)

	getMultiValues ()

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

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

	getTableFilterLabelFor ()
	Get label "for" attribute value for filter. More...

	getFormLabelFor ()
	Get label "for" attribute value for form. More...

	setRequestParam (string $key, $val)
	This writes the request (aka post) values. More...

Public Member Functions inherited from ilTableFilterItem
	getTableFilterLabelFor ()
	Get label "for" attribute value. 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 = null

int	$maxlength = 200

int	$size = 40

string	$validationRegexp = ""

string	$validationFailureMessage = ''

string	$suffix = ""

string	$style_css = ""

string	$css_class = ""

string	$ajax_datasource = ""

string	$ajax_datasource_delimiter = null

bool	$ajax_datasource_commit = false

string	$ajax_datasource_commit_url = ""

bool	$submit_form_on_enter = false

bool	$autocomplete_disabled = false

string	$input_type = ""

Protected Attributes inherited from ilSubEnabledFormPropertyGUI
array	$sub_items = array()

Protected Attributes inherited from ilFormPropertyGUI
array	$set_params = []

ilTable2GUI	$parent_table = null

ilFormPropertyGUI	$parent_gui = null

ilCtrl	$ctrl

ilLanguage	$lng

string	$type = ""

string	$title = ""

string	$postvar = ""

string	$info = ""

string	$alert = ""

bool	$required = false

ilPropertyFormGUI	$parentform = null

string	$hidden_title = ""

bool	$multi = false

bool	$multi_sortable = false

bool	$multi_addremove = true

array	$multi_values = []

RequestInterface	$request

HTTP Services	$http

Refinery Factory	$refinery = null

bool	$disabled = false

ilGlobalTemplateInterface	$global_tpl = null

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters (string $a_text)
	Remove prohibited characters see #19159. More...

Protected Member Functions inherited from ilFormPropertyGUI
	setType (string $a_type)

	checkParentFormTable ()

	getSessionKey ()

	getMultiIconsHTML ()

	int ($key)

	intArray ($key)

	str ($key)

	raw ($key)

	strArray ($key)

	arrayArray ($key)

	isRequestParamArray (string $key)

	getRequestParam (string $key, Refinery\Transformation $t)

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 26 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 43 of file class.ilKVPWizardInputGUI.php.

References ILIAS\GlobalScreen\Provider\__construct().

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

Here is the call graph for this function:

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 224 of file class.ilKVPWizardInputGUI.php.

References $DIC, ilFormPropertyGUI\$lng, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), ilArrayUtil\stripSlashesRecursive(), and ilLanguage\txt().

                                 : bool
     {
         global $DIC;
         $lng = $DIC['lng'];
 
         if (is_array($_POST[$this->getPostVar()])) {
             $_POST[$this->getPostVar()] = ilArrayUtil::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 215 of file class.ilKVPWizardInputGUI.php.

References $allowMove.

Referenced by insert().

                                   : bool
     {
         return $this->allowMove;
     }

Here is the caller graph for this function:

◆ getKeyMaxlength()

ilKVPWizardInputGUI::getKeyMaxlength ( )

Get key maxlength.

Returns: integer Key maxlength

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

References $key_maxlength.

Referenced by insert().

                                      : int
     {
         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 175 of file class.ilKVPWizardInputGUI.php.

References $key_name.

Referenced by insert().

                                 : string
     {
         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 75 of file class.ilKVPWizardInputGUI.php.

References $key_size.

Referenced by insert().

                                 : int
     {
         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 135 of file class.ilKVPWizardInputGUI.php.

References $value_maxlength.

Referenced by insert().

                                        : int
     {
         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 155 of file class.ilKVPWizardInputGUI.php.

References $value_name.

Referenced by insert().

                                   : string
     {
         return $this->value_name;
     }

Here is the caller graph for this function:

◆ getValues()

ilKVPWizardInputGUI::getValues ( )

Get Values.

Returns: array Values

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

References $values.

                                : array
     {
         return $this->values;
     }

◆ getValueSize()

ilKVPWizardInputGUI::getValueSize ( )

Get value size.

Returns: integer value size

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

References $value_size.

Referenced by insert().

                                   : int
     {
         return $this->value_size;
     }

Here is the caller graph for this function:

◆ insert()

ilKVPWizardInputGUI::insert ( ilTemplate $a_tpl )

Insert property html.

Returns: void Size

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

References $DIC, $i, ilFormPropertyGUI\$lng, $tpl, ilTextInputGUI\$value, ilGlyphGUI\ADD, ilGlyphGUI\DOWN, ilGlyphGUI\get(), getAllowMove(), ilFormPropertyGUI\getFieldId(), getKeyMaxlength(), getKeyName(), getKeySize(), ilFormPropertyGUI\getPostVar(), getValueMaxlength(), getValueName(), getValueSize(), ilTemplate\parseCurrentBlock(), ilLegacyFormElementsUtil\prepareFormOutput(), ilGlyphGUI\REMOVE, ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), and ilGlyphGUI\UP.

                                              : void
     {
         global $DIC;
         $lng = $DIC['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", ilLegacyFormElementsUtil::prepareFormOutput($value[0]));
                 $tpl->parseCurrentBlock();
                 $tpl->setCurrentBlock("prop_value_propval");
                 $tpl->setVariable("PROPERTY_VALUE", ilLegacyFormElementsUtil::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 $DIC;
         $tpl = $DIC['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 205 of file class.ilKVPWizardInputGUI.php.

                                                : void
     {
         $this->allowMove = $a_allow_move;
     }

◆ setKeyMaxlength()

ilKVPWizardInputGUI::setKeyMaxlength ( $a_maxlength )

Set key maxlength.

Parameters

integer $a_size Key maxlength

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

                                                  : void
     {
         $this->key_maxlength = $a_maxlength;
     }

◆ setKeyName()

ilKVPWizardInputGUI::setKeyName ( $a_name )

Set key name.

Parameters

string $a_name value name

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

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

◆ setKeySize()

ilKVPWizardInputGUI::setKeySize ( $a_size )

Set key size.

Parameters

integer $a_size Key size

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

                                        : void
     {
         $this->key_size = $a_size;
     }

◆ setValue()

ilKVPWizardInputGUI::setValue ( $a_value )

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

References ILIAS\LTI\ToolProvider\$key.

                                       : void
     {
         $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 125 of file class.ilKVPWizardInputGUI.php.

                                                    : void
     {
         $this->value_maxlength = $a_maxlength;
     }

◆ setValueName()

ilKVPWizardInputGUI::setValueName ( $a_name )

Set value name.

Parameters

string $a_name value name

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

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

◆ setValues()

ilKVPWizardInputGUI::setValues ( $a_values )

Set Values.

Parameters

array $a_value Value

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

                                         : void
     {
         $this->values = $a_values;
     }

◆ setValueSize()

ilKVPWizardInputGUI::setValueSize ( $a_size )

Set value size.

Parameters

integer $a_size value size

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

                                          : void
     {
         $this->value_size = $a_size;
     }

Field Documentation

◆ $allowMove

ilKVPWizardInputGUI::$allowMove = false

protected

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

Referenced by getAllowMove().

◆ $key_maxlength

ilKVPWizardInputGUI::$key_maxlength = 255

protected

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

Referenced by getKeyMaxlength().

◆ $key_name

ilKVPWizardInputGUI::$key_name = ""

protected

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

Referenced by getKeyName().

◆ $key_size

ilKVPWizardInputGUI::$key_size = 20

protected

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

Referenced by getKeySize().

◆ $value_maxlength

ilKVPWizardInputGUI::$value_maxlength = 255

protected

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

Referenced by getValueMaxlength().

◆ $value_name

ilKVPWizardInputGUI::$value_name = ""

protected

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

Referenced by getValueName().

◆ $value_size

ilKVPWizardInputGUI::$value_size = 20

protected

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

Referenced by getValueSize().

◆ $values

ilKVPWizardInputGUI::$values = array()

protected

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