SurveySingleChoiceQuestion Class Reference

SingleChoice survey question. More...

Inheritance diagram for SurveySingleChoiceQuestion:

Collaboration diagram for SurveySingleChoiceQuestion:

Public Member Functions
	__construct ($title="", $description="", $author="", $questiontext="", $owner=-1, $orientation=1)
	SurveySingleChoiceQuestion constructor. More...
&	getCategoriesForPhrase ($phrase_id)
	Gets the available categories for a given phrase. More...
	addPhrase ($phrase_id)
	Adds a phrase to the question. More...
	getQuestionDataArray ($id)
	Returns the question data fields from the database. More...
	loadFromDb ($id)
	Loads a SurveySingleChoiceQuestion object from the database. More...
	isComplete ()
	Returns true if the question is complete for use. More...
	saveToDb ($original_id="")
	Saves a SurveySingleChoiceQuestion 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...
	importAdditionalMetadata ($a_meta)
	Import additional meta data from the question import file. More...
	addStandardNumbers ($lower_limit, $upper_limit)
	Adds standard numbers as categories. More...
	savePhrase ($title)
	Saves a set of categories to a default phrase. 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)
	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
	$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
	$user
	$db
	$cumulated
	An array containing the cumulated results of the question for a given survey. More...
	$log

Detailed Description

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 13 of file class.SurveySingleChoiceQuestion.php.

Constructor & Destructor Documentation

__construct()

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

SurveySingleChoiceQuestion constructor.

The constructor takes possible arguments an creates an instance of the SurveySingleChoiceQuestion 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 public

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

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

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

Here is the call graph for this function:

Member Function Documentation

addPhrase()

SurveySingleChoiceQuestion::addPhrase

(

$phrase_id

)

Adds a phrase to the question.

Parameters

integer

$phrase_id

The database id of the given phrase public

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

References SurveyQuestion\$db, $ilDB, $ilUser, $result, and SurveyQuestion\$user.

    {
        $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 (($row["defaultvalue"] == 1) and ($row["owner_fi"] == 0)) {
                $this->categories->addCategory($this->lng->txt($row["title"]), 0, $neutral);
            } else {
                $this->categories->addCategory($row["title"], 0, $neutral);
            }
        }
    }

addStandardNumbers()

SurveySingleChoiceQuestion::addStandardNumbers	(		$lower_limit,
			$upper_limit
	)

Adds standard numbers as categories.

Parameters

integer	$lower_limit	The lower limit
integer	$upper_limit	The upper limit public

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

References $i.

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

checkUserInput()

SurveySingleChoiceQuestion::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 public

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

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

    {
        $entered_value = $post_data[$this->getId() . "_value"];

        $this->log->debug("Entered value = " . $entered_value);
        
        if ((!$this->getObligatory($survey_id)) && (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");
                    }
                } else {
                    if (strlen($post_data[$this->getId() . "_" . $i . "_other"])) {
                        return $this->lng->txt("question_sr_no_other_answer_checked");
                    }
                }
            }
        }

        return "";
    }

Here is the call graph for this function:

getAdditionalTableName()

SurveySingleChoiceQuestion::getAdditionalTableName

(

)

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

Returns

string The additional table name public

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

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

    {
        return "svy_qst_sc";
    }

Here is the caller graph for this function:

getAvailableRelations()

SurveySingleChoiceQuestion::getAvailableRelations

(

)

Returns the available relations for the question.

Returns

array An array containing the available relations public

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

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

getCategories()

SurveySingleChoiceQuestion::getCategories

(

)

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

References $categories.

    {
        return $this->categories;
    }

getCategoriesForPhrase()

& SurveySingleChoiceQuestion::getCategoriesForPhrase

(

$phrase_id

)

Gets the available categories for a given phrase.

Parameters

integer

$phrase_id

The database id of the given phrase

Returns

array All available categories public

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

References $categories, SurveyQuestion\$db, $ilDB, and $result.

    {
        $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 (($row["defaultvalue"] == 1) and ($row["owner_fi"] == 0)) {
                $categories[$row["category_id"]] = $this->lng->txt($row["title"]);
            } else {
                $categories[$row["category_id"]] = $row["title"];
            }
        }
        return $categories;
    }

getPreconditionOptions()

SurveySingleChoiceQuestion::getPreconditionOptions

(

)

Returns the options for preconditions.

Returns

array

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

References $i, and SurveyQuestion\$lng.

Referenced by getPreconditionSelectValue().

    {
        $lng = $this->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;
    }

Here is the caller graph for this function:

getPreconditionSelectValue()

SurveySingleChoiceQuestion::getPreconditionSelectValue	(		$default = "",
			$title,
			$variable
	)

Creates a form property for the precondition value.

Returns

The ILIAS form element public

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

References SurveyQuestion\$title, and getPreconditionOptions().

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

Here is the call graph for this function:

getPreconditionValueOutput()

SurveySingleChoiceQuestion::getPreconditionValueOutput

(

$value

)

Returns the output for a precondition value.

Parameters

string

$value

The precondition value

Returns

string The output of the precondition value public

Definition at line 621 of file class.SurveySingleChoiceQuestion.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()

SurveySingleChoiceQuestion::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 public

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

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

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

Here is the call graph for this function:

getQuestionType()

SurveySingleChoiceQuestion::getQuestionType

(

)

Returns the question type of the question.

Returns

integer The question type of the question public

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

    {
        return "SurveySingleChoiceQuestion";
    }

getWorkingDataFromUserInput()

& SurveySingleChoiceQuestion::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 public

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

References $data, $i, and SurveyQuestion\getId().

    {
        $entered_value = $post_data[$this->getId() . "_value"];
        $data = array();
        if (strlen($entered_value)) {
            array_push($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"])) {
                        array_push($data, array("value" => $i, "textanswer" => $post_data[$this->getId() . '_' . $i . '_other'], "uncheck" => true));
                    }
                }
            }
        }
        return $data;
    }

Here is the call graph for this function:

importAdditionalMetadata()

SurveySingleChoiceQuestion::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 public

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

References SurveyQuestion\setOrientation().

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

Here is the call graph for this function:

importResponses()

SurveySingleChoiceQuestion::importResponses

(

$a_data

)

Import response data from the question import file.

Returns

array $a_data Array containing the response data public

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

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

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

insertXML()

SurveySingleChoiceQuestion::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 public

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

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

Referenced by toXML().

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

Here is the call graph for this function:

Here is the caller graph for this function:

isComplete()

SurveySingleChoiceQuestion::isComplete

(

)

Returns true if the question is complete for use.

Returns

boolean True if the question is complete for use, otherwise false public

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

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

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

Here is the call graph for this function:

loadFromDb()

SurveySingleChoiceQuestion::loadFromDb

(

$id

)

Loads a SurveySingleChoiceQuestion object from the database.

Parameters

integer

$id

The database id of the single choice survey question public

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

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

    {
        $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($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"]);
            $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->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);
    }

Here is the call graph for this function:

saveCategoriesToDb()

SurveySingleChoiceQuestion::saveCategoriesToDb

(

)

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

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

Referenced by saveToDb().

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

Here is the call graph for this function:

Here is the caller graph for this function:

savePhrase()

SurveySingleChoiceQuestion::savePhrase

(

$title

)

Saves a set of categories to a default phrase.

Parameters

array	$phrases	The database ids of the seleted phrases
string	$title	The title of the default phrase public

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

References $_SESSION, $data, SurveyQuestion\$db, $ilDB, $ilUser, SurveyQuestion\$title, and SurveyQuestion\$user.

    {
        $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;
        foreach ($_SESSION['save_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++;
        }
    }

saveToDb()

SurveySingleChoiceQuestion::saveToDb

(

$original_id = ""

)

Saves a SurveySingleChoiceQuestion object to a database.

public

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

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

    {
        $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");
            $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) VALUES (%s, %s)",
                array('integer', 'text'),
                array(
                    $this->getId(),
                    $this->getOrientation()
                )
            );

            $this->saveMaterial();
            $this->saveCategoriesToDb();
        }
    }

Here is the call graph for this function:

saveUserInput()

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

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

References SurveyQuestion\$db, $ilDB, SurveyQuestion\getId(), and SurveyQuestion\stripSlashesAddSpaceFallback().

    {
        $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;
        }
        
        $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"]) ?
            $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"]) ? $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);
    }

Here is the call graph for this function:

toXML()

SurveySingleChoiceQuestion::toXML	(		$a_include_header = true,
			$obligatory_state = ""
	)

Returns an xml representation of the question.

Returns

string The xml representation of the question public

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

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

    {
        $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;
    }

Here is the call graph for this function:

usableForPrecondition()

SurveySingleChoiceQuestion::usableForPrecondition

(

)

Returns if the question is usable for preconditions.

Returns

boolean TRUE if the question is usable for a precondition, FALSE otherwise public

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

    {
        return true;
    }

Field Documentation

$categories

SurveySingleChoiceQuestion::$categories

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

Referenced by getCategories(), and getCategoriesForPhrase().

---

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

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