SurveyMultipleChoiceQuestionGUI Class Reference

MultipleChoice survey question GUI representation. More...

Inheritance diagram for SurveyMultipleChoiceQuestionGUI:

Collaboration diagram for SurveyMultipleChoiceQuestionGUI:

Public Member Functions
	setQuestionTabs ()
	getParsedAnswers (array $a_working_data=null, $a_only_user_anwers=false)
	getPrintView ($question_title=1, $show_questiontext=1, $survey_id=null, array $a_working_data=null)
	Creates a HTML representation of the question. More...
	getWorkingForm ($working_data="", $question_title=1, $show_questiontext=1, $error_message="", $survey_id=null)
	Creates the question output form for the learner. More...
Public Member Functions inherited from SurveyQuestionGUI
	__construct ($a_id=-1)
	setQuestionTabs ()
&	executeCommand ()
	getQuestionType ()
	Returns the question type string. More...
	setBackUrl ($a_url)
	setQuestionTabsForClass ($guiclass)
	getPrintView ($question_title=1, $show_questiontext=1)
	preview ()
	Creates a preview of the question. More...
	getWorkingForm ($working_data="", $question_title=1, $show_questiontext=1, $error_message="", $survey_id=null)
	material ($checkonly=false)
	Material tab of the survey questions. More...
	deleteMaterial ()
	addMaterial ()
	Add materials to a question. More...
	removeMaterial ()
	cancelExplorer ()
	addPG ()
	addST ()
	addGIT ()
	linkChilds ()
	savePhrase ($a_reload=false)
	Creates an output to save the current answers as a phrase. More...
	confirmSavePhrase ()
	Save a new phrase to the database. More...

Protected Member Functions
	initObject ()
	addFieldsToEditForm (ilPropertyFormGUI $a_form)
	validateEditForm (ilPropertyFormGUI $a_form)
	importEditFormValues (ilPropertyFormGUI $a_form)
Protected Member Functions inherited from SurveyQuestionGUI
	initObject ()
	outQuestionText ($template)
	initEditForm ()
	addCommandButtons ($a_form)
	editQuestion (ilPropertyFormGUI $a_form=null)
	saveSync ()
	saveReturn ()
	saveForm ()
	save ($a_return=false, $a_sync=false)
	copySyncForm ()
	syncCopies ()
	originalSyncForm ()
	sync ()
	cancelSync ()
	redirectAfterSaving ($a_return=false)
	Redirect to calling survey or to edit form. More...
	cancel ()
	validateEditForm (ilPropertyFormGUI $a_form)
	addFieldsToEditForm (ilPropertyFormGUI $a_form)
	importEditFormValues (ilPropertyFormGUI $a_form)
	getPrintViewQuestionTitle ($question_title=1)
	getMaterialOutput ()
	Creates the HTML output of the question material(s) More...
	initPhrasesForm ()
	addPhrase (ilPropertyFormGUI $a_form=null)
	Creates an output for the addition of phrases. More...
	addSelectedPhrase ()
	renderStatisticsDetailsTable (array $a_head, array $a_rows, array $a_foot=null)

Additional Inherited Members
Static Public Member Functions inherited from SurveyQuestionGUI
static	_getQuestionGUI ($questiontype, $question_id=-1)
	Creates a question gui representation. More...
static	_getGUIClassNameForId ($a_q_id)
static	_getClassNameForQType ($q_type)
Data Fields inherited from SurveyQuestionGUI
	$object
Protected Attributes inherited from SurveyQuestionGUI
	$rbacsystem
	$user
	$access
	$tree
	$toolbar
	$tabs
	$tpl
	$lng
	$ctrl
	$cumulated
	$parent_url
	$log

Detailed Description

MultipleChoice survey question GUI representation.

The SurveyMultipleChoiceQuestionGUI class encapsulates the GUI representation for multiple choice survey question types.

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

Version

$Id$

Definition at line 37 of file class.SurveyMultipleChoiceQuestionGUI.php.

Member Function Documentation

addFieldsToEditForm()

SurveyMultipleChoiceQuestionGUI::addFieldsToEditForm ( ilPropertyFormGUI  $a_form )

protected

Definition at line 54 of file class.SurveyMultipleChoiceQuestionGUI.php.

References ilPropertyFormGUI\addItem(), object, ilFormPropertyGUI\setRequired(), ilNumberInputGUI\setSize(), and ilCheckboxInputGUI\setValue().

    {
        // orientation
        $orientation = new ilRadioGroupInputGUI($this->lng->txt("orientation"), "orientation");
        $orientation->setRequired(false);
        $orientation->addOption(new ilRadioOption($this->lng->txt('vertical'), 0));
        $orientation->addOption(new ilRadioOption($this->lng->txt('horizontal'), 1));
        $a_form->addItem($orientation);

        // minimum answers
        $minanswers = new ilCheckboxInputGUI($this->lng->txt("use_min_answers"), "use_min_answers");
        $minanswers->setValue(1);
        $minanswers->setOptionTitle($this->lng->txt("use_min_answers_option"));
        $minanswers->setRequired(false);
        
        $nranswers = new ilNumberInputGUI($this->lng->txt("nr_min_answers"), "nr_min_answers");
        $nranswers->setSize(5);
        $nranswers->setDecimals(0);
        $nranswers->setRequired(false);
        $nranswers->setMinValue(1);
        $minanswers->addSubItem($nranswers);
        
        $nrmaxanswers = new ilNumberInputGUI($this->lng->txt("nr_max_answers"), "nr_max_answers");
        $nrmaxanswers->setSize(5);
        $nrmaxanswers->setDecimals(0);
        $nrmaxanswers->setRequired(false);
        $nrmaxanswers->setMinValue(1);
        $minanswers->addSubItem($nrmaxanswers);
        
        $a_form->addItem($minanswers);

        // Answers
        include_once "./Modules/SurveyQuestionPool/classes/class.ilCategoryWizardInputGUI.php";
        $answers = new ilCategoryWizardInputGUI($this->lng->txt("answers"), "answers");
        $answers->setRequired(false);
        $answers->setAllowMove(true);
        $answers->setShowWizard(false);
        $answers->setShowSavePhrase(false);
        $answers->setUseOtherAnswer(true);
        $answers->setShowNeutralCategory(true);
        $answers->setNeutralCategoryTitle($this->lng->txt('svy_neutral_answer'));
        $answers->setDisabledScale(false);
        $a_form->addItem($answers);
        
        
        // values
        $orientation->setValue($this->object->getOrientation());
        $minanswers->setChecked($this->object->use_min_answers);
        $nranswers->setValue($this->object->nr_min_answers);
        $nrmaxanswers->setValue($this->object->nr_max_answers);
        if (!$this->object->getCategories()->getCategoryCount()) {
            $this->object->getCategories()->addCategory("");
        }
        $answers->setValues($this->object->getCategories());
    }

Here is the call graph for this function:

getParsedAnswers()

SurveyMultipleChoiceQuestionGUI::getParsedAnswers	(	array	$a_working_data = null,
			$a_only_user_anwers = false
	)

Definition at line 168 of file class.SurveyMultipleChoiceQuestionGUI.php.

References $i, $options, $text, and array.

Referenced by getPrintView().

    {
        if (is_array($a_working_data)) {
            $user_answers = $a_working_data;
        }
    
        $options = array();
        for ($i = 0; $i < $this->object->categories->getCategoryCount(); $i++) {
            $cat = $this->object->categories->getCategory($i);
            $value = ($cat->scale) ? ($cat->scale - 1) : $i;
        
            $checked = "unchecked";
            $text = null;
            if (is_array($a_working_data)) {
                foreach ($user_answers as $user_answer) {
                    if ($value == $user_answer["value"]) {
                        $checked = "checked";
                        if ($user_answer["textanswer"]) {
                            $text = $user_answer["textanswer"];
                        }
                        break;
                    }
                }
            }
            
            // "other" options have to be last or horizontal will be screwed
            $idx = $cat->other . "_" . $value;
            
            if (!$a_only_user_anwers || $checked == "checked") {
                $options[$idx] = array(
                "value" => $value
                ,"title" => trim($cat->title)
                ,"other" => (bool) $cat->other
                ,"checked" => $checked
                ,"textanswer" => $text
            );
            }
            
            ksort($options);
        }
    
        return array_values($options);
    }

Here is the caller graph for this function:

getPrintView()

SurveyMultipleChoiceQuestionGUI::getPrintView	(		$question_title = 1,
			$show_questiontext = 1,
			$survey_id = null,
		array	$a_working_data = null
	)

Creates a HTML representation of the question.

private

Definition at line 217 of file class.SurveyMultipleChoiceQuestionGUI.php.

References $options, $template, ilUtil\getHtmlPath(), ilUtil\getImagePath(), getParsedAnswers(), SurveyQuestionGUI\getPrintViewQuestionTitle(), object, SurveyQuestionGUI\outQuestionText(), and ilUtil\prepareFormOutput().

    {
        $options = $this->getParsedAnswers($a_working_data);
        
        $template = new ilTemplate("tpl.il_svy_qpl_mc_printview.html", true, true, "Modules/SurveyQuestionPool");
        switch ($this->object->getOrientation()) {
            case 0:
                // vertical orientation
                foreach ($options as $option) {
                    if ($option["other"]) {
                        $template->setCurrentBlock("other_row");
                        $template->setVariable("IMAGE_CHECKBOX", ilUtil::getHtmlPath(ilUtil::getImagePath("checkbox_" . $option["checked"] . ".png")));
                        $template->setVariable("ALT_CHECKBOX", $this->lng->txt($option["checked"]));
                        $template->setVariable("TITLE_CHECKBOX", $this->lng->txt($option["checked"]));
                        $template->setVariable("OTHER_LABEL", ilUtil::prepareFormOutput($option["title"]));
                        $template->setVariable("OTHER_ANSWER", $option["textanswer"]
                            ? ilUtil::prepareFormOutput($option["textanswer"])
                            : " ");
                        $template->parseCurrentBlock();
                    } else {
                        $template->setCurrentBlock("mc_row");
                        $template->setVariable("IMAGE_CHECKBOX", ilUtil::getHtmlPath(ilUtil::getImagePath("checkbox_" . $option["checked"] . ".png")));
                        $template->setVariable("ALT_CHECKBOX", $this->lng->txt($option["checked"]));
                        $template->setVariable("TITLE_CHECKBOX", $this->lng->txt($option["checked"]));
                        $template->setVariable("TEXT_MC", ilUtil::prepareFormOutput($option["title"]));
                        $template->parseCurrentBlock();
                    }
                }
                break;
            case 1:
                // horizontal orientation
                foreach ($options as $option) {
                    $template->setCurrentBlock("checkbox_col");
                    $template->setVariable("IMAGE_CHECKBOX", ilUtil::getHtmlPath(ilUtil::getImagePath("checkbox_" . $option["checked"] . ".png")));
                    $template->setVariable("ALT_CHECKBOX", $this->lng->txt($option["checked"]));
                    $template->setVariable("TITLE_CHECKBOX", $this->lng->txt($option["checked"]));
                    $template->parseCurrentBlock();
                }
                foreach ($options as $option) {
                    if ($option["other"]) {
                        $template->setCurrentBlock("other_text_col");
                        $template->setVariable("OTHER_LABEL", ilUtil::prepareFormOutput($option["title"]));
                        $template->setVariable("OTHER_ANSWER", $option["textanswer"]
                            ? ilUtil::prepareFormOutput($option["textanswer"])
                            : " ");
                        $template->parseCurrentBlock();
                    } else {
                        $template->setCurrentBlock("text_col");
                        $template->setVariable("TEXT_MC", ilUtil::prepareFormOutput($option["title"]));
                        $template->parseCurrentBlock();
                    }
                }
                break;
        }
        
        if ($this->object->use_min_answers) {
            $template->setCurrentBlock('min_max_msg');
            if ($this->object->nr_min_answers > 0 && $this->object->nr_max_answers > 0) {
                $template->setVariable('MIN_MAX_MSG', sprintf($this->lng->txt('msg_min_max_nr_answers'), $this->object->nr_min_answers, $this->object->nr_max_answers));
            } elseif ($this->object->nr_min_answers > 0) {
                $template->setVariable('MIN_MAX_MSG', sprintf($this->lng->txt('msg_min_nr_answers'), $this->object->nr_min_answers));
            } elseif ($this->object->nr_max_answers > 0) {
                $template->setVariable('MIN_MAX_MSG', sprintf($this->lng->txt('msg_max_nr_answers'), $this->object->nr_max_answers));
            }
            $template->parseCurrentBlock();
        }
        if ($show_questiontext) {
            $this->outQuestionText($template);
        }
        if ($question_title) {
            $template->setVariable("QUESTION_TITLE", $this->getPrintViewQuestionTitle($question_title));
        }
        $template->parseCurrentBlock();
        return $template->get();
    }

Here is the call graph for this function:

getWorkingForm()

SurveyMultipleChoiceQuestionGUI::getWorkingForm	(		$working_data = "",
			$question_title = 1,
			$show_questiontext = 1,
			$error_message = "",
			$survey_id = null
	)

Creates the question output form for the learner.

public

Definition at line 303 of file class.SurveyMultipleChoiceQuestionGUI.php.

References $i, $template, SurveyQuestionGUI\getMaterialOutput(), object, SurveyQuestionGUI\outQuestionText(), and ilUtil\prepareFormOutput().

    {
        $template = new ilTemplate("tpl.il_svy_out_mc.html", true, true, "Modules/SurveyQuestionPool");
        $template->setCurrentBlock("material");
        $template->setVariable("TEXT_MATERIAL", $this->getMaterialOutput());
        $template->parseCurrentBlock();
        switch ($this->object->getOrientation()) {
            case 0:
                // vertical orientation
                for ($i = 0; $i < $this->object->categories->getCategoryCount(); $i++) {
                    $cat = $this->object->categories->getCategory($i);
                    if ($cat->other) {
                        $template->setCurrentBlock("other_row");
                        if (strlen($cat->title)) {
                            $template->setVariable("OTHER_LABEL", $cat->title);
                        }
                        $template->setVariable("VALUE_MC", ($cat->scale) ? ($cat->scale - 1) : $i);
                        $template->setVariable("QUESTION_ID", $this->object->getId());
                        if (is_array($working_data)) {
                            foreach ($working_data as $value) {
                                if (strlen($value["value"])) {
                                    if ($value["value"] == $cat->scale-1) {
                                        $template->setVariable("OTHER_VALUE", ' value="' . ilUtil::prepareFormOutput($value['textanswer']) . '"');
                                        if (!$value['uncheck']) {
                                            $template->setVariable("CHECKED_MC", " checked=\"checked\"");
                                        }
                                    }
                                }
                            }
                        }
                        $template->parseCurrentBlock();
                    } else {
                        $template->setCurrentBlock("mc_row");
                        if ($cat->neutral) {
                            $template->setVariable('ROWCLASS', ' class="neutral"');
                        }
                        $template->setVariable("TEXT_MC", ilUtil::prepareFormOutput($cat->title));
                        $template->setVariable("VALUE_MC", ($cat->scale) ? ($cat->scale - 1) : $i);
                        $template->setVariable("QUESTION_ID", $this->object->getId());
                        if (is_array($working_data)) {
                            foreach ($working_data as $value) {
                                if (strlen($value["value"])) {
                                    if ($value["value"] == $cat->scale-1) {
                                        if (!$value['uncheck']) {
                                            $template->setVariable("CHECKED_MC", " checked=\"checked\"");
                                        }
                                    }
                                }
                            }
                        }
                        $template->parseCurrentBlock();
                    }
                    $template->touchBlock('outer_row');
                }
                break;
            case 1:
                // horizontal orientation
                
                // #15477 - reverting the categorizing of answers
                for ($i = 0; $i < $this->object->categories->getCategoryCount(); $i++) {
                    $cat = $this->object->categories->getCategory($i);
                    
                    // checkbox
                    $template->setCurrentBlock("checkbox_col");
                    if ($cat->neutral) {
                        $template->setVariable('COLCLASS', ' neutral');
                    }
                    $template->setVariable("VALUE_MC", ($cat->scale) ? ($cat->scale - 1) : $i);
                    $template->setVariable("QUESTION_ID", $this->object->getId());
                    if (is_array($working_data)) {
                        foreach ($working_data as $value) {
                            if (strlen($value["value"])) {
                                if ($value["value"] == $cat->scale-1) {
                                    if (!$value['uncheck']) {
                                        $template->setVariable("CHECKED_MC", " checked=\"checked\"");
                                    }
                                }
                            }
                        }
                    }
                    $template->parseCurrentBlock();
                    
                    // answer & input
                    if ($cat->other) {
                        $template->setCurrentBlock("text_other_col");
                        $template->setVariable("VALUE_MC", ($cat->scale) ? ($cat->scale - 1) : $i);
                        $template->setVariable("QUESTION_ID", $this->object->getId());
                        if (strlen($cat->title)) {
                            $template->setVariable("OTHER_LABEL", $cat->title);
                        }
                        if (is_array($working_data)) {
                            foreach ($working_data as $value) {
                                if (strlen($value["value"])) {
                                    if ($value["value"] == $cat->scale-1) {
                                        $template->setVariable("OTHER_VALUE", ' value="' . ilUtil::prepareFormOutput($value['textanswer']) . '"');
                                    }
                                }
                            }
                        }
                        $template->parseCurrentBlock();
                    }
                    // answer
                    else {
                        $template->setCurrentBlock("text_col");
                        if ($cat->neutral) {
                            $template->setVariable('COLCLASS', ' neutral');
                        }
                        $template->setVariable("VALUE_MC", ($cat->scale) ? ($cat->scale - 1) : $i);
                        $template->setVariable("TEXT_MC", ilUtil::prepareFormOutput($cat->title));
                        $template->setVariable("QUESTION_ID", $this->object->getId());
                        $template->parseCurrentBlock();
                    }
                    $template->touchBlock('text_outer_col');
                }
                break;
        }
        
        $template->setCurrentBlock("question_data");
        if ($this->object->use_min_answers) {
            $template->setCurrentBlock('min_max_msg');
            if ($this->object->nr_min_answers > 0 && $this->object->nr_max_answers > 0) {
                if ($this->object->nr_min_answers == $this->object->nr_max_answers) {
                    $template->setVariable('MIN_MAX_MSG', sprintf($this->lng->txt('msg_min_max_exact_answers'), $this->object->nr_min_answers));
                } else {
                    $template->setVariable('MIN_MAX_MSG', sprintf($this->lng->txt('msg_min_max_nr_answers'), $this->object->nr_min_answers, $this->object->nr_max_answers));
                }
            } elseif ($this->object->nr_min_answers > 0) {
                $template->setVariable('MIN_MAX_MSG', sprintf($this->lng->txt('msg_min_nr_answers'), $this->object->nr_min_answers));
            } elseif ($this->object->nr_max_answers > 0) {
                $template->setVariable('MIN_MAX_MSG', sprintf($this->lng->txt('msg_max_nr_answers'), $this->object->nr_max_answers));
            }
            $template->parseCurrentBlock();
        }
        if (strcmp($error_message, "") != 0) {
            $template->setVariable("ERROR_MESSAGE", "<p class=\"warning\">$error_message</p>");
        }
        if ($show_questiontext) {
            $this->outQuestionText($template);
        }
        if ($question_title) {
            $template->setVariable("QUESTION_TITLE", $this->object->getTitle());
        }
        $template->parseCurrentBlock();
        return $template->get();
    }

Here is the call graph for this function:

importEditFormValues()

SurveyMultipleChoiceQuestionGUI::importEditFormValues ( ilPropertyFormGUI  $a_form )

protected

Definition at line 146 of file class.SurveyMultipleChoiceQuestionGUI.php.

References $_POST, $key, and ilPropertyFormGUI\getInput().

    {
        $this->object->setOrientation($a_form->getInput("orientation"));
        $this->object->use_other_answer = ($a_form->getInput('use_other_answer')) ? 1 : 0;
        $this->object->other_answer_label = $this->object->use_other_answer ? $a_form->getInput('other_answer_label') : null;
        $this->object->use_min_answers = ($a_form->getInput('use_min_answers')) ? true : false;
        $this->object->nr_min_answers = ($a_form->getInput('nr_min_answers') > 0) ? $a_form->getInput('nr_min_answers') : null;
        $this->object->nr_max_answers = ($a_form->getInput('nr_max_answers') > 0) ? $a_form->getInput('nr_max_answers') : null;
        $this->object->label = $a_form->getInput('label');

        $this->object->categories->flushCategories();

        foreach ($_POST['answers']['answer'] as $key => $value) {
            if (strlen($value)) {
                $this->object->getCategories()->addCategory($value, $_POST['answers']['other'][$key], 0, null, $_POST['answers']['scale'][$key]);
            }
        }
        if (strlen($_POST['answers']['neutral'])) {
            $this->object->getCategories()->addCategory($_POST['answers']['neutral'], 0, 1, null, $_POST['answers_neutral_scale']);
        }
    }

Here is the call graph for this function:

initObject()

SurveyMultipleChoiceQuestionGUI::initObject ( )

protected

Definition at line 39 of file class.SurveyMultipleChoiceQuestionGUI.php.

    {
        include_once "./Modules/SurveyQuestionPool/classes/class.SurveyMultipleChoiceQuestion.php";
        $this->object = new SurveyMultipleChoiceQuestion();
    }

setQuestionTabs()

SurveyMultipleChoiceQuestionGUI::setQuestionTabs

(

)

Definition at line 49 of file class.SurveyMultipleChoiceQuestionGUI.php.

References SurveyQuestionGUI\setQuestionTabsForClass().

    {
        $this->setQuestionTabsForClass("surveymultiplechoicequestiongui");
    }

Here is the call graph for this function:

validateEditForm()

SurveyMultipleChoiceQuestionGUI::validateEditForm ( ilPropertyFormGUI  $a_form )

protected

Definition at line 110 of file class.SurveyMultipleChoiceQuestionGUI.php.

References $_POST, $errors, $key, ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), and ilUtil\sendFailure().

    {
        if ($a_form->getInput("use_min_answers")) {
            // #13927 - see importEditFormValues()
            $cnt_answers = 0;
            foreach ($_POST['answers']['answer'] as $key => $value) {
                if (strlen($value)) {
                    $cnt_answers++;
                }
            }
            if (strlen($_POST['answers']['neutral'])) {
                $cnt_answers++;
            }
            /* this would be the DB-values
            $cnt_answers = $a_form->getItemByPostVar("answers");
            $cnt_answers = $cnt_answers->getCategoryCount();
            */
            $min_anwers = $a_form->getInput("nr_min_answers");
            $max_anwers = $a_form->getInput("nr_max_answers");
            
            if ($min_anwers &&
                $min_anwers > $cnt_answers) {
                $a_form->getItemByPostVar("nr_min_answers")->setAlert($this->lng->txt('err_minvalueganswers'));
                $errors = true;
            }
            if ($max_anwers > 0 &&
                ($max_anwers > $cnt_answers || $max_anwers < $min_anwers)) {
                $a_form->getItemByPostVar("nr_max_answers")->setAlert($this->lng->txt('err_maxvaluegeminvalue'));
                $errors = true;
            }
        }
        
        ilUtil::sendFailure($this->lng->txt('form_input_not_valid'));
        return !$errors;
    }

Here is the call graph for this function:

---

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

• Modules/SurveyQuestionPool/classes/class.SurveyMultipleChoiceQuestionGUI.php