SurveySingleChoiceQuestion Class Reference

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

Inheritance diagram for SurveySingleChoiceQuestion:

Collaboration diagram for SurveySingleChoiceQuestion:

Public Member Functions
	__construct (string $title="", string $description="", string $author="", string $questiontext="", int $owner=-1, int $orientation=1)
	getCategoriesForPhrase (int $phrase_id)
	Gets the available categories for a given phrase. More...
	addPhrase (int $phrase_id)
	Adds a phrase to the question. More...
	getQuestionDataArray (int $id)
	Returns the question data. More...
	loadFromDb (int $question_id)
	load question data into object note: this base implementation only loads the material data More...
	isComplete ()
	saveToDb (int $original_id=0)
	Saves a SurveyQuestion object to a database. More...
	saveCategoriesToDb ()
	toXML (bool $a_include_header=true, bool $obligatory_state=false)
	insertXML (ilXmlWriter $a_xml_writer, bool $a_include_header=true)
	importAdditionalMetadata (array $a_meta)
	Import additional meta data from the question import file. More...
	addStandardNumbers (int $lower_limit, int $upper_limit)
	Adds standard numbers as categories. More...
	savePhrase (string $title)
	Saves a set of categories to a default phrase note: data comes from session. More...
	getQuestionType ()
	getAdditionalTableName ()
	getWorkingDataFromUserInput (array $post_data)
	Creates the user data of the svy_answer table from the POST data. More...
	checkUserInput (array $post_data, int $survey_id)
	Checks the input of the active user for obligatory status and entered values. More...
	saveUserInput (array $post_data, int $active_id, bool $a_return=false)
	importResponses (array $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 (string $default, string $title, string $variable)
	Creates a form property for the precondition value. More...
	getPreconditionValueOutput (string $value)
	Returns the output for a precondition value. More...
	getCategories ()
Public Member Functions inherited from SurveyQuestion
	__construct (string $title="", string $description="", string $author="", string $questiontext="", int $owner=-1)
	setComplete (bool $a_complete)
	isComplete ()
	questionTitleExists (string $title, int $questionpool_object=0)
	setTitle (string $title="")
	setObligatory (bool $obligatory=true)
	setOrientation (int $orientation=0)
	setId (int $id=-1)
	setSurveyId (int $id=-1)
	setDescription (string $description="")
	addMaterials (string $materials_file, string $materials_name="")
	setMaterialsfile (string $materials_filename, string $materials_tempfilename="", string $materials_name="")
	Uploads and adds a material. More...
	deleteMaterial (string $materials_name="")
	flushMaterials ()
	Deletes all materials uris. More...
	setAuthor (string $author="")
	setQuestiontext (string $questiontext="")
	setOwner (int $owner=0)
	getTitle ()
	getLabel ()
	getId ()
	getObligatory ()
	getSurveyId ()
	getOrientation ()
	getDescription ()
	getAuthor ()
	getOwner ()
	getQuestiontext ()
	getObjId ()
	Get the reference(?) id of the container object. More...
	setObjId (int $obj_id=0)
	Set the reference(?) id of the container object. More...
	duplicate (bool $for_survey=true, string $title="", string $author="", int $owner=0, int $a_survey_id=0)
	copyObject (int $target_questionpool, string $title="")
	copyXHTMLMediaObjectsOfQuestion (int $a_q_id)
	Copy media object usages from other question. More...
	loadFromDb (int $question_id)
	load question data into object note: this base implementation only loads the material data More...
	saveCompletionStatus (int $original_id=0)
	Saves the complete flag to the database. More...
	saveToDb (int $original_id=0)
	Saves a SurveyQuestion object to a database. More...
	saveMaterial ()
	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...
	getImagePath ()
	Returns the image path for web accessible images of a question. More...
	getMaterialsPath ()
	Returns the materials path for web accessible materials of a question. More...
	getImagePathWeb ()
	Returns the web image path for web accessible images of a question. More...
	getMaterialsPathWeb ()
	Returns the web image path for web accessable images of a question. More...
	saveCategoryToDb (string $categorytext, int $neutral=0)
	Saves a category to the database. More...
	deleteAdditionalTableData (int $question_id)
	Deletes datasets from the additional question table in the database. More...
	delete (int $question_id)
	Deletes a question and all materials from the database. More...
	syncWithOriginal ()
	getPhrase (int $phrase_id)
	Returns a phrase title for phrase id. More...
	phraseExists (string $title)
	Returns true if the phrase title already exists for the current user(!) More...
	deleteMaterials (array $a_array)
	duplicateMaterials (int $question_id)
	Duplicates the materials of a question. More...
	addMaterial (ilSurveyMaterial $obj_material)
	getQuestionTypeID ()
	getQuestionType ()
	isHTML (string $a_text)
	QTIMaterialToString (ilQTIMaterial $a_material)
	Reads an QTI material tag an creates a text string. More...
	addMaterialTag (ilXmlWriter $a_xml_writer, string $a_material, bool $close_material_tag=true, bool $add_mobs=true, ?array $a_attrs=null)
	Creates an XML material tag from a plain text or xhtml text. More...
	prepareTextareaOutput (string $txt_output, bool $prepare_for_latex_output=false)
	Prepares string for a text area output in surveys. More...
	getQuestionDataArray (int $id)
	Returns the question data. More...
	getWorkingDataFromUserInput (array $post_data)
	Creates the user data of the svy_answer table from the POST data. More...
	importAdditionalMetadata (array $a_meta)
	Import additional meta data from the question import file. More...
	importResponses (array $a_data)
	Import response data from the question import file. More...
	importAdjectives (array $a_data)
	Import bipolar adjectives from the question import file. More...
	importMatrix (array $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 (string $value)
	Returns the output for a precondition value. More...
	getPreconditionSelectValue (string $default, string $title, string $variable)
	Creates a form property for the precondition value. More...
	setOriginalId (?int $original_id)
	getOriginalId ()
	getMaterial ()
	setSubtype (int $a_subtype)
	getSubtype ()
	__get (string $value)
	__set (string $key, string $value)
	getCopyIds (bool $a_group_by_survey=false)
	hasCopies ()
	stripSlashesAddSpaceFallback (string $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...

Static Public Member Functions
static	getMaxSumScore (int $survey_id)
	Get max sum score for specific survey (and this question type) More...
static	getCompressCompareString (SurveySingleChoiceQuestion $q)
Static Public Member Functions inherited from SurveyQuestion
static	_isComplete (int $question_id)
	Checks whether the question is complete or not. More...
static	_getQuestionType (int $question_id)
	Returns the question type of a question with a given id. More...
static	_getTitle (int $question_id)
	Returns the question title of a question with a given id. More...
static	_getOriginalId (int $question_id, bool $a_return_question_id_if_no_original=true)
	Returns the original id of a question. More...
static	_questionExists (int $question_id)
static	_resolveInternalLink (string $internal_link)
static	_resolveIntLinks (int $question_id)
static	_getInternalLinkHref (string $target="", int $a_parent_ref_id=null)
static	_isWriteable (int $question_id, int $user_id)
	is question writeable by a certain user More...
static	_includeClass (string $question_type, int $gui=0)
	Include the php class file for a given question type. More...
static	_getQuestionTypeName (string $type_tag)
	Return the translation for a given question type. More...
static	_instanciateQuestion (int $question_id)
	Get question object. More...
static	_instanciateQuestionGUI (int $question_id)
	Get question gui object. More...
static	_instanciateQuestionEvaluation (int $question_id, array $a_finished_ids=null)
static	_changeOriginalId (int $a_question_id, int $a_original_id, int $a_object_id)
	Change original id of existing question in db. More...
static	_lookupSurveyObjId (int $a_question_id)
static	lookupObjFi (int $a_qid)
static	getMaxSumScore (int $survey_id)
	Get max sum score for specific survey (and this question type) More...

Data Fields
SurveyCategories	$categories
Data Fields inherited from SurveyQuestion
int	$id
string	$title
string	$description
int	$owner
string	$author
array	$materials
int	$survey_id
int	$obj_id
string	$questiontext
bool	$obligatory
ilLanguage	$lng
int	$orientation
array	$material
bool	$complete

Protected Member Functions
	isSumScoreValid (int $nr_answer_records)

Additional Inherited Members
Protected Attributes inherited from SurveyQuestion
int	$original_id
ILIAS SurveyQuestionPool Editing EditSessionRepository	$edit_manager
ilObjUser	$user
ilDBInterface	$db
array	$cumulated
ilLogger	$log
ILIAS SurveyQuestionPool Export ImportSessionRepository	$import_manager

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 SingleChoice survey question

The SurveySingleChoiceQuestion class defines and encapsulates basic methods and attributes for single 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

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

Constructor & Destructor Documentation

__construct()

SurveySingleChoiceQuestion::__construct	(	string	$title = "",
		string	$description = "",
		string	$author = "",
		string	$questiontext = "",
		int	$owner = -1,
		int	$orientation = 1
	)

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

      {
        global $DIC;
 
        $this->db = $DIC->database();
        $this->user = $DIC->user();
        $this->lng = $DIC->language();
        parent::__construct($title, $description, $author, $questiontext, $owner);
 
        $this->orientation = $orientation;
        $this->categories = new SurveyCategories();
    }

References SurveyQuestion\$author, SurveyQuestion\$description, $DIC, SurveyQuestion\$orientation, SurveyQuestion\$owner, SurveyQuestion\$questiontext, SurveyQuestion\$title, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

addPhrase()

SurveySingleChoiceQuestion::addPhrase

(

int

$phrase_id

)

Adds a phrase to the question.

Definition at line 75 of file class.SurveySingleChoiceQuestion.php.

                                             : void
    {
        $ilUser = $this->user;
        $ilDB = $this->db;
 
        $result = $ilDB->queryF(
            "SELECT svy_category.* FROM svy_category, svy_phrase_cat WHERE svy_phrase_cat.category_fi = svy_category.category_id AND svy_phrase_cat.phrase_fi = %s AND (svy_category.owner_fi = 0 OR svy_category.owner_fi = %s) ORDER BY svy_phrase_cat.sequence",
            array('integer', 'integer'),
            array($phrase_id, $ilUser->getId())
        );
        while ($row = $ilDB->fetchAssoc($result)) {
            $neutral = $row["neutral"];
            if ((int) $row["defaultvalue"] === 1 && (int) $row["owner_fi"] === 0) {
                $this->categories->addCategory($this->lng->txt($row["title"]), 0, $neutral);
            } else {
                $this->categories->addCategory($row["title"], 0, $neutral);
            }
        }
    }

References SurveyQuestion\$db, $ilDB, $ilUser, SurveyQuestion\$user, and ILIAS\Repository\lng().

Here is the call graph for this function:

addStandardNumbers()

SurveySingleChoiceQuestion::addStandardNumbers	(	int	$lower_limit,
		int	$upper_limit
	)

Adds standard numbers as categories.

Definition at line 323 of file class.SurveySingleChoiceQuestion.php.

     : void {
        for ($i = $lower_limit; $i <= $upper_limit; $i++) {
            $this->categories->addCategory($i);
        }
    }

References $i.

checkUserInput()

SurveySingleChoiceQuestion::checkUserInput	(	array	$post_data,
		int	$survey_id
	)

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

Definition at line 409 of file class.SurveySingleChoiceQuestion.php.

     : string {
        $entered_value = $post_data[$this->getId() . "_value"] ?? "";
 
        $this->log->debug("Entered value = " . $entered_value);
 
        if ((!$this->getObligatory()) && (strlen($entered_value) == 0)) {
            return "";
        }
 
        if (strlen($entered_value) == 0) {
            return $this->lng->txt("question_not_checked");
        }
 
        for ($i = 0; $i < $this->categories->getCategoryCount(); $i++) {
            $cat = $this->categories->getCategory($i);
            if ($cat->other) {
                if ($i == $entered_value) {
                    if (array_key_exists($this->getId() . "_" . $entered_value . "_other", $post_data) && !strlen($post_data[$this->getId() . "_" . $entered_value . "_other"])) {
                        return $this->lng->txt("question_mr_no_other_answer");
                    }
                } elseif (strlen($post_data[$this->getId() . "_" . $i . "_other"] ?? "")) {
                    return $this->lng->txt("question_sr_no_other_answer_checked");
                }
            }
        }
 
        return "";
    }

getAdditionalTableName()

SurveySingleChoiceQuestion::getAdditionalTableName

(

)

Definition at line 374 of file class.SurveySingleChoiceQuestion.php.

                                            : string
    {
        return "svy_qst_sc";
    }

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

Here is the caller graph for this function:

getAvailableRelations()

SurveySingleChoiceQuestion::getAvailableRelations

(

)

Returns the available relations for the question.

Reimplemented from SurveyQuestion.

Definition at line 499 of file class.SurveySingleChoiceQuestion.php.

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

getCategories()

SurveySingleChoiceQuestion::getCategories

(

)

Definition at line 545 of file class.SurveySingleChoiceQuestion.php.

                                   : SurveyCategories
    {
        return $this->categories;
    }

getCategoriesForPhrase()

SurveySingleChoiceQuestion::getCategoriesForPhrase

(

int

$phrase_id

)

Gets the available categories for a given phrase.

Definition at line 53 of file class.SurveySingleChoiceQuestion.php.

                                                          : array
    {
        $ilDB = $this->db;
        $categories = array();
        $result = $ilDB->queryF(
            "SELECT svy_category.* FROM svy_category, svy_phrase_cat WHERE svy_phrase_cat.category_fi = svy_category.category_id AND svy_phrase_cat.phrase_fi = %s ORDER BY svy_phrase_cat.sequence",
            array('integer'),
            array($phrase_id)
        );
        while ($row = $ilDB->fetchAssoc($result)) {
            if ((int) $row["defaultvalue"] === 1 && (int) $row["owner_fi"] === 0) {
                $categories[$row["category_id"]] = $this->lng->txt($row["title"]);
            } else {
                $categories[$row["category_id"]] = $row["title"];
            }
        }
        return $categories;
    }

References $categories, SurveyQuestion\$db, $ilDB, and ILIAS\Repository\lng().

Here is the call graph for this function:

getCompressCompareString()

static SurveySingleChoiceQuestion::getCompressCompareString ( SurveySingleChoiceQuestion  $q )

static

Definition at line 594 of file class.SurveySingleChoiceQuestion.php.

     : string {
        $str = "";
        for ($i = 0; $i < $q->categories->getCategoryCount(); $i++) {
            $cat = $q->categories->getCategory($i);
            $str .= ":" . $cat->scale . ":" . $cat->title;
        }
        return $str;
    }

References $i.

getMaxSumScore()

static SurveySingleChoiceQuestion::getMaxSumScore ( int  $survey_id )

static

Get max sum score for specific survey (and this question type)

Reimplemented from SurveyQuestion.

Definition at line 550 of file class.SurveySingleChoiceQuestion.php.

                                                         : int
    {
        global $DIC;
 
        // we need max scale values of single choice questions (type 2)
        $db = $DIC->database();
        $set = $db->queryF(
            "SELECT SUM(max_sum_score) sum_sum_score FROM (SELECT MAX(scale) max_sum_score FROM svy_svy_qst sq " .
            "JOIN svy_question q ON (sq.question_fi = q.question_id) " .
            "JOIN svy_variable v ON (v.question_fi = q.question_id) " .
            "WHERE sq.survey_fi  = %s AND q.questiontype_fi = %s " .
            "GROUP BY (q.question_id)) x",
            ["integer", "integer"],
            [$survey_id, 2]
        );
        $rec = $db->fetchAssoc($set);
        return (int) $rec["sum_sum_score"];
    }

References $DIC.

getPreconditionOptions()

SurveySingleChoiceQuestion::getPreconditionOptions

(

)

Returns the options for preconditions.

Reimplemented from SurveyQuestion.

Definition at line 504 of file class.SurveySingleChoiceQuestion.php.

                                            : array
    {
        $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 $i.

getPreconditionSelectValue()

SurveySingleChoiceQuestion::getPreconditionSelectValue	(	string	$default,
		string	$title,
		string	$variable
	)

Creates a form property for the precondition value.

Reimplemented from SurveyQuestion.

Definition at line 514 of file class.SurveySingleChoiceQuestion.php.

     : ?ilFormPropertyGUI {
        $step3 = new ilSelectInputGUI($title, $variable);
        $options = $this->getPreconditionOptions();
        $step3->setOptions($options);
        $step3->setValue($default);
        return $step3;
    }

getPreconditionValueOutput()

SurveySingleChoiceQuestion::getPreconditionValueOutput

(

string

$value

)

Returns the output for a precondition value.

Parameters

string

$value

The precondition value

Returns

string The output of the precondition value

Reimplemented from SurveyQuestion.

Definition at line 526 of file class.SurveySingleChoiceQuestion.php.

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

getQuestionDataArray()

SurveySingleChoiceQuestion::getQuestionDataArray

(

int

$id

)

Returns the question data.

Reimplemented from SurveyQuestion.

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

                                                 : array
    {
        $ilDB = $this->db;
 
        $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\$db, SurveyQuestion\$id, $ilDB, and getAdditionalTableName().

Here is the call graph for this function:

getQuestionType()

SurveySingleChoiceQuestion::getQuestionType

(

)

Reimplemented from SurveyQuestion.

Definition at line 369 of file class.SurveySingleChoiceQuestion.php.

                                     : string
    {
        return "SurveySingleChoiceQuestion";
    }

getWorkingDataFromUserInput()

SurveySingleChoiceQuestion::getWorkingDataFromUserInput

(

array

$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

Reimplemented from SurveyQuestion.

Definition at line 379 of file class.SurveySingleChoiceQuestion.php.

     : array {
        $entered_value = $post_data[$this->getId() . "_value"] ?? "";
        $data = array();
        if (strlen($entered_value)) {
            $data[] = array("value" => $entered_value,
                            "textanswer" => $post_data[$this->getId() . '_' . $entered_value . '_other'] ?? ""
            );
        }
        for ($i = 0; $i < $this->categories->getCategoryCount(); $i++) {
            $cat = $this->categories->getCategory($i);
            if ($cat->other) {
                if ($i != $entered_value) {
                    if (strlen($post_data[$this->getId() . "_" . $i . "_other"] ?? "")) {
                        $data[] = array("value" => $i,
                                        "textanswer" => $post_data[$this->getId() . '_' . $i . '_other'] ?? "",
                                        "uncheck" => true
                        );
                    }
                }
            }
        }
        return $data;
    }

importAdditionalMetadata()

SurveySingleChoiceQuestion::importAdditionalMetadata

(

array

$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.

Reimplemented from SurveyQuestion.

Definition at line 309 of file class.SurveySingleChoiceQuestion.php.

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

References ILIAS\LTI\ToolProvider\$key.

importResponses()

SurveySingleChoiceQuestion::importResponses

(

array

$a_data

)

Import response data from the question import file.

Reimplemented from SurveyQuestion.

Definition at line 477 of file class.SurveySingleChoiceQuestion.php.

                                                  : void
    {
        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, and $id.

insertXML()

SurveySingleChoiceQuestion::insertXML	(	ilXmlWriter	$a_xml_writer,
		bool	$a_include_header = true
	)

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

     : void {
        $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_single", $attrs);
            $this->addMaterialTag($a_xml_writer, $this->categories->getCategory($i)->title);
            $a_xml_writer->xmlEndTag("response_single");
        }
 
        $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->xmlEndTag("metadata");
 
        $a_xml_writer->xmlEndTag("question");
    }

isComplete()

SurveySingleChoiceQuestion::isComplete

(

)

Reimplemented from SurveyQuestion.

Definition at line 150 of file class.SurveySingleChoiceQuestion.php.

                                : bool
    {
        if (
            $this->getTitle() !== '' &&
            $this->getAuthor() !== '' &&
            $this->getQuestiontext() !== '' &&
            $this->categories->getCategoryCount()
        ) {
            return true;
        } else {
            return false;
        }
    }

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

Here is the call graph for this function:

isSumScoreValid()

SurveySingleChoiceQuestion::isSumScoreValid ( int  $nr_answer_records )

protected

Definition at line 569 of file class.SurveySingleChoiceQuestion.php.

                                                              : bool
    {
        if ($nr_answer_records == 1) {
            return true;
        }
        return false;
    }

loadFromDb()

SurveySingleChoiceQuestion::loadFromDb

(

int

$question_id

)

load question data into object note: this base implementation only loads the material data

Reimplemented from SurveyQuestion.

Definition at line 111 of file class.SurveySingleChoiceQuestion.php.

                                                : void
    {
        $ilDB = $this->db;
 
        $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($question_id)
        );
        if ($result->numRows() === 1) {
            $data = $ilDB->fetchAssoc($result);
            $this->setId((int) $data["question_id"]);
            $this->setTitle((string) $data["title"]);
            $this->label = (string) $data['label'];
            $this->setDescription((string) $data["description"]);
            $this->setObjId((int) $data["obj_fi"]);
            $this->setAuthor((string) $data["author"]);
            $this->setOwner((int) $data["owner_fi"]);
            $this->setQuestiontext(ilRTE::_replaceMediaObjectImageSrc((string) $data["questiontext"], 1));
            $this->setObligatory((bool) $data["obligatory"]);
            $this->setComplete((bool) $data["complete"]);
            $this->setOriginalId((int) $data["original_id"]);
            $this->setOrientation((int) $data["orientation"]);
 
            $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($question_id)
            );
            if ($result->numRows() > 0) {
                while ($data = $ilDB->fetchAssoc($result)) {
                    $this->categories->addCategory((string) $data["title"], (int) $data["other"], (int) $data["neutral"], null, ($data['scale']) ?: ($data['sequence'] + 1));
                }
            }
        }
        parent::loadFromDb($question_id);
    }

References $data, SurveyQuestion\$db, $ilDB, 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()

SurveySingleChoiceQuestion::saveCategoriesToDb

(

)

Definition at line 191 of file class.SurveySingleChoiceQuestion.php.

                                        : void
    {
        $ilDB = $this->db;
 
        $this->log->debug("DELETE from svy_variable before the INSERT into svy_variable. if scale > 0  we get scale value else we get null");
 
        $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())
            );
 
            $debug_scale = ($cat->scale > 0) ? $cat->scale : null;
            $this->log->debug("INSERT INTO svy_variable category_fi= " . $category_id . " question_fi= " . $this->getId() . " value1= " . ($i + 1) . " other= " . $cat->other . " sequence= " . $i . " scale =" . $debug_scale);
        }
        $this->saveCompletionStatus();
    }

References SurveyQuestion\$db, $i, $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:

savePhrase()

SurveySingleChoiceQuestion::savePhrase

(

string

$title

)

Saves a set of categories to a default phrase note: data comes from session.

Definition at line 336 of file class.SurveySingleChoiceQuestion.php.

                                             : void
    {
        $ilUser = $this->user;
        $ilDB = $this->db;
 
        $next_id = $ilDB->nextId('svy_phrase');
        $affectedRows = $ilDB->manipulateF(
            "INSERT INTO svy_phrase (phrase_id, title, defaultvalue, owner_fi, tstamp) VALUES (%s, %s, %s, %s, %s)",
            array('integer','text','text','integer','integer'),
            array($next_id, $title, 1, $ilUser->getId(), time())
        );
        $phrase_id = $next_id;
 
        $counter = 1;
        $phrase_data = $this->edit_manager->getPhraseData();
        foreach ($phrase_data as $data) {
            $next_id = $ilDB->nextId('svy_category');
            $affectedRows = $ilDB->manipulateF(
                "INSERT INTO svy_category (category_id, title, defaultvalue, owner_fi, tstamp, neutral) VALUES (%s, %s, %s, %s, %s, %s)",
                array('integer','text','text','integer','integer','text'),
                array($next_id, $data['answer'], 1, $ilUser->getId(), time(), $data['neutral'])
            );
            $category_id = $next_id;
            $next_id = $ilDB->nextId('svy_phrase_cat');
            $affectedRows = $ilDB->manipulateF(
                "INSERT INTO svy_phrase_cat (phrase_category_id, phrase_fi, category_fi, sequence, other, scale) VALUES (%s, %s, %s, %s, %s, %s)",
                array('integer', 'integer', 'integer','integer', 'integer', 'integer'),
                array($next_id, $phrase_id, $category_id, $counter, ($data['other']) ? 1 : 0, $data['scale'])
            );
            $counter++;
        }
    }

References $data, $ilDB, and $ilUser.

saveToDb()

SurveySingleChoiceQuestion::saveToDb

(

int

$original_id = 0

)

Saves a SurveyQuestion object to a database.

Reimplemented from SurveyQuestion.

Definition at line 164 of file class.SurveySingleChoiceQuestion.php.

                                                  : int
    {
        $ilDB = $this->db;
 
        $affectedRows = parent::saveToDb($original_id);
        if ($affectedRows === 1) {
            $this->log->debug("Before save Category-> DELETE from svy_qst_sc WHERE question_fi = " . $this->getId() . " AND INSERT again the same id and orientation in svy_qst_sc");
            $ilDB->manipulateF(
                "DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
                array('integer'),
                array($this->getId())
            );
            $ilDB->manipulateF(
                "INSERT INTO " . $this->getAdditionalTableName() . " (question_fi, orientation) VALUES (%s, %s)",
                array('integer', 'text'),
                array(
                    $this->getId(),
                    $this->getOrientation()
                )
            );
 
            $this->saveMaterial();
            $this->saveCategoriesToDb();
        }
        return $affectedRows;
    }

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

Here is the call graph for this function:

saveUserInput()

SurveySingleChoiceQuestion::saveUserInput	(	array	$post_data,
		int	$active_id,
		bool	$a_return = false
	)

Definition at line 441 of file class.SurveySingleChoiceQuestion.php.

     : ?array {
        $ilDB = $this->db;
 
        $entered_value = $post_data[$this->getId() . "_value"] ?? "";
 
        if ($a_return) {
            return array(array("value" => $entered_value,
                "textanswer" => $post_data[$this->getId() . "_" . $entered_value . "_other"] ?? ""));
        }
        if (strlen($entered_value) == 0) {
            return null;
        }
 
        $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", isset($post_data[$this->getId() . "_" . $entered_value . "_other"]) ?
            $this->stripSlashesAddSpaceFallback($post_data[$this->getId() . "_" . $entered_value . "_other"]) : null);
        $fields['tstamp'] = array("integer", time());
 
        $affectedRows = $ilDB->insert("svy_answer", $fields);
 
        $debug_value = (strlen($entered_value)) ? $entered_value : "NULL";
        $debug_answer = $post_data[$this->getId() . "_" . $entered_value . "_other"] ?? "NULL";
        $this->log->debug("INSERT svy_answer answer_id=" . $next_id . " question_fi=" . $this->getId() . " active_fi=" . $active_id . " value=" . $debug_value . " textanswer=" . $debug_answer);
        return null;
    }

References ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

toXML()

SurveySingleChoiceQuestion::toXML	(	bool	$a_include_header = true,
		bool	$obligatory_state = false
	)

Definition at line 219 of file class.SurveySingleChoiceQuestion.php.

     : string {
        $a_xml_writer = new ilXmlWriter();
        $a_xml_writer->xmlHeader();
        $this->insertXML($a_xml_writer, $a_include_header);
        $xml = $a_xml_writer->xmlDumpMem(false);
        if (!$a_include_header) {
            $pos = strpos($xml, "?>");
            $xml = substr($xml, $pos + 2);
        }
        return $xml;
    }

usableForPrecondition()

SurveySingleChoiceQuestion::usableForPrecondition

(

)

Returns if the question is usable for preconditions.

Reimplemented from SurveyQuestion.

Definition at line 494 of file class.SurveySingleChoiceQuestion.php.

                                           : bool
    {
        return true;
    }

Field Documentation

$categories

SurveyCategories SurveySingleChoiceQuestion::$categories

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

Referenced by getCategoriesForPhrase().

---

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

• Modules/SurveyQuestionPool/Questions/class.SurveySingleChoiceQuestion.php