AttemptResultsTable.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Test\Results\Presentation;

use ILIAS\Test\Results\Data\AttemptResult;
use ILIAS\Test\Results\Data\QuestionResult;
use ILIAS\UI\Component\Table\Presentation as PresentationTable;
use ILIAS\UI\Component\Table\PresentationRow;
use ILIAS\UI\URLBuilder;
use ILIAS\UI\Factory as UIFactory;
use ILIAS\UI\Renderer as UIRenderer;
use ILIAS\Refinery\Factory as Refinery;
use ILIAS\HTTP\Services as HTTPService;
use ILIAS\Data\Factory as DataFactory;
use ILIAS\Language\Language;

class AttemptResultsTable
{
    private const ENV = 'e';
    private const LNG = 'l';
    private const URL_NAMESPACE = ['taresult', 'vc'];
    private const PARAM_MODE = 'm';
    private const MODE_OPT_ALL = "all";
    private const MODE_OPT_CORRECT = "ok";
    private const MODE_OPT_INCORRECT = "fail";
    private const PARAM_SORT = 's';
    private const SORT_OPT_ORDEROFAPPEARANCE = 'ooa';
    private const SORT_OPT_POSSIBLESCORE = 'ms';

    protected PresentationTable $table;

    public function __construct(
        UIFactory $ui_factory,
        private UIRenderer $ui_renderer,
        private Refinery $refinery,
        private HTTPService $http,
        DataFactory $data_factory,
        Language $lng,
        private AttemptResult $test_results,
        Settings $settings,
        string $title,
        bool $for_print
    ) {
        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);
    }

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

    public function getTableComponent(): PresentationTable
    {
        return $this->table;
    }

    private function applyControls(
        string $mode,
        string $sortation,
        array $question_results
    ) {
        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;
    }

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

    private function getViewControlsParameter(): 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];
    }

    private function getViewControls(
        UIFactory $ui_factory,
        Language $lng,
        URLBuilder $target,
        string $mode,
        string $sortation
    ): 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
        ];
    }

    private function getMapping(): \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_fields[$lng->txt('tst_question_hints_requested_hint_count_header')] = (string) $question->getNumberOfRequestedHints();
            $stats = $ui_factory->listing()->characteristicValue()->text($stats_fields);


            $feedback = $ui_factory->listing()->descriptive([
                $lng->txt('tst_feedback') => $question->getFeedback()
            ]);

            $contents = [];

            $contents[] = $stats;
            if ($env->getShowFeedback()) {
                $contents[] = $feedback;
            }

            if ($recap = $question->getContentForRecapitulation()) {
                $contents[] = $ui_factory->listing()->descriptive([
                    $lng->txt('suggested_solution') => $recap
                ]);
            }

            $listing = [
                $lng->txt('tst_header_participant') => $question->getUserAnswer()
            ];
            if ($autosave_content = $question->getAutosavedAnswer()) {
                $listing[$lng->txt('autosavecontent')] = $autosave_content;
            }

            $answer_contents = [
                $ui_factory->listing()->descriptive($listing)
            ];
            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);
        };
    }
}