class.ilObjTestDynamicQuestionSetConfig.php

Go to the documentation of this file.

<?php

class ilObjTestDynamicQuestionSetConfig extends ilTestQuestionSetConfig
{
    private $sourceQuestionPoolId = null;

    private $answerStatusFilterEnabled = null;

    private $taxonomyFilterEnabled = null;

    private $orderingTaxonomyId = null;

    public function getSourceQuestionPoolId(): ?int
    {
        return $this->sourceQuestionPoolId;
    }

    public function setSourceQuestionPoolId($sourceQuestionPoolId)
    {
        $this->sourceQuestionPoolId = (int) $sourceQuestionPoolId;
    }

    public function getSourceQuestionPoolTitle(): string
    {
        return $this->sourceQuestionPoolTitle;
    }

    public function setSourceQuestionPoolTitle($sourceQuestionPoolTitle)
    {
        $this->sourceQuestionPoolTitle = $sourceQuestionPoolTitle;
    }

    public function isAnswerStatusFilterEnabled(): ?bool
    {
        return $this->answerStatusFilterEnabled;
    }

    public function setAnswerStatusFilterEnabled($answerStatusFilterEnabled)
    {
        $this->answerStatusFilterEnabled = $answerStatusFilterEnabled;
    }

    public function isTaxonomyFilterEnabled(): ?bool
    {
        return $this->taxonomyFilterEnabled;
    }

    public function setTaxonomyFilterEnabled($taxonomyFilterEnabled)
    {
        $this->taxonomyFilterEnabled = (bool) $taxonomyFilterEnabled;
    }

    public function getOrderingTaxonomyId(): ?int
    {
        return $this->orderingTaxonomyId;
    }

    public function setOrderingTaxonomyId($orderingTaxonomyId)
    {
        $this->orderingTaxonomyId = $orderingTaxonomyId;
    }

    public function initFromArray($dataArray)
    {
        foreach ($dataArray as $field => $value) {
            switch ($field) {
                case 'source_qpl_fi':                           $this->setSourceQuestionPoolId($value);                 break;
                case 'source_qpl_title':                        $this->setSourceQuestionPoolTitle($value);              break;
                case 'answer_filter_enabled':           $this->setAnswerStatusFilterEnabled($value);    break;
                case 'tax_filter_enabled':                      $this->setTaxonomyFilterEnabled($value);                break;
                case 'order_tax':                                       $this->setOrderingTaxonomyId($value);                   break;
            }
        }
    }

    public function loadFromDb(): bool
    {
        $res = $this->db->queryF(
            "SELECT * FROM tst_dyn_quest_set_cfg WHERE test_fi = %s",
            array('integer'),
            array($this->testOBJ->getTestId())
        );

        while ($row = $this->db->fetchAssoc($res)) {
            $this->initFromArray($row);

            return true;
        }

        return false;
    }

    public function saveToDb()
    {
        if ($this->dbRecordExists($this->testOBJ->getTestId())) {
            $this->updateDbRecord($this->testOBJ->getTestId());
        } else {
            $this->insertDbRecord($this->testOBJ->getTestId());
        }
    }

    public function cloneToDbForTestId($testId)
    {
        $this->insertDbRecord($testId);
    }

    public function deleteFromDb(): bool
    {
        $aff = $this->db->manipulateF(
            "DELETE FROM tst_dyn_quest_set_cfg WHERE test_fi = %s",
            array('integer'),
            array($this->testOBJ->getTestId())
        );

        return (bool) $aff;
    }

    private function dbRecordExists($testId): bool
    {
        $res = $this->db->queryF(
            "SELECT COUNT(*) cnt FROM tst_dyn_quest_set_cfg WHERE test_fi = %s",
            array('integer'),
            array($testId)
        );

        $row = $this->db->fetchAssoc($res);

        return (bool) $row['cnt'];
    }

    private function updateDbRecord($testId)
    {
        $this->db->update(
            'tst_dyn_quest_set_cfg',
            array(
                'source_qpl_fi' => array('integer', $this->getSourceQuestionPoolId()),
                'source_qpl_title' => array('text', $this->getSourceQuestionPoolTitle()),
                'answer_filter_enabled' => array('integer', $this->isAnswerStatusFilterEnabled()),
                'tax_filter_enabled' => array('integer', $this->isTaxonomyFilterEnabled()),
                'order_tax' => array('integer', $this->getOrderingTaxonomyId())
            ),
            array(
                'test_fi' => array('integer', $testId)
            )
        );
    }

    private function insertDbRecord($testId)
    {
        $this->db->insert('tst_dyn_quest_set_cfg', array(
                'test_fi' => array('integer', $testId),
                'source_qpl_fi' => array('integer', $this->getSourceQuestionPoolId()),
                'source_qpl_title' => array('text', $this->getSourceQuestionPoolTitle()),
                'answer_filter_enabled' => array('integer', $this->isAnswerStatusFilterEnabled()),
                'tax_filter_enabled' => array('integer', $this->isTaxonomyFilterEnabled()),
                'order_tax' => array('integer', $this->getOrderingTaxonomyId())
        ));
    }

    public function isQuestionSetConfigured(): bool
    {
        return $this->getSourceQuestionPoolId() > 0;
    }

    public function doesQuestionSetRelatedDataExist(): bool
    {
        return $this->isQuestionSetConfigured();
    }

    public function removeQuestionSetRelatedData(): void
    {
        $this->deleteFromDb();
    }

    public function resetQuestionSetRelatedTestSettings()
    {
        // nothing to do
    }

    public function cloneQuestionSetRelatedData(ilObjTest $cloneTestOBJ)
    {
        $this->loadFromDb();
        $this->cloneToDbForTestId($cloneTestOBJ->getTestId());
    }

    public function getSourceQuestionPoolSummaryString(ilLanguage $lng): string
    {
        $poolRefs = $this->getSourceQuestionPoolRefIds();

        if (!count($poolRefs)) {
            $sourceQuestionPoolSummaryString = sprintf(
                $lng->txt('tst_dyn_quest_set_src_qpl_summary_string_deleted'),
                $this->getSourceQuestionPoolTitle()
            );

            return $sourceQuestionPoolSummaryString;
        }

        foreach ($poolRefs as $refId) {
            if (!$this->tree->isDeleted($refId)) {
                $sourceQuestionPoolSummaryString = sprintf(
                    $lng->txt('tst_dynamic_question_set_source_questionpool_summary_string'),
                    $this->getSourceQuestionPoolTitle(),
                    $this->getQuestionPoolPathString($this->getSourceQuestionPoolId()),
                    $this->getSourceQuestionPoolNumQuestions()
                );

                return $sourceQuestionPoolSummaryString;
            }
        }

        $sourceQuestionPoolSummaryString = sprintf(
            $lng->txt('tst_dyn_quest_set_src_qpl_summary_string_trashed'),
            $this->getSourceQuestionPoolTitle(),
            $this->getSourceQuestionPoolNumQuestions()
        );

        return $sourceQuestionPoolSummaryString;
    }

    private function getSourceQuestionPoolNumQuestions(): int
    {
        $query = "
                        SELECT COUNT(*) num from qpl_questions
                        WHERE obj_fi = %s AND original_id IS NULL
                ";

        $res = $this->db->queryF(
            $query,
            array('integer'),
            array($this->getSourceQuestionPoolId())
        );

        $row = $this->db->fetchAssoc($res);

        return $row['num'];
    }

    public function areDepenciesInVulnerableState(): bool
    {
        if (!$this->getSourceQuestionPoolId()) {
            return false;
        }

        $poolRefs = $this->getSourceQuestionPoolRefIds();

        foreach ($poolRefs as $refId) {
            if (!$this->tree->isDeleted($refId)) {
                return false;
            }
        }

        return true;
    }

    public function getDepenciesInVulnerableStateMessage(ilLanguage $lng): string
    {
        $msg = sprintf(
            $lng->txt('tst_dyn_quest_set_pool_trashed'),
            $this->getSourceQuestionPoolTitle()
        );

        return $msg;
    }

    public function areDepenciesBroken(): bool
    {
        if (!$this->getSourceQuestionPoolId()) {
            return false;
        }

        $poolRefs = $this->getSourceQuestionPoolRefIds();

        if (count($poolRefs)) {
            return false;
        }

        return true;
    }

    public function getDepenciesBrokenMessage(ilLanguage $lng): string
    {
        $msg = sprintf(
            $lng->txt('tst_dyn_quest_set_pool_deleted'),
            $this->getSourceQuestionPoolTitle()
        );

        return $msg;
    }

    public function isValidRequestOnBrokenQuestionSetDepencies($nextClass, $cmd): bool
    {
        //vd($nextClass, $cmd);

        if (!$this->testOBJ->participantDataExist()) {
            return true;
        }

        switch ($nextClass) {
            case 'ilobjtestdynamicquestionsetconfiggui':

            case 'ilobjectmetadatagui':
            case 'ilpermissiongui':

                return true;

            case 'ilobjtestgui':
            case '':

                $cmds = array(
                    'infoScreen', 'participants', 'npSetFilter', 'npResetFilter',
                    'deleteAllUserResults', 'confirmDeleteAllUserResults',
                    'deleteSingleUserResults', 'confirmDeleteSelectedUserData', 'cancelDeleteSelectedUserData'
                );

                if (in_array($cmd, $cmds)) {
                    return true;
                }

                break;
        }

        return false;
    }

    public function getHiddenTabsOnBrokenDepencies(): array
    {
        return array(
            'settings', 'manscoring', 'scoringadjust', 'statistics', 'history', 'export'
        );
    }

    private $sourceQuestionPoolRefIds = null;

    public function getSourceQuestionPoolRefIds(): array
    {
        if ($this->sourceQuestionPoolRefIds === null) {
            $this->sourceQuestionPoolRefIds = ilObject::_getAllReferences($this->getSourceQuestionPoolId());
        }

        return $this->sourceQuestionPoolRefIds;
    }

    public function isResultTaxonomyFilterSupported(): bool
    {
        return false;
    }

    public function isAnyQuestionFilterEnabled(): bool
    {
        if ($this->isTaxonomyFilterEnabled()) {
            return true;
        }

        if ($this->isAnswerStatusFilterEnabled()) {
            return true;
        }

        return false;
    }

    public function getSourceQuestionPoolLink(): string
    {
        $refId = current(ilObject::_getAllReferences($this->getSourceQuestionPoolId()));
        $href = ilLink::_getLink($refId, 'qpl');
        $title = $this->getSourceQuestionPoolTitle();

        return "<a href=\"$href\" alt=\"$title\">$title</a>";
    }
}