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.
	setValue ($a_value)
	Set Value.
	setKeySize ($a_size)
	Set key size.
	getKeySize ()
	Get key size.
	setValueSize ($a_size)
	Set value size.
	getValueSize ()
	Get value size.
	setKeyMaxlength ($a_maxlength)
	Set key maxlength.
	getKeyMaxlength ()
	Get key maxlength.
	setValueMaxlength ($a_maxlength)
	Set value maxlength.
	getValueMaxlength ()
	Get value maxlength.
	setValueName ($a_name)
	Set value name.
	getValueName ()
	Get value name.
	setKeyName ($a_name)
	Set key name.
	getKeyName ()
	Get key name.
	setValues ($a_values)
	Set Values.
	getValues ()
	Get Values.
	setAllowMove ($a_allow_move)
	Set allow move.
	getAllowMove ()
	Get allow move.
	checkInput ()
	Check input, strip slashes etc.
	insert (&$a_tpl)
	Insert property html.
Public Member Functions inherited from ilTextInputGUI
	getValue ()
	Get Value.
	setValidationFailureMessage ($a_msg)
	Set message string for validation failure.
	getValidationFailureMessage ()
	setValidationRegexp ($a_value)
	Set validation regexp.
	getValidationRegexp ()
	Get validation regexp.
	setMaxLength ($a_maxlength)
	Set Max Length.
	getMaxLength ()
	Get Max Length.
	setSize ($a_size)
	Set Size.
	setInlineStyle ($a_style)
	Set inline style.
	getInlineStyle ()
	Get inline style.
	setCssClass ($a_class)
	getCssClass ()
	setValueByArray ($a_values)
	Set value by array.
	getSize ()
	Get Size.
	setSuffix ($a_value)
	Set suffix.
	getSuffix ()
	Get suffix.
	setInputType ($a_type)
	set input type
	getInputType ()
	get input type
	setSubmitFormOnEnter ($a_val)
	Set submit form on enter.
	getSubmitFormOnEnter ()
	Get submit form on enter.
	getDataSource ()
	get datasource link for js autocomplete
	setDataSource ($href, $a_delimiter=null)
	set datasource link for js autocomplete
	setDataSourceSubmitOnSelection ($a_stat)
	getDataSourceSubmitOnSelection ()
	setDataSourceSubmitUrl ($a_url)
	getDataSourceSubmitUrl ()
	setMultiValues (array $a_values)
	Set multi values.
	getTableFilterHTML ()
	Get HTML for table filter.
	getToolbarHTML ()
	Get HTML for toolbar.
	setDisableHtmlAutoComplete ($autocomplete)
	isHtmlAutoCompleteDisabled ()
Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem ($a_item)
	Add Subitem.
	getSubItems ()
	Get Subitems.
	getSubInputItemsRecursive ()
	returns a flat array of possibly existing subitems recursively
	checkSubItemsInput ()
	Check SubItems.
	getSubForm ()
	Get sub form html.
	getItemByPostVar ($a_post_var)
	Get item by post var.
Public Member Functions inherited from ilFormPropertyGUI
&	executeCommand ()
	Execute command.
	getType ()
	Get Type.
	setTitle ($a_title)
	Set Title.
	getTitle ()
	Get Title.
	setPostVar ($a_postvar)
	Set Post Variable.
	getPostVar ()
	Get Post Variable.
	getFieldId ()
	Get Post Variable.
	setInfo ($a_info)
	Set Information Text.
	getInfo ()
	Get Information Text.
	setAlert ($a_alert)
	Set Alert Text.
	getAlert ()
	Get Alert Text.
	setRequired ($a_required)
	Set Required.
	getRequired ()
	Get Required.
	setDisabled ($a_disabled)
	Set Disabled.
	getDisabled ()
	Get Disabled.
	setParentForm ($a_parentform)
	Set Parent Form.
	getParentForm ()
	Get Parent Form.
	setParent ($a_val)
	Set Parent GUI object.
	getParent ()
	Get Parent GUI object.
	hideSubForm ()
	Sub form hidden on init?
	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders)
	getHiddenTitle ()
	Get hidden title.
	serializeData ()
	serialize data
	unserializeData ($a_data)
	unserialize data
	writeToSession ()
	Write to session.
	clearFromSession ()
	Clear session value.
	readFromSession ()
	Read from session.
	getHiddenTag ($a_post_var, $a_value)
	Get hidden tag (used for disabled properties)
	setMulti ($a_multi, $a_sortable=false, $a_addremove=true)
	Set Multi.
	getMulti ()
	Get Multi.
	getMultiValues ()
	Get multi values.
	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g.

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.
	getMultiIconsHTML ()
	Get HTML for multiple value icons.

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:: class.ilKVPWizardInputGUI.php 55161 2014-11-14 14:16:51Z mjansen

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

Constructor & Destructor Documentation

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Reimplemented from ilTextInputGUI.

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

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

Member Function Documentation

ilKVPWizardInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

Reimplemented from ilTextInputGUI.

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:

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:

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:

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:

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:

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:

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:

ilKVPWizardInputGUI::getValues ( )

Get Values.

Returns: array Values

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

References $values.

        {
                return $this->values;
        }

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:

ilKVPWizardInputGUI::insert ( & $a_tpl )

Insert property html.

Returns: int Size

Reimplemented from ilTextInputGUI.

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:

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;
        }

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;
        }

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;
        }

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;
        }

ilKVPWizardInputGUI::setValue ( $a_value )

Set Value.

Parameters

string $a_value Value

Reimplemented from ilTextInputGUI.

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]));
                                }
                        }
                }
        }

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;
        }

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;
        }

ilKVPWizardInputGUI::setValues ( $a_values )

Set Values.

Parameters

array $a_value Value

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

        {
                $this->values = $a_values;
        }

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

ilKVPWizardInputGUI::$allowMove = false

protected

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

Referenced by getAllowMove().

ilKVPWizardInputGUI::$key_maxlength = 255

protected

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

Referenced by getKeyMaxlength().

ilKVPWizardInputGUI::$key_name = ""

protected

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

Referenced by getKeyName().

ilKVPWizardInputGUI::$key_size = 20

protected

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

Referenced by getKeySize().

ilKVPWizardInputGUI::$value_maxlength = 255

protected

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

Referenced by getValueMaxlength().

ilKVPWizardInputGUI::$value_name = ""

protected

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

Referenced by getValueName().

ilKVPWizardInputGUI::$value_size = 20

protected

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

Referenced by getValueSize().

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

Member Function Documentation

Field Documentation