Collaboration diagram for ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository:

Public Member Functions
	__construct (private \ilDBInterface $db, private \ilComponentFactory $component_factory, private \ilComponentRepository $component_repository)

	getForQuestionId (int $question_id)

	getForParentObjectId (int $obj_id)

	getForQuestionIds (array $question_ids)

	getFractionOfReachedToReachablePointsTotal (int $question_id)

	areQuestionsAnsweredByUser (int $user_id, array $question_ids)
	Checks if an array of question ids is answered by a user or not. More...

	lookupResultRecordExist (int $active_id, int $question_id, int $pass)

	isInUse (int $question_id=0)

	usageCount (int $question_id=0)
	Returns the number of place the question is in use in pools or tests. More...

	searchQuestionIdsByTitle (string $title)

	questionExists (int $question_id)

	questionExistsInPool (int $question_id)

	isUsedInRandomTest (int $question_id)

	originalQuestionExists (int $question_id)

	getQuestionsMissingResultRecord (int $active_id, int $pass, array $question_ids)

	isInActiveTest (int $obj_id)

Private Member Functions
	buildGeneralQuestionPropertyFromDBRecords (\stdClass $db_record)

	getForWhereClause (string $where)

	isQuestionTypeAvailable (?string $plugin_name)

Private Attributes
const	MAIN_QUESTION_TABLE = 'qpl_questions'

const	QUESTION_TYPES_TABLE = 'qpl_qst_type'

const	TEST_FIXED_QUESTION_TABLE = 'tst_test_question'

const	TEST_RANDOM_QUESTION_TABLE = 'tst_test_rnd_qst'

const	TEST_RESULTS_TABLE = 'tst_test_result'

const	TEST_TO_ACTIVE_USER_TABLE = 'tst_active'

const	DATA_TABLE = 'object_data'

Detailed Description

Definition at line 23 of file GeneralQuestionPropertiesRepository.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository::__construct	(	private \ilDBInterface	$db,
		private \ilComponentFactory	$component_factory,
		private \ilComponentRepository	$component_repository
	)

Definition at line 33 of file GeneralQuestionPropertiesRepository.php.

37 {

38 }

Member Function Documentation

◆ areQuestionsAnsweredByUser()

ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository::areQuestionsAnsweredByUser	(	int	$user_id,
		array	$question_ids
	)

Checks if an array of question ids is answered by a user or not.

Parameters

int	user_id
array<int>	$question_ids

Definition at line 122 of file GeneralQuestionPropertiesRepository.php.

                                                                                 : bool
    {
        $result = $this->db->queryF(
            'SELECT COUNT(DISTINCT question_fi) cnt FROM ' . self::TEST_RESULTS_TABLE . ' JOIN tst_active'
            . ' ON (active_id = active_fi)'
            . ' WHERE ' . $this->db->in('question_fi', $question_ids, false, \ilDBConstants::T_INTEGER)
            . ' AND user_fi = %s',
            [\ilDBConstants::T_INTEGER],
            [$user_id]
        );
 
        $row = $this->db->fetchObject($result);
        return $row->cnt === count($question_ids);
    }

References $user_id, and ilDBConstants\T_INTEGER.

◆ buildGeneralQuestionPropertyFromDBRecords()

ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository::buildGeneralQuestionPropertyFromDBRecords ( \stdClass $db_record )

private

Definition at line 323 of file GeneralQuestionPropertiesRepository.php.

                                                                                    : GeneralQuestionProperties
    {
        return new GeneralQuestionProperties(
            $this->component_factory,
            $db_record->question_id,
            $db_record->original_id,
            $db_record->external_id,
            $db_record->obj_fi,
            $db_record->oq_obj_fi,
            $db_record->question_type_fi,
            $db_record->type_tag,
            $db_record->owner,
            $db_record->title,
            $db_record->description,
            $db_record->question_text,
            $db_record->points,
            $db_record->nr_of_tries,
            $db_record->lifecycle,
            $db_record->author,
            $db_record->tstamp,
            $db_record->created,
            (bool) $db_record->complete,
            $db_record->add_cont_edit_mode
        );
    }

◆ getForParentObjectId()

ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository::getForParentObjectId ( int $obj_id )

Returns: array<GeneralQuestionProperties>

Definition at line 53 of file GeneralQuestionPropertiesRepository.php.

                                                     : array
    {
        return $this->getForWhereClause('q.obj_fi=' . $obj_id);
    }

References ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository\getForWhereClause().

Here is the call graph for this function:

◆ getForQuestionId()

ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository::getForQuestionId ( int $question_id )

Definition at line 40 of file GeneralQuestionPropertiesRepository.php.

                                                      : ?GeneralQuestionProperties
    {
        if ($question_id < 1) {
            return new GeneralQuestionProperties($this->component_factory, $question_id);
        }
 
        $question_data = $this->getForWhereClause('q.question_id=' . $question_id);
        return $question_data[$question_id] ?? null;
    }

References ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository\getForWhereClause().

Referenced by assQuestion\instantiateQuestion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getForQuestionIds()

ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository::getForQuestionIds ( array $question_ids )

Parameters

array<int> $question_ids

Returns: array<GeneralQuestionProperties>

Definition at line 63 of file GeneralQuestionPropertiesRepository.php.

                                                          : array
    {
        return $this->getForWhereClause(
            $this->db->in(
                'q.question_id',
                $question_ids,
                false,
                \ilDBConstants::T_INTEGER
            )
        );
    }

References ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository\getForWhereClause(), and ilDBConstants\T_INTEGER.

Here is the call graph for this function:

◆ getForWhereClause()

ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository::getForWhereClause ( string $where )

private

Returns: array<GeneralQuestionProperties>

Definition at line 352 of file GeneralQuestionPropertiesRepository.php.

                                                     : array
    {
        $query_result = $this->db->query(
            'SELECT q.*, qt.type_tag, qt.plugin as is_plugin, qt.plugin_name, oq.obj_fi as oq_obj_fi'
            . ' FROM ' . self::MAIN_QUESTION_TABLE . ' q'
            . ' INNER JOIN ' . self::QUESTION_TYPES_TABLE . ' qt'
            . ' ON q.question_type_fi = qt.question_type_id'
            . ' LEFT JOIN ' . self::MAIN_QUESTION_TABLE . ' oq'
            . ' ON oq.question_id = q.original_id'
            . ' WHERE ' . $where
        );
 
        $questions = [];
        while ($db_record = $this->db->fetchObject($query_result)) {
            if (!$this->isQuestionTypeAvailable($db_record->plugin_name)) {
                continue;
            }
            $questions[$db_record->question_id] = $this
                ->buildGeneralQuestionPropertyFromDBRecords($db_record);
        }
        return $questions;
    }

Referenced by ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository\getForParentObjectId(), ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository\getForQuestionId(), and ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository\getForQuestionIds().

Here is the caller graph for this function:

◆ getFractionOfReachedToReachablePointsTotal()

ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository::getFractionOfReachedToReachablePointsTotal ( int $question_id )

Definition at line 75 of file GeneralQuestionPropertiesRepository.php.

                                                                                : float
    {
        $questions_result = $this->db->queryF(
            'SELECT question_id, points FROM ' . self::MAIN_QUESTION_TABLE . ' WHERE original_id = %s OR question_id = %s',
            [\ilDBConstants::T_INTEGER,\ilDBConstants::T_INTEGER],
            [$question_id, $question_id]
        );
        if ($this->db->numRows($questions_result) === 0) {
            return 0.0;
        }
 
        $found_questions = [];
        while ($found_questions_row = $this->db->fetchObject($questions_result)) {
            $found_questions[$found_questions_row->question_id] = $found_questions_row->points;
        }
 
        $points_result = $this->db->query(
            'SELECT question_fi, points FROM ' . self::TEST_RESULTS_TABLE
            . ' WHERE ' . $this->db->in('question_fi', array_keys($found_questions), false, \ilDBConstants::T_INTEGER)
        );
 
        $answers = [];
        while ($points_row = $this->db->fetchObject($points_result)) {
            $answers[] = [
                'reached' => $points_row->points,
                'reachable' => $found_questions[$points_row->question_fi]
            ];
        }
 
        $reachable = 0.0;
        $reached = 0.0;
        foreach ($answers as $points) {
            $reachable += $points['reachable'];
            $reached += $points['reached'];
        }
        if ($reachable > 0) {
            return $reached / $reachable;
        }
        return 0;
    }

References ilDBConstants\T_INTEGER.

◆ getQuestionsMissingResultRecord()

ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository::getQuestionsMissingResultRecord	(	int	$active_id,
		int	$pass,
		array	$question_ids
	)

Definition at line 277 of file GeneralQuestionPropertiesRepository.php.

     : array {
        $in_question_ids = $this->db->in('question_fi', $question_ids, false, \ilDBConstants::T_INTEGER);
 
        $result = $this->db->queryF(
            'SELECT question_fi'
            . ' FROM ' . self::TEST_RESULTS_TABLE
            . ' WHERE active_fi = %s'
            . ' AND pass = %s'
            . ' AND ' . $in_question_ids,
            [\ilDBConstants::T_INTEGER, \ilDBConstants::T_INTEGER],
            [$active_id, $pass]
        );
 
        $questions_having_result_record = [];
 
        while ($row = $this->db->fetchObject($result)) {
            $questions_having_result_record[] = $row->question_fi;
        }
 
        $questions_missing_result_record = array_diff(
            $question_ids,
            $questions_having_result_record
        );
 
        return $questions_missing_result_record;
    }

◆ isInActiveTest()

ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository::isInActiveTest ( int $obj_id )

Definition at line 308 of file GeneralQuestionPropertiesRepository.php.

                                               : bool
    {
        $result = $this->db->query(
            'SELECT COUNT(user_fi) cnt FROM ' . self::TEST_TO_ACTIVE_USER_TABLE
            . ' JOIN ' . self::TEST_FIXED_QUESTION_TABLE
            . ' ON ' . self::TEST_FIXED_QUESTION_TABLE . '.test_fi = ' . self::TEST_TO_ACTIVE_USER_TABLE . '.test_fi '
            . ' JOIN ' . self::MAIN_QUESTION_TABLE
            . ' ON ' . self::MAIN_QUESTION_TABLE . '.question_id = ' . self::TEST_FIXED_QUESTION_TABLE . '.question_fi '
            . ' WHERE ' . self::MAIN_QUESTION_TABLE . '.obj_fi = ' . $this->db->quote($obj_id, \ilDBConstants::T_INTEGER)
        );
 
        $row = $this->db->fetchObject($result);
        return $row->cnt > 0;
    }

References ilDBConstants\T_INTEGER.

◆ isInUse()

ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository::isInUse ( int $question_id = 0 )

Definition at line 153 of file GeneralQuestionPropertiesRepository.php.

                                                 : bool
    {
        return $this->usageCount($question_id) > 0;
    }

References ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository\usageCount().

Here is the call graph for this function:

◆ isQuestionTypeAvailable()

ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository::isQuestionTypeAvailable ( ?string $plugin_name )

private

Definition at line 378 of file GeneralQuestionPropertiesRepository.php.

                                                                  : bool
    {
        if ($plugin_name === null) {
            return true;
        }
 
        $plugin_slot = $this->component_repository->getComponentByTypeAndName(
            \ilComponentInfo::TYPE_COMPONENT,
            'TestQuestionPool'
        )->getPluginSlotById('qst');
 
        if (!$plugin_slot->hasPluginName($plugin_name)) {
            return false;
        }
 
        return $plugin_slot->getPluginByName($plugin_name)->isActive();
    }

References ilComponentInfo\TYPE_COMPONENT.

◆ isUsedInRandomTest()

ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository::isUsedInRandomTest ( int $question_id )

Definition at line 247 of file GeneralQuestionPropertiesRepository.php.

                                                        : bool
    {
        $result = $this->db->queryF(
            'SELECT COUNT(test_random_question_id) cnt'
            . ' FROM ' . self::TEST_RANDOM_QUESTION_TABLE
            . ' WHERE question_fi = %s',
            [\ilDBConstants::T_INTEGER],
            [$question_id]
        );
 
        $row = $this->db->fetchObject($result);
        return $row->cnt > 0;
    }

References ilDBConstants\T_INTEGER.

◆ lookupResultRecordExist()

ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository::lookupResultRecordExist	(	int	$active_id,
		int	$question_id,
		int	$pass
	)

Definition at line 137 of file GeneralQuestionPropertiesRepository.php.

                                                                                        : bool
    {
        $result = $this->db->queryF(
            'SELECT COUNT(*) cnt '
            . ' FROM ' . self::TEST_RESULTS_TABLE
            . ' WHERE active_fi = %s'
            . ' AND question_fi = %s'
            . ' AND pass = %s',
            [\ilDBConstants::T_INTEGER, \ilDBConstants::T_INTEGER, \ilDBConstants::T_INTEGER],
            [$active_id, $question_id, $pass]
        );
 
        $row = $this->db->fetchObject($result);
        return $row->cnt > 0;
    }

References ilDBConstants\T_INTEGER.

◆ originalQuestionExists()

ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository::originalQuestionExists ( int $question_id )

Definition at line 261 of file GeneralQuestionPropertiesRepository.php.

                                                            : bool
    {
        $res = $this->db->queryF(
            'SELECT COUNT(dupl.question_id) cnt'
            . ' FROM ' . self::MAIN_QUESTION_TABLE . ' dupl'
            . ' INNER JOIN ' . self::MAIN_QUESTION_TABLE . ' orig'
            . ' ON orig.question_id = dupl.original_id'
            . ' WHERE dupl.question_id = %s',
            [\ilDBConstants::T_INTEGER],
            [$question_id]
        );
        $row = $this->db->fetchObject($res);
 
        return $row->cnt > 0;
    }

References $res, and ilDBConstants\T_INTEGER.

◆ questionExists()

ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository::questionExists ( int $question_id )

Definition at line 214 of file GeneralQuestionPropertiesRepository.php.

                                                    : bool
    {
        if ($question_id < 1) {
            return false;
        }
 
        $result = $this->db->queryF(
            'SELECT COUNT(question_id) cnt FROM ' . self::MAIN_QUESTION_TABLE . ' WHERE question_id = %s',
            [\ilDBConstants::T_INTEGER],
            [$question_id]
        );
 
        $row = $this->db->fetchObject($result);
        return $row->cnt === 1;
    }

References ilDBConstants\T_INTEGER.

◆ questionExistsInPool()

ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository::questionExistsInPool ( int $question_id )

Definition at line 230 of file GeneralQuestionPropertiesRepository.php.

                                                          : bool
    {
        if ($question_id < 1) {
            return false;
        }
 
        $result = $this->db->queryF(
            'SELECT COUNT(question_id) cnt FROM ' . self::MAIN_QUESTION_TABLE
            . ' INNER JOIN ' . self::DATA_TABLE . ' ON obj_fi = obj_id WHERE question_id = %s AND type = "qpl"',
            [\ilDBConstants::T_INTEGER],
            [$question_id]
        );
 
        $row = $this->db->fetchObject($result);
        return $row->cnt === 1;
    }

References ILIAS\components\ResourceStorage\Container\View\DATA_TABLE, and ilDBConstants\T_INTEGER.

◆ searchQuestionIdsByTitle()

ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository::searchQuestionIdsByTitle ( string $title )

Returns: array<int>

Definition at line 197 of file GeneralQuestionPropertiesRepository.php.

                                                           : array
    {
        if ($title === '') {
            return [];
        }
 
        $result = $this->db->query(
            'SELECT question_id  FROM ' . self::MAIN_QUESTION_TABLE . ' WHERE '
                . $this->db->like('title', \ilDBConstants::T_TEXT, "%{$title}%"),
        );
 
        return array_map(
            static fn(\stdClass $q): int => $q->question_id,
            $this->db->fetchAll($result, \ilDBConstants::FETCHMODE_OBJECT)
        );
    }

References $q, ilDBConstants\FETCHMODE_OBJECT, and ilDBConstants\T_TEXT.

◆ usageCount()

ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository::usageCount ( int $question_id = 0 )

Returns the number of place the question is in use in pools or tests.

Definition at line 161 of file GeneralQuestionPropertiesRepository.php.

                                                    : int
    {
        $result_tests_fixed = $this->db->queryF(
            'SELECT COUNT(' . self::MAIN_QUESTION_TABLE . '.question_id) question_count'
            . ' FROM ' . self::MAIN_QUESTION_TABLE . ', ' . self::TEST_FIXED_QUESTION_TABLE
            . ' WHERE ' . self::MAIN_QUESTION_TABLE . '.question_id = ' . self::TEST_FIXED_QUESTION_TABLE . '.question_fi'
            . ' AND ' . self::MAIN_QUESTION_TABLE . '.original_id = %s',
            [\ilDBConstants::T_INTEGER],
            [$question_id]
        );
        $row_tests_fixed = $this->db->fetchObject($result_tests_fixed);
        $count = $row_tests_fixed->question_count;
 
        $result_tests_random = $this->db->queryF(
            'SELECT COUNT(' . self::TEST_TO_ACTIVE_USER_TABLE . '.test_fi) question_count'
            . ' FROM ' . self::MAIN_QUESTION_TABLE
            . ' INNER JOIN ' . self::TEST_RANDOM_QUESTION_TABLE
            . ' ON ' . self::TEST_RANDOM_QUESTION_TABLE . '.question_fi = ' . self::MAIN_QUESTION_TABLE . '.question_id'
            . ' INNER JOIN ' . self::TEST_TO_ACTIVE_USER_TABLE
            . ' ON ' . self::TEST_TO_ACTIVE_USER_TABLE . '.active_id = ' . self::TEST_RANDOM_QUESTION_TABLE . '.active_fi'
            . ' WHERE ' . self::MAIN_QUESTION_TABLE . '.original_id = %s'
            . ' GROUP BY tst_active.test_fi',
            [\ilDBConstants::T_INTEGER],
            [$question_id]
        );
        $row_tests_random = $this->db->fetchObject($result_tests_random);
        if ($row_tests_random !== null) {
            $count += $row_tests_random->question_count;
        }
 
        return $count;
    }

References ilDBConstants\T_INTEGER.

Referenced by ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository\isInUse().

Here is the caller graph for this function:

Field Documentation

◆ DATA_TABLE

const ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository::DATA_TABLE = 'object_data'

private

Definition at line 31 of file GeneralQuestionPropertiesRepository.php.

◆ MAIN_QUESTION_TABLE

const ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository::MAIN_QUESTION_TABLE = 'qpl_questions'

private

Definition at line 25 of file GeneralQuestionPropertiesRepository.php.

◆ QUESTION_TYPES_TABLE

const ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository::QUESTION_TYPES_TABLE = 'qpl_qst_type'

private

Definition at line 26 of file GeneralQuestionPropertiesRepository.php.

◆ TEST_FIXED_QUESTION_TABLE

const ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository::TEST_FIXED_QUESTION_TABLE = 'tst_test_question'

private

Definition at line 27 of file GeneralQuestionPropertiesRepository.php.

◆ TEST_RANDOM_QUESTION_TABLE

const ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository::TEST_RANDOM_QUESTION_TABLE = 'tst_test_rnd_qst'

private

Definition at line 28 of file GeneralQuestionPropertiesRepository.php.

◆ TEST_RESULTS_TABLE

const ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository::TEST_RESULTS_TABLE = 'tst_test_result'

private

Definition at line 29 of file GeneralQuestionPropertiesRepository.php.

◆ TEST_TO_ACTIVE_USER_TABLE

const ILIAS\TestQuestionPool\Questions\GeneralQuestionPropertiesRepository::TEST_TO_ACTIVE_USER_TABLE = 'tst_active'

private

Definition at line 30 of file GeneralQuestionPropertiesRepository.php.

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

components/ILIAS/TestQuestionPool/src/Questions/GeneralQuestionPropertiesRepository.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ areQuestionsAnsweredByUser()

◆ buildGeneralQuestionPropertyFromDBRecords()

◆ getForParentObjectId()

◆ getForQuestionId()

◆ getForQuestionIds()

◆ getForWhereClause()

◆ getFractionOfReachedToReachablePointsTotal()

◆ getQuestionsMissingResultRecord()

◆ isInActiveTest()

◆ isInUse()

◆ isQuestionTypeAvailable()

◆ isUsedInRandomTest()

◆ lookupResultRecordExist()

◆ originalQuestionExists()

◆ questionExists()

◆ questionExistsInPool()

◆ searchQuestionIdsByTitle()

◆ usageCount()

Field Documentation

◆ DATA_TABLE

◆ MAIN_QUESTION_TABLE

◆ QUESTION_TYPES_TABLE

◆ TEST_FIXED_QUESTION_TABLE

◆ TEST_RANDOM_QUESTION_TABLE

◆ TEST_RESULTS_TABLE

◆ TEST_TO_ACTIVE_USER_TABLE