class.ilTestExportAbstract.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

abstract class ilTestExportAbstract
{
    protected ilTestEvaluationData $complete_data;
    protected array $aggregated_data;
    protected array $additionalFields;
    protected ilLanguage $lng;

    public function __construct(
        protected ilObjTest $test_obj,
        protected string $filter_key_participants = ilTestEvaluationData::FILTER_BY_NONE,
        protected string $filtertext = '',
        protected bool $passedonly = false,
        protected bool $scoredonly = false,
        ilLanguage $lng = null
    ) {
        global $DIC;
        $this->lng = $lng ?? $DIC['lng'];
        $this->complete_data = $this->test_obj->getCompleteEvaluationData(true, $this->filter_key_participants, $this->filtertext);
        $this->aggregated_data = $this->test_obj->getAggregatedResultsData();
        $this->additionalFields = $this->test_obj->getEvaluationAdditionalFields();
    }

    abstract public function deliver(string $title): void;
    abstract public function getContent(): ilAssExcelFormatHelper|string;

    public function getDatarows(ilObjTest $test_obj): array
    {
        $test_obj->setAccessFilteredParticipantList(
            $test_obj->buildStatisticsAccessFilteredParticipantList()
        );

        $headerrow = $this->getHeaderRow($this->lng, $test_obj);
        $counter = 1;
        $rows = [];
        foreach ($this->complete_data->getParticipants() as $active_id => $userdata) {
            $datarow = $headerrow;
            if ($this->passedonly && !$userdata->getPassed()) {
                continue;
            }
            $datarow2 = [];
            if ($test_obj->getAnonymity()) {
                $datarow2[] = $counter;
            } else {
                $datarow2[] = $userdata->getName();
                $datarow2[] = $userdata->getLogin();
            }

            $userfields = [];
            if ($userdata->getUserID() !== null) {
                $userfields = ilObjUser::_lookupFields($userdata->getUserID());
            }
            foreach ($this->additionalFields as $fieldname) {
                if ($fieldname === 'gender') {
                    $datarow2[] = isset($userfields[$fieldname]) && $userfields[$fieldname] !== ''
                        ? $this->lng->txt('gender_' . $userfields[$fieldname])
                        : '';
                } elseif ($fieldname === 'exam_id') {
                    $datarow2[] = $userdata->getExamIdFromScoredPass();
                } else {
                    $datarow2[] = $userfields[$fieldname] ?? '';
                }
            }

            $datarow2[] = $userdata->getReached();
            $datarow2[] = $userdata->getMaxpoints();
            $datarow2[] = $userdata->getMark();
            $datarow2[] = $userdata->getQuestionsWorkedThrough();
            $datarow2[] = $userdata->getNumberOfQuestions();
            $datarow2[] = $userdata->getQuestionsWorkedThroughInPercent() / 100.0;
            $time = $userdata->getTimeOfWork();
            $time_seconds = $time;
            $time_hours = floor($time_seconds / 3600);
            $time_seconds -= $time_hours * 3600;
            $time_minutes = floor($time_seconds / 60);
            $time_seconds -= $time_minutes * 60;
            $datarow2[] = sprintf("%02d:%02d:%02d", $time_hours, $time_minutes, $time_seconds);
            $time = $userdata->getQuestionsWorkedThrough() ? $this->complete_data->getParticipant(
                $active_id
            )->getTimeOfWork() / $userdata->getQuestionsWorkedThrough() : 0;
            $time_seconds = $time;
            $time_hours = floor($time_seconds / 3600);
            $time_seconds -= $time_hours * 3600;
            $time_minutes = floor($time_seconds / 60);
            $time_seconds -= $time_minutes * 60;
            $datarow2[] = sprintf("%02d:%02d:%02d", $time_hours, $time_minutes, $time_seconds);

            $fv = $userdata->getFirstVisit();
            $lv = $userdata->getLastVisit();
            foreach ([$fv, $lv] as $ts) {
                if ($ts) {
                    $visit = ilDatePresentation::formatDate(new ilDateTime($ts, IL_CAL_UNIX));
                    $datarow2[] = $visit;
                } else {
                    $datarow2[] = "";
                }
            }

            $median = $this->complete_data->getStatistics()->getStatistics()->median();
            $pct = $userdata->getMaxpoints() ? $median / $this->complete_data->getParticipant(
                $active_id
            )->getMaxpoints() * 100.0 : 0;
            $mark = $test_obj->getMarkSchema()->getMatchingMark($pct);
            $mark_short_name = "";
            if (is_object($mark)) {
                $mark_short_name = $mark->getShortName();
            }
            $datarow2[] = $mark_short_name;
            $datarow2[] = $this->complete_data->getStatistics()->getStatistics()->rank(
                $userdata->getReached()
            );
            $datarow2[] = $this->complete_data->getStatistics()->getStatistics()->rank_median();
            $datarow2[] = $this->complete_data->getStatistics()->getStatistics()->count();
            $datarow2[] = $median;

            $datarow2[] = $userdata->getPassCount();
            $datarow2[] = $userdata->getFinishedPasses();
            if ($test_obj->getPassScoring() === SCORE_BEST_PASS) {
                $datarow2[] = $userdata->getBestPass() + 1;
            } else {
                $datarow2[] = $userdata->getLastPass() + 1;
            }
            $shown_pass = 0;
            if ($counter >= 2 && $test_obj->isRandomTest()) {
                $datarow = $datarow2;
                $datarow[] = '';
                $datarow2 = array_map(static fn($entry) => '', $datarow2);
            }

            for ($pass = 0; $pass <= $userdata->getLastPass(); $pass++) {
                $finishdate = ilObjTest::lookupPassResultsUpdateTimestamp($active_id, $pass);

                if ($finishdate < 1
                    || $this->scoredonly && $pass !== $userdata->getScoredPass()) {
                    continue;
                }

                if ($shown_pass > 0) {
                    for ($i = 1, $iMax = count($headerrow); $i < $iMax; $i++) {
                        $datarow2[] = "";
                        $datarow[] = "";
                    }
                    $datarow[] = "";
                }
                $datarow2[] = $pass + 1;
                if (is_object($userdata)
                    && is_array(
                        $evaluated_questions = $userdata->getQuestions($pass)
                    )
                ) {
                    $questions = $this->orderQuestions($evaluated_questions);
                    foreach ($questions as $question) {
                        $question_data = $userdata->getPass(
                            $pass
                        )->getAnsweredQuestionByQuestionId($question["id"]);
                        if (is_null($question_data)) {
                            $question_data = ['reached' => 0];
                        }
                        $datarow2[] = $question_data["reached"];
                        $datarow[] = preg_replace("/<.*?>/", "", $this->complete_data->getQuestionTitle($question["id"]));
                    }
                }
                if (($counter === 1 && $shown_pass === 0) || $test_obj->isRandomTest()) {
                    $rows[] = $datarow;
                }
                $datarow = [];

                $rows[] = $datarow2;
                $datarow2 = [];
                $shown_pass++;
            }
            $counter++;
        }

        return $rows;
    }

    public function getHeaderRow(ilLanguage $lng, ilObjTest $test_obj): array
    {
        if ($test_obj->getAnonymity()) {
            $datarow[] = $lng->txt("counter");
        } else {
            $datarow[] = $lng->txt("name");
            $datarow[] = $lng->txt("login");
        }
        if (count($this->additionalFields)) {
            foreach ($this->additionalFields as $fieldname) {
                if (strcmp($fieldname, "exam_id") === 0) {
                    $datarow[] = $lng->txt('exam_id_label');
                    continue;
                }
                $datarow[] = $lng->txt($fieldname);
            }
        }
        $datarow[] = $this->lng->txt("tst_stat_result_resultspoints");
        $datarow[] = $lng->txt("maximum_points");
        $datarow[] = $lng->txt("tst_stat_result_resultsmarks");
        $datarow[] = $lng->txt("tst_stat_result_qworkedthrough");
        $datarow[] = $lng->txt("tst_stat_result_qmax");
        $datarow[] = $lng->txt("tst_stat_result_pworkedthrough");
        $datarow[] = $lng->txt("tst_stat_result_timeofwork");
        $datarow[] = $lng->txt("tst_stat_result_atimeofwork");
        $datarow[] = $lng->txt("tst_stat_result_firstvisit");
        $datarow[] = $lng->txt("tst_stat_result_lastvisit");
        $datarow[] = $lng->txt("tst_stat_result_mark_median");
        $datarow[] = $lng->txt("tst_stat_result_rank_participant");
        $datarow[] = $lng->txt("tst_stat_result_rank_median");
        $datarow[] = $lng->txt("tst_stat_result_total_participants");
        $datarow[] = $lng->txt("tst_stat_result_median");
        $datarow[] = $lng->txt("tst_tbl_col_started_passes");
        $datarow[] = $lng->txt("tst_tbl_col_finished_passes");
        $datarow[] = $lng->txt("scored_pass");
        $datarow[] = $lng->txt("pass");

        return $datarow;
    }

    protected function orderQuestions(array $questions): array
    {
        $key = $this->test_obj->isRandomTest() ? 'qid' : 'sequence';
        usort(
            $questions,
            static function ($a, $b) use ($key) {
                if (isset($a[$key], $b[$key]) && $a[$key] > $b[$key]) {
                    return 1;
                }
                return -1;
            }
        );
        return $questions;
    }
}