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 (?array $filter_data, ?array $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...

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 ()

	handleFeedbackJoin (string $tableJoin)

	handleHintJoin (string $tableJoin)

	getTaxonomyFilterExpressions ()

	getFilterByAssignedTaxonomyIdsExpression ()

	getQuestionInstanceTypeFilterExpression ()

	getQuestionIdsFilterExpressions ()

	getAnswerStatusFilterExpressions ()

	getTableJoinExpression ()

	getConditionalFilterExpression ()

	getSelectFieldsExpression ()

	generateFeedbackSubquery ()

	generateHintSubquery ()

	generateTaxonomySubquery ()

	buildBasicQuery ()

	getHavingFilterExpression ()

	buildOrderQueryExpression ()

	buildLimitQueryExpression ()

	buildQuery ()

	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 = []

Order	$order = 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 77 of file class.ilAssQuestionList.php.

83 {

84 }

Member Function Documentation

◆ addFieldFilter()

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

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

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

◆ addTaxonomyFilter()

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

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

References $parentObjId, and $parentObjType.

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

◆ addTaxonomyFilterNoTaxonomySet()

ilAssQuestionList::addTaxonomyFilterNoTaxonomySet ( bool $flag )

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

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

◆ buildBasicQuery()

ilAssQuestionList::buildBasicQuery ( )

private

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

Referenced by buildQuery().

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

Here is the caller graph for this function:

◆ buildLimitQueryExpression()

ilAssQuestionList::buildLimitQueryExpression ( )

private

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

References $range, ILIAS\Data\Range\getLength(), ILIAS\Data\Range\getStart(), and null.

Referenced by buildQuery().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildOrderQueryExpression()

ilAssQuestionList::buildOrderQueryExpression ( )

private

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

References $order, ILIAS\Data\Order\join(), and null.

Referenced by buildQuery().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildQuery()

ilAssQuestionList::buildQuery ( )

private

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

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

Referenced by load().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkFilters()

ilAssQuestionList::checkFilters ( )

private

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

Referenced by getTotalRowCount(), and load().

                                    : 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.'
             );
         }
     }

Here is the caller graph for this function:

◆ generateFeedbackSubquery()

ilAssQuestionList::generateFeedbackSubquery ( )

private

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

References ilAssQuestionFeedback\PAGE_OBJECT_TYPE_GENERIC_FEEDBACK, and ilAssQuestionFeedback\PAGE_OBJECT_TYPE_SPECIFIC_FEEDBACK.

Referenced by getSelectFieldsExpression().

                                                : 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";
     }

Here is the caller graph for this function:

◆ generateHintSubquery()

ilAssQuestionList::generateHintSubquery ( )

private

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

Referenced by getSelectFieldsExpression().

                                            : string
     {
         $hint_subquery = 'SELECT 1 FROM qpl_hints WHERE qpl_hints.qht_question_fi = qpl_questions.question_id';
         return "CASE WHEN EXISTS ($hint_subquery) THEN TRUE ELSE FALSE END AS hints";
     }

Here is the caller graph for this function:

◆ generateTaxonomySubquery()

ilAssQuestionList::generateTaxonomySubquery ( )

private

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

Referenced by getSelectFieldsExpression().

                                                : 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";
     }

Here is the caller graph for this function:

◆ getAnswerStatusFilterExpressions()

ilAssQuestionList::getAnswerStatusFilterExpressions ( )

private

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

Referenced by getConditionalFilterExpression().

                                                        : 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 => [],
         };
     }

Here is the caller graph for this function:

◆ getConditionalFilterExpression()

ilAssQuestionList::getConditionalFilterExpression ( )

private

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

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

Referenced by buildQuery().

                                                      : 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" : '';
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDataArrayForQuestionId()

ilAssQuestionList::getDataArrayForQuestionId ( int $questionId )

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

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

◆ getFieldFilterExpressions()

ilAssQuestionList::getFieldFilterExpressions ( )

private

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

References ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

Referenced by getConditionalFilterExpression().

                                                 : 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;
     }

Here is the caller graph for this function:

◆ getFilterByAssignedTaxonomyIdsExpression()

ilAssQuestionList::getFilterByAssignedTaxonomyIdsExpression ( )

private

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

References getTaxItems(), and ilDBConstants\T_INTEGER.

Referenced by getTaxonomyFilterExpressions().

                                                                : 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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHavingFilterExpression()

ilAssQuestionList::getHavingFilterExpression ( )

private

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

Referenced by buildQuery().

                                                 : 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;
 
             }
 
             if ($fieldName === 'hints') {
                 $fieldValue = strtoupper($fieldValue);
                 if (in_array($fieldValue, ['TRUE', 'FALSE'], true)) {
                     $expressions[] = "hints IS $fieldValue";
                 }
             }
         }
 
         $having = implode(' AND ', $expressions);
         return $having !== '' ? "HAVING $having" : '';
     }

Here is the caller graph for this function:

◆ getNumberOfCommentsForQuestion()

ilAssQuestionList::getNumberOfCommentsForQuestion ( int $question_id )

protected

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

References getParentObjId(), and null.

Referenced by load().

                                                                        : 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);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getParentObjFilterExpression()

ilAssQuestionList::getParentObjFilterExpression ( )

private

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

References null, and ilDBConstants\T_INTEGER.

Referenced by getConditionalFilterExpression().

                                                    : ?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;
     }

Here is the caller graph for this function:

◆ getParentObjId()

ilAssQuestionList::getParentObjId ( )

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

References $parentObjId.

Referenced by getNumberOfCommentsForQuestion(), and ilTestSkillEvaluation\init().

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

Here is the caller graph for this function:

◆ getQuestionDataArray()

ilAssQuestionList::getQuestionDataArray ( )

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

References $questions.

Referenced by ILIAS\TestQuestionPool\Questions\Presentation\QuestionTable\getData(), ILIAS\TestQuestionPool\Questions\Presentation\QuestionTable\getTotalRowCount(), and ilTestSkillEvaluation\initTestQuestionData().

                                           : array
     {
         return $this->questions;
     }

Here is the caller graph for this function:

◆ getQuestionIdsFilterExpressions()

ilAssQuestionList::getQuestionIdsFilterExpressions ( )

private

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

References ilDBConstants\T_INTEGER.

Referenced by getConditionalFilterExpression().

                                                       : 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;
     }

Here is the caller graph for this function:

◆ getQuestionInstanceTypeFilterExpression()

ilAssQuestionList::getQuestionInstanceTypeFilterExpression ( )

private

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

References null.

Referenced by getConditionalFilterExpression().

                                                               : ?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
         };
     }

Here is the caller graph for this function:

◆ getSelectFieldsExpression()

ilAssQuestionList::getSelectFieldsExpression ( )

private

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

References generateFeedbackSubquery(), generateHintSubquery(), and generateTaxonomySubquery().

                                                 : string
     {
         $select_fields = [
             'qpl_questions.*',
             'qpl_qst_type.type_tag',
             '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';
         }
 
         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->generateHintSubquery();
         $select_fields[] = $this->generateTaxonomySubquery();
 
         $select_fields = implode(', ', $select_fields);
         return "SELECT DISTINCT $select_fields";
     }

Here is the call graph for this function:

◆ getTableJoinExpression()

ilAssQuestionList::getTableJoinExpression ( )

private

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

References handleFeedbackJoin(), and handleHintJoin().

                                              : string
     {
         $tableJoin = '
                         INNER JOIN      qpl_qst_type
                         ON                      qpl_qst_type.question_type_id = qpl_questions.question_type_fi
                 ';
 
         if ($this->join_obj_data) {
             $tableJoin .= '
                                 INNER JOIN      object_data
                                 ON                      object_data.obj_id = qpl_questions.obj_fi
                         ';
         }
 
         if (
             $this->parentObjType === 'tst'
             && $this->questionInstanceTypeFilter === self::QUESTION_INSTANCE_TYPE_ALL
         ) {
             $tableJoin .= 'INNER JOIN tst_test_question tstquest ON tstquest.question_fi = qpl_questions.question_id';
         }
 
         $tableJoin = $this->handleFeedbackJoin($tableJoin);
         $tableJoin = $this->handleHintJoin($tableJoin);
 
         if ($this->answerStatusActiveId) {
             $tableJoin .= "
                                 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 $tableJoin;
     }

Here is the call graph for this function:

◆ getTaxItems()

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

protected

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

Referenced by getFilterByAssignedTaxonomyIdsExpression().

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

Here is the caller graph for this function:

◆ getTaxonomyFilterExpressions()

ilAssQuestionList::getTaxonomyFilterExpressions ( )

private

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

References getFilterByAssignedTaxonomyIdsExpression().

Referenced by getConditionalFilterExpression().

                                                    : 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;
     }

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 726 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	(	?array	$filter_data,
		?array	$additional_parameters
	)

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

References checkFilters().

                                                                                         : ?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);
     }

Here is the call graph for this function:

◆ handleFeedbackJoin()

ilAssQuestionList::handleFeedbackJoin ( string $tableJoin )

private

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

References null.

Referenced by getTableJoinExpression().

                                                           : 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 ";
             $tableJoin .= !str_contains($tableJoin, $SQL) ? $SQL : '';
         }
 
         return $tableJoin;
     }

Here is the caller graph for this function:

◆ handleHintJoin()

ilAssQuestionList::handleHintJoin ( string $tableJoin )

private

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

References null.

Referenced by getTableJoinExpression().

                                                       : string
     {
         $feedback_join = match ($this->fieldFilters['hints'] ?? null) {
             'true' => 'INNER',
             'false' => 'LEFT',
             default => null
         };
 
         if (isset($feedback_join)) {
             $SQL = "$feedback_join JOIN qpl_hints ON qpl_hints.qht_question_fi = qpl_questions.question_id ";
             $tableJoin .= !str_contains($tableJoin, $SQL) ? $SQL : '';
         }
 
         return $tableJoin;
     }

Here is the caller graph for this function:

◆ isActiveQuestionType()

ilAssQuestionList::isActiveQuestionType ( array $questionData )

private

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

References ilComponentInfo\TYPE_MODULES.

Referenced by load().

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

Here is the caller graph for this function:

◆ isInList()

ilAssQuestionList::isInList ( int $questionId )

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

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

◆ load()

ilAssQuestionList::load ( )

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

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

Referenced by ILIAS\TestQuestionPool\Questions\Presentation\QuestionTable\getData(), and ILIAS\TestQuestionPool\Questions\Presentation\QuestionTable\getTotalRowCount().

                           : void
     {
         $this->checkFilters();
 
         $tags_trafo = $this->refinery->encode()->htmlSpecialCharsAsEntities();
 
         $res = $this->db->query($this->buildQuery());
         while ($row = $this->db->fetchAssoc($res)) {
             $row = ilAssQuestionType::completeMissingPluginName($row);
 
             if (!$this->isActiveQuestionType($row)) {
                 continue;
             }
 
             $row['title'] = $tags_trafo->transform($row['title'] ?? '&nbsp;');
             $row['description'] = $tags_trafo->transform($row['description'] !== '' && $row['description'] !== null ? $row['description'] : '&nbsp;');
             $row['author'] = $tags_trafo->transform($row['author']);
             $row['taxonomies'] = $this->loadTaxonomyAssignmentData($row['obj_fi'], $row['question_id']);
             $row['ttype'] = $this->lng->txt($row['type_tag']);
             $row['feedback'] = $row['feedback'] === 1;
             $row['hints'] = $row['hints'] === 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;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadTaxonomyAssignmentData()

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

private

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

Referenced by load().

      : 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;
     }

Here is the caller graph for this function:

◆ setAnswerStatusActiveId()

ilAssQuestionList::setAnswerStatusActiveId ( ?int $answerStatusActiveId )

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

References $answerStatusActiveId.

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

◆ setAnswerStatusFilter()

ilAssQuestionList::setAnswerStatusFilter ( string $answerStatusFilter )

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

References $answerStatusFilter.

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

◆ setAvailableTaxonomyIds()

ilAssQuestionList::setAvailableTaxonomyIds ( array $availableTaxonomyIds )

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

References $availableTaxonomyIds.

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

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

Here is the caller graph for this function:

◆ setCommentFilter()

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

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

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

◆ setExcludeQuestionIdsFilter()

ilAssQuestionList::setExcludeQuestionIdsFilter ( array $excludeQuestionIdsFilter )

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

References $excludeQuestionIdsFilter.

Referenced by ilTestQuestionBrowserTableGUI\addModeParametersToQuestionList().

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

Here is the caller graph for this function:

◆ setIncludeQuestionIdsFilter()

ilAssQuestionList::setIncludeQuestionIdsFilter ( array $questionIdsFilter )

Definition at line 121 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 166 of file class.ilAssQuestionList.php.

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

◆ setOrder()

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

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

References $order.

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

◆ setParentObjectType()

ilAssQuestionList::setParentObjectType ( string $parentObjType )

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

References $parentObjType.

Referenced by ilTestQuestionBrowserTableGUI\addModeParametersToQuestionList().

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

Here is the caller graph for this function:

◆ setParentObjId()

ilAssQuestionList::setParentObjId ( ?int $parentObjId )

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

References $parentObjId.

Referenced by ILIAS\TestQuestionPool\Questions\Presentation\QuestionTable\getData(), ilCopySelfAssQuestionTableGUI\getQuestions(), and ILIAS\TestQuestionPool\Questions\Presentation\QuestionTable\getTotalRowCount().

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

Here is the caller graph for this function:

◆ setParentObjIdsFilter()

ilAssQuestionList::setParentObjIdsFilter ( array $parentObjIdsFilter )

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

References $parentObjIdsFilter.

Referenced by ilTestQuestionBrowserTableGUI\addModeParametersToQuestionList(), ilAsqFactory\getQuestionDataArray(), and ilAsqFactory\getQuestionInstances().

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

Here is the caller graph for this function:

◆ setQuestionInstanceTypeFilter()

ilAssQuestionList::setQuestionInstanceTypeFilter ( ?string $questionInstanceTypeFilter )

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

Referenced by ilTestQuestionBrowserTableGUI\addModeParametersToQuestionList().

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

Here is the caller graph for this function:

◆ setRange()

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

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

References $range.

                                                   : void
     {
         $this->range = $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

Order ilAssQuestionList::$order = null

private

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

Referenced by buildOrderQueryExpression(), and setOrder().

◆ $parentObjId

int ilAssQuestionList::$parentObjId = null

private

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

Referenced by addTaxonomyFilter(), getParentObjId(), 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.

◆ $questions

array ilAssQuestionList::$questions = []

protected

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

Referenced by getQuestionDataArray().

◆ $range

Range ilAssQuestionList::$range = null

private

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

Referenced by buildLimitQueryExpression(), and 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

◆ addFieldFilter()

◆ addTaxonomyFilter()

◆ addTaxonomyFilterNoTaxonomySet()

◆ buildBasicQuery()

◆ buildLimitQueryExpression()

◆ buildOrderQueryExpression()

◆ buildQuery()

◆ checkFilters()

◆ generateFeedbackSubquery()

◆ generateHintSubquery()

◆ generateTaxonomySubquery()

◆ getAnswerStatusFilterExpressions()

◆ getConditionalFilterExpression()

◆ getDataArrayForQuestionId()

◆ getFieldFilterExpressions()

◆ getFilterByAssignedTaxonomyIdsExpression()

◆ getHavingFilterExpression()

◆ getNumberOfCommentsForQuestion()

◆ getParentObjFilterExpression()

◆ getParentObjId()

◆ getQuestionDataArray()

◆ getQuestionIdsFilterExpressions()

◆ getQuestionInstanceTypeFilterExpression()

◆ getSelectFieldsExpression()

◆ getTableJoinExpression()

◆ getTaxItems()

◆ getTaxonomyFilterExpressions()

◆ getTitle()

◆ getTotalRowCount()

◆ handleFeedbackJoin()

◆ handleHintJoin()

◆ isActiveQuestionType()

◆ isInList()

◆ load()

◆ loadTaxonomyAssignmentData()

◆ 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

◆ $parentObjId

◆ $parentObjIdsFilter

◆ $parentObjType

◆ $questionInstanceTypeFilter

◆ $questions

◆ $range

◆ $taxFilters

◆ $taxFiltersExcludeAnyObjectsWithTaxonomies

◆ $taxParentIds

◆ $taxParentTypes

◆ ANSWER_STATUS_FILTER_ALL_NON_CORRECT

◆ ANSWER_STATUS_FILTER_NON_ANSWERED_ONLY