class.ilTestRandomQuestionsQuantitiesDistribution.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */

require_once 'Modules/Test/classes/class.ilObjTest.php';
require_once 'Modules/Test/classes/class.ilTestRandomQuestionSetSourcePoolDefinitionFactory.php';
require_once 'Modules/Test/classes/class.ilTestRandomQuestionSetSourcePoolDefinitionList.php';
require_once 'Modules/Test/classes/class.ilTestRandomQuestionSetQuestionCollection.php';
require_once 'Modules/Test/classes/class.ilTestRandomQuestionCollectionSubsetApplicationList.php';
require_once 'Modules/Test/classes/class.ilTestRandomQuestionsSrcPoolDefinitionQuantitiesCalculation.php';

class ilTestRandomQuestionsQuantitiesDistribution
{
    // -----------------------------------------------------------------------------------------------------------------

    protected $questionCollectionProvider;
    
    protected $sourcePoolDefinitionList;
    
    // -----------------------------------------------------------------------------------------------------------------

    protected $questRelatedSrcPoolDefRegister = array();
    
    protected $srcPoolDefRelatedQuestRegister= array();
    
    // -----------------------------------------------------------------------------------------------------------------

    public function __construct(ilTestRandomSourcePoolDefinitionQuestionCollectionProvider $questionCollectionProvider)
    {
        if ($questionCollectionProvider !== null) {
            $this->setQuestionCollectionProvider($questionCollectionProvider);
        }
    }
    
    public function setQuestionCollectionProvider(ilTestRandomSourcePoolDefinitionQuestionCollectionProvider $questionCollectionProvider)
    {
        $this->questionCollectionProvider = $questionCollectionProvider;
    }
    
    public function getQuestionCollectionProvider()
    {
        return $this->questionCollectionProvider;
    }
    
    public function setSourcePoolDefinitionList($sourcePoolDefinitionList)
    {
        $this->sourcePoolDefinitionList = $sourcePoolDefinitionList;
    }
    
    public function getSourcePoolDefinitionList()
    {
        return $this->sourcePoolDefinitionList;
    }

    // -----------------------------------------------------------------------------------------------------------------
    
    protected function buildSourcePoolDefinitionListInstance()
    {
        $anyTestObject = new ilObjTest();
        $nonRequiredDb = isset($GLOBALS['DIC']) ? $GLOBALS['DIC']['ilDB'] : $GLOBALS['ilDB'];
        $nonUsedFactory = new ilTestRandomQuestionSetSourcePoolDefinitionFactory($nonRequiredDb, $anyTestObject);
        return new ilTestRandomQuestionSetSourcePoolDefinitionList($nonRequiredDb, $anyTestObject, $nonUsedFactory);
    }
    
    protected function buildRandomQuestionCollectionInstance()
    {
        return new ilTestRandomQuestionSetQuestionCollection();
    }
    
    protected function buildQuestionCollectionSubsetApplicationInstance()
    {
        return new ilTestRandomQuestionCollectionSubsetApplication();
    }
    
    protected function buildQuestionCollectionSubsetApplicationListInstance()
    {
        return new ilTestRandomQuestionCollectionSubsetApplicationList();
    }
    
    // -----------------------------------------------------------------------------------------------------------------
    
    protected function resetQuestRelatedSrcPoolDefRegister()
    {
        $this->questRelatedSrcPoolDefRegister = array();
    }
    
    protected function registerQuestRelatedSrcPoolDef($questionId, ilTestRandomQuestionSetSourcePoolDefinition $definition)
    {
        if (!$this->questRelatedSrcPoolDefRegister[$questionId]) {
            $this->questRelatedSrcPoolDefRegister[$questionId] = $this->buildSourcePoolDefinitionListInstance();
        }
        
        $this->questRelatedSrcPoolDefRegister[$questionId]->addDefinition($definition);
    }
    
    protected function getQuestRelatedSrcPoolDefinitionList($questionId)
    {
        if (isset($this->questRelatedSrcPoolDefRegister[$questionId])) {
            return $this->questRelatedSrcPoolDefRegister[$questionId];
        }
        
        return null;
    }
    
    protected function resetSrcPoolDefRelatedQuestRegister()
    {
        $this->srcPoolDefRelatedQuestRegister = array();
    }
    
    protected function registerSrcPoolDefRelatedQuest($definitionId, ilTestRandomQuestionSetQuestion $randomSetQuestion)
    {
        if (!isset($this->srcPoolDefRelatedQuestRegister[$definitionId])) {
            $this->srcPoolDefRelatedQuestRegister[$definitionId] = $this->buildRandomQuestionCollectionInstance();
        }
        
        $this->srcPoolDefRelatedQuestRegister[$definitionId]->addQuestion($randomSetQuestion);
    }
    
    protected function getSrcPoolDefRelatedQuestionCollection($definitionId)
    {
        if (isset($this->srcPoolDefRelatedQuestRegister[$definitionId])) {
            return $this->srcPoolDefRelatedQuestRegister[$definitionId];
        }
        
        return new ilTestRandomQuestionSetQuestionCollection();
    }
    
    // -----------------------------------------------------------------------------------------------------------------
    
    protected function initialiseRegisters()
    {
        foreach ($this->getSrcPoolDefQuestionCombinationCollection() as $randomQuestion) {
            $sourcePoolDefinition = $this->getSourcePoolDefinitionList()->getDefinition(
                $randomQuestion->getSourcePoolDefinitionId()
            );
            
            $this->registerSrcPoolDefRelatedQuest(
                $randomQuestion->getSourcePoolDefinitionId(),
                $randomQuestion
            );
            
            $this->registerQuestRelatedSrcPoolDef(
                $randomQuestion->getQuestionId(),
                $sourcePoolDefinition
            );
        }
    }
    
    protected function resetRegisters()
    {
        $this->resetQuestRelatedSrcPoolDefRegister();
        $this->resetSrcPoolDefRelatedQuestRegister();
    }
    
    // -----------------------------------------------------------------------------------------------------------------
    
    protected function getSrcPoolDefQuestionCombinationCollection()
    {
        $qstCollectionProvider = $this->getQuestionCollectionProvider();
        $srcPoolDefinitionList = $this->getSourcePoolDefinitionList();
        
        $defQstCombinationCollection = $qstCollectionProvider->getSrcPoolDefListRelatedQuestCombinationCollection(
            $srcPoolDefinitionList
        );
        
        return $defQstCombinationCollection;
    }
    
    protected function getExclusiveQuestionCollection($definitionId)
    {
        $exclusiveQstCollection = $this->buildRandomQuestionCollectionInstance();
        
        foreach ($this->getSrcPoolDefRelatedQuestionCollection($definitionId) as $question) {
            if ($this->isQuestionUsedByMultipleSrcPoolDefinitions($question)) {
                continue;
            }
            
            $exclusiveQstCollection->addQuestion($question);
        }
        
        return $exclusiveQstCollection;
    }
    
    protected function getSharedQuestionCollection($definitionId)
    {
        $srcPoolDefRelatedQstCollection = $this->getSrcPoolDefRelatedQuestionCollection($definitionId);
        $exclusiveQstCollection = $this->getExclusiveQuestionCollection($definitionId);
        return $srcPoolDefRelatedQstCollection->getRelativeComplementCollection($exclusiveQstCollection);
    }
    
    protected function getIntersectionQuestionCollection($thisDefinitionId, $thatDefinitionId)
    {
        $thisDefRelatedSharedQstCollection = $this->getSharedQuestionCollection($thisDefinitionId);
        $thatDefRelatedSharedQstCollection = $this->getSharedQuestionCollection($thatDefinitionId);
        
        $intersectionQstCollection = $thisDefRelatedSharedQstCollection->getIntersectionCollection(
            $thatDefRelatedSharedQstCollection
        );
        
        return $intersectionQstCollection;
    }
    
    protected function getIntersectionQstCollectionByDefinitionMap(ilTestRandomQuestionSetSourcePoolDefinition $definition)
    {
        $intersectionQstCollectionsByDefId = array();
        
        $sharedQuestionCollection = $this->getSharedQuestionCollection($definition->getId());
        foreach ($sharedQuestionCollection as $sharedQuestion) {
            $relatedSrcPoolDefList = $this->getQuestRelatedSrcPoolDefinitionList($sharedQuestion->getQuestionId());
            foreach ($relatedSrcPoolDefList as $otherDefinition) {
                if ($otherDefinition->getId() == $definition->getId()) {
                    continue;
                }
                
                if (isset($intersectionQstCollectionsByDefId[$otherDefinition->getId()])) {
                    continue;
                }
                
                $intersectionQuestionCollection = $this->getIntersectionQuestionCollection(
                    $definition->getId(),
                    $otherDefinition->getId()
                );
                
                $intersectionQstCollectionsByDefId[$otherDefinition->getId()] = $intersectionQuestionCollection;
            }
        }
        
        return $intersectionQstCollectionsByDefId;
    }
    
    protected function getIntersectionQuestionCollectionSubsetApplicationList(ilTestRandomQuestionSetSourcePoolDefinition $definition)
    {
        $qstCollectionSubsetApplicationList = $this->buildQuestionCollectionSubsetApplicationListInstance();
        
        $intersectionQstCollectionByDefIdMap = $this->getIntersectionQstCollectionByDefinitionMap($definition);
        foreach ($intersectionQstCollectionByDefIdMap as $otherDefinitionId => $intersectionCollection) {
            /* @var ilTestRandomQuestionSetQuestionCollection $intersectionCollection */
            
            $qstCollectionSubsetApplication = $this->buildQuestionCollectionSubsetApplicationInstance();
            $qstCollectionSubsetApplication->setQuestions($intersectionCollection->getQuestions());
            $qstCollectionSubsetApplication->setApplicantId($otherDefinitionId);
            
            #$qstCollectionSubsetApplication->setRequiredAmount($this->getRequiredSharedQuestionAmount(
            #   $this->getSourcePoolDefinitionList()->getDefinition($otherDefinitionId)
            #));
            
            $qstCollectionSubsetApplication->setRequiredAmount(
                $this->getSourcePoolDefinitionList()->getDefinition($otherDefinitionId)->getQuestionAmount()
            );
            
            $qstCollectionSubsetApplicationList->addCollectionSubsetApplication($qstCollectionSubsetApplication);
        }
        
        return $qstCollectionSubsetApplicationList;
    }
    
    // -----------------------------------------------------------------------------------------------------------------
    
    protected function getIntersectionSharingDefinitionList(ilTestRandomQuestionSetSourcePoolDefinition $definition)
    {
        $intersectionSharingDefinitionList = $this->buildSourcePoolDefinitionListInstance();
        
        $sharedQuestionCollection = $this->getSharedQuestionCollection($definition->getId());
        foreach ($sharedQuestionCollection as $sharedQuestion) {
            $relatedSrcPoolDefList = $this->getQuestRelatedSrcPoolDefinitionList($sharedQuestion->getQuestionId());
            foreach ($relatedSrcPoolDefList as $otherDefinition) {
                if ($otherDefinition->getId() == $definition->getId()) {
                    continue;
                }
                
                if ($intersectionSharingDefinitionList->hasDefinition($otherDefinition->getId())) {
                    continue;
                }
                
                $intersectionSharingDefinitionList->addDefinition($otherDefinition);
            }
        }
        
        return $intersectionSharingDefinitionList;
    }
            
    protected function isQuestionUsedByMultipleSrcPoolDefinitions(ilTestRandomQuestionSetQuestion $question)
    {
        /* @var ilTestRandomQuestionSetSourcePoolDefinitionList $qstRelatedSrcPoolDefList */
        $qstRelatedSrcPoolDefList = $this->questRelatedSrcPoolDefRegister[$question->getQuestionId()];
        return $qstRelatedSrcPoolDefList->getDefinitionCount() > 1;
    }
    
    protected function getSrcPoolDefRelatedQuestionAmount(ilTestRandomQuestionSetSourcePoolDefinition $definition)
    {
        return $this->getSrcPoolDefRelatedQuestionCollection($definition->getId())->getQuestionAmount();
    }
    
    protected function getExclusiveQuestionAmount(ilTestRandomQuestionSetSourcePoolDefinition $definition)
    {
        return $this->getExclusiveQuestionCollection($definition->getId())->getQuestionAmount();
    }
    
    protected function getAvailableSharedQuestionAmount(ilTestRandomQuestionSetSourcePoolDefinition $definition)
    {
        $intersectionSubsetApplicationList = $this->getIntersectionQuestionCollectionSubsetApplicationList($definition);
        
        foreach ($this->getSharedQuestionCollection($definition->getId()) as $sharedQuestion) {
            $intersectionSubsetApplicationList->handleQuestionRequest($sharedQuestion);
        }
        
        return $intersectionSubsetApplicationList->getNonReservedQuestionAmount();
    }
    
    protected function getRequiredSharedQuestionAmount(ilTestRandomQuestionSetSourcePoolDefinition $definition)
    {
        $exclusiveQstCollection = $this->getExclusiveQuestionCollection($definition->getId());
        $missingExclsuiveQstCount = $exclusiveQstCollection->getMissingCount($definition->getQuestionAmount());
        return $missingExclsuiveQstCount;
    }
    
    protected function requiresSharedQuestions(ilTestRandomQuestionSetSourcePoolDefinition $definition)
    {
        return $this->getRequiredSharedQuestionAmount($definition) > 0;
    }
    
    // -----------------------------------------------------------------------------------------------------------------
    
    public function initialise()
    {
        $this->initialiseRegisters();
    }
    
    public function reset()
    {
        $this->resetRegisters();
    }
    
    // -----------------------------------------------------------------------------------------------------------------
    
    public function calculateQuantities(ilTestRandomQuestionSetSourcePoolDefinition $definition)
    {
        $quantityCalculation = new ilTestRandomQuestionsSrcPoolDefinitionQuantitiesCalculation($definition);
        
        $quantityCalculation->setOverallQuestionAmount($this->getSrcPoolDefRelatedQuestionAmount($definition));
        $quantityCalculation->setExclusiveQuestionAmount($this->getExclusiveQuestionAmount($definition));
        $quantityCalculation->setAvailableSharedQuestionAmount($this->getAvailableSharedQuestionAmount($definition));
        
        $quantityCalculation->setIntersectionQuantitySharingDefinitionList(
            $this->getIntersectionSharingDefinitionList($definition)
        );
        
        return $quantityCalculation;
    }
    
    // -----------------------------------------------------------------------------------------------------------------
}