SurveyTextQuestion 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 SurveyTextQuestion:

Collaboration diagram for SurveyTextQuestion:

Public Member Functions
	__construct (string $title="", string $description="", string $author="", string $questiontext="", int $owner=-1)
	getQuestionDataArray (int $id)
	loadFromDb (int $question_id)
	isComplete ()
	setMaxChars (int $maxchars=0)
	getMaxChars ()
	saveToDb (int $original_id=0)
	toXML (bool $a_include_header=true, bool $obligatory_state=false)
	insertXML (ilXmlWriter $a_xml_writer, $a_include_header=true)
	getQuestionType ()
	getAdditionalTableName ()
	getWorkingDataFromUserInput (array $post_data)
	checkUserInput (array $post_data, int $survey_id)
	Checks the input of the active user for obligatory status and entered values. More...
	saveUserInput (array $post_data, int $active_id, bool $a_return=false)
	importResponses (array $a_data)
	usableForPrecondition ()
	getTextWidth ()
	getTextHeight ()
	setTextWidth (?int $a_textwidth=null)
	setTextHeight (?int $a_textheight=null)
Public Member Functions inherited from SurveyQuestion
	__construct (string $title="", string $description="", string $author="", string $questiontext="", int $owner=-1)
	setComplete (bool $a_complete)
	isComplete ()
	questionTitleExists (string $title, int $questionpool_object=0)
	setTitle (string $title="")
	setObligatory (bool $obligatory=true)
	setOrientation (int $orientation=0)
	setId (int $id=-1)
	setSurveyId (int $id=-1)
	setDescription (string $description="")
	addMaterials (string $materials_file, string $materials_name="")
	setMaterialsfile (string $materials_filename, string $materials_tempfilename="", string $materials_name="")
	Uploads and adds a material. More...
	deleteMaterial (string $materials_name="")
	flushMaterials ()
	Deletes all materials uris. More...
	setAuthor (string $author="")
	setQuestiontext (string $questiontext="")
	setOwner (int $owner=0)
	getTitle ()
	getLabel ()
	getId ()
	getObligatory ()
	getSurveyId ()
	getOrientation ()
	getDescription ()
	getAuthor ()
	getOwner ()
	getQuestiontext ()
	getObjId ()
	Get the reference(?) id of the container object. More...
	setObjId (int $obj_id=0)
	Set the reference(?) id of the container object. More...
	duplicate (bool $for_survey=true, string $title="", string $author="", int $owner=0, int $a_survey_id=0)
	copyObject (int $target_questionpool, string $title="")
	copyXHTMLMediaObjectsOfQuestion (int $a_q_id)
	Copy media object usages from other question. More...
	loadFromDb (int $question_id)
	load question data into object note: this base implementation only loads the material data More...
	saveCompletionStatus (int $original_id=0)
	Saves the complete flag to the database. More...
	saveToDb (int $original_id=0)
	Saves a SurveyQuestion object to a database. More...
	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 ()
	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...

Protected Attributes
int	$maxchars = null
int	$textwidth = null
int	$textheight = null
Protected Attributes inherited from SurveyQuestion
int	$original_id
ILIAS SurveyQuestionPool Editing EditSessionRepository	$edit_manager
ilObjUser	$user
ilDBInterface	$db
array	$cumulated
ilLogger	$log
ILIAS SurveyQuestionPool Export ImportSessionRepository	$import_manager

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

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

The SurveyTextQuestion class defines and encapsulates basic methods and attributes for text survey question types.

Author

Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m

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

Constructor & Destructor Documentation

__construct()

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

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

References SurveyQuestion\$author, SurveyQuestion\$description, $DIC, SurveyQuestion\$owner, SurveyQuestion\$questiontext, SurveyQuestion\$title, and ILIAS\MetaData\Repository\Validation\Data\__construct().

      {
        global $DIC;

        $this->db = $DIC->database();
        parent::__construct($title, $description, $author, $questiontext, $owner);

        $this->maxchars = 0;
        $this->textwidth = 50;
        $this->textheight = 5;
    }

Here is the call graph for this function:

Member Function Documentation

checkUserInput()

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

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

Definition at line 233 of file class.SurveyTextQuestion.php.

References SurveyQuestion\getId(), getMaxChars(), SurveyQuestion\getObligatory(), ILIAS\Repository\lng(), and ilStr\strLen().

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

        if ((!$this->getObligatory()) && (strlen($entered_value ?? "") == 0)) {
            return "";
        }

        if (strlen($entered_value ?? "") == 0) {
            return $this->lng->txt("text_question_not_filled_out");
        }

        // see bug #22648
        if ($this->getMaxChars() > 0 && ilStr::strLen($entered_value) > $this->getMaxChars()) {
            return str_replace("%s", ilStr::strLen($entered_value), $this->lng->txt("svy_answer_too_long"));
        }

        return "";
    }

Here is the call graph for this function:

getAdditionalTableName()

SurveyTextQuestion::getAdditionalTableName

(

)

Definition at line 213 of file class.SurveyTextQuestion.php.

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

                                            : string
    {
        return "svy_qst_text";
    }

Here is the caller graph for this function:

getMaxChars()

SurveyTextQuestion::getMaxChars

(

)

Definition at line 113 of file class.SurveyTextQuestion.php.

References $maxchars.

Referenced by checkUserInput(), insertXML(), saveToDb(), and saveUserInput().

                                 : int
    {
        return $this->maxchars;
    }

Here is the caller graph for this function:

getQuestionDataArray()

SurveyTextQuestion::getQuestionDataArray

(

int

$id

)

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

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

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

Here is the call graph for this function:

getQuestionType()

SurveyTextQuestion::getQuestionType

(

)

Definition at line 208 of file class.SurveyTextQuestion.php.

Referenced by insertXML().

                                     : string
    {
        return "SurveyTextQuestion";
    }

Here is the caller graph for this function:

getTextHeight()

SurveyTextQuestion::getTextHeight

(

)

Definition at line 316 of file class.SurveyTextQuestion.php.

References $textheight.

Referenced by insertXML(), and saveToDb().

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

Here is the caller graph for this function:

getTextWidth()

SurveyTextQuestion::getTextWidth

(

)

Definition at line 311 of file class.SurveyTextQuestion.php.

References $textwidth.

Referenced by insertXML(), and saveToDb().

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

Here is the caller graph for this function:

getWorkingDataFromUserInput()

SurveyTextQuestion::getWorkingDataFromUserInput

(

array

$post_data

)

Definition at line 218 of file class.SurveyTextQuestion.php.

References $data, and SurveyQuestion\getId().

     : array {
        $entered_value = $post_data[$this->getId() . "_text_question"] ?? "";
        $data = array();
        if (strlen($entered_value ?? "")) {
            $data[] = array("textanswer" => $entered_value);
        }
        return $data;
    }

Here is the call graph for this function:

importResponses()

SurveyTextQuestion::importResponses

(

array

$a_data

)

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

References $data, SurveyQuestion\$id, setMaxChars(), setTextHeight(), and setTextWidth().

                                                  : void
    {
        foreach ($a_data as $id => $data) {
            if ($data["maxlength"] > 0) {
                $this->setMaxChars($data["maxlength"]);
            }
            if ($data["rows"] > 0) {
                $this->setTextHeight($data["rows"]);
            }
            if ($data["columns"] > 0) {
                $this->setTextWidth($data["columns"]);
            }
        }
    }

Here is the call graph for this function:

insertXML()

SurveyTextQuestion::insertXML	(	ilXmlWriter	$a_xml_writer,
			$a_include_header = true
	)

Definition at line 153 of file class.SurveyTextQuestion.php.

References SurveyQuestion\addMaterialTag(), SurveyQuestion\getAuthor(), SurveyQuestion\getDescription(), SurveyQuestion\getId(), getMaxChars(), SurveyQuestion\getObligatory(), SurveyQuestion\getQuestiontext(), getQuestionType(), getTextHeight(), getTextWidth(), SurveyQuestion\getTitle(), IL_INST_ID, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by toXML().

     : void {
        $attrs = array(
            "id" => $this->getId(),
            "title" => $this->getTitle(),
            "type" => $this->getQuestionType(),
            "obligatory" => $this->getObligatory()
        );
        $a_xml_writer->xmlStartTag("question", $attrs);

        $a_xml_writer->xmlElement("description", null, $this->getDescription());
        $a_xml_writer->xmlElement("author", null, $this->getAuthor());
        if (strlen($this->label ?? "")) {
            $attrs = array(
                "label" => $this->label,
            );
        } else {
            $attrs = array();
        }
        $a_xml_writer->xmlStartTag("questiontext", $attrs);
        $this->addMaterialTag($a_xml_writer, $this->getQuestiontext());
        $a_xml_writer->xmlEndTag("questiontext");

        $a_xml_writer->xmlStartTag("responses");
        $attrs = array(
            "id" => "0",
            "rows" => $this->getTextHeight(),
            "columns" => $this->getTextWidth()
        );
        if ($this->getMaxChars() > 0) {
            $attrs["maxlength"] = $this->getMaxChars();
        }
        $a_xml_writer->xmlElement("response_text", $attrs);
        $a_xml_writer->xmlEndTag("responses");

        if (count($this->material)) {
            if (preg_match("/il_(\d*?)_(\w+)_(\d+)/", $this->material["internal_link"], $matches)) {
                $attrs = array(
                    "label" => $this->material["title"]
                );
                $a_xml_writer->xmlStartTag("material", $attrs);
                $intlink = "il_" . IL_INST_ID . "_" . $matches[2] . "_" . $matches[3];
                if (strcmp($matches[1], "") != 0) {
                    $intlink = $this->material["internal_link"];
                }
                $a_xml_writer->xmlElement("mattext", null, $intlink);
                $a_xml_writer->xmlEndTag("material");
            }
        }

        $a_xml_writer->xmlEndTag("question");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isComplete()

SurveyTextQuestion::isComplete

(

)

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

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

                                : bool
    {
        if (
            strlen($this->getTitle() ?? "") &&
            strlen($this->getAuthor() ?? "") &&
            strlen($this->getQuestiontext() ?? "")
        ) {
            return true;
        } else {
            return false;
        }
    }

Here is the call graph for this function:

loadFromDb()

SurveyTextQuestion::loadFromDb

(

int

$question_id

)

Definition at line 65 of file class.SurveyTextQuestion.php.

References $data, SurveyQuestion\$db, $ilDB, ilRTE\_replaceMediaObjectImageSrc(), getAdditionalTableName(), SurveyQuestion\setAuthor(), SurveyQuestion\setComplete(), SurveyQuestion\setDescription(), SurveyQuestion\setId(), setMaxChars(), SurveyQuestion\setObjId(), SurveyQuestion\setObligatory(), SurveyQuestion\setOriginalId(), SurveyQuestion\setOwner(), SurveyQuestion\setQuestiontext(), setTextHeight(), setTextWidth(), and SurveyQuestion\setTitle().

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

        $result = $ilDB->queryF(
            "SELECT svy_question.*, " . $this->getAdditionalTableName() . ".* FROM svy_question LEFT JOIN " . $this->getAdditionalTableName() . " ON " . $this->getAdditionalTableName() . ".question_fi = svy_question.question_id WHERE svy_question.question_id = %s",
            array('integer'),
            array($question_id)
        );
        if ($result->numRows() === 1) {
            $data = $ilDB->fetchAssoc($result);
            $this->setId((int) $data["question_id"]);
            $this->setTitle((string) $data["title"]);
            $this->label = (string) $data['label'];
            $this->setDescription((string) $data["description"]);
            $this->setObjId((int) $data["obj_fi"]);
            $this->setAuthor((string) $data["author"]);
            $this->setOwner((int) $data["owner_fi"]);
            $this->setQuestiontext(ilRTE::_replaceMediaObjectImageSrc((string) $data["questiontext"], 1));
            $this->setObligatory((bool) $data["obligatory"]);
            $this->setComplete((bool) $data["complete"]);
            $this->setOriginalId((int) $data["original_id"]);

            $this->setMaxChars((int) $data["maxchars"]);
            $this->setTextWidth($data["width"] ? (int) $data["width"] : null);
            $this->setTextHeight($data["height"] ? (int) $data["height"] : null);
        }
        parent::loadFromDb($question_id);
    }

Here is the call graph for this function:

saveToDb()

SurveyTextQuestion::saveToDb

(

int

$original_id = 0

)

Definition at line 118 of file class.SurveyTextQuestion.php.

References SurveyQuestion\$db, $ilDB, SurveyQuestion\$original_id, getAdditionalTableName(), SurveyQuestion\getId(), getMaxChars(), getTextHeight(), and getTextWidth().

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

        $affectedRows = parent::saveToDb($original_id);
        if ($affectedRows === 1) {
            $ilDB->manipulateF(
                "DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
                array('integer'),
                array($this->getId())
            );
            $ilDB->manipulateF(
                "INSERT INTO " . $this->getAdditionalTableName() . " (question_fi, maxchars, width, height) VALUES (%s, %s, %s, %s)",
                array('integer', 'integer', 'integer', 'integer'),
                array($this->getId(), $this->getMaxChars(), $this->getTextWidth(), $this->getTextHeight())
            );
        }
        return $affectedRows;
    }

Here is the call graph for this function:

saveUserInput()

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

Definition at line 255 of file class.SurveyTextQuestion.php.

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

     : ?array {
        $ilDB = $this->db;

        $entered_value = $this->stripSlashesAddSpaceFallback($post_data[$this->getId() . "_text_question"]);
        $maxchars = $this->getMaxChars();

        if ($maxchars > 0) {
            $entered_value = ilStr::subStr($entered_value, 0, $maxchars);
        }

        if ($a_return) {
            return array(array("value" => null, "textanswer" => $entered_value));
        }
        if (strlen($entered_value ?? "") == 0) {
            return null;
        }

        $next_id = $ilDB->nextId('svy_answer');
        #20216
        $fields = array();
        $fields['answer_id'] = array("integer", $next_id);
        $fields['question_fi'] = array("integer", $this->getId());
        $fields['active_fi'] = array("integer", $active_id);
        $fields['value'] = array("float", null);
        $fields['textanswer'] = array("clob", (strlen($entered_value ?? "")) ? $entered_value : null);
        $fields['tstamp'] = array("integer", time());

        $ilDB->insert("svy_answer", $fields);

        return null;
    }

Here is the call graph for this function:

setMaxChars()

SurveyTextQuestion::setMaxChars

(

int

$maxchars = 0

)

Definition at line 108 of file class.SurveyTextQuestion.php.

References $maxchars.

Referenced by importResponses(), and loadFromDb().

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

Here is the caller graph for this function:

setTextHeight()

SurveyTextQuestion::setTextHeight

(

?int

$a_textheight = null

)

Definition at line 330 of file class.SurveyTextQuestion.php.

Referenced by importResponses(), and loadFromDb().

                                                            : void
    {
        if ($a_textheight < 1) {
            $this->textheight = 5;
        } else {
            $this->textheight = $a_textheight;
        }
    }

Here is the caller graph for this function:

setTextWidth()

SurveyTextQuestion::setTextWidth

(

?int

$a_textwidth = null

)

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

Referenced by importResponses(), and loadFromDb().

                                                          : void
    {
        if ($a_textwidth < 1) {
            $this->textwidth = 50;
        } else {
            $this->textwidth = $a_textwidth;
        }
    }

Here is the caller graph for this function:

toXML()

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

Definition at line 138 of file class.SurveyTextQuestion.php.

References insertXML().

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

Here is the call graph for this function:

usableForPrecondition()

SurveyTextQuestion::usableForPrecondition

(

)

Definition at line 306 of file class.SurveyTextQuestion.php.

                                           : bool
    {
        return false;
    }

Field Documentation

$maxchars

int SurveyTextQuestion::$maxchars = null

protected

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

Referenced by getMaxChars(), and setMaxChars().

$textheight

int SurveyTextQuestion::$textheight = null

protected

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

Referenced by getTextHeight().

$textwidth

int SurveyTextQuestion::$textwidth = null

protected

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

Referenced by getTextWidth().

---

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

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