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

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

Public Member Functions
	__construct (protected readonly \ilLanguage $lng, protected readonly \ilCtrlInterface $ctrl, protected readonly UIFactory $ui_factory, protected readonly DataFactory $data_factory, protected readonly GlobalHttpState $http, protected readonly \ilTestPlayerAbstractGUI $parent_gui, protected readonly \ilObjTest $test, protected readonly array $data)

	getRows (DataRowBuilder $row_builder, array $visible_column_ids, Range $range, Order $order, ?array $filter_data, ?array $additional_parameters)
	This is called by the table to retrieve rows; map data-records to rows using the $row_builder e.g. More...

	getTotalRowCount (?array $filter_data, ?array $additional_parameters)
	Mainly for the purpose of pagination-support, it is important to know about the total number of records available. More...

	buildComponents (bool $is_start_page)

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

	createShowQuestionLink (int $sequence)

	getColumns ()

	isShowDescriptionEnabled ()

	isPostponingEnabled ()

	isShowPointsEnabled ()

	isShowMarkerEnabled ()

Detailed Description

Definition at line 35 of file QuestionsOfAttemptTable.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Test\Questions\Presentation\QuestionsOfAttemptTable::__construct	(	protected readonly \ilLanguage	$lng,
		protected readonly \ilCtrlInterface	$ctrl,
		protected readonly UIFactory	$ui_factory,
		protected readonly DataFactory	$data_factory,
		protected readonly GlobalHttpState	$http,
		protected readonly \ilTestPlayerAbstractGUI	$parent_gui,
		protected readonly \ilObjTest	$test,
		protected readonly array	$data
	)

Definition at line 37 of file QuestionsOfAttemptTable.php.

46 {

47 }

Member Function Documentation

◆ buildComponents()

ILIAS\Test\Questions\Presentation\QuestionsOfAttemptTable::buildComponents ( bool $is_start_page )

Returns: array<Component>

Definition at line 81 of file QuestionsOfAttemptTable.php.

References $components, ILIAS\Repository\ctrl(), ILIAS\Test\Questions\Presentation\QuestionsOfAttemptTable\getColumns(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ilTestPlayerCommands\SHOW_QUESTION.

      : array {
         $components = [
             $this->ui_factory->button()->standard(
                 $is_start_page ? $this->lng->txt('goto_first_question') : $this->lng->txt('tst_resume_test'),
                 $this->ctrl->getLinkTarget($this->parent_gui, ilTestPlayerCommands::SHOW_QUESTION)
             )
         ];
 
         $button_text = $this->lng->txt('finish_test');
         // Examview enabled & !reviewed & requires_confirmation? test_submission_overview (review gui)
         if ($this->parent_gui->getObject()->getMainSettings()->getFinishingSettings()->getShowAnswerOverview()) {
             $components[] = $this->ui_factory->button()->standard(
                 $button_text,
                 $this->ctrl->getLinkTargetByClass(ilTestSubmissionReviewGUI::class, 'show')
             );
         } else {
             $finish_test_modal = $this->parent_gui->buildFinishTestModal();
             $components[] = $this->ui_factory->button()->standard($button_text, '')
                 ->withOnClick($finish_test_modal->getShowSignal());
             $components[] = $finish_test_modal;
         }
 
         $components[] = $this->ui_factory->table()->data(
             $this,
             $this->lng->txt('question_summary'),
             $this->getColumns(),
         )
             ->withRequest($this->http->request())
             ->withId('listofquestions');
 
         return $components;
     }

Here is the call graph for this function:

◆ createShowQuestionLink()

ILIAS\Test\Questions\Presentation\QuestionsOfAttemptTable::createShowQuestionLink ( int $sequence )

protected

Definition at line 122 of file QuestionsOfAttemptTable.php.

References ILIAS\Repository\ctrl(), and ilTestPlayerCommands\SHOW_QUESTION.

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

                                                             : string
     {
         $this->ctrl->setParameter($this->parent_gui, 'sequence', $sequence);
         $this->ctrl->setParameter($this->parent_gui, 'pmode', '');
         return $this->ctrl->getLinkTarget($this->parent_gui, ilTestPlayerCommands::SHOW_QUESTION);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getColumns()

ILIAS\Test\Questions\Presentation\QuestionsOfAttemptTable::getColumns ( )

protected

Returns: array<Column>

Definition at line 132 of file QuestionsOfAttemptTable.php.

References ILIAS\Test\Questions\Presentation\QuestionsOfAttemptTable\isPostponingEnabled(), ILIAS\Test\Questions\Presentation\QuestionsOfAttemptTable\isShowDescriptionEnabled(), ILIAS\Test\Questions\Presentation\QuestionsOfAttemptTable\isShowMarkerEnabled(), ILIAS\Test\Questions\Presentation\QuestionsOfAttemptTable\isShowPointsEnabled(), and ILIAS\Repository\lng().

Referenced by ILIAS\Test\Questions\Presentation\QuestionsOfAttemptTable\buildComponents().

                                    : array
     {
         $column_factory = $this->ui_factory->table()->column();
         $icon_factory = $this->ui_factory->symbol()->icon();
         $icon_checked = $icon_factory->custom('assets/images/standard/icon_checked.svg', $this->lng->txt('yes'));
         $icon_unchecked = $icon_factory->custom('assets/images/standard/icon_unchecked.svg', $this->lng->txt('no'));
         $icon_marked = $icon_factory->custom('assets/images/object/marked.svg', $this->lng->txt('tst_question_marked'));
 
         $columns = [
             'order' => $column_factory->number($this->lng->txt('tst_qst_order')),
             'title' => $column_factory->link($this->lng->txt('tst_question')),
             'description' => $column_factory->text($this->lng->txt('description')),
             'postponed' => $column_factory->boolean(ucfirst($this->lng->txt('postponed')), $this->lng->txt('yes'), ''),
             'points' => $column_factory->number($this->lng->txt('tst_maximum_points'))->withUnit($this->lng->txt('points_short')),
             'answered' => $column_factory->boolean($this->lng->txt('answered'), $icon_checked, $icon_unchecked),
             'marked' => $column_factory->boolean($this->lng->txt('tst_question_marker'), $icon_marked, ''),
         ];
 
         $optional_columns = [
             'description' => $this->isShowDescriptionEnabled(),
             'postponed' => $this->isPostponingEnabled(),
             'points' => $this->isShowPointsEnabled(),
             'marked' => $this->isShowMarkerEnabled(),
         ];
 
         $list = [];
         foreach ($columns as $key => $column) {
             if (isset($optional_columns[$key]) && !$optional_columns[$key]) {
                 continue;
             }
             $list[$key] = $column->withIsOptional(false, true)->withIsSortable(false);
         }
         return $list;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getData()

ILIAS\Test\Questions\Presentation\QuestionsOfAttemptTable::getData	(	Range	$range,
		Order	$order
	)

protected

Definition at line 116 of file QuestionsOfAttemptTable.php.

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

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

                                                           : array
     {
         // ignore order bc table is not sortable
         return array_slice($this->data, $range->getStart(), $range->getLength());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRows()

ILIAS\Test\Questions\Presentation\QuestionsOfAttemptTable::getRows	(	DataRowBuilder	$row_builder,
		array	$visible_column_ids,
		Range	$range,
		Order	$order,
		?array	$filter_data,
		?array	$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 49 of file QuestionsOfAttemptTable.php.

References ILIAS\UI\Component\Table\DataRowBuilder\buildDataRow(), ILIAS\Test\Questions\Presentation\QuestionsOfAttemptTable\createShowQuestionLink(), ILIAS\Test\Questions\Presentation\QuestionsOfAttemptTable\getData(), and ILIAS\Repository\int().

      : \Generator {
         foreach ($this->getData($range, $order) as $question) {
             $title = $this->ui_factory->link()->standard($question['title'], $this->createShowQuestionLink($question['sequence']));
             $record = [
                 'order' => (int) $question['order'],
                 'title' => $title->withDisabled($question['disabled']),
                 'description' => $question['description'],
                 'points' => $question['points'],
                 'postponed' => (bool) $question['postponed'],
                 'answered' => (bool) $question['isAnswered'],
                 'marked' => (bool) $question['marked'],
             ];
             yield $row_builder->buildDataRow((string) $question['order'], $record);
         }
     }

Here is the call graph for this function:

◆ getTotalRowCount()

ILIAS\Test\Questions\Presentation\QuestionsOfAttemptTable::getTotalRowCount	(	?array	$filter_data,
		?array	$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 72 of file QuestionsOfAttemptTable.php.

                                                                                         : ?int
     {
         //ignore filter bc table is not filterable
         return count($this->data);
     }

◆ isPostponingEnabled()

ILIAS\Test\Questions\Presentation\QuestionsOfAttemptTable::isPostponingEnabled ( )

protected

Definition at line 172 of file QuestionsOfAttemptTable.php.

Referenced by ILIAS\Test\Questions\Presentation\QuestionsOfAttemptTable\getColumns().

                                             : bool
     {
         return $this->test->isPostponingEnabled();
     }

Here is the caller graph for this function:

◆ isShowDescriptionEnabled()

ILIAS\Test\Questions\Presentation\QuestionsOfAttemptTable::isShowDescriptionEnabled ( )

protected

Definition at line 167 of file QuestionsOfAttemptTable.php.

Referenced by ILIAS\Test\Questions\Presentation\QuestionsOfAttemptTable\getColumns().

                                                  : bool
     {
         return $this->test->getListOfQuestionsDescription();
     }

Here is the caller graph for this function:

◆ isShowMarkerEnabled()

ILIAS\Test\Questions\Presentation\QuestionsOfAttemptTable::isShowMarkerEnabled ( )

protected

Definition at line 182 of file QuestionsOfAttemptTable.php.

Referenced by ILIAS\Test\Questions\Presentation\QuestionsOfAttemptTable\getColumns().

                                             : bool
     {
         return $this->test->getShowMarker();
     }

Here is the caller graph for this function:

◆ isShowPointsEnabled()

ILIAS\Test\Questions\Presentation\QuestionsOfAttemptTable::isShowPointsEnabled ( )

protected

Definition at line 177 of file QuestionsOfAttemptTable.php.

Referenced by ILIAS\Test\Questions\Presentation\QuestionsOfAttemptTable\getColumns().

                                             : bool
     {
         return !$this->test->getTitleOutput();
     }

Here is the caller graph for this function:

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

components/ILIAS/Test/src/Questions/Presentation/QuestionsOfAttemptTable.php

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildComponents()

◆ createShowQuestionLink()

◆ getColumns()

◆ getData()

◆ getRows()

◆ getTotalRowCount()

◆ isPostponingEnabled()

◆ isShowDescriptionEnabled()

◆ isShowMarkerEnabled()

◆ isShowPointsEnabled()