Inheritance diagram for ilClozeGapInputBuilderGUI:

Collaboration diagram for ilClozeGapInputBuilderGUI:

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

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

	getValue ()

	setValueCombination ($value)

	getValueCombination ()

	setValueCombinationFromDb ($value)

	checkInput ()

	setValueByArray ($data)

	insert (ilTemplate $template)

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

Static Public Member Functions
static	stripSlashesRecursive ($a_data, bool $a_strip_html=true, string $a_allow="")

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

Private Attributes
	$value_combination

	$value

ArrayBasedRequestWrapper	$post

ArrayBasedRequestWrapper	$query

Additional Inherited Members
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)

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

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilClozeGapInputBuilderGUI::__construct	(	string	$a_title = `""`,
		string	$a_postvar = `""`
	)

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

References ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\FileDelivery\http().

     {
         parent::__construct($a_title, $a_postvar);
         $this->post = $this->http->wrapper()->post();
         $this->query = $this->http->wrapper()->query();
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilClozeGapInputBuilderGUI::checkInput ( )

Exceptions

JsonException

Definition at line 99 of file class.ilClozeGapInputBuilderGUI.php.

References $i, $index, ILIAS\LTI\ToolProvider\$key, CLOZE_NUMERIC, CLOZE_SELECT, CLOZE_TEXT, ilFormPropertyGUI\raw(), ILIAS\Repository\refinery(), and ilUtil\stripSlashes().

                                 : bool
     {
         $error = false;
         $json = self::stripSlashesRecursive(
             json_decode(
                 $this->post->retrieve(
                     "gap_json_post",
                     $this->refinery->kindlyTo()->string()
                 ),
                 true,
                 512,
                 JSON_THROW_ON_ERROR
             ),
             false
         );
         $gap = self::stripSlashesRecursive($this->raw('gap'));
         $gaps_used_in_combination = array();
         if ($this->post->has('gap_combination')) {
             $gapCombination = $this->post->retrieve(
                 "gap_combination",
                 $this->refinery->kindlyTo()->recordOf(
                     [
                         'select' => new ListTransformation(
                             new ListTransformation($this->refinery->kindlyTo()->string())
                         ),
                         'points' => new ListTransformation(
                             new ListTransformation($this->refinery->kindlyTo()->string())
                         ),
                     ]
                 )
             );
             $gapCombinationValues = $this->post->retrieve(
                 "gap_combination_values",
                 $this->refinery->kindlyTo()->listOf(
                     new ListTransformation(
                         new ListTransformation($this->refinery->kindlyTo()->string())
                     )
                 )
             );
 
             $gap_with_points = array();
 
             for ($i = 0, $iMax = count($gapCombination['select']); $i < $iMax; $i++) {
                 foreach ($gapCombination['select'][$i] as $key => $item) {
                     if ($item == 'none_selected_minus_one') {
                         return false;
                     }
                     $gaps_used_in_combination[$item] = $item;
                     $check_points_for_best_scoring = false;
                     foreach ($gapCombinationValues[$i] as $index => $answeritems) {
                         foreach ($answeritems as $answeritem) {
                             if ($answeritem == 'none_selected_minus_one') {
                                 return false;
                             }
                         }
                         $points = $gapCombination['points'][$i][$index];
                         if ($points > 0) {
                             $check_points_for_best_scoring = true;
                         }
                     }
                     if (!$check_points_for_best_scoring) {
                         return false;
                     }
                 }
             }
         }
 
         if (is_array($gap)) {
             foreach ($gap as $key => $item) {
                 $getType = ilUtil::stripSlashes($this->raw('clozetype_' . $key));
                 $gapsize = $this->raw('gap_' . $key . '_gapsize');
 
                 //$json[0][$key]->text_field_length = $gapsize > 0 ? $gapsize : '';
                 $json[0][$key]['text_field_length'] = $gapsize > 0 ? $gapsize : '';
 
                 $select_at_least_on_positive = false;
                 if ($getType == CLOZE_TEXT || $getType == CLOZE_SELECT) {
                     $gapText = self::stripSlashesRecursive($this->raw('gap_' . $key), false);
                     foreach ($gapText['answer'] as $row => $answer) {
                         if (!isset($answer) || $answer == '') {
                             $error = true;
                         }
                     }
                     $points_sum = 0;
                     if (array_key_exists('points', $gapText)) {
                         foreach ($gapText['points'] as $row => $points) {
                             if (isset($points) && $points != '' && is_numeric($points)) {
                                 $points_sum += $points;
                                 if ($points > 0) {
                                     $select_at_least_on_positive = true;
                                 }
                             } else {
                                 $error = true;
                             }
                         }
                         if (isset($gap_with_points) && is_array($gap_with_points) && array_key_exists($key, $gap_with_points)) {
                             $points_sum += $gap_with_points[$key];
                         }
                         if ($points_sum <= 0) {
                             if (!array_key_exists($key, $gaps_used_in_combination) && (!$getType == 'select' || $select_at_least_on_positive == false)) {
                                 $error = true;
                             }
                         }
                     } else {
                         $error = true;
                     }
                 }
                 if ($getType == CLOZE_NUMERIC) {
                     $eval = new EvalMath();
                     $eval->suppress_errors = true;
 
                     $mark_errors = array('answer' => false, 'lower' => false, 'upper' => false, 'points' => false);
                     foreach (array(     'answer' => '_numeric',
                                     'lower' => '_numeric_lower',
                                     'upper' => '_numeric_upper',
                                     'points' => '_numeric_points') as $part => $suffix) {
                         $val = ilUtil::stripSlashes($this->raw('gap_' . $key . $suffix), false);
                         $val = str_replace(',', '.', $val);
                         if ($eval->e($val) === false) {
                             $mark_errors[$part] = true;
                             $error = true;
                         }
 
                         if ($part == 'points') {
                             $points = $val;
                         }
                     }
 
                     if (isset($gap_with_points) && is_array($gap_with_points) && array_key_exists($key, $gap_with_points)) {
                         $points += $gap_with_points[$key];
                     }
 
                     if (!isset($points) || $points == '' || !is_numeric($points) || $points == 0) {
                         if (!array_key_exists($key, $gaps_used_in_combination)) {
                             $error = true;
                         }
                     }
 
                     $json[0][$key]["values"][0]["error"] = $mark_errors;
                 }
             }
         }
         //$_POST['gap_json_post'] = json_encode($json);
         return !$error;
     }

Here is the call graph for this function:

◆ getValue()

ilClozeGapInputBuilderGUI::getValue ( )

Exceptions

JsonException

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

References $value.

Referenced by insert().

     {
         $editOrOpen = $this->value;
         if (isset($editOrOpen['author'])) {
             $json = json_decode($this->post->retrieve(
                 "gap_json_post",
                 $this->refinery->kindlyTo()->string()
             ), true, 512, JSON_THROW_ON_ERROR);
             return $json[0];
         }
         return $this->value;
     }

Here is the caller graph for this function:

◆ getValueCombination()

ilClozeGapInputBuilderGUI::getValueCombination ( )

Exceptions

JsonException

Definition at line 69 of file class.ilClozeGapInputBuilderGUI.php.

References $value, and $value_combination.

Referenced by insert().

     {
         $editOrOpen = $this->value;
         if (isset($editOrOpen['author'])) {
             return json_decode($this->post->retrieve(
                 "gap_json_combination_post",
                 $this->refinery->kindlyTo()->string()
             ), true, 512, JSON_THROW_ON_ERROR);
         }
         return (array) $this->value_combination;
     }

Here is the caller graph for this function:

◆ insert()

ilClozeGapInputBuilderGUI::insert ( ilTemplate $template )

Parameters

ilTemplate $template

Definition at line 253 of file class.ilClozeGapInputBuilderGUI.php.

References $DIC, ilFormPropertyGUI\$lng, ilModalGUI\getInstance(), getValue(), getValueCombination(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), and ilLanguage\txt().

                                                 : void
     {
         global $DIC;
         $lng = $DIC['lng'];
         $modal = ilModalGUI::getInstance();
         $modal->setHeading($lng->txt(''));
         $modal->setId("ilGapModal");
         $modal->setBody('');
 
         $cloze_settings_js = 'ClozeSettings = {'
             . ' gaps_php             : ' . json_encode(array($this->getValue()))
             . ',gaps_combination     : ' . json_encode($this->getValueCombination())
             . ',gap_backup           : []'
             . ',unused_gaps_comb     : []'
             . ',outofbound_text      : ' . '"' . $lng->txt('out_of_range') . '"'
             . ',combination_error    : ' . '"' . $lng->txt('please_select') . '"'
             . ',combination_text     : ' . '"' . $lng->txt('gap_combination') . '"'
             . ',copy_of_combination  : ' . '"' . $lng->txt('copy_of') . ' ' . $lng->txt('gap_combination') . '"'
             . ',gap_in_more_than_one : ' . '""'
             . ',gap_text             : ' . '"' . $lng->txt('gap') . '"'
             . ',ok_text              : ' . '"' . $lng->txt('ok') . '"'
             . ',cancel_text          : ' . '"' . $lng->txt('cancel') . '"'
         . '};';
 
         $DIC->ui()->mainTemplate()->addOnLoadCode(
             $cloze_settings_js
             . 'ClozeQuestionGapBuilder.Init();'
         );
         $DIC->ui()->mainTemplate()->addJavascript(
             './Modules/TestQuestionPool/templates/default/clozeQuestionGapBuilder.js'
         );
 
 
         $custom_template = new ilTemplate('tpl.il_as_cloze_gap_builder.html', true, true, 'Modules/TestQuestionPool');
         $custom_template->setVariable("MY_MODAL", $modal->getHTML());
         $custom_template->setVariable('GAP_JSON', json_encode(array($this->getValue())));
         $custom_template->setVariable('GAP', $lng->txt('gap'));
         $custom_template->setVariable('GAP_COMBINATION_JSON', json_encode($this->getValueCombination()));
         $custom_template->setVariable('TEXT_GAP', $lng->txt('text_gap'));
         $custom_template->setVariable('SELECT_GAP', $lng->txt('select_gap'));
         $custom_template->setVariable('NUMERIC_GAP', $lng->txt('numeric_gap'));
         $custom_template->setVariable('GAP_SIZE', $lng->txt('cloze_fixed_textlength'));
         $custom_template->setVariable('GAP_SIZE_INFO', $lng->txt('cloze_gap_size_info'));
         $custom_template->setVariable('ANSWER_TEXT', $lng->txt('answer_text'));
         $custom_template->setVariable('ANSWER_BYLINE', $lng->txt('cloze_answer_text_info'));
         $custom_template->setVariable('POINTS', $lng->txt('points'));
         $custom_template->setVariable('VALUE', $lng->txt('value'));
         $custom_template->setVariable('UPPER_BOUND', $lng->txt('range_upper_limit'));
         $custom_template->setVariable('LOWER_BOUND', $lng->txt('range_lower_limit'));
         $custom_template->setVariable('ACTIONS', $lng->txt('actions'));
         $custom_template->setVariable('REMOVE_GAP', $lng->txt('remove_gap'));
         $custom_template->setVariable('SHUFFLE_ANSWERS', $lng->txt('shuffle_answers'));
         $custom_template->setVariable('POINTS_ERROR', $lng->txt('enter_enough_positive_points'));
         $custom_template->setVariable('MISSING_VALUE', $lng->txt('msg_input_is_required'));
         $custom_template->setVariable('NOT_A_FORMULA', $lng->txt('err_no_formula'));
         $custom_template->setVariable('NOT_A_NUMBER', $lng->txt('err_no_numeric_value'));
         $custom_template->setVariable('CLOSE', $lng->txt('close'));
         $custom_template->setVariable('DELETE_GAP', $lng->txt('are_you_sure'));
         $custom_template->setVariable('PLEASE_SELECT', $lng->txt('please_select'));
         $custom_template->setVariable('BEST_POSSIBLE_SOLUTION_HEADER', $lng->txt('tst_best_solution_is'));
         $custom_template->setVariable('BEST_POSSIBLE_SOLUTION', $lng->txt('value'));
         $custom_template->setVariable('MAX_POINTS', $lng->txt('max_points'));
         $custom_template->setVariable('TYPE', $lng->txt('type'));
         $custom_template->setVariable('VALUES', $lng->txt('values'));
         $custom_template->setVariable('GAP_COMBINATION', $lng->txt('gap_combination'));
         $custom_template->setVariable('COPY', $lng->txt('copy_of'));
         $template->setCurrentBlock('prop_generic');
         $template->setVariable('PROP_GENERIC', $custom_template->get());
         $template->parseCurrentBlock();
     }

Here is the call graph for this function:

◆ setValue()

ilClozeGapInputBuilderGUI::setValue ( $a_value )

Set Value.

Parameters

string $a_value Value

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

Referenced by setValueByArray().

                                       : void
     {
         $this->value = $a_value;
     }

Here is the caller graph for this function:

◆ setValueByArray()

ilClozeGapInputBuilderGUI::setValueByArray ( $data )

Definition at line 245 of file class.ilClozeGapInputBuilderGUI.php.

References $data, and setValue().

                                           : void
     {
         $this->setValue($data);
     }

Here is the call graph for this function:

◆ setValueCombination()

ilClozeGapInputBuilderGUI::setValueCombination ( $value )

Definition at line 61 of file class.ilClozeGapInputBuilderGUI.php.

References $value.

Referenced by setValueCombinationFromDb().

                                                : void
     {
         $this->value_combination = $value;
     }

Here is the caller graph for this function:

◆ setValueCombinationFromDb()

ilClozeGapInputBuilderGUI::setValueCombinationFromDb ( $value )

Definition at line 81 of file class.ilClozeGapInputBuilderGUI.php.

References $value, and setValueCombination().

                                                      : void
     {
         $return_array = array();
         if ($value) {
             foreach ($value as $row) {
                 if ($row['row_id'] == 0) {
                     $return_array[$row['cid']][0][] = $row['gap_fi'];
                 }
                 $return_array[$row['cid']][1][$row['row_id']][] = $row['answer'];
                 $return_array[$row['cid']][2][$row['row_id']] = $row['points']; //= array('key' => $row['cid'], 'points' => $row['points'], 'best_solution' => $row['best_solution']);
             }
             $this->setValueCombination($return_array);
         }
     }

Here is the call graph for this function:

◆ stripSlashesRecursive()

static ilClozeGapInputBuilderGUI::stripSlashesRecursive	(		$a_data,
		bool	$a_strip_html = `true`,
		string	$a_allow = `""`
	)

static

Parameters

$data string|array

Deprecated:

Definition at line 328 of file class.ilClozeGapInputBuilderGUI.php.

References ilUtil\stripSlashes().

     {
         if (is_array($a_data)) {
             foreach ($a_data as $k => $v) {
                 if (is_array($v)) {
                     $a_data[$k] = self::stripSlashesRecursive($v, $a_strip_html, $a_allow);
                 } else {
                     $a_data[$k] = ilUtil::stripSlashes($v, $a_strip_html, $a_allow);
                 }
             }
         } else {
             if ($a_data != null) {
                 $a_data = ilUtil::stripSlashes($a_data, $a_strip_html, $a_allow);
             }
         }
 
         return $a_data;
     }