class.SurveyMatrixQuestionEvaluation.php

Go to the documentation of this file.

<?php

class SurveyMatrixQuestionEvaluation extends SurveyQuestionEvaluation
{
    //
    // RESULTS
    //

    public function getResults()
    {
        $results = array();

        $answers = $this->getAnswerData();

        // parse rows
        for ($r = 0; $r < $this->question->getRowCount(); $r++) {
            $row_results = new ilSurveyEvaluationResults($this->question);

            $this->parseResults(
                $row_results,
                (array) ($answers[$r] ?? []),
                $this->question->getColumns()
            );

            $results[] = array(
                $this->question->getRow($r)->title,
                $row_results
            );
        }

        return $results;
    }


    //
    // DETAILS
    //

    public function getGrid(
        $a_results,
        bool $a_abs = true,
        bool $a_perc = true
    ): array {
        $res = array(
            "cols" => array(),
            "rows" => array()
        );

        $tmp = $a_results;
        $tmp = array_shift($tmp);
        $vars = $tmp[1]->getVariables();
        if ($vars) {
            foreach ($vars as $var) {
                $res["cols"][] = $var->cat->title;
            }
        }
        $q_counter = 0;
        foreach ($a_results as $results_row) {
            #20363
            $parsed_row = array(
                ++$q_counter . ". " . $results_row[0]
            );

            $vars = $results_row[1]->getVariables();
            if ($vars) {
                foreach ($vars as $var) {
                    $perc = $var->perc
                        ? sprintf("%.2f", $var->perc * 100) . "%"
                        : "0%";

                    if ($a_abs && $a_perc) {
                        $parsed_row[] = $var->abs . " / " . $perc;
                    } elseif ($a_abs) {
                        $parsed_row[] = $var->abs;
                    } else {
                        $parsed_row[] = $perc;
                    }
                }
            }

            $res["rows"][] = $parsed_row;
        }
        return $res;
    }

    public function getTextAnswers($a_results): array
    {
        $res = array();

        foreach ($a_results as $results_row) {
            $texts = $results_row[1]->getMappedTextAnswers();
            if ($texts) {
                $idx = $results_row[0];
                foreach ($texts as $answers) {
                    foreach ($answers as $answer) {
                        $res[$idx][] = $answer;
                    }
                }
            }
        }

        return $res;
    }

    public function getChart($a_results): ?array
    {
        $chart = ilChart::getInstanceByType(ilChart::TYPE_GRID, $a_results[0][1]->getQuestion()->getId());
        $chart->setXAxisToInteger(true);
        $chart->setStacked(true);

        $colors = $this->getChartColors();
        $chart->setColors($colors);

        // :TODO:
        //$chart->setsize($this->chart_width, $this->chart_height);

        $data = $labels = $legend = array();

        $row_idx = count($a_results);

        $row_counter = 0;
        $text_shortened = false;
        foreach ($a_results as $row) {
            $row_idx--;

            $row_title = $row[0];
            $row_results = $row[1];

            #20363
            $row_title = ++$row_counter . ". " . $row_title;
            $labels[$row_idx] = ilStr::shortenTextExtended($row_title, 50, true);
            if ($labels[$row_idx] != $row_title) {
                $text_shortened = true;
            }
            //$labels[$row_idx] = wordwrap(ilUtil::shortenText($row_title, 50, true), 30, "<br />");

            $vars = $row_results->getVariables();
            if ($vars) {
                foreach ($vars as $idx => $var) {
                    if (!array_key_exists($idx, $data)) {
                        $data[$idx] = $chart->getDataInstance(ilChartGrid::DATA_BARS);
                        $data[$idx]->setLabel($var->cat->title);
                        $data[$idx]->setBarOptions(0.5, "center", true);
                        $data[$idx]->setFill(1);

                        $legend[] = array(
                            $var->cat->title,
                            $colors[$idx]
                        );
                    }

                    $data[$idx]->addPoint((float) $var->abs, $row_idx);
                }
            }
        }

        //Chart height depending on the number of questions. Not fixed anymore.
        $this->chart_height = count($a_results) * 40;
        //Chart width 500px if one or + question string are longer than 60 char. Otherwise the default width still aplied.
        if ($text_shortened) {
            $this->chart_width = 500;
        }
        $chart->setSize((string) $this->chart_width, (string) $this->chart_height);

        foreach ($data as $var) {
            $chart->addData($var);
        }

        $chart->setTicks(false, $labels, true);

        return array(
            $chart->getHTML(),
            $legend
        );
    }



    //
    // EXPORT
    //

    public function exportResults(
        $a_results,
        bool $a_do_title,
        bool $a_do_label
    ): array {
        $question = $a_results[0][1]->getQuestion();

        $rows = array();
        $row = array();

        if ($a_do_title) {
            $row[] = $question->getTitle();
        }
        if ($a_do_label) {
            $row[] = $question->label;
        }

        $row[] = $question->getQuestiontext();
        $row[] = SurveyQuestion::_getQuestionTypeName($question->getQuestionType());

        $row[] = (int) $a_results[0][1]->getUsersAnswered();
        $row[] = (int) $a_results[0][1]->getUsersSkipped();
        $row[] = null;
        $row[] = null;
        $row[] = null;
        $row[] = null;
        $row[] = null;

        $rows[] = $row;

        foreach ($a_results as $row_result) {
            $row_title = $row_result[0];
            $row_res = $row_result[1];

            $row = array();

            if ($a_do_title) {
                $row[] = null;
            }
            if ($a_do_label) {
                $row[] = null;
            }

            $row[] = $row_title;
            $row[] = null;

            $row[] = null;
            $row[] = null;

            // :TODO:
            $row[] = is_array($row_res->getModeValue())
                ? implode(", ", $row_res->getModeValue())
                : $row_res->getModeValue();

            $row[] = $row_res->getModeValueAsText();
            $row[] = (int) $row_res->getModeNrOfSelections();

            // :TODO:
            $row[] = $row_res->getMedianAsText();

            $row[] = $row_res->getMean();

            $rows[] = $row;
        }
        return $rows;
    }

    public function getUserSpecificVariableTitles(
        array &$a_title_row,
        array &$a_title_row2,
        bool $a_do_title,
        bool $a_do_label
    ): void {
        $lng = $this->lng;

        for ($i = 0; $i < $this->question->getRowCount(); $i++) {
            // create row title according label, add 'other column'
            $row = $this->question->getRow($i);

            if ($a_do_title && $a_do_label) {
                $a_title_row[] = $row->title;
                $a_title_row2[] = $row->label;

                if ($this->question->getSubtype() == 0) {
                    $a_title_row[] = $row->title;        // see #20646
                    $a_title_row2[] = $row->label;        // see #20646
                }

                if ($row->other) {
                    $a_title_row[] = $row->title;
                    $a_title_row2[] = $lng->txt('other');
                }
            } elseif ($a_do_title) {
                $a_title_row[] = $row->title;
                $a_title_row2[] = "";

                if ($this->question->getSubtype() == 0) {
                    $a_title_row[] = $row->title;        // see #20646
                    $a_title_row2[] = "";                // see #20646
                }

                if ($row->other) {
                    $a_title_row[] = $row->title;
                    $a_title_row2[] = $lng->txt('other');
                }
            } else {
                $a_title_row[] = $row->label;
                $a_title_row2[] = "";

                if ($this->question->getSubtype() == 0) {
                    $a_title_row[] = $row->label;        // see #20646
                    $a_title_row2[] = "";                // see #20646
                }

                if ($row->other) {
                    $a_title_row[] = $row->label;
                    $a_title_row2[] = $lng->txt('other');
                }
            }

            // mc
            if ($this->question->getSubtype() === 1) {
                for ($index = 0; $index < $this->question->getColumnCount(); $index++) {
                    $col = $this->question->getColumn($index);

                    $a_title_row[] = $col->title . " [" . $col->scale . "]";
                    $a_title_row2[] = "";
                }
            }
        }
    }

    public function addUserSpecificResults(
        array &$a_row,
        int $a_user_id,
        $a_results
    ): void {
        $answer_map = array();
        foreach ($a_results as $row_results) {
            $row_title = $row_results[0];
            $row_result = $row_results[1];

            $answers = $row_result->getUserResults($a_user_id);
            if ($answers !== null) {
                foreach ($answers as $answer) {
                    // mc
                    if ($this->question->getSubtype() === 1) {
                        $answer_map[$row_title . "|" . $answer[2]] = $answer[2];
                    } else {
                        $answer_map[$row_title] = $answer[3];
                        $answer_map[$row_title . "|scale"] = $answer[2];                // see #20646
                    }
                    if ($answer[1]) {
                        $answer_map[$row_title . "|txt"] = $answer[1];
                    }
                }
            }
        }

        if (!count($answer_map)) {
            $a_row[] = $this->getSkippedValue();
        } else {
            $a_row[] = "";
        }

        for ($i = 0; $i < $this->question->getRowCount(); $i++) {
            $row = $this->question->getRow($i);
            $row_title = $row->title;

            $a_row[] = $answer_map[$row_title] ?? null;
            if ($this->question->getSubtype() === 0) {
                $a_row[] = $answer_map[$row_title . "|scale"] ?? null;    // see #20646
            }

            if ($row->other) {
                $a_row[] = $answer_map[$row_title . "|txt"] ?? null;
            }

            // mc
            if ($this->question->getSubtype() === 1) {
                for ($index = 0; $index < $this->question->getColumnCount(); $index++) {
                    $col = $this->question->getColumn($index);
                    $a_row[] = $answer_map[$row_title . "|" . $col->scale] ?? null;
                }
            }
        }
    }

    protected function supportsSumScore(): bool
    {
        return true;
    }

    protected function isSumScoreValid(int $nr_answer_records): bool
    {
        if ($nr_answer_records === $this->question->getRowCount()) {
            return true;
        }
        return false;
    }
}