Inheritance diagram for QuestionTable:

Collaboration diagram for QuestionTable:

Public Member Functions
	__construct (protected UIFactory $ui_factory, protected UIRenderer $ui_renderer, protected DataFactory $data_factory, protected Refinery $refinery, protected URLBuilder $url_builder, protected URLBuilderToken $action_parameter_token, protected URLBuilderToken $row_id_token, protected ilDBInterface $db, protected ilLanguage $lng, protected ilComponentRepository $component_repository, protected ilRbacSystem $rbac, protected ?TaxonomyService $taxonomy, protected NotesService $notes_service, protected int $parent_obj_id, protected int $request_ref_id)

	getTable ()

	getFilter (ilUIService $ui_service, string $action)
	Filters should be part of the Table; for now, since they are not fully integrated, they are rendered and applied seperately. More...

	getColums ()

	getRows (Table\DataRowBuilder $row_builder, array $visible_column_ids, Range $range, Order $order, ?array $filter_data, ?array $additional_parameters)

	getTotalRowCount (?array $filter_data, ?array $additional_parameters)

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

	getParentObjId ()

	setParentObjId ($parentObjId)

	getParentObjectType ()

	setParentObjectType ($parentObjType)

	getParentObjIdsFilter ()

	setParentObjIdsFilter ($parentObjIdsFilter)

	setQuestionInstanceTypeFilter ($questionInstanceTypeFilter)

	getQuestionInstanceTypeFilter ()

	setIncludeQuestionIdsFilter ($questionIdsFilter)

	getIncludeQuestionIdsFilter ()

	getExcludeQuestionIdsFilter ()

	setExcludeQuestionIdsFilter ($excludeQuestionIdsFilter)

	getQuestionCompletionStatusFilter ()

	setQuestionCompletionStatusFilter ($questionCompletionStatusFilter)

	addFieldFilter ($fieldName, $fieldValue)

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

	addTaxonomyFilterNoTaxonomySet (bool $flag)

	setAvailableTaxonomyIds ($availableTaxonomyIds)

	getAvailableTaxonomyIds ()

	setAnswerStatusActiveId ($answerStatusActiveId)

	getAnswerStatusActiveId ()

	setAnswerStatusFilter ($answerStatusFilter)

	getAnswerStatusFilter ()

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

	getJoinObjectData ()
	Get if object data table should be joined. More...

	setForcedQuestionIds ($forcedQuestionIds)

	getForcedQuestionIds ()

	load ()

	setCommentFilter (int $commented=null)

	getDataArrayForQuestionId ($questionId)

	getQuestionDataArray ()

	isInList ($questionId)

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

Protected Member Functions
	getData (Order $order, Range $range)

	getActions ()

	buildAction (string $act, string $type, bool $async=false)

	postOrder (array $list, \ILIAS\Data\Order $order)

Protected Member Functions inherited from ilAssQuestionList
	getTaxItems ($parentType, $parentObjId, $taxId, $taxNode)

	getNumberOfCommentsForQuestion (int $question_id)

	hasFeedback (int $question_id)

	hasHints (int $question_id)

Private Member Functions
	treeify (&$pointer, $stack)

	toNestedList (array $nodes)

	taxNodeReader ($tree, $sortfield, $node_id)

	singleTaxonomyRepresentation (int $tax_id, array $stored_tax_data, string $check_marker)

	taxonomyRepresentation (array $taxonomy_data)

	showCommentAction ()

Additional Inherited Members
Data Fields inherited from ilAssQuestionList
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_COMPLETION_STATUS_COMPLETE = 'complete'

const	QUESTION_COMPLETION_STATUS_INCOMPLETE = 'incomplete'

const	QUESTION_COMPLETION_STATUS_BOTH = 'complete/incomplete'

const	QUESTION_COMMENTED_ONLY = '1'

const	QUESTION_COMMENTED_EXCLUDED = '2'

Protected Attributes inherited from ilAssQuestionList
bool	$join_obj_data = true

string	$filter_comments = null

array	$questions = []

Detailed Description

Definition at line 34 of file QuestionTable.php.

Constructor & Destructor Documentation

◆ __construct()

QuestionTable::__construct	(	protected UIFactory	$ui_factory,
		protected UIRenderer	$ui_renderer,
		protected DataFactory	$data_factory,
		protected Refinery	$refinery,
		protected URLBuilder	$url_builder,
		protected URLBuilderToken	$action_parameter_token,
		protected URLBuilderToken	$row_id_token,
		protected ilDBInterface	$db,
		protected ilLanguage	$lng,
		protected ilComponentRepository	$component_repository,
		protected ilRbacSystem	$rbac,
		protected ?TaxonomyService	$taxonomy,
		protected NotesService	$notes_service,
		protected int	$parent_obj_id,
		protected int	$request_ref_id
	)

Definition at line 36 of file QuestionTable.php.

References ILIAS\MetaData\Repository\Validation\Data\__construct(), ilLanguage\loadLanguageModule(), and ilAssQuestionList\setAvailableTaxonomyIds().

       {
         $lng->loadLanguageModule('qpl');
         parent::__construct($db, $lng, $refinery, $component_repository, $notes_service);
         if ($this->taxonomy) {
             $this->setAvailableTaxonomyIds($taxonomy->getUsageOfObject($parent_obj_id));
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ buildAction()

QuestionTable::buildAction	(	string	$act,
		string	$type,
		bool	$async = `false`
	)

protected

Definition at line 351 of file QuestionTable.php.

References ILIAS\Repository\lng().

Referenced by getActions().

                                                                                   : array
     {
         $action = $this->ui_factory->table()->action()
             ->$type(
                 $this->lng->txt($act),
                 $this->url_builder->withParameter($this->action_parameter_token, $act),
                 $this->row_id_token
             );
         if ($async) {
             $action = $action->withAsync(true);
         }
 
         return [$act => $action];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActions()

QuestionTable::getActions ( )

protected

Definition at line 334 of file QuestionTable.php.

References buildAction(), and showCommentAction().

Referenced by getTable().

                                    : array
     {
         return array_merge(
             $this->buildAction('copy', 'standard'),
             $this->buildAction('move', 'standard'),
             $this->buildAction('delete', 'standard'),
             $this->buildAction('export', 'multi'),
             $this->buildAction('preview', 'single'),
             $this->buildAction('statistics', 'single'),
             $this->buildAction('edit_question', 'single'),
             $this->buildAction('edit_page', 'single'),
             $this->buildAction('feedback', 'single'),
             $this->buildAction('hints', 'single'),
             $this->showCommentAction() ? $this->buildAction('comments', 'single', true) : []
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getColums()

QuestionTable::getColums ( )

Definition at line 148 of file QuestionTable.php.

References Vendor\Package\$f, ilUtil\getImagePath(), and ILIAS\Repository\lng().

Referenced by getTable().

                                : array
     {
         $f = $this->ui_factory->table()->column();
         $df = $this->data_factory->dateFormat();
         $date_format = $df->withTime24($this->data_factory->dateFormat()->germanShort());
         $icon_yes = $this->ui_factory->symbol()->icon()->custom(ilUtil::getImagePath('standard/icon_checked.svg'), 'yes');
         $icon_no = $this->ui_factory->symbol()->icon()->custom(ilUtil::getImagePath('standard/icon_unchecked.svg'), 'no');
 
         $cols = [
             'title' => $f->link($this->lng->txt('title')),
             'description' => $f->text($this->lng->txt('description'))->withIsOptional(true, true),
             'ttype' => $f->text($this->lng->txt('question_type'))->withIsOptional(true, true),
             'points' => $f->number($this->lng->txt('points'))->withDecimals(2)->withIsOptional(true, true),
             'author' => $f->text($this->lng->txt('author'))->withIsOptional(true, true),
             'lifecycle' => $f->text($this->lng->txt('qst_lifecycle'))->withIsOptional(true, true),
         ];
         if ($this->taxonomy) {
             $cols['taxonomies'] = $f->text($this->lng->txt('qpl_settings_subtab_taxonomies'))->withIsOptional(true, true);
         }
         $cols = array_merge($cols, [
             'feedback' => $f->boolean($this->lng->txt('feedback'), $icon_yes, $icon_no)->withIsOptional(true, true),
             'hints' => $f->boolean($this->lng->txt('hints'), $icon_yes, $icon_no)->withIsOptional(true, true),
             'created' => $f->date($this->lng->txt('create_date'), $date_format)->withIsOptional(true, true),
             'tstamp' => $f->date($this->lng->txt('last_update'), $date_format)->withIsOptional(true, true),
             'comments' => $f->number($this->lng->txt('comments'))->withIsOptional(true, false),
         ]);
         return $cols;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getData()

QuestionTable::getData	(	Order	$order,
		Range	$range
	)

protected

Definition at line 324 of file QuestionTable.php.

References $data, ilAssQuestionList\getQuestionDataArray(), ilAssQuestionList\load(), postOrder(), ilAssQuestionList\setParentObjId(), and ILIAS\Data\Range\unpack().

Referenced by getRows().

                                                           : array
     {
         $this->setParentObjId($this->parent_obj_id);
         $this->load();
         $data = $this->postOrder($this->getQuestionDataArray(), $order);
         [$offset, $length] = $range->unpack();
         $length = $length > 0 ? $length : null;
         return array_slice($data, $offset, $length);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFilter()

QuestionTable::getFilter	(	ilUIService	$ui_service,
		string	$action
	)

Filters should be part of the Table; for now, since they are not fully integrated, they are rendered and applied seperately.

Definition at line 75 of file QuestionTable.php.

References ilObjQuestionPool\_getQuestionTypes(), ilUIService\filter(), ilAssQuestionLifecycle\getDraftInstance(), ILIAS\Repository\lng(), ilAssQuestionList\QUESTION_COMMENTED_EXCLUDED, ilAssQuestionList\QUESTION_COMMENTED_ONLY, ilObjTaxonomy\SORT_ALPHABETICAL, and taxNodeReader().

                                                                       : Filter
     {
         $lifecycle_options = array_merge(
             ['' => $this->lng->txt('qst_lifecycle_filter_all')],
             ilAssQuestionLifecycle::getDraftInstance()->getSelectOptions($this->lng)
         );
         $question_type_options = [
             '' => $this->lng->txt('filter_all_question_types')
         ];
         $question_types = ilObjQuestionPool::_getQuestionTypes();
         foreach ($question_types as $translation => $row) {
             $question_type_options[$row['type_tag']] = $translation;
         }
 
         $field_factory = $this->ui_factory->input()->field();
         $filter_inputs = [
             'title' => $field_factory->text($this->lng->txt("title")),
             'description' => $field_factory->text($this->lng->txt("description")),
             'author' => $field_factory->text($this->lng->txt("author")),
             'lifecycle' => $field_factory->select($this->lng->txt("qst_lifecycle"), $lifecycle_options),
             'type' => $field_factory->select($this->lng->txt("type"), $question_type_options),
             'commented' => $field_factory->select(
                 $this->lng->txt("ass_comments"),
                 [
                     ilAssQuestionList::QUESTION_COMMENTED_ONLY => $this->lng->txt('qpl_filter_commented_only'),
                     ilAssQuestionList::QUESTION_COMMENTED_EXCLUDED => $this->lng->txt('qpl_filter_commented_exclude')
                 ]
             )
         ];
 
         if ($this->taxonomy) {
             $taxs = $this->taxonomy->getUsageOfObject($this->parent_obj_id, true);
             $tax_filter_options = [
                 'null' => '<b>' . $this->lng->txt('tax_filter_notax') . '</b>'
             ];
 
             foreach ($taxs as $tax_entry) {
                 $tax = new ilObjTaxonomy($tax_entry['tax_id']);
                 $tax_tree = $tax->getTree();
                 $sortfield = $tax->getSortingMode() === ilObjTaxonomy::SORT_ALPHABETICAL ? 'title' : 'order_nr';
                 $children = $this->taxNodeReader($tax_tree, $sortfield, $tax_tree->readRootId());
                 $nodes = implode('-', array_map(fn($node) => $node['obj_id'], $children));
 
                 $tax_id = $tax_entry['tax_id'] . '-0-' . $nodes;
                 $tax_title = '<b>' . $tax_entry['title'] . '</b>';
                 $tax_filter_options[$tax_id] = $tax_title;
 
                 foreach ($children as $subtax) {
                     $stax_id = $subtax['tax_id'] . '-' . $subtax['obj_id'];
                     $stax_title = str_repeat('&nbsp; ', ($subtax['depth'] - 2) * 2)
                         . ' &boxur;&HorizontalLine; '
                         . $subtax['title'];
 
                     $tax_filter_options[$stax_id] = $stax_title;
                 }
             }
             $filter_inputs['taxonomies'] = $field_factory->multiSelect($this->lng->txt("tax_filter"), $tax_filter_options);
         }
 
         $active = array_fill(0, count($filter_inputs), true);
 
         $filter = $ui_service->filter()->standard(
             "question_table_filter_id",
             $action,
             $filter_inputs,
             $active,
             true,
             true
         );
         return $filter;
     }

Here is the call graph for this function:

◆ getRows()

QuestionTable::getRows	(	Table\DataRowBuilder	$row_builder,
		array	$visible_column_ids,
		Range	$range,
		Order	$order,
		?array	$filter_data,
		?array	$additional_parameters
	)

Definition at line 276 of file QuestionTable.php.

References $lifecycle, getData(), ilAssQuestionLifecycle\getInstance(), ILIAS\Repository\lng(), ILIAS\Repository\rbac(), and taxonomyRepresentation().

      : \Generator {
         $no_write_access = !($this->rbac->checkAccess('write', $this->request_ref_id));
         foreach ($this->getData($order, $range) as $idx => $record) {
             $row_id = (string) $record['question_id'];
             $record['created'] = (new \DateTimeImmutable())->setTimestamp($record['created']);
             $record['tstamp'] = (new \DateTimeImmutable())->setTimestamp($record['tstamp']);
             $lifecycle = ilAssQuestionLifecycle::getInstance($record['lifecycle']);
             $record['lifecycle'] = $lifecycle->getTranslation($this->lng);
 
             $title = $record['title'];
             $to_question = $this->url_builder
                 ->withParameter($this->action_parameter_token, 'preview')
                 ->withParameter($this->row_id_token, $row_id)
                 ->buildURI()->__toString();
             if (!(bool) $record['complete']) {
                 $title .= ' (' . $this->lng->txt('warning_question_not_complete') . ')';
             }
             $record['title'] = $this->ui_factory->link()->standard($title, $to_question);
             if ($this->taxonomy) {
                 $record['taxonomies'] = $this->taxonomyRepresentation($record['taxonomies']);
             }
 
             yield $row_builder->buildDataRow($row_id, $record)
                 ->withDisabledAction('move', $no_write_access)
                 ->withDisabledAction('copy', $no_write_access)
                 ->withDisabledAction('delete', $no_write_access)
                 ->withDisabledAction('feedback', $no_write_access)
                 ->withDisabledAction('hints', $no_write_access)
             ;
         }
     }

Here is the call graph for this function:

◆ getTable()

QuestionTable::getTable ( )

Definition at line 60 of file QuestionTable.php.

References getActions(), getColums(), and ILIAS\Repository\lng().

                               : Table\Data
     {
         return $this->ui_factory->table()->data(
             $this->lng->txt('questions'),
             $this->getColums(),
             $this
         )
         ->withActions($this->getActions())
         ->withId('qpt' . $this->parent_obj_id . '_' . $this->request_ref_id);
     }

Here is the call graph for this function:

◆ getTotalRowCount()

QuestionTable::getTotalRowCount	(	?array	$filter_data,
		?array	$additional_parameters
	)

Definition at line 315 of file QuestionTable.php.

References ilAssQuestionList\getQuestionDataArray(), ilAssQuestionList\load(), and ilAssQuestionList\setParentObjId().

      : ?int {
         $this->setParentObjId($this->parent_obj_id);
         $this->load();
         return count($this->getQuestionDataArray());
     }

Here is the call graph for this function:

◆ postOrder()

QuestionTable::postOrder	(	array	$list,
		\ILIAS\Data\Order	$order
	)

protected

Definition at line 366 of file QuestionTable.php.

References Vendor\Package\$a, and Vendor\Package\$b.

Referenced by getData().

                                                                        : array
     {
         [$aspect, $direction] = $order->join('', function ($i, $k, $v) {
             return [$k, $v];
         });
         usort($list, static function (array $a, array $b) use ($aspect): int {
             if (is_numeric($a[$aspect]) || is_bool($a[$aspect])) {
                 return $a[$aspect] <=> $b[$aspect];
             }
             if (is_array($a[$aspect])) {
                 return $a[$aspect] <=> $b[$aspect];
             }
 
             $aspect_a = '';
             $aspect_b = '';
             if ($a[$aspect] !== null) {
                 $aspect_a = $a[$aspect];
             }
             if ($b[$aspect] !== null) {
                 $aspect_b = $b[$aspect];
             }
 
             return strcmp($aspect_a, $aspect_b);
         });
 
         if ($direction === $order::DESC) {
             $list = array_reverse($list);
         }
         return $list;
     }

Here is the caller graph for this function:

◆ showCommentAction()

QuestionTable::showCommentAction ( )

private

Definition at line 397 of file QuestionTable.php.

References ILIAS\Repository\rbac().

Referenced by getActions().

                                         : bool
     {
         return $this->notes_service->domain()->commentsActive($this->parent_obj_id)
             || $this->rbac->checkAccess('write', $this->request_ref_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ singleTaxonomyRepresentation()

QuestionTable::singleTaxonomyRepresentation	(	int	$tax_id,
		array	$stored_tax_data,
		string	$check_marker
	)

private

Definition at line 225 of file QuestionTable.php.

References $path, ilObject\_lookupTitle(), ilObjTaxonomy\SORT_ALPHABETICAL, taxNodeReader(), toNestedList(), and treeify().

Referenced by taxonomyRepresentation().

      : string {
         $tax = new ilObjTaxonomy($tax_id);
         $tax_tree = $tax->getTree();
         $sortfield = $tax->getSortingMode() === ilObjTaxonomy::SORT_ALPHABETICAL ? 'title' : 'order_nr';
         $taxnodes = $this->taxNodeReader($tax_tree, $sortfield, $tax_tree->readRootId());
 
         $nodes = [];
         foreach ($taxnodes as $taxnode) {
             $taxdata = array_filter(
                 $stored_tax_data,
                 fn($data_child) => $data_child['node_id'] === $taxnode['obj_id']
             );
 
             foreach (array_keys($taxdata) as $node_obj_id) {
                 $path = array_map(
                     fn($n) => in_array($n['obj_id'], array_keys($stored_tax_data)) ? $check_marker . $n['title'] : $n['title'],
                     $tax_tree->getPathFull($node_obj_id),
                 );
                 $path[0] = ilObject::_lookupTitle($tax_id);
                 $this->treeify($nodes, $path);
             }
         }
         return $this->toNestedList($nodes);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ taxNodeReader()

QuestionTable::taxNodeReader	(	$tree,
		$sortfield,
		$node_id
	)

private

Definition at line 204 of file QuestionTable.php.

References Vendor\Package\$a, Vendor\Package\$b, and Vendor\Package\$c.

Referenced by getFilter(), and singleTaxonomyRepresentation().

                                                                : array
     {
         $ret = [];
         $nodes = $tree->getChildsByTypeFilter($node_id, ['taxn']);
         usort(
             $nodes,
             fn($a, $b) => strcmp(
                 (string) $a[$sortfield],
                 (string) $b[$sortfield]
             )
         );
 
         foreach ($nodes as $node) {
             $ret[] = $node;
             foreach ($this->taxNodeReader($tree, $sortfield, $node['obj_id']) as $c) {
                 $ret[] = $c;
             }
         }
         return $ret;
     }

Here is the caller graph for this function:

◆ taxonomyRepresentation()

QuestionTable::taxonomyRepresentation ( array $taxonomy_data )

private

Definition at line 254 of file QuestionTable.php.

References $check, ilUtil\getImagePath(), and singleTaxonomyRepresentation().

Referenced by getRows().

                                                                  : string
     {
         $check = $this->ui_renderer->render(
             $this->ui_factory->symbol()->icon()->custom(ilUtil::getImagePath('standard/icon_checked.svg'), 'checked')
         );
 
         $taxonomies = [];
         $taxs = $this->taxonomy->getUsageOfObject($this->parent_obj_id, true);
         foreach ($taxs as $tax_entry) {
             $tax_id = $tax_entry['tax_id'];
             if (!array_key_exists($tax_id, $taxonomy_data)) {
                 continue;
             }
             $taxonomies[] = $this->singleTaxonomyRepresentation(
                 $tax_id,
                 $taxonomy_data[$tax_id],
                 $check
             );
         }
         return implode('', $taxonomies);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toNestedList()

QuestionTable::toNestedList ( array $nodes )

private

Definition at line 189 of file QuestionTable.php.

Referenced by singleTaxonomyRepresentation().

                                                : string
     {
         $entries = [];
         foreach ($nodes as $k => $n) {
             if ($n === []) {
                 $entries[] = $k;
             } else {
                 $entries[] = $k . $this->toNestedList($n);
             }
         }
         return $this->ui_renderer->render(
             $this->ui_factory->listing()->unordered($entries)
         );
     }

Here is the caller graph for this function:

◆ treeify()

QuestionTable::treeify	(	&	$pointer,
			$stack
	)

private

Definition at line 177 of file QuestionTable.php.

Referenced by singleTaxonomyRepresentation().

     {
         $hop = array_shift($stack);
         if (!$hop) {
             return;
         }
         if (! array_key_exists($hop, $pointer)) {
             $pointer[$hop] = [];
         }
         $this->treeify($pointer[$hop], $stack);
     }

Here is the caller graph for this function:

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

Modules/TestQuestionPool/classes/QuestionTable.php

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildAction()

◆ getActions()

◆ getColums()

◆ getData()

◆ getFilter()

◆ getRows()

◆ getTable()

◆ getTotalRowCount()

◆ postOrder()

◆ showCommentAction()

◆ singleTaxonomyRepresentation()

◆ taxNodeReader()

◆ taxonomyRepresentation()

◆ toNestedList()

◆ treeify()