class.ilAssQuestionHintList.php

Go to the documentation of this file.

<?php

class ilAssQuestionHintList implements Iterator
{
    private array $questionHints = [];

    public function current(): ilAssQuestionHint
    {
        return current($this->questionHints);
    }

    public function rewind(): void
    {
        reset($this->questionHints);
    }

    public function next(): void
    {
        next($this->questionHints);
    }

    public function key(): int
    {
        return key($this->questionHints);
    }

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

    public function __construct()
    {
    }

    public function addHint(ilAssQuestionHint $questionHint): void
    {
        $this->questionHints[] = $questionHint;
    }

    public function getHint($hintId): ilAssQuestionHint
    {
        foreach ($this as $questionHint) {
            /* @var $questionHint ilAssQuestionHint */

            if ($questionHint->getId() == $hintId) {
                return $questionHint;
            }
        }

        throw new ilTestQuestionPoolException("hint with id $hintId does not exist in this list");
    }

    public function hintExists($hintId): bool
    {
        foreach ($this as $questionHint) {
            /* @var ilAssQuestionHint $questionHint */
            if ($questionHint->getId() == $hintId) {
                return true;
            }
        }

        return false;
    }

    public function reIndex(): void
    {
        $counter = 0;

        foreach ($this as $questionHint) {
            /* @var $questionHint ilAssQuestionHint */

            $questionHint->setIndex(++$counter);
            $questionHint->save();
        }
    }

    public static function duplicateListForQuestion($originalQuestionId, $duplicateQuestionId): array
    {
        $hintIds = [];

        $questionHintList = self::getListByQuestionId($originalQuestionId);

        foreach ($questionHintList as $questionHint) {
            /* @var $questionHint ilAssQuestionHint */

            $originalHintId = $questionHint->getId();

            $questionHint->setId(0);
            $questionHint->setQuestionId($duplicateQuestionId);

            $questionHint->save();

            $duplicateHintId = $questionHint->getId();

            $hintIds[$originalHintId] = $duplicateHintId;
        }

        return $hintIds;
    }

    public function getTableData(): array
    {
        $tableData = [];

        foreach ($this as $questionHint) {
            /* @var $questionHint ilAssQuestionHint */

            $tableData[] = [
                'hint_id' => $questionHint->getId(),
                'hint_index' => $questionHint->getIndex(),
                'hint_points' => $questionHint->getPoints(),
                'hint_text' => $questionHint->getText()
            ];
        }

        return $tableData;
    }

    public static function getListByQuestionId($questionId): ilAssQuestionHintList
    {
        global $DIC;
        $ilDB = $DIC->database();

        $query = "
                        SELECT          qht_hint_id,
                                                qht_question_fi,
                                                qht_hint_index,
                                                qht_hint_points,
                                                qht_hint_text

                        FROM            qpl_hints

                        WHERE           qht_question_fi = %s

                        ORDER BY        qht_hint_index ASC
                ";

        $res = $ilDB->queryF(
            $query,
            ['integer'],
            [(int) $questionId]
        );

        $questionHintList = new self();

        while ($row = $ilDB->fetchAssoc($res)) {
            $questionHint = new ilAssQuestionHint();

            ilAssQuestionHint::assignDbRow($questionHint, $row);

            $questionHintList->addHint($questionHint);
        }

        return $questionHintList;
    }

    public static function getListByHintIds($hintIds): ilAssQuestionHintList
    {
        global $DIC;
        $ilDB = $DIC->database();

        $qht_hint_id__IN__hintIds = $ilDB->in('qht_hint_id', (array) $hintIds, false, 'integer');

        $query = "
                        SELECT          qht_hint_id,
                                                qht_question_fi,
                                                qht_hint_index,
                                                qht_hint_points,
                                                qht_hint_text

                        FROM            qpl_hints

                        WHERE           $qht_hint_id__IN__hintIds

                        ORDER BY        qht_hint_index ASC
                ";

        $res = $ilDB->query($query);

        $questionHintList = new self();

        while ($row = $ilDB->fetchAssoc($res)) {
            $questionHint = new ilAssQuestionHint();

            ilAssQuestionHint::assignDbRow($questionHint, $row);

            $questionHintList->addHint($questionHint);
        }

        return $questionHintList;
    }

    public static function getNextIndexByQuestionId($questionId): int
    {
        global $DIC;
        $ilDB = $DIC->database();

        $query = "
                        SELECT          1 + COALESCE( MAX(qht_hint_index), 0 ) next_index

                        FROM            qpl_hints

                        WHERE           qht_question_fi = %s
                ";

        $res = $ilDB->queryF(
            $query,
            ['integer'],
            [(int) $questionId]
        );
        $row = $ilDB->fetchAssoc($res);

        return is_array($row) ? (int) $row['next_index'] : 1;
    }

    public static function deleteHintsByQuestionIds(array $questionIds): int
    {
        global $DIC;
        $ilDB = $DIC->database();

        $__qht_question_fi__IN__questionIds = $ilDB->in('qht_question_fi', $questionIds, false, 'integer');

        $query = "
                        DELETE FROM             qpl_hints
                        WHERE                   $__qht_question_fi__IN__questionIds
                ";

        return $ilDB->manipulate($query);
    }
}