ILIAS\Test\Questions\Presentation\QuestionsBrowserTable Class Reference

Inheritance diagram for ILIAS\Test\Questions\Presentation\QuestionsBrowserTable:

Collaboration diagram for ILIAS\Test\Questions\Presentation\QuestionsBrowserTable:

Public Member Functions
	__construct (private readonly string $table_id, private readonly \ilObjUser $current_user, private readonly UIFactory $ui_factory, private readonly UIRenderer $ui_renderer, private readonly \ilLanguage $lng, private readonly \ilCtrl $ctrl, private readonly DataFactory $data_factory, private readonly \ilAssQuestionList $question_list, private readonly TaxonomyService $taxonomy, private readonly string $parent_title)
	getComponent (ServerRequestInterface $request, ?array $filter)
	getColumns ()
	getActions ()
	getRows (DataRowBuilder $row_builder, array $visible_column_ids, Range $range, Order $order, mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)
	This is called by the table to retrieve rows; map data-records to rows using the $row_builder e.g. More...
	getTotalRowCount (mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)
	Mainly for the purpose of pagination-support, it is important to know about the total number of records available. More...
	loadRecords (array $filters=[], ?Order $order=null, ?Range $range=null)
	getRows (DataRowBuilder $row_builder, array $visible_column_ids, Range $range, Order $order, mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)
	This is called by the table to retrieve rows; map data-records to rows using the $row_builder e.g. More...
	getTotalRowCount (mixed $additional_viewcontrol_data, mixed $filter_data, mixed $additional_parameters)
	Mainly for the purpose of pagination-support, it is important to know about the total number of records available. More...

Data Fields
const	ACTION_INSERT = 'insert'

Private Member Functions
	getInsertAction ()
	getParentObjectLink (array $record)
	addFiltersToQuestionList (array $filters)
	resolveTaxonomiesRowData (int $obj_fi, int $questionId)
	loadTaxonomyAssignmentData (int $parentObjId, int $questionId, array $available_taxonomy_ids)

Detailed Description

Definition at line 39 of file QuestionsBrowserTable.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Test\Questions\Presentation\QuestionsBrowserTable::__construct	(	private readonly string	$table_id,
		private readonly \ilObjUser	$current_user,
		private readonly UIFactory	$ui_factory,
		private readonly UIRenderer	$ui_renderer,
		private readonly \ilLanguage	$lng,
		private readonly \ilCtrl	$ctrl,
		private readonly DataFactory	$data_factory,
		private readonly \ilAssQuestionList	$question_list,
		private readonly TaxonomyService	$taxonomy,
		private readonly string	$parent_title
	)

Definition at line 43 of file QuestionsBrowserTable.php.

      {
    }

Member Function Documentation

addFiltersToQuestionList()

ILIAS\Test\Questions\Presentation\QuestionsBrowserTable::addFiltersToQuestionList ( array  $filters )

private

Definition at line 207 of file QuestionsBrowserTable.php.

                                                             : void
    {
        foreach (array_filter($filters) as $key => $filter) {
            if ($key === 'commented') {
                $this->question_list->setCommentFilter((int) $filter);
                continue;
            }
 
            $this->question_list->addFieldFilter($key, $filter);
        }
    }

getActions()

ILIAS\Test\Questions\Presentation\QuestionsBrowserTable::getActions

(

)

Definition at line 119 of file QuestionsBrowserTable.php.

                                : array
    {
        return [self::ACTION_INSERT => $this->getInsertAction()];
    }

References ILIAS\Test\Questions\Presentation\QuestionsBrowserTable\getInsertAction().

Referenced by ILIAS\Test\Questions\Presentation\QuestionsBrowserTable\getComponent().

Here is the call graph for this function:

Here is the caller graph for this function:

getColumns()

ILIAS\Test\Questions\Presentation\QuestionsBrowserTable::getColumns

(

)

Definition at line 69 of file QuestionsBrowserTable.php.

                                : array
    {
        $column_factory = $this->ui_factory->table()->column();
        $icon_factory = $this->ui_factory->symbol()->icon();
        $iconYes = $icon_factory->custom('assets/images/standard/icon_checked.svg', 'yes');
        $iconNo = $icon_factory->custom('assets/images/standard/icon_unchecked.svg', 'no');
 
        $columns = [
            'title' => $column_factory->text(
                $this->lng->txt('tst_question_title')
            )->withIsOptional(false, true),
            'description' => $column_factory->text(
                $this->lng->txt('description')
            )->withIsOptional(true, true),
            'question_type' => $column_factory->text(
                $this->lng->txt('tst_question_type')
            )->withIsOptional(false, true),
            'points' => $column_factory->number(
                $this->lng->txt('points')
            )->withIsOptional(false, true),
            'author' => $column_factory->text(
                $this->lng->txt('author')
            )->withIsOptional(true, false),
            'lifecycle' => $column_factory->text(
                $this->lng->txt('qst_lifecycle')
            )->withIsOptional(true, false),
            'parent_title' => $column_factory->link(
                $this->lng->txt($this->parent_title)
            )->withIsOptional(false, true),
            'taxonomies' => $column_factory->text(
                $this->lng->txt('qpl_settings_subtab_taxonomies')
            )->withIsOptional(false, true),
            'feedback' => $column_factory->boolean(
                $this->lng->txt('tst_feedback'),
                $iconYes,
                $iconNo
            )->withIsOptional(true, false),
            'created' => $column_factory->date(
                $this->lng->txt('created'),
                $this->current_user->getDateTimeFormat()
            )->withIsOptional(true, false),
            'tstamp' => $column_factory->date(
                $this->lng->txt('updated'),
                $this->current_user->getDateTimeFormat()
            )->withIsOptional(true, false)
        ];
 
        return array_map(static fn(Column $column): Column => $column->withIsSortable(true), $columns);
    }

References ILIAS\Repository\lng(), and ILIAS\UI\Component\Table\Column\Column\withIsSortable().

Here is the call graph for this function:

getComponent()

ILIAS\Test\Questions\Presentation\QuestionsBrowserTable::getComponent	(	ServerRequestInterface	$request,
		?array	$filter
	)

Definition at line 57 of file QuestionsBrowserTable.php.

                                                                                 : Data
    {
        return $this->ui_factory->table()->data(
            $this,
            $this->lng->txt('list_of_questions'),
            $this->getColumns(),
        )->withId($this->table_id)
        ->withActions($this->getActions())
        ->withRequest($request)
        ->withFilter($filter);
    }

References ILIAS\Test\Questions\Presentation\QuestionsBrowserTable\getActions(), ILIAS\Repository\lng(), and ILIAS\UI\Component\Table\Data\withId().

Here is the call graph for this function:

getInsertAction()

ILIAS\Test\Questions\Presentation\QuestionsBrowserTable::getInsertAction ( )

private

Definition at line 124 of file QuestionsBrowserTable.php.

                                      : TableAction
    {
        $url_builder = new URLBuilder($this->data_factory->uri(
            ILIAS_HTTP_PATH . "/{$this->ctrl->getLinkTargetByClass(
                ilTestQuestionBrowserTableGUI::class,
                ilTestQuestionBrowserTableGUI::CMD_INSERT_QUESTIONS
            )}"
        ));
 
        [$url_builder, $row_id_token] = $url_builder->acquireParameters(['qlist'], 'q_id');
 
        return $this->ui_factory->table()->action()->standard(
            $this->lng->txt('tst_insert_in_test'),
            $url_builder,
            $row_id_token
        );
    }

References ILIAS\Repository\lng().

Referenced by ILIAS\Test\Questions\Presentation\QuestionsBrowserTable\getActions().

Here is the call graph for this function:

Here is the caller graph for this function:

getParentObjectLink()

ILIAS\Test\Questions\Presentation\QuestionsBrowserTable::getParentObjectLink ( array  $record )

private

Definition at line 168 of file QuestionsBrowserTable.php.

                                                       : Standard
    {
        [$parent_class, $parent_command] = match($record['parent_type']) {
            'qpl' => [\ilObjQuestionPoolGUI::class, \ilObjQuestionPoolGUI::DEFAULT_CMD],
            'tst' => [\ilObjTestGUI::class, \ilObjTestGUI::SHOW_QUESTIONS_CMD],
            default => throw new \RuntimeException("Unsupported parent type {$record['parent_type']}"),
        };
 
        $this->ctrl->setParameterByClass($parent_class, 'ref_id', $record['parent_ref_id']);
        $link = $this->ui_factory->link()->standard(
            $record['parent_title'],
            $this->ctrl->getLinkTargetByClass($parent_class, $parent_command),
        );
        $this->ctrl->setParameterByClass($parent_class, 'ref_id', null);
 
        return $link;
    }

References ILIAS\Repository\ctrl(), ilObjQuestionPoolGUI\DEFAULT_CMD, and ilObjTestGUI\SHOW_QUESTIONS_CMD.

Referenced by ILIAS\Test\Questions\Presentation\QuestionsBrowserTable\getRows().

Here is the call graph for this function:

Here is the caller graph for this function:

getRows()

ILIAS\Test\Questions\Presentation\QuestionsBrowserTable::getRows	(	DataRowBuilder	$row_builder,
		array	$visible_column_ids,
		Range	$range,
		Order	$order,
		mixed	$additional_viewcontrol_data,
		mixed	$filter_data,
		mixed	$additional_parameters
	)

This is called by the table to retrieve rows; map data-records to rows using the $row_builder e.g.

yield $row_builder->buildStandardRow($row_id, $record).

Parameters

string[]

$visible_column_ids

Implements ILIAS\UI\Component\Table\DataRetrieval.

Definition at line 142 of file QuestionsBrowserTable.php.

     : \Generator {
        $timezone = new \DateTimeZone($this->current_user->getTimeZone());
        foreach ($this->loadRecords($filter_data ?? [], $order, $range) as $record) {
            $question_id = $record['question_id'];
 
            $record['question_type'] = $record['question_type'];
            $record['complete'] = (bool) $record['complete'];
            $record['lifecycle'] = new \ilAssQuestionLifecycle($record['lifecycle'])->getTranslation($this->lng) ?? '';
 
            $record['created'] = (new \DateTimeImmutable("@{$record['created']}"))->setTimezone($timezone);
            $record['tstamp'] = (new \DateTimeImmutable("@{$record['tstamp']}"))->setTimezone($timezone);
            $record['taxonomies'] = $this->resolveTaxonomiesRowData($record['obj_fi'], $question_id);
            $record['parent_title'] = $this->getParentObjectLink($record);
 
            yield $row_builder->buildDataRow((string) $question_id, $record);
        }
    }

References ILIAS\UI\Component\Table\DataRowBuilder\buildDataRow(), ILIAS\Test\Questions\Presentation\QuestionsBrowserTable\getParentObjectLink(), ILIAS\Repository\lng(), and ILIAS\Test\Questions\Presentation\QuestionsBrowserTable\resolveTaxonomiesRowData().

Here is the call graph for this function:

getTotalRowCount()

ILIAS\Test\Questions\Presentation\QuestionsBrowserTable::getTotalRowCount	(	mixed	$additional_viewcontrol_data,
		mixed	$filter_data,
		mixed	$additional_parameters
	)

Mainly for the purpose of pagination-support, it is important to know about the total number of records available.

Given the nature of a DataTable, which is, opposite to a PresentationTable, rather administrative than explorative, this information will increase user experience quite a bit. However, you may return null, if the call is to costly, but expect the View Control to look a little different in this case.

Make sure that potential filters or user restrictions are being applied to the count.

Implements ILIAS\UI\Component\Table\DataRetrieval.

Definition at line 186 of file QuestionsBrowserTable.php.

     : int {
        $filter_data ??= [];
        $this->addFiltersToQuestionList($filter_data);
        return $this->question_list->getTotalRowCount($additional_viewcontrol_data, $filter_data, $additional_parameters);
    }

loadRecords()

ILIAS\Test\Questions\Presentation\QuestionsBrowserTable::loadRecords	(	array	$filters = [],
		?Order	$order = null,
		?Range	$range = null
	)

Definition at line 196 of file QuestionsBrowserTable.php.

                                                                                                : array
    {
        $this->addFiltersToQuestionList($filters);
 
        $this->question_list->setOrder($order);
        $this->question_list->setRange($range);
        $this->question_list->load();
 
        return $this->question_list->getQuestionDataArray();
    }

References ILIAS\UI\Implementation\Component\Table\$range.

loadTaxonomyAssignmentData()

ILIAS\Test\Questions\Presentation\QuestionsBrowserTable::loadTaxonomyAssignmentData ( int  $parentObjId, int  $questionId, array  $available_taxonomy_ids  )

private

Definition at line 240 of file QuestionsBrowserTable.php.

                                                                                                                 : array
    {
        $taxonomyAssignmentData = [];
 
        foreach ($available_taxonomy_ids as $taxId) {
            $taxTree = new \ilTaxonomyTree($taxId);
            $assignments = (new \ilTaxNodeAssignment(
                'qpl',
                $parentObjId,
                'quest',
                $taxId
            ))->getAssignmentsOfItem($questionId);
 
            foreach ($assignments as $assData) {
                $taxId = $assData['tax_id'];
                if (!isset($taxonomyAssignmentData[$taxId])) {
                    $taxonomyAssignmentData[$taxId] = [];
                }
 
                $nodeId = $assData['node_id'];
                $assData['node_lft'] = $taxTree->getNodeData($nodeId)['lft'];
                $taxonomyAssignmentData[$taxId][$nodeId] = $assData;
            }
        }
 
        return $taxonomyAssignmentData;
    }

resolveTaxonomiesRowData()

ILIAS\Test\Questions\Presentation\QuestionsBrowserTable::resolveTaxonomiesRowData ( int  $obj_fi, int  $questionId  )

private

Definition at line 219 of file QuestionsBrowserTable.php.

                                                                           : string
    {
        $available_taxonomy_ids = $this->taxonomy->getUsageOfObject($obj_fi);
        $data = $this->loadTaxonomyAssignmentData($obj_fi, $questionId, $available_taxonomy_ids);
 
        $taxonomies = [];
 
        foreach ($data as $taxonomyId => $taxData) {
            $taxonomies[] = \ilObject::_lookupTitle($taxonomyId);
            $taxonomies[] = $this->ui_renderer->render(
                $this->ui_factory->listing()->unordered(
                    array_map(static function ($node) {
                        return \ilTaxonomyNode::_lookupTitle($node['node_id']);
                    }, $taxData)
                )
            );
        }
 
        return implode('', $taxonomies);
    }

References $data, and ilObject\_lookupTitle().

Referenced by ILIAS\Test\Questions\Presentation\QuestionsBrowserTable\getRows().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

ACTION_INSERT

const ILIAS\Test\Questions\Presentation\QuestionsBrowserTable::ACTION_INSERT = 'insert'

Definition at line 41 of file QuestionsBrowserTable.php.

---

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

• components/ILIAS/Test/src/Questions/Presentation/QuestionsBrowserTable.php