class.ilSurveyConstraintsGUI.php

Go to the documentation of this file.

<?php

class ilSurveyConstraintsGUI
{
    protected \ILIAS\Survey\Editing\EditingGUIRequest $request;
    protected \ILIAS\Survey\Editing\EditManager $edit_manager;
    protected ilObjSurvey $object;
    protected ilObjSurveyGUI $parent_gui;
    protected ilCtrl $ctrl;
    protected ilLanguage $lng;
    protected ilGlobalTemplateInterface $tpl;
    protected ilAccessHandler $access;

    public function __construct(
        ilObjSurveyGUI $a_parent_gui
    ) {
        global $DIC;

        $this->access = $DIC->access();
        $ilCtrl = $DIC->ctrl();
        $lng = $DIC->language();
        $tpl = $DIC["tpl"];

        $this->parent_gui = $a_parent_gui;

        $survey = $this->parent_gui->getObject();
        $this->object = $survey;

        $this->ctrl = $ilCtrl;
        $this->lng = $lng;
        $this->tpl = $tpl;
        $this->edit_manager = $DIC->survey()
            ->internal()
            ->domain()
            ->edit();
        $this->request = $DIC->survey()
            ->internal()
            ->gui()
            ->editing()
            ->request();
    }

    public function executeCommand(): void
    {
        $ilCtrl = $this->ctrl;

        $cmd = $ilCtrl->getCmd("constraints");
        $cmd .= "Object";

        $this->$cmd();
    }

    public function constraintsObject(): void
    {
        $step = $this->request->getStep();
        switch ($step) {
            case 1:
                $this->constraintStep1Object();
                return;
            case 3:
            case 2:
                return;
        }

        $hasDatasets = ilObjSurvey::_hasDatasets($this->object->getSurveyId());

        $tbl = new SurveyConstraintsTableGUI($this, "constraints", $this->object, $hasDatasets);

        $mess = "";
        if ($hasDatasets) {
            $mbox = new ilSurveyContainsDataMessageBoxGUI();
            $mess = $mbox->getHTML();
        } else {
            $this->edit_manager->setConstraintStructure($tbl->getStructure());
        }

        $this->tpl->setContent($mess . $tbl->getHTML());
    }

    public function constraintsAddObject(): void
    {
        if ($this->request->getConstraintPar("v") === '') {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("msg_enter_value_for_valid_constraint"));
            $this->constraintStep3Object();
            return;
        }
        $survey_questions = $this->object->getSurveyQuestions();
        $structure = $this->edit_manager->getConstraintStructure();
        $include_elements = $this->edit_manager->getConstraintElements();
        foreach ($include_elements as $elementCounter) {
            if (is_array($structure[$elementCounter])) {
                if ($this->request->getPrecondition() !== '') {
                    $this->object->updateConstraint(
                        $this->request->getPrecondition(),
                        $this->request->getConstraintPar("q"),
                        $this->request->getConstraintPar("r"),
                        $this->request->getConstraintPar("v"),
                        $this->request->getConstraintPar("c")
                    );
                } else {
                    $constraint_id = $this->object->addConstraint(
                        $this->request->getConstraintPar("q"),
                        $this->request->getConstraintPar("r"),
                        $this->request->getConstraintPar("v"),
                        $this->request->getConstraintPar("c")
                    );
                    foreach ($structure[$elementCounter] as $key => $question_id) {
                        $this->object->addConstraintToQuestion($question_id, $constraint_id);
                    }
                }
                if (count($structure[$elementCounter]) > 1) {
                    $this->object->updateConjunctionForQuestions(
                        $structure[$elementCounter],
                        $this->request->getConstraintPar("c")
                    );
                }
            }
        }
        $this->edit_manager->clearConstraintElements();
        $this->edit_manager->clearConstraintStructure();
        $this->ctrl->redirect($this, "constraints");
    }

    public function constraintStep1Object($start = null): void
    {
        $survey_questions = $this->object->getSurveyQuestions();
        $structure = $this->edit_manager->getConstraintStructure();
        if (is_null($start)) {
            $start = $this->request->getStart();
        }
        $option_questions = array();
        for ($i = 1; $i < $start; $i++) {
            if (is_array($structure[$i])) {
                foreach ($structure[$i] as $key => $question_id) {
                    if ($survey_questions[$question_id]["usableForPrecondition"]) {
                        $option_questions[] = array("question_id" => $survey_questions[$question_id]["question_id"],
                                                    "title" => $survey_questions[$question_id]["title"],
                                                    "type_tag" => $survey_questions[$question_id]["type_tag"]
                        );
                    }
                }
            }
        }
        if (count($option_questions) === 0) {
            $this->edit_manager->clearConstraintElements();
            $this->edit_manager->clearConstraintStructure();
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("constraints_no_nonessay_available"), true);
            $this->ctrl->redirect($this, "constraints");
        }
        $this->constraintForm(1, $this->getConstraintParsFromPost(), $survey_questions, $option_questions);
    }

    public function constraintStep2Object(): void
    {
        $survey_questions = $this->object->getSurveyQuestions();
        $option_questions = array();
        $q = $this->request->getConstraintPar("q");
        $option_questions[] = array(
            "question_id" => $q,
            "title" => $survey_questions[$q]["title"],
            "type_tag" => $survey_questions[$q]["type_tag"]
        );
        $this->constraintForm(2, $this->getConstraintParsFromPost(), $survey_questions, $option_questions);
    }

    public function constraintStep3Object(): void
    {
        $survey_questions = $this->object->getSurveyQuestions();
        $option_questions = array();
        if ($this->request->getPrecondition() !== '') {
            if (!$this->validateConstraintForEdit($this->request->getPrecondition())) {
                $this->ctrl->redirect($this, "constraints");
            }

            $pc = $this->object->getPrecondition($this->request->getPrecondition());
            $postvalues = array(
                "c" => $pc["conjunction"],
                "q" => $pc["question_fi"],
                "r" => $pc["relation_id"],
                "v" => $pc["value"]
            );
            $option_questions[] = array("question_id" => $pc["question_fi"],
                                        "title" => $survey_questions[$pc["question_fi"]]["title"],
                                        "type_tag" => $survey_questions[$pc["question_fi"]]["type_tag"]
            );
            $this->constraintForm(3, $postvalues, $survey_questions, $option_questions);
        } else {
            $q = $this->request->getConstraintPar("q");
            $option_questions[] = array(
                "question_id" => $q,
                "title" => $survey_questions[$q]["title"],
                "type_tag" => $survey_questions[$q]["type_tag"]
            );
            $this->constraintForm(3, $this->getConstraintParsFromPost(), $survey_questions, $option_questions);
        }
    }

    protected function getConstraintParsFromPost(): array
    {
        return [
            "c" => $this->request->getConstraintPar("c"),
            "q" => $this->request->getConstraintPar("q"),
            "r" => $this->request->getConstraintPar("r"),
            "v" => $this->request->getConstraintPar("v")
        ];
    }

    // output constraint editing form
    public function constraintForm(
        int $step,
        array $postvalues,
        array $survey_questions,
        ?array $questions = null
    ): void {
        if ((string) $this->request->getStart() !== '') {
            $this->ctrl->setParameter($this, "start", $this->request->getStart());
        }
        $this->ctrl->saveParameter($this, "precondition");
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTableWidth("100%");
        $form->setId("constraintsForm");

        $constraint_structure = $this->edit_manager->getConstraintStructure();

        // #9366
        $title = array();
        $title_ids = $this->edit_manager->getConstraintElements();
        if (!$title_ids) {
            $title_ids = array($this->request->getStart());
        }
        foreach ($title_ids as $title_id) {
            // question block
            if ($survey_questions[$constraint_structure[$title_id][0]]["questionblock_id"] > 0) {
                $title[] = $this->lng->txt("questionblock") . ": " . $survey_questions[$constraint_structure[$title_id][0]]["questionblock_title"];
            }
            // question
            else {
                $title[] = $this->lng->txt($survey_questions[$constraint_structure[$title_id][0]]["type_tag"]) . ": " .
                    $survey_questions[$constraint_structure[$title_id][0]]["title"];
            }
        }
        $header = new ilFormSectionHeaderGUI();
        $header->setTitle(implode("<br/>", $title));
        $form->addItem($header);

        $fulfilled = new ilRadioGroupInputGUI($this->lng->txt("constraint_fulfilled"), "c");
        $fulfilled->addOption(new ilRadioOption($this->lng->txt("conjunction_and"), '0', ''));
        $fulfilled->addOption(new ilRadioOption($this->lng->txt("conjunction_or"), '1', ''));
        $fulfilled->setValue((strlen($postvalues['c'])) ? $postvalues['c'] : 0);
        $form->addItem($fulfilled);

        $step1 = new ilSelectInputGUI($this->lng->txt("step") . " 1: " . $this->lng->txt("select_prior_question"), "q");
        $options = array();
        if (is_array($questions)) {
            foreach ($questions as $question) {
                $options[$question["question_id"]] = $question["title"] . " (" . SurveyQuestion::_getQuestionTypeName($question["type_tag"]) . ")";
            }
        }
        $step1->setOptions($options);
        $step1->setValue($postvalues["q"]);
        $form->addItem($step1);

        if ($step > 1) {
            $relations = $this->object->getAllRelations();
            $step2 = new ilSelectInputGUI($this->lng->txt("step") . " 2: " . $this->lng->txt("select_relation"), "r");
            $options = array();
            foreach ($relations as $rel_id => $relation) {
                if (in_array($relation["short"], $survey_questions[$postvalues["q"]]["availableRelations"])) {
                    $options[$rel_id] = $relation['short'];
                }
            }
            $step2->setOptions($options);
            $step2->setValue($postvalues["r"]);
            $form->addItem($step2);
        }

        if ($step > 2) {
            $variables = $this->object->getVariables($postvalues["q"]);
            $question_type = $survey_questions[$postvalues["q"]]["type_tag"];
            SurveyQuestion::_includeClass($question_type);
            $question = new $question_type();
            $question->loadFromDb($postvalues["q"]);

            $step3 = $question->getPreconditionSelectValue($postvalues["v"], $this->lng->txt("step") . " 3: " . $this->lng->txt("select_value"), "v");
            $form->addItem($step3);
        }

        $cmd_back = "";
        $cmd_continue = "";

        switch ($step) {
            case 1:
                $cmd_continue = "constraintStep2";
                $cmd_back = "constraints";
                break;
            case 2:
                $cmd_continue = "constraintStep3";
                $cmd_back = "constraintStep1";
                break;
            case 3:
                $cmd_continue = "constraintsAdd";
                $cmd_back = "constraintStep2";
                break;
        }
        $form->addCommandButton($cmd_back, $this->lng->txt("back"));
        $form->addCommandButton($cmd_continue, $this->lng->txt("continue"));

        $this->tpl->setVariable("ADM_CONTENT", $form->getHTML());
    }

    protected function validateConstraintForEdit(
        int $a_id
    ): bool {
        $ilAccess = $this->access;

        if (ilObjSurvey::_hasDatasets($this->object->getSurveyId())) {
            return false;
        }
        if (!$ilAccess->checkAccess("write", "", $this->object->getRefId())) {
            return false;
        }

        return true;
    }

    public function confirmDeleteConstraintsObject(): void
    {
        $id = (int) $this->request->getPrecondition();
        if (!$this->validateConstraintForEdit($id)) {
            $this->ctrl->redirect($this, "constraints");
        }

        $constraint = $this->object->getPrecondition($id);
        $questions = $this->object->getSurveyQuestions();
        $question = $questions[$constraint["question_fi"]];
        $relation = $questions[$constraint["ref_question_fi"]];
        $relation = $relation["title"];

        // see ilSurveyConstraintsTableGUI
        $question_type = SurveyQuestion::_getQuestionType($constraint["question_fi"]);
        SurveyQuestion::_includeClass($question_type);
        $question_obj = new $question_type();
        $question_obj->loadFromDb($constraint["question_fi"]);
        $valueoutput = $question_obj->getPreconditionValueOutput($constraint["value"]);

        $title = $question["title"] . " " . $constraint["shortname"] . " " . $valueoutput;

        $this->ctrl->saveParameter($this, "precondition");

        $cgui = new ilConfirmationGUI();
        $cgui->setHeaderText(sprintf($this->lng->txt("survey_sure_delete_constraint"), $title, $relation));

        $cgui->setFormAction($this->ctrl->getFormAction($this, "deleteConstraints"));
        $cgui->setCancel($this->lng->txt("cancel"), "constraints");
        $cgui->setConfirm($this->lng->txt("confirm"), "deleteConstraints");

        $this->tpl->setContent($cgui->getHTML());
    }

    public function deleteConstraintsObject(): void
    {
        $id = (int) $this->request->getPrecondition();
        if ($this->validateConstraintForEdit($id)) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("survey_constraint_deleted"), true);
            $this->object->deleteConstraint($id);
        }

        $this->ctrl->redirect($this, "constraints");
    }

    public function createConstraintsObject(): void
    {
        $include_elements = $this->request->getIncludeElements();
        if (count($include_elements) === 0) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("constraints_no_questions_or_questionblocks_selected"), true);
            $this->ctrl->redirect($this, "constraints");
        } elseif (count($include_elements) >= 1) {
            $this->edit_manager->setConstraintElements($include_elements);
            sort($include_elements, SORT_NUMERIC);
            $this->constraintStep1Object($include_elements[0]);
        }
    }

    public function editPreconditionObject(): void
    {
        if (!$this->validateConstraintForEdit($this->request->getPrecondition())) {
            $this->ctrl->redirect($this, "constraints");
        }

        $this->edit_manager->setConstraintElements([$this->request->getStart()]);
        $this->ctrl->setParameter($this, "precondition", $this->request->getPrecondition());
        $this->ctrl->setParameter($this, "start", $this->request->getStart());
        $this->ctrl->redirect($this, "constraintStep3");
    }
}