Inheritance diagram for ilAssQuestionList:

Collaboration diagram for ilAssQuestionList:

Public Member Functions
	__construct (private ilDBInterface $db, private ilLanguage $lng, private Refinery $refinery, private ilComponentRepository $component_repository, private ?NotesService $notes_service=null)

	setOrder (?Order $order=null)

	setRange (?Range $range=null)

	getParentObjId ()

	setParentObjId (?int $parentObjId)

	setParentObjectType (string $parentObjType)

	setParentObjIdsFilter (array $parentObjIdsFilter)

	setQuestionInstanceTypeFilter (?string $questionInstanceTypeFilter)

	setIncludeQuestionIdsFilter (array $questionIdsFilter)

	setExcludeQuestionIdsFilter (array $excludeQuestionIdsFilter)

	addFieldFilter (string $fieldName, mixed $fieldValue)

	addTaxonomyFilter ($taxId, $taxNodes, $parentObjId, $parentObjType)

	addTaxonomyFilterNoTaxonomySet (bool $flag)

	setAvailableTaxonomyIds (array $availableTaxonomyIds)

	setAnswerStatusActiveId (?int $answerStatusActiveId)

	setAnswerStatusFilter (string $answerStatusFilter)

	setJoinObjectData (bool $a_val)
	Set if object data table should be joined. More...

	load ()

	getTotalRowCount (mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)

	setCommentFilter (?int $commented=null)

	getDataArrayForQuestionId (int $questionId)

	getQuestionDataArray ()

	isInList (int $questionId)

	getTitle (string $a_comp_id, string $a_item_type, int $a_item_id)
	Get title of an assigned item. More...

	getTitle (string $a_comp_id, string $a_item_type, int $a_item_id)
	Get title of an assigned item. More...

Data Fields
const	QUESTION_ANSWER_STATUS_NON_ANSWERED = 'nonAnswered'
	answer status domain for single questions More...

const	QUESTION_ANSWER_STATUS_WRONG_ANSWERED = 'wrongAnswered'

const	QUESTION_ANSWER_STATUS_CORRECT_ANSWERED = 'correctAnswered'

const	ANSWER_STATUS_FILTER_ALL_NON_CORRECT = 'allNonCorrect'
	answer status filter value domain More...

const	ANSWER_STATUS_FILTER_NON_ANSWERED_ONLY = 'nonAnswered'

const	ANSWER_STATUS_FILTER_WRONG_ANSWERED_ONLY = 'wrongAnswered'

const	QUESTION_INSTANCE_TYPE_ORIGINALS = 'QST_INSTANCE_TYPE_ORIGINALS'

const	QUESTION_INSTANCE_TYPE_DUPLICATES = 'QST_INSTANCE_TYPE_DUPLICATES'

const	QUESTION_INSTANCE_TYPE_ALL = 'QST_INSTANCE_TYPE_ALL'

const	QUESTION_COMMENTED_ONLY = '1'

const	QUESTION_COMMENTED_EXCLUDED = '2'

Protected Member Functions
	getTaxItems (string $parentType, int $parentObjId, int $taxId, int $taxNode)

	getNumberOfCommentsForQuestion (int $question_id)

Protected Attributes
bool	$join_obj_data = true

string	$filter_comments = null

array	$questions = []

Private Member Functions
	getParentObjFilterExpression ()

	getFieldFilterExpressions ()

	addFeedbackJoinIfNeeded (string $table_join)

	getTaxonomyFilterExpressions ()

	getFilterByAssignedTaxonomyIdsExpression ()

	getQuestionInstanceTypeFilterExpression ()

	getQuestionIdsFilterExpressions ()

	getAnswerStatusFilterExpressions ()

	getTableJoinExpression ()

	getConditionalFilterExpression ()

	getSelectFieldsExpression ()

	generateFeedbackSubquery ()

	generateTaxonomySubquery ()

	buildBasicQuery ()

	getHavingFilterExpression ()

	buildOrderQueryExpression ()

	buildLimitQueryExpression ()

	getOrderFieldAndDirection (?Order $order)

	buildQuery ()

	orderAndLimitByQuestionType (array $questions)

	loadTaxonomyAssignmentData (int $parent_obj_id, int $question_id)

	isActiveQuestionType (array $questionData)

	checkFilters ()

Private Attributes
array	$parentObjIdsFilter = []

int	$parentObjId = null

string	$parentObjType = 'qpl'

array	$availableTaxonomyIds = []

array	$fieldFilters = []

array	$taxFilters = []

bool	$taxFiltersExcludeAnyObjectsWithTaxonomies = false

array	$taxParentIds = []

array	$taxParentTypes = []

int	$answerStatusActiveId = null

string	$answerStatusFilter = ''

string	$questionInstanceTypeFilter = self::QUESTION_INSTANCE_TYPE_ORIGINALS

array	$includeQuestionIdsFilter = []

array	$excludeQuestionIdsFilter = []

string	$order_field = null

string	$order_direction = null

Range	$range = null

Detailed Description

Definition at line 30 of file class.ilAssQuestionList.php.

Constructor & Destructor Documentation

◆ __construct()

ilAssQuestionList::__construct	(	private ilDBInterface	$db,
		private ilLanguage	$lng,
		private Refinery	$refinery,
		private ilComponentRepository	$component_repository,
		private ?NotesService	$notes_service = `null`
	)

Definition at line 78 of file class.ilAssQuestionList.php.

84 {

85 }

Member Function Documentation

◆ addFeedbackJoinIfNeeded()

ilAssQuestionList::addFeedbackJoinIfNeeded ( string $table_join )

private

Definition at line 220 of file class.ilAssQuestionList.php.

                                                                : string
    {
        $feedback_join = match ($this->fieldFilters['feedback'] ?? null) {
            'true' => 'INNER',
            'false' => 'LEFT',
            default => null
        };
 
        if (isset($feedback_join)) {
            $sql = "{$feedback_join} JOIN qpl_fb_generic ON qpl_fb_generic.question_fi = qpl_questions.question_id ";
            $table_join .= !str_contains($table_join, $sql) ? $sql : '';
        }
 
        return $table_join;
    }

Referenced by getTableJoinExpression().

Here is the caller graph for this function:

◆ addFieldFilter()

ilAssQuestionList::addFieldFilter	(	string	$fieldName,
		mixed	$fieldValue
	)

Definition at line 135 of file class.ilAssQuestionList.php.

                                                                        : void
    {
        $this->fieldFilters[$fieldName] = $fieldValue;
    }

◆ addTaxonomyFilter()

ilAssQuestionList::addTaxonomyFilter	(	$taxId,
		$taxNodes,
		$parentObjId,
		$parentObjType
	)

Definition at line 140 of file class.ilAssQuestionList.php.

                                                                                      : void
    {
        $this->taxFilters[$taxId] = $taxNodes;
        $this->taxParentIds[$taxId] = $parentObjId;
        $this->taxParentTypes[$taxId] = $parentObjType;
    }

References $parentObjId, and $parentObjType.

◆ addTaxonomyFilterNoTaxonomySet()

ilAssQuestionList::addTaxonomyFilterNoTaxonomySet ( bool $flag )

Definition at line 147 of file class.ilAssQuestionList.php.

                                                              : void
    {
        $this->taxFiltersExcludeAnyObjectsWithTaxonomies = $flag;
    }

◆ buildBasicQuery()

ilAssQuestionList::buildBasicQuery ( )

private

Definition at line 491 of file class.ilAssQuestionList.php.

                                      : string
    {
        return "{$this->getSelectFieldsExpression()} FROM qpl_questions {$this->getTableJoinExpression()} WHERE qpl_questions.tstamp > 0";
    }

Referenced by buildQuery().

Here is the caller graph for this function:

◆ buildLimitQueryExpression()

ilAssQuestionList::buildLimitQueryExpression ( )

private

Definition at line 522 of file class.ilAssQuestionList.php.

                                                : string
    {
        if ($this->order_field === 'question_type'
            || $this->range === null) {
            return '';
        }
 
        $limit = max($this->range->getLength(), 0);
        $offset = max($this->range->getStart(), 0);
 
        return " LIMIT {$limit} OFFSET {$offset}";
    }

Referenced by buildQuery().

Here is the caller graph for this function:

◆ buildOrderQueryExpression()

ilAssQuestionList::buildOrderQueryExpression ( )

private

Definition at line 515 of file class.ilAssQuestionList.php.

                                                : string
    {
        return $this->order_field === null || $this->order_direction === null || $this->order_field === 'question_type'
            ? ''
            : " ORDER BY `$this->order_field` $this->order_direction";
    }

Referenced by buildQuery().

Here is the caller graph for this function:

◆ buildQuery()

ilAssQuestionList::buildQuery ( )

private

Definition at line 556 of file class.ilAssQuestionList.php.

                                 : string
    {
        return implode(PHP_EOL, array_filter([
            $this->buildBasicQuery(),
            $this->getConditionalFilterExpression(),
            $this->getHavingFilterExpression(),
            $this->buildOrderQueryExpression(),
            $this->buildLimitQueryExpression(),
        ]));
    }

References buildBasicQuery(), buildLimitQueryExpression(), buildOrderQueryExpression(), getConditionalFilterExpression(), and getHavingFilterExpression().

Referenced by load().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkFilters()

ilAssQuestionList::checkFilters ( )

private

Definition at line 740 of file class.ilAssQuestionList.php.

                                   : void
    {
        if ($this->answerStatusFilter !== '' && !$this->answerStatusActiveId) {
            throw new ilTestQuestionPoolException(
                'No active id given! You cannot use the answer status filter without giving an active id.'
            );
        }
    }

Referenced by load().

Here is the caller graph for this function:

◆ generateFeedbackSubquery()

ilAssQuestionList::generateFeedbackSubquery ( )

private

Definition at line 460 of file class.ilAssQuestionList.php.

                                               : string
    {
        $cases = [];
        $tables = ['qpl_fb_generic', 'qpl_fb_specific'];
 
        foreach ($tables as $table) {
            $subquery = "SELECT 1 FROM $table WHERE $table.question_fi = qpl_questions.question_id AND $table.feedback <> ''";
            $cases[] = "WHEN EXISTS ($subquery) THEN TRUE";
        }
 
        $page_object_table = 'page_object';
        foreach ($tables as $table) {
            $subquery = sprintf(
                "SELECT 1 FROM $table JOIN $page_object_table ON $page_object_table.page_id = $table.feedback_id WHERE $page_object_table.parent_type IN ('%s', '%s') AND $page_object_table.is_empty <> 1 AND $table.question_fi = qpl_questions.question_id",
                \ilAssQuestionFeedback::PAGE_OBJECT_TYPE_GENERIC_FEEDBACK,
                \ilAssQuestionFeedback::PAGE_OBJECT_TYPE_SPECIFIC_FEEDBACK,
            );
            $cases[] = "WHEN EXISTS ($subquery) THEN TRUE";
        }
 
        $feedback_case_subquery = implode(' ', $cases);
        return "CASE $feedback_case_subquery ELSE FALSE END AS feedback";
    }

References ilAssQuestionFeedback\PAGE_OBJECT_TYPE_GENERIC_FEEDBACK, and ilAssQuestionFeedback\PAGE_OBJECT_TYPE_SPECIFIC_FEEDBACK.

Referenced by getSelectFieldsExpression().

Here is the caller graph for this function:

◆ generateTaxonomySubquery()

ilAssQuestionList::generateTaxonomySubquery ( )

private

Definition at line 484 of file class.ilAssQuestionList.php.

                                               : string
    {
        $tax_node_assignment_table = 'tax_node_assignment';
        $tax_subquery = "SELECT 1 FROM $tax_node_assignment_table WHERE $tax_node_assignment_table.item_id = qpl_questions.question_id AND $tax_node_assignment_table.item_type = 'quest'";
        return "CASE WHEN EXISTS ($tax_subquery) THEN TRUE ELSE FALSE END AS taxonomies";
    }

Referenced by getSelectFieldsExpression().

Here is the caller graph for this function:

◆ getAnswerStatusFilterExpressions()

ilAssQuestionList::getAnswerStatusFilterExpressions ( )

private

Definition at line 358 of file class.ilAssQuestionList.php.

                                                       : array
    {
        return match ($this->answerStatusFilter) {
            self::ANSWER_STATUS_FILTER_ALL_NON_CORRECT => ['
                (tst_test_result.question_fi IS NULL OR tst_test_result.points < qpl_questions.points)
            '],
            self::ANSWER_STATUS_FILTER_NON_ANSWERED_ONLY => ['tst_test_result.question_fi IS NULL'],
            self::ANSWER_STATUS_FILTER_WRONG_ANSWERED_ONLY => [
                'tst_test_result.question_fi IS NOT NULL',
                'tst_test_result.points < qpl_questions.points'
            ],
            default => [],
        };
    }

Referenced by getConditionalFilterExpression().

Here is the caller graph for this function:

◆ getConditionalFilterExpression()

ilAssQuestionList::getConditionalFilterExpression ( )

private

Definition at line 404 of file class.ilAssQuestionList.php.

                                                     : string
    {
        $conditions = [];
 
        if ($this->getQuestionInstanceTypeFilterExpression() !== null) {
            $conditions[] = $this->getQuestionInstanceTypeFilterExpression();
        }
 
        if ($this->getParentObjFilterExpression() !== null) {
            $conditions[] = $this->getParentObjFilterExpression();
        }
 
        $conditions = array_merge(
            $conditions,
            $this->getQuestionIdsFilterExpressions(),
            $this->getFieldFilterExpressions(),
            $this->getTaxonomyFilterExpressions(),
            $this->getAnswerStatusFilterExpressions()
        );
 
        $conditions = implode(' AND ', $conditions);
        return $conditions !== '' ? "AND $conditions" : '';
    }

References getAnswerStatusFilterExpressions(), getFieldFilterExpressions(), getParentObjFilterExpression(), getQuestionIdsFilterExpressions(), getQuestionInstanceTypeFilterExpression(), and getTaxonomyFilterExpressions().

Referenced by buildQuery().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDataArrayForQuestionId()

ilAssQuestionList::getDataArrayForQuestionId ( int $questionId )

Definition at line 707 of file class.ilAssQuestionList.php.

                                                              : array
    {
        return $this->questions[$questionId];
    }

◆ getFieldFilterExpressions()

ilAssQuestionList::getFieldFilterExpressions ( )

private

Definition at line 188 of file class.ilAssQuestionList.php.

                                                : array
    {
        $expressions = [];
 
        foreach ($this->fieldFilters as $fieldName => $fieldValue) {
            switch ($fieldName) {
                case 'title':
                case 'description':
                case 'author':
                case 'lifecycle':
                    $expressions[] = $this->db->like("qpl_questions.$fieldName", ilDBConstants::T_TEXT, "%%$fieldValue%%");
                    break;
                case 'type':
                    $expressions[] = "qpl_qst_type.type_tag = {$this->db->quote($fieldValue, ilDBConstants::T_TEXT)}";
                    break;
                case 'question_id':
                    if ($fieldValue !== '' && !is_array($fieldValue)) {
                        $fieldValue = [$fieldValue];
                    }
                    $expressions[] = $this->db->in('qpl_questions.question_id', $fieldValue, false, ilDBConstants::T_INTEGER);
                    break;
                case 'parent_title':
                    if ($this->join_obj_data) {
                        $expressions[] = $this->db->like('object_data.title', ilDBConstants::T_TEXT, "%%$fieldValue%%");
                    }
                    break;
            }
        }
 
        return $expressions;
    }

References ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

Referenced by getConditionalFilterExpression().

Here is the caller graph for this function:

◆ getFilterByAssignedTaxonomyIdsExpression()

ilAssQuestionList::getFilterByAssignedTaxonomyIdsExpression ( )

private

Definition at line 264 of file class.ilAssQuestionList.php.

                                                               : array
    {
        if ($this->taxFiltersExcludeAnyObjectsWithTaxonomies) {
            return ['question_id NOT IN (SELECT DISTINCT item_id FROM tax_node_assignment)'];
        }
 
        $expressions = [];
        foreach ($this->taxFilters as $tax_id => $tax_nodes) {
            $question_ids = [];
 
            if ($tax_nodes === []) {
                continue;
            }
 
            foreach ($tax_nodes as $tax_node) {
                $tax_items_by_tax_parent = $this->getTaxItems(
                    $this->taxParentTypes[$tax_id],
                    $this->taxParentIds[$tax_id],
                    $tax_id,
                    $tax_node
                );
 
                $tax_items_by_parent = $this->getTaxItems(
                    $this->parentObjType,
                    $this->parentObjId,
                    $tax_id,
                    $tax_node
                );
 
                $tax_items = array_merge($tax_items_by_tax_parent, $tax_items_by_parent);
                foreach ($tax_items as $tax_item) {
                    $question_ids[$tax_item['item_id']] = $tax_item['item_id'];
                }
            }
 
            $expressions[] = $this->db->in('question_id', $question_ids, false, ilDBConstants::T_INTEGER);
        }
 
        return $expressions;
    }

References getTaxItems(), and ilDBConstants\T_INTEGER.

Referenced by getTaxonomyFilterExpressions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHavingFilterExpression()

ilAssQuestionList::getHavingFilterExpression ( )

private

Definition at line 496 of file class.ilAssQuestionList.php.

                                                : string
    {
        $expressions = [];
 
        foreach ($this->fieldFilters as $fieldName => $fieldValue) {
            if ($fieldName === 'feedback') {
                $fieldValue = strtoupper($fieldValue);
                if (in_array($fieldValue, ['TRUE', 'FALSE'], true)) {
                    $expressions[] = "feedback IS $fieldValue";
                }
                continue;
 
            }
        }
 
        $having = implode(' AND ', $expressions);
        return $having !== '' ? "HAVING $having" : '';
    }

Referenced by buildQuery().

Here is the caller graph for this function:

◆ getNumberOfCommentsForQuestion()

ilAssQuestionList::getNumberOfCommentsForQuestion ( int $question_id )

protected

Definition at line 637 of file class.ilAssQuestionList.php.

                                                                       : int
    {
        if ($this->notes_service === null) {
            return 0;
        }
        $notes_context = $this->notes_service->data()->context(
            $this->getParentObjId(),
            $question_id,
            'quest'
        );
        return $this->notes_service->domain()->getNrOfCommentsForContext($notes_context);
    }

Referenced by load().

Here is the caller graph for this function:

◆ getOrderFieldAndDirection()

ilAssQuestionList::getOrderFieldAndDirection ( ?Order $order )

private

Definition at line 535 of file class.ilAssQuestionList.php.

                                                             : ?array
    {
        if ($order === null) {
            return ['order_field' => null, 'order_direction' => null];
        }
 
        [$order_field, $order_direction] = $order->join(
            '',
            static fn(string $index, string $key, string $value): array => [
                $key,
                strtoupper($value)
            ]
        );
 
        if (!in_array($order_direction, [Order::ASC, Order::DESC], true)) {
            $order_direction = Order::ASC;
        }
 
        return ['order_field' => $order_field, 'order_direction' => $order_direction];
    }

References $order_direction, $order_field, and ILIAS\Data\Order\join().

Referenced by setOrder().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getParentObjFilterExpression()

ilAssQuestionList::getParentObjFilterExpression ( )

private

Definition at line 175 of file class.ilAssQuestionList.php.

                                                   : ?string
    {
        if ($this->parentObjId) {
            return "qpl_questions.obj_fi = {$this->db->quote($this->parentObjId, ilDBConstants::T_INTEGER)}";
        }
 
        if (!empty($this->parentObjIdsFilter)) {
            return $this->db->in('qpl_questions.obj_fi', $this->parentObjIdsFilter, false, ilDBConstants::T_INTEGER);
        }
 
        return null;
    }

References ilDBConstants\T_INTEGER.

Referenced by getConditionalFilterExpression().

Here is the caller graph for this function:

◆ getParentObjId()

ilAssQuestionList::getParentObjId ( )

Definition at line 100 of file class.ilAssQuestionList.php.

                                    : ?int
    {
        return $this->parentObjId;
    }

References $parentObjId.

Referenced by ilTestSkillEvaluation\init().

Here is the caller graph for this function:

◆ getQuestionDataArray()

ilAssQuestionList::getQuestionDataArray ( )

Definition at line 712 of file class.ilAssQuestionList.php.

                                          : array
    {
        return $this->questions;
    }

Referenced by ilTestSkillEvaluation\initTestQuestionData().

Here is the caller graph for this function:

◆ getQuestionIdsFilterExpressions()

ilAssQuestionList::getQuestionIdsFilterExpressions ( )

private

Definition at line 331 of file class.ilAssQuestionList.php.

                                                      : array
    {
        $expressions = [];
 
        if (!empty($this->includeQuestionIdsFilter)) {
            $expressions[] = $this->db->in(
                'qpl_questions.question_id',
                $this->includeQuestionIdsFilter,
                false,
                ilDBConstants::T_INTEGER
            );
        }
 
        if (!empty($this->excludeQuestionIdsFilter)) {
            $IN = $this->db->in(
                'qpl_questions.question_id',
                $this->excludeQuestionIdsFilter,
                true,
                ilDBConstants::T_INTEGER
            );
 
            $expressions[] = $IN === ' 1=2 ' ? ' 1=1 ' : $IN; // required for ILIAS < 5.0
        }
 
        return $expressions;
    }

References ilDBConstants\T_INTEGER.

Referenced by getConditionalFilterExpression().

Here is the caller graph for this function:

◆ getQuestionInstanceTypeFilterExpression()

ilAssQuestionList::getQuestionInstanceTypeFilterExpression ( )

private

Definition at line 322 of file class.ilAssQuestionList.php.

                                                              : ?string
    {
        return match ($this->questionInstanceTypeFilter) {
            self::QUESTION_INSTANCE_TYPE_ORIGINALS => 'qpl_questions.original_id IS NULL',
            self::QUESTION_INSTANCE_TYPE_DUPLICATES => 'qpl_questions.original_id IS NOT NULL',
            default => null
        };
    }

Referenced by getConditionalFilterExpression().

Here is the caller graph for this function:

◆ getSelectFieldsExpression()

ilAssQuestionList::getSelectFieldsExpression ( )

private

Definition at line 428 of file class.ilAssQuestionList.php.

                                                : string
    {
        $select_fields = [
            'qpl_questions.*',
            'qpl_qst_type.type_tag AS question_type',
            'qpl_qst_type.plugin',
            'qpl_qst_type.plugin_name',
            'qpl_questions.points max_points'
        ];
 
        if ($this->join_obj_data) {
            $select_fields[] = 'object_data.title parent_title, object_data.type parent_type, object_reference.ref_id parent_ref_id';
        }
 
        if ($this->answerStatusActiveId) {
            $select_fields[] = 'tst_test_result.points reached_points';
            $select_fields[] = "CASE
                                        WHEN tst_test_result.points IS NULL THEN '" . self::QUESTION_ANSWER_STATUS_NON_ANSWERED . "'
                                        WHEN tst_test_result.points < qpl_questions.points THEN '" . self::QUESTION_ANSWER_STATUS_WRONG_ANSWERED . "'
                                        ELSE '" . self::QUESTION_ANSWER_STATUS_CORRECT_ANSWERED . "'
                                END question_answer_status
                        ";
        }
 
        $select_fields[] = $this->generateFeedbackSubquery();
 
        $select_fields[] = $this->generateTaxonomySubquery();
 
        $select_fields = implode(', ', $select_fields);
        return "SELECT DISTINCT $select_fields";
    }

References generateFeedbackSubquery(), and generateTaxonomySubquery().

Here is the call graph for this function:

◆ getTableJoinExpression()

ilAssQuestionList::getTableJoinExpression ( )

private

Definition at line 373 of file class.ilAssQuestionList.php.

                                             : string
    {
        $table_join = 'INNER JOIN qpl_qst_type ON qpl_qst_type.question_type_id = qpl_questions.question_type_fi ';
 
        if ($this->join_obj_data) {
            $table_join .= '
                INNER JOIN object_data ON object_data.obj_id = qpl_questions.obj_fi
                INNER JOIN object_reference ON object_reference.obj_id = object_data.obj_id
            ';
        }
 
        if (
            $this->parentObjType === 'tst'
            && $this->questionInstanceTypeFilter === self::QUESTION_INSTANCE_TYPE_ALL
        ) {
            $table_join .= 'INNER JOIN tst_test_question tstquest ON tstquest.question_fi = qpl_questions.question_id';
        }
 
        $table_join = $this->addFeedbackJoinIfNeeded($table_join);
 
        if ($this->answerStatusActiveId) {
            $table_join .= "
                                LEFT JOIN       tst_test_result
                                ON                      tst_test_result.question_fi = qpl_questions.question_id
                                AND                     tst_test_result.active_fi = {$this->db->quote($this->answerStatusActiveId, ilDBConstants::T_INTEGER)}
                        ";
        }
 
        return $table_join;
    }

References addFeedbackJoinIfNeeded().

Here is the call graph for this function:

◆ getTaxItems()

ilAssQuestionList::getTaxItems	(	string	$parentType,
		int	$parentObjId,
		int	$taxId,
		int	$taxNode
	)

protected

Definition at line 305 of file class.ilAssQuestionList.php.

                                                                                                  : array
    {
        $taxTree = new ilTaxonomyTree($taxId);
 
        $taxNodeAssignment = new ilTaxNodeAssignment(
            $parentType,
            $parentObjId,
            'quest',
            $taxId
        );
 
        $subNodes = $taxTree->getSubTreeIds($taxNode);
        $subNodes[] = $taxNode;
 
        return $taxNodeAssignment->getAssignmentsOfNode($subNodes);
    }

References $parentObjId.

Referenced by getFilterByAssignedTaxonomyIdsExpression().

Here is the caller graph for this function:

◆ getTaxonomyFilterExpressions()

ilAssQuestionList::getTaxonomyFilterExpressions ( )

private

Definition at line 236 of file class.ilAssQuestionList.php.

                                                   : array
    {
        $expressions = $this->getFilterByAssignedTaxonomyIdsExpression();
 
        $taxonomy_title = $this->fieldFilters['taxonomy_title'] ?? '';
        $taxonomy_node_title = $this->fieldFilters['taxonomy_node_title'] ?? '';
 
        if ($taxonomy_title === '' && $taxonomy_node_title === '') {
            return $expressions;
        }
 
        $base = 'SELECT DISTINCT item_id FROM tax_node_assignment';
 
        $like_taxonomy_title = $taxonomy_title !== ''
            ? "AND {$this->db->like('object_data.title', ilDBConstants::T_TEXT, "%$taxonomy_title%", false)}"
            : '';
        $like_taxonomy_node_title = $taxonomy_node_title !== ''
            ? "AND {$this->db->like('tax_node.title', ilDBConstants::T_TEXT, "%$taxonomy_node_title%", false)}"
            : '';
 
        $inner_join_object_data = "INNER JOIN object_data ON (object_data.obj_id = tax_node_assignment.tax_id AND object_data.type = 'tax' $like_taxonomy_title)";
        $inner_join_tax_node = "INNER JOIN tax_node ON (tax_node.tax_id = tax_node_assignment.tax_id AND tax_node.type = 'taxn' AND tax_node_assignment.node_id = tax_node.obj_id $like_taxonomy_node_title)";
 
        $expressions[] = "qpl_questions.question_id IN ($base $inner_join_object_data $inner_join_tax_node)";
 
        return $expressions;
    }

References getFilterByAssignedTaxonomyIdsExpression().

Referenced by getConditionalFilterExpression().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTitle()

ilAssQuestionList::getTitle	(	string	$a_comp_id,
		string	$a_item_type,
		int	$a_item_id
	)

Get title of an assigned item.

(is used from ilObjTaxonomyGUI when item sorting is activated)

Parameters

string	$a_comp_id	('qpl' in our context)
string	$a_item_type	('quest' in our context)
integer	$a_item_id	(questionId in our context)

Implements ilTaxAssignedItemInfo.

Definition at line 731 of file class.ilAssQuestionList.php.

                                                                                    : string
    {
        if ($a_comp_id !== 'qpl' || $a_item_type !== 'quest' || !$a_item_id) {
            return '';
        }
 
        return $this->questions[$a_item_id]['title'] ?? '';
    }

◆ getTotalRowCount()

ilAssQuestionList::getTotalRowCount	(	mixed	$additional_viewcontrol_data,
		mixed	$filter_data,
		mixed	$additional_parameters
	)

Reimplemented in ILIAS\TestQuestionPool\Questions\Presentation\QuestionTable.

Definition at line 624 of file class.ilAssQuestionList.php.

     : ?int {
        $this->checkFilters();
 
        $count = 'COUNT(*)';
        $query = "SELECT $count FROM qpl_questions {$this->getTableJoinExpression()} WHERE qpl_questions.tstamp > 0 {$this->getConditionalFilterExpression()}";
 
        return (int) ($this->db->query($query)->fetch()[$count] ?? 0);
    }

◆ isActiveQuestionType()

ilAssQuestionList::isActiveQuestionType ( array $questionData )

private

Definition at line 680 of file class.ilAssQuestionList.php.

                                                              : bool
    {
        if (!isset($questionData['plugin'])) {
            return false;
        }
 
        if (!$questionData['plugin']) {
            return true;
        }
 
        if (
            !isset($questionData['plugin_name'])
            || !$this->component_repository->getComponentByTypeAndName(
                ilComponentInfo::TYPE_COMPONENT,
                'TestQuestionPool'
            )->getPluginSlotById('qst')->hasPluginName($questionData['plugin_name'])
        ) {
            return false;
        }
 
        return $this->component_repository
            ->getComponentByTypeAndName(ilComponentInfo::TYPE_COMPONENT, 'TestQuestionPool')
            ->getPluginSlotById('qst')
            ->getPluginByName($questionData['plugin_name'])
            ->isActive();
    }

References ilComponentInfo\TYPE_COMPONENT.

Referenced by load().

Here is the caller graph for this function:

◆ isInList()

ilAssQuestionList::isInList ( int $questionId )

Definition at line 717 of file class.ilAssQuestionList.php.

                                             : bool
    {
        return isset($this->questions[$questionId]);
    }

◆ load()

ilAssQuestionList::load ( )

Definition at line 567 of file class.ilAssQuestionList.php.

                          : void
    {
        $this->checkFilters();
 
        $tags_trafo = $this->refinery->encode()->htmlSpecialCharsAsEntities();
 
        $res = $this->db->query($this->buildQuery());
        while ($row_from_db = $this->db->fetchAssoc($res)) {
            $row = ilAssQuestionType::completeMissingPluginName($row_from_db);
 
            if (!$this->isActiveQuestionType($row)) {
                continue;
            }
 
            $row['title'] = $tags_trafo->transform($row['title'] ?? '&nbsp;');
            $row['description'] = $tags_trafo->transform($row['description'] ?? '');
            $row['author'] = $tags_trafo->transform($row['author']);
            $row['taxonomies'] = $this->loadTaxonomyAssignmentData($row['obj_fi'], $row['question_id']);
            $row['question_type'] = $this->lng->txt($row['question_type']);
            $row['feedback'] = $row['feedback'] === 1;
            $row['comments'] = $this->getNumberOfCommentsForQuestion($row['question_id']);
 
            if (
                $this->filter_comments === self::QUESTION_COMMENTED_ONLY && $row['comments'] === 0
                || $this->filter_comments === self::QUESTION_COMMENTED_EXCLUDED && $row['comments'] > 0
            ) {
                continue;
            }
 
            $this->questions[$row['question_id']] = $row;
        }
 
        if ($this->order_field === 'question_type') {
            $this->questions = $this->orderAndLimitByQuestionType($this->questions);
        }
    }

References $res, buildQuery(), checkFilters(), ilAssQuestionType\completeMissingPluginName(), getNumberOfCommentsForQuestion(), isActiveQuestionType(), ILIAS\Repository\lng(), loadTaxonomyAssignmentData(), orderAndLimitByQuestionType(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

◆ loadTaxonomyAssignmentData()

ilAssQuestionList::loadTaxonomyAssignmentData	(	int	$parent_obj_id,
		int	$question_id
	)

private

Definition at line 655 of file class.ilAssQuestionList.php.

     : array {
        $tax_assignment_data = [];
        foreach ($this->availableTaxonomyIds as $tax_id) {
            $tax_tree = new ilTaxonomyTree($tax_id);
 
            $tax_assignment = new ilTaxNodeAssignment('qpl', $parent_obj_id, 'quest', $tax_id);
            $assignments = $tax_assignment->getAssignmentsOfItem($question_id);
 
            foreach ($assignments as $ass_data) {
                if (!isset($tax_assignment_data[$ass_data['tax_id']])) {
                    $tax_assignment_data[$ass_data['tax_id']] = [];
                }
 
                $ass_data['node_lft'] = $tax_tree->getNodeData($ass_data['node_id']);
 
                $tax_assignment_data[$ass_data['tax_id']][$ass_data['node_id']] = $ass_data;
            }
        }
 
        return $tax_assignment_data;
    }

Referenced by load().

Here is the caller graph for this function:

◆ orderAndLimitByQuestionType()

ilAssQuestionList::orderAndLimitByQuestionType ( array $questions )

private

Definition at line 604 of file class.ilAssQuestionList.php.

     : array {
        $direction = $this->order_direction === Order::DESC ? -1 : 1;
        usort(
            $questions,
            fn(array $a, array $b): int => $direction * ($a['question_type'] <=> $b['question_type'])
        );
 
        if ($this->range !== null) {
            $questions = array_slice(
                $questions,
                $this->range->getStart(),
                $this->range->getLength()
            );
        }
 
        return $questions;
    }

Referenced by load().

Here is the caller graph for this function:

◆ setAnswerStatusActiveId()

ilAssQuestionList::setAnswerStatusActiveId ( ?int $answerStatusActiveId )

Definition at line 157 of file class.ilAssQuestionList.php.

                                                                       : void
    {
        $this->answerStatusActiveId = $answerStatusActiveId;
    }

References $answerStatusActiveId.

◆ setAnswerStatusFilter()

ilAssQuestionList::setAnswerStatusFilter ( string $answerStatusFilter )

Definition at line 162 of file class.ilAssQuestionList.php.

                                                                     : void
    {
        $this->answerStatusFilter = $answerStatusFilter;
    }

References $answerStatusFilter.

◆ setAvailableTaxonomyIds()

ilAssQuestionList::setAvailableTaxonomyIds ( array $availableTaxonomyIds )

Definition at line 152 of file class.ilAssQuestionList.php.

                                                                        : void
    {
        $this->availableTaxonomyIds = $availableTaxonomyIds;
    }

References $availableTaxonomyIds.

Referenced by ILIAS\TestQuestionPool\Questions\Presentation\QuestionTable\__construct().

Here is the caller graph for this function:

◆ setCommentFilter()

ilAssQuestionList::setCommentFilter ( ?int $commented = null )

Definition at line 650 of file class.ilAssQuestionList.php.

                                                            : void
    {
        $this->filter_comments = $commented;
    }

◆ setExcludeQuestionIdsFilter()

ilAssQuestionList::setExcludeQuestionIdsFilter ( array $excludeQuestionIdsFilter )

Definition at line 130 of file class.ilAssQuestionList.php.

                                                                                : void
    {
        $this->excludeQuestionIdsFilter = $excludeQuestionIdsFilter;
    }

References $excludeQuestionIdsFilter.

Referenced by ilTestQuestionBrowserTableGUI\addModeParametersToQuestionList().

Here is the caller graph for this function:

◆ setIncludeQuestionIdsFilter()

ilAssQuestionList::setIncludeQuestionIdsFilter ( array $questionIdsFilter )

Definition at line 125 of file class.ilAssQuestionList.php.

                                                                         : void
    {
        $this->includeQuestionIdsFilter = $questionIdsFilter;
    }

◆ setJoinObjectData()

ilAssQuestionList::setJoinObjectData ( bool $a_val )

Set if object data table should be joined.

Definition at line 170 of file class.ilAssQuestionList.php.

                                                  : void
    {
        $this->join_obj_data = $a_val;
    }

◆ setOrder()

ilAssQuestionList::setOrder ( ?Order $order = null )

Definition at line 87 of file class.ilAssQuestionList.php.

                                                  : void
    {
        [
            'order_field' => $this->order_field,
            'order_direction' => $this->order_direction
        ] = $this->getOrderFieldAndDirection($order);
    }

References $order_direction, $order_field, and getOrderFieldAndDirection().

Here is the call graph for this function:

◆ setParentObjectType()

ilAssQuestionList::setParentObjectType ( string $parentObjType )

Definition at line 110 of file class.ilAssQuestionList.php.

                                                              : void
    {
        $this->parentObjType = $parentObjType;
    }

References $parentObjType.

Referenced by ilTestQuestionBrowserTableGUI\addModeParametersToQuestionList().

Here is the caller graph for this function:

◆ setParentObjId()

ilAssQuestionList::setParentObjId ( ?int $parentObjId )

Definition at line 105 of file class.ilAssQuestionList.php.

                                                     : void
    {
        $this->parentObjId = $parentObjId;
    }

References $parentObjId.

◆ setParentObjIdsFilter()

ilAssQuestionList::setParentObjIdsFilter ( array $parentObjIdsFilter )

Definition at line 115 of file class.ilAssQuestionList.php.

                                                                    : void
    {
        $this->parentObjIdsFilter = $parentObjIdsFilter;
    }

References $parentObjIdsFilter.

Referenced by ilTestQuestionBrowserTableGUI\addModeParametersToQuestionList().

Here is the caller graph for this function:

◆ setQuestionInstanceTypeFilter()

ilAssQuestionList::setQuestionInstanceTypeFilter ( ?string $questionInstanceTypeFilter )

Definition at line 120 of file class.ilAssQuestionList.php.

                                                                                      : void
    {
        $this->questionInstanceTypeFilter = (string) $questionInstanceTypeFilter;
    }

References $questionInstanceTypeFilter.

Referenced by ilTestQuestionBrowserTableGUI\addModeParametersToQuestionList().

Here is the caller graph for this function:

◆ setRange()

ilAssQuestionList::setRange ( ?Range $range = null )

Definition at line 95 of file class.ilAssQuestionList.php.

                                                  : void
    {
        $this->range = $range;
    }

References $range.

Field Documentation

◆ $answerStatusActiveId

int ilAssQuestionList::$answerStatusActiveId = null

private

Definition at line 41 of file class.ilAssQuestionList.php.

Referenced by setAnswerStatusActiveId().

◆ $answerStatusFilter

string ilAssQuestionList::$answerStatusFilter = ''

private

Definition at line 58 of file class.ilAssQuestionList.php.

Referenced by setAnswerStatusFilter().

◆ $availableTaxonomyIds

array ilAssQuestionList::$availableTaxonomyIds = []

private

Definition at line 35 of file class.ilAssQuestionList.php.

Referenced by setAvailableTaxonomyIds().

◆ $excludeQuestionIdsFilter

array ilAssQuestionList::$excludeQuestionIdsFilter = []

private

Definition at line 66 of file class.ilAssQuestionList.php.

Referenced by setExcludeQuestionIdsFilter().

◆ $fieldFilters

array ilAssQuestionList::$fieldFilters = []

private

Definition at line 36 of file class.ilAssQuestionList.php.

◆ $filter_comments

string ilAssQuestionList::$filter_comments = null

protected

Definition at line 70 of file class.ilAssQuestionList.php.

◆ $includeQuestionIdsFilter

array ilAssQuestionList::$includeQuestionIdsFilter = []

private

Definition at line 65 of file class.ilAssQuestionList.php.

◆ $join_obj_data

bool ilAssQuestionList::$join_obj_data = true

protected

Definition at line 42 of file class.ilAssQuestionList.php.

◆ $order_direction

string ilAssQuestionList::$order_direction = null

private

Definition at line 75 of file class.ilAssQuestionList.php.

Referenced by getOrderFieldAndDirection(), and setOrder().

◆ $order_field

string ilAssQuestionList::$order_field = null

private

Definition at line 74 of file class.ilAssQuestionList.php.

Referenced by getOrderFieldAndDirection(), and setOrder().

◆ $parentObjId

int ilAssQuestionList::$parentObjId = null

private

Definition at line 33 of file class.ilAssQuestionList.php.

Referenced by addTaxonomyFilter(), getParentObjId(), getTaxItems(), and setParentObjId().

◆ $parentObjIdsFilter

array ilAssQuestionList::$parentObjIdsFilter = []

private

Definition at line 32 of file class.ilAssQuestionList.php.

Referenced by setParentObjIdsFilter().

◆ $parentObjType

string ilAssQuestionList::$parentObjType = 'qpl'

private

Definition at line 34 of file class.ilAssQuestionList.php.

Referenced by addTaxonomyFilter(), and setParentObjectType().

◆ $questionInstanceTypeFilter

string ilAssQuestionList::$questionInstanceTypeFilter = self::QUESTION_INSTANCE_TYPE_ORIGINALS

private

Definition at line 63 of file class.ilAssQuestionList.php.

Referenced by setQuestionInstanceTypeFilter().

◆ $questions

array ilAssQuestionList::$questions = []

protected

Definition at line 72 of file class.ilAssQuestionList.php.

◆ $range

Range ilAssQuestionList::$range = null

private

Definition at line 76 of file class.ilAssQuestionList.php.

Referenced by setRange().

◆ $taxFilters

array ilAssQuestionList::$taxFilters = []

private

Definition at line 37 of file class.ilAssQuestionList.php.

◆ $taxFiltersExcludeAnyObjectsWithTaxonomies

bool ilAssQuestionList::$taxFiltersExcludeAnyObjectsWithTaxonomies = false

private

Definition at line 38 of file class.ilAssQuestionList.php.

◆ $taxParentIds

array ilAssQuestionList::$taxParentIds = []

private

Definition at line 39 of file class.ilAssQuestionList.php.

◆ $taxParentTypes

array ilAssQuestionList::$taxParentTypes = []

private

Definition at line 40 of file class.ilAssQuestionList.php.

◆ ANSWER_STATUS_FILTER_ALL_NON_CORRECT

const ilAssQuestionList::ANSWER_STATUS_FILTER_ALL_NON_CORRECT = 'allNonCorrect'

answer status filter value domain

Definition at line 54 of file class.ilAssQuestionList.php.

◆ ANSWER_STATUS_FILTER_NON_ANSWERED_ONLY

const ilAssQuestionList::ANSWER_STATUS_FILTER_NON_ANSWERED_ONLY = 'nonAnswered'

Definition at line 55 of file class.ilAssQuestionList.php.

◆ ANSWER_STATUS_FILTER_WRONG_ANSWERED_ONLY

const ilAssQuestionList::ANSWER_STATUS_FILTER_WRONG_ANSWERED_ONLY = 'wrongAnswered'

Definition at line 56 of file class.ilAssQuestionList.php.

◆ QUESTION_ANSWER_STATUS_CORRECT_ANSWERED

const ilAssQuestionList::QUESTION_ANSWER_STATUS_CORRECT_ANSWERED = 'correctAnswered'

Definition at line 49 of file class.ilAssQuestionList.php.

◆ QUESTION_ANSWER_STATUS_NON_ANSWERED

const ilAssQuestionList::QUESTION_ANSWER_STATUS_NON_ANSWERED = 'nonAnswered'

answer status domain for single questions

Definition at line 47 of file class.ilAssQuestionList.php.

◆ QUESTION_ANSWER_STATUS_WRONG_ANSWERED

const ilAssQuestionList::QUESTION_ANSWER_STATUS_WRONG_ANSWERED = 'wrongAnswered'

Definition at line 48 of file class.ilAssQuestionList.php.

◆ QUESTION_COMMENTED_EXCLUDED

const ilAssQuestionList::QUESTION_COMMENTED_EXCLUDED = '2'

Definition at line 69 of file class.ilAssQuestionList.php.

Referenced by ILIAS\TestQuestionPool\Questions\Presentation\QuestionTable\getFilter().

◆ QUESTION_COMMENTED_ONLY

const ilAssQuestionList::QUESTION_COMMENTED_ONLY = '1'

Definition at line 68 of file class.ilAssQuestionList.php.

Referenced by ILIAS\TestQuestionPool\Questions\Presentation\QuestionTable\getFilter().

◆ QUESTION_INSTANCE_TYPE_ALL

const ilAssQuestionList::QUESTION_INSTANCE_TYPE_ALL = 'QST_INSTANCE_TYPE_ALL'

Definition at line 62 of file class.ilAssQuestionList.php.

Referenced by ilTestQuestionBrowserTableGUI\addModeParametersToQuestionList().

◆ QUESTION_INSTANCE_TYPE_DUPLICATES

const ilAssQuestionList::QUESTION_INSTANCE_TYPE_DUPLICATES = 'QST_INSTANCE_TYPE_DUPLICATES'

Definition at line 61 of file class.ilAssQuestionList.php.

Referenced by ilTestPlayerRandomQuestionSetGUI\buildTestPassQuestionList(), and ilTestSkillAdministrationGUI\getRequiredQuestionInstanceTypeFilter().

◆ QUESTION_INSTANCE_TYPE_ORIGINALS

const ilAssQuestionList::QUESTION_INSTANCE_TYPE_ORIGINALS = 'QST_INSTANCE_TYPE_ORIGINALS'

Definition at line 60 of file class.ilAssQuestionList.php.

Referenced by ilTestQuestionBrowserTableGUI\addModeParametersToQuestionList(), and ilQuestionPoolSkillAdministrationGUI\executeCommand().

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

components/ILIAS/TestQuestionPool/classes/class.ilAssQuestionList.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addFeedbackJoinIfNeeded()

◆ addFieldFilter()

◆ addTaxonomyFilter()

◆ addTaxonomyFilterNoTaxonomySet()

◆ buildBasicQuery()

◆ buildLimitQueryExpression()

◆ buildOrderQueryExpression()

◆ buildQuery()

◆ checkFilters()

◆ generateFeedbackSubquery()

◆ generateTaxonomySubquery()

◆ getAnswerStatusFilterExpressions()

◆ getConditionalFilterExpression()

◆ getDataArrayForQuestionId()

◆ getFieldFilterExpressions()

◆ getFilterByAssignedTaxonomyIdsExpression()

◆ getHavingFilterExpression()

◆ getNumberOfCommentsForQuestion()

◆ getOrderFieldAndDirection()

◆ getParentObjFilterExpression()

◆ getParentObjId()

◆ getQuestionDataArray()

◆ getQuestionIdsFilterExpressions()

◆ getQuestionInstanceTypeFilterExpression()

◆ getSelectFieldsExpression()

◆ getTableJoinExpression()

◆ getTaxItems()

◆ getTaxonomyFilterExpressions()

◆ getTitle()

◆ getTotalRowCount()

◆ isActiveQuestionType()

◆ isInList()

◆ load()

◆ loadTaxonomyAssignmentData()

◆ orderAndLimitByQuestionType()

◆ setAnswerStatusActiveId()

◆ setAnswerStatusFilter()

◆ setAvailableTaxonomyIds()

◆ setCommentFilter()

◆ setExcludeQuestionIdsFilter()

◆ setIncludeQuestionIdsFilter()

◆ setJoinObjectData()

◆ setOrder()

◆ setParentObjectType()

◆ setParentObjId()

◆ setParentObjIdsFilter()

◆ setQuestionInstanceTypeFilter()

◆ setRange()

Field Documentation

◆ $answerStatusActiveId

◆ $answerStatusFilter

◆ $availableTaxonomyIds

◆ $excludeQuestionIdsFilter

◆ $fieldFilters

◆ $filter_comments

◆ $includeQuestionIdsFilter

◆ $join_obj_data

◆ $order_direction

◆ $order_field

◆ $parentObjId

◆ $parentObjIdsFilter

◆ $parentObjType

◆ $questionInstanceTypeFilter

◆ $questions

◆ $range

◆ $taxFilters

◆ $taxFiltersExcludeAnyObjectsWithTaxonomies

◆ $taxParentIds

◆ $taxParentTypes

◆ ANSWER_STATUS_FILTER_ALL_NON_CORRECT