Inheritance diagram for ilAssOrderingElementList:

Collaboration diagram for ilAssOrderingElementList:

Public Member Functions
	__construct (int $question_id=null, array $elements=[])
	ilAssOrderingElementList constructor. More...

	__clone ()
	clone list by additionally cloning the element objects More...

	getClone ()

	getQuestionId ()

	setQuestionId ($question_id)

	countElements ()

	hasElements ()

	isFirstElementPosition ($position)

	isLastElementPosition ($position)

	moveElementByPositions ($currentPosition, $targetPosition)

	removeElement (ilAssOrderingElement $removeElement)

	resetElements ()
	resets elements More...

	setElements ($elements)

	getElements ()

	getRandomIdentifierIndexedElements ()

	getRandomIdentifierIndex ()

	getSolutionIdentifierIndexedElements ()

	getSolutionIdentifierIndex ()

	addElement (ilAssOrderingElement $element)

	getElementByPosition ($position)

	elementExistByPosition ($position)

	getElementByRandomIdentifier ($randomIdentifier)

	elementExistByRandomIdentifier ($randomIdentifier)

	getElementBySolutionIdentifier ($solutionIdentifier)

	elementExistBySolutionIdentifier ($solutionIdentifier)

	ensureValidIdentifiers (ilAssOrderingElement $element)

	distributeNewRandomIdentifiers ()

	hasSameElementSetByRandomIdentifiers (self $otherList)

	getParityTrueElementList (self $otherList)

	reorderByRandomIdentifiers ($randomIdentifiers)

	resetElementsIndentations ()
	resets the indentation to level 0 for all elements in list More...

	getDifferenceElementList (self $otherElementList)

	completeContentsFromElementList (self $otherList)

	current ()

	next ()

	key ()

	valid ()

	rewind ()

	getHash ()

	withElements (array $elements)

	withQuestionId (int $question_id)

Static Public Member Functions
static	isValidSolutionIdentifier ($identifier)

static	isValidRandomIdentifier ($identifier)

static	isValidPosition ($position)

static	isValidIndentation ($indentation)

static	getFallbackDefaultElement ()

static	buildInstance (int $question_id, array $elements=[])

Data Fields
	$objectInstanceId

const	SOLUTION_IDENTIFIER_BUILD_MAX_TRIES = 1000

const	SOLUTION_IDENTIFIER_VALUE_INTERVAL = 1

const	SOLUTION_IDENTIFIER_START_VALUE = 0

const	RANDOM_IDENTIFIER_BUILD_MAX_TRIES = 1000

const	RANDOM_IDENTIFIER_RANGE_LOWER_BOUND = 1

const	RANDOM_IDENTIFIER_RANGE_UPPER_BOUND = 100000

const	FALLBACK_DEFAULT_ELEMENT_RANDOM_IDENTIFIER = 0

const	JS_ADDED_ELEMENTS_RANDOM_IDENTIFIER_START_VALUE = -1

const	JS_ADDED_ELEMENTS_RANDOM_IDENTIFIER_VALUE_INTERVAL = -1

const	IDENTIFIER_TYPE_SOLUTION = 'SolutionIds'

const	IDENTIFIER_TYPE_RANDOM = 'RandomIds'

Static Public Attributes
static	$objectInstanceCounter = 0

Protected Member Functions
	getIndexedElements ($identifierType)

	getRegisteredSolutionIdentifiers ()

	getRegisteredRandomIdentifiers ()

	getRegisteredIdentifiers ($identifierType)

	hasValidIdentifiers (ilAssOrderingElement $element)

	ensureValidIdentifier (ilAssOrderingElement $element, $identifierType)

	registerIdentifiers (ilAssOrderingElement $element)

	registerIdentifier (ilAssOrderingElement $element, $identifierType)

	isIdentifierRegistered (ilAssOrderingElement $element, $identifierType)

	fetchIdentifier (ilAssOrderingElement $element, string $identifierType)

	populateIdentifier (ilAssOrderingElement $element, $identifierType, $identifier)

	isValidIdentifier ($identifierType, $identifier)
	PhpInconsistentReturnPointsInspection More...

	buildIdentifier ($identifierType)

	throwUnknownIdentifierTypeException ($identifierType)

	throwCouldNotBuildRandomIdentifierException ($maxTries)

	throwMissingReorderPositionException ($randomIdentifier)

	throwUnknownRandomIdentifiersException ($randomIdentifiers)

	getLastSolutionIdentifier ()

	buildSolutionIdentifier ()

	buildRandomIdentifier ()

	getDifferenceRandomIdentifierIndex (self $otherElementList)

Protected Attributes
	$question_id

	$elements = array()

Static Protected Attributes
static	$identifierRegistry

Detailed Description

Definition at line 25 of file class.ilAssOrderingElementList.php.

Constructor & Destructor Documentation

◆ __construct()

ilAssOrderingElementList::__construct	(	int	$question_id = `null`,
		array	$elements = `[]`
	)

ilAssOrderingElementList constructor.

Parameters

ilAssOrderingElement[] $elements

Definition at line 67 of file class.ilAssOrderingElementList.php.

References $elements, and $question_id.

       {
         $this->objectInstanceId = ++self::$objectInstanceCounter;
 
         $this->question_id = $question_id;
         $this->elements = $elements;
     }

Member Function Documentation

◆ __clone()

ilAssOrderingElementList::__clone ( )

clone list by additionally cloning the element objects

Definition at line 80 of file class.ilAssOrderingElementList.php.

References $elements, and ILIAS\LTI\ToolProvider\$key.

     {
         $this->objectInstanceId = ++self::$objectInstanceCounter;
 
         $elements = array();
 
         foreach ($this as $key => $element) {
             $elements[$key] = clone $element;
         }
 
         $this->elements = $elements;
     }

◆ addElement()

ilAssOrderingElementList::addElement ( ilAssOrderingElement $element )

Parameters

ilAssOrderingElement $element

Definition at line 260 of file class.ilAssOrderingElementList.php.

References hasValidIdentifiers(), and registerIdentifiers().

Referenced by setElements().

                                                              : void
     {
         if ($this->hasValidIdentifiers($element)) {
             $this->registerIdentifiers($element);
         }
 
         $this->elements[] = $element;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildIdentifier()

ilAssOrderingElementList::buildIdentifier ( $identifierType )

protected

Definition at line 509 of file class.ilAssOrderingElementList.php.

References buildRandomIdentifier(), buildSolutionIdentifier(), and throwUnknownIdentifierTypeException().

Referenced by ensureValidIdentifier().

                                                        : int
     {
         switch ($identifierType) {
             case self::IDENTIFIER_TYPE_SOLUTION:
                 return $this->buildSolutionIdentifier();
             default:
             case self::IDENTIFIER_TYPE_RANDOM:
                 return $this->buildRandomIdentifier();
         }
 
         $this->throwUnknownIdentifierTypeException($identifierType);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildInstance()

static ilAssOrderingElementList::buildInstance	(	int	$question_id,
		array	$elements = `[]`
	)

static

Definition at line 848 of file class.ilAssOrderingElementList.php.

References $elements, and setQuestionId().

Referenced by assOrderingQuestion\fetchSolutionListFromFormSubmissionData(), ilAssOrderingImagesInputGUI\getElementList(), ilAssOrderingTextsInputGUI\getElementList(), and ilAssNestedOrderingElementsInputGUI\getElementList().

                                                                                 : ilAssOrderingElementList
     {
         $elementList = new self();
 
         $elementList->setQuestionId($question_id);
         $elementList->setElements($elements);
 
         return $elementList;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildRandomIdentifier()

ilAssOrderingElementList::buildRandomIdentifier ( )

protected

Returns: int $randomIdentifier

Exceptions

ilTestQuestionPoolException

Definition at line 605 of file class.ilAssOrderingElementList.php.

References isIdentifierRegistered(), and throwCouldNotBuildRandomIdentifierException().

Referenced by buildIdentifier(), and distributeNewRandomIdentifiers().

                                               : int
     {
         $usedTriesCounter = 0;
 
         do {
             if ($usedTriesCounter >= self::RANDOM_IDENTIFIER_BUILD_MAX_TRIES) {
                 $this->throwCouldNotBuildRandomIdentifierException(self::RANDOM_IDENTIFIER_BUILD_MAX_TRIES);
             }
 
             $usedTriesCounter++;
 
             $lowerBound = self::RANDOM_IDENTIFIER_RANGE_LOWER_BOUND;
             $upperBound = self::RANDOM_IDENTIFIER_RANGE_UPPER_BOUND;
             $randomIdentifier = mt_rand($lowerBound, $upperBound);
 
             $testElement = new ilAssOrderingElement();
             $testElement->setRandomIdentifier($randomIdentifier);
         } while ($this->isIdentifierRegistered($testElement, self::IDENTIFIER_TYPE_RANDOM));
 
         return $randomIdentifier;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildSolutionIdentifier()

ilAssOrderingElementList::buildSolutionIdentifier ( )

protected

Returns: integer|null $nextSolutionIdentifier

Definition at line 588 of file class.ilAssOrderingElementList.php.

References getLastSolutionIdentifier().

Referenced by buildIdentifier().

                                                 : ?int
     {
         $lastSolutionIdentifier = $this->getLastSolutionIdentifier();
 
         if ($lastSolutionIdentifier === null) {
             return 0;
         }
 
         $nextSolutionIdentifier = $lastSolutionIdentifier + self::SOLUTION_IDENTIFIER_VALUE_INTERVAL;
 
         return $nextSolutionIdentifier;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ completeContentsFromElementList()

ilAssOrderingElementList::completeContentsFromElementList ( self $otherList )

Parameters

ilAssOrderingElementList $otherList

Definition at line 781 of file class.ilAssOrderingElementList.php.

                                                                     : void
     {
         foreach ($this as $thisElement) {
             if (!$otherList->elementExistByRandomIdentifier($thisElement->getRandomIdentifier())) {
                 continue;
             }
 
             $otherElement = $otherList->getElementByRandomIdentifier(
                 $thisElement->getRandomIdentifier()
             );
 
             $thisElement->setContent($otherElement->getContent());
         }
     }

◆ countElements()

ilAssOrderingElementList::countElements ( )

Definition at line 118 of file class.ilAssOrderingElementList.php.

Referenced by hasElements(), hasSameElementSetByRandomIdentifiers(), and isLastElementPosition().

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

Here is the caller graph for this function:

◆ current()

ilAssOrderingElementList::current ( )

Returns: ilAssOrderingElement

Definition at line 799 of file class.ilAssOrderingElementList.php.

                              : ilAssOrderingElement
     {
         return current($this->elements);
     }

◆ distributeNewRandomIdentifiers()

ilAssOrderingElementList::distributeNewRandomIdentifiers ( )

Definition at line 655 of file class.ilAssOrderingElementList.php.

References buildRandomIdentifier().

                                                     : void
     {
         foreach ($this as $element) {
             $element->setRandomIdentifier($this->buildRandomIdentifier());
         }
     }

Here is the call graph for this function:

◆ elementExistByPosition()

ilAssOrderingElementList::elementExistByPosition ( $position )

Parameters

$position

Returns: bool

Definition at line 286 of file class.ilAssOrderingElementList.php.

References getElementByPosition().

                                                      : bool
     {
         return ($this->getElementByPosition($position) !== null);
     }

Here is the call graph for this function:

◆ elementExistByRandomIdentifier()

ilAssOrderingElementList::elementExistByRandomIdentifier ( $randomIdentifier )

Parameters

$randomIdentifier

Returns: bool

Definition at line 310 of file class.ilAssOrderingElementList.php.

References getElementByRandomIdentifier().

                                                                      : bool
     {
         return ($this->getElementByRandomIdentifier($randomIdentifier) !== null);
     }

Here is the call graph for this function:

◆ elementExistBySolutionIdentifier()

ilAssOrderingElementList::elementExistBySolutionIdentifier ( $solutionIdentifier )

Parameters

$solutionIdentifier

Returns: bool

Definition at line 335 of file class.ilAssOrderingElementList.php.

References getElementBySolutionIdentifier().

                                                                          : bool
     {
         return ($this->getElementBySolutionIdentifier($solutionIdentifier) !== null);
     }

Here is the call graph for this function:

◆ ensureValidIdentifier()

ilAssOrderingElementList::ensureValidIdentifier	(	ilAssOrderingElement	$element,
			$identifierType
	)

protected

Parameters

ilAssOrderingElement	$element
string	$identifierType

Definition at line 405 of file class.ilAssOrderingElementList.php.

References buildIdentifier(), fetchIdentifier(), isValidIdentifier(), populateIdentifier(), and registerIdentifier().

Referenced by ensureValidIdentifiers().

                                                                                             : void
     {
         $identifier = $this->fetchIdentifier($element, $identifierType);
 
         if (!$this->isValidIdentifier($identifierType, $identifier)) {
             $identifier = $this->buildIdentifier($identifierType);
             $this->populateIdentifier($element, $identifierType, $identifier);
             $this->registerIdentifier($element, $identifierType);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ensureValidIdentifiers()

ilAssOrderingElementList::ensureValidIdentifiers ( ilAssOrderingElement $element )

Parameters

ilAssOrderingElement $element

Definition at line 393 of file class.ilAssOrderingElementList.php.

References ensureValidIdentifier().

Referenced by assOrderingQuestion\setOrderingElementList().

                                                                          : ilAssOrderingElement
     {
         //TODO: remove!
         $this->ensureValidIdentifier($element, self::IDENTIFIER_TYPE_SOLUTION);
         $this->ensureValidIdentifier($element, self::IDENTIFIER_TYPE_RANDOM);
         return $element;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fetchIdentifier()

ilAssOrderingElementList::fetchIdentifier	(	ilAssOrderingElement	$element,
		string	$identifierType
	)

protected

Exceptions

ilTestQuestionPoolException

Definition at line 467 of file class.ilAssOrderingElementList.php.

References ilAssOrderingElement\getRandomIdentifier(), ilAssOrderingElement\getSolutionIdentifier(), and throwUnknownIdentifierTypeException().

Referenced by ensureValidIdentifier(), getIndexedElements(), hasValidIdentifiers(), isIdentifierRegistered(), and registerIdentifier().

                                                                                              : ?int
     {
         if ($identifierType == self::IDENTIFIER_TYPE_SOLUTION) {
             return $element->getSolutionIdentifier();
         } else {
             return $element->getRandomIdentifier();
         }
 
         $this->throwUnknownIdentifierTypeException($identifierType);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getClone()

ilAssOrderingElementList::getClone ( )

Returns: ilAssOrderingElementList

Definition at line 96 of file class.ilAssOrderingElementList.php.

                               : ilAssOrderingElementList
     {
         $that = clone $this;
         return $that;
     }

◆ getDifferenceElementList()

ilAssOrderingElementList::getDifferenceElementList ( self $otherElementList )

Parameters

ilAssOrderingElementList $otherElementList

Returns: $differenceElementList ilAssOrderingElementList

Definition at line 749 of file class.ilAssOrderingElementList.php.

References getDifferenceRandomIdentifierIndex(), getElementByRandomIdentifier(), and getQuestionId().

                                                                     : ilAssOrderingElementList
     {
         $differenceRandomIdentifierIndex = $this->getDifferenceRandomIdentifierIndex($otherElementList);
 
         $differenceElementList = new self();
         $differenceElementList->setQuestionId($this->getQuestionId());
 
         foreach ($differenceRandomIdentifierIndex as $randomIdentifier) {
             $element = $this->getElementByRandomIdentifier($randomIdentifier);
             $differenceElementList->addElement($element);
         }
 
         return $differenceElementList;
     }

Here is the call graph for this function:

◆ getDifferenceRandomIdentifierIndex()

ilAssOrderingElementList::getDifferenceRandomIdentifierIndex ( self $otherElementList )

protected

Parameters

ilAssOrderingElementList $other

Returns: array

Definition at line 768 of file class.ilAssOrderingElementList.php.

References getRandomIdentifierIndex().

Referenced by getDifferenceElementList().

                                                                                  : array
     {
         $differenceRandomIdentifierIndex = array_diff(
             $this->getRandomIdentifierIndex(),
             $otherElementList->getRandomIdentifierIndex()
         );
 
         return $differenceRandomIdentifierIndex;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getElementByPosition()

ilAssOrderingElementList::getElementByPosition ( $position )

Parameters

$randomIdentifier

Returns: ilAssOrderingElement

Definition at line 273 of file class.ilAssOrderingElementList.php.

Referenced by assOrderingQuestion\calculateReachedPointsForSolution(), elementExistByPosition(), and moveElementByPositions().

                                                    : ?ilAssOrderingElement
     {
         if (isset($this->elements[$position])) {
             return $this->elements[$position];
         }
 
         return null;
     }

Here is the caller graph for this function:

◆ getElementByRandomIdentifier()

ilAssOrderingElementList::getElementByRandomIdentifier ( $randomIdentifier )

Parameters

$randomIdentifier

Returns: ilAssOrderingElement

Definition at line 295 of file class.ilAssOrderingElementList.php.

Referenced by elementExistByRandomIdentifier(), and getDifferenceElementList().

                                                                    : ?ilAssOrderingElement
     {
         foreach ($this as $element) {
             if ($element->getRandomIdentifier() === intval($randomIdentifier)) {
                 return $element;
             }
         }
 
         return null;
     }

Here is the caller graph for this function:

◆ getElementBySolutionIdentifier()

ilAssOrderingElementList::getElementBySolutionIdentifier ( $solutionIdentifier )

Parameters

$randomIdentifier

Returns: ilAssOrderingElement

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

Referenced by elementExistBySolutionIdentifier().

                                                                        : ?ilAssOrderingElement
     {
         foreach ($this as $element) {
             if ($element->getSolutionIdentifier() != $solutionIdentifier) {
                 continue;
             }
 
             return $element;
         }
         return null;
     }

Here is the caller graph for this function:

◆ getElements()

ilAssOrderingElementList::getElements ( )

Returns: ilAssOrderingElement[]

Definition at line 206 of file class.ilAssOrderingElementList.php.

References $elements.

Referenced by assOrderingQuestion\setOrderingElementList(), and ILIAS\TA\Questions\Ordering\assOrderingQuestionDatabaseRepository\updateOrderingList().

                                  : array
     {
         return $this->elements;
     }

Here is the caller graph for this function:

◆ getFallbackDefaultElement()

static ilAssOrderingElementList::getFallbackDefaultElement ( )

static

Returns: ilAssOrderingElement

Definition at line 839 of file class.ilAssOrderingElementList.php.

Referenced by ilAssOrderingDefaultElementFallback\manipulateFormInputValues().

                                                       : ilAssOrderingElement
     {
         $element = new ilAssOrderingElement();
         $element->setRandomIdentifier(self::FALLBACK_DEFAULT_ELEMENT_RANDOM_IDENTIFIER);
 
         return $element;
     }

Here is the caller graph for this function:

◆ getHash()

ilAssOrderingElementList::getHash ( )

Definition at line 858 of file class.ilAssOrderingElementList.php.

                              : string
     {
         $items = array();
 
         foreach ($this as $element) {
             $items[] = implode(':', array(
                 $element->getSolutionIdentifier(),
                 $element->getRandomIdentifier(),
                 $element->getIndentation()
             ));
         }
 
         return md5(serialize($items));
     }

◆ getIndexedElements()

ilAssOrderingElementList::getIndexedElements ( $identifierType )

protected

Returns: array

Definition at line 246 of file class.ilAssOrderingElementList.php.

References $elements, and fetchIdentifier().

Referenced by getRandomIdentifierIndexedElements(), and getSolutionIdentifierIndexedElements().

                                                           : array
     {
         $elements = array();
 
         foreach ($this as $element) {
             $elements[$this->fetchIdentifier($element, $identifierType)] = $element;
         }
 
         return $elements;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLastSolutionIdentifier()

ilAssOrderingElementList::getLastSolutionIdentifier ( )

protected

Returns: integer|null $lastSolutionIdentifier

Definition at line 570 of file class.ilAssOrderingElementList.php.

References getRegisteredSolutionIdentifiers().

Referenced by buildSolutionIdentifier().

                                                   : ?int
     {
         $lastSolutionIdentifier = null;
 
         foreach ($this->getRegisteredSolutionIdentifiers() as $registeredIdentifier) {
             if ($lastSolutionIdentifier > $registeredIdentifier) {
                 continue;
             }
 
             $lastSolutionIdentifier = $registeredIdentifier;
         }
 
         return $lastSolutionIdentifier;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getParityTrueElementList()

ilAssOrderingElementList::getParityTrueElementList ( self $otherList )

Definition at line 676 of file class.ilAssOrderingElementList.php.

References getQuestionId(), and hasSameElementSetByRandomIdentifiers().

                                                              : ilAssOrderingElementList
     {
         if (!$this->hasSameElementSetByRandomIdentifiers($otherList)) {
             throw new ilTestQuestionPoolException('cannot compare lists having different element sets');
         }
 
         $parityTrueElementList = new self();
         $parityTrueElementList->setQuestionId($this->getQuestionId());
 
         foreach ($this as $thisElement) {
             $otherElement = $otherList->getElementByRandomIdentifier(
                 $thisElement->getRandomIdentifier()
             );
 
             if ($otherElement->getPosition() != $thisElement->getPosition()) {
                 continue;
             }
 
             if ($otherElement->getIndentation() != $thisElement->getIndentation()) {
                 continue;
             }
 
             $parityTrueElementList->addElement($thisElement);
         }
 
         return $parityTrueElementList;
     }

Here is the call graph for this function:

◆ getQuestionId()

ilAssOrderingElementList::getQuestionId ( )

Returns: integer

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

References $question_id.

Referenced by getDifferenceElementList(), getParityTrueElementList(), getRegisteredIdentifiers(), isIdentifierRegistered(), moveElementByPositions(), registerIdentifier(), removeElement(), and ILIAS\TA\Questions\Ordering\assOrderingQuestionDatabaseRepository\updateOrderingList().

                                    : ?int
     {
         return $this->question_id;
     }

Here is the caller graph for this function:

◆ getRandomIdentifierIndex()

ilAssOrderingElementList::getRandomIdentifierIndex ( )

Returns: array

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

References getRandomIdentifierIndexedElements().

Referenced by getDifferenceRandomIdentifierIndex(), and hasSameElementSetByRandomIdentifiers().

                                               : array
     {
         return array_keys($this->getRandomIdentifierIndexedElements());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRandomIdentifierIndexedElements()

ilAssOrderingElementList::getRandomIdentifierIndexedElements ( )

Returns: array

Definition at line 214 of file class.ilAssOrderingElementList.php.

References getIndexedElements().

Referenced by getRandomIdentifierIndex(), ilAssOrderingImagesInputGUI\setElementList(), ilAssOrderingTextsInputGUI\setElementList(), and ilAssNestedOrderingElementsInputGUI\setElementList().

                                                         : array
     {
         return $this->getIndexedElements(self::IDENTIFIER_TYPE_RANDOM);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRegisteredIdentifiers()

ilAssOrderingElementList::getRegisteredIdentifiers ( $identifierType )

protected

Parameters

string $identifierType

Returns: array

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

References getQuestionId().

Referenced by getRegisteredRandomIdentifiers(), and getRegisteredSolutionIdentifiers().

                                                                 : array
     {
         if (!isset(self::$identifierRegistry[$identifierType][$this->getQuestionId()])) {
             return array();
         }
 
         return self::$identifierRegistry[$identifierType][$this->getQuestionId()];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRegisteredRandomIdentifiers()

ilAssOrderingElementList::getRegisteredRandomIdentifiers ( )

protected

Returns: array

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

References getRegisteredIdentifiers().

                                                        : array
     {
         return $this->getRegisteredIdentifiers(self::IDENTIFIER_TYPE_RANDOM);
     }

Here is the call graph for this function:

◆ getRegisteredSolutionIdentifiers()

ilAssOrderingElementList::getRegisteredSolutionIdentifiers ( )

protected

Returns: array

Definition at line 343 of file class.ilAssOrderingElementList.php.

References getRegisteredIdentifiers().

Referenced by getLastSolutionIdentifier().

                                                          : array
     {
         return $this->getRegisteredIdentifiers(self::IDENTIFIER_TYPE_SOLUTION);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSolutionIdentifierIndex()

ilAssOrderingElementList::getSolutionIdentifierIndex ( )

Returns: array

Definition at line 238 of file class.ilAssOrderingElementList.php.

References getSolutionIdentifierIndexedElements().

                                                 : array
     {
         return array_keys($this->getSolutionIdentifierIndexedElements());
     }

Here is the call graph for this function:

◆ getSolutionIdentifierIndexedElements()

ilAssOrderingElementList::getSolutionIdentifierIndexedElements ( )

Returns: array

Definition at line 230 of file class.ilAssOrderingElementList.php.

References getIndexedElements().

Referenced by getSolutionIdentifierIndex().

                                                           : array
     {
         return $this->getIndexedElements(self::IDENTIFIER_TYPE_SOLUTION);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasElements()

ilAssOrderingElementList::hasElements ( )

Definition at line 123 of file class.ilAssOrderingElementList.php.

References countElements().

                                  : bool
     {
         return (bool) $this->countElements();
     }

Here is the call graph for this function:

◆ hasSameElementSetByRandomIdentifiers()

ilAssOrderingElementList::hasSameElementSetByRandomIdentifiers ( self $otherList )

Parameters

ilAssOrderingElementList $otherList

Definition at line 665 of file class.ilAssOrderingElementList.php.

References countElements(), and getRandomIdentifierIndex().

Referenced by getParityTrueElementList().

                                                                          : bool
     {
         $numIntersectingElements = count(array_intersect(
             $otherList->getRandomIdentifierIndex(),
             $this->getRandomIdentifierIndex()
         ));
 
         return $numIntersectingElements == $this->countElements()
             && $numIntersectingElements == $otherList->countElements();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasValidIdentifiers()

ilAssOrderingElementList::hasValidIdentifiers ( ilAssOrderingElement $element )

protected

Parameters

ilAssOrderingElement $element

Returns: bool

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

References fetchIdentifier(), and isValidIdentifier().

Referenced by addElement().

                                                                          : bool
     {
         $identifier = $this->fetchIdentifier($element, self::IDENTIFIER_TYPE_SOLUTION);
 
         if (!$this->isValidIdentifier(self::IDENTIFIER_TYPE_SOLUTION, $identifier)) {
             return false;
         }
 
         $identifier = $this->fetchIdentifier($element, self::IDENTIFIER_TYPE_RANDOM);
 
         if (!$this->isValidIdentifier(self::IDENTIFIER_TYPE_RANDOM, $identifier)) {
             return false;
         }
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isFirstElementPosition()

ilAssOrderingElementList::isFirstElementPosition ( $position )

Definition at line 128 of file class.ilAssOrderingElementList.php.

                                                      : bool
     {
         return $position == 0;
     }

◆ isIdentifierRegistered()

ilAssOrderingElementList::isIdentifierRegistered	(	ilAssOrderingElement	$element,
			$identifierType
	)

protected

Parameters

ilAssOrderingElement	$element
string	$identifierType

Returns: bool

Exceptions

ilTestQuestionPoolException

Definition at line 449 of file class.ilAssOrderingElementList.php.

References fetchIdentifier(), and getQuestionId().

Referenced by buildRandomIdentifier().

                                                                                              : bool
     {
         if (!isset(self::$identifierRegistry[$identifierType][$this->getQuestionId()])) {
             return false;
         }
 
         $identifier = $this->fetchIdentifier($element, $identifierType);
 
         if (!in_array($identifier, self::$identifierRegistry[$identifierType][$this->getQuestionId()])) {
             return false;
         }
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isLastElementPosition()

ilAssOrderingElementList::isLastElementPosition ( $position )

Definition at line 133 of file class.ilAssOrderingElementList.php.

References countElements().

                                                     : bool
     {
         return $position == ($this->countElements() - 1);
     }

Here is the call graph for this function:

◆ isValidIdentifier()

ilAssOrderingElementList::isValidIdentifier	(	$identifierType,
		$identifier
	)

protected

PhpInconsistentReturnPointsInspection

Definition at line 496 of file class.ilAssOrderingElementList.php.

References throwUnknownIdentifierTypeException().

Referenced by ensureValidIdentifier(), and hasValidIdentifiers().

     {
         switch ($identifierType) {
             case self::IDENTIFIER_TYPE_SOLUTION:
                 return self::isValidSolutionIdentifier($identifier);
 
             case self::IDENTIFIER_TYPE_RANDOM:
                 return self::isValidRandomIdentifier($identifier);
         }
 
         $this->throwUnknownIdentifierTypeException($identifierType);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isValidIndentation()

static ilAssOrderingElementList::isValidIndentation ( $indentation )

static

Definition at line 647 of file class.ilAssOrderingElementList.php.

Referenced by ilAssOrderingElement\isExportIdent().

                                                            : bool
     {
         return self::isValidPosition($indentation); // horizontal position ^^
     }

Here is the caller graph for this function:

◆ isValidPosition()

static ilAssOrderingElementList::isValidPosition ( $position )

static

Definition at line 642 of file class.ilAssOrderingElementList.php.

Referenced by ilAssOrderingElement\isExportIdent().

                                                      : bool
     {
         return self::isValidSolutionIdentifier($position); // this was the position earlier
     }

Here is the caller graph for this function:

◆ isValidRandomIdentifier()

static ilAssOrderingElementList::isValidRandomIdentifier ( $identifier )

static

Definition at line 634 of file class.ilAssOrderingElementList.php.

References ILIAS\Repository\int().

Referenced by ilAssOrderingElement\isExportIdent().

                                                                : bool
     {
         return is_numeric($identifier)
             && $identifier == (int) $identifier
             && (int) $identifier >= self::RANDOM_IDENTIFIER_RANGE_LOWER_BOUND
             && (int) $identifier <= self::RANDOM_IDENTIFIER_RANGE_UPPER_BOUND;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isValidSolutionIdentifier()

static ilAssOrderingElementList::isValidSolutionIdentifier ( $identifier )

static

Definition at line 627 of file class.ilAssOrderingElementList.php.

References ILIAS\Repository\int().

Referenced by ilAssOrderingElement\isExportIdent().

                                                                  : bool
     {
         return is_numeric($identifier)
             && $identifier == (int) $identifier
             && (int) $identifier >= 0;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ key()

ilAssOrderingElementList::key ( )

Returns: integer|bool

Definition at line 815 of file class.ilAssOrderingElementList.php.

Referenced by valid().

     {
         return key($this->elements);
     }

Here is the caller graph for this function:

◆ moveElementByPositions()

ilAssOrderingElementList::moveElementByPositions	(	$currentPosition,
		$targetPosition
	)

Definition at line 138 of file class.ilAssOrderingElementList.php.

References getElementByPosition(), getQuestionId(), and setElements().

                                                                              : void
     {
         $movingElement = $this->getElementByPosition($currentPosition);
         $dodgingElement = $this->getElementByPosition($targetPosition);
 
         $elementList = new self();
         $elementList->setQuestionId($this->getQuestionId());
 
         foreach ($this as $element) {
             if ($element->getPosition() == $currentPosition) {
                 $elementList->addElement($dodgingElement);
                 continue;
             }
 
             if ($element->getPosition() == $targetPosition) {
                 $elementList->addElement($movingElement);
                 continue;
             }
 
             $elementList->addElement($element);
         }
 
         $dodgingElement->setPosition($currentPosition);
         $movingElement->setPosition($targetPosition);
 
         $this->setElements($elementList->getElements());
     }

Here is the call graph for this function:

◆ next()

ilAssOrderingElementList::next ( )

Returns: ilAssOrderingElement|false

Definition at line 807 of file class.ilAssOrderingElementList.php.

     {
         return next($this->elements);
     }

◆ populateIdentifier()

ilAssOrderingElementList::populateIdentifier	(	ilAssOrderingElement	$element,
			$identifierType,
			$identifier
	)

protected

Parameters

ilAssOrderingElement	$element
string	$identifierType
	$identifier

Exceptions

ilTestQuestionPoolException

Definition at line 484 of file class.ilAssOrderingElementList.php.

References ilAssOrderingElement\setRandomIdentifier(), ilAssOrderingElement\setSolutionIdentifier(), and throwUnknownIdentifierTypeException().

Referenced by ensureValidIdentifier().

                                                                                                       : void
     {
         switch ($identifierType) {
             case self::IDENTIFIER_TYPE_SOLUTION: $element->setSolutionIdentifier($identifier);
                 break;
             case self::IDENTIFIER_TYPE_RANDOM: $element->setRandomIdentifier($identifier);
                 break;
             default: $this->throwUnknownIdentifierTypeException($identifierType);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ registerIdentifier()

ilAssOrderingElementList::registerIdentifier	(	ilAssOrderingElement	$element,
			$identifierType
	)

protected

Parameters

ilAssOrderingElement	$element
string	$identifierType

Exceptions

ilTestQuestionPoolException

Definition at line 430 of file class.ilAssOrderingElementList.php.

References fetchIdentifier(), and getQuestionId().

Referenced by ensureValidIdentifier(), and registerIdentifiers().

                                                                                          : void
     {
         if (!isset(self::$identifierRegistry[$identifierType][$this->getQuestionId()])) {
             self::$identifierRegistry[$identifierType][$this->getQuestionId()] = array();
         }
 
         $identifier = $this->fetchIdentifier($element, $identifierType);
 
         if (!in_array($identifier, self::$identifierRegistry[$identifierType][$this->getQuestionId()])) {
             self::$identifierRegistry[$identifierType][$this->getQuestionId()][] = $identifier;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ registerIdentifiers()

ilAssOrderingElementList::registerIdentifiers ( ilAssOrderingElement $element )

protected

Parameters

ilAssOrderingElement $element

Definition at line 419 of file class.ilAssOrderingElementList.php.

References registerIdentifier().

Referenced by addElement().

                                                                          : void
     {
         $this->registerIdentifier($element, self::IDENTIFIER_TYPE_SOLUTION);
         $this->registerIdentifier($element, self::IDENTIFIER_TYPE_RANDOM);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeElement()

ilAssOrderingElementList::removeElement ( ilAssOrderingElement $removeElement )

Definition at line 166 of file class.ilAssOrderingElementList.php.

References getQuestionId().

                                                                       : void
     {
         $elementList = new self();
         $elementList->setQuestionId($this->getQuestionId());
 
         $positionCounter = 0;
 
         foreach ($this as $element) {
             if ($element->isSameElement($removeElement)) {
                 continue;
             }
 
             $element->setPosition($positionCounter++);
             $elementList->addElement($element);
         }
     }

Here is the call graph for this function:

◆ reorderByRandomIdentifiers()

ilAssOrderingElementList::reorderByRandomIdentifiers ( $randomIdentifiers )

Parameters

$randomIdentifiers

Exceptions

ilTestQuestionPoolException

Definition at line 708 of file class.ilAssOrderingElementList.php.

References setElements(), throwMissingReorderPositionException(), and throwUnknownRandomIdentifiersException().

                                                                   : void
     {
         $positionsMap = array_flip(array_values($randomIdentifiers));
 
         $orderedElements = array();
 
         foreach ($this as $element) {
             if (!isset($positionsMap[$element->getRandomIdentifier()])) {
                 $this->throwMissingReorderPositionException($element->getRandomIdentifier());
             }
 
             $position = $positionsMap[$element->getRandomIdentifier()];
             unset($positionsMap[$element->getRandomIdentifier()]);
 
             $element->setPosition($position);
             $orderedElements[$position] = $element;
         }
 
         if (count($positionsMap)) {
             $this->throwUnknownRandomIdentifiersException(array_keys($positionsMap));
         }
 
         ksort($orderedElements);
 
         $this->setElements(array_values($orderedElements));
     }

Here is the call graph for this function:

◆ resetElements()

ilAssOrderingElementList::resetElements ( )

resets elements

Definition at line 186 of file class.ilAssOrderingElementList.php.

Referenced by setElements().

                                    : void
     {
         $this->elements = array();
     }

Here is the caller graph for this function:

◆ resetElementsIndentations()

ilAssOrderingElementList::resetElementsIndentations ( )

resets the indentation to level 0 for all elements in list

Definition at line 738 of file class.ilAssOrderingElementList.php.

                                                : void
     {
         foreach ($this as $element) {
             $element->setIndentation(0);
         }
     }

◆ rewind()

ilAssOrderingElementList::rewind ( )

Returns: ilAssOrderingElement|false

Definition at line 831 of file class.ilAssOrderingElementList.php.

     {
         return reset($this->elements);
     }

◆ setElements()

ilAssOrderingElementList::setElements ( $elements )

Parameters

$elements

Definition at line 194 of file class.ilAssOrderingElementList.php.

References $elements, addElement(), and resetElements().

Referenced by moveElementByPositions(), and reorderByRandomIdentifiers().

                                           : void
     {
         $this->resetElements();
 
         foreach ($elements as $element) {
             $this->addElement($element);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setQuestionId()

ilAssOrderingElementList::setQuestionId ( $question_id )

Parameters

integer $question_id

Definition at line 113 of file class.ilAssOrderingElementList.php.

References $question_id.

Referenced by buildInstance().

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

Here is the caller graph for this function:

◆ throwCouldNotBuildRandomIdentifierException()

ilAssOrderingElementList::throwCouldNotBuildRandomIdentifierException ( $maxTries )

protected

Parameters

string $identifierType

Exceptions

ilTestQuestionPoolException

Definition at line 537 of file class.ilAssOrderingElementList.php.

Referenced by buildRandomIdentifier().

                                                                              : void
     {
         throw new ilTestQuestionPoolException(
             "could not build random identifier (max tries: $maxTries)"
         );
     }

Here is the caller graph for this function:

◆ throwMissingReorderPositionException()

ilAssOrderingElementList::throwMissingReorderPositionException ( $randomIdentifier )

protected

Parameters

string $randomIdentifier

Exceptions

ilTestQuestionPoolException

Definition at line 548 of file class.ilAssOrderingElementList.php.

Referenced by reorderByRandomIdentifiers().

                                                                               : void
     {
         throw new ilTestQuestionPoolException(
             "cannot reorder element due to missing position (random identifier: $randomIdentifier)"
         );
     }

Here is the caller graph for this function:

◆ throwUnknownIdentifierTypeException()

ilAssOrderingElementList::throwUnknownIdentifierTypeException ( $identifierType )

protected

Parameters

string $identifierType

Exceptions

ilTestQuestionPoolException

Definition at line 526 of file class.ilAssOrderingElementList.php.

Referenced by buildIdentifier(), fetchIdentifier(), isValidIdentifier(), and populateIdentifier().

                                                                            : void
     {
         throw new ilTestQuestionPoolException(
             "unknown identifier type given (type: $identifierType)"
         );
     }

Here is the caller graph for this function:

◆ throwUnknownRandomIdentifiersException()

ilAssOrderingElementList::throwUnknownRandomIdentifiersException ( $randomIdentifiers )

protected

Parameters

array $randomIdentifiers

Exceptions

ilTestQuestionPoolException

Definition at line 559 of file class.ilAssOrderingElementList.php.

Referenced by reorderByRandomIdentifiers().

                                                                                  : void
     {
         throw new ilTestQuestionPoolException(
             'cannot reorder element due to one or more unknown random identifiers ' .
             '(' . implode(', ', $randomIdentifiers) . ')'
         );
     }

Here is the caller graph for this function:

◆ valid()

ilAssOrderingElementList::valid ( )

Returns: bool

Definition at line 823 of file class.ilAssOrderingElementList.php.

References key().

                            : bool
     {
         return ($this->key() !== null);
     }

Here is the call graph for this function:

◆ withElements()

ilAssOrderingElementList::withElements ( array $elements )

Parameters

ilAssOrderingElement[];

Definition at line 876 of file class.ilAssOrderingElementList.php.

References $elements.

Referenced by assOrderingQuestion\setOrderingElementList(), and assOrderingQuestionTest\testOrderingElementListMutation().

                                                  : self
     {
         $clone = clone $this;
         $clone->elements = $elements;
         return $clone;
     }

Here is the caller graph for this function:

◆ withQuestionId()

ilAssOrderingElementList::withQuestionId ( int $question_id )

Definition at line 883 of file class.ilAssOrderingElementList.php.

References $question_id.

Referenced by assOrderingQuestion\setOrderingElementList().

                                                     : self
     {
         $clone = clone $this;
         $clone->question_id = $question_id;
         return $clone;
     }

Here is the caller graph for this function:

Field Documentation

◆ $elements

ilAssOrderingElementList::$elements = array()

protected

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

Referenced by __clone(), __construct(), buildInstance(), getElements(), getIndexedElements(), setElements(), and withElements().

◆ $identifierRegistry

ilAssOrderingElementList::$identifierRegistry

staticprotected

Initial value:

= array(
        self::IDENTIFIER_TYPE_SOLUTION => array(),
        self::IDENTIFIER_TYPE_RANDOM => array()
    )

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

◆ $objectInstanceCounter

ilAssOrderingElementList::$objectInstanceCounter = 0

static

Definition at line 27 of file class.ilAssOrderingElementList.php.

◆ $objectInstanceId

ilAssOrderingElementList::$objectInstanceId

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

◆ $question_id

ilAssOrderingElementList::$question_id

protected

Definition at line 56 of file class.ilAssOrderingElementList.php.

Referenced by __construct(), getQuestionId(), setQuestionId(), and withQuestionId().

◆ FALLBACK_DEFAULT_ELEMENT_RANDOM_IDENTIFIER

const ilAssOrderingElementList::FALLBACK_DEFAULT_ELEMENT_RANDOM_IDENTIFIER = 0

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

◆ IDENTIFIER_TYPE_RANDOM

const ilAssOrderingElementList::IDENTIFIER_TYPE_RANDOM = 'RandomIds'

Definition at line 43 of file class.ilAssOrderingElementList.php.

◆ IDENTIFIER_TYPE_SOLUTION

const ilAssOrderingElementList::IDENTIFIER_TYPE_SOLUTION = 'SolutionIds'

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

◆ JS_ADDED_ELEMENTS_RANDOM_IDENTIFIER_START_VALUE

const ilAssOrderingElementList::JS_ADDED_ELEMENTS_RANDOM_IDENTIFIER_START_VALUE = -1

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

◆ JS_ADDED_ELEMENTS_RANDOM_IDENTIFIER_VALUE_INTERVAL

const ilAssOrderingElementList::JS_ADDED_ELEMENTS_RANDOM_IDENTIFIER_VALUE_INTERVAL = -1

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

◆ RANDOM_IDENTIFIER_BUILD_MAX_TRIES

const ilAssOrderingElementList::RANDOM_IDENTIFIER_BUILD_MAX_TRIES = 1000

Definition at line 34 of file class.ilAssOrderingElementList.php.

◆ RANDOM_IDENTIFIER_RANGE_LOWER_BOUND

const ilAssOrderingElementList::RANDOM_IDENTIFIER_RANGE_LOWER_BOUND = 1

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

◆ RANDOM_IDENTIFIER_RANGE_UPPER_BOUND

const ilAssOrderingElementList::RANDOM_IDENTIFIER_RANGE_UPPER_BOUND = 100000

Definition at line 36 of file class.ilAssOrderingElementList.php.

◆ SOLUTION_IDENTIFIER_BUILD_MAX_TRIES

const ilAssOrderingElementList::SOLUTION_IDENTIFIER_BUILD_MAX_TRIES = 1000

Definition at line 30 of file class.ilAssOrderingElementList.php.

◆ SOLUTION_IDENTIFIER_START_VALUE

const ilAssOrderingElementList::SOLUTION_IDENTIFIER_START_VALUE = 0

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

◆ SOLUTION_IDENTIFIER_VALUE_INTERVAL

const ilAssOrderingElementList::SOLUTION_IDENTIFIER_VALUE_INTERVAL = 1

Definition at line 31 of file class.ilAssOrderingElementList.php.

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

Modules/TestQuestionPool/classes/questions/class.ilAssOrderingElementList.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __clone()

◆ addElement()

◆ buildIdentifier()

◆ buildInstance()

◆ buildRandomIdentifier()

◆ buildSolutionIdentifier()

◆ completeContentsFromElementList()

◆ countElements()

◆ current()

◆ distributeNewRandomIdentifiers()

◆ elementExistByPosition()

◆ elementExistByRandomIdentifier()

◆ elementExistBySolutionIdentifier()

◆ ensureValidIdentifier()

◆ ensureValidIdentifiers()

◆ fetchIdentifier()

◆ getClone()

◆ getDifferenceElementList()

◆ getDifferenceRandomIdentifierIndex()

◆ getElementByPosition()

◆ getElementByRandomIdentifier()

◆ getElementBySolutionIdentifier()

◆ getElements()

◆ getFallbackDefaultElement()

◆ getHash()

◆ getIndexedElements()

◆ getLastSolutionIdentifier()

◆ getParityTrueElementList()

◆ getQuestionId()

◆ getRandomIdentifierIndex()

◆ getRandomIdentifierIndexedElements()

◆ getRegisteredIdentifiers()

◆ getRegisteredRandomIdentifiers()

◆ getRegisteredSolutionIdentifiers()

◆ getSolutionIdentifierIndex()

◆ getSolutionIdentifierIndexedElements()

◆ hasElements()

◆ hasSameElementSetByRandomIdentifiers()

◆ hasValidIdentifiers()

◆ isFirstElementPosition()

◆ isIdentifierRegistered()

◆ isLastElementPosition()

◆ isValidIdentifier()

◆ isValidIndentation()

◆ isValidPosition()

◆ isValidRandomIdentifier()

◆ isValidSolutionIdentifier()

◆ key()

◆ moveElementByPositions()

◆ next()

◆ populateIdentifier()

◆ registerIdentifier()

◆ registerIdentifiers()

◆ removeElement()

◆ reorderByRandomIdentifiers()

◆ resetElements()

◆ resetElementsIndentations()

◆ rewind()

◆ setElements()

◆ setQuestionId()

◆ throwCouldNotBuildRandomIdentifierException()

◆ throwMissingReorderPositionException()

◆ throwUnknownIdentifierTypeException()

◆ throwUnknownRandomIdentifiersException()

◆ valid()

◆ withElements()

◆ withQuestionId()

Field Documentation

◆ $elements