Class for cloze question gaps. More...

Inheritance diagram for assClozeGap:

Collaboration diagram for assClozeGap:

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

	getType ()
	Gets the cloze gap type. More...

	isTextGap ()

	isSelectGap ()

	isNumericGap ()

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

	getItems (ilArrayElementShuffler $shuffler, ?int $gap_index=null)

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

	setShuffler (ilArrayElementShuffler $shuffler=null)

	getShuffler ()

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

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

	getBestSolutionOutput (ilArrayElementShuffler $shuffler, $combinations=null)

	setGapSize ($gap_size)

	getGapSize ()

	numericRangeExists ()

Data Fields
const	TYPE_TEXT = 0

const	TYPE_SELECT = 1

const	TYPE_NUMERIC = 2

	$type
	Type of gap. More...

	$items

	$shuffle

Private Attributes
	$shuffler

	$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 18 of file class.assClozeGap.php.

Constructor & Destructor Documentation

◆ __construct()

assClozeGap::__construct ( $a_type )

assClozeGap constructor

Parameters

int $a_type

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

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

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 163 of file class.assClozeGap.php.

References $i.

     {
         $order = $a_item->getOrder();
         if (array_key_exists($order, $this->items)) {
             $newitems = array();
             for ($i = 0; $i < $order; $i++) {
                 array_push($newitems, $this->items[$i]);
             }
             array_push($newitems, $a_item);
             for ($i = $order; $i < count($this->items); $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 289 of file class.assClozeGap.php.

     {
         $this->items = array();
     }

◆ 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 214 of file class.assClozeGap.php.

     {
         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 370 of file class.assClozeGap.php.

References $keys.

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

◆ getBestSolutionOutput()

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

Parameters

ilArrayElementShuffler	$shuffler
null \| array	$combinations

Returns: string

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

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

     {
         global $DIC;
         $lng = $DIC['lng'];
         switch ($this->getType()) {
             case CLOZE_TEXT:
             case CLOZE_SELECT:
                 $best_solutions = array();
                 if ($combinations !== null && $combinations['best_solution'] == 1) {
                     $best_solutions[$combinations['points']] = array();
                     array_push($best_solutions[$combinations['points']], $combinations['answer']);
                 } else {
                     foreach ($this->getItems($shuffler) as $answer) {
                         if (isset($best_solutions[$answer->getPoints()]) && is_array($best_solutions[$answer->getPoints()])) {
                             array_push($best_solutions[$answer->getPoints()], $answer->getAnswertext());
                         } else {
                             $best_solutions[$answer->getPoints()] = array();
                             array_push($best_solutions[$answer->getPoints()], $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 446 of file class.assClozeGap.php.

References $gap_size.

     {
         return $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 272 of file class.assClozeGap.php.

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

     {
         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 149 of file class.assClozeGap.php.

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

◆ getItems()

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

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

References $i, $items, getShuffle(), and ilArrayElementShuffler\shuffle().

Referenced by 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->shuffle($this->items);
         }
 
         $items = $this->items;
         for ($i = -2; $i < $gap_index; $i++) {
             $items = $shuffler->shuffle($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 135 of file class.assClozeGap.php.

References $items.

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

     {
         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 351 of file class.assClozeGap.php.

     {
         $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 311 of file class.assClozeGap.php.

References $shuffle.

Referenced by getItems().

     {
         return $this->shuffle;
     }

Here is the caller graph for this function:

◆ getShuffler()

assClozeGap::getShuffler ( )

Returns: ilArrayElementShuffler

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

References $shuffler, and setShuffler().

                                   : ilArrayElementShuffler
     {
         if ($this->shuffler == null) {
             $this->setShuffler();
         }
         return $this->shuffler;
     }

Here is the call graph for this function:

◆ getType()

assClozeGap::getType ( )

Gets the cloze gap type.

Gets the cloze gap type

Returns: integer cloze gap type

See also: $type for mapping.

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

References $type.

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

     {
         return $this->type;
     }

Here is the caller graph for this function:

◆ isNumericGap()

assClozeGap::isNumericGap ( )

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

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

◆ isSelectGap()

assClozeGap::isSelectGap ( )

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

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

◆ isTextGap()

assClozeGap::isTextGap ( )

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

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

◆ numericRangeExists()

assClozeGap::numericRangeExists ( )

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

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

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

     {
         if ($this->getType() != CLOZE_NUMERIC) {
             return false;
         }
 
         require_once 'Services/Math/classes/class.EvalMath.php';
         $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 ( $gap_size )

Parameters

integer $gap_size

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

References $gap_size.

     {
         $this->gap_size = $gap_size;
     }

◆ setItemLowerBound()

assClozeGap::setItemLowerBound	(	$order,
		$bound
	)

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 234 of file class.assClozeGap.php.

     {
         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 196 of file class.assClozeGap.php.

     {
         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 253 of file class.assClozeGap.php.

     {
         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 301 of file class.assClozeGap.php.

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

◆ setShuffler()

assClozeGap::setShuffler ( ilArrayElementShuffler $shuffler = null )

Parameters

ilArrayElementShuffler $shuffler

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

References $shuffler.

Referenced by getShuffler().

     {
         if ($shuffler == null) {
             require_once 'Services/Randomization/classes/class.ilArrayElementShuffler.php';
             $shuffler = new ilArrayElementShuffler();
             $seed = $shuffler->buildRandomSeed();
             $shuffler->setSeed($seed);
         }
         $this->shuffler = $shuffler;
     }

Here is the caller graph for this function:

◆ 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 103 of file class.assClozeGap.php.

     {
         $this->type = $a_type;
     }

Field Documentation

◆ $gap_size

assClozeGap::$gap_size = 0

private

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

Referenced by getGapSize(), and setGapSize().

◆ $items

assClozeGap::$items

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

Referenced by getItems(), and getItemsRaw().

◆ $shuffle

assClozeGap::$shuffle

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

Referenced by getShuffle().

◆ $shuffler

assClozeGap::$shuffler

private

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

Referenced by getShuffler(), and setShuffler().

◆ $type

int assClozeGap::$type

Type of gap.

An integer value indicating the type of the gap 0 == text gap, 1 == select gap, 2 == numeric gap

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

Referenced by getType().

◆ TYPE_NUMERIC

const assClozeGap::TYPE_NUMERIC = 2

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

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

◆ TYPE_SELECT

const assClozeGap::TYPE_SELECT = 1

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

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

◆ TYPE_TEXT

const assClozeGap::TYPE_TEXT = 0

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

Referenced by ilAssClozeTestFeedback\completeFormPropsForFeedbackModeGapAnswers(), 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()

◆ getShuffler()

◆ getType()

◆ isNumericGap()

◆ isSelectGap()

◆ isTextGap()

◆ numericRangeExists()

◆ setGapSize()

◆ setItemLowerBound()

◆ setItemPoints()

◆ setItemUpperBound()

◆ setShuffle()

◆ setShuffler()

◆ setType()

Field Documentation

◆ $gap_size

◆ $items

◆ $shuffle

◆ $shuffler

◆ $type

◆ TYPE_NUMERIC

◆ TYPE_SELECT

◆ TYPE_TEXT