MultipleChoice survey question. More...

Inheritance diagram for SurveyMultipleChoiceQuestion:

Collaboration diagram for SurveyMultipleChoiceQuestion:

Public Member Functions
	__construct ($title="", $description="", $author="", $questiontext="", $owner=-1, $orientation=0)
	The constructor takes possible arguments an creates an instance of the SurveyMultipleChoiceQuestion object. More...

	getQuestionDataArray ($id)
	Returns the question data fields from the database. More...

	loadFromDb ($id)
	Loads a SurveyMultipleChoiceQuestion object from the database. More...

	isComplete ()
	Returns true if the question is complete for use. More...

	saveToDb ($original_id="")
	Saves a SurveyMultipleChoiceQuestion object to a database. More...

	saveCategoriesToDb ()

	toXML ($a_include_header=TRUE, $obligatory_state="")
	Returns an xml representation of the question. More...

	insertXML (&$a_xml_writer, $a_include_header=TRUE)
	Adds the question XML to a given XMLWriter object. More...

	getQuestionType ()
	Returns the question type of the question. More...

	getAdditionalTableName ()
	Returns the name of the additional question data table in the database. More...

&	getWorkingDataFromUserInput ($post_data)
	Creates the user data of the svy_answer table from the POST data. More...

	checkUserInput ($post_data, $survey_id)
	Checks the input of the active user for obligatory status and entered values. More...

	saveUserInput ($post_data, $active_id, $a_return=false)

	importAdditionalMetadata ($a_meta)
	Import additional meta data from the question import file. More...

	importResponses ($a_data)
	Import response data from the question import file. More...

	usableForPrecondition ()
	Returns if the question is usable for preconditions. More...

	getAvailableRelations ()
	Returns the available relations for the question. More...

	getPreconditionOptions ()
	Returns the options for preconditions. More...

	getPreconditionSelectValue ($default="", $title, $variable)
	Creates a form property for the precondition value. More...

	getPreconditionValueOutput ($value)
	Returns the output for a precondition value. More...

	getCategories ()

Public Member Functions inherited from SurveyQuestion
	__construct ($title="", $description="", $author="", $questiontext="", $owner=-1)
	SurveyQuestion constructor The constructor takes possible arguments an creates an instance of the SurveyQuestion object. More...

	setComplete ($a_complete)
	Sets the complete state of the question. More...

	isComplete ()
	Returns 1, if a question is complete for use. More...

	questionTitleExists ($title, $questionpool_object="")
	Returns TRUE if the question title exists in the database. More...

	setTitle ($title="")
	Sets the title string of the SurveyQuestion object. More...

	setObligatory ($obligatory=1)
	Sets the obligatory state of the question. More...

	setOrientation ($orientation=0)
	Sets the orientation of the question output. More...

	setId ($id=-1)
	Sets the id of the SurveyQuestion object. More...

	setSurveyId ($id=-1)
	Sets the survey id of the SurveyQuestion object. More...

	setDescription ($description="")
	Sets the description string of the SurveyQuestion object. More...

	addMaterials ($materials_file, $materials_name="")
	Sets the materials uri. More...

	setMaterialsfile ($materials_filename, $materials_tempfilename="", $materials_name="")
	Sets and uploads the materials uri. More...

	deleteMaterial ($materials_name="")
	Deletes a materials uri with a given name. More...

	flushMaterials ()
	Deletes all materials uris. More...

	setAuthor ($author="")
	Sets the authors name of the SurveyQuestion object. More...

	setQuestiontext ($questiontext="")
	Sets the questiontext of the SurveyQuestion object. More...

	setOwner ($owner="")
	Sets the creator/owner ID of the SurveyQuestion object. More...

	getTitle ()
	Gets the title string of the SurveyQuestion object. More...

	getLabel ()

	getId ()
	Gets the id of the SurveyQuestion object. More...

	getObligatory ($survey_id="")
	Gets the obligatory state of the question. More...

	getSurveyId ()
	Gets the survey id of the SurveyQuestion object. More...

	getOrientation ()
	Gets the orientation of the question output. More...

	getDescription ()
	Gets the description string of the SurveyQuestion object. More...

	getAuthor ()
	Gets the authors name of the SurveyQuestion object. More...

	getOwner ()
	Gets the creator/owner ID of the SurveyQuestion object. More...

	getQuestiontext ()
	Gets the questiontext of the SurveyQuestion object. More...

	getObjId ()
	Get the reference id of the container object. More...

	setObjId ($obj_id=0)
	Set the reference id of the container object. More...

	duplicate ($for_survey=true, $title="", $author="", $owner="", $a_survey_id=0)
	Duplicates a survey question. More...

	copyObject ($target_questionpool, $title="")
	Copies an assOrderingQuestion object. More...

	copyXHTMLMediaObjectsOfQuestion ($a_q_id)
	Increases the media object usage counter when a question is duplicated. More...

	loadFromDb ($question_id)
	Loads a SurveyQuestion object from the database. More...

	saveCompletionStatus ($original_id="")
	Saves the complete flag to the database. More...

	saveToDb ($original_id="")
	Saves a SurveyQuestion object to a database. More...

	saveMaterial ()
	save material to db More...

	createNewQuestion ()
	Creates a new question with a 0 timestamp when a new question is created This assures that an ID is given to the question if a file upload or something else occurs. More...

	saveWorkingData ($limit_to=LIMIT_NO_LIMIT)
	Saves the learners input of the question to the database. More...

	getImagePath ()
	Returns the image path for web accessable images of a question. More...

	getMaterialsPath ()
	Returns the materials path for web accessable materials of a question. More...

	getImagePathWeb ()
	Returns the web image path for web accessable images of a question. More...

	getMaterialsPathWeb ()
	Returns the web image path for web accessable images of a question. More...

	saveCategoryToDb ($categorytext, $neutral=0)
	Saves a category to the database. More...

	deleteAdditionalTableData ($question_id)
	Deletes datasets from the additional question table in the database. More...

	delete ($question_id)
	Deletes a question and all materials from the database. More...

	syncWithOriginal ()

	getPhrase ($phrase_id)
	Returns a phrase for a given database id. More...

	phraseExists ($title)
	Returns true if the phrase title already exists for the current user. More...

	addInternalLink ($material_id, $title="")

	deleteMaterials ($a_array)
	Deletes materials. More...

	duplicateMaterials ($question_id)
	Duplicates the materials of a question. More...

	addMaterial ($obj_material)

	setMaterial ($material_id="", $is_import=false, $material_title="")
	Sets a material link for the question. More...

	getQuestionTypeID ()
	Returns the question type ID of the question. More...

	getQuestionType ()
	Returns the question type of the question. More...

	isHTML ($a_text)
	Checks if a given string contains HTML or not. More...

	QTIMaterialToString ($a_material)
	Reads an QTI material tag an creates a text string. More...

	addMaterialTag (&$a_xml_writer, $a_material, $close_material_tag=TRUE, $add_mobs=TRUE, $a_attrs=null)
	Creates an XML material tag from a plain text or xhtml text. More...

	prepareTextareaOutput ($txt_output, $prepare_for_latex_output=FALSE)
	Prepares a string for a text area output in surveys. More...

	getQuestionDataArray ($id)
	Returns the question data fields from the database. More...

&	getWorkingDataFromUserInput ($post_data)
	Creates the user data of the svy_answer table from the POST data. More...

	importAdditionalMetadata ($a_meta)
	Import additional meta data from the question import file. More...

	importResponses ($a_data)
	Import response data from the question import file. More...

	importAdjectives ($a_data)
	Import bipolar adjectives from the question import file. More...

	importMatrix ($a_data)
	Import matrix rows from the question import file. More...

	usableForPrecondition ()
	Returns if the question is usable for preconditions. More...

	getAvailableRelations ()
	Returns the available relations for the question. More...

	getPreconditionOptions ()
	Returns the options for preconditions. More...

	getPreconditionValueOutput ($value)
	Returns the output for a precondition value. More...

	getPreconditionSelectValue ($default="", $title, $variable)
	Creates a form property for the precondition value. More...

	setOriginalId ($original_id)

	getOriginalId ()

	getMaterial ()

	setSubtype ($a_subtype)

	getSubtype ()

	__get ($value)
	Object getter. More...

	__set ($key, $value)
	Object setter. More...

	getCopyIds ($a_group_by_survey=false)

	hasCopies ()

	stripSlashesAddSpaceFallback ($a_str)
	Strip slashes with add space fallback, see https://mantis.ilias.de/view.php?id=19727 and https://mantis.ilias.de/view.php?id=24200. More...

Data Fields
	$categories

Data Fields inherited from SurveyQuestion
	$id

	$title

	$description

	$owner

	$author

	$materials

	$survey_id

	$obj_id

	$questiontext

	$obligatory

	$ilias

	$tpl

	$lng

	$orientation

	$material

	$complete

Additional Inherited Members
Static Public Member Functions inherited from SurveyQuestion
static	_isComplete ($question_id)
	Checks whether the question is complete or not. More...

static	_getQuestionType ($question_id)
	Returns the question type of a question with a given id. More...

static	_getTitle ($question_id)
	Returns the question title of a question with a given id. More...

static	_getOriginalId ($question_id, $a_return_question_id_if_no_original=true)
	Returns the original id of a question. More...

static	_questionExists ($question_id)
	Returns true if the question already exists in the database. More...

static	_resolveInternalLink ($internal_link)

static	_resolveIntLinks ($question_id)

static	_getInternalLinkHref ($target="", $a_parent_ref_id=null)

static	_isWriteable ($question_id, $user_id)
	Returns true if the question is writeable by a certain user. More...

static	_includeClass ($question_type, $gui=0)
	Include the php class file for a given question type. More...

static	_getQuestionTypeName ($type_tag)
	Return the translation for a given question type tag. More...

static	_instanciateQuestion ($question_id)
	Creates an instance of a question with a given question id. More...

static	_instanciateQuestionGUI ($question_id)
	Creates an instance of a question GUI with a given question id. More...

static	_instanciateQuestionEvaluation ($question_id, array $a_finished_ids=null)
	Creates an instance of a question evaluation with a given question id. More...

static	_changeOriginalId ($a_question_id, $a_original_id, $a_object_id)
	Change original id of existing question in db. More...

static	_lookupSurveyObjId ($a_question_id)

static	lookupObjFi ($a_qid)
	Lookip obj fi. More...

Protected Attributes inherited from SurveyQuestion
	$cumulated
	An array containing the cumulated results of the question for a given survey. More...

	$log

Detailed Description

MultipleChoice survey question.

The SurveyMultipleChoiceQuestion class defines and encapsulates basic methods and attributes 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.SurveyMultipleChoiceQuestion.php.

Constructor & Destructor Documentation

◆ __construct()

SurveyMultipleChoiceQuestion::__construct	(	$title = `""`,
		$description = `""`,
		$author = `""`,
		$questiontext = `""`,
		$owner = `-1`,
		$orientation = `0`
	)

The constructor takes possible arguments an creates an instance of the SurveyMultipleChoiceQuestion object.

Parameters

string	$title	A title string to describe the question
string	$description	A description string to describe the question
string	$author	A string containing the name of the questions author
integer	$owner	A numerical ID to identify the owner/creator @access public

Definition at line 55 of file class.SurveyMultipleChoiceQuestion.php.

        {
                parent::__construct($title, $description, $author, $questiontext, $owner);
                
                $this->orientation = $orientation;
                include_once "./Modules/SurveyQuestionPool/classes/class.SurveyCategories.php";
                $this->categories = new SurveyCategories();
        }

References SurveyQuestion\$author, SurveyQuestion\$description, SurveyQuestion\$orientation, SurveyQuestion\$owner, SurveyQuestion\$questiontext, and SurveyQuestion\$title.

Member Function Documentation

◆ checkUserInput()

SurveyMultipleChoiceQuestion::checkUserInput	(	$post_data,
		$survey_id
	)

Checks the input of the active user for obligatory status and entered values.

Parameters

array	$post_data	The contents of the $_POST array
integer	$survey_id	The database ID of the active survey

Returns: string Empty string if the input is ok, an error message otherwise @access public

Definition at line 395 of file class.SurveyMultipleChoiceQuestion.php.

        {
                $entered_value = $post_data[$this->getId() . "_value"];
                if (!$this->getObligatory($survey_id) && count($entered_value) == 0) return "";
 
                if ($this->use_min_answers && $this->nr_min_answers > 0 && $this->nr_max_answers > 0 && $this->nr_min_answers == $this->nr_max_answers && count($entered_value) != $this->nr_max_answers)
                {
                        return sprintf($this->lng->txt("err_no_exact_answers"), $this->nr_min_answers);
                }
                if ($this->use_min_answers && $this->nr_min_answers > 0 && count($entered_value) < $this->nr_min_answers)
                {
                        return sprintf($this->lng->txt("err_no_min_answers"), $this->nr_min_answers);
                }
                if ($this->use_min_answers && $this->nr_max_answers > 0 && count($entered_value) > $this->nr_max_answers)
                {
                        return sprintf($this->lng->txt("err_no_max_answers"), $this->nr_max_answers);
                }
                if (!is_array($entered_value))
                {
                        return $this->lng->txt("question_mr_not_checked");
                }
                for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
                {
                        $cat = $this->categories->getCategory($i);
                        if ($cat->other)
                        {
                                if (in_array($i, $entered_value))
                                {
                                        if (array_key_exists($this->getId() . "_" . $i . "_other", $post_data) && !strlen($post_data[$this->getId() . "_" . $i . "_other"]))
                                        {
                                                return $this->lng->txt("question_mr_no_other_answer");
                                        }
                                }
                                else
                                {
                                        if (strlen($post_data[$this->getId() . "_" . $i . "_other"]))
                                        {
                                                return $this->lng->txt("question_mr_no_other_answer_checked");
                                        }
                                }
                        }
                }
                return "";
        }

References SurveyQuestion\$survey_id, SurveyQuestion\getId(), SurveyQuestion\getObligatory(), and sprintf.

Here is the call graph for this function:

◆ getAdditionalTableName()

SurveyMultipleChoiceQuestion::getAdditionalTableName ( )

Returns the name of the additional question data table in the database.

Returns: string The additional table name @access public

Definition at line 346 of file class.SurveyMultipleChoiceQuestion.php.

        {
                return "svy_qst_mc";
        }

Referenced by getQuestionDataArray(), loadFromDb(), and saveToDb().

Here is the caller graph for this function:

◆ getAvailableRelations()

SurveyMultipleChoiceQuestion::getAvailableRelations ( )

Returns the available relations for the question.

Returns: array An array containing the available relations @access public

Reimplemented from SurveyQuestion.

Definition at line 555 of file class.SurveyMultipleChoiceQuestion.php.

        {
                return array("=", "<>");
        }

◆ getCategories()

SurveyMultipleChoiceQuestion::getCategories ( )

Definition at line 612 of file class.SurveyMultipleChoiceQuestion.php.

        {
                return $this->categories;
        }

References $categories.

◆ getPreconditionOptions()

SurveyMultipleChoiceQuestion::getPreconditionOptions ( )

Returns the options for preconditions.

Returns: array

Reimplemented from SurveyQuestion.

Definition at line 565 of file class.SurveyMultipleChoiceQuestion.php.

        {
                global $lng;
                
                $options = array();
                for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
                {
                        $category = $this->categories->getCategory($i);                 
                        $options[$category->scale-1] = $category->scale . " - " . $category->title;
                }
                return $options;
        }

References SurveyQuestion\$lng, and $options.

Referenced by getPreconditionSelectValue().

Here is the caller graph for this function:

◆ getPreconditionSelectValue()

SurveyMultipleChoiceQuestion::getPreconditionSelectValue	(	$default = `""`,
		$title,
		$variable
	)

Creates a form property for the precondition value.

Returns: The ILIAS form element @access public

Reimplemented from SurveyQuestion.

Definition at line 584 of file class.SurveyMultipleChoiceQuestion.php.

        {
                include_once "./Services/Form/classes/class.ilSelectInputGUI.php";
                $step3 = new ilSelectInputGUI($title, $variable);
                $options = $this->getPreconditionOptions();
                $step3->setOptions($options);
                $step3->setValue($default);
                return $step3;
        }

References $options, SurveyQuestion\$title, and getPreconditionOptions().

Here is the call graph for this function:

◆ getPreconditionValueOutput()

SurveyMultipleChoiceQuestion::getPreconditionValueOutput ( $value )

Returns the output for a precondition value.

Parameters

string $value The precondition value

Returns: string The output of the precondition value @access public

Reimplemented from SurveyQuestion.

Definition at line 601 of file class.SurveyMultipleChoiceQuestion.php.

        {
                // #18136
                $category = $this->categories->getCategoryForScale($value+1);
                
                // #17895 - see getPreconditionOptions()
                return $category->scale . 
                        " - " . 
                        ((strlen($category->title)) ? $category->title : $this->lng->txt('other_answer'));
        }

◆ getQuestionDataArray()

SurveyMultipleChoiceQuestion::getQuestionDataArray ( $id )

Returns the question data fields from the database.

Parameters

integer $id The question ID from the database

Returns: array Array containing the question fields and data from the database @access public

Reimplemented from SurveyQuestion.

Definition at line 71 of file class.SurveyMultipleChoiceQuestion.php.

        {
                global $ilDB;
                
                $result = $ilDB->queryF("SELECT svy_question.*, " . $this->getAdditionalTableName() . ".* FROM svy_question, " . $this->getAdditionalTableName() . " WHERE svy_question.question_id = %s AND svy_question.question_id = " . $this->getAdditionalTableName() . ".question_fi",
                        array('integer'),
                        array($id)
                );
                if ($result->numRows() == 1)
                {
                        return $ilDB->fetchAssoc($result);
                }
                else
                {
                        return array();
                }
        }

References SurveyQuestion\$id, $ilDB, $result, and getAdditionalTableName().

Here is the call graph for this function:

◆ getQuestionType()

SurveyMultipleChoiceQuestion::getQuestionType ( )

Returns the question type of the question.

Returns: integer The question type of the question @access public

Reimplemented from SurveyQuestion.

Definition at line 335 of file class.SurveyMultipleChoiceQuestion.php.

        {
                return "SurveyMultipleChoiceQuestion";
        }

◆ getWorkingDataFromUserInput()

& SurveyMultipleChoiceQuestion::getWorkingDataFromUserInput ( $post_data )

Creates the user data of the svy_answer table from the POST data.

Returns: array User data according to the svy_answer table @access public

Reimplemented from SurveyQuestion.

Definition at line 357 of file class.SurveyMultipleChoiceQuestion.php.

        {
                $entered_value = $post_data[$this->getId() . "_value"];
                $data = array();
                if (is_array($entered_value))
                {
                        foreach ($entered_value as $idx => $value)
                        {
                                array_push($data, array("value" => $value, "textanswer" => $post_data[$this->getId() . '_' . $value . '_other']));
                        }
                }
                for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
                {
                        $cat = $this->categories->getCategory($i);
                        if ($cat->other)
                        {
                                // #18212
                                if (!is_array($entered_value) || !in_array($i, $entered_value))
                                {
                                        if (strlen($post_data[$this->getId() . "_" . $i . "_other"]))
                                        {
                                                array_push($data, array("value" => $i, "textanswer" => $post_data[$this->getId() . '_' . $i . '_other'], "uncheck" => true));
                                        }
                                }
                        }
                }
                return $data;
        }

References $data, and SurveyQuestion\getId().

Here is the call graph for this function:

◆ importAdditionalMetadata()

SurveyMultipleChoiceQuestion::importAdditionalMetadata ( $a_meta )

Import additional meta data from the question import file.

Usually the meta data section is used to store question elements which are not part of the standard XML schema.

Returns: array $a_meta Array containing the additional meta data @access public

Reimplemented from SurveyQuestion.

Definition at line 491 of file class.SurveyMultipleChoiceQuestion.php.

        {
                foreach ($a_meta as $key => $value)
                {
                        switch ($value["label"])
                        {
                                case "orientation":
                                        $this->setOrientation($value["entry"]);
                                        break;
                                case "use_min_answers":
                                        $this->use_min_answers = $value["entry"];
                                        break;
                                case "nr_min_answers":
                                        $this->nr_min_answers = $value["entry"];
                                        break;
                                case "nr_max_answers":
                                        $this->nr_max_answers = $value["entry"];
                                        break;
                        }
                }
        }

References SurveyQuestion\setOrientation().

Here is the call graph for this function:

◆ importResponses()

SurveyMultipleChoiceQuestion::importResponses ( $a_data )

Import response data from the question import file.

Returns: array $a_data Array containing the response data @access public

Reimplemented from SurveyQuestion.

Definition at line 519 of file class.SurveyMultipleChoiceQuestion.php.

        {
                foreach ($a_data as $id => $data)
                {
                        $categorytext = "";
                        foreach ($data["material"] as $material)
                        {
                                $categorytext .= $material["text"];
                        }
                        $this->categories->addCategory(
                                $categorytext, 
                                strlen($data['other']) ? $data['other'] : 0, 
                                strlen($data['neutral']) ? $data['neutral'] : 0, 
                                strlen($data['label']) ? $data['label'] : null, 
                                strlen($data['scale']) ? $data['scale'] : null
                        );
                }
        }

References $data, SurveyQuestion\$id, and SurveyQuestion\$material.

◆ insertXML()

SurveyMultipleChoiceQuestion::insertXML	(	&	$a_xml_writer,
			$a_include_header = `TRUE`
	)

Adds the question XML to a given XMLWriter object.

Parameters

object	$a_xml_writer	The XMLWriter object
boolean	$a_include_header	Determines wheather or not the XML should be used @access public

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

        {
                $attrs = array(
                        "id" => $this->getId(),
                        "title" => $this->getTitle(),
                        "type" => $this->getQuestiontype(),
                        "obligatory" => $this->getObligatory()
                );
                $a_xml_writer->xmlStartTag("question", $attrs);
                
                $a_xml_writer->xmlElement("description", NULL, $this->getDescription());
                $a_xml_writer->xmlElement("author", NULL, $this->getAuthor());
                if (strlen($this->label))
                {
                        $attrs = array(
                                "label" => $this->label,
                        );
                }
                else
                {
                        $attrs = array();
                }
                $a_xml_writer->xmlStartTag("questiontext", $attrs);
                $this->addMaterialTag($a_xml_writer, $this->getQuestiontext());
                $a_xml_writer->xmlEndTag("questiontext");
 
                $a_xml_writer->xmlStartTag("responses");
 
                for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
                {
                        $attrs = array(
                                "id" => $i
                        );
                        if (strlen($this->categories->getCategory($i)->other)) $attrs['other'] = $this->categories->getCategory($i)->other;
                        if (strlen($this->categories->getCategory($i)->neutral)) $attrs['neutral'] = $this->categories->getCategory($i)->neutral;
                        if (strlen($this->categories->getCategory($i)->label)) $attrs['label'] = $this->categories->getCategory($i)->label;
                        if (strlen($this->categories->getCategory($i)->scale)) $attrs['scale'] = $this->categories->getCategory($i)->scale;
                        $a_xml_writer->xmlStartTag("response_multiple", $attrs);
                        $this->addMaterialTag($a_xml_writer, $this->categories->getCategory($i)->title);
                        $a_xml_writer->xmlEndTag("response_multiple");
                }
 
                $a_xml_writer->xmlEndTag("responses");
 
                if (count($this->material))
                {
                        if (preg_match("/il_(\d*?)_(\w+)_(\d+)/", $this->material["internal_link"], $matches))
                        {
                                $attrs = array(
                                        "label" => $this->material["title"]
                                );
                                $a_xml_writer->xmlStartTag("material", $attrs);
                                $intlink = "il_" . IL_INST_ID . "_" . $matches[2] . "_" . $matches[3];
                                if (strcmp($matches[1], "") != 0)
                                {
                                        $intlink = $this->material["internal_link"];
                                }
                                $a_xml_writer->xmlElement("mattext", NULL, $intlink);
                                $a_xml_writer->xmlEndTag("material");
                        }
                }
 
                $a_xml_writer->xmlStartTag("metadata");
                $a_xml_writer->xmlStartTag("metadatafield");
                $a_xml_writer->xmlElement("fieldlabel", NULL, "orientation");
                $a_xml_writer->xmlElement("fieldentry", NULL, $this->getOrientation());
                $a_xml_writer->xmlEndTag("metadatafield");
                $a_xml_writer->xmlStartTag("metadatafield");
                $a_xml_writer->xmlElement("fieldlabel", NULL, "use_min_answers");
                $a_xml_writer->xmlElement("fieldentry", NULL, $this->use_min_answers);
                $a_xml_writer->xmlEndTag("metadatafield");
                $a_xml_writer->xmlStartTag("metadatafield");
                $a_xml_writer->xmlElement("fieldlabel", NULL, "nr_min_answers");
                $a_xml_writer->xmlElement("fieldentry", NULL, $this->nr_min_answers);
                $a_xml_writer->xmlEndTag("metadatafield");
                $a_xml_writer->xmlStartTag("metadatafield");
                $a_xml_writer->xmlElement("fieldlabel", NULL, "nr_max_answers");
                $a_xml_writer->xmlElement("fieldentry", NULL, $this->nr_max_answers);
                $a_xml_writer->xmlEndTag("metadatafield");
                $a_xml_writer->xmlEndTag("metadata");
 
                $a_xml_writer->xmlEndTag("question");
        }

References SurveyQuestion\addMaterialTag(), SurveyQuestion\getAuthor(), SurveyQuestion\getDescription(), SurveyQuestion\getId(), SurveyQuestion\getObligatory(), SurveyQuestion\getOrientation(), SurveyQuestion\getQuestiontext(), and SurveyQuestion\getTitle().

Referenced by toXML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isComplete()

SurveyMultipleChoiceQuestion::isComplete ( )

Returns true if the question is complete for use.

Returns: boolean True if the question is complete for use, otherwise false @access public

Reimplemented from SurveyQuestion.

Definition at line 145 of file class.SurveyMultipleChoiceQuestion.php.

        {
                if (
                        strlen($this->getTitle()) &&
                        strlen($this->getAuthor()) &&
                        strlen($this->getQuestiontext()) &&
                        $this->categories->getCategoryCount()
                )
                {
                        return 1;
                }
                else
                {
                        return 0;
                }
        }

References SurveyQuestion\getAuthor(), SurveyQuestion\getQuestiontext(), and SurveyQuestion\getTitle().

Here is the call graph for this function:

◆ loadFromDb()

SurveyMultipleChoiceQuestion::loadFromDb ( $id )

Loads a SurveyMultipleChoiceQuestion object from the database.

Parameters

integer $id The database id of the multiple choice survey question @access public

Reimplemented from SurveyQuestion.

Definition at line 95 of file class.SurveyMultipleChoiceQuestion.php.

        {
                global $ilDB;
 
                $result = $ilDB->queryF("SELECT svy_question.*, " . $this->getAdditionalTableName() . ".* FROM svy_question LEFT JOIN " . $this->getAdditionalTableName() . " ON " . $this->getAdditionalTableName() . ".question_fi = svy_question.question_id WHERE svy_question.question_id = %s",
                        array('integer'),
                        array($id)
                );
                if ($result->numRows() == 1) 
                {
                        $data = $ilDB->fetchAssoc($result);
                        $this->setId($data["question_id"]);
                        $this->setTitle($data["title"]);
                        $this->label = $data['label'];
                        $this->setDescription($data["description"]);
                        $this->setObjId($data["obj_fi"]);
                        $this->setAuthor($data["author"]);
                        $this->setOwner($data["owner_fi"]);
                        include_once("./Services/RTE/classes/class.ilRTE.php");
                        $this->setQuestiontext(ilRTE::_replaceMediaObjectImageSrc($data["questiontext"], 1));
                        $this->setObligatory($data["obligatory"]);
                        $this->setComplete($data["complete"]);
                        $this->setOriginalId($data["original_id"]);
                        $this->setOrientation($data["orientation"]);
                        $this->use_min_answers = ($data['use_min_answers']) ? true : false;
                        $this->nr_min_answers = $data['nr_min_answers'];
                        $this->nr_max_answers = $data['nr_max_answers'];
 
                        $this->categories->flushCategories();
                        $result = $ilDB->queryF("SELECT svy_variable.*, svy_category.title, svy_category.neutral FROM svy_variable, svy_category WHERE svy_variable.question_fi = %s AND svy_variable.category_fi = svy_category.category_id ORDER BY sequence ASC",
                                array('integer'),
                                array($id)
                        );
                        if ($result->numRows() > 0) 
                        {
                                while ($data = $ilDB->fetchAssoc($result)) 
                                {
                                        $this->categories->addCategory($data["title"], $data["other"], $data["neutral"], null, ($data['scale']) ? $data['scale'] : ($data['sequence'] + 1));
                                }
                        }
                }
                parent::loadFromDb($id);
        }

References $data, SurveyQuestion\$id, $ilDB, $result, ilRTE\_replaceMediaObjectImageSrc(), getAdditionalTableName(), SurveyQuestion\setAuthor(), SurveyQuestion\setComplete(), SurveyQuestion\setDescription(), SurveyQuestion\setId(), SurveyQuestion\setObjId(), SurveyQuestion\setObligatory(), SurveyQuestion\setOrientation(), SurveyQuestion\setOriginalId(), SurveyQuestion\setOwner(), SurveyQuestion\setQuestiontext(), and SurveyQuestion\setTitle().

Here is the call graph for this function:

◆ saveCategoriesToDb()

SurveyMultipleChoiceQuestion::saveCategoriesToDb ( )

Definition at line 195 of file class.SurveyMultipleChoiceQuestion.php.

        {
                global $ilDB;
                
                $affectedRows = $ilDB->manipulateF("DELETE FROM svy_variable WHERE question_fi = %s",
                        array('integer'),
                        array($this->getId())
                );
 
                for ($i = 0; $i < $this->categories->getCategoryCount(); $i++)
                {
                        $cat = $this->categories->getCategory($i);
                        $category_id = $this->saveCategoryToDb($cat->title, $cat->neutral);
                        $next_id = $ilDB->nextId('svy_variable');
                        $affectedRows = $ilDB->manipulateF("INSERT INTO svy_variable (variable_id, category_fi, question_fi, value1, other, sequence, scale, tstamp) VALUES (%s, %s, %s, %s, %s, %s, %s, %s)",
                                array('integer','integer','integer','float','integer','integer', 'integer','integer'),
                                array($next_id, $category_id, $this->getId(), ($i + 1), $cat->other, $i, ($cat->scale > 0) ? $cat->scale : null, time())
                        );
                }
                $this->saveCompletionStatus();
        }

References $ilDB, SurveyQuestion\getId(), SurveyQuestion\saveCategoryToDb(), and SurveyQuestion\saveCompletionStatus().

Referenced by saveToDb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveToDb()

SurveyMultipleChoiceQuestion::saveToDb ( $original_id = "" )

Saves a SurveyMultipleChoiceQuestion object to a database.

@access public

Reimplemented from SurveyQuestion.

Definition at line 167 of file class.SurveyMultipleChoiceQuestion.php.

  {
                global $ilDB;
 
                $affectedRows = parent::saveToDb($original_id);
                if ($affectedRows == 1) 
                {
                        $affectedRows = $ilDB->manipulateF("DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
                                array('integer'),
                                array($this->getId())
                        );
                        $affectedRows = $ilDB->manipulateF("INSERT INTO " . $this->getAdditionalTableName() . " (question_fi, orientation, use_min_answers, nr_min_answers, nr_max_answers) VALUES (%s, %s, %s, %s, %s)",
                                array('integer', 'text', 'integer', 'integer', 'integer'),
                                array(
                                        $this->getId(), 
                                        $this->getOrientation(),
                                        ($this->use_min_answers) ? 1 : 0,
                                        ($this->nr_min_answers > 0) ? $this->nr_min_answers : null,
                                        ($this->nr_max_answers > 0) ? $this->nr_max_answers : null
                                )
                        );
 
                        // saving material uris in the database
                        $this->saveMaterial();
                        $this->saveCategoriesToDb();
                }
        }

References $ilDB, getAdditionalTableName(), SurveyQuestion\getId(), SurveyQuestion\getOrientation(), saveCategoriesToDb(), and SurveyQuestion\saveMaterial().

Here is the call graph for this function:

◆ saveUserInput()

SurveyMultipleChoiceQuestion::saveUserInput	(	$post_data,
		$active_id,
		$a_return = `false`
	)

Definition at line 440 of file class.SurveyMultipleChoiceQuestion.php.

        {
                global $ilDB;
 
                if($a_return)
                {
                        $return_data = array();
                }
                if (is_array($post_data[$this->getId() . "_value"]))
                {
                        foreach ($post_data[$this->getId() . "_value"] as $entered_value)
                        {
                                if (strlen($entered_value) > 0)
                                {
                                        if(!$a_return)
                                        {
                                                $next_id = $ilDB->nextId('svy_answer');
                                                
                                                #20216
                                                $fields = array();
                                                $fields['answer_id'] = array("integer", $next_id);
                                                $fields['question_fi'] = array("integer", $this->getId());
                                                $fields['active_fi'] = array("integer", $active_id);
                                                $fields['value'] = array("float", (strlen($entered_value)) ? $entered_value : NULL);
                                                $fields['textanswer'] = array("clob", ($post_data[$this->getId() . "_" . $entered_value . "_other"]) ? $post_data[$this->getId() . "_" . $entered_value . "_other"] : null);
                                                $fields['tstamp'] = array("integer", time());
 
                                                $affectedRows = $ilDB->insert("svy_answer", $fields);   
                                        }
                                        else
                                        {
                                                $return_data[] = array("value"=>$entered_value, 
                                                                "textanswer"=>$post_data[$this->getId() . "_" . $entered_value . "_other"]);
                                        }
                                }
                        }
                }
                if($a_return)
                {
                        return $return_data;
                }
        }

References $ilDB, and SurveyQuestion\getId().

Here is the call graph for this function:

◆ toXML()

SurveyMultipleChoiceQuestion::toXML	(	$a_include_header = `TRUE`,
		$obligatory_state = `""`
	)

Returns an xml representation of the question.

Returns: string The xml representation of the question @access public

Definition at line 223 of file class.SurveyMultipleChoiceQuestion.php.

        {
                include_once("./Services/Xml/classes/class.ilXmlWriter.php");
                $a_xml_writer = new ilXmlWriter;
                $a_xml_writer->xmlHeader();
                $this->insertXML($a_xml_writer, $a_include_header, $obligatory_state);
                $xml = $a_xml_writer->xmlDumpMem(FALSE);
                if (!$a_include_header)
                {
                        $pos = strpos($xml, "?>");
                        $xml = substr($xml, $pos + 2);
                }
                return $xml;
        }

References insertXML(), and ilXmlWriter\xmlHeader().

Here is the call graph for this function:

◆ usableForPrecondition()

SurveyMultipleChoiceQuestion::usableForPrecondition ( )

Returns if the question is usable for preconditions.

Returns: boolean TRUE if the question is usable for a precondition, FALSE otherwise @access public

Reimplemented from SurveyQuestion.

Definition at line 544 of file class.SurveyMultipleChoiceQuestion.php.

        {
                return TRUE;
        }

Field Documentation

◆ $categories

SurveyMultipleChoiceQuestion::$categories

Definition at line 44 of file class.SurveyMultipleChoiceQuestion.php.

Referenced by getCategories().

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

Modules/SurveyQuestionPool/classes/class.SurveyMultipleChoiceQuestion.php

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkUserInput()

◆ getAdditionalTableName()

◆ getAvailableRelations()

◆ getCategories()

◆ getPreconditionOptions()

◆ getPreconditionSelectValue()

◆ getPreconditionValueOutput()

◆ getQuestionDataArray()

◆ getQuestionType()

◆ getWorkingDataFromUserInput()

◆ importAdditionalMetadata()

◆ importResponses()

◆ insertXML()

◆ isComplete()

◆ loadFromDb()

◆ saveCategoriesToDb()

◆ saveToDb()

◆ saveUserInput()

◆ toXML()

◆ usableForPrecondition()

Field Documentation

◆ $categories