This class represents a single choice wizard property in a property form. More...

Inheritance diagram for ilAnswerWizardInputGUI:

Collaboration diagram for ilAnswerWizardInputGUI:

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

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

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

	getValues ()
	Get Values. More...

	setSingleline ($a_value)
	Set singleline. More...

	getSingleline ()
	Get singleline. More...

	setQuestionObject ($a_value)
	Set question object. More...

	getQuestionObject ()
	Get question object. More...

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

	getAllowMove ()
	Get allow move. More...

	setMinvalueShouldBeGreater ($a_bool)
	Set minvalueShouldBeGreater. More...

	minvalueShouldBeGreater ()
	Get minvalueShouldBeGreater. More...

	setMinValue ($a_minvalue)
	Set Minimum Value. More...

	getMinValue ()
	Get Minimum Value. 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 Member Functions
	getTextInputLabel ($lng)

	getPointsInputLabel ($lng)

	getTemplate ()

	sanitizeSuperGlobalSubmitValue ()

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

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

Protected Attributes
	$values = array()

	$allowMove = false

	$singleline = true

	$qstObject = null

	$minvalue = false

	$minvalueShouldBeGreater = false

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

Detailed Description

This class represents a single choice 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.ilAnswerWizardInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Definition at line 28 of file class.ilAnswerWizardInputGUI.php.

References ilTextInputGUI\setSize().

         {
                 parent::__construct($a_title, $a_postvar);
                 $this->setSize('25');
                 $this->validationRegexp = "";
         }

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilAnswerWizardInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

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

References $_POST, $lng, ilSubEnabledFormPropertyGUI\checkSubItemsInput(), getMinValue(), ilFormPropertyGUI\getPostVar(), minvalueShouldBeGreater(), sanitizeSuperGlobalSubmitValue(), and ilFormPropertyGUI\setAlert().

         {
                 global $lng;
                 $this->sanitizeSuperGlobalSubmitValue();
                 $foundvalues = $_POST[$this->getPostVar()];
                 if (is_array($foundvalues))
                 {
                         // check answers
                         if (is_array($foundvalues['answer']))
                         {
                                 foreach ($foundvalues['answer'] as $aidx => $answervalue)
                                 {
                                         if ((strlen($answervalue)) == 0)
                                         {
                                                 $this->setAlert($lng->txt("msg_input_is_required"));
                                                 return FALSE;
                                         }
                                 }
                         }
                         // check points
                         $max = 0;
                         if (is_array($foundvalues['points']))
                         {
                                 foreach ($foundvalues['points'] as $points)
                                 {
                                         if ($points > $max) $max = $points;
                                         if (((strlen($points)) == 0) || (!is_numeric($points))) 
                                         {
                                                 $this->setAlert($lng->txt("form_msg_numeric_value_required"));
                                                 return FALSE;
                                         }
                                         if ($this->minvalueShouldBeGreater())
                                         {
                                                 if (trim($points) != "" &&
                                                         $this->getMinValue() !== false &&
                                                         $points <= $this->getMinValue())
                                                 {
                                                         $this->setAlert($lng->txt("form_msg_value_too_low"));
 
                                                         return false;
                                                 }
                                         }
                                         else
                                         {
                                                 if (trim($points) != "" &&
                                                         $this->getMinValue() !== false &&
                                                         $points < $this->getMinValue())
                                                 {
                                                         $this->setAlert($lng->txt("form_msg_value_too_low"));
 
                                                         return false;
 
                                                 }
                                         }
                                 }
                         }
                         if ($max == 0)
                         {
                                 $this->setAlert($lng->txt("enter_enough_positive_points"));
                                 return false;
                         }
                 }
                 else
                 {
                         $this->setAlert($lng->txt("msg_input_is_required"));
                         return FALSE;
                 }
                 
                 return $this->checkSubItemsInput();
         }

Here is the call graph for this function:

◆ getAllowMove()

ilAnswerWizardInputGUI::getAllowMove ( )

Get allow move.

Returns: boolean Allow move

Definition at line 132 of file class.ilAnswerWizardInputGUI.php.

References $allowMove.

Referenced by insert().

         {
                 return $this->allowMove;
         }

Here is the caller graph for this function:

◆ getMinValue()

ilAnswerWizardInputGUI::getMinValue ( )

Get Minimum Value.

Returns: float Minimum Value

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

References $minvalue.

Referenced by checkInput().

         {
                 return $this->minvalue;
         }

Here is the caller graph for this function:

◆ getPointsInputLabel()

ilAnswerWizardInputGUI::getPointsInputLabel ( $lng )

protected

Parameters

$lng

Returns: mixed

Definition at line 360 of file class.ilAnswerWizardInputGUI.php.

References $lng.

Referenced by insert().

         {
                 return $lng->txt('points');
         }

Here is the caller graph for this function:

◆ getQuestionObject()

ilAnswerWizardInputGUI::getQuestionObject ( )

Get question object.

Returns: object Value

Definition at line 112 of file class.ilAnswerWizardInputGUI.php.

References $qstObject.

         {
                 return $this->qstObject;
         }

◆ getSingleline()

ilAnswerWizardInputGUI::getSingleline ( )

Get singleline.

Returns: boolean Value

Definition at line 92 of file class.ilAnswerWizardInputGUI.php.

References $singleline.

Referenced by insert().

         {
                 return $this->singleline;
         }

Here is the caller graph for this function:

◆ getTemplate()

ilAnswerWizardInputGUI::getTemplate ( )

protected

Returns: string

Definition at line 368 of file class.ilAnswerWizardInputGUI.php.

Referenced by insert().

         {
                 return "tpl.prop_answerwizardinput.html";
         }

Here is the caller graph for this function:

◆ getTextInputLabel()

ilAnswerWizardInputGUI::getTextInputLabel ( $lng )

protected

Parameters

$lng

Returns: mixed

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

References $lng.

Referenced by insert().

         {
                 return $lng->txt('answer_text');
         }

Here is the caller graph for this function:

◆ getValues()

ilAnswerWizardInputGUI::getValues ( )

Get Values.

Returns: array Values

Definition at line 72 of file class.ilAnswerWizardInputGUI.php.

References $values.

         {
                 return $this->values;
         }

◆ insert()

ilAnswerWizardInputGUI::insert ( & $a_tpl )

Insert property html.

Returns: int Size

Definition at line 256 of file class.ilAnswerWizardInputGUI.php.

References $lng, $tpl, ilTextInputGUI\$value, ilGlyphGUI\ADD, ilGlyphGUI\DOWN, ilGlyphGUI\get(), getAllowMove(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), ilTextInputGUI\getMaxLength(), getPointsInputLabel(), ilFormPropertyGUI\getPostVar(), getSingleline(), ilTextInputGUI\getSize(), getTemplate(), getTextInputLabel(), ilUtil\prepareFormOutput(), ilGlyphGUI\REMOVE, and ilGlyphGUI\UP.

         {
                 global $lng;
                 
                 $tpl = new ilTemplate($this->getTemplate(), true, true, "Modules/TestQuestionPool");
                 $i = 0;
                 foreach ($this->values as $value)
                 {
                         if ($this->getSingleline())
                         {
                                 if (is_object($value))
                                 {
                                         $tpl->setCurrentBlock("prop_text_propval");
                                         $tpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput($value->getAnswertext()));
                                         $tpl->parseCurrentBlock();
                                         $tpl->setCurrentBlock("prop_points_propval");
                                         $tpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput($value->getPoints()));
                                         $tpl->parseCurrentBlock();
                                 }
                                 $tpl->setCurrentBlock('singleline');
                                 $tpl->setVariable("SIZE", $this->getSize());
                                 $tpl->setVariable("SINGLELINE_ID", $this->getPostVar() . "[answer][$i]");
                                 $tpl->setVariable("SINGLELINE_ROW_NUMBER", $i);
                                 $tpl->setVariable("SINGLELINE_POST_VAR", $this->getPostVar());
                                 $tpl->setVariable("MAXLENGTH", $this->getMaxLength());
                                 if ($this->getDisabled())
                                 {
                                         $tpl->setVariable("DISABLED_SINGLELINE", " disabled=\"disabled\"");
                                 }
                                 $tpl->parseCurrentBlock();
                         }
                         else if (!$this->getSingleline())
                         {
                                 if (is_object($value))
                                 {
                                         $tpl->setCurrentBlock("prop_points_propval");
                                         $tpl->setVariable("PROPERTY_VALUE", ilUtil::prepareFormOutput($value->getPoints()));
                                         $tpl->parseCurrentBlock();
                                 }
                                 $tpl->setCurrentBlock('multiline');
                                 $tpl->setVariable("PROPERTY_VALUE", $this->qstObject->prepareTextareaOutput($value->getAnswertext()));
                                 $tpl->setVariable("MULTILINE_ID", $this->getPostVar() . "[answer][$i]");
                                 $tpl->setVariable("MULTILINE_ROW_NUMBER", $i);
                                 $tpl->setVariable("MULTILINE_POST_VAR", $this->getPostVar());
                                 if ($this->getDisabled())
                                 {
                                         $tpl->setVariable("DISABLED_MULTILINE", " disabled=\"disabled\"");
                                 }
                                 $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");
                         $tpl->setVariable("POST_VAR", $this->getPostVar());
                         $tpl->setVariable("ROW_NUMBER", $i);
                         $tpl->setVariable("ID", $this->getPostVar() . "[answer][$i]");
                         $tpl->setVariable("POINTS_ID", $this->getPostVar() . "[points][$i]");
                         $tpl->setVariable("CMD_ADD", "cmd[add" . $this->getFieldId() . "][$i]");
                         $tpl->setVariable("CMD_REMOVE", "cmd[remove" . $this->getFieldId() . "][$i]");
                         if ($this->getDisabled())
                         {
                                 $tpl->setVariable("DISABLED_POINTS", " disabled=\"disabled\"");
                         }
                         $tpl->setVariable("ADD_BUTTON", ilGlyphGUI::get(ilGlyphGUI::ADD));
                         $tpl->setVariable("REMOVE_BUTTON", ilGlyphGUI::get(ilGlyphGUI::REMOVE));
                         $tpl->parseCurrentBlock();
                         $i++;
                 }
 
                 $tpl->setVariable("ELEMENT_ID", $this->getPostVar());
                 $tpl->setVariable("ANSWER_TEXT", $this->getTextInputLabel($lng));
                 $tpl->setVariable("POINTS_TEXT", $this->getPointsInputLabel($lng));
                 $tpl->setVariable("COMMANDS_TEXT", $lng->txt('actions'));
 
                 $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/answerwizard.js");
         }

Here is the call graph for this function:

◆ minvalueShouldBeGreater()

ilAnswerWizardInputGUI::minvalueShouldBeGreater ( )

Get minvalueShouldBeGreater.

Returns: boolean true if the minimum value should be greater than minvalue

Definition at line 152 of file class.ilAnswerWizardInputGUI.php.

References $minvalueShouldBeGreater.

Referenced by checkInput(), and setMinvalueShouldBeGreater().

         {
                 return $this->minvalueShouldBeGreater;
         }

Here is the caller graph for this function:

◆ sanitizeSuperGlobalSubmitValue()

ilAnswerWizardInputGUI::sanitizeSuperGlobalSubmitValue ( )

protected

Definition at line 373 of file class.ilAnswerWizardInputGUI.php.

References $_POST, ilFormPropertyGUI\getPostVar(), and ilUtil\stripSlashesRecursive().

Referenced by checkInput().

         {
                 if( isset($_POST[$this->getPostVar()]) && is_array($_POST[$this->getPostVar()]) )
                 {
                         $_POST[$this->getPostVar()] = ilUtil::stripSlashesRecursive($_POST[$this->getPostVar()]);
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAllowMove()

ilAnswerWizardInputGUI::setAllowMove ( $a_allow_move )

Set allow move.

Parameters

boolean $a_allow_move Allow move

Definition at line 122 of file class.ilAnswerWizardInputGUI.php.

         {
                 $this->allowMove = $a_allow_move;
         }

◆ setMinValue()

ilAnswerWizardInputGUI::setMinValue ( $a_minvalue )

Set Minimum Value.

Parameters

float $a_minvalue Minimum Value

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

         {
                 $this->minvalue = $a_minvalue;
         }

◆ setMinvalueShouldBeGreater()

ilAnswerWizardInputGUI::setMinvalueShouldBeGreater ( $a_bool )

Set minvalueShouldBeGreater.

Parameters

boolean $a_bool true if the minimum value should be greater than minvalue

Definition at line 142 of file class.ilAnswerWizardInputGUI.php.

References minvalueShouldBeGreater().

         {
                 $this->minvalueShouldBeGreater = $a_bool;
         }

Here is the call graph for this function:

◆ setQuestionObject()

ilAnswerWizardInputGUI::setQuestionObject ( $a_value )

Set question object.

Parameters

object $a_value test object

Definition at line 102 of file class.ilAnswerWizardInputGUI.php.

         {
                 $this->qstObject =& $a_value;
         }

◆ setSingleline()

ilAnswerWizardInputGUI::setSingleline ( $a_value )

Set singleline.

Parameters

boolean $a_value Value

Definition at line 82 of file class.ilAnswerWizardInputGUI.php.

         {
                 $this->singleline = $a_value;
         }

◆ setValue()

ilAnswerWizardInputGUI::setValue ( $a_value )

Set Value.

Parameters

string $a_value Value

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

References ilTextInputGUI\$value.

         {
                 $this->values = array();
                 if (is_array($a_value))
                 {
                         if (is_array($a_value['answer']))
                         {
                                 foreach ($a_value['answer'] as $index => $value)
                                 {
                                         include_once "./Modules/TestQuestionPool/classes/class.assAnswerBinaryStateImage.php";
                                         $answer = new ASS_AnswerBinaryStateImage($value, $a_value['points'][$index], $index, 1, $a_value['imagename'][$index]);
                                         array_push($this->values, $answer);
                                 }
                         }
                 }
         }

◆ setValues()

ilAnswerWizardInputGUI::setValues ( $a_values )

Set Values.

Parameters

array $a_value Value

Definition at line 62 of file class.ilAnswerWizardInputGUI.php.

         {
                 $this->values = $a_values;
         }

Field Documentation

◆ $allowMove

ilAnswerWizardInputGUI::$allowMove = false

protected

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

Referenced by getAllowMove().

◆ $minvalue

ilAnswerWizardInputGUI::$minvalue = false

protected

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

Referenced by getMinValue().

◆ $minvalueShouldBeGreater

ilAnswerWizardInputGUI::$minvalueShouldBeGreater = false

protected

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

Referenced by minvalueShouldBeGreater().

◆ $qstObject

ilAnswerWizardInputGUI::$qstObject = null

protected

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

Referenced by getQuestionObject().

◆ $singleline

ilAnswerWizardInputGUI::$singleline = true

protected

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

Referenced by getSingleline().

◆ $values

ilAnswerWizardInputGUI::$values = array()

protected

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

Referenced by getValues().

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

Modules/TestQuestionPool/classes/class.ilAnswerWizardInputGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getAllowMove()

◆ getMinValue()

◆ getPointsInputLabel()

◆ getQuestionObject()

◆ getSingleline()

◆ getTemplate()

◆ getTextInputLabel()

◆ getValues()

◆ insert()

◆ minvalueShouldBeGreater()

◆ sanitizeSuperGlobalSubmitValue()

◆ setAllowMove()

◆ setMinValue()

◆ setMinvalueShouldBeGreater()

◆ setQuestionObject()

◆ setSingleline()

◆ setValue()

◆ setValues()

Field Documentation

◆ $allowMove

◆ $minvalue

◆ $minvalueShouldBeGreater

◆ $qstObject

◆ $singleline

◆ $values