class.ilObjTestXMLParser.php

Go to the documentation of this file.

<?php

class ilObjTestXMLParser extends ilSaxParser
{
    protected ?ilObjTest $testOBJ = null;

    protected ?ilImportMapping $importMapping = null;

    protected String $cdata = '';

    public function getTestOBJ(): ?\ilObjTest
    {
        return $this->testOBJ;
    }

    public function setTestOBJ(\ilObjTest $testOBJ): void
    {
        $this->testOBJ = $testOBJ;
    }

    public function getImportMapping(): ?\ilImportMapping
    {
        return $this->importMapping;
    }

    public function setImportMapping(\ilImportMapping $importMapping): void
    {
        $this->importMapping = $importMapping;
    }

    public function setHandlers($a_xml_parser): void
    {
        xml_set_object($a_xml_parser, $this);
        xml_set_element_handler($a_xml_parser, 'handlerBeginTag', 'handlerEndTag');
        xml_set_character_data_handler($a_xml_parser, 'handlerCharacterData');
    }

    public function handlerBeginTag($xmlParser, $tagName, $tagAttributes): void
    {
        switch ($tagName) {
            case 'RandomQuestionSetConfig':
                $this->inRandomQuestionSetConfig = true;
                break;

            case 'RandomQuestionSetSettings':
                if ($this->inRandomQuestionSetConfig) {
                    $this->inRandomQuestionSetSettings = true;
                    $this->cdata = '';
                    $this->attr = $tagAttributes;
                }
                break;

            case 'RandomQuestionStage':
                if ($this->inRandomQuestionSetConfig) {
                    $this->inRandomQuestionStage = true;
                }
                break;

            case 'RandomQuestionStagingPool':
                if ($this->inRandomQuestionStage) {
                    $this->cdata = '';
                    $this->attr = $tagAttributes;
                }
                break;

            case 'RandomQuestionSelectionDefinitions':
                if ($this->inRandomQuestionSetConfig) {
                    $this->inRandomQuestionSelectionDefinitions = true;
                }
                break;

            case 'RandomQuestionSelectionDefinition':
                if ($this->inRandomQuestionSelectionDefinitions) {
                    $this->sourcePoolDefinition = $this->getRandomQuestionSourcePoolDefinitionInstance();
                    $this->attr = $tagAttributes;
                }
                break;

            case 'RandomQuestionSourcePoolTitle':
            case 'RandomQuestionSourcePoolPath':
                if ($this->sourcePoolDefinition instanceof ilTestRandomQuestionSetSourcePoolDefinition) {
                    $this->cdata = '';
                }
                break;
        }
    }

    public function handlerEndTag($xmlParser, $tagName): void
    {
        switch ($tagName) {
            case 'RandomQuestionSetConfig':
                $this->inRandomQuestionSetConfig = false;
                break;

            case 'RandomQuestionSetSettings':
                if ($this->inRandomQuestionSetConfig) {
                    $this->importRandomQuestionSetSettings($this->attr);
                    $this->attr = null;
                }
                break;

            case 'RandomQuestionStage':
                if ($this->inRandomQuestionSetConfig) {
                    $this->inRandomQuestionStage = false;
                }
                break;

            case 'RandomQuestionStagingPool':
                if ($this->inRandomQuestionSetConfig && $this->inRandomQuestionStage) {
                    $this->importRandomQuestionStagingPool($this->attr, $this->cdata);
                    $this->attr = null;
                    $this->cdata = '';
                }
                break;

            case 'RandomQuestionSelectionDefinitions':
                if ($this->inRandomQuestionSetConfig) {
                    $this->inRandomQuestionSelectionDefinitions = false;
                }
                break;

            case 'RandomQuestionSelectionDefinition':
                if ($this->inRandomQuestionSetConfig && $this->inRandomQuestionSelectionDefinitions) {
                    $this->importRandomQuestionSourcePoolDefinition($this->sourcePoolDefinition, $this->attr);
                    $this->sourcePoolDefinition->saveToDb();

                    $this->getImportMapping()->addMapping(
                        'Modules/Test',
                        'rnd_src_pool_def',
                        $this->attr['id'],
                        $this->sourcePoolDefinition->getId()
                    );

                    $this->sourcePoolDefinition = null;
                    $this->attr = null;
                }
                break;

            case 'RandomQuestionSourcePoolTitle':
                if ($this->sourcePoolDefinition instanceof ilTestRandomQuestionSetSourcePoolDefinition) {
                    $this->sourcePoolDefinition->setPoolTitle($this->cdata);
                    $this->cdata = '';
                }
                break;

            case 'RandomQuestionSourcePoolPath':
                if ($this->sourcePoolDefinition instanceof ilTestRandomQuestionSetSourcePoolDefinition) {
                    $this->sourcePoolDefinition->setPoolPath($this->cdata);
                    $this->cdata = '';
                }
                break;
        }
    }

    public function handlerCharacterData($xmlParser, $charData): void
    {
        if ($charData != "\n") {
            // Replace multiple tabs with one space
            $charData = preg_replace("/\t+/", " ", $charData);

            $this->cdata .= $charData;
        }
    }

    protected function importRandomQuestionSetSettings($attr): void
    {
        global $DIC;
        $tree = $DIC['tree'];
        $ilDB = $DIC['ilDB'];
        $component_repository = $DIC['component.repository'];
        $questionSetConfig = new ilTestRandomQuestionSetConfig($tree, $ilDB, $component_repository, $this->testOBJ);

        if (!$questionSetConfig->isValidQuestionAmountConfigurationMode($attr['amountMode'])) {
            throw new ilTestException(
                'invalid random test question set config amount mode given: "' . $attr['amountMode'] . '"'
            );
        }

        $questionSetConfig->setQuestionAmountConfigurationMode($attr['amountMode']);
        $questionSetConfig->setQuestionAmountPerTest((int) $attr['questAmount']);
        $questionSetConfig->setPoolsWithHomogeneousScoredQuestionsRequired((bool) $attr['homogeneous']);
        $questionSetConfig->setLastQuestionSyncTimestamp((int) $attr['synctimestamp']);

        $questionSetConfig->saveToDb();
    }

    protected function importRandomQuestionStagingPool($attr, $cdata): void
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        $oldPoolId = $attr['poolId'];
        $newPoolId = $ilDB->nextId('object_data'); // yes !!

        $this->getImportMapping()->addMapping(
            'Modules/Test',
            'pool',
            $oldPoolId,
            $newPoolId
        );

        $oldQuestionIds = explode(',', $cdata);

        foreach ($oldQuestionIds as $oldQuestionId) {
            $newQuestionId = $this->getImportMapping()->getMapping(
                'Modules/Test',
                'quest',
                $oldQuestionId
            );

            $stagingQuestion = new ilTestRandomQuestionSetStagingPoolQuestion($ilDB);
            $stagingQuestion->setTestId($this->testOBJ->getTestId());
            $stagingQuestion->setPoolId($newPoolId);
            $stagingQuestion->setQuestionId($newQuestionId);

            $stagingQuestion->saveQuestionStaging();
        }
    }

    protected function getRandomQuestionSourcePoolDefinitionInstance(): \ilTestRandomQuestionSetSourcePoolDefinition
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];

        return new ilTestRandomQuestionSetSourcePoolDefinition($ilDB, $this->testOBJ);
    }

    protected function importRandomQuestionSourcePoolDefinition(ilTestRandomQuestionSetSourcePoolDefinition $sourcePoolDefinition, $attr): void
    {
        $source_pool_id = (int) $attr['poolId'];
        $effective_pool_id = (int) $this->getImportMapping()->getMapping(
            'Modules/Test',
            'pool',
            $source_pool_id
        );
        $sourcePoolDefinition->setPoolId($effective_pool_id);

        $derive_from_obj_id = true;
        // The ref_id might not be given in old export files, so we have to check for existence
        if (isset($attr['ref_id']) && is_numeric($attr['ref_id'])) {
            if ($source_pool_id === $effective_pool_id) {
                $derive_from_obj_id = false;
                $sourcePoolDefinition->setPoolRefId((int) $attr['ref_id']);
            }
        }

        if ($derive_from_obj_id) {
            $ref_ids = ilObject::_getAllReferences($effective_pool_id);
            $ref_id = current($ref_ids);
            $sourcePoolDefinition->setPoolRefId($ref_id ? $ref_id : null);
        }

        $sourcePoolDefinition->setPoolQuestionCount((int) $attr['poolQuestCount']);
        $sourcePoolDefinition->setQuestionAmount((int) $attr['questAmount']);
        $sourcePoolDefinition->setSequencePosition((int) $attr['position']);

        if (isset($attr['typeFilter']) && strlen($attr['typeFilter']) > 0) {
            $sourcePoolDefinition->setTypeFilterFromTypeTags(explode(',', $attr['typeFilter']));
        }

        // #21330
        if (isset($attr['tax']) && isset($attr['taxNode'])) {
            $mappedTaxFilter = array(
                (int) $attr['tax'] => array(
                    (int) $attr['taxNode']
                )
            );
            $sourcePoolDefinition->setMappedTaxonomyFilter($mappedTaxFilter);
        } elseif (isset($attr['taxFilter']) && strlen($attr['taxFilter']) > 0) {
            $mappedTaxFilter = unserialize($attr['taxFilter']);
            $sourcePoolDefinition->setMappedTaxonomyFilter($mappedTaxFilter);
        }
    }
}