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

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

	getItems (ilArrayElementShuffler $shuffler)
	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 (ilArrayElementShuffler $shuffler, $combinations=null)

	setGapSize ($gap_size)

	getGapSize ()

Data Fields
	$type
	Type of gap. More...

	$items

	$shuffle

Private Attributes
	$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 55 of file class.assClozeGap.php.

References $a_type, and array.

     {
         $this->type = $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 140 of file class.assClozeGap.php.

References $i, and array.

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

References array.

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

References $key.

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

References $key, $keys, and array.

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

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

     {
         global $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 396 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

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

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

◆ getItemCount()

assClozeGap::getItemCount ( )

Gets the item count.

Gets the item count

Returns: integer The item count public

See also: $items

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

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

◆ getItems()

assClozeGap::getItems ( ilArrayElementShuffler $shuffler )

Gets the items of a cloze gap.

Parameters

ilArrayElementShuffler $shuffler

Returns: array The list of items

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

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

Referenced by getBestSolutionOutput().

     {
         if ($this->getShuffle()) {
             return $shuffler->shuffle($this->items);
         }
         
         return $this->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 112 of file class.assClozeGap.php.

References $items.

     {
         return $this->items;
     }

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

References $shuffle.

Referenced by getItems().

     {
         return $this->shuffle;
     }

Here is the caller 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 71 of file class.assClozeGap.php.

References $type.

Referenced by getBestSolutionOutput().

     {
         return $this->type;
     }

Here is the caller graph for this function:

◆ setGapSize()

assClozeGap::setGapSize ( $gap_size )

Parameters

integer $gap_size

Definition at line 388 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.

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

References $key.

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

References $key.

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

References $key.

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

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

References $a_type.

     {
         $this->type = $a_type;
     }

Field Documentation

◆ $gap_size

assClozeGap::$gap_size = 0

private

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

Referenced by getGapSize(), and setGapSize().

◆ $items

assClozeGap::$items

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

Referenced by getItems(), and getItemsRaw().

◆ $shuffle

assClozeGap::$shuffle

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

Referenced by getShuffle().

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

Referenced by getType().

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()

◆ setGapSize()

◆ setItemLowerBound()

◆ setItemPoints()

◆ setItemUpperBound()

◆ setShuffle()

◆ setType()

Field Documentation

◆ $gap_size

◆ $items

◆ $shuffle

◆ $type