SurveyQuestion Class Reference

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

Inheritance diagram for SurveyQuestion:

Collaboration diagram for SurveyQuestion:

Public Member Functions
	__construct (string $title="", string $description="", string $author="", string $questiontext="", int $owner=-1)
	setComplete (bool $a_complete)
	isComplete ()
	questionTitleExists (string $title, int $questionpool_object=0)
	setTitle (string $title="")
	setObligatory (bool $obligatory=true)
	setOrientation (int $orientation=0)
	setId (int $id=-1)
	setSurveyId (int $id=-1)
	setDescription (string $description="")
	addMaterials (string $materials_file, string $materials_name="")
	setMaterialsfile (string $materials_filename, string $materials_tempfilename="", string $materials_name="")
	Uploads and adds a material. More...
	deleteMaterial (string $materials_name="")
	flushMaterials ()
	Deletes all materials uris. More...
	setAuthor (string $author="")
	setQuestiontext (string $questiontext="")
	setOwner (int $owner=0)
	getTitle ()
	getLabel ()
	getId ()
	getObligatory ()
	getSurveyId ()
	getOrientation ()
	getDescription ()
	getAuthor ()
	getOwner ()
	getQuestiontext ()
	getObjId ()
	Get the reference(?) id of the container object. More...
	setObjId (int $obj_id=0)
	Set the reference(?) id of the container object. More...
	duplicate (bool $for_survey=true, string $title="", string $author="", int $owner=0, int $a_survey_id=0)
	copyObject (int $target_questionpool, string $title="")
	copyXHTMLMediaObjectsOfQuestion (int $a_q_id)
	Copy media object usages from other question. More...
	loadFromDb (int $question_id)
	load question data into object note: this base implementation only loads the material data More...
	saveCompletionStatus (int $original_id=0)
	Saves the complete flag to the database. More...
	saveToDb (int $original_id=0)
	Saves a SurveyQuestion object to a database. More...
	saveMaterial ()
	createNewQuestion ()
	Creates a new question with a 0 timestamp when a new question is created This assures that an ID is given to the question if a file upload or something else occurs. More...
	getImagePath ()
	Returns the image path for web accessible images of a question. More...
	getMaterialsPath ()
	Returns the materials path for web accessible materials of a question. More...
	getImagePathWeb ()
	Returns the web image path for web accessible images of a question. More...
	getMaterialsPathWeb ()
	Returns the web image path for web accessable images of a question. More...
	saveCategoryToDb (string $categorytext, int $neutral=0)
	Saves a category to the database. More...
	deleteAdditionalTableData (int $question_id)
	Deletes datasets from the additional question table in the database. More...
	delete (int $question_id)
	Deletes a question and all materials from the database. More...
	syncWithOriginal ()
	getPhrase (int $phrase_id)
	Returns a phrase title for phrase id. More...
	phraseExists (string $title)
	Returns true if the phrase title already exists for the current user(!) More...
	deleteMaterials (array $a_array)
	duplicateMaterials (int $question_id)
	Duplicates the materials of a question. More...
	addMaterial (ilSurveyMaterial $obj_material)
	getQuestionTypeID ()
	getQuestionType ()
	isHTML (string $a_text)
	QTIMaterialToString (ilQTIMaterial $a_material)
	Reads an QTI material tag an creates a text string. More...
	addMaterialTag (ilXmlWriter $a_xml_writer, string $a_material, bool $close_material_tag=true, bool $add_mobs=true, ?array $a_attrs=null)
	Creates an XML material tag from a plain text or xhtml text. More...
	prepareTextareaOutput (string $txt_output, bool $prepare_for_latex_output=false)
	Prepares string for a text area output in surveys. More...
	getQuestionDataArray (int $id)
	Returns the question data. More...
	getWorkingDataFromUserInput (array $post_data)
	Creates the user data of the svy_answer table from the POST data. More...
	importAdditionalMetadata (array $a_meta)
	Import additional meta data from the question import file. More...
	importResponses (array $a_data)
	Import response data from the question import file. More...
	importAdjectives (array $a_data)
	Import bipolar adjectives from the question import file. More...
	importMatrix (array $a_data)
	Import matrix rows from the question import file. More...
	usableForPrecondition ()
	Returns if the question is usable for preconditions. More...
	getAvailableRelations ()
	Returns the available relations for the question. More...
	getPreconditionOptions ()
	Returns the options for preconditions. More...
	getPreconditionValueOutput (string $value)
	Returns the output for a precondition value. More...
	getPreconditionSelectValue (string $default, string $title, string $variable)
	Creates a form property for the precondition value. More...
	setOriginalId (?int $original_id)
	getOriginalId ()
	getMaterial ()
	setSubtype (int $a_subtype)
	getSubtype ()
	__get (string $value)
	__set (string $key, string $value)
	getCopyIds (bool $a_group_by_survey=false)
	hasCopies ()
	stripSlashesAddSpaceFallback (string $a_str)
	Strip slashes with add space fallback, see https://mantis.ilias.de/view.php?id=19727 and https://mantis.ilias.de/view.php?id=24200. More...

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

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

Protected Attributes
int	$original_id
ILIAS SurveyQuestionPool Editing EditSessionRepository	$edit_manager
ilObjUser	$user
ilDBInterface	$db
array	$cumulated
ilLogger	$log
ILIAS SurveyQuestionPool Export ImportSessionRepository	$import_manager

Private Attributes
array	$arrData

Detailed Description

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

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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

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

Constructor & Destructor Documentation

__construct()

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

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

References $author, $description, $DIC, $ilUser, $lng, $owner, $questiontext, $title, ilLoggerFactory\getLogger(), ILIAS\Repository\lng(), and ILIAS\Repository\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');
        $this->import_manager = $DIC->surveyQuestionPool()
            ->internal()
            ->repo()
            ->import();

        $this->edit_manager = $DIC->surveyQuestionPool()
            ->internal()
            ->repo()
            ->editing();
    }

Here is the call graph for this function:

Member Function Documentation

__get()

SurveyQuestion::__get

(

string

$value

)

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

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

                return null;
        }
    }

__set()

SurveyQuestion::__set	(	string	$key,
		string	$value
	)

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

References ILIAS\LTI\ToolProvider\$key.

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

_changeOriginalId()

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

static

Change original id of existing question in db.

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

References $DIC, and $ilDB.

Referenced by ilSurveyEditorGUI\executeCopyQuestionsToPoolObject().

     : void {
        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 ( string  $target = "", int  $a_parent_ref_id = null  )

static

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

References $target_id, $type, and ilFileUtils\removeTrailingPathSeparators().

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

     : string {
        $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 "StructureObject":
                case "PageObject":
                case "GlossaryItem":
                case "LearningModule":
                    $href = ilFileUtils::removeTrailingPathSeparators(ILIAS_HTTP_PATH) . "/goto.php?target=" . $type . "_" . $target_id;
                    break;
                case "MediaObject":
                    $href = ilFileUtils::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 ( int  $question_id, bool  $a_return_question_id_if_no_original = true  )

static

Returns the original id of a question.

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

References $DIC, and $ilDB.

Referenced by ilObjSurvey\importObject().

     : int {
        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 (int) $row["original_id"];
            } elseif ($a_return_question_id_if_no_original) { // #12419
                return (int) $row["question_id"];
            }
        }
        return 0;
    }

Here is the caller graph for this function:

_getQuestionType()

static SurveyQuestion::_getQuestionType ( int  $question_id )

static

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

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

References $data, $DIC, and $ilDB.

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

                                                             : string
    {
        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 ( string  $type_tag )

static

Return the translation for a given question type.

Parameters

string

$type_tag

type of the question type

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

References $DIC, and ilLanguage\txt().

Referenced by ilSurveyConstraintsGUI\constraintForm(), ilObjSurveyQuestionPoolGUI\deleteQuestionsObject(), SurveyMatrixQuestionEvaluation\exportResults(), SurveyQuestionEvaluation\exportResults(), ilSurveyEvaluationGUI\exportResultsDetailsExcel(), ilSurveyQuestionsTableGUI\fillRow(), ilSurveyResultsCumulatedTableGUI\getItems(), ILIAS\Survey\Mode\AbstractUIModifier\getPanelCard(), and ilSurveyEditorGUI\removeQuestionsForm().

     : string {
        global $DIC;

        if (file_exists("./Modules/SurveyQuestionPool/Questions/class." . $type_tag . ".php")) {
            $lng = $DIC->language();
            return $lng->txt($type_tag);
        } else {
            $component_factory = $DIC["component.factory"];
            foreach ($component_factory->getActivePluginsInSlot("svyq") as $pl) {
                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 ( int  $question_id )

static

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

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

References $data, $DIC, and $ilDB.

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

                                                      : string
    {
        global $DIC;

        $ilDB = $DIC->database();

        $result = $ilDB->queryF(
            "SELECT title FROM svy_question WHERE svy_question.question_id = %s",
            array('integer'),
            array($question_id)
        );

        if ($data = $ilDB->fetchAssoc($result)) {
            return (string) $data["title"];
        }
        return "";
    }

Here is the caller graph for this function:

_includeClass()

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

static

Include the php class file for a given question type.

Parameters

int

$gui

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

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

References $DIC, and $type.

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

     : bool {
        $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;

            $component_factory = $DIC["component.factory"];
            foreach ($component_factory->getActivePluginsInSlot("svyq") as $pl) {
                if (strcmp($pl->getQuestionType(), $question_type) === 0) {
                    return true;
                }
            }
        }
        return false;
    }

Here is the caller graph for this function:

_instanciateQuestion()

static SurveyQuestion::_instanciateQuestion ( int  $question_id )

static

Get question object.

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

Referenced by ilSurveySkill\determineMaxScale(), ilObjSurveyQuestionPool\duplicateQuestion(), ilObjMediaObject\getParentObjectIdForUsage(), ilSurveyImporter\getSurvey(), SurveySingleChoiceQuestion\isSumScoreValid(), ilObjSurveyQuestionPool\removeQuestion(), and ilSurveyExecutionGUI\saveActiveQuestionData().

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

Here is the caller graph for this function:

_instanciateQuestionEvaluation()

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

static

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

Referenced by ilSurveyEvaluationGUI\evaluation(), ilSurveyEvaluationGUI\exportCumulatedResults(), ilSurveyEvaluationGUI\exportEvaluationUser(), ILIAS\Survey\PrintView\ResultsDetailsPrintViewProviderGUI\getPages(), ilSurveyEvaluationGUI\getSumScores(), ILIAS\Survey\Evaluation\EvaluationManager\getUserSpecificResults(), and ilObjSurvey\getUserSpecificResults().

     : ?SurveyQuestionEvaluation {
        $question = self::_instanciateQuestion($question_id);
        if (is_null($a_finished_ids)) {
            $a_finished_ids = [];
        }
        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;
        }
        return null;
    }

Here is the caller graph for this function:

_instanciateQuestionGUI()

static SurveyQuestion::_instanciateQuestionGUI ( int  $question_id )

static

Get question gui object.

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

     : ?SurveyQuestionGUI {
        $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;
        }
        return null;
    }

_isComplete()

static SurveyQuestion::_isComplete ( int  $question_id )

static

Checks whether the question is complete or not.

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

References $DIC, and $ilDB.

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

                                                        : bool
    {
        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 ((int) $row["complete"] === 1) {
                return true;
            }
        }
        return false;
    }

Here is the caller graph for this function:

_isWriteable()

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

static

is question writeable by a certain user

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

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

Referenced by SurveyQuestionGUI\save().

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

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_lookupSurveyObjId()

static SurveyQuestion::_lookupSurveyObjId ( int  $a_question_id )

static

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

References $DIC, and $ilDB.

Referenced by ilObjMediaObject\getParentObjectIdForUsage().

     : ?int {
        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 (int) $row["obj_fi"];
        }
        return null;
    }

Here is the caller graph for this function:

_questionExists()

static SurveyQuestion::_questionExists ( int  $question_id )

static

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

References $DIC, $ilDB, $target_id, $type, ilGlossaryTerm\_lookGlossaryTerm(), ilLMObject\_lookupContObjID(), addMaterial(), ILIAS\Repository\lng(), and saveMaterial().

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

                                                            : bool
    {
        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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_resolveInternalLink()

static SurveyQuestion::_resolveInternalLink ( string  $internal_link )

static

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

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

     : string {
        $resolved_link = "";
        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 ( int  $question_id )

static

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

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

Referenced by ilQuestionPageParser\processPagesToParse().

     : void {
        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:

addMaterial()

SurveyQuestion::addMaterial

(

ilSurveyMaterial

$obj_material

)

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

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

Referenced by _questionExists().

                                                               : void
    {
        $this->material[] = $obj_material;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addMaterials()

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

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

Referenced by setMaterialsfile().

     : void {
        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	(	ilXmlWriter	$a_xml_writer,
		string	$a_material,
		bool	$close_material_tag = true,
		bool	$add_mobs = true,
		?array	$a_attrs = null
	)

Creates an XML material tag from a plain text or xhtml text.

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

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

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

     : void {
        $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	(	int	$target_questionpool,
		string	$title = ""
	)

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

References getId(), and getObjId().

     : ?int {
        if ($this->getId() <= 0) {
            // The question has not been saved. It cannot be copied
            return null;
        }
        $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

(

int

$a_q_id

)

Copy media object usages from other question.

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

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

     : void {
        $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

int ID of the new question

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

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

                                       : int
    {
        $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

(

int

$question_id

)

Deletes a question and all materials from the database.

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

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

                                            : void
    {
        $ilDB = $this->db;
        $this->log->debug("Question Delete... " . $question_id);
        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)) {
            ilFileUtils::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();
        }
        $this->log->debug("Call ilSurveySkill::handleQuestionDeletion, q id: " . $question_id .
            ", obj id: " . $obj_id);
        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

(

int

$question_id

)

Deletes datasets from the additional question table in the database.

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

References $db, and $ilDB.

Referenced by delete().

                                                               : void
    {
        $ilDB = $this->db;

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

        $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

(

string

$materials_name = ""

)

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

References ILIAS\LTI\ToolProvider\$key, and getMaterialsPath().

     : void {
        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

(

array

$a_array

)

Parameters

array

$a_array

Array with indexes of the materials to delete

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

References saveMaterial().

                                                   : void
    {
        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	(	bool	$for_survey = true,
		string	$title = "",
		string	$author = "",
		int	$owner = 0,
		int	$a_survey_id = 0
	)

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

References getId().

     : ?int {
        if ($this->getId() <= 0) {
            // The question has not been saved. It cannot be duplicated
            return null;
        }
        // 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

(

int

$question_id

)

Duplicates the materials of a question.

Parameters

int

$question_id

Exceptions

ilSurveyException

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

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

                                                        : void
    {
        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)) {
                ilFileUtils::makeDirParents($materialspath);
            }
            if (!copy($materialspath_original . $filename, $materialspath . $filename)) {
                throw new ilSurveyException("Unable to duplicate materials.");
            }
        }
    }

Here is the call graph for this function:

flushMaterials()

SurveyQuestion::flushMaterials

(

)

Deletes all materials uris.

Todo:

check if unlink is necessary

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

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

getAuthor()

SurveyQuestion::getAuthor

(

)

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

References $author.

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

                               : string
    {
        return $this->author;
    }

Here is the caller graph for this function:

getAvailableRelations()

SurveyQuestion::getAvailableRelations

(

)

Returns the available relations for the question.

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

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

getCopyIds()

SurveyQuestion::getCopyIds

(

bool

$a_group_by_survey = false

)

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

References $db, $ilDB, $res, and ILIAS\Repository\int().

Referenced by hasCopies().

     : array {
        $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[] = (int) $row["question_id"];
            } else {
                $res[$row["obj_fi"]][] = (int) $row["question_id"];
            }
        }
        return $res;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDescription()

SurveyQuestion::getDescription

(

)

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

References $description.

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

                                    : string
    {
        return $this->description;
    }

Here is the caller graph for this function:

getId()

SurveyQuestion::getId

(

)

Definition at line 253 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(), SurveyMetricQuestion\getWorkingDataFromUserInput(), SurveySingleChoiceQuestion\getWorkingDataFromUserInput(), SurveyMatrixQuestion\getWorkingDataFromUserInput(), SurveyTextQuestion\insertXML(), SurveyMultipleChoiceQuestion\insertXML(), SurveyMetricQuestion\insertXML(), SurveySingleChoiceQuestion\insertXML(), SurveyMatrixQuestion\insertXML(), loadFromDb(), SurveyMatrixQuestion\saveBipolarAdjectives(), SurveyMultipleChoiceQuestion\saveCategoriesToDb(), SurveySingleChoiceQuestion\saveCategoriesToDb(), SurveyMatrixQuestion\saveColumnsToDb(), saveCompletionStatus(), SurveyMatrixQuestion\saveLayout(), saveMaterial(), SurveyMatrixQuestion\saveRowsToDb(), SurveyMultipleChoiceQuestion\saveToDb(), SurveyTextQuestion\saveToDb(), SurveyMetricQuestion\saveToDb(), SurveySingleChoiceQuestion\saveToDb(), SurveyMatrixQuestion\saveToDb(), saveToDb(), SurveyTextQuestion\saveUserInput(), SurveyMultipleChoiceQuestion\saveUserInput(), SurveyMetricQuestion\saveUserInput(), SurveySingleChoiceQuestion\saveUserInput(), SurveyMatrixQuestion\saveUserInput(), and syncWithOriginal().

                           : int
    {
        return $this->id;
    }

Here is the caller graph for this function:

getImagePath()

SurveyQuestion::getImagePath

(

)

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

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

References CLIENT_WEB_DIR.

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

getImagePathWeb()

SurveyQuestion::getImagePathWeb

(

)

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

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

References CLIENT_WEB_DIR, and ilFileUtils\removeTrailingPathSeparators().

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

Here is the call graph for this function:

getLabel()

SurveyQuestion::getLabel

(

)

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

                              : string
    {
        return $this->label;
    }

getMaterial()

SurveyQuestion::getMaterial

(

)

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

References $material.

                                 : array
    {
        return $this->material;
    }

getMaterialsPath()

SurveyQuestion::getMaterialsPath

(

)

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

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

References CLIENT_WEB_DIR.

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

                                      : string
    {
        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.

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

References CLIENT_WEB_DIR, and ilFileUtils\removeTrailingPathSeparators().

                                         : string
    {
        $webdir = ilFileUtils::removeTrailingPathSeparators(CLIENT_WEB_DIR) . "/survey/$this->obj_id/$this->id/materials/";
        return str_replace(
            ilFileUtils::removeTrailingPathSeparators(ILIAS_ABSOLUTE_PATH),
            ilFileUtils::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)

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

                                                         : int
    {
        return 0;
    }

getObjId()

SurveyQuestion::getObjId

(

)

Get the reference(?) id of the container object.

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

References $obj_id.

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

                              : int
    {
        return $this->obj_id;
    }

Here is the caller graph for this function:

getObligatory()

SurveyQuestion::getObligatory

(

)

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

References $obligatory.

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

                                   : bool
    {
        return $this->obligatory;
    }

Here is the caller graph for this function:

getOrientation()

SurveyQuestion::getOrientation

(

)

Returns

int 0 = vertical, 1 = horizontal

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

References $orientation.

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

                                    : int
    {
        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 1593 of file class.SurveyQuestion.php.

References $original_id.

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

                                   : ?int
    {
        return $this->original_id;
    }

Here is the caller graph for this function:

getOwner()

SurveyQuestion::getOwner

(

)

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

References $owner.

Referenced by createNewQuestion(), and saveToDb().

                              : int
    {
        return $this->owner;
    }

Here is the caller graph for this function:

getPhrase()

SurveyQuestion::getPhrase

(

int

$phrase_id

)

Returns a phrase title for phrase id.

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

References $db, and $ilDB.

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

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

Referenced by SurveyMatrixQuestion\getPreconditionSelectValue().

                                            : array
    {
        // overwrite in inherited classes
        return [];
    }

Here is the caller graph for this function:

getPreconditionSelectValue()

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

Creates a form property for the precondition value.

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

     : ?ilFormPropertyGUI {
        // overwrite in inherited classes
        return null;
    }

getPreconditionValueOutput()

SurveyQuestion::getPreconditionValueOutput

(

string

$value

)

Returns the output for a precondition value.

Parameters

string

$value

The precondition value

Returns

string The output of the precondition value

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

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

getQuestionDataArray()

SurveyQuestion::getQuestionDataArray

(

int

$id

)

Returns the question data.

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

                                                 : array
    {
        return array();
    }

getQuestiontext()

SurveyQuestion::getQuestiontext

(

)

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

References $questiontext.

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

                                     : string
    {
        return $this->questiontext;
    }

Here is the caller graph for this function:

getQuestionType()

SurveyQuestion::getQuestionType

(

)

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

Referenced by SurveyMatrixQuestionEvaluation\exportResults(), SurveyQuestionEvaluation\exportResults(), and getQuestionTypeID().

                                     : string
    {
        return "";
    }

Here is the caller graph for this function:

getQuestionTypeID()

SurveyQuestion::getQuestionTypeID

(

)

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

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

Referenced by createNewQuestion(), and saveToDb().

                                       : int
    {
        $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 (int) $row["questiontype_id"];
        }

        return 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSubtype()

SurveyQuestion::getSubtype

(

)

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

                                : ?int
    {
        // do nothing
        return null;
    }

getSurveyId()

SurveyQuestion::getSurveyId

(

)

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

References $survey_id.

                                 : int
    {
        return $this->survey_id;
    }

getTitle()

SurveyQuestion::getTitle

(

)

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

References $title.

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

                              : string
    {
        return $this->title;
    }

Here is the caller graph for this function:

getWorkingDataFromUserInput()

SurveyQuestion::getWorkingDataFromUserInput

(

array

$post_data

)

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

Returns

array User data according to the svy_answer table

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

References $data.

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

hasCopies()

SurveyQuestion::hasCopies

(

)

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

References getCopyIds().

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

Here is the call graph for this function:

importAdditionalMetadata()

SurveyQuestion::importAdditionalMetadata

(

array

$a_meta

)

Import additional meta data from the question import file.

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

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

                                                           : void
    {
        // overwrite in inherited classes
    }

importAdjectives()

SurveyQuestion::importAdjectives

(

array

$a_data

)

Import bipolar adjectives from the question import file.

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

                                                   : void
    {
        // overwrite in inherited classes
    }

importMatrix()

SurveyQuestion::importMatrix

(

array

$a_data

)

Import matrix rows from the question import file.

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

                                               : void
    {
        // overwrite in inherited classes
    }

importResponses()

SurveyQuestion::importResponses

(

array

$a_data

)

Import response data from the question import file.

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

                                                  : void
    {
        // overwrite in inherited classes
    }

isComplete()

SurveyQuestion::isComplete

(

)

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

Referenced by saveCompletionStatus(), and saveToDb().

                                : bool
    {
        return false;
    }

Here is the caller graph for this function:

isHTML()

SurveyQuestion::isHTML

(

string

$a_text

)

Todo:

move to manager

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

Referenced by addMaterialTag().

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

        return false;
    }

Here is the caller graph for this function:

loadFromDb()

SurveyQuestion::loadFromDb

(

int

$question_id

)

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

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

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

                                                : void
    {
        $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 = (string) $row['material_type'];
                $mat->internal_link = (string) $row['internal_link'];
                $mat->title = (string) $row['material_title'];
                $mat->import_id = (string) $row['import_id'];
                $mat->text_material = (string) $row['text_material'];
                $mat->external_link = (string) $row['external_link'];
                $mat->file_material = (string) $row['file_material'];
                $this->material[] = $mat;
            }
        }
    }

Here is the call graph for this function:

lookupObjFi()

static SurveyQuestion::lookupObjFi ( int  $a_qid )

static

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

References $DIC, and $ilDB.

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

     : ?int {
        global $DIC;

        $ilDB = $DIC->database();

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

Here is the caller graph for this function:

phraseExists()

SurveyQuestion::phraseExists

(

string

$title

)

Returns true if the phrase title already exists for the current user(!)

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

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

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

prepareTextareaOutput()

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

Prepares string for a text area output in surveys.

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

References ilLegacyFormElementsUtil\prepareTextareaOutput().

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

Here is the call graph for this function:

QTIMaterialToString()

SurveyQuestion::QTIMaterialToString

(

ilQTIMaterial

$a_material

)

Reads an QTI material tag an creates a text string.

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

References $i, ilLoggerFactory\getLogger(), ilQTIMaterial\getMaterial(), and ilQTIMaterial\getMaterialCount().

                                                                  : string
    {
        $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
                    $this->import_manager->addMob(
                        $matimage->getLabel(),
                        $matimage->getUri()
                    );
                }
            }
        }
        return $result;
    }

Here is the call graph for this function:

questionTitleExists()

SurveyQuestion::questionTitleExists	(	string	$title,
		int	$questionpool_object = 0
	)

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

References $db, and $ilDB.

     : bool {
        $ilDB = $this->db;

        $refwhere = "";
        if ($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;
    }

saveCategoryToDb()

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

Saves a category to the database.

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

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

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

     : int {
        $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 = "";
        $insert = true;
        if ($result->numRows()) {
            while ($row = $ilDB->fetchAssoc($result)) {
                if (strcmp($row["title"], $categorytext) === 0) {
                    $returnvalue = $row["category_id"];
                    $insert = false;
                }
            }
        }
        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

(

int

$original_id = 0

)

Saves the complete flag to the database.

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

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

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

     : void {
        $ilDB = $this->db;

        $question_id = $this->getId();
        if ($original_id > 0) {
            $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

(

)

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

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

Referenced by _questionExists(), addMaterial(), deleteMaterials(), SurveyMultipleChoiceQuestion\saveToDb(), SurveyTextQuestion\saveToDb(), SurveyMetricQuestion\saveToDb(), SurveySingleChoiceQuestion\saveToDb(), and SurveyMatrixQuestion\saveToDb().

                                  : void
    {
        $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], (int) $matches[3], (int) $matches[1]);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveToDb()

SurveyQuestion::saveToDb

(

int

$original_id = 0

)

Saves a SurveyQuestion object to a database.

Definition at line 479 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().

                                                  : int
    {
        $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) ?: 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:

setAuthor()

SurveyQuestion::setAuthor

(

string

$author = ""

)

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

References $author, $ilUser, and $user.

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

                                                  : void
    {
        $ilUser = $this->user;

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

Here is the caller graph for this function:

setComplete()

SurveyQuestion::setComplete

(

bool

$a_complete

)

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

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

                                                 : void
    {
        $this->complete = $a_complete;
    }

Here is the caller graph for this function:

setDescription()

SurveyQuestion::setDescription

(

string

$description = ""

)

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

References $description.

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

                                                            : void
    {
        $this->description = $description;
    }

Here is the caller graph for this function:

setId()

SurveyQuestion::setId

(

int

$id = -1

)

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

References $id.

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

                                       : void
    {
        $this->id = $id;
    }

Here is the caller graph for this function:

setMaterialsfile()

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

Uploads and adds a material.

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

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

     : void {
        if (!empty($materials_filename)) {
            $materialspath = $this->getMaterialsPath();
            if (!file_exists($materialspath)) {
                ilFileUtils::makeDirParents($materialspath);
            }
            if (ilFileUtils::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

(

int

$obj_id = 0

)

Set the reference(?) id of the container object.

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

References $obj_id.

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

                                             : void
    {
        $this->obj_id = $obj_id;
    }

Here is the caller graph for this function:

setObligatory()

SurveyQuestion::setObligatory

(

bool

$obligatory = true

)

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

References $obligatory.

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

                                                          : void
    {
        $this->obligatory = $obligatory;
    }

Here is the caller graph for this function:

setOrientation()

SurveyQuestion::setOrientation

(

int

$orientation = 0

)

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

References $orientation.

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

                                                        : void
    {
        $this->orientation = $orientation;
    }

Here is the caller graph for this function:

setOriginalId()

SurveyQuestion::setOriginalId

(

?int

$original_id

)

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

References $original_id.

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

                                                    : void
    {
        $this->original_id = $original_id;
    }

Here is the caller graph for this function:

setOwner()

SurveyQuestion::setOwner

(

int

$owner = 0

)

Parameters

int

$owner

user id of owner

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

References $owner.

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

                                            : void
    {
        $this->owner = $owner;
    }

Here is the caller graph for this function:

setQuestiontext()

SurveyQuestion::setQuestiontext

(

string

$questiontext = ""

)

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

References $questiontext.

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

                                                              : void
    {
        $this->questiontext = $questiontext;
    }

Here is the caller graph for this function:

setSubtype()

SurveyQuestion::setSubtype

(

int

$a_subtype

)

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

                                              : void
    {
        // do nothing
    }

setSurveyId()

SurveyQuestion::setSurveyId

(

int

$id = -1

)

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

References $id.

                                             : void
    {
        $this->survey_id = $id;
    }

setTitle()

SurveyQuestion::setTitle

(

string

$title = ""

)

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

References $title.

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

                                                : void
    {
        $this->title = $title;
    }

Here is the caller graph for this function:

stripSlashesAddSpaceFallback()

SurveyQuestion::stripSlashesAddSpaceFallback

(

string

$a_str

)

Strip slashes with add space fallback, see https://mantis.ilias.de/view.php?id=19727 and https://mantis.ilias.de/view.php?id=24200.

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

References ilUtil\stripSlashes().

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

                                                               : string
    {
        $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 891 of file class.SurveyQuestion.php.

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

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

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

                                           : bool
    {
        // overwrite in inherited classes
        return false;
    }

Field Documentation

$arrData

array SurveyQuestion::$arrData

private

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

$author

string SurveyQuestion::$author

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

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

$complete

bool SurveyQuestion::$complete

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

$cumulated

array SurveyQuestion::$cumulated

protected

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

$db

ilDBInterface SurveyQuestion::$db

protected

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

Referenced by SurveySingleChoiceQuestion\addPhrase(), SurveyMatrixQuestion\addPhrase(), createNewQuestion(), delete(), deleteAdditionalTableData(), SurveyMatrixQuestion\deleteAdditionalTableData(), SurveySingleChoiceQuestion\getCategoriesForPhrase(), getCopyIds(), SurveyMultipleChoiceQuestion\getMaxSumScore(), SurveySingleChoiceQuestion\getMaxSumScore(), SurveyMatrixQuestion\getMaxSumScore(), getPhrase(), SurveyMultipleChoiceQuestion\getQuestionDataArray(), SurveyTextQuestion\getQuestionDataArray(), SurveyMetricQuestion\getQuestionDataArray(), SurveySingleChoiceQuestion\getQuestionDataArray(), SurveyMatrixQuestion\getQuestionDataArray(), SurveyMetricQuestion\getQuestionTypeID(), getQuestionTypeID(), SurveyMultipleChoiceQuestion\loadFromDb(), SurveyTextQuestion\loadFromDb(), SurveyMetricQuestion\loadFromDb(), SurveySingleChoiceQuestion\loadFromDb(), SurveyMatrixQuestion\loadFromDb(), loadFromDb(), phraseExists(), questionTitleExists(), SurveyMatrixQuestion\saveBipolarAdjectives(), SurveyMultipleChoiceQuestion\saveCategoriesToDb(), SurveySingleChoiceQuestion\saveCategoriesToDb(), saveCategoryToDb(), SurveyMatrixQuestion\saveColumnsToDb(), SurveyMatrixQuestion\saveColumnToDb(), saveCompletionStatus(), SurveyMatrixQuestion\saveLayout(), saveMaterial(), SurveySingleChoiceQuestion\savePhrase(), SurveyMatrixQuestion\savePhrase(), SurveyMatrixQuestion\saveRowsToDb(), SurveyMultipleChoiceQuestion\saveToDb(), SurveyTextQuestion\saveToDb(), SurveyMetricQuestion\saveToDb(), SurveySingleChoiceQuestion\saveToDb(), SurveyMatrixQuestion\saveToDb(), saveToDb(), SurveyTextQuestion\saveUserInput(), SurveyMultipleChoiceQuestion\saveUserInput(), SurveyMetricQuestion\saveUserInput(), SurveySingleChoiceQuestion\saveUserInput(), SurveyMatrixQuestion\saveUserInput(), and syncWithOriginal().

$description

string SurveyQuestion::$description

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

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

$edit_manager

ILIAS SurveyQuestionPool Editing EditSessionRepository SurveyQuestion::$edit_manager

protected

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

$id

int SurveyQuestion::$id

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

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

$import_manager

ILIAS SurveyQuestionPool Export ImportSessionRepository SurveyQuestion::$import_manager

protected

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

$lng

ilLanguage SurveyQuestion::$lng

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

Referenced by __construct().

$log

ilLogger SurveyQuestion::$log

protected

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

$material

array SurveyQuestion::$material

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

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

$materials

array SurveyQuestion::$materials

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

$obj_id

int SurveyQuestion::$obj_id

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

Referenced by getObjId(), and setObjId().

$obligatory

bool SurveyQuestion::$obligatory

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

Referenced by getObligatory(), and setObligatory().

$orientation

int SurveyQuestion::$orientation

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

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

$original_id

int SurveyQuestion::$original_id

protected

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

Referenced by getOriginalId(), SurveyMatrixQuestion\saveColumnsToDb(), saveCompletionStatus(), SurveyMatrixQuestion\saveRowsToDb(), SurveyMultipleChoiceQuestion\saveToDb(), SurveyTextQuestion\saveToDb(), SurveyMetricQuestion\saveToDb(), SurveySingleChoiceQuestion\saveToDb(), SurveyMatrixQuestion\saveToDb(), and setOriginalId().

$owner

int SurveyQuestion::$owner

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

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

$questiontext

string SurveyQuestion::$questiontext

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

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

$survey_id

int SurveyQuestion::$survey_id

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

Referenced by getSurveyId().

$title

string SurveyQuestion::$title

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

Referenced by SurveyMultipleChoiceQuestion\__construct(), SurveySingleChoiceQuestion\__construct(), SurveyTextQuestion\__construct(), SurveyMetricQuestion\__construct(), __construct(), SurveyMatrixQuestion\__construct(), SurveySingleChoiceQuestion\getPreconditionValueOutput(), getTitle(), and setTitle().

$user

ilObjUser SurveyQuestion::$user

protected

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

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

---

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

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