Collaboration diagram for ILIAS\Test\Results\Presentation\AttemptResultsTable:

Public Member Functions
	__construct (UIFactory $ui_factory, private UIRenderer $ui_renderer, private Refinery $refinery, private HTTPService $http, DataFactory $data_factory, Language $lng, private AttemptSolutions $test_results, Settings $settings, string $title, bool $for_print)

	render ()

	getTableComponent ()

Protected Attributes
PresentationTable	$table

Private Member Functions
	applyControls (string $mode, string $sortation, array $question_results)

	getViewControlNamespace ()

	getViewControlsParameter ()

	getViewControls (UIFactory $ui_factory, Language $lng, URLBuilder $target, string $mode, string $sortation)
	return array<\ILIAS\UI\ViewControl\ViewControl> More...

	getMapping ()

Private Attributes
const	ENV = 'e'

const	LNG = 'l'

const	URL_NAMESPACE = ['taresult', 'vc']

const	PARAM_MODE = 'm'

const	MODE_OPT_ALL = "all"

const	MODE_OPT_CORRECT = "ok"

const	MODE_OPT_INCORRECT = "fail"

const	PARAM_SORT = 's'

const	SORT_OPT_ORDEROFAPPEARANCE = 'ooa'

const	SORT_OPT_POSSIBLESCORE = 'ms'

Detailed Description

Definition at line 35 of file AttemptResultsTable.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Test\Results\Presentation\AttemptResultsTable::__construct	(	UIFactory	$ui_factory,
		private UIRenderer	$ui_renderer,
		private Refinery	$refinery,
		private HTTPService	$http,
		DataFactory	$data_factory,
		Language	$lng,
		private AttemptSolutions	$test_results,
		Settings	$settings,
		string	$title,
		bool	$for_print
	)

Definition at line 50 of file AttemptResultsTable.php.

      {
        list($mode, $sortation) = $this->getViewControlsParameter();
        $results = $this->applyControls($mode, $sortation, $test_results->getQuestionResults());
        $target = new URLBuilder($data_factory->uri($http->request()->getUri()->__toString()));
 
        $this->table = $ui_factory->table()->presentation(
            $title,
            $for_print ? [] : $this->getViewControls($ui_factory, $lng, $target, $mode, $sortation),
            $this->getMapping()
        )
        ->withEnvironment([
            self::ENV => $settings,
            self::LNG => $lng
        ])
        ->withData($results);
    }

References $http, $lng, $results, ILIAS\Test\Results\Presentation\AttemptResultsTable\applyControls(), ILIAS\Test\Results\Presentation\AttemptResultsTable\getMapping(), ILIAS\Test\Results\Data\AttemptSolutions\getQuestionResults(), ILIAS\Test\Results\Presentation\AttemptResultsTable\getViewControls(), and ILIAS\Test\Results\Presentation\AttemptResultsTable\getViewControlsParameter().

Here is the call graph for this function:

Member Function Documentation

◆ applyControls()

ILIAS\Test\Results\Presentation\AttemptResultsTable::applyControls	(	string	$mode,
		string	$sortation,
		array	$question_results
	)

private

Parameters

array<QuestionResult> $question_results

Definition at line 91 of file AttemptResultsTable.php.

      {
        switch ($mode) {
            case self::MODE_OPT_CORRECT:
                $filter = static fn($qr) => $qr->getCorrect() === QuestionResult::CORRECT_FULL;
                break;
            case self::MODE_OPT_INCORRECT:
                $filter = static fn($qr) => $qr->getCorrect() !== QuestionResult::CORRECT_FULL;
                break;
            case self::MODE_OPT_ALL:
            default:
                $filter = static fn($qr) => true;
        }
        $question_results = array_filter($question_results, $filter);
 
        if ($sortation === self::SORT_OPT_POSSIBLESCORE) {
            usort(
                $question_results,
                static fn(QuestionResult $a, QuestionResult $b) => $a->getQuestionScore() <=> $b->getQuestionScore()
            );
            $question_results = array_reverse($question_results);
        }
        return $question_results;
    }

References Vendor\Package\$a, Vendor\Package\$b, ILIAS\Test\Results\Data\QuestionResult\CORRECT_FULL, ILIAS\Test\Results\Presentation\AttemptResultsTable\MODE_OPT_ALL, ILIAS\Test\Results\Presentation\AttemptResultsTable\MODE_OPT_CORRECT, and ILIAS\Test\Results\Presentation\AttemptResultsTable\MODE_OPT_INCORRECT.

Referenced by ILIAS\Test\Results\Presentation\AttemptResultsTable\__construct().

Here is the caller graph for this function:

◆ getMapping()

ILIAS\Test\Results\Presentation\AttemptResultsTable::getMapping ( )

private

Definition at line 182 of file AttemptResultsTable.php.

                                 : \Closure
    {
        return function (PresentationRow $row, QuestionResult $question, UIFactory $ui_factory, array $environment) {
            $env = $environment[self::ENV];
            $lng = $environment[self::LNG];
 
            $title = $this->refinery->encode()->htmlSpecialCharsAsEntities()->transform(
                $question->getTitle()
            );
 
            $important_fields = [
                $lng->txt('position') => (string) ($question->getPosition() + 1),
                $lng->txt('question_id') => (string) $question->getId(),
                $lng->txt('question_type') => $lng->txt($question->getType()),
                $lng->txt('points') => sprintf(
                    '%s/%s (%s%%)',
                    (string) $question->getUserScore(),
                    (string) $question->getQuestionScore(),
                    (string) $question->getUserScorePercent()
                )
            ];
 
            $stats_fields = $important_fields;
            $stats = $ui_factory->listing()->characteristicValue()->text($stats_fields);
 
            $contents = [
                $stats
            ];
 
            if ($recap = $question->getContentForRecapitulation()) {
                $contents[] = $ui_factory->listing()->descriptive([
                    $lng->txt('suggested_solution') => $recap
                ]);
            }
 
            $user_answer = $question->getUserAnswer();
            $answer_contents = [
                $ui_factory->listing()->descriptive([$lng->txt('tst_header_participant') => $user_answer])
            ];
            if ($env->getShowBestSolution()) {
                $answer_contents[] = $ui_factory->listing()->descriptive([
                    $lng->txt('tst_header_solution') => $question->getBestSolution()
                ]);
            }
 
            $answers = $ui_factory->layout()->alignment()->horizontal()->evenlyDistributed(...$answer_contents);
            $contents[] = $answers;
 
            $content = $ui_factory->layout()->alignment()->vertical(...$contents);
 
            switch ($question->getCorrect()) {
                case QuestionResult::CORRECT_FULL:
                    $icon_name = 'icon_ok.svg';
                    $label = $lng->txt("answer_is_right");
                    break;
                case QuestionResult::CORRECT_PARTIAL:
                    $icon_name = 'icon_mostly_ok.svg';
                    $label = $lng->txt("answer_is_not_correct_but_positive");
                    break;
                case QuestionResult::CORRECT_NONE:
                    $icon_name = 'icon_not_ok.svg';
                    $label = $lng->txt("answer_is_wrong");
                    break;
            }
            $path = \ilUtil::getImagePath('standard/' . $icon_name);
            $correct_icon = $ui_factory->symbol()->icon()->custom(
                $path,
                $label
            );
 
            return $row
                ->withHeadline($title)
                ->withLeadingSymbol($correct_icon)
                ->withImportantFields($important_fields)
                ->withContent($content);
        };
    }

References $lng, $path, ILIAS\Test\Results\Data\QuestionResult\CORRECT_FULL, ILIAS\Test\Results\Data\QuestionResult\CORRECT_NONE, ILIAS\Test\Results\Data\QuestionResult\CORRECT_PARTIAL, ilUtil\getImagePath(), ILIAS\Repository\refinery(), and ILIAS\UI\Component\Table\PresentationRow\withHeadline().

Referenced by ILIAS\Test\Results\Presentation\AttemptResultsTable\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTableComponent()

ILIAS\Test\Results\Presentation\AttemptResultsTable::getTableComponent ( )

Definition at line 83 of file AttemptResultsTable.php.

                                       : PresentationTable
    {
        return $this->table;
    }

References ILIAS\Test\Results\Presentation\AttemptResultsTable\$table.

◆ getViewControlNamespace()

ILIAS\Test\Results\Presentation\AttemptResultsTable::getViewControlNamespace ( )

private

Definition at line 119 of file AttemptResultsTable.php.

                                              : array
    {
        $namespace = self::URL_NAMESPACE;
        $namespace[] = (string) $this->test_results->getActiveId();
        $namespace[] = (string) $this->test_results->getAttempt();
        return $namespace;
    }

References $namespace, and ILIAS\Test\Results\Presentation\AttemptResultsTable\URL_NAMESPACE.

Referenced by ILIAS\Test\Results\Presentation\AttemptResultsTable\getViewControlsParameter().

Here is the caller graph for this function:

◆ getViewControls()

ILIAS\Test\Results\Presentation\AttemptResultsTable::getViewControls	(	UIFactory	$ui_factory,
		Language	$lng,
		URLBuilder	$target,
		string	$mode,
		string	$sortation
	)

private

return array<\ILIAS\UI\ViewControl\ViewControl>

Definition at line 144 of file AttemptResultsTable.php.

     : array {
        $builder = $target->acquireParameter($this->getViewControlNamespace(), self::PARAM_MODE);
        [$target, $token] = $builder;
 
        $modes = [
            $lng->txt('resulttable_all') => $target->withParameter($token, self::MODE_OPT_ALL)->buildURI()->__toString(),
            $lng->txt('resulttable_correct') => $target->withParameter($token, self::MODE_OPT_CORRECT)->buildURI()->__toString(),
            $lng->txt('resulttable_incorrect') => $target->withParameter($token, self::MODE_OPT_INCORRECT)->buildURI()->__toString(),
        ];
        $check = [self::MODE_OPT_ALL, self::MODE_OPT_CORRECT, self::MODE_OPT_INCORRECT];
        $active = array_search($mode, $check);
 
        $vc_mode = $ui_factory->viewControl()->mode($modes, $lng->txt('ta_resulttable_vc_mode_aria'))
            ->withActive(array_keys($modes)[$active]);
 
        $options = [
            self::SORT_OPT_ORDEROFAPPEARANCE => $lng->txt('resulttable_vc_sort_iooa'),
            self::SORT_OPT_POSSIBLESCORE => $lng->txt('resulttable_vc_sort_posscore')
        ];
 
        $pre = implode(URLBuilder::SEPARATOR, $this->getViewControlNamespace()) . URLBuilder::SEPARATOR;
        $vc_sort = $ui_factory->viewControl()->sortation($options, $sortation)->withTargetURL(
            $target->buildURI()->__toString(),
            $pre . self::PARAM_SORT
        );
 
        return [
            $vc_mode,
            $vc_sort
        ];
    }

Referenced by ILIAS\Test\Results\Presentation\AttemptResultsTable\__construct().

Here is the caller graph for this function:

◆ getViewControlsParameter()

ILIAS\Test\Results\Presentation\AttemptResultsTable::getViewControlsParameter ( )

private

Definition at line 127 of file AttemptResultsTable.php.

                                               : array
    {
        $request = $this->http->wrapper()->query();
        $pre = implode(URLBuilder::SEPARATOR, $this->getViewControlNamespace()) . URLBuilder::SEPARATOR;
 
        $mode = $request->has($pre . self::PARAM_MODE) ?
            $request->retrieve($pre . self::PARAM_MODE, $this->refinery->kindlyTo()->string()) : self::MODE_OPT_ALL;
 
        $sortation = $request->has($pre . self::PARAM_SORT) ?
            $request->retrieve($pre . self::PARAM_SORT, $this->refinery->kindlyTo()->string()) : self::SORT_OPT_ORDEROFAPPEARANCE;
 
        return [$mode, $sortation];
    }

References ILIAS\Test\Results\Presentation\AttemptResultsTable\getViewControlNamespace(), ILIAS\FileDelivery\http(), ILIAS\Test\Results\Presentation\AttemptResultsTable\MODE_OPT_ALL, ILIAS\Repository\refinery(), ILIAS\UI\URLBuilder\SEPARATOR, and ILIAS\Test\Results\Presentation\AttemptResultsTable\SORT_OPT_ORDEROFAPPEARANCE.

Referenced by ILIAS\Test\Results\Presentation\AttemptResultsTable\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ render()

ILIAS\Test\Results\Presentation\AttemptResultsTable::render ( )

Definition at line 78 of file AttemptResultsTable.php.

                            : string
    {
        return $this->ui_renderer->render($this->table);
    }

Field Documentation

◆ $table

PresentationTable ILIAS\Test\Results\Presentation\AttemptResultsTable::$table

protected

Definition at line 48 of file AttemptResultsTable.php.

Referenced by ILIAS\Test\Results\Presentation\AttemptResultsTable\getTableComponent().

◆ ENV

const ILIAS\Test\Results\Presentation\AttemptResultsTable::ENV = 'e'

private

Definition at line 37 of file AttemptResultsTable.php.

◆ LNG

const ILIAS\Test\Results\Presentation\AttemptResultsTable::LNG = 'l'

private

Definition at line 38 of file AttemptResultsTable.php.

◆ MODE_OPT_ALL

const ILIAS\Test\Results\Presentation\AttemptResultsTable::MODE_OPT_ALL = "all"

private

Definition at line 41 of file AttemptResultsTable.php.

Referenced by ILIAS\Test\Results\Presentation\AttemptResultsTable\applyControls(), and ILIAS\Test\Results\Presentation\AttemptResultsTable\getViewControlsParameter().

◆ MODE_OPT_CORRECT

const ILIAS\Test\Results\Presentation\AttemptResultsTable::MODE_OPT_CORRECT = "ok"

private

Definition at line 42 of file AttemptResultsTable.php.

Referenced by ILIAS\Test\Results\Presentation\AttemptResultsTable\applyControls().

◆ MODE_OPT_INCORRECT

const ILIAS\Test\Results\Presentation\AttemptResultsTable::MODE_OPT_INCORRECT = "fail"

private

Definition at line 43 of file AttemptResultsTable.php.

Referenced by ILIAS\Test\Results\Presentation\AttemptResultsTable\applyControls().

◆ PARAM_MODE

const ILIAS\Test\Results\Presentation\AttemptResultsTable::PARAM_MODE = 'm'

private

Definition at line 40 of file AttemptResultsTable.php.

◆ PARAM_SORT

const ILIAS\Test\Results\Presentation\AttemptResultsTable::PARAM_SORT = 's'

private

Definition at line 44 of file AttemptResultsTable.php.

◆ SORT_OPT_ORDEROFAPPEARANCE

const ILIAS\Test\Results\Presentation\AttemptResultsTable::SORT_OPT_ORDEROFAPPEARANCE = 'ooa'

private

Definition at line 45 of file AttemptResultsTable.php.

Referenced by ILIAS\Test\Results\Presentation\AttemptResultsTable\getViewControlsParameter().

◆ SORT_OPT_POSSIBLESCORE

const ILIAS\Test\Results\Presentation\AttemptResultsTable::SORT_OPT_POSSIBLESCORE = 'ms'

private

Definition at line 46 of file AttemptResultsTable.php.

◆ URL_NAMESPACE

const ILIAS\Test\Results\Presentation\AttemptResultsTable::URL_NAMESPACE = ['taresult', 'vc']

private

Definition at line 39 of file AttemptResultsTable.php.

Referenced by ILIAS\Test\Results\Presentation\AttemptResultsTable\getViewControlNamespace().

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

components/ILIAS/Test/src/Results/Presentation/AttemptResultsTable.php

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ applyControls()

◆ getMapping()

◆ getTableComponent()

◆ getViewControlNamespace()

◆ getViewControls()

◆ getViewControlsParameter()

◆ render()

Field Documentation

◆ $table

◆ ENV

◆ LNG

◆ MODE_OPT_ALL

◆ MODE_OPT_CORRECT

◆ MODE_OPT_INCORRECT

◆ PARAM_MODE

◆ PARAM_SORT

◆ SORT_OPT_ORDEROFAPPEARANCE

◆ SORT_OPT_POSSIBLESCORE

◆ URL_NAMESPACE