ilSurveyConstraintsGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilSurveyConstraintsGUI:

Public Member Functions
	executeCommand ()
	constraintsObject ()
	Administration page for survey constraints. More...
	constraintsAddObject ()
	Add a precondition for a survey question or question block. More...
	constraintStep1Object ($start=null)
	Handles the first step of the precondition add action. More...
	constraintStep2Object ()
	Handles the second step of the precondition add action. More...
	constraintStep3Object ()
	Handles the third step of the precondition add action. More...
	constraintForm (int $step, array $postvalues, array $survey_questions, ?array $questions=null)
	confirmDeleteConstraintsObject ()
	Delete constraint confirmation. More...
	deleteConstraintsObject ()
	createConstraintsObject ()
	editPreconditionObject ()

Protected Member Functions
	getConstraintParsFromPost ()
	validateConstraintForEdit (int $a_id)
	Validate if given constraint id is part of current survey and there are sufficient permissions to edit. More...

Protected Attributes
ILIAS Survey Editing EditingGUIRequest	$request
ILIAS Survey Editing EditManager	$edit_manager
ilObjSurvey	$object
ilObjSurveyGUI	$parent_gui
ilCtrl	$ctrl
ilLanguage	$lng
ilGlobalTemplateInterface	$tpl
ilAccessHandler	$access

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author

Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m ilSurveyConstraintsGUI:

Definition at line 23 of file class.ilSurveyConstraintsGUI.php.

Member Function Documentation

confirmDeleteConstraintsObject()

ilSurveyConstraintsGUI::confirmDeleteConstraintsObject

(

)

Delete constraint confirmation.

Definition at line 371 of file class.ilSurveyConstraintsGUI.php.

References $id, $relation, SurveyQuestion\_getQuestionType(), SurveyQuestion\_includeClass(), ILIAS\Repository\ctrl(), ILIAS\Repository\int(), ILIAS\Repository\lng(), and validateConstraintForEdit().

                                                    : 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());
    }

Here is the call graph for this function:

constraintForm()

ilSurveyConstraintsGUI::constraintForm	(	int	$step,
		array	$postvalues,
		array	$survey_questions,
		?array	$questions = null
	)

Definition at line 245 of file class.ilSurveyConstraintsGUI.php.

References $relation, SurveyQuestion\_getQuestionTypeName(), SurveyQuestion\_includeClass(), ilRadioGroupInputGUI\addOption(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by constraintStep1Object(), constraintStep2Object(), and constraintStep3Object().

     : 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());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

constraintsAddObject()

ilSurveyConstraintsGUI::constraintsAddObject

(

)

Add a precondition for a survey question or question block.

Definition at line 107 of file class.ilSurveyConstraintsGUI.php.

References $structure, constraintStep3Object(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

                                          : 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");
    }

Here is the call graph for this function:

constraintsObject()

ilSurveyConstraintsGUI::constraintsObject

(

)

Administration page for survey constraints.

Definition at line 77 of file class.ilSurveyConstraintsGUI.php.

References ilObjSurvey\_hasDatasets(), constraintStep1Object(), and ILIAS\Repository\object().

                                       : 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());
    }

Here is the call graph for this function:

constraintStep1Object()

ilSurveyConstraintsGUI::constraintStep1Object

(

$start = null

)

Handles the first step of the precondition add action.

Definition at line 154 of file class.ilSurveyConstraintsGUI.php.

References $structure, constraintForm(), ILIAS\Repository\ctrl(), getConstraintParsFromPost(), and ILIAS\Repository\lng().

Referenced by constraintsObject(), and createConstraintsObject().

                                                        : 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);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

constraintStep2Object()

ilSurveyConstraintsGUI::constraintStep2Object

(

)

Handles the second step of the precondition add action.

Definition at line 186 of file class.ilSurveyConstraintsGUI.php.

References $q, constraintForm(), and getConstraintParsFromPost().

                                           : 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);
    }

Here is the call graph for this function:

constraintStep3Object()

ilSurveyConstraintsGUI::constraintStep3Object

(

)

Handles the third step of the precondition add action.

Definition at line 202 of file class.ilSurveyConstraintsGUI.php.

References $q, constraintForm(), ILIAS\Repository\ctrl(), getConstraintParsFromPost(), and validateConstraintForEdit().

Referenced by constraintsAddObject().

                                           : 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);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createConstraintsObject()

ilSurveyConstraintsGUI::createConstraintsObject

(

)

Definition at line 416 of file class.ilSurveyConstraintsGUI.php.

References constraintStep1Object(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\UI\examples\Symbol\Glyph\Sort\sort().

                                             : 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]);
        }
    }

Here is the call graph for this function:

deleteConstraintsObject()

ilSurveyConstraintsGUI::deleteConstraintsObject

(

)

Definition at line 405 of file class.ilSurveyConstraintsGUI.php.

References $id, ILIAS\Repository\ctrl(), ILIAS\Repository\int(), ILIAS\Repository\lng(), and validateConstraintForEdit().

                                             : 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");
    }

Here is the call graph for this function:

editPreconditionObject()

ilSurveyConstraintsGUI::editPreconditionObject

(

)

Exceptions

ilCtrlException

Definition at line 432 of file class.ilSurveyConstraintsGUI.php.

References ILIAS\Repository\ctrl(), and validateConstraintForEdit().

                                            : 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");
    }

Here is the call graph for this function:

executeCommand()

ilSurveyConstraintsGUI::executeCommand

(

)

Definition at line 64 of file class.ilSurveyConstraintsGUI.php.

References $ctrl, and ilCtrl\getCmd().

                                    : void
    {
        $ilCtrl = $this->ctrl;

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

        $this->$cmd();
    }

Here is the call graph for this function:

getConstraintParsFromPost()

ilSurveyConstraintsGUI::getConstraintParsFromPost ( )

protected

Definition at line 234 of file class.ilSurveyConstraintsGUI.php.

Referenced by constraintStep1Object(), constraintStep2Object(), and constraintStep3Object().

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

Here is the caller graph for this function:

validateConstraintForEdit()

ilSurveyConstraintsGUI::validateConstraintForEdit ( int  $a_id )

protected

Validate if given constraint id is part of current survey and there are sufficient permissions to edit.

Todo:

actually the ID is not checked against the survey

Definition at line 353 of file class.ilSurveyConstraintsGUI.php.

References $access, ilObjSurvey\_hasDatasets(), and ILIAS\Repository\object().

Referenced by confirmDeleteConstraintsObject(), constraintStep3Object(), deleteConstraintsObject(), and editPreconditionObject().

     : bool {
        $ilAccess = $this->access;

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

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access

ilAccessHandler ilSurveyConstraintsGUI::$access

protected

Definition at line 32 of file class.ilSurveyConstraintsGUI.php.

Referenced by validateConstraintForEdit().

$ctrl

ilCtrl ilSurveyConstraintsGUI::$ctrl

protected

Definition at line 29 of file class.ilSurveyConstraintsGUI.php.

Referenced by executeCommand().

$edit_manager

ILIAS Survey Editing EditManager ilSurveyConstraintsGUI::$edit_manager

protected

Definition at line 26 of file class.ilSurveyConstraintsGUI.php.

$lng

ilLanguage ilSurveyConstraintsGUI::$lng

protected

Definition at line 30 of file class.ilSurveyConstraintsGUI.php.

$object

ilObjSurvey ilSurveyConstraintsGUI::$object

protected

Definition at line 27 of file class.ilSurveyConstraintsGUI.php.

$parent_gui

ilObjSurveyGUI ilSurveyConstraintsGUI::$parent_gui

protected

Definition at line 28 of file class.ilSurveyConstraintsGUI.php.

$request

ILIAS Survey Editing EditingGUIRequest ilSurveyConstraintsGUI::$request

protected

Definition at line 25 of file class.ilSurveyConstraintsGUI.php.

$tpl

ilGlobalTemplateInterface ilSurveyConstraintsGUI::$tpl

protected

Definition at line 31 of file class.ilSurveyConstraintsGUI.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/Survey/Constraints/class.ilSurveyConstraintsGUI.php