SurveyQuestion Class Reference

Basic class for all survey question types. More...

Inheritance diagram for SurveyQuestion:

Collaboration diagram for SurveyQuestion:

Public Member Functions
	__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...

Static Public Member Functions
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...
static	getMaxSumScore (int $survey_id)
	Get max sum score for specific survey (and this question type) More...

Data Fields
	$id
	$title
	$description
	$owner
	$author
	$materials
	$survey_id
	$obj_id
	$questiontext
	$obligatory
	$lng
	$orientation
	$material
	$complete

Protected Attributes
	$user
	$db
	$cumulated
	An array containing the cumulated results of the question for a given survey. More...
	$log

Private Attributes
	$arrData
	data array containing the question data More...

Detailed Description

Basic class for all survey question types.

The SurveyQuestion class defines and encapsulates basic methods and attributes for survey question types to be used for all parent classes.

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 34 of file class.SurveyQuestion.php.

Constructor & Destructor Documentation

__construct()

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

SurveyQuestion constructor The constructor takes possible arguments an creates an instance of the SurveyQuestion 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 158 of file class.SurveyQuestion.php.

References $author, $description, $DIC, $ilUser, $lng, $owner, $questiontext, $title, ilLoggerFactory\getLogger(), and user().

    {
        global $DIC;

        $this->user = $DIC->user();
        $this->db = $DIC->database();
        $lng = $DIC->language();
        $ilUser = $DIC->user();

        $this->lng = $lng;
        $this->complete = 0;
        $this->title = $title;
        $this->description = $description;
        $this->questiontext = $questiontext;
        $this->author = $author;
        $this->cumulated = array();
        if (!$this->author) {
            $this->author = $ilUser->fullname;
        }
        $this->owner = $owner;
        if ($this->owner == -1) {
            $this->owner = $ilUser->getId();
        }
        $this->id = -1;
        $this->survey_id = -1;
        $this->obligatory = 1;
        $this->orientation = 0;
        $this->materials = array();
        $this->material = array();
        $this->arrData = array();

        $this->log = ilLoggerFactory::getLogger('svy');
    }

Here is the call graph for this function:

Member Function Documentation

__get()

SurveyQuestion::__get

(

$value

)

Object getter.

Definition at line 2007 of file class.SurveyQuestion.php.

    {
        switch ($value) {
            default:
                if (array_key_exists($value, $this->arrData)) {
                    return $this->arrData[$value];
                } else {
                    return null;
                }
                break;
        }
    }

__set()

SurveyQuestion::__set	(		$key,
			$value
	)

Object setter.

Definition at line 2023 of file class.SurveyQuestion.php.

    {
        switch ($key) {
            default:
                $this->arrData[$key] = $value;
                break;
        }
    }

_changeOriginalId()

static SurveyQuestion::_changeOriginalId (   $a_question_id,   $a_original_id,   $a_object_id  )

static

Change original id of existing question in db.

Parameters

int	$a_question_id
int	$a_original_id
int	$a_object_id

Definition at line 2039 of file class.SurveyQuestion.php.

References $DIC, and $ilDB.

Referenced by ilSurveyEditorGUI\executeCopyQuestionsToPoolObject().

    {
        global $DIC;

        $ilDB = $DIC->database();

        $ilDB->manipulate("UPDATE svy_question" .
            " SET original_id = " . $ilDB->quote($a_original_id, "integer") . "," .
            " obj_fi = " . $ilDB->quote($a_object_id, "integer") .
            " WHERE question_id = " . $ilDB->quote($a_question_id, "integer"));
    }

Here is the caller graph for this function:

_getInternalLinkHref()

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

static

Definition at line 1532 of file class.SurveyQuestion.php.

References $DIC, $ilDB, $target_id, $type, and ilUtil\removeTrailingPathSeparators().

Referenced by SurveyQuestionGUI\getMaterialOutput(), and SurveyQuestionGUI\material().

    {
        global $DIC;

        $ilDB = $DIC->database();
        $linktypes = array(
            "lm" => "LearningModule",
            "pg" => "PageObject",
            "st" => "StructureObject",
            "git" => "GlossaryItem",
            "mob" => "MediaObject"
        );
        $href = "";
        if (preg_match("/il__(\w+)_(\d+)/", $target, $matches)) {
            $type = $matches[1];
            $target_id = $matches[2];
            switch ($linktypes[$matches[1]]) {
                case "LearningModule":
                    $href = ilUtil::removeTrailingPathSeparators(ILIAS_HTTP_PATH) . "/goto.php?target=" . $type . "_" . $target_id;
                    break;
                case "PageObject":
                case "StructureObject":
                    $href = ilUtil::removeTrailingPathSeparators(ILIAS_HTTP_PATH) . "/goto.php?target=" . $type . "_" . $target_id;
                    break;
                case "GlossaryItem":
                    $href = ilUtil::removeTrailingPathSeparators(ILIAS_HTTP_PATH) . "/goto.php?target=" . $type . "_" . $target_id;
                    break;
                case "MediaObject":
                    $href = ilUtil::removeTrailingPathSeparators(ILIAS_HTTP_PATH) . "/ilias.php?baseClass=ilLMPresentationGUI&obj_type=" . $linktypes[$type] . "&cmd=media&ref_id=" . $a_parent_ref_id . "&mob_id=" . $target_id;
                    break;
            }
        }
        return $href;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getOriginalId()

static SurveyQuestion::_getOriginalId (   $question_id,   $a_return_question_id_if_no_original = true  )

static

Returns the original id of a question.

Parameters

integer

$question_id

The database id of the question

Returns

integer The database id of the original question public

Definition at line 1180 of file class.SurveyQuestion.php.

References $DIC, $ilDB, and $result.

Referenced by ilObjSurvey\importObject().

    {
        global $DIC;

        $ilDB = $DIC->database();
        $result = $ilDB->queryF(
            "SELECT * FROM svy_question WHERE question_id = %s",
            array('integer'),
            array($question_id)
        );
        if ($result->numRows() > 0) {
            $row = $ilDB->fetchAssoc($result);
            if ($row["original_id"] > 0) {
                return $row["original_id"];
            } elseif ((bool) $a_return_question_id_if_no_original) { // #12419
                return $row["question_id"];
            }
        } else {
            return "";
        }
    }

Here is the caller graph for this function:

_getQuestionType()

static SurveyQuestion::_getQuestionType (   $question_id )

static

Returns the question type of a question with a given id.

Parameters

integer

$question_id

The database id of the question

Returns

string The question type string private

Definition at line 1120 of file class.SurveyQuestion.php.

References $data, $DIC, $ilDB, and $result.

Referenced by ilObjSurvey\_instanciateQuestion(), ilObjSurveyQuestionPoolGUI\addLocatorItems(), ilObjSurveyGUI\addLocatorItems(), ilSurveyConstraintsGUI\confirmDeleteConstraintsObject(), ilObjSurvey\getConstraints(), and ilObjSurvey\getUserSpecificResults().

    {
        global $DIC;

        $ilDB = $DIC->database();

        if ($question_id < 1) {
            return "";
        }

        $result = $ilDB->queryF(
            "SELECT type_tag FROM svy_question, svy_qtype WHERE svy_question.question_id = %s AND svy_question.questiontype_fi = svy_qtype.questiontype_id",
            array('integer'),
            array($question_id)
        );
        if ($result->numRows() == 1) {
            $data = $ilDB->fetchAssoc($result);
            return $data["type_tag"];
        } else {
            return "";
        }
    }

Here is the caller graph for this function:

_getQuestionTypeName()

static SurveyQuestion::_getQuestionTypeName (   $type_tag )

static

Return the translation for a given question type tag.

Parameters

string

$type_tag

The type tag of the question type public

Definition at line 1671 of file class.SurveyQuestion.php.

References $DIC, $lng, ilPlugin\getPluginObject(), and IL_COMP_MODULE.

Referenced by ilSurveyConstraintsGUI\constraintForm(), ilObjSurveyQuestionPoolGUI\deleteQuestionsObject(), SurveyMatrixQuestionEvaluation\exportResults(), SurveyQuestionEvaluation\exportResults(), ilSurveyEvaluationGUI\exportResultsDetailsExcel(), ilSurveyQuestionsTableGUI\fillRow(), ilSurveyResultsCumulatedTableGUI\getItems(), ilSurveyEditorGUI\removeQuestionsForm(), and ilSurveyEvaluationGUI\renderDetails().

    {
        if (file_exists("./Modules/SurveyQuestionPool/Questions/class." . $type_tag . ".php")) {
            global $DIC;

            $lng = $DIC->language();
            return $lng->txt($type_tag);
        } else {
            global $DIC;

            $ilPluginAdmin = $DIC["ilPluginAdmin"];
            $pl_names = $ilPluginAdmin->getActivePluginsForSlot(IL_COMP_MODULE, "SurveyQuestionPool", "svyq");
            foreach ($pl_names as $pl_name) {
                $pl = ilPlugin::getPluginObject(IL_COMP_MODULE, "SurveyQuestionPool", "svyq", $pl_name);
                if (strcmp($pl->getQuestionType(), $type_tag) == 0) {
                    return $pl->getQuestionTypeTranslation();
                }
            }
        }
        return "";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getTitle()

static SurveyQuestion::_getTitle (   $question_id )

static

Returns the question title of a question with a given id.

Parameters

integer

$question_id

The database id of the question

Returns

string The question title private

Definition at line 1150 of file class.SurveyQuestion.php.

References $data, $DIC, $ilDB, and $result.

Referenced by ilObjSurveyQuestionPoolGUI\addLocatorItems(), ilObjSurveyGUI\addLocatorItems(), ilTermUsagesTableGUI\fillRow(), ilSurveySyncTableGUI\importData(), and ilSurveyEvaluationGUI\renderChartOnly().

    {
        global $DIC;

        $ilDB = $DIC->database();

        if ($question_id < 1) {
            return "";
        }

        $result = $ilDB->queryF(
            "SELECT title FROM svy_question WHERE svy_question.question_id = %s",
            array('integer'),
            array($question_id)
        );
        if ($result->numRows() == 1) {
            $data = $ilDB->fetchAssoc($result);
            return $data["title"];
        } else {
            return "";
        }
    }

Here is the caller graph for this function:

_includeClass()

static SurveyQuestion::_includeClass (   $question_type,   $gui = 0  )

static

Include the php class file for a given question type.

Parameters

string

$question_type

The type tag of the question type

Returns

integer 0 if the class should be included, 1 if the GUI class should be included public

Definition at line 1639 of file class.SurveyQuestion.php.

References $DIC, $type, ilPlugin\getPluginObject(), and IL_COMP_MODULE.

Referenced by SurveyQuestionGUI\_getQuestionGUI(), ilObjSurvey\_instanciateQuestion(), ilSurveyConstraintsGUI\confirmDeleteConstraintsObject(), ilSurveyConstraintsGUI\constraintForm(), ilObjSurvey\getConstraints(), ilObjSurvey\getUserSpecificResults(), SurveyImportParser\handlerBeginTag(), and ilObjSurveyQuestionPool\toXML().

    {
        $type = $question_type;
        if ($gui == 1) {
            $type .= "GUI";
        } elseif ($gui == 2) {
            $type .= "Evaluation";
        }
        if (file_exists("./Modules/SurveyQuestionPool/Questions/class." . $type . ".php")) {
            return true;
        } else {
            global $DIC;

            $ilPluginAdmin = $DIC["ilPluginAdmin"];
            $pl_names = $ilPluginAdmin->getActivePluginsForSlot(IL_COMP_MODULE, "SurveyQuestionPool", "svyq");
            foreach ($pl_names as $pl_name) {
                $pl = ilPlugin::getPluginObject(IL_COMP_MODULE, "SurveyQuestionPool", "svyq", $pl_name);
                if (strcmp($pl->getQuestionType(), $question_type) == 0) {
                    $pl->includeClass("class." . $type . ".php");
                    return true;
                }
            }
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_instanciateQuestion()

static SurveyQuestion::_instanciateQuestion (   $question_id )

static

Creates an instance of a question with a given question id.

Parameters

integer

$question_id

The question id

Returns

object The question instance public

Definition at line 1701 of file class.SurveyQuestion.php.

Referenced by SurveySingleChoiceQuestion\compressable(), ilSurveySkill\determineMaxScale(), ilObjSurveyQuestionPool\duplicateQuestion(), ilObjMediaObject\getParentObjectIdForUsage(), ilObjSurvey\importObject(), ilSurveyImporter\importXmlRepresentation(), ilObjSurveyQuestionPool\removeQuestion(), and ilSurveyExecutionGUI\saveActiveQuestionData().

    {
        $question_type = self::_getQuestionType($question_id);
        if ($question_type) {
            self::_includeClass($question_type);
            $question = new $question_type();
            $question->loadFromDb($question_id);
            return $question;
        }
    }

Here is the caller graph for this function:

_instanciateQuestionEvaluation()

static SurveyQuestion::_instanciateQuestionEvaluation (   $question_id, array  $a_finished_ids = null  )

static

Creates an instance of a question evaluation with a given question id.

Parameters

integer

$question_id

The question id

Returns

object The question evaluation instance public

Definition at line 1737 of file class.SurveyQuestion.php.

Referenced by ilSurveyEvaluationGUI\evaluation(), ilSurveyEvaluationGUI\exportCumulatedResults(), ilSurveyEvaluationGUI\exportEvaluationUser(), ilSurveyEvaluationGUI\getSumScores(), ilObjSurvey\getUserSpecificResults(), ilSurveyEvaluationGUI\parseUserSpecificResults(), and ilSurveyEvaluationGUI\renderChartOnly().

    {
        $question = self::_instanciateQuestion($question_id);
        if ($question) {
            $question_type = self::_getQuestionType($question_id);
            self::_includeClass($question_type, 2);
            $class = $question_type . "Evaluation";
            $ev = new $class($question, $a_finished_ids);
            return $ev;
        }
    }

Here is the caller graph for this function:

_instanciateQuestionGUI()

static SurveyQuestion::_instanciateQuestionGUI (   $question_id )

static

Creates an instance of a question GUI with a given question id.

Parameters

integer

$question_id

The question id

Returns

object The question GUI instance public

Definition at line 1719 of file class.SurveyQuestion.php.

    {
        $question_type = self::_getQuestionType($question_id);
        if ($question_type) {
            self::_includeClass($question_type, 1);
            $guitype = $question_type . "GUI";
            $question = new $guitype($question_id);
            return $question;
        }
    }

_isComplete()

static SurveyQuestion::_isComplete (   $question_id )

static

Checks whether the question is complete or not.

Returns

boolean TRUE if the question is complete, FALSE otherwise public

Definition at line 693 of file class.SurveyQuestion.php.

References $DIC, $ilDB, and $result.

Referenced by ilSurveyPageGUI\insertNewQuestion(), ilObjSurvey\insertQuestion(), and SurveyQuestionGUI\save().

    {
        global $DIC;

        $ilDB = $DIC->database();

        $result = $ilDB->queryF(
            "SELECT complete FROM svy_question WHERE question_id = %s",
            array('integer'),
            array($question_id)
        );
        if ($result->numRows()) {
            $row = $ilDB->fetchAssoc($result);
            if ($row["complete"] == 1) {
                return true;
            }
        }
        return false;
    }

Here is the caller graph for this function:

_isWriteable()

static SurveyQuestion::_isWriteable (   $question_id,   $user_id  )

static

Returns true if the question is writeable by a certain user.

Parameters

integer	$question_id	The database id of the question
integer	$user_id	The database id of the user

Returns

boolean True, if the question exists, otherwise False public

Definition at line 1575 of file class.SurveyQuestion.php.

References $DIC, $ilDB, $result, and ilObjSurveyQuestionPool\_isWriteable().

Referenced by SurveyQuestionGUI\save().

    {
        global $DIC;

        $ilDB = $DIC->database();

        if (($question_id < 1) || ($user_id < 1)) {
            return false;
        }
        
        $result = $ilDB->queryF(
            "SELECT obj_fi FROM svy_question WHERE question_id = %s",
            array('integer'),
            array($question_id)
        );
        if ($result->numRows() == 1) {
            $row = $ilDB->fetchAssoc($result);
            $qpl_object_id = $row["obj_fi"];
            return ilObjSurveyQuestionPool::_isWriteable($qpl_object_id, $user_id);
        } else {
            return false;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_lookupSurveyObjId()

static SurveyQuestion::_lookupSurveyObjId (   $a_question_id )

static

Definition at line 2076 of file class.SurveyQuestion.php.

References $DIC, and $ilDB.

Referenced by ilObjMediaObject\getParentObjectIdForUsage().

    {
        global $DIC;

        $ilDB = $DIC->database();
        
        $set = $ilDB->query("SELECT svy_svy.obj_fi FROM svy_svy_qst" .
            " JOIN svy_svy ON (svy_svy.survey_id = svy_svy_qst.survey_fi)" .
            " WHERE svy_svy_qst.question_fi = " . $ilDB->quote($a_question_id, "integer"));
        $row = $ilDB->fetchAssoc($set);
        if ($ilDB->numRows($set)) {
            return $row["obj_fi"];
        }
    }

Here is the caller graph for this function:

_questionExists()

static SurveyQuestion::_questionExists (   $question_id )

static

Returns true if the question already exists in the database.

Parameters

integer

$question_id

The database id of the question

Returns

boolean True, if the question exists, otherwise False public

Definition at line 1290 of file class.SurveyQuestion.php.

References $DIC, $ilDB, and $result.

Referenced by ilSurveySkill\read(), and SurveyQuestionGUI\save().

    {
        global $DIC;

        $ilDB = $DIC->database();

        if ($question_id < 1) {
            return false;
        }
        
        $result = $ilDB->queryF(
            "SELECT question_id FROM svy_question WHERE question_id = %s",
            array('integer'),
            array($question_id)
        );
        return ($result->numRows() == 1) ? true : false;
    }

Here is the caller graph for this function:

_resolveInternalLink()

static SurveyQuestion::_resolveInternalLink (   $internal_link )

static

Definition at line 1456 of file class.SurveyQuestion.php.

References ilInternalLink\_getIdForImportId(), and ilLMObject\_getIdForImportId().

    {
        if (preg_match("/il_(\d+)_(\w+)_(\d+)/", $internal_link, $matches)) {
            switch ($matches[2]) {
                case "lm":
                    $resolved_link = ilLMObject::_getIdForImportId($internal_link);
                    break;
                case "pg":
                    $resolved_link = ilInternalLink::_getIdForImportId("PageObject", $internal_link);
                    break;
                case "st":
                    $resolved_link = ilInternalLink::_getIdForImportId("StructureObject", $internal_link);
                    break;
                case "git":
                    $resolved_link = ilInternalLink::_getIdForImportId("GlossaryItem", $internal_link);
                    break;
                case "mob":
                    $resolved_link = ilInternalLink::_getIdForImportId("MediaObject", $internal_link);
                    break;
            }
            if (strcmp($resolved_link, "") == 0) {
                $resolved_link = $internal_link;
            }
        } else {
            $resolved_link = $internal_link;
        }
        return $resolved_link;
    }

Here is the call graph for this function:

_resolveIntLinks()

static SurveyQuestion::_resolveIntLinks (   $question_id )

static

Definition at line 1485 of file class.SurveyQuestion.php.

References $DIC, $ilDB, $result, ilInternalLink\_deleteAllLinksOfSource(), and ilInternalLink\_saveLink().

Referenced by ilQuestionPageParser\processPagesToParse(), and ilContObjParser\processPagesToParse().

    {
        global $DIC;

        $ilDB = $DIC->database();
        $resolvedlinks = 0;
        $result = $ilDB->queryF(
            "SELECT * FROM svy_material WHERE question_fi = %s",
            array('integer'),
            array($question_id)
        );
        if ($result->numRows()) {
            while ($row = $ilDB->fetchAssoc($result)) {
                $internal_link = $row["internal_link"];
                $resolved_link = self::_resolveInternalLink($internal_link);
                if (strcmp($internal_link, $resolved_link) != 0) {
                    // internal link was resolved successfully
                    $affectedRows = $ilDB->manipulateF(
                        "UPDATE svy_material SET internal_link = %s, tstamp = %s WHERE material_id = %s",
                        array('text', 'integer', 'integer'),
                        array($resolved_link, time(), $row["material_id"])
                    );
                    $resolvedlinks++;
                }
            }
        }
        if ($resolvedlinks) {
            // there are resolved links -> reenter theses links to the database

            // delete all internal links from the database
            ilInternalLink::_deleteAllLinksOfSource("sqst", $question_id);

            $result = $ilDB->queryF(
                "SELECT * FROM svy_material WHERE question_fi = %s",
                array('integer'),
                array($question_id)
            );
            if ($result->numRows()) {
                while ($row = $ilDB->fetchAssoc($result)) {
                    if (preg_match("/il_(\d*?)_(\w+)_(\d+)/", $row["internal_link"], $matches)) {
                        ilInternalLink::_saveLink("sqst", $question_id, $matches[2], $matches[3], $matches[1]);
                    }
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addInternalLink()

SurveyQuestion::addInternalLink	(		$material_id,
			$title = ""
	)

Definition at line 1308 of file class.SurveyQuestion.php.

References $target_id, $type, ilGlossaryTerm\_lookGlossaryTerm(), ilLMObject\_lookupContObjID(), addMaterial(), and saveMaterial().

    {
        if (strlen($material_id)) {
            if (strcmp($material_title, "") == 0) {
                if (preg_match("/il__(\w+)_(\d+)/", $material_id, $matches)) {
                    $type = $matches[1];
                    $target_id = $matches[2];
                    $material_title = $this->lng->txt("obj_$type") . ": ";
                    switch ($type) {
                        case "lm":
                            $cont_obj_gui = new ilObjContentObjectGUI("", $target_id, true);
                            $cont_obj = $cont_obj_gui->object;
                            $material_title .= $cont_obj->getTitle();
                            break;

                        case "pg":
                            $lm_id = ilLMObject::_lookupContObjID($target_id);
                            $cont_obj_gui = new ilObjContentObjectGUI("", $lm_id, false);
                            $cont_obj = $cont_obj_gui->object;
                            $pg_obj = new ilLMPageObject($cont_obj, $target_id);
                            $material_title .= $pg_obj->getTitle();
                            break;

                        case "st":
                            $lm_id = ilLMObject::_lookupContObjID($target_id);
                            $cont_obj_gui = new ilObjContentObjectGUI("", $lm_id, false);
                            $cont_obj = $cont_obj_gui->object;
                            $st_obj = new ilStructureObject($cont_obj, $target_id);
                            $material_title .= $st_obj->getTitle();
                            break;

                        case "git":
                            $material_title = $this->lng->txt("glossary_term") . ": " . ilGlossaryTerm::_lookGlossaryTerm($target_id);
                            break;
                        case "mob":
                            break;
                    }
                }
            }

            $mat = new ilSurveyMaterial();
            $mat->type = 0;
            $mat->internal_link = $material_id;
            $mat->title = $material_title;
            $this->addMaterial($mat);
            $this->saveMaterial();
        }
    }

Here is the call graph for this function:

addMaterial()

SurveyQuestion::addMaterial

(

$obj_material

)

Definition at line 1391 of file class.SurveyQuestion.php.

Referenced by addInternalLink().

    {
        array_push($this->material, $obj_material);
    }

Here is the caller graph for this function:

addMaterials()

SurveyQuestion::addMaterials	(		$materials_file,
			$materials_name = ""
	)

Sets the materials uri.

Parameters

string	$materials_file	An uri to additional materials
string	$materials_name	An uri name to additional materials public

See also

$materials

Definition at line 321 of file class.SurveyQuestion.php.

Referenced by setMaterialsfile().

    {
        if (empty($materials_name)) {
            $materials_name = $materials_file;
        }
        if ((!empty($materials_name)) && (!array_key_exists($materials_name, $this->materials))) {
            $this->materials[$materials_name] = $materials_file;
        }
    }

Here is the caller graph for this function:

addMaterialTag()

SurveyQuestion::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.

Parameters

object	$a_xml_writer	Reference to the ILIAS XML writer
string	$a_material	plain text or html text containing the material

Returns

string XML material tag

Definition at line 1805 of file class.SurveyQuestion.php.

References $mobs, ilObjMediaObject\_getMobsOfObject(), ilRTE\_replaceMediaObjectImageSrc(), getId(), IL_INST_ID, and isHTML().

Referenced by SurveyTextQuestion\insertXML(), SurveyMultipleChoiceQuestion\insertXML(), SurveySingleChoiceQuestion\insertXML(), SurveyMetricQuestion\insertXML(), and SurveyMatrixQuestion\insertXML().

    {
        $a_xml_writer->xmlStartTag("material");
        $attrs = array(
            "type" => "text/plain"
        );
        if ($this->isHTML($a_material)) {
            $attrs["type"] = "text/xhtml";
        }
        if (is_array($a_attrs)) {
            $attrs = array_merge($attrs, $a_attrs);
        }
        $a_xml_writer->xmlElement("mattext", $attrs, ilRTE::_replaceMediaObjectImageSrc($a_material, 0));

        if ($add_mobs) {
            $mobs = ilObjMediaObject::_getMobsOfObject("spl:html", $this->getId());
            foreach ($mobs as $mob) {
                $mob_obj = new ilObjMediaObject($mob);
                $imgattrs = array(
                    "label" => "il_" . IL_INST_ID . "_mob_" . $mob,
                    "uri" => "objects/" . "il_" . IL_INST_ID . "_mob_" . $mob . "/" . $mob_obj->getTitle(),
                    "type" => "spl:html",
                    "id" => $this->getId()
                );
                $a_xml_writer->xmlElement("matimage", $imgattrs, null);
            }
        }
        if ($close_material_tag) {
            $a_xml_writer->xmlEndTag("material");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

copyObject()

SurveyQuestion::copyObject	(		$target_questionpool,
			$title = ""
	)

Copies an assOrderingQuestion object.

public

Definition at line 618 of file class.SurveyQuestion.php.

References $title, getId(), and getObjId().

    {
        if ($this->getId() <= 0) {
            // The question has not been saved. It cannot be copied
            return;
        }
        $clone = $this;
        $original_id = self::_getOriginalId($this->getId(), false);
        $clone->setId(-1);
        $source_questionpool = $this->getObjId();
        $clone->setObjId($target_questionpool);
        if ($title) {
            $clone->setTitle($title);
        }
        
        $clone->saveToDb();

        // duplicate the materials
        $clone->duplicateMaterials($original_id);
        // copy XHTML media objects
        $clone->copyXHTMLMediaObjectsOfQuestion($original_id);
        return $clone->getId();
    }

Here is the call graph for this function:

copyXHTMLMediaObjectsOfQuestion()

SurveyQuestion::copyXHTMLMediaObjectsOfQuestion

(

$a_q_id

)

Increases the media object usage counter when a question is duplicated.

Parameters

integer

$a_q_id

The question id of the original question public

Definition at line 648 of file class.SurveyQuestion.php.

References $mobs, ilObjMediaObject\_getMobsOfObject(), ilObjMediaObject\_saveUsage(), and getId().

    {
        $mobs = ilObjMediaObject::_getMobsOfObject("spl:html", $a_q_id);
        foreach ($mobs as $mob) {
            ilObjMediaObject::_saveUsage($mob, "spl:html", $this->getId());
        }
    }

Here is the call graph for this function:

createNewQuestion()

SurveyQuestion::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.

Returns

integer ID of the new question

Definition at line 840 of file class.SurveyQuestion.php.

References $db, $ilDB, $obj_id, getAuthor(), getId(), getObjId(), getOwner(), getQuestionTypeID(), and setId().

    {
        $ilDB = $this->db;
                
        $obj_id = $this->getObjId();
        if ($obj_id > 0) {
            $next_id = $ilDB->nextId('svy_question');
            $affectedRows = $ilDB->manipulateF(
                "INSERT INTO svy_question (question_id, questiontype_fi, " .
                "obj_fi, owner_fi, title, description, author, questiontext, obligatory, complete, " .
                "created, original_id, tstamp) VALUES " .
                "(%s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s)",
                array('integer', 'integer', 'integer', 'integer', 'text', 'text', 'text', 'text',
                    'text', 'text', 'integer', 'integer', 'integer'),
                array(
                    $next_id,
                    $this->getQuestionTypeID(),
                    $obj_id,
                    $this->getOwner(),
                    null,
                    null,
                    $this->getAuthor(),
                    null,
                    "1",
                    "0",
                    time(),
                    null,
                    0
                )
            );
            $this->log->debug("INSERT INTO svy_question question_id= " . $next_id . " questiontype_fi= " . $this->getQuestionTypeID());

            $this->setId($next_id);
        }
        return $this->getId();
    }

Here is the call graph for this function:

delete()

SurveyQuestion::delete

(

$question_id

)

Deletes a question and all materials from the database.

Parameters

integer

$question_id

The database id of the question private

Definition at line 1004 of file class.SurveyQuestion.php.

References $db, $ilDB, $mobs, $obj_id, $result, ilInternalLink\_deleteAllLinksOfSource(), ilObjMediaObject\_getMobsOfObject(), ilObjMediaObject\_removeUsage(), CLIENT_WEB_DIR, ilUtil\delDir(), deleteAdditionalTableData(), and ilSurveySkill\handleQuestionDeletion().

    {
        $ilDB = $this->db;
        
        if ($question_id < 1) {
            return;
        }

        $result = $ilDB->queryF(
            "SELECT obj_fi FROM svy_question WHERE question_id = %s",
            array('integer'),
            array($question_id)
        );
        if ($result->numRows() == 1) {
            $row = $ilDB->fetchAssoc($result);
            $obj_id = $row["obj_fi"];
        } else {
            return;
        }
        
        $affectedRows = $ilDB->manipulateF(
            "DELETE FROM svy_answer WHERE question_fi = %s",
            array('integer'),
            array($question_id)
        );

        $affectedRows = $ilDB->manipulateF(
            "DELETE FROM svy_constraint WHERE question_fi = %s",
            array('integer'),
            array($question_id)
        );

        $result = $ilDB->queryF(
            "SELECT constraint_fi FROM svy_qst_constraint WHERE question_fi = %s",
            array('integer'),
            array($question_id)
        );
        while ($row = $ilDB->fetchObject($result)) {
            $affectedRows = $ilDB->manipulateF(
                "DELETE FROM svy_constraint WHERE constraint_id = %s",
                array('integer'),
                array($row->constraint_fi)
            );
        }
    
        $affectedRows = $ilDB->manipulateF(
            "DELETE FROM svy_qst_constraint WHERE question_fi = %s",
            array('integer'),
            array($question_id)
        );
        $affectedRows = $ilDB->manipulateF(
            "DELETE FROM svy_qblk_qst WHERE question_fi = %s",
            array('integer'),
            array($question_id)
        );
        $affectedRows = $ilDB->manipulateF(
            "DELETE FROM svy_svy_qst WHERE question_fi = %s",
            array('integer'),
            array($question_id)
        );
        $affectedRows = $ilDB->manipulateF(
            "DELETE FROM svy_variable WHERE question_fi = %s",
            array('integer'),
            array($question_id)
        );
        $affectedRows = $ilDB->manipulateF(
            "DELETE FROM svy_question WHERE question_id = %s",
            array('integer'),
            array($question_id)
        );

        $this->deleteAdditionalTableData($question_id);
        
        $affectedRows = $ilDB->manipulateF(
            "DELETE FROM svy_material WHERE question_fi = %s",
            array('integer'),
            array($question_id)
        );

        $this->log->debug("SET OF DELETES svy_answer, svy_constraint, svy_qst_constraint, svy_qblk_qst, svy_qst_oblig, svy_svy_qst, svy_variable, svy_question, svy_material WHERE question_fi = " . $question_id);

        ilInternalLink::_deleteAllLinksOfSource("sqst", $question_id);

        $directory = CLIENT_WEB_DIR . "/survey/" . $obj_id . "/$question_id";
        if (preg_match("/\d+/", $obj_id) and preg_match("/\d+/", $question_id) and is_dir($directory)) {
            ilUtil::delDir($directory);
        }

        $mobs = ilObjMediaObject::_getMobsOfObject("spl:html", $question_id);
        // remaining usages are not in text anymore -> delete them
        // and media objects (note: delete method of ilObjMediaObject
        // checks whether object is used in another context; if yes,
        // the object is not deleted!)
        foreach ($mobs as $mob) {
            ilObjMediaObject::_removeUsage($mob, "spl:html", $question_id);
            $mob_obj = new ilObjMediaObject($mob);
            $mob_obj->delete();
        }
        
        ilSurveySkill::handleQuestionDeletion($question_id, $obj_id);

        $this->log->debug("UPDATE svy_question");

        // #12772 - untie question copies from pool question
        $ilDB->manipulate("UPDATE svy_question" .
            " SET original_id = NULL" .
            " WHERE original_id  = " . $ilDB->quote($question_id, "integer"));
    }

Here is the call graph for this function:

deleteAdditionalTableData()

SurveyQuestion::deleteAdditionalTableData

(

$question_id

)

Deletes datasets from the additional question table in the database.

Parameters

integer

$question_id

The question id which should be deleted in the additional question table public

Definition at line 985 of file class.SurveyQuestion.php.

References $db, and $ilDB.

Referenced by delete().

    {
        $ilDB = $this->db;

        $this->log->debug("DELETE FROM " . $this->getAdditionalTableName());

        $affectedRows = $ilDB->manipulateF(
            "DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
            array('integer'),
            array($question_id)
        );
    }

Here is the caller graph for this function:

deleteMaterial()

SurveyQuestion::deleteMaterial

(

$materials_name = ""

)

Deletes a materials uri with a given name.

Parameters

string

$index

A materials_name of the materials uri public

See also

$materials

Definition at line 364 of file class.SurveyQuestion.php.

References getMaterialsPath().

    {
        foreach ($this->materials as $key => $value) {
            if (strcmp($key, $materials_name) == 0) {
                if (file_exists($this->getMaterialsPath() . $value)) {
                    unlink($this->getMaterialsPath() . $value);
                }
                unset($this->materials[$key]);
            }
        }
    }

Here is the call graph for this function:

deleteMaterials()

SurveyQuestion::deleteMaterials

(

$a_array

)

Deletes materials.

Parameters

array

$a_array

Array with indexes of the materials to delete

Definition at line 1362 of file class.SurveyQuestion.php.

References saveMaterial().

    {
        foreach ($a_array as $idx) {
            unset($this->material[$idx]);
        }
        $this->material = array_values($this->material);
        $this->saveMaterial();
    }

Here is the call graph for this function:

duplicate()

SurveyQuestion::duplicate	(		$for_survey = true,
			$title = "",
			$author = "",
			$owner = "",
			$a_survey_id = 0
	)

Duplicates a survey question.

public

Definition at line 579 of file class.SurveyQuestion.php.

References $author, $owner, $title, and getId().

    {
        if ($this->getId() <= 0) {
            // The question has not been saved. It cannot be duplicated
            return;
        }
        // duplicate the question in database
        $clone = $this;
        $original_id = $this->getId();
        $clone->setId(-1);
        if ($a_survey_id > 0) {
            $clone->setObjId($a_survey_id);
        }
        if ($title) {
            $clone->setTitle($title);
        }
        if ($author) {
            $clone->setAuthor($author);
        }
        if ($owner) {
            $clone->setOwner($owner);
        }
        if ($for_survey) {
            $clone->saveToDb($original_id);
        } else {
            $clone->saveToDb();
        }
        // duplicate the materials
        $clone->duplicateMaterials($original_id);
        // copy XHTML media objects
        $clone->copyXHTMLMediaObjectsOfQuestion($original_id);
        return $clone->getId();
    }

Here is the call graph for this function:

duplicateMaterials()

SurveyQuestion::duplicateMaterials

(

$question_id

)

Duplicates the materials of a question.

Parameters

integer

$question_id

The database id of the original survey question public

Definition at line 1377 of file class.SurveyQuestion.php.

References $filename, getMaterialsPath(), and ilUtil\makeDirParents().

    {
        foreach ($this->materials as $filename) {
            $materialspath = $this->getMaterialsPath();
            $materialspath_original = preg_replace("/([^\d])$this->id([^\d])/", "\${1}$question_id\${2}", $materialspath);
            if (!file_exists($materialspath)) {
                ilUtil::makeDirParents($materialspath);
            }
            if (!copy($materialspath_original . $filename, $materialspath . $filename)) {
                print "material could not be duplicated!!!! ";
            }
        }
    }

Here is the call graph for this function:

flushMaterials()

SurveyQuestion::flushMaterials

(

)

Deletes all materials uris.

public

See also

$materials

Definition at line 382 of file class.SurveyQuestion.php.

    {
        $this->materials = array();
    }

getAuthor()

SurveyQuestion::getAuthor

(

)

Gets the authors name of the SurveyQuestion object.

Returns

string The string containing the name of the questions author public

See also

$author

Definition at line 521 of file class.SurveyQuestion.php.

Referenced by createNewQuestion(), SurveyTextQuestion\insertXML(), SurveyMultipleChoiceQuestion\insertXML(), SurveySingleChoiceQuestion\insertXML(), SurveyMetricQuestion\insertXML(), SurveyMatrixQuestion\insertXML(), SurveyTextQuestion\isComplete(), SurveyMultipleChoiceQuestion\isComplete(), SurveySingleChoiceQuestion\isComplete(), SurveyMetricQuestion\isComplete(), SurveyMatrixQuestion\isComplete(), and saveToDb().

    {
        return (strlen($this->author)) ? $this->author : null;
    }

Here is the caller graph for this function:

getAvailableRelations()

SurveyQuestion::getAvailableRelations

(

)

Returns the available relations for the question.

Returns

array An array containing the available relations public

Definition at line 1937 of file class.SurveyQuestion.php.

    {
        // overwrite in inherited classes
        return array();
    }

getCopyIds()

SurveyQuestion::getCopyIds

(

$a_group_by_survey = false

)

Definition at line 2051 of file class.SurveyQuestion.php.

References $db, $ilDB, and $res.

Referenced by hasCopies().

    {
        $ilDB = $this->db;
        
        $set = $ilDB->query("SELECT q.question_id,s.obj_fi" .
            " FROM svy_question q" .
            " JOIN svy_svy_qst sq ON (sq.question_fi = q.question_id)" .
            " JOIN svy_svy s ON (s.survey_id = sq.survey_fi)" .
            " WHERE original_id = " . $ilDB->quote($this->getId(), "integer"));
        $res = array();
        while ($row = $ilDB->fetchAssoc($set)) {
            if (!$a_group_by_survey) {
                $res[] = $row["question_id"];
            } else {
                $res[$row["obj_fi"]][] = $row["question_id"];
            }
        }
        return $res;
    }

Here is the caller graph for this function:

getDescription()

SurveyQuestion::getDescription

(

)

Gets the description string of the SurveyQuestion object.

Returns

string The description string to describe the question public

See also

$description

Definition at line 509 of file class.SurveyQuestion.php.

Referenced by SurveyTextQuestion\insertXML(), SurveyMultipleChoiceQuestion\insertXML(), SurveySingleChoiceQuestion\insertXML(), SurveyMetricQuestion\insertXML(), SurveyMatrixQuestion\insertXML(), and saveToDb().

    {
        return (strlen($this->description)) ? $this->description : null;
    }

Here is the caller graph for this function:

getId()

SurveyQuestion::getId

(

)

Gets the id of the SurveyQuestion object.

Returns

integer The id of the SurveyQuestion object public

See also

$id

Definition at line 452 of file class.SurveyQuestion.php.

References $id.

Referenced by addMaterialTag(), SurveyTextQuestion\checkUserInput(), SurveyMultipleChoiceQuestion\checkUserInput(), SurveyMetricQuestion\checkUserInput(), SurveySingleChoiceQuestion\checkUserInput(), SurveyMatrixQuestion\checkUserInput(), copyObject(), copyXHTMLMediaObjectsOfQuestion(), createNewQuestion(), duplicate(), SurveyTextQuestion\getWorkingDataFromUserInput(), SurveyMultipleChoiceQuestion\getWorkingDataFromUserInput(), SurveySingleChoiceQuestion\getWorkingDataFromUserInput(), SurveyMetricQuestion\getWorkingDataFromUserInput(), SurveyMatrixQuestion\getWorkingDataFromUserInput(), SurveyTextQuestion\insertXML(), SurveyMultipleChoiceQuestion\insertXML(), SurveySingleChoiceQuestion\insertXML(), SurveyMetricQuestion\insertXML(), SurveyMatrixQuestion\insertXML(), loadFromDb(), SurveyMatrixQuestion\saveBipolarAdjectives(), SurveyMultipleChoiceQuestion\saveCategoriesToDb(), SurveySingleChoiceQuestion\saveCategoriesToDb(), SurveyMatrixQuestion\saveColumnsToDb(), saveCompletionStatus(), SurveyMatrixQuestion\saveLayout(), saveMaterial(), SurveyMatrixQuestion\saveRowsToDb(), SurveyTextQuestion\saveToDb(), SurveyMultipleChoiceQuestion\saveToDb(), SurveySingleChoiceQuestion\saveToDb(), SurveyMetricQuestion\saveToDb(), SurveyMatrixQuestion\saveToDb(), saveToDb(), SurveyTextQuestion\saveUserInput(), SurveyMultipleChoiceQuestion\saveUserInput(), SurveyMetricQuestion\saveUserInput(), SurveySingleChoiceQuestion\saveUserInput(), SurveyMatrixQuestion\saveUserInput(), and syncWithOriginal().

    {
        return $this->id;
    }

Here is the caller graph for this function:

getImagePath()

SurveyQuestion::getImagePath

(

)

Returns the image path for web accessable images of a question.

The image path is under the CLIENT_WEB_DIR in assessment/REFERENCE_ID_OF_QUESTION_POOL/ID_OF_QUESTION/images

public

Definition at line 893 of file class.SurveyQuestion.php.

References CLIENT_WEB_DIR.

    {
        return CLIENT_WEB_DIR . "/survey/$this->obj_id/$this->id/images/";
    }

getImagePathWeb()

SurveyQuestion::getImagePathWeb

(

)

Returns the web image path for web accessable images of a question.

The image path is under the web accessable data dir in assessment/REFERENCE_ID_OF_QUESTION_POOL/ID_OF_QUESTION/images

public

Definition at line 915 of file class.SurveyQuestion.php.

References CLIENT_WEB_DIR, and ilUtil\removeTrailingPathSeparators().

    {
        $webdir = ilUtil::removeTrailingPathSeparators(CLIENT_WEB_DIR) . "/survey/$this->obj_id/$this->id/images/";
        return str_replace(ilUtil::removeTrailingPathSeparators(ILIAS_ABSOLUTE_PATH), ilUtil::removeTrailingPathSeparators(ILIAS_HTTP_PATH), $webdir);
    }

Here is the call graph for this function:

getLabel()

SurveyQuestion::getLabel

(

)

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

    {
        return $this->label;
    }

getMaterial()

SurveyQuestion::getMaterial

(

)

Definition at line 1988 of file class.SurveyQuestion.php.

References $material.

    {
        return $this->material;
    }

getMaterialsPath()

SurveyQuestion::getMaterialsPath

(

)

Returns the materials path for web accessable materials of a question.

The materials path is under the CLIENT_WEB_DIR in assessment/REFERENCE_ID_OF_QUESTION_POOL/ID_OF_QUESTION/materials

public

Definition at line 904 of file class.SurveyQuestion.php.

References CLIENT_WEB_DIR.

Referenced by deleteMaterial(), duplicateMaterials(), and setMaterialsfile().

    {
        return CLIENT_WEB_DIR . "/survey/$this->obj_id/$this->id/materials/";
    }

Here is the caller graph for this function:

getMaterialsPathWeb()

SurveyQuestion::getMaterialsPathWeb

(

)

Returns the web image path for web accessable images of a question.

The image path is under the web accessable data dir in assessment/REFERENCE_ID_OF_QUESTION_POOL/ID_OF_QUESTION/images

public

Definition at line 927 of file class.SurveyQuestion.php.

References CLIENT_WEB_DIR, and ilUtil\removeTrailingPathSeparators().

    {
        $webdir = ilUtil::removeTrailingPathSeparators(CLIENT_WEB_DIR) . "/survey/$this->obj_id/$this->id/materials/";
        return str_replace(ilUtil::removeTrailingPathSeparators(ILIAS_ABSOLUTE_PATH), ilUtil::removeTrailingPathSeparators(ILIAS_HTTP_PATH), $webdir);
    }

Here is the call graph for this function:

getMaxSumScore()

static SurveyQuestion::getMaxSumScore ( int  $survey_id )

static

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

Parameters

int

$survey_id

Returns

int

Definition at line 2132 of file class.SurveyQuestion.php.

                                                          : int
    {
        return 0;
    }

getObjId()

SurveyQuestion::getObjId

(

)

Get the reference id of the container object.

Returns

integer The reference id of the container object public

See also

$obj_id

Definition at line 557 of file class.SurveyQuestion.php.

References $obj_id.

Referenced by copyObject(), createNewQuestion(), and saveToDb().

    {
        return $this->obj_id;
    }

Here is the caller graph for this function:

getObligatory()

SurveyQuestion::getObligatory

(

$survey_id = ""

)

Gets the obligatory state of the question.

Returns

integer 1, if the question is obligatory, otherwise 0

See also

$obligatory

Definition at line 463 of file class.SurveyQuestion.php.

Referenced by SurveyTextQuestion\checkUserInput(), SurveyMultipleChoiceQuestion\checkUserInput(), SurveyMetricQuestion\checkUserInput(), SurveySingleChoiceQuestion\checkUserInput(), SurveyMatrixQuestion\checkUserInput(), SurveyTextQuestion\insertXML(), SurveyMultipleChoiceQuestion\insertXML(), SurveySingleChoiceQuestion\insertXML(), SurveyMetricQuestion\insertXML(), SurveyMatrixQuestion\insertXML(), and saveToDb().

    {
        return ($this->obligatory) ? 1 : 0;
    }

Here is the caller graph for this function:

getOrientation()

SurveyQuestion::getOrientation

(

)

Gets the orientation of the question output.

Returns

integer 0 = vertical, 1 = horizontal public

See also

$orientation

Definition at line 487 of file class.SurveyQuestion.php.

References $orientation.

Referenced by SurveyMultipleChoiceQuestion\insertXML(), SurveySingleChoiceQuestion\insertXML(), SurveyMultipleChoiceQuestion\saveToDb(), and SurveySingleChoiceQuestion\saveToDb().

    {
        switch ($this->orientation) {
            case 0:
            case 1:
            case 2:
                break;
            default:
                $this->orientation = 0;
                break;
        }
        return $this->orientation;
    }

Here is the caller graph for this function:

getOriginalId()

SurveyQuestion::getOriginalId

(

)

Definition at line 1983 of file class.SurveyQuestion.php.

Referenced by SurveyMatrixQuestion\syncWithOriginal(), and syncWithOriginal().

    {
        return $this->original_id;
    }

Here is the caller graph for this function:

getOwner()

SurveyQuestion::getOwner

(

)

Gets the creator/owner ID of the SurveyQuestion object.

Returns

integer The numerical ID to identify the owner/creator public

See also

$owner

Definition at line 533 of file class.SurveyQuestion.php.

References $owner.

Referenced by createNewQuestion(), and saveToDb().

    {
        return $this->owner;
    }

Here is the caller graph for this function:

getPhrase()

SurveyQuestion::getPhrase

(

$phrase_id

)

Returns a phrase for a given database id.

Returns

String The title of the phrase public

Definition at line 1248 of file class.SurveyQuestion.php.

References $db, $ilDB, and $result.

    {
        $ilDB = $this->db;
        
        $result = $ilDB->queryF(
            "SELECT title FROM svy_phrase WHERE phrase_id = %s",
            array('integer'),
            array($phrase_id)
        );
        if ($row = $ilDB->fetchAssoc($result)) {
            return $row["title"];
        }
        return "";
    }

getPreconditionOptions()

SurveyQuestion::getPreconditionOptions

(

)

Returns the options for preconditions.

Returns

array

Definition at line 1948 of file class.SurveyQuestion.php.

Referenced by SurveyMatrixQuestion\getPreconditionSelectValue().

    {
        // overwrite in inherited classes
    }

Here is the caller graph for this function:

getPreconditionSelectValue()

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

Creates a form property for the precondition value.

Returns

The ILIAS form element public

Definition at line 1972 of file class.SurveyQuestion.php.

    {
        // overwrite in inherited classes
        return null;
    }

getPreconditionValueOutput()

SurveyQuestion::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 1960 of file class.SurveyQuestion.php.

    {
        // overwrite in inherited classes
        return $value;
    }

getQuestionDataArray()

SurveyQuestion::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 1855 of file class.SurveyQuestion.php.

    {
        return array();
    }

getQuestiontext()

SurveyQuestion::getQuestiontext

(

)

Gets the questiontext of the SurveyQuestion object.

Returns

string The questiontext of the question object public

See also

$questiontext

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

Referenced by SurveyTextQuestion\insertXML(), SurveyMultipleChoiceQuestion\insertXML(), SurveySingleChoiceQuestion\insertXML(), SurveyMetricQuestion\insertXML(), SurveyMatrixQuestion\insertXML(), SurveyTextQuestion\isComplete(), SurveyMultipleChoiceQuestion\isComplete(), SurveySingleChoiceQuestion\isComplete(), SurveyMetricQuestion\isComplete(), SurveyMatrixQuestion\isComplete(), and saveToDb().

    {
        return (strlen($this->questiontext)) ? $this->questiontext : null;
    }

Here is the caller graph for this function:

getQuestionType()

SurveyQuestion::getQuestionType

(

)

Returns the question type of the question.

Returns

integer The question type of the question public

Definition at line 1627 of file class.SurveyQuestion.php.

Referenced by getQuestionTypeID().

    {
        return "";
    }

Here is the caller graph for this function:

getQuestionTypeID()

SurveyQuestion::getQuestionTypeID

(

)

Returns the question type ID of the question.

Returns

integer The question type of the question public

Definition at line 1605 of file class.SurveyQuestion.php.

References $db, $ilDB, $result, and getQuestionType().

Referenced by createNewQuestion(), and saveToDb().

    {
        $ilDB = $this->db;
        $result = $ilDB->queryF(
            "SELECT questiontype_id FROM svy_qtype WHERE type_tag = %s",
            array('text'),
            array($this->getQuestionType())
        );
        if ($result->numRows() == 1) {
            $row = $ilDB->fetchAssoc($result);
            return $row["questiontype_id"];
        } else {
            return 0;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSubtype()

SurveyQuestion::getSubtype

(

)

Definition at line 1998 of file class.SurveyQuestion.php.

    {
        // do nothing
        return null;
    }

getSurveyId()

SurveyQuestion::getSurveyId

(

)

Gets the survey id of the SurveyQuestion object.

Returns

integer The survey id of the SurveyQuestion object public

See also

$survey_id

Definition at line 475 of file class.SurveyQuestion.php.

References $survey_id.

    {
        return $this->survey_id;
    }

getTitle()

SurveyQuestion::getTitle

(

)

Gets the title string of the SurveyQuestion object.

Returns

string The title string to describe the question public

See also

$title

Definition at line 435 of file class.SurveyQuestion.php.

References $title.

Referenced by SurveyTextQuestion\insertXML(), SurveyMultipleChoiceQuestion\insertXML(), SurveySingleChoiceQuestion\insertXML(), SurveyMetricQuestion\insertXML(), SurveyMatrixQuestion\insertXML(), SurveyTextQuestion\isComplete(), SurveyMultipleChoiceQuestion\isComplete(), SurveySingleChoiceQuestion\isComplete(), SurveyMetricQuestion\isComplete(), SurveyMatrixQuestion\isComplete(), and saveToDb().

    {
        return $this->title;
    }

Here is the caller graph for this function:

getWorkingDataFromUserInput()

& SurveyQuestion::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 1866 of file class.SurveyQuestion.php.

References $data.

    {
        // overwrite in inherited classes
        $data = array();
        return $data;
    }

hasCopies()

SurveyQuestion::hasCopies

(

)

Definition at line 2071 of file class.SurveyQuestion.php.

References getCopyIds().

    {
        return (bool) sizeof($this->getCopyIds());
    }

Here is the call graph for this function:

importAdditionalMetadata()

SurveyQuestion::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 1881 of file class.SurveyQuestion.php.

    {
        // overwrite in inherited classes
    }

importAdjectives()

SurveyQuestion::importAdjectives

(

$a_data

)

Import bipolar adjectives from the question import file.

Returns

array $a_data Array containing the adjectives public

Definition at line 1903 of file class.SurveyQuestion.php.

    {
        // overwrite in inherited classes
    }

importMatrix()

SurveyQuestion::importMatrix

(

$a_data

)

Import matrix rows from the question import file.

Returns

array $a_data Array containing the matrix rows public

Definition at line 1914 of file class.SurveyQuestion.php.

    {
        // overwrite in inherited classes
    }

importResponses()

SurveyQuestion::importResponses

(

$a_data

)

Import response data from the question import file.

Returns

array $a_data Array containing the response data public

Definition at line 1892 of file class.SurveyQuestion.php.

    {
        // overwrite in inherited classes
    }

isComplete()

SurveyQuestion::isComplete

(

)

Returns 1, if a question is complete for use.

Returns

integer 1, if the question is complete for use, otherwise 0 public

Definition at line 209 of file class.SurveyQuestion.php.

Referenced by saveCompletionStatus(), and saveToDb().

    {
        return 0;
    }

Here is the caller graph for this function:

isHTML()

SurveyQuestion::isHTML

(

$a_text

)

Checks if a given string contains HTML or not.

Parameters

string

$a_text

Text which should be checked

Returns

boolean public

Definition at line 1757 of file class.SurveyQuestion.php.

Referenced by addMaterialTag().

    {
        if (preg_match("/<[^>]*?>/", $a_text)) {
            return true;
        } else {
            return false;
        }
    }

Here is the caller graph for this function:

loadFromDb()

SurveyQuestion::loadFromDb

(

$question_id

)

Loads a SurveyQuestion object from the database.

Parameters

integer

$question_id

A unique key which defines the question in the database public

Definition at line 662 of file class.SurveyQuestion.php.

References $db, $ilDB, $result, and getId().

    {
        $ilDB = $this->db;
        
        $result = $ilDB->queryF(
            "SELECT * FROM svy_material WHERE question_fi = %s",
            array('integer'),
            array($this->getId())
        );
        $this->material = array();
        if ($result->numRows()) {
            while ($row = $ilDB->fetchAssoc($result)) {
                $mat = new ilSurveyMaterial();
                $mat->type = $row['material_type'];
                $mat->internal_link = $row['internal_link'];
                $mat->title = $row['material_title'];
                $mat->import_id = $row['import_id'];
                $mat->text_material = $row['text_material'];
                $mat->external_link = $row['external_link'];
                $mat->file_material = $row['file_material'];
                array_push($this->material, $mat);
            }
        }
    }

Here is the call graph for this function:

lookupObjFi()

static SurveyQuestion::lookupObjFi (   $a_qid )

static

Lookip obj fi.

Parameters

Definition at line 2097 of file class.SurveyQuestion.php.

References $DIC, and $ilDB.

Referenced by ilTermUsagesTableGUI\fillRow(), and ilSurveyQuestionTableGUI\importData().

    {
        global $DIC;

        $ilDB = $DIC->database();

        $set = $ilDB->query(
            "SELECT obj_fi FROM svy_question " .
            " WHERE question_id = " . $ilDB->quote($a_qid, "integer")
        );
        $rec = $ilDB->fetchAssoc($set);
        return $rec["obj_fi"];
    }

Here is the caller graph for this function:

phraseExists()

SurveyQuestion::phraseExists

(

$title

)

Returns true if the phrase title already exists for the current user.

Parameters

string

$title

The title of the phrase

Returns

boolean True, if the title exists, otherwise False public

Definition at line 1270 of file class.SurveyQuestion.php.

References $db, $ilDB, $ilUser, $result, $title, and $user.

    {
        $ilUser = $this->user;
        $ilDB = $this->db;
        
        $result = $ilDB->queryF(
            "SELECT phrase_id FROM svy_phrase WHERE title = %s AND owner_fi = %s",
            array('text', 'integer'),
            array($title, $ilUser->getId())
        );
        return ($result->numRows() == 0) ? false : true;
    }

prepareTextareaOutput()

SurveyQuestion::prepareTextareaOutput	(		$txt_output,
			$prepare_for_latex_output = false
	)

Prepares a string for a text area output in surveys.

Parameters

string

$txt_output

String which should be prepared for output public

Definition at line 1843 of file class.SurveyQuestion.php.

References ilUtil\prepareTextareaOutput().

    {
        return ilUtil::prepareTextareaOutput($txt_output, $prepare_for_latex_output);
    }

Here is the call graph for this function:

QTIMaterialToString()

SurveyQuestion::QTIMaterialToString

(

$a_material

)

Reads an QTI material tag an creates a text string.

Parameters

string

$a_material

QTI material tag

Returns

string text or xhtml string public

Definition at line 1773 of file class.SurveyQuestion.php.

References $_SESSION, $i, $material, $result, and ilLoggerFactory\getLogger().

    {
        $svy_log = ilLoggerFactory::getLogger("svy");
        $svy_log->debug("material count: " . $a_material->getMaterialCount());

        $result = "";
        for ($i = 0; $i < $a_material->getMaterialCount(); $i++) {
            $material = $a_material->getMaterial($i);
            if (strcmp($material["type"], "mattext") == 0) {
                $result .= $material["material"]->getContent();
            }
            if (strcmp($material["type"], "matimage") == 0) {
                $matimage = $material["material"];
                if (preg_match("/(il_([0-9]+)_mob_([0-9]+))/", $matimage->getLabel(), $matches)) {
                    // import an mediaobject which was inserted using tiny mce
                    if (!is_array($_SESSION["import_mob_xhtml"])) {
                        $_SESSION["import_mob_xhtml"] = array();
                    }
                    array_push($_SESSION["import_mob_xhtml"], array("mob" => $matimage->getLabel(), "uri" => $matimage->getUri()));
                }
            }
        }
        return $result;
    }

Here is the call graph for this function:

questionTitleExists()

SurveyQuestion::questionTitleExists	(		$title,
			$questionpool_object = ""
	)

Returns TRUE if the question title exists in the database.

Parameters

string	$title	The title of the question
string	$questionpool_reference	The reference id of a container question pool

Returns

boolean The result of the title check public

Definition at line 222 of file class.SurveyQuestion.php.

References $db, $ilDB, $result, and $title.

    {
        $ilDB = $this->db;
        
        $refwhere = "";
        if (strcmp($questionpool_object, "") != 0) {
            $refwhere = sprintf(
                " AND obj_fi = %s",
                $ilDB->quote($questionpool_object, 'integer')
            );
        }
        $result = $ilDB->queryF(
            "SELECT question_id FROM svy_question WHERE title = %s$refwhere",
            array('text'),
            array($title)
        );
        return ($result->numRows() > 0) ? true : false;
    }

saveCategoryToDb()

SurveyQuestion::saveCategoryToDb	(		$categorytext,
			$neutral = 0
	)

Saves a category to the database.

Parameters

string

$categorytext

The description of the category

Returns

integer The database id of the category public

See also

$categories

Definition at line 941 of file class.SurveyQuestion.php.

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

Referenced by SurveyMultipleChoiceQuestion\saveCategoriesToDb(), and SurveySingleChoiceQuestion\saveCategoriesToDb().

    {
        $ilUser = $this->user;
        $ilDB = $this->db;
        
        $result = $ilDB->queryF(
            "SELECT title, category_id FROM svy_category WHERE title = %s AND neutral = %s AND owner_fi = %s",
            array('text','text','integer'),
            array($categorytext, $neutral, $ilUser->getId())
        );
        $insert = false;
        $returnvalue = "";
        if ($result->numRows()) {
            $insert = true;
            while ($row = $ilDB->fetchAssoc($result)) {
                if (strcmp($row["title"], $categorytext) == 0) {
                    $returnvalue = $row["category_id"];
                    $insert = false;
                }
            }
        } else {
            $insert = true;
        }
        if ($insert) {
            $next_id = $ilDB->nextId('svy_category');
            $affectedRows = $ilDB->manipulateF(
                "INSERT INTO svy_category (category_id, title, neutral, owner_fi, tstamp) VALUES (%s, %s, %s, %s, %s)",
                array('integer','text','text','integer','integer'),
                array($next_id, $categorytext, $neutral, $ilUser->getId(), time())
            );

            $this->log->debug("INSERT INTO svy_category id=" . $next_id);

            $returnvalue = $next_id;
        }
        return $returnvalue;
    }

Here is the caller graph for this function:

saveCompletionStatus()

SurveyQuestion::saveCompletionStatus

(

$original_id = ""

)

Saves the complete flag to the database.

public

Definition at line 718 of file class.SurveyQuestion.php.

References $db, $ilDB, getId(), and isComplete().

Referenced by SurveyMultipleChoiceQuestion\saveCategoriesToDb(), SurveySingleChoiceQuestion\saveCategoriesToDb(), SurveyMatrixQuestion\saveColumnsToDb(), and SurveyMatrixQuestion\saveRowsToDb().

    {
        $ilDB = $this->db;
        
        $question_id = $this->getId();
        if (strlen($original_id)) {
            $question_id = $original_id;
        }

        if ($this->getId() > 0) {
            $this->log->debug("UPDATE svy_question question_id=" . $question_id);

            // update existing dataset
            $affectedRows = $ilDB->manipulateF(
                "UPDATE svy_question SET complete = %s, tstamp = %s WHERE question_id = %s",
                array('text', 'integer', 'integer'),
                array($this->isComplete(), time(), $question_id)
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveMaterial()

SurveyQuestion::saveMaterial

(

)

save material to db

Definition at line 799 of file class.SurveyQuestion.php.

References $db, $ilDB, $material, ilInternalLink\_deleteAllLinksOfSource(), ilInternalLink\_saveLink(), and getId().

Referenced by addInternalLink(), deleteMaterials(), SurveyTextQuestion\saveToDb(), SurveyMultipleChoiceQuestion\saveToDb(), SurveySingleChoiceQuestion\saveToDb(), SurveyMetricQuestion\saveToDb(), SurveyMatrixQuestion\saveToDb(), and setMaterial().

    {
        $ilDB = $this->db;
        
        $this->log->debug("DELETE: svy_material question_fi=" . $this->getId());

        $affectedRows = $ilDB->manipulateF(
            "DELETE FROM svy_material WHERE question_fi = %s",
            array('integer'),
            array($this->getId())
        );
        ilInternalLink::_deleteAllLinksOfSource("sqst", $this->getId());

        foreach ($this->material as $material) {
            $next_id = $ilDB->nextId('svy_material');

            $this->log->debug("INSERT: svy_material question_fi=" . $this->getId());

            $affectedRows = $ilDB->manipulateF(
                "INSERT INTO svy_material " .
                "(material_id, question_fi, internal_link, import_id, material_title, tstamp," .
                "text_material, external_link, file_material, material_type) " .
                "VALUES (%s, %s, %s, %s, %s, %s, %s, %s, %s, %s)",
                array('integer','integer','text','text','text','integer','text','text','text','integer'),
                array(
                    $next_id, $this->getId(), $material->internal_link, $material->import_id,
                    $material->title, time(), $material->text_material, $material->external_link,
                    $material->file_material, $material->type)
            );
            if (preg_match("/il_(\d*?)_(\w+)_(\d+)/", $material->internal_link, $matches)) {
                ilInternalLink::_saveLink("sqst", $this->getId(), $matches[2], $matches[3], $matches[1]);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveToDb()

SurveyQuestion::saveToDb

(

$original_id = ""

)

Saves a SurveyQuestion object to a database.

Parameters

integer

$original_id

public

Definition at line 745 of file class.SurveyQuestion.php.

References $db, $ilDB, ilRTE\_cleanupMediaObjectUsage(), ilRTE\_replaceMediaObjectImageSrc(), getAuthor(), getDescription(), getId(), getObjId(), getObligatory(), getOwner(), getQuestiontext(), getQuestionTypeID(), getTitle(), isComplete(), and setId().

Referenced by syncWithOriginal().

    {
        $ilDB = $this->db;
        
        // cleanup RTE images which are not inserted into the question text
        ilRTE::_cleanupMediaObjectUsage($this->getQuestiontext(), "spl:html", $this->getId());
        $affectedRows = 0;
        if ($this->getId() == -1) {
            // Write new dataset
            $next_id = $ilDB->nextId('svy_question');
            $affectedRows = $ilDB->insert("svy_question", array(
                "question_id" => array("integer", $next_id),
                "questiontype_fi" => array("integer", $this->getQuestionTypeID()),
                "obj_fi" => array("integer", $this->getObjId()),
                "owner_fi" => array("integer", $this->getOwner()),
                "title" => array("text", $this->getTitle()),
                "label" => array("text", (strlen($this->label)) ? $this->label : null),
                "description" => array("text", $this->getDescription()),
                "author" => array("text", $this->getAuthor()),
                "questiontext" => array("clob", ilRTE::_replaceMediaObjectImageSrc($this->getQuestiontext(), 0)),
                "obligatory" => array("text", $this->getObligatory()),
                "complete" => array("text", $this->isComplete()),
                "created" => array("integer", time()),
                "original_id" => array("integer", ($original_id) ? $original_id : null),
                "tstamp" => array("integer", time())
            ));

            //$this->log->debug("INSERT: svy_question id=".$next_id." questiontype_fi=".$this->getQuestionTypeID()." obj_fi".$this->getObjId()." title=".$this->getTitle()." ...");

            $this->setId($next_id);
        } else {
            // update existing dataset
            $affectedRows = $ilDB->update("svy_question", array(
                "title" => array("text", $this->getTitle()),
                "label" => array("text", (strlen($this->label)) ? $this->label : null),
                "description" => array("text", $this->getDescription()),
                "author" => array("text", $this->getAuthor()),
                "questiontext" => array("clob", ilRTE::_replaceMediaObjectImageSrc($this->getQuestiontext(), 0)),
                "obligatory" => array("text", $this->getObligatory()),
                "complete" => array("text", $this->isComplete()),
                "tstamp" => array("integer", time())
            ), array(
            "question_id" => array("integer", $this->getId())
            ));

            $this->log->debug("UPDATE svy_question id=" . $this->getId() . " SET: title=" . $this->getTitle() . " ...");
        }
        
        return $affectedRows;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveWorkingData()

SurveyQuestion::saveWorkingData

(

$limit_to = LIMIT_NO_LIMIT

)

Saves the learners input of the question to the database.

public

See also

$answers

Definition at line 883 of file class.SurveyQuestion.php.

    {
    }

setAuthor()

SurveyQuestion::setAuthor

(

$author = ""

)

Sets the authors name of the SurveyQuestion object.

Parameters

string

$author

A string containing the name of the questions author public

See also

$author

Definition at line 394 of file class.SurveyQuestion.php.

References $author, $ilUser, and $user.

Referenced by SurveyTextQuestion\loadFromDb(), SurveyMultipleChoiceQuestion\loadFromDb(), SurveySingleChoiceQuestion\loadFromDb(), SurveyMetricQuestion\loadFromDb(), and SurveyMatrixQuestion\loadFromDb().

    {
        $ilUser = $this->user;

        if (!$author) {
            $author = $ilUser->fullname;
        }
        $this->author = $author;
    }

Here is the caller graph for this function:

setComplete()

SurveyQuestion::setComplete

(

$a_complete

)

Sets the complete state of the question.

Parameters

integer

$a_complete

1 if complete, 0 otherwise public

Definition at line 198 of file class.SurveyQuestion.php.

Referenced by SurveyTextQuestion\loadFromDb(), SurveyMultipleChoiceQuestion\loadFromDb(), SurveySingleChoiceQuestion\loadFromDb(), SurveyMetricQuestion\loadFromDb(), and SurveyMatrixQuestion\loadFromDb().

    {
        $this->complete = ($a_complete) ? 1 : 0;
    }

Here is the caller graph for this function:

setDescription()

SurveyQuestion::setDescription

(

$description = ""

)

Sets the description string of the SurveyQuestion object.

Parameters

string

$description

A description string to describe the question public

See also

$description

Definition at line 308 of file class.SurveyQuestion.php.

References $description.

Referenced by SurveyTextQuestion\loadFromDb(), SurveyMultipleChoiceQuestion\loadFromDb(), SurveySingleChoiceQuestion\loadFromDb(), SurveyMetricQuestion\loadFromDb(), and SurveyMatrixQuestion\loadFromDb().

    {
        $this->description = $description;
    }

Here is the caller graph for this function:

setId()

SurveyQuestion::setId

(

$id = -1

)

Sets the id of the SurveyQuestion object.

Parameters

integer

$id

A unique integer value public

See also

$id

Definition at line 284 of file class.SurveyQuestion.php.

References $id.

Referenced by createNewQuestion(), SurveyTextQuestion\loadFromDb(), SurveyMultipleChoiceQuestion\loadFromDb(), SurveySingleChoiceQuestion\loadFromDb(), SurveyMetricQuestion\loadFromDb(), SurveyMatrixQuestion\loadFromDb(), saveToDb(), and syncWithOriginal().

    {
        $this->id = $id;
    }

Here is the caller graph for this function:

setMaterial()

SurveyQuestion::setMaterial	(		$material_id = "",
			$is_import = false,
			$material_title = ""
	)

Sets a material link for the question.

Parameters

string	$material_id	An internal link pointing to the material
boolean	$is_import	A boolean indication that the internal link was imported from another ILIAS installation public

Definition at line 1403 of file class.SurveyQuestion.php.

References $target_id, $type, ilGlossaryTerm\_lookGlossaryTerm(), ilLMObject\_lookupContObjID(), and saveMaterial().

    {
        if (strcmp($material_id, "") != 0) {
            $import_id = "";
            if ($is_import) {
                $import_id = $material_id;
                $material_id = self::_resolveInternalLink($import_id);
            }
            if (strcmp($material_title, "") == 0) {
                if (preg_match("/il__(\w+)_(\d+)/", $material_id, $matches)) {
                    $type = $matches[1];
                    $target_id = $matches[2];
                    $material_title = $this->lng->txt("obj_$type") . ": ";
                    switch ($type) {
                        case "lm":
                            $cont_obj_gui = new ilObjContentObjectGUI("", $target_id, true);
                            $cont_obj = $cont_obj_gui->object;
                            $material_title .= $cont_obj->getTitle();
                            break;

                        case "pg":
                            $lm_id = ilLMObject::_lookupContObjID($target_id);
                            $cont_obj_gui = new ilObjContentObjectGUI("", $lm_id, false);
                            $cont_obj = $cont_obj_gui->object;
                            $pg_obj = new ilLMPageObject($cont_obj, $target_id);
                            $material_title .= $pg_obj->getTitle();
                            break;

                        case "st":
                            $lm_id = ilLMObject::_lookupContObjID($target_id);
                            $cont_obj_gui = new ilObjContentObjectGUI("", $lm_id, false);
                            $cont_obj = $cont_obj_gui->object;
                            $st_obj = new ilStructureObject($cont_obj, $target_id);
                            $material_title .= $st_obj->getTitle();
                            break;

                        case "git":
                            $material_title = $this->lng->txt("glossary_term") . ": " . ilGlossaryTerm::_lookGlossaryTerm($target_id);
                            break;
                        case "mob":
                            break;
                    }
                }
            }
            $this->material = array(
                "internal_link" => $material_id,
                "import_id" => $import_id,
                "title" => $material_title
            );
        }
        $this->saveMaterial();
    }

Here is the call graph for this function:

setMaterialsfile()

SurveyQuestion::setMaterialsfile	(		$materials_filename,
			$materials_tempfilename = "",
			$materials_name = ""
	)

Sets and uploads the materials uri.

Parameters

string | string | string

$materials_filename,$materials_tempfilename,$materials

public

See also

$materials

Definition at line 338 of file class.SurveyQuestion.php.

References addMaterials(), getMaterialsPath(), ilUtil\makeDirParents(), and ilUtil\moveUploadedFile().

    {
        if (!empty($materials_filename)) {
            $materialspath = $this->getMaterialsPath();
            if (!file_exists($materialspath)) {
                ilUtil::makeDirParents($materialspath);
            }
            if (ilUtil::moveUploadedFile(
                $materials_tempfilename,
                $materials_filename,
                $materialspath . $materials_filename
            )) {
                print "image not uploaded!!!! ";
            } else {
                $this->addMaterials($materials_filename, $materials_name);
            }
        }
    }

Here is the call graph for this function:

setObjId()

SurveyQuestion::setObjId

(

$obj_id = 0

)

Set the reference id of the container object.

Parameters

integer

$obj_id

The reference id of the container object public

See also

$obj_id

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

References $obj_id.

Referenced by SurveyTextQuestion\loadFromDb(), SurveyMultipleChoiceQuestion\loadFromDb(), SurveySingleChoiceQuestion\loadFromDb(), SurveyMetricQuestion\loadFromDb(), and SurveyMatrixQuestion\loadFromDb().

    {
        $this->obj_id = $obj_id;
    }

Here is the caller graph for this function:

setObligatory()

SurveyQuestion::setObligatory

(

$obligatory = 1

)

Sets the obligatory state of the question.

Parameters

integer

$obligatory

1, if the question is obligatory, otherwise 0 public

See also

$obligatory

Definition at line 260 of file class.SurveyQuestion.php.

References $obligatory.

Referenced by SurveyTextQuestion\loadFromDb(), SurveyMultipleChoiceQuestion\loadFromDb(), SurveySingleChoiceQuestion\loadFromDb(), SurveyMetricQuestion\loadFromDb(), and SurveyMatrixQuestion\loadFromDb().

    {
        $this->obligatory = ($obligatory) ? 1 : 0;
    }

Here is the caller graph for this function:

setOrientation()

SurveyQuestion::setOrientation

(

$orientation = 0

)

Sets the orientation of the question output.

Parameters

integer

$orientation

0 = vertical, 1 = horizontal public

See also

$orientation

Definition at line 272 of file class.SurveyQuestion.php.

References $orientation.

Referenced by SurveySingleChoiceQuestion\importAdditionalMetadata(), SurveyMultipleChoiceQuestion\importAdditionalMetadata(), SurveyMultipleChoiceQuestion\loadFromDb(), and SurveySingleChoiceQuestion\loadFromDb().

    {
        $this->orientation = ($orientation) ? $orientation : 0;
    }

Here is the caller graph for this function:

setOriginalId()

SurveyQuestion::setOriginalId

(

$original_id

)

Definition at line 1978 of file class.SurveyQuestion.php.

Referenced by SurveyTextQuestion\loadFromDb(), SurveyMultipleChoiceQuestion\loadFromDb(), SurveySingleChoiceQuestion\loadFromDb(), SurveyMetricQuestion\loadFromDb(), SurveyMatrixQuestion\loadFromDb(), and syncWithOriginal().

    {
        $this->original_id = $original_id;
    }

Here is the caller graph for this function:

setOwner()

SurveyQuestion::setOwner

(

$owner = ""

)

Sets the creator/owner ID of the SurveyQuestion object.

Parameters

integer

$owner

A numerical ID to identify the owner/creator public

See also

$owner

Definition at line 423 of file class.SurveyQuestion.php.

References $owner.

Referenced by SurveyTextQuestion\loadFromDb(), SurveyMultipleChoiceQuestion\loadFromDb(), SurveySingleChoiceQuestion\loadFromDb(), SurveyMetricQuestion\loadFromDb(), and SurveyMatrixQuestion\loadFromDb().

    {
        $this->owner = $owner;
    }

Here is the caller graph for this function:

setQuestiontext()

SurveyQuestion::setQuestiontext

(

$questiontext = ""

)

Sets the questiontext of the SurveyQuestion object.

Parameters

string

$questiontext

A string containing the questiontext public

See also

$questiontext

Definition at line 411 of file class.SurveyQuestion.php.

References $questiontext.

Referenced by SurveyTextQuestion\loadFromDb(), SurveyMultipleChoiceQuestion\loadFromDb(), SurveySingleChoiceQuestion\loadFromDb(), SurveyMetricQuestion\loadFromDb(), and SurveyMatrixQuestion\loadFromDb().

    {
        $this->questiontext = $questiontext;
    }

Here is the caller graph for this function:

setSubtype()

SurveyQuestion::setSubtype

(

$a_subtype

)

Definition at line 1993 of file class.SurveyQuestion.php.

    {
        // do nothing
    }

setSurveyId()

SurveyQuestion::setSurveyId

(

$id = -1

)

Sets the survey id of the SurveyQuestion object.

Parameters

integer

$id

A unique integer value public

See also

$survey_id

Definition at line 296 of file class.SurveyQuestion.php.

References $id.

    {
        $this->survey_id = $id;
    }

setTitle()

SurveyQuestion::setTitle

(

$title = ""

)

Sets the title string of the SurveyQuestion object.

Parameters

string

$title

A title string to describe the question public

See also

$title

Definition at line 248 of file class.SurveyQuestion.php.

References $title.

Referenced by SurveyTextQuestion\loadFromDb(), SurveyMultipleChoiceQuestion\loadFromDb(), SurveySingleChoiceQuestion\loadFromDb(), SurveyMetricQuestion\loadFromDb(), and SurveyMatrixQuestion\loadFromDb().

    {
        $this->title = $title;
    }

Here is the caller graph for this function:

stripSlashesAddSpaceFallback()

SurveyQuestion::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.

Parameters

string

$a_str

string

Returns

string

Definition at line 2118 of file class.SurveyQuestion.php.

References ilUtil\stripSlashes().

Referenced by SurveyTextQuestion\saveUserInput(), SurveyMultipleChoiceQuestion\saveUserInput(), SurveySingleChoiceQuestion\saveUserInput(), and SurveyMatrixQuestion\saveUserInput().

    {
        $str = ilUtil::stripSlashes($a_str);
        if ($str != $a_str) {
            $str = ilUtil::stripSlashes(str_replace("<", "< ", $a_str));
        }
        return $str;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

syncWithOriginal()

SurveyQuestion::syncWithOriginal

(

)

Definition at line 1202 of file class.SurveyQuestion.php.

References $db, $id, $ilDB, ilInternalLink\_deleteAllLinksOfSource(), ilInternalLink\_saveLink(), getId(), getOriginalId(), saveToDb(), setId(), and setOriginalId().

    {
        $ilDB = $this->db;
        
        if ($this->getOriginalId()) {
            $id = $this->getId();
            $original = $this->getOriginalId();

            $this->setId($this->getOriginalId());
            $this->setOriginalId(null);
            $this->saveToDb();

            $this->setId($id);
            $this->setOriginalId($original);

            $this->log->debug("DELETE FROM svy_material WHERE question_fi = " . $this->getOriginalId());

            $affectedRows = $ilDB->manipulateF(
                "DELETE FROM svy_material WHERE question_fi = %s",
                array('integer'),
                array($this->getOriginalId())
            );
            ilInternalLink::_deleteAllLinksOfSource("sqst", $this->original_id);
            if (strlen($this->material["internal_link"])) {
                $next_id = $ilDB->nextId('svy_material');
                $affectedRows = $ilDB->manipulateF(
                    "INSERT INTO svy_material (material_id, question_fi, internal_link, import_id, material_title, tstamp) VALUES (%s, %s, %s, %s, %s, %s)",
                    array('integer', 'integer', 'text', 'text', 'text', 'integer'),
                    array($next_id, $this->getOriginalId(), $this->material["internal_link"], $this->material["import_id"], $this->material["title"], time())
                );

                $this->log->debug("INSERT svy_material material_id=" . $next_id . " question_fi=" . $this->getOriginalId());

                if (preg_match("/il_(\d*?)_(\w+)_(\d+)/", $this->material["internal_link"], $matches)) {
                    ilInternalLink::_saveLink("sqst", $this->getOriginalId(), $matches[2], $matches[3], $matches[1]);
                }
            }
        }
    }

Here is the call graph for this function:

usableForPrecondition()

SurveyQuestion::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 1925 of file class.SurveyQuestion.php.

    {
        // overwrite in inherited classes
        return false;
    }

Field Documentation

$arrData

SurveyQuestion::$arrData

private

data array containing the question data

Definition at line 141 of file class.SurveyQuestion.php.

$author

SurveyQuestion::$author

Definition at line 79 of file class.SurveyQuestion.php.

Referenced by SurveyTextQuestion\__construct(), SurveySingleChoiceQuestion\__construct(), SurveyMultipleChoiceQuestion\__construct(), SurveyMetricQuestion\__construct(), SurveyMatrixQuestion\__construct(), __construct(), duplicate(), and setAuthor().

$complete

SurveyQuestion::$complete

Definition at line 131 of file class.SurveyQuestion.php.

$cumulated

SurveyQuestion::$cumulated

protected

An array containing the cumulated results of the question for a given survey.

Definition at line 136 of file class.SurveyQuestion.php.

$db

SurveyQuestion::$db

protected

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

Referenced by SurveySingleChoiceQuestion\addPhrase(), createNewQuestion(), delete(), deleteAdditionalTableData(), SurveySingleChoiceQuestion\getCategoriesForPhrase(), getCopyIds(), SurveySingleChoiceQuestion\getMaxSumScore(), getPhrase(), SurveyTextQuestion\getQuestionDataArray(), SurveySingleChoiceQuestion\getQuestionDataArray(), getQuestionTypeID(), SurveyTextQuestion\loadFromDb(), SurveySingleChoiceQuestion\loadFromDb(), loadFromDb(), phraseExists(), questionTitleExists(), SurveySingleChoiceQuestion\saveCategoriesToDb(), saveCategoryToDb(), saveCompletionStatus(), saveMaterial(), SurveySingleChoiceQuestion\savePhrase(), SurveyTextQuestion\saveToDb(), SurveySingleChoiceQuestion\saveToDb(), saveToDb(), SurveyTextQuestion\saveUserInput(), SurveySingleChoiceQuestion\saveUserInput(), and syncWithOriginal().

$description

SurveyQuestion::$description

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

Referenced by SurveyTextQuestion\__construct(), SurveySingleChoiceQuestion\__construct(), SurveyMultipleChoiceQuestion\__construct(), SurveyMetricQuestion\__construct(), SurveyMatrixQuestion\__construct(), __construct(), and setDescription().

$id

SurveyQuestion::$id

Definition at line 51 of file class.SurveyQuestion.php.

Referenced by getId(), SurveyTextQuestion\getQuestionDataArray(), SurveyMultipleChoiceQuestion\getQuestionDataArray(), SurveySingleChoiceQuestion\getQuestionDataArray(), SurveyMetricQuestion\getQuestionDataArray(), SurveyMatrixQuestion\getQuestionDataArray(), SurveyTextQuestion\importResponses(), SurveyMultipleChoiceQuestion\importResponses(), SurveyMetricQuestion\importResponses(), SurveySingleChoiceQuestion\importResponses(), SurveyMatrixQuestion\importResponses(), SurveyTextQuestion\loadFromDb(), SurveyMultipleChoiceQuestion\loadFromDb(), SurveySingleChoiceQuestion\loadFromDb(), SurveyMetricQuestion\loadFromDb(), SurveyMatrixQuestion\loadFromDb(), setId(), setSurveyId(), and syncWithOriginal().

$lng

SurveyQuestion::$lng

Definition at line 121 of file class.SurveyQuestion.php.

Referenced by __construct(), _getQuestionTypeName(), SurveyMultipleChoiceQuestion\getPreconditionOptions(), and SurveySingleChoiceQuestion\getPreconditionOptions().

$log

SurveyQuestion::$log

protected

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

$material

SurveyQuestion::$material

Definition at line 130 of file class.SurveyQuestion.php.

Referenced by getMaterial(), SurveyMultipleChoiceQuestion\importResponses(), SurveySingleChoiceQuestion\importResponses(), SurveyMatrixQuestion\importResponses(), QTIMaterialToString(), and saveMaterial().

$materials

SurveyQuestion::$materials

Definition at line 86 of file class.SurveyQuestion.php.

$obj_id

SurveyQuestion::$obj_id

Definition at line 100 of file class.SurveyQuestion.php.

Referenced by createNewQuestion(), delete(), getObjId(), and setObjId().

$obligatory

SurveyQuestion::$obligatory

Definition at line 114 of file class.SurveyQuestion.php.

Referenced by setObligatory().

$orientation

SurveyQuestion::$orientation

Definition at line 128 of file class.SurveyQuestion.php.

Referenced by SurveySingleChoiceQuestion\__construct(), SurveyMultipleChoiceQuestion\__construct(), getOrientation(), and setOrientation().

$owner

SurveyQuestion::$owner

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

Referenced by SurveyTextQuestion\__construct(), SurveySingleChoiceQuestion\__construct(), SurveyMultipleChoiceQuestion\__construct(), SurveyMetricQuestion\__construct(), SurveyMatrixQuestion\__construct(), __construct(), duplicate(), getOwner(), and setOwner().

$questiontext

SurveyQuestion::$questiontext

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

Referenced by SurveyTextQuestion\__construct(), SurveySingleChoiceQuestion\__construct(), SurveyMultipleChoiceQuestion\__construct(), SurveyMetricQuestion\__construct(), SurveyMatrixQuestion\__construct(), __construct(), and setQuestiontext().

$survey_id

SurveyQuestion::$survey_id

Definition at line 93 of file class.SurveyQuestion.php.

Referenced by SurveyTextQuestion\checkUserInput(), SurveyMultipleChoiceQuestion\checkUserInput(), SurveyMetricQuestion\checkUserInput(), SurveySingleChoiceQuestion\checkUserInput(), SurveyMatrixQuestion\checkUserInput(), and getSurveyId().

$title

SurveyQuestion::$title

Definition at line 58 of file class.SurveyQuestion.php.

Referenced by SurveyTextQuestion\__construct(), SurveySingleChoiceQuestion\__construct(), SurveyMultipleChoiceQuestion\__construct(), SurveyMetricQuestion\__construct(), SurveyMatrixQuestion\__construct(), __construct(), copyObject(), duplicate(), SurveyMultipleChoiceQuestion\getPreconditionSelectValue(), SurveyMetricQuestion\getPreconditionSelectValue(), SurveySingleChoiceQuestion\getPreconditionSelectValue(), SurveyMatrixQuestion\getPreconditionSelectValue(), getTitle(), phraseExists(), questionTitleExists(), SurveySingleChoiceQuestion\savePhrase(), SurveyMatrixQuestion\savePhrase(), and setTitle().

$user

SurveyQuestion::$user

protected

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

Referenced by SurveySingleChoiceQuestion\addPhrase(), phraseExists(), saveCategoryToDb(), SurveySingleChoiceQuestion\savePhrase(), and setAuthor().

---

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

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