Text survey question. More...

Inheritance diagram for SurveyTextQuestion:

Collaboration diagram for SurveyTextQuestion:

Public Member Functions
	SurveyTextQuestion ( $title="", $description="", $author="", $questiontext="", $owner=-1)
	The constructor takes possible arguments an creates an instance of the SurveyTextQuestion object. More...

	_getQuestionDataArray ($id)
	Returns the question data fields from the database. More...

	loadFromDb ($id)
	Loads a SurveyTextQuestion object from the database. More...

	isComplete ()
	Returns true if the question is complete for use. More...

	setMaxChars ($maxchars=0)
	Sets the maximum number of allowed characters for the text answer. More...

	getMaxChars ()
	Returns the maximum number of allowed characters for the text answer. More...

	saveToDb ($original_id="")
	Saves a SurveyTextQuestion object to a database. More...

	toXML ($a_include_header=TRUE, $obligatory_state="")
	Returns an xml representation of the question. More...

	insertXML (&$a_xml_writer, $a_include_header=TRUE, $obligatory_state="")
	Adds the question XML to a given XMLWriter object. More...

	_getMaxChars ($question_id)
	Returns the maxium number of allowed characters for the text answer. More...

	getQuestionType ()
	Returns the question type of the question. More...

	getAdditionalTableName ()
	Returns the name of the additional question data table in the database. More...

&	getWorkingDataFromUserInput ($post_data)
	Creates the user data of the svy_answer table from the POST data. More...

	checkUserInput ($post_data, $survey_id)
	Checks the input of the active user for obligatory status and entered values. More...

	randomText ($length)

	saveRandomData ($active_id)
	Saves random answers for a given active user in the database. More...

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

&	getCumulatedResults ($survey_id, $nr_of_users, $finished_ids)

	setExportDetailsXLS (&$workbook, &$format_title, &$format_bold, &$eval_data, $export_label)
	Creates an Excel worksheet for the detailed cumulated results of this question. More...

	addUserSpecificResultsData (&$a_array, &$resultset)
	Adds the values for the user specific results export for a given user. More...

&	getUserAnswers ($survey_id, $finished_ids)
	Returns an array containing all answers to this question in a given survey. More...

	importResponses ($a_data)
	Import response data from the question import file. More...

	usableForPrecondition ()
	Returns if the question is usable for preconditions. More...

	getTextWidth ()
	Returns the width of the answer field. More...

	getTextHeight ()
	Returns the height of the answer field. More...

	setTextWidth ($a_textwidth)
	Sets the width of the answer field. More...

	setTextHeight ($a_textheight)
	Sets the height of the answer field. More...

Public Member Functions inherited from SurveyQuestion
	SurveyQuestion ( $title="", $description="", $author="", $questiontext="", $owner=-1)
	SurveyQuestion constructor The constructor takes possible arguments an creates an instance of the SurveyQuestion object. More...

	_SurveyQuestion ()

	setComplete ($a_complete)
	Sets the complete state of the question. More...

	isComplete ()
	Returns 1, if a question is complete for use. More...

	questionTitleExists ($title, $questionpool_object="")
	Returns TRUE if the question title exists in the database. More...

	setTitle ($title="")
	Sets the title string of the SurveyQuestion object. More...

	setObligatory ($obligatory=1)
	Sets the obligatory state of the question. More...

	setOrientation ($orientation=0)
	Sets the orientation of the question output. More...

	setId ($id=-1)
	Sets the id of the SurveyQuestion object. More...

	setSurveyId ($id=-1)
	Sets the survey id of the SurveyQuestion object. More...

	setDescription ($description="")
	Sets the description string of the SurveyQuestion object. More...

	addMaterials ($materials_file, $materials_name="")
	Sets the materials uri. More...

	setMaterialsfile ($materials_filename, $materials_tempfilename="", $materials_name="")
	Sets and uploads the materials uri. More...

	deleteMaterial ($materials_name="")
	Deletes a materials uri with a given name. More...

	flushMaterials ()
	Deletes all materials uris. More...

	setAuthor ($author="")
	Sets the authors name of the SurveyQuestion object. More...

	setQuestiontext ($questiontext="")
	Sets the questiontext of the SurveyQuestion object. More...

	setOwner ($owner="")
	Sets the creator/owner ID of the SurveyQuestion object. More...

	getTitle ()
	Gets the title string of the SurveyQuestion object. More...

	getId ()
	Gets the id of the SurveyQuestion object. More...

	getObligatory ($survey_id="")
	Gets the obligatory state of the question. More...

	getSurveyId ()
	Gets the survey id of the SurveyQuestion object. More...

	getOrientation ()
	Gets the orientation of the question output. More...

	getDescription ()
	Gets the description string of the SurveyQuestion object. More...

	getAuthor ()
	Gets the authors name of the SurveyQuestion object. More...

	getOwner ()
	Gets the creator/owner ID of the SurveyQuestion object. More...

	getQuestiontext ()
	Gets the questiontext of the SurveyQuestion object. More...

	getObjId ()
	Get the reference id of the container object. More...

	setObjId ($obj_id=0)
	Set the reference id of the container object. More...

	duplicate ($for_survey=true, $title="", $author="", $owner="")
	Duplicates a survey question. More...

	copyObject ($target_questionpool, $title="")
	Copies an assOrderingQuestion object. More...

	copyXHTMLMediaObjectsOfQuestion ($a_q_id)
	Increases the media object usage counter when a question is duplicated. More...

	loadFromDb ($question_id)
	Loads a SurveyQuestion object from the database. More...

	_isComplete ($question_id)
	Checks whether the question is complete or not. More...

	saveCompletionStatus ($original_id="")
	Saves the complete flag to the database. More...

	saveToDb ($original_id="")
	Saves a SurveyQuestion object to a database. More...

	saveMaterial ()
	save material to db More...

	createNewQuestion ()
	Creates a new question with a 0 timestamp when a new question is created This assures that an ID is given to the question if a file upload or something else occurs. More...

	saveWorkingData ($limit_to=LIMIT_NO_LIMIT)
	Saves the learners input of the question to the database. More...

	getImagePath ()
	Returns the image path for web accessable images of a question. More...

	getMaterialsPath ()
	Returns the materials path for web accessable materials of a question. More...

	getImagePathWeb ()
	Returns the web image path for web accessable images of a question. More...

	getMaterialsPathWeb ()
	Returns the web image path for web accessable images of a question. More...

	saveCategoryToDb ($categorytext, $neutral=0)
	Saves a category to the database. More...

	deleteAdditionalTableData ($question_id)
	Deletes datasets from the additional question table in the database. More...

	delete ($question_id)
	Deletes a question and all materials from the database. More...

	_getQuestionType ($question_id)
	Returns the question type of a question with a given id. More...

	_getTitle ($question_id)
	Returns the question title of a question with a given id. More...

	_getOriginalId ($question_id, $a_return_question_id_if_no_original=true)
	Returns the original id of a question. More...

	syncWithOriginal ()

	getPhrase ($phrase_id)
	Returns a phrase for a given database id. More...

	phraseExists ($title)
	Returns true if the phrase title already exists for the current user. More...

	_questionExists ($question_id)
	Returns true if the question already exists in the database. More...

	addInternalLink ($material_id, $title="")

	deleteMaterials ($a_array)
	Deletes materials. More...

	duplicateMaterials ($question_id)
	Duplicates the materials of a question. More...

	addMaterial ($obj_material)

	setMaterial ($material_id="", $is_import=false, $material_title="")
	Sets a material link for the question. More...

	_resolveInternalLink ($internal_link)

	_resolveIntLinks ($question_id)

	_getInternalLinkHref ($target="", $a_parent_ref_id=null)

	_isWriteable ($question_id, $user_id)
	Returns true if the question is writeable by a certain user. More...

	getQuestionTypeID ()
	Returns the question type ID of the question. More...

	getQuestionType ()
	Returns the question type of the question. More...

&	_instanciateQuestion ($question_id)
	Creates an instance of a question with a given question id. More...

&	_instanciateQuestionGUI ($question_id)
	Creates an instance of a question GUI with a given question id. More...

	isHTML ($a_text)
	Checks if a given string contains HTML or not. More...

	QTIMaterialToString ($a_material)
	Reads an QTI material tag an creates a text string. More...

	addMaterialTag (&$a_xml_writer, $a_material, $close_material_tag=TRUE, $add_mobs=TRUE, $a_attrs=null)
	Creates an XML material tag from a plain text or xhtml text. More...

	prepareTextareaOutput ($txt_output, $prepare_for_latex_output=FALSE)
	Prepares a string for a text area output in surveys. More...

	_getQuestionDataArray ($id)
	Returns the question data fields from the database. More...

	addUserSpecificResultsExportTitles (&$a_array, $a_use_label=false, $a_substitute=true)
	Adds the entries for the title row of the user specific results. More...

	addUserSpecificResultsData (&$a_array, &$resultset)
	Adds the values for the user specific results export for a given user. More...

&	getUserAnswers ($survey_id)
	Returns an array containing all answers to this question in a given survey. More...

&	getWorkingDataFromUserInput ($post_data)
	Creates the user data of the svy_answer table from the POST data. More...

	importAdditionalMetadata ($a_meta)
	Import additional meta data from the question import file. More...

	importResponses ($a_data)
	Import response data from the question import file. More...

	importAdjectives ($a_data)
	Import bipolar adjectives from the question import file. More...

	importMatrix ($a_data)
	Import matrix rows from the question import file. More...

	setExportCumulatedXLS (&$worksheet, &$format_title, &$format_bold, &$eval_data, $row, $export_label)
	Creates the Excel output for the cumulated results of this question. More...

&	setExportCumulatedCVS (&$eval_data, $export_label)
	Creates the CSV output for the cumulated results of this question. More...

	setExportDetailsXLS (&$workbook, &$format_title, &$format_bold, &$eval_data, $export_label)
	Creates an Excel worksheet for the detailed cumulated results of this question. More...

	usableForPrecondition ()
	Returns if the question is usable for preconditions. More...

	getAvailableRelations ()
	Returns the available relations for the question. More...

	getPreconditionOptions ()
	Returns the options for preconditions. More...

	getPreconditionValueOutput ($value)
	Returns the output for a precondition value. More...

	getPreconditionSelectValue ($default="", $title, $variable)
	Creates a form property for the precondition value. More...

	outChart ($survey_id, $type="")
	Creates an image visualising the results of the question. More...

	setOriginalId ($original_id)

	getOriginalId ()

	saveRandomData ($active_id)
	Saves random answers for a given active user in the database. More...

	getMaterial ()

	setSubtype ($a_subtype)

	getSubtype ()

	getCumulatedResultData ($survey_id, $counter, $finished_ids)
	Creates a the cumulated results data for the question. More...

	__get ($value)
	Object getter. More...

	__set ($key, $value)
	Object setter. More...

	getCopyIds ($a_group_by_survey=false)

	hasCopies ()

	getSkippedValue ()

Data Fields
	$maxchars

	$textwidth

	$textheight

Data Fields inherited from SurveyQuestion
	$id

	$title

	$description

	$owner

	$author

	$materials

	$survey_id

	$obj_id

	$questiontext

	$obligatory

	$ilias

	$tpl

	$lng

	$orientation

	$material

	$complete

Additional Inherited Members
Static Public Member Functions inherited from SurveyQuestion
static	_includeClass ($question_type, $gui=0)
	Include the php class file for a given question type. More...

static	_getQuestionTypeName ($type_tag)
	Return the translation for a given question type tag. More...

static	_changeOriginalId ($a_question_id, $a_original_id, $a_object_id)
	Change original id of existing question in db. More...

Protected Member Functions inherited from SurveyQuestion
&	calculateCumulatedResults ($survey_id, $finished_ids)

Protected Attributes inherited from SurveyQuestion
	$cumulated
	An array containing the cumulated results of the question for a given survey. More...

Detailed Description

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

Version: $Id$

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

Member Function Documentation

◆ _getMaxChars()

SurveyTextQuestion::_getMaxChars ( $question_id )

Returns the maxium number of allowed characters for the text answer.

Returns: integer The maximum number of characters public

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

References $result, and $row.

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

◆ _getQuestionDataArray()

SurveyTextQuestion::_getQuestionDataArray ( $id )

Returns the question data fields from the database.

Parameters

integer $id The question ID from the database

Returns: array Array containing the question fields and data from the database public

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

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

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

◆ addUserSpecificResultsData()

SurveyTextQuestion::addUserSpecificResultsData	(	&	$a_array,
		&	$resultset
	)

Adds the values for the user specific results export for a given user.

Parameters

array	$a_array	An array which is used to append the values
array	$resultset	The evaluation data for a given user public

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

References SurveyQuestion\getId(), and SurveyQuestion\getSkippedValue().

         {
                 if (count($resultset["answers"][$this->getId()]))
                 {
                         foreach ($resultset["answers"][$this->getId()] as $key => $answer)
                         {
                                 array_push($a_array, $answer["textanswer"]);
                         }
                 }
                 else
                 {
                         array_push($a_array, $this->getSkippedValue());
                 }
         }

Here is the call graph for this function:

◆ checkUserInput()

SurveyTextQuestion::checkUserInput	(	$post_data,
		$survey_id
	)

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

Parameters

array	$post_data	The contents of the $_POST array
integer	$survey_id	The database ID of the active survey

Returns: string Empty string if the input is ok, an error message otherwise public

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

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

         {
                 $entered_value = $post_data[$this->getId() . "_text_question"];
                 
                 if ((!$this->getObligatory($survey_id)) && (strlen($entered_value) == 0)) return "";
                 
                 if (strlen($entered_value) == 0) return $this->lng->txt("text_question_not_filled_out");
 
                 return "";
         }

Here is the call graph for this function:

◆ getAdditionalTableName()

SurveyTextQuestion::getAdditionalTableName ( )

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

Returns: string The additional table name public

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

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

         {
                 return "svy_qst_text";
         }

Here is the caller graph for this function:

◆ getCumulatedResults()

& SurveyTextQuestion::getCumulatedResults	(	$survey_id,
		$nr_of_users,
		$finished_ids
	)

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

References SurveyQuestion\$cumulated, $result, $row, SurveyQuestion\$survey_id, and SurveyQuestion\getId().

         {
                 global $ilDB;
                 
                 $question_id = $this->getId();
                 
                 $result_array = array();
                 $cumulated = array();
                 $textvalues = array();
                 
                 $sql = "SELECT svy_answer.* FROM svy_answer".
                         " JOIN svy_finished ON (svy_finished.finished_id = svy_answer.active_fi)".
                         " WHERE svy_answer.question_fi = ".$ilDB->quote($question_id, "integer").
                         " AND svy_finished.survey_fi = ".$ilDB->quote($survey_id, "integer");           
                 if($finished_ids)
                 {
                         $sql .= " AND ".$ilDB->in("svy_finished.finished_id", $finished_ids, "", "integer");
                 }
 
                 $result = $ilDB->query($sql);           
                 while ($row = $ilDB->fetchAssoc($result))
                 {
                         $cumulated[$row["value"]]++;
                         array_push($textvalues, $row["textanswer"]);
                 }
                 asort($cumulated, SORT_NUMERIC);
                 end($cumulated);
                 $numrows = $result->numRows();
                 $result_array["USERS_ANSWERED"] = $result->numRows();
                 $result_array["USERS_SKIPPED"] = $nr_of_users - $result->numRows();
                 $result_array["QUESTION_TYPE"] = "SurveyTextQuestion";
                 $result_array["textvalues"] = $textvalues;
                 return $result_array;
         }

Here is the call graph for this function:

◆ getMaxChars()

SurveyTextQuestion::getMaxChars ( )

Returns the maximum number of allowed characters for the text answer.

public

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

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

         {
                 return ($this->maxchars) ? $this->maxchars : NULL;
         }

Here is the caller graph for this function:

◆ getQuestionType()

SurveyTextQuestion::getQuestionType ( )

Returns the question type of the question.

Returns: integer The question type of the question public

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

         {
                 return "SurveyTextQuestion";
         }

◆ getTextHeight()

SurveyTextQuestion::getTextHeight ( )

Returns the height of the answer field.

Returns: integer The height of the answer field in characters public

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

Referenced by insertXML(), and saveToDb().

         {
                 return ($this->textheight) ? $this->textheight : NULL;
         }

Here is the caller graph for this function:

◆ getTextWidth()

SurveyTextQuestion::getTextWidth ( )

Returns the width of the answer field.

Returns: integer The width of the answer field in characters public

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

Referenced by insertXML(), and saveToDb().

         {
                 return ($this->textwidth) ? $this->textwidth : NULL;
         }

Here is the caller graph for this function:

◆ getUserAnswers()

& SurveyTextQuestion::getUserAnswers	(	$survey_id,
		$finished_ids
	)

Returns an array containing all answers to this question in a given survey.

Parameters

integer $survey_id The database ID of the survey

Returns: array An array containing the answers to the question. The keys are either the user id or the anonymous id public

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

References $result, $row, SurveyQuestion\$survey_id, and SurveyQuestion\getId().

         {
                 global $ilDB;
                 
                 $answers = array();
                 
                 $sql = "SELECT svy_answer.* FROM svy_answer, svy_finished".
                         " WHERE svy_finished.survey_fi = ".$ilDB->quote($survey_id, "integer").
                         " AND svy_answer.question_fi = ".$ilDB->quote($this->getId(), "integer").
                         " AND svy_finished.finished_id = svy_answer.active_fi"; 
                 if($finished_ids)
                 {
                         $sql .= " AND ".$ilDB->in("svy_finished.finished_id", $finished_ids, "", "integer");
                 }
                 $result = $ilDB->query($sql);
                 while ($row = $ilDB->fetchAssoc($result))
                 {
                         $answers[$row["active_fi"]] = $row["textanswer"];
                 }
                 return $answers;
         }

Here is the call graph for this function:

◆ getWorkingDataFromUserInput()

& SurveyTextQuestion::getWorkingDataFromUserInput ( $post_data )

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

Returns: array User data according to the svy_answer table public

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

References $data, and SurveyQuestion\getId().

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

Here is the call graph for this function:

◆ importResponses()

SurveyTextQuestion::importResponses ( $a_data )

Import response data from the question import file.

Returns: array $a_data Array containing the response data public

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

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

         {
                 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	(	&	$a_xml_writer,
			$a_include_header = `TRUE`,
			$obligatory_state = `""`
	)

Adds the question XML to a given XMLWriter object.

Parameters

object	$a_xml_writer	The XMLWriter object
boolean	$a_include_header	Determines wheather or not the XML should be used
string	$obligatory_state	The value of the obligatory state public

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

References SurveyQuestion\addMaterialTag(), SurveyQuestion\getAuthor(), SurveyQuestion\getDescription(), SurveyQuestion\getId(), getMaxChars(), SurveyQuestion\getObligatory(), SurveyQuestion\getQuestiontext(), getTextHeight(), getTextWidth(), and SurveyQuestion\getTitle().

Referenced by toXML().

         {
                 $attrs = array(
                         "id" => $this->getId(),
                         "title" => $this->getTitle(),
                         "type" => $this->getQuestiontype(),
                         "obligatory" => $this->getObligatory()
                 );
                 $a_xml_writer->xmlStartTag("question", $attrs);
                 
                 $a_xml_writer->xmlElement("description", NULL, $this->getDescription());
                 $a_xml_writer->xmlElement("author", NULL, $this->getAuthor());
                 if (strlen($this->label))
                 {
                         $attrs = array(
                                 "label" => $this->label,
                         );
                 }
                 else
                 {
                         $attrs = array();
                 }
                 $a_xml_writer->xmlStartTag("questiontext", $attrs);
                 $this->addMaterialTag($a_xml_writer, $this->getQuestiontext());
                 $a_xml_writer->xmlEndTag("questiontext");
 
                 $a_xml_writer->xmlStartTag("responses");
                 $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 ( )

Returns true if the question is complete for use.

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

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

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

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

Here is the call graph for this function:

◆ loadFromDb()

SurveyTextQuestion::loadFromDb ( $id )

Loads a SurveyTextQuestion object from the database.

Parameters

integer $id The database id of the text survey question public

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

References $data, SurveyQuestion\$id, $result, ilRTE\_replaceMediaObjectImageSrc(), ilDB\fetchAssoc(), 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().

         {
                 global $ilDB;
                 
                 $result = $ilDB->queryF("SELECT svy_question.*, " . $this->getAdditionalTableName() . ".* FROM svy_question LEFT JOIN " . $this->getAdditionalTableName() . " ON " . $this->getAdditionalTableName() . ".question_fi = svy_question.question_id WHERE svy_question.question_id = %s",
                         array('integer'),
                         array($id)
                 );
                 if ($result->numRows() == 1) 
                 {
                         $data = $ilDB->fetchAssoc($result);
                         $this->setId($data["question_id"]);
                         $this->setTitle($data["title"]);
                         $this->label = $data['label'];
                         $this->setDescription($data["description"]);
                         $this->setObjId($data["obj_fi"]);
                         $this->setAuthor($data["author"]);
                         $this->setOwner($data["owner_fi"]);
                         include_once("./Services/RTE/classes/class.ilRTE.php");
                         $this->setQuestiontext(ilRTE::_replaceMediaObjectImageSrc($data["questiontext"], 1));
                         $this->setObligatory($data["obligatory"]);
                         $this->setComplete($data["complete"]);
                         $this->setOriginalId($data["original_id"]);
 
                         $this->setMaxChars($data["maxchars"]);
                         $this->setTextWidth($data["width"]);
                         $this->setTextHeight($data["height"]);
 
                 }
                 parent::loadFromDb($id);
         }

Here is the call graph for this function:

◆ randomText()

SurveyTextQuestion::randomText ( $length )

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

Referenced by saveRandomData().

         {
                 $random= "";
                 $char_list = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
                 $char_list .= "abcdefghijklmnopqrstuvwxyz";
                 $char_list .= "1234567890";
                 for($i = 0; $i < $length; $i++)
                 { 
                         $random .= substr($char_list,(rand()%(strlen($char_list))), 1);
                         if (!rand(0,5)) $random .= ' ';
                 }
                 return $random;
         }

Here is the caller graph for this function:

◆ saveRandomData()

SurveyTextQuestion::saveRandomData ( $active_id )

Saves random answers for a given active user in the database.

Parameters

integer $active_id The database ID of the active user

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

References SurveyQuestion\getId(), and randomText().

         {
                 global $ilDB;
                 // single response
                 $randomtext = $this->randomText(rand(25,100));
                 $next_id = $ilDB->nextId('svy_answer');
                 $affectedRows = $ilDB->manipulateF("INSERT INTO svy_answer (answer_id, question_fi, active_fi, value, textanswer, tstamp) VALUES (%s, %s, %s, %s, %s, %s)",
                         array('integer', 'integer', 'integer', 'float', 'text', 'integer'),
                         array($next_id, $this->getId(), $active_id, NULL, $randomtext, time())
                 );
         }

Here is the call graph for this function:

◆ saveToDb()

SurveyTextQuestion::saveToDb ( $original_id = "" )

Saves a SurveyTextQuestion object to a database.

public

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

References getAdditionalTableName(), SurveyQuestion\getId(), getMaxChars(), getTextHeight(), getTextWidth(), and SurveyQuestion\saveMaterial().

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

Here is the call graph for this function:

◆ saveUserInput()

SurveyTextQuestion::saveUserInput	(	$post_data,
		$active_id,
		$a_return = `false`
	)

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

References SurveyQuestion\getId(), getMaxChars(), and ilUtil\stripSlashes().

         {
                 global $ilDB;
 
                 include_once "./Services/Utilities/classes/class.ilUtil.php";
                 $entered_value = ilUtil::stripSlashes($post_data[$this->getId() . "_text_question"]);
                 $maxchars = $this->getMaxChars();
                 if ($maxchars > 0)
                 {
                         $entered_value = substr($entered_value, 0, $maxchars);
                 }
                 
                 if($a_return)
                 {
                         return array(array("value"=>null, "textanswer"=>$entered_value));
                 }               
                 if (strlen($entered_value) == 0) return;        
                 
                 $next_id = $ilDB->nextId('svy_answer');
                 $affectedRows = $ilDB->manipulateF("INSERT INTO svy_answer (answer_id, question_fi, active_fi, value, textanswer, tstamp) VALUES (%s, %s, %s, %s, %s, %s)",
                         array('integer', 'integer', 'integer', 'float', 'text', 'integer'),
                         array($next_id, $this->getId(), $active_id, NULL, (strlen($entered_value)) ? $entered_value : NULL, time())
                 );
         }

Here is the call graph for this function:

◆ setExportDetailsXLS()

SurveyTextQuestion::setExportDetailsXLS	(	&	$workbook,
		&	$format_title,
		&	$format_bold,
		&	$eval_data,
			$export_label
	)

Creates an Excel worksheet for the detailed cumulated results of this question.

Parameters

object	$workbook	Reference to the parent excel workbook
object	$format_title	Excel title format
object	$format_bold	Excel bold format
array	$eval_data	Cumulated evaluation data public

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

References ilExcelUtils\_convert_text(), SurveyQuestion\getQuestiontext(), and SurveyQuestion\getTitle().

         {
                 include_once ("./Services/Excel/classes/class.ilExcelUtils.php");
                 $worksheet =& $workbook->addWorksheet();
                 $rowcounter = 0;
                 switch ($export_label)
                 {
                         case 'label_only':
                                 $worksheet->writeString(0, 0, ilExcelUtils::_convert_text($this->lng->txt("label")), $format_bold);
                                 $worksheet->writeString(0, 1, ilExcelUtils::_convert_text($this->label));
                                 break;
                         case 'title_only':
                                 $worksheet->writeString(0, 0, ilExcelUtils::_convert_text($this->lng->txt("title")), $format_bold);
                                 $worksheet->writeString(0, 1, ilExcelUtils::_convert_text($this->getTitle()));
                                 break;
                         default:
                                 $worksheet->writeString(0, 0, ilExcelUtils::_convert_text($this->lng->txt("title")), $format_bold);
                                 $worksheet->writeString(0, 1, ilExcelUtils::_convert_text($this->getTitle()));
                                 $rowcounter++;
                                 $worksheet->writeString($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("label")), $format_bold);
                                 $worksheet->writeString($rowcounter, 1, ilExcelUtils::_convert_text($this->label));
                                 break;
                 }
                 $rowcounter++;
                 $worksheet->writeString($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("question")), $format_bold);
                 $worksheet->writeString($rowcounter, 1, ilExcelUtils::_convert_text($this->getQuestiontext()));
                 $rowcounter++;
                 $worksheet->writeString($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("question_type")), $format_bold);
                 $worksheet->writeString($rowcounter, 1, ilExcelUtils::_convert_text($this->lng->txt($this->getQuestionType())));
                 $rowcounter++;
                 $worksheet->writeString($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("users_answered")), $format_bold);
                 $worksheet->write($rowcounter, 1, $eval_data["USERS_ANSWERED"]);
                 $rowcounter++;
                 $worksheet->writeString($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("users_skipped")), $format_bold);
                 $worksheet->write($rowcounter, 1, $eval_data["USERS_SKIPPED"]);
                 $rowcounter++;
 
                 $worksheet->write($rowcounter, 0, ilExcelUtils::_convert_text($this->lng->txt("given_answers")), $format_bold);
                 $textvalues = "";
                 if (is_array($eval_data["textvalues"]))
                 {
                         foreach ($eval_data["textvalues"] as $textvalue)
                         {
                                 $worksheet->write($rowcounter++, 1, ilExcelUtils::_convert_text($textvalue));
                         }
                 }
         }

Here is the call graph for this function:

◆ setMaxChars()

SurveyTextQuestion::setMaxChars ( $maxchars = 0 )

Sets the maximum number of allowed characters for the text answer.

public

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

References $maxchars.

Referenced by importResponses(), and loadFromDb().

         {
                 $this->maxchars = $maxchars;
         }

Here is the caller graph for this function:

◆ setTextHeight()

SurveyTextQuestion::setTextHeight ( $a_textheight )

Sets the height of the answer field.

Parameters

integer $a_textheight The height of the answer field in characters public

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

Referenced by importResponses(), and loadFromDb().

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

Here is the caller graph for this function:

◆ setTextWidth()

SurveyTextQuestion::setTextWidth ( $a_textwidth )

Sets the width of the answer field.

Parameters

integer $a_textwidth The width of the answer field in characters public

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

Referenced by importResponses(), and loadFromDb().

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

Here is the caller graph for this function:

◆ SurveyTextQuestion()

SurveyTextQuestion::SurveyTextQuestion	(	$title = `""`,
		$description = `""`,
		$author = `""`,
		$questiontext = `""`,
		$owner = `-1`
	)

The constructor takes possible arguments an creates an instance of the SurveyTextQuestion object.

Parameters

string	$title	A title string to describe the question
string	$description	A description string to describe the question
string	$author	A string containing the name of the questions author
integer	$owner	A numerical ID to identify the owner/creator public

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

References SurveyQuestion\$author, SurveyQuestion\$description, SurveyQuestion\$owner, SurveyQuestion\$questiontext, SurveyQuestion\$title, and SurveyQuestion\SurveyQuestion().

         {
                 $this->SurveyQuestion($title, $description, $author, $questiontext, $owner);
                 $this->maxchars = 0;
                 $this->textwidth = 50;
                 $this->textheight = 5;
         }

Here is the call graph for this function:

◆ toXML()

SurveyTextQuestion::toXML	(	$a_include_header = `TRUE`,
		$obligatory_state = `""`
	)

Returns an xml representation of the question.

Returns: string The xml representation of the question public

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

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

         {
                 include_once("./Services/Xml/classes/class.ilXmlWriter.php");
                 $a_xml_writer = new ilXmlWriter;
                 $a_xml_writer->xmlHeader();
                 $this->insertXML($a_xml_writer, $a_include_header, $obligatory_state);
                 $xml = $a_xml_writer->xmlDumpMem(FALSE);
                 if (!$a_include_header)
                 {
                         $pos = strpos($xml, "?>");
                         $xml = substr($xml, $pos + 2);
                 }
                 return $xml;
         }

Here is the call graph for this function:

◆ usableForPrecondition()

SurveyTextQuestion::usableForPrecondition ( )

Returns if the question is usable for preconditions.

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

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

         {
                 return FALSE;
         }

Field Documentation

◆ $maxchars

SurveyTextQuestion::$maxchars

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

Referenced by setMaxChars().

◆ $textheight

SurveyTextQuestion::$textheight

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

◆ $textwidth

SurveyTextQuestion::$textwidth

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

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

Modules/SurveyQuestionPool/classes/class.SurveyTextQuestion.php

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _getMaxChars()

◆ _getQuestionDataArray()

◆ addUserSpecificResultsData()

◆ checkUserInput()

◆ getAdditionalTableName()

◆ getCumulatedResults()

◆ getMaxChars()

◆ getQuestionType()

◆ getTextHeight()

◆ getTextWidth()

◆ getUserAnswers()

◆ getWorkingDataFromUserInput()

◆ importResponses()

◆ insertXML()

◆ isComplete()

◆ loadFromDb()

◆ randomText()

◆ saveRandomData()

◆ saveToDb()

◆ saveUserInput()

◆ setExportDetailsXLS()

◆ setMaxChars()

◆ setTextHeight()

◆ setTextWidth()

◆ SurveyTextQuestion()

◆ toXML()

◆ usableForPrecondition()

Field Documentation

◆ $maxchars

◆ $textheight

◆ $textwidth