Class for cloze question gaps. More...

Inheritance diagram for assClozeGap:

Collaboration diagram for assClozeGap:

Public Member Functions
	__construct ($a_type)
	assClozeGap constructor More...

	getType ()

	isTextGap ()

	isSelectGap ()

	isNumericGap ()

	setType ($a_type=0)
	Sets the cloze gap type. More...

	getItems (Transformation $shuffler, ?int $gap_index=null)
	Gets the items of a cloze gap. More...

	getItemsRaw ()
	Gets the items of a cloze gap. More...

	getItemCount ()
	Gets the item count. More...

	addItem ($a_item)
	Adds a gap item. More...

	setItemPoints ($order, $points)
	Sets the points for a given item. More...

	deleteItem ($order)
	Deletes an item at a given index. More...

	setItemLowerBound ($order, $bound)
	Sets the lower bound for a given item. More...

	setItemUpperBound ($order, $bound)
	Sets the upper bound for a given item. More...

	getItem ($a_index)
	Gets the item with a given index. More...

	clearItems ()
	Removes all gap items. More...

	setShuffle ($a_shuffle=true)
	Sets the shuffle state of the items. More...

	getShuffle ()
	Gets the shuffle state of the items. More...

	getMaxWidth ()
	Returns the maximum width of the gap. More...

	getBestSolutionIndexes ()
	Returns the indexes of the best solutions for the gap. More...

	getBestSolutionOutput (Transformation $shuffler, $combinations=null)

	setGapSize (int $gap_size)

	getGapSize ()

	numericRangeExists ()

Data Fields
const	TYPE_TEXT = 0

const	TYPE_SELECT = 1

const	TYPE_NUMERIC = 2

int	$type

	$items

	$shuffle

Private Attributes
Transformation	$shuffler = null

	$gap_size = 0

Detailed Description

Class for cloze question gaps.

assClozeGap is a class for the abstraction of cloze gaps. It represents a text gap.

Author: Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m; Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

assClozeGap::__construct ( $a_type )

assClozeGap constructor

Parameters

int $a_type

Definition at line 68 of file class.assClozeGap.php.

References ILIAS\Repository\int().

     {
         $this->type = (int) $a_type;
         $this->items = [];
         $this->shuffle = true;
     }

Here is the call graph for this function:

Member Function Documentation

◆ addItem()

assClozeGap::addItem ( $a_item )

Adds a gap item.

Adds a gap item

Parameters

object $a_item Cloze gap item public

See also: $items

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

                                     : void
     {
         $order = $a_item->getOrder();
         if (array_key_exists($order, $this->items)) {
             $newitems = [];
             for ($i = 0; $i < $order; $i++) {
                 array_push($newitems, $this->items[$i]);
             }
             array_push($newitems, $a_item);
             for ($i = $order, $iMax = count($this->items); $i < $iMax; $i++) {
                 array_push($newitems, $this->items[$i]);
             }
             $i = 0;
             foreach ($newitems as $idx => $item) {
                 $newitems[$idx]->setOrder($i);
                 $i++;
             }
             $this->items = $newitems;
         } else {
             array_push($this->items, $a_item);
         }
     }

◆ clearItems()

assClozeGap::clearItems ( )

Removes all gap items.

Removes all gap items

public

See also: $items

Definition at line 299 of file class.assClozeGap.php.

                                 : void
     {
         $this->items = [];
     }

◆ deleteItem()

assClozeGap::deleteItem ( $order )

Deletes an item at a given index.

Deletes an item at a given index

Parameters

integer $0order Order of the item public

See also: $items

Definition at line 222 of file class.assClozeGap.php.

References ILIAS\LTI\ToolProvider\$key.

                                       : void
     {
         if (array_key_exists($order, $this->items)) {
             unset($this->items[$order]);
             $order = 0;
             foreach ($this->items as $key => $item) {
                 $this->items[$key]->setOrder($order);
                 $order++;
             }
         }
     }

◆ getBestSolutionIndexes()

assClozeGap::getBestSolutionIndexes ( )

Returns the indexes of the best solutions for the gap.

Returns the indexes of the best solutions for the gap

Returns: array The indexs of the best solutions public

Definition at line 353 of file class.assClozeGap.php.

References ILIAS\LTI\ToolProvider\$key.

                                             : array
     {
         $maxpoints = 0;
         foreach ($this->items as $key => $item) {
             if ($item->getPoints() > $maxpoints) {
                 $maxpoints = $item->getPoints();
             }
         }
         $keys = [];
         foreach ($this->items as $key => $item) {
             if ($item->getPoints() == $maxpoints) {
                 array_push($keys, $key);
             }
         }
         return $keys;
     }

◆ getBestSolutionOutput()

assClozeGap::getBestSolutionOutput	(	Transformation	$shuffler,
			$combinations = `null`
	)

Parameters

Transformation	$shuffler
null \| array	$combinations

Returns: string

Definition at line 375 of file class.assClozeGap.php.

References $DIC, $lng, CLOZE_NUMERIC, CLOZE_SELECT, CLOZE_TEXT, getItems(), and getType().

                                                                                          : string
     {
         global $DIC;
         $lng = $DIC['lng'];
         switch ($this->getType()) {
             case CLOZE_TEXT:
             case CLOZE_SELECT:
                 $best_solutions = [];
                 if ($combinations !== null && $combinations['best_solution'] == 1) {
                     $points_string_for_key = (string) $combinations['points'];
                     $best_solutions[$points_string_for_key] = [];
                     array_push($best_solutions[$points_string_for_key], $combinations['answer']);
                 } else {
                     foreach ($this->getItems($shuffler) as $answer) {
                         $points_string_for_key = (string) $answer->getPoints();
                         if (isset($best_solutions[$points_string_for_key]) && is_array($best_solutions[$points_string_for_key])) {
                             array_push($best_solutions[$points_string_for_key], $answer->getAnswertext());
                         } else {
                             $best_solutions[$points_string_for_key] = [];
                             array_push($best_solutions[$points_string_for_key], $answer->getAnswertext());
                         }
                     }
                 }
 
                 krsort($best_solutions, SORT_NUMERIC);
                 reset($best_solutions);
                 $found = current($best_solutions);
                 return join(" " . $lng->txt("or") . " ", $found);
                 break;
             case CLOZE_NUMERIC:
                 $maxpoints = 0;
                 $foundvalue = "";
                 foreach ($this->getItems($shuffler) as $answer) {
                     if ($answer->getPoints() >= $maxpoints) {
                         $maxpoints = $answer->getPoints();
                         $foundvalue = $answer->getAnswertext();
                     }
                 }
                 return $foundvalue;
                 break;
             default:
                 return "";
         }
     }

Here is the call graph for this function:

◆ getGapSize()

assClozeGap::getGapSize ( )

Returns: int

Definition at line 428 of file class.assClozeGap.php.

References $gap_size.

                                 : int
     {
         return (int)$this->gap_size;
     }

◆ getItem()

assClozeGap::getItem ( $a_index )

Gets the item with a given index.

Gets the item with a given index

Parameters

integer $a_index Item index public

See also: $items

Returns: assAnswerCloze|null

Definition at line 282 of file class.assClozeGap.php.

Referenced by ilAssClozeTestFeedback\determineAnswerIndexForAnswerValue(), and numericRangeExists().

                                      : ?assAnswerCloze
     {
         if (array_key_exists($a_index, $this->items)) {
             return $this->items[$a_index];
         } else {
             return null;
         }
     }

Here is the caller graph for this function:

◆ getItemCount()

assClozeGap::getItemCount ( )

Gets the item count.

Gets the item count

Returns: integer The item count public

See also: $items

Definition at line 157 of file class.assClozeGap.php.

                                   : int
     {
         return count($this->items);
     }

◆ getItems()

assClozeGap::getItems	(	Transformation	$shuffler,
		?int	$gap_index = `null`
	)

Gets the items of a cloze gap.

Parameters

Transformation $shuffler

Returns: assAnswerCloze[] The list of items

Definition at line 116 of file class.assClozeGap.php.

References $items, getShuffle(), and ILIAS\Refinery\Transformation\transform().

Referenced by ilAssClozeTestFeedback\buildGapFeedbackLabel(), ilAssClozeTestFeedback\completeFbPropsForSelectGap(), ilAssClozeTestFeedback\completeFbPropsForTextGap(), ilAssClozeTestFeedback\determineAnswerIndexForAnswerValue(), getBestSolutionOutput(), ilAssClozeTestFeedback\initFbPropsForSelectGap(), ilAssClozeTestFeedback\initFbPropsForTextGap(), ilAssClozeTestFeedback\saveFbPropsForSelectGap(), and ilAssClozeTestFeedback\saveFbPropsForTextGap().

                                                                               : array
     {
         if (!$this->getShuffle()) {
             return $this->items;
         }
 
         if ($gap_index === null) {
             return $shuffler->transform($this->items);
         }
 
         $items = $this->items;
         for ($i = -2; $i < $gap_index; $i++) {
             $items = $shuffler->transform($items);
         }
 
         return $items;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getItemsRaw()

assClozeGap::getItemsRaw ( )

Gets the items of a cloze gap.

Gets the items of a cloze gap

Returns: array The list of items public

See also: $items

Definition at line 143 of file class.assClozeGap.php.

References $items.

Referenced by assClozeTestGUI\saveGapCorrectionFormProperty(), and assClozeTestGUI\saveTextOrSelectGapCorrectionFormProperty().

                                  : array
     {
         return $this->items;
     }

Here is the caller graph for this function:

◆ getMaxWidth()

assClozeGap::getMaxWidth ( )

Returns the maximum width of the gap.

Returns the maximum width of the gap

Returns: integer The maximum width of the gap defined by the longest answer public

Definition at line 334 of file class.assClozeGap.php.

                                  : int
     {
         $maxwidth = 0;
         foreach ($this->items as $item) {
             if (strlen($item->getAnswertext()) > $maxwidth) {
                 $maxwidth = strlen($item->getAnswertext());
             }
         }
         return $maxwidth;
     }

◆ getShuffle()

assClozeGap::getShuffle ( )

Gets the shuffle state of the items.

Returns: boolean Shuffle state

Definition at line 321 of file class.assClozeGap.php.

References $shuffle.

Referenced by getItems().

                                 : bool
     {
         return $this->shuffle;
     }

Here is the caller graph for this function:

◆ getType()

assClozeGap::getType ( )

See also: $type for mapping.

Definition at line 78 of file class.assClozeGap.php.

References $type.

Referenced by ilAssClozeTestFeedback\determineAnswerIndexForAnswerValue(), getBestSolutionOutput(), numericRangeExists(), and assClozeTestGUI\saveGapCorrectionFormProperty().

                              : int
     {
         return $this->type;
     }

Here is the caller graph for this function:

◆ isNumericGap()

assClozeGap::isNumericGap ( )

Definition at line 93 of file class.assClozeGap.php.

                                   : bool
     {
         return $this->type === self::TYPE_NUMERIC;
     }

◆ isSelectGap()

assClozeGap::isSelectGap ( )

Definition at line 88 of file class.assClozeGap.php.

                                  : bool
     {
         return $this->type === self::TYPE_SELECT;
     }

◆ isTextGap()

assClozeGap::isTextGap ( )

Definition at line 83 of file class.assClozeGap.php.

                                : bool
     {
         return $this->type === self::TYPE_TEXT;
     }

◆ numericRangeExists()

assClozeGap::numericRangeExists ( )

Definition at line 433 of file class.assClozeGap.php.

References CLOZE_NUMERIC, getItem(), and getType().

Referenced by ilAssClozeTestFeedback\completeFbPropsForNumericGap(), ilAssClozeTestFeedback\initFbPropsForNumericGap(), and ilAssClozeTestFeedback\saveFbPropsForNumericGap().

                                         : bool
     {
         if ($this->getType() != CLOZE_NUMERIC) {
             return false;
         }
 
         $math = new EvalMath();
 
         $item = $this->getItem(0);
         $lowerBound = $math->evaluate($item->getLowerBound());
         $upperBound = $math->evaluate($item->getUpperBound());
         $preciseValue = $math->evaluate($item->getAnswertext());
 
         if ($lowerBound < $preciseValue || $upperBound > $preciseValue) {
             return true;
         }
 
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setGapSize()

assClozeGap::setGapSize ( int $gap_size )

Definition at line 420 of file class.assClozeGap.php.

References $gap_size.

                                              : void
     {
         $this->gap_size = $gap_size;
     }

◆ setItemLowerBound()

assClozeGap::setItemLowerBound	(	$order,
		$bound
	)

Sets the lower bound for a given item.

Sets the lower bound for a given item

Parameters

integer	$order	Order of the item
double	$bound	Lower bounds of the item public

See also: $items

Definition at line 244 of file class.assClozeGap.php.

References ILIAS\LTI\ToolProvider\$key.

                                                      : void
     {
         foreach ($this->items as $key => $item) {
             if ($item->getOrder() == $order) {
                 $item->setLowerBound($bound);
             }
         }
     }

◆ setItemPoints()

assClozeGap::setItemPoints	(	$order,
		$points
	)

Sets the points for a given item.

Sets the points for a given item

Parameters

integer	$order	Order of the item
double	$points	Points of the item public

See also: $items

Definition at line 204 of file class.assClozeGap.php.

References ILIAS\LTI\ToolProvider\$key.

                                                   : void
     {
         foreach ($this->items as $key => $item) {
             if ($item->getOrder() == $order) {
                 $item->setPoints($points);
             }
         }
     }

◆ setItemUpperBound()

assClozeGap::setItemUpperBound	(	$order,
		$bound
	)

Sets the upper bound for a given item.

Sets the upper bound for a given item

Parameters

integer	$order	Order of the item
double	$bound	Upper bound of the item public

See also: $items

Definition at line 263 of file class.assClozeGap.php.

References ILIAS\LTI\ToolProvider\$key.

                                                      : void
     {
         foreach ($this->items as $key => $item) {
             if ($item->getOrder() == $order) {
                 $item->setUpperBound($bound);
             }
         }
     }

◆ setShuffle()

assClozeGap::setShuffle ( $a_shuffle = true )

Sets the shuffle state of the items.

Sets the shuffle state of the items

Parameters

boolean $a_shuffle Shuffle state

Definition at line 311 of file class.assClozeGap.php.

                                                  : void
     {
         $this->shuffle = (bool) $a_shuffle;
     }

◆ setType()

assClozeGap::setType ( $a_type = 0 )

Sets the cloze gap type.

Parameters

integer $a_type cloze gap type

See also: $type for mapping.

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

                                         : void
     {
         $this->type = $a_type;
     }

Field Documentation

◆ $gap_size

assClozeGap::$gap_size = 0

private

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

Referenced by getGapSize(), and setGapSize().

◆ $items

assClozeGap::$items

Definition at line 51 of file class.assClozeGap.php.

Referenced by getItems(), and getItemsRaw().

◆ $shuffle

assClozeGap::$shuffle

Definition at line 58 of file class.assClozeGap.php.

Referenced by getShuffle().

◆ $shuffler

Transformation assClozeGap::$shuffler = null

private

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

◆ $type

int assClozeGap::$type

Definition at line 42 of file class.assClozeGap.php.

Referenced by getType().

◆ TYPE_NUMERIC

const assClozeGap::TYPE_NUMERIC = 2

Definition at line 39 of file class.assClozeGap.php.

Referenced by ilAssClozeTestFeedback\completeFormPropsForFeedbackModeGapAnswers(), ilAssClozeTestFeedback\initFeedbackFieldsPerGapAnswers(), and ilAssClozeTestFeedback\saveFeedbackFieldsPerGapAnswers().

◆ TYPE_SELECT

const assClozeGap::TYPE_SELECT = 1

Definition at line 38 of file class.assClozeGap.php.

Referenced by ilAssClozeTestFeedback\completeFormPropsForFeedbackModeGapAnswers(), ilAssClozeTestFeedback\initFeedbackFieldsPerGapAnswers(), and ilAssClozeTestFeedback\saveFeedbackFieldsPerGapAnswers().

◆ TYPE_TEXT

const assClozeGap::TYPE_TEXT = 0

Definition at line 37 of file class.assClozeGap.php.

Referenced by ilAssClozeTestFeedback\completeFormPropsForFeedbackModeGapAnswers(), assClozeTestGUI\getSpecificFeedbackOutput(), ilAssClozeTestFeedback\initFeedbackFieldsPerGapAnswers(), and ilAssClozeTestFeedback\saveFeedbackFieldsPerGapAnswers().

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

Modules/TestQuestionPool/classes/class.assClozeGap.php

Public Member Functions

Data Fields

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addItem()

◆ clearItems()

◆ deleteItem()

◆ getBestSolutionIndexes()

◆ getBestSolutionOutput()

◆ getGapSize()

◆ getItem()

◆ getItemCount()

◆ getItems()

◆ getItemsRaw()

◆ getMaxWidth()

◆ getShuffle()

◆ getType()

◆ isNumericGap()

◆ isSelectGap()

◆ isTextGap()

◆ numericRangeExists()

◆ setGapSize()

◆ setItemLowerBound()

◆ setItemPoints()

◆ setItemUpperBound()

◆ setShuffle()

◆ setType()

Field Documentation

◆ $gap_size

◆ $items

◆ $shuffle

◆ $shuffler

◆ $type

◆ TYPE_NUMERIC

◆ TYPE_SELECT

◆ TYPE_TEXT