class.UIModifier.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Survey\Mode\IndividualFeedback;

use ILIAS\Survey\Mode;
use ILIAS\Survey\InternalGUIService;

class UIModifier extends Mode\AbstractUIModifier
{
    public function getSurveySettingsGeneral(
        \ilObjSurvey $survey
    ): array {
        $items = [];

        return $items;
    }

    public function getSurveySettingsResults(
        \ilObjSurvey $survey,
        InternalGUIService $ui_service
    ): array {
        $items = [];
        $lng = $ui_service->lng();

        $ts_results = new \ilRadioGroupInputGUI($lng->txt("survey_360_results"), "ts_res");
        $ts_results->setValue((string) $survey->get360Results());

        $option = new \ilRadioOption($lng->txt("survey_360_results_none"), (string) \ilObjSurvey::RESULTS_360_NONE);
        $option->setInfo($lng->txt("survey_360_results_none_info"));
        $ts_results->addOption($option);

        $option = new \ilRadioOption(
            $lng->txt("survey_360_results_own"),
            (string) \ilObjSurvey::RESULTS_360_OWN
        );
        $option->setInfo($lng->txt("survey_360_results_own_info"));
        $ts_results->addOption($option);

        $items[] = $ts_results;

        return $items;
    }

    public function getSurveySettingsReminderTargets(
        \ilObjSurvey $survey,
        InternalGUIService $ui_service
    ): array {
        $items = [];
        $lng = $ui_service->lng();

        // remind appraisees
        $cb = new \ilCheckboxInputGUI($lng->txt("survey_notification_target_group"), "remind_appraisees");
        $cb->setOptionTitle($lng->txt("survey_360_appraisees"));
        $cb->setInfo($lng->txt("survey_360_appraisees_remind_info"));
        $cb->setValue("1");
        $cb->setChecked(in_array(
            $survey->getReminderTarget(),
            array(\ilObjSurvey::NOTIFICATION_APPRAISEES, \ilObjSurvey::NOTIFICATION_APPRAISEES_AND_RATERS),
            true
        ));
        $items[] = $cb;

        // remind raters
        $cb = new \ilCheckboxInputGUI("", "remind_raters");
        $cb->setOptionTitle($lng->txt("survey_360_raters"));
        $cb->setInfo($lng->txt("survey_360_raters_remind_info"));
        $cb->setValue("1");
        $cb->setChecked(in_array(
            $survey->getReminderTarget(),
            array(\ilObjSurvey::NOTIFICATION_RATERS, \ilObjSurvey::NOTIFICATION_APPRAISEES_AND_RATERS),
            true
        ));
        $items[] = $cb;

        return $items;
    }

    public function setValuesFromForm(
        \ilObjSurvey $survey,
        \ilPropertyFormGUI $form
    ): void {
        if ($form->getInput("remind_appraisees") && $form->getInput("remind_raters")) {
            $survey->setReminderTarget(\ilObjSurvey::NOTIFICATION_APPRAISEES_AND_RATERS);
        } elseif ($form->getInput("remind_appraisees")) {
            $survey->setReminderTarget(\ilObjSurvey::NOTIFICATION_APPRAISEES);
        } elseif ($form->getInput("remind_raters")) {
            $survey->setReminderTarget(\ilObjSurvey::NOTIFICATION_RATERS);
        } else {
            $survey->setReminderTarget(0);
        }

        $survey->set360Results((int) $form->getInput("ts_res"));
    }


    public function setResultsDetailToolbar(
        \ilObjSurvey $survey,
        \ilToolbarGUI $toolbar,
        int $user_id
    ): void {
        $this->addApprSelectionToToolbar(
            $survey,
            $toolbar,
            $user_id
        );

        $this->addExportAndPrintButton(
            $survey,
            $toolbar,
            true
        );
    }

    public function setResultsCompetenceToolbar(
        \ilObjSurvey $survey,
        \ilToolbarGUI $toolbar,
        int $user_id
    ): void {
        $this->addApprSelectionToToolbar(
            $survey,
            $toolbar,
            $user_id
        );

        $this->addRaterSelectionToToolbar(
            $survey,
            $toolbar,
            $user_id
        );
    }

    public function addRaterSelectionToToolbar(
        \ilObjSurvey $survey,
        \ilToolbarGUI $toolbar,
        int $user_id
    ): void {
        $lng = $this->service->gui()->lng();
        $ctrl = $this->service->gui()->ctrl();
        $req = $this->service->gui()->evaluation($survey)->request();

        $evaluation_manager = $this->service->domain()->evaluation(
            $survey,
            $user_id,
            $req->getAppraiseeId(),
            $req->getRaterId()
        );


        if (!$evaluation_manager->isMultiParticipantsView()) {
            $raters = $evaluation_manager->getSelectableRaters();

            if (count($raters) > 0) {
                $options = [];
                $options["-"] = $lng->txt("svy_all_raters");
                foreach ($raters as $rater) {
                    $options[$rater["user_id"]] = $rater["name"];
                }

                $rat = new \ilSelectInputGUI($lng->txt("svy_rater"), "rater_id");
                $rat->setOptions($options);
                $rat->setValue($evaluation_manager->getCurrentRater());
                $toolbar->addInputItem($rat, true);

                $this->gui->button(
                    $this->gui->lng()->txt("svy_select_rater"),
                    $ctrl->getCmd()
                )->submit()->toToolbar(false, $toolbar);


                $toolbar->addSeparator();
            }
        }
    }


    protected function getPanelChart(
        \ILIAS\Survey\Evaluation\EvaluationGUIRequest $request,
        \SurveyQuestionEvaluation $a_eval
    ): string {
        return "";
    }

    protected function getPanelText(
        \ILIAS\Survey\Evaluation\EvaluationGUIRequest $request,
        \SurveyQuestionEvaluation $a_eval,
        \ilSurveyEvaluationResults $question_res
    ): string {
        return "";
    }

    protected function getPanelTable(
        array $participants,
        \ILIAS\Survey\Evaluation\EvaluationGUIRequest $request,
        \SurveyQuestionEvaluation $a_eval
    ): string {
        $a_results = $a_eval->getResults();
        $lng = $this->service->gui()->lng();
        $matrix = false;
        if (is_array($a_results)) {
            $answers = $a_results[0][1]->getAnswers();
            $q = $a_results[0][1]->getQuestion();
            $matrix = true;
        } else {
            $answers = $a_results->getAnswers();
            $q = $a_results->getQuestion();
        }
        // SurveySingleChoiceQuestion
        if (!in_array($q->getQuestionType(), [
            "SurveySingleChoiceQuestion",
            "SurveyMultipleChoiceQuestion",
            "SurveyMetricQuestion",
            "SurveyTextQuestion"
        ], true)) {
            //var_dump($q->getQuestionType());
            //var_dump($answers);
            //exit;
        }


        \ilDatePresentation::setUseRelativeDates(false);

        $a_tpl = new \ilTemplate("tpl.svy_results_details_table.html", true, true, "Modules/Survey/Evaluation");

        // table
        $ret = "";
        if ($request->getShowTable()) {
            if (!$matrix) {
                // rater
                $a_tpl->setCurrentBlock("grid_col_header_bl");
                $a_tpl->setVariable("COL_HEADER", $lng->txt("svy_rater"));
                $a_tpl->parseCurrentBlock();

                // date
                $a_tpl->setCurrentBlock("grid_col_header_bl");
                $a_tpl->setVariable("COL_HEADER", $lng->txt("date"));
                $a_tpl->parseCurrentBlock();

                // answer
                $a_tpl->setCurrentBlock("grid_col_header_bl");
                $a_tpl->setVariable("COL_HEADER", $lng->txt("answers"));
                $a_tpl->parseCurrentBlock();

                $condensed_answers = [];
                foreach ($answers as $answer) {
                    $condensed_answers[$answer->active_id]["tstamp"] = $answer->tstamp;
                    $condensed_answers[$answer->active_id]["active_id"] = $answer->active_id;
                    // this moves the original multiple answers items of muliple choice question into one array
                    $condensed_answers[$answer->active_id]["value"][] = $answer->value;
                    $condensed_answers[$answer->active_id]["text"] = $answer->text;
                }

                foreach ($condensed_answers as $answer) {
                    // rater
                    $a_tpl->setCurrentBlock("grid_col_bl");
                    $a_tpl->setVariable("COL_CAPTION", " ");
                    $a_tpl->parseCurrentBlock();

                    // rater
                    $participant = $this->getParticipantByActiveId($participants, $answer["active_id"]);
                    $part_caption = "";
                    if ($participant) {
                        $part_caption = $this->getCaptionForParticipant($participant);
                    }
                    $a_tpl->setCurrentBlock("grid_col_bl");
                    $a_tpl->setVariable("COL_CAPTION", $part_caption);
                    $a_tpl->parseCurrentBlock();

                    // date
                    $a_tpl->setCurrentBlock("grid_col_bl");
                    $date = new \ilDate($answer["tstamp"], IL_CAL_UNIX);
                    $a_tpl->setVariable(
                        "COL_CAPTION",
                        \ilDatePresentation::formatDate($date)
                    );
                    $a_tpl->parseCurrentBlock();

                    // answer
                    $a_tpl->setCurrentBlock("grid_col_bl");
                    if ($q->getQuestionType() === "SurveyTextQuestion") {
                        $a_tpl->setVariable(
                            "COL_CAPTION",
                            $a_results->getScaleText($answer["text"])
                        );
                    } else {
                        $scale_texts = array_map(static function ($v) use ($a_results): string {
                            return $a_results->getScaleText($v);
                        }, $answer["value"]);
                        $a_tpl->setVariable(
                            "COL_CAPTION",
                            implode(", ", $scale_texts)
                        );
                    }
                    $a_tpl->parseCurrentBlock();

                    $a_tpl->touchBlock("grid_row_bl");
                }
                $ret = $a_tpl->get();
            } else {
                foreach ($answers as $answer) {
                    $cats = $q->getColumns();
                    foreach ($cats->getCategories() as $cat) {
                        $a_tpl->touchBlock("grid_col_head_center");
                        $a_tpl->setCurrentBlock("grid_col_header_bl");
                        $a_tpl->setVariable("COL_HEADER", $cat->title);
                        $a_tpl->parseCurrentBlock();
                    }

                    $cats_rows = $q->getRows();

                    reset($a_results);
                    foreach ($cats_rows->getCategories() as $cat) {
                        $a_tpl->setCurrentBlock("grid_col_bl");
                        $a_tpl->setVariable("COL_CAPTION", $cat->title);
                        $a_tpl->parseCurrentBlock();

                        $r = current($a_results);
                        $row_answers = $r[1]->getAnswers();
                        $user_answers = null;
                        foreach ($row_answers as $ra) {
                            if ($ra->active_id == $answer->active_id) {
                                $user_answers = $ra;
                            }
                        }

                        foreach ($cats->getCategories() as $catr) {
                            if ($user_answers && $user_answers->value == $catr->scale) {
                                $a_tpl->touchBlock("grid_col_center");
                                $a_tpl->setCurrentBlock("grid_col_bl");
                                $a_tpl->setVariable("COL_CAPTION", "X");
                            } else {
                                $a_tpl->setCurrentBlock("grid_col_bl");
                                $a_tpl->setVariable("COL_CAPTION", " ");
                            }

                            $a_tpl->parseCurrentBlock();
                        }

                        $a_tpl->touchBlock("grid_row_bl");
                        next($a_results);
                    }

                    // rater
                    $participant = $this->getParticipantByActiveId($participants, $answer->active_id);
                    $part_caption = "";
                    if ($participant) {
                        $part_caption = $participant["sortname"];
                    }
                    $date = new \ilDate($answer->tstamp, IL_CAL_UNIX);
                    $part_caption .= ", " . \ilDatePresentation::formatDate($date);

                    $a_tpl->setVariable("HEADER", $part_caption);
                    $ret .= $a_tpl->get();
                    $a_tpl = new \ilTemplate("tpl.svy_results_details_table.html", true, true, "Modules/Survey/Evaluation");
                }
            }
        }
        return $ret;
    }

    protected function getParticipantByActiveId(array $participants, int $active_id): ?array
    {
        foreach ($participants as $part) {
            if ((int) $part["active_id"] === $active_id) {
                return $part;
            }
        }
        return null;
    }

    protected function getCaptionForParticipant(array $part_array): string
    {
        return $part_array["sortname"];
    }
}