SurveyTextQuestion Class Reference

Text survey question. More...

Inheritance diagram for SurveyTextQuestion:

Collaboration diagram for SurveyTextQuestion:

Public Member Functions
	SurveyTextQuestion ($title="", $description="", $author="", $questiontext="", $owner=-1)
	SurveyTextQuestion constructor.
	_getQuestionDataArray ($id)
	Returns the question data fields from the database.
	loadFromDb ($id)
	Loads a SurveyTextQuestion object from the database.
	isComplete ()
	Returns true if the question is complete for use.
	setMaxChars ($maxchars=0)
	Sets the maximum number of allowed characters for the text answer.
	getMaxChars ()
	Returns the maximum number of allowed characters for the text answer.
	saveToDb ($original_id="")
	Saves a SurveyTextQuestion object to a database.
	toXML ($a_include_header=TRUE, $obligatory_state="")
	Returns an xml representation of the question.
	insertXML (&$a_xml_writer, $a_include_header=TRUE, $obligatory_state="")
	Adds the question XML to a given XMLWriter object.
	syncWithOriginal ()
	_getMaxChars ($question_id)
	Returns the maxium number of allowed characters for the text answer.
	getQuestionType ()
	Returns the question type of the question.
	getAdditionalTableName ()
	Returns the name of the additional question data table in the database.
&	getWorkingDataFromUserInput ($post_data)
	Creates the user data of the survey_answer table from the POST data.
	checkUserInput ($post_data, $survey_id)
	Checks the input of the active user for obligatory status and entered values.
	randomText ($length)
	saveRandomData ($active_id)
	Saves random answers for a given active user in the database.
	saveUserInput ($post_data, $active_id)
&	getCumulatedResults ($survey_id, $nr_of_users)
	setExportDetailsXLS (&$workbook, &$format_title, &$format_bold, &$eval_data)
	Creates an Excel worksheet for the detailed cumulated results of this question.
	addUserSpecificResultsData (&$a_array, &$resultset)
	Adds the values for the user specific results export for a given user.
&	getUserAnswers ($survey_id)
	Returns an array containing all answers to this question in a given survey.
	importResponses ($a_data)
	Import response data from the question import file.
	usableForPrecondition ()
	Returns if the question is usable for preconditions.
	getTextWidth ()
	Returns the width of the answer field.
	getTextHeight ()
	Returns the height of the answer field.
	setTextWidth ($a_textwidth)
	Sets the width of the answer field.
	setTextHeight ($a_textheight)
	Sets the height of the answer field.
Public Member Functions inherited from SurveyQuestion
	SurveyQuestion ($title="", $description="", $author="", $questiontext="", $owner=-1)
	SurveyQuestion constructor.
	_SurveyQuestion ()
	questionTitleExists ($title, $questionpool_object="")
	Returns TRUE if the question title exists in the database.
	setTitle ($title="")
	Sets the title string.
	setObligatory ($obligatory=1)
	Sets the obligatory state of the question.
	setOrientation ($orientation=0)
	Sets the orientation of the question output.
	setId ($id=-1)
	Sets the id.
	setSurveyId ($id=-1)
	Sets the survey id.
	setDescription ($description="")
	Sets the description.
	addMaterials ($materials_file, $materials_name="")
	Sets the materials uri.
	keyInArray ($searchkey, $array)
	returns TRUE if the key occurs in an array
	setMaterialsfile ($materials_filename, $materials_tempfilename="", $materials_name="")
	Sets and uploads the materials uri.
	deleteMaterial ($materials_name="")
	Deletes a materials uri.
	flushMaterials ()
	Deletes all materials uris.
	setAuthor ($author="")
	Sets the authors name.
	setQuestiontext ($questiontext="")
	Sets the questiontext.
	setOwner ($owner="")
	Sets the creator/owner.
	getTitle ()
	Gets the title string.
	getId ()
	Gets the id.
	getObligatory ($survey_id="")
	Gets the obligatory state of the question.
	getSurveyId ()
	Gets the survey id.
	getOrientation ()
	Gets the orientation of the question output.
	getDescription ()
	Gets the description.
	getAuthor ()
	Gets the authors name.
	getOwner ()
	Gets the creator/owner.
	getQuestiontext ()
	Gets the questiontext.
	getObjId ()
	Get the reference id of the container object.
	setObjId ($obj_id=0)
	Set the reference id of the container object.
	duplicate ($for_survey=true, $title="", $author="", $owner="")
	Duplicates a survey question.
	copyObject ($target_questionpool, $title="")
	Copies an assOrderingQuestion object.
	copyXHTMLMediaObjectsOfQuestion ($a_q_id)
	Increases the media object usage counter when a question is duplicated.
	duplicateMaterials ($question_id)
	Duplicates the materials of a question.
	_isComplete ($question_id)
	Checks wheather the question is complete or not.
	saveCompletionStatus ($original_id="")
	Saves the complete flag to the database.
	saveWorkingData ($limit_to=LIMIT_NO_LIMIT)
	Saves the learners input of the question to the database.
	getImagePath ()
	Returns the image path for web accessable images of a question.
	getMaterialsPath ()
	Returns the materials path for web accessable material of a question.
	getImagePathWeb ()
	Returns the web image path for web accessable images of a question.
	getMaterialsPathWeb ()
	Returns the web image path for web accessable images of a question.
	saveMaterialsToDb ()
	Saves a materials to a database.
	loadMaterialFromDb ($question_id)
	Loads materials uris from a database.
	saveCategoryToDb ($categorytext, $neutral=0)
	Saves a category to the database.
	deleteAdditionalTableData ($question_id)
	Deletes datasets from the additional question table in the database.
	delete ($question_id)
	Deletes a question from the database.
	_getQuestionType ($question_id)
	Returns the question type of a question with a given id.
	_getTitle ($question_id)
	Returns the question title of a question with a given id.
	_getOriginalId ($question_id)
	Returns the original id of a question.
	_getRefIdFromObjId ($obj_id)
	getPhrase ($phrase_id)
	Returns a phrase for a given database id.
	phraseExists ($title)
	Returns true if the phrase title already exists for the current user.
	_questionExists ($question_id)
	Returns true if the question already exists in the database.
	setMaterial ($material_id="", $is_import=false, $material_title="")
	Sets a material link for the question.
	_resolveInternalLink ($internal_link)
	_resolveIntLinks ($question_id)
	_getInternalLinkHref ($target="")
	_isWriteable ($question_id, $user_id)
	Returns true if the question is writeable by a certain user.
	getQuestionTypeID ()
	Returns the question type ID of the question.
&	_instanciateQuestion ($question_id)
	Creates an instance of a question with a given question id.
&	_instanciateQuestionGUI ($question_id)
	Creates an instance of a question GUI with a given question id.
	isHTML ($a_text)
	Checks if a given string contains HTML or not.
	QTIMaterialToString ($a_material)
	Reads an QTI material tag an creates a text string.
	addMaterialTag (&$a_xml_writer, $a_material, $close_material_tag=TRUE, $add_mobs=TRUE)
	Creates an XML material tag from a plain text or xhtml text.
	prepareTextareaOutput ($txt_output, $prepare_for_latex_output=FALSE)
	Prepares a string for a text area output in surveys.
	addUserSpecificResultsExportTitles (&$a_array)
	Adds the entries for the title row of the user specific results.
	importAdditionalMetadata ($a_meta)
	Import additional meta data from the question import file.
	importAdjectives ($a_data)
	Import bipolar adjectives from the question import file.
	importMatrix ($a_data)
	Import matrix rows from the question import file.
	setExportCumulatedXLS (&$worksheet, &$format_title, &$format_bold, &$eval_data, $row)
	Creates the Excel output for the cumulated results of this question.
&	setExportCumulatedCVS (&$eval_data)
	Creates the CSV output for the cumulated results of this question.
	getAvailableRelations ()
	Returns the available relations for the question.
	getPreconditionSelectValue ($default="")
	Creates a value selection for preconditions.
	getPreconditionValueOutput ($value)
	Returns the output for a precondition value.
	outChart ($survey_id, $type="")
	Creates an image visualising the results of the question.
	setOriginalId ($original_id)
	getOriginalId ()

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

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.
static	_getQuestionTypeName ($type_tag)
	Return the translation for a given question type tag.

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:

class.SurveyTextQuestion.php 19759 2009-04-21 10:45:44Z hschottm

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

Member Function Documentation

SurveyTextQuestion::_getMaxChars

(

$question_id

)

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

Returns the maxium number of allowed characters for the text answer

Returns

integer The maximum number of characters public

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

References $result.

        {
                global $ilDB;
                $query = sprintf("SELECT maxchars FROM survey_question WHERE question_id = %s",
                        $ilDB->quote($question_id . "")
                );
                $result = $ilDB->query($query);
                if ($result->numRows())
                {
                        $row = $result->fetchRow(MDB2_FETCHMODE_ASSOC);
                        return $row["maxchars"];
                }
                return 0;
        }

SurveyTextQuestion::_getQuestionDataArray

(

$id

)

Returns the question data fields from the database.

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

Reimplemented from SurveyQuestion.

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

References SurveyQuestion\$id, and $result.

        {
                global $ilDB;
                
    $query = sprintf("SELECT survey_question.*, survey_question_text.* FROM survey_question, survey_question_text WHERE survey_question.question_id = %s AND survey_question.question_id = survey_question_text.question_fi",
      $ilDB->quote($id)
    );
    $result = $ilDB->query($query);
                if ($result->numRows() == 1)
                {
                        return $result->fetchRow(MDB2_FETCHMODE_ASSOC);
                }
                else
                {
                        return array();
                }
        }

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

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

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

Reimplemented from SurveyQuestion.

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

References SurveyQuestion\getId().

        {
                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->lng->txt("skipped"));
                }
        }

Here is the call graph for this function:

SurveyTextQuestion::checkUserInput	(		$post_data,
			$survey_id
	)

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

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

SurveyTextQuestion::getAdditionalTableName

(

)

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

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

Returns

string The additional table name public

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

        {
                return "survey_question_text";
        }

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

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

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

        {
                global $ilDB;
                
                $question_id = $this->getId();
                
                $result_array = array();
                $cumulated = array();
                $textvalues = array();

                $query = sprintf("SELECT survey_answer.* FROM survey_answer, survey_finished WHERE survey_answer.question_fi = %s AND survey_finished.survey_fi = %s AND survey_finished.finished_id = survey_answer.active_fi",
                        $ilDB->quote($question_id),
                        $ilDB->quote($survey_id)
                );
                $result = $ilDB->query($query);
                
                while ($row = $result->fetchRow(MDB2_FETCHMODE_OBJECT))
                {
                        $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:

SurveyTextQuestion::getMaxChars

(

)

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

Returns the maximum number of allowed characters for the text answer

public

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

References $maxchars.

Referenced by insertXML(), and saveUserInput().

        {
                return $this->maxchars;
        }

Here is the caller graph for this function:

SurveyTextQuestion::getQuestionType

(

)

Returns the question type of the question.

Returns the question type of the question

Returns

integer The question type of the question public

Reimplemented from SurveyQuestion.

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

        {
                return "SurveyTextQuestion";
        }

SurveyTextQuestion::getTextHeight

(

)

Returns the height of the answer field.

Returns the height of the answer field

Returns

integer The height of the answer field in characters public

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

References $textheight.

Referenced by insertXML(), and saveToDb().

        {
                return $this->textheight;
        }

Here is the caller graph for this function:

SurveyTextQuestion::getTextWidth

(

)

Returns the width of the answer field.

Returns the width of the answer field

Returns

integer The width of the answer field in characters public

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

References $textwidth.

Referenced by insertXML(), and saveToDb().

        {
                return $this->textwidth;
        }

Here is the caller graph for this function:

& SurveyTextQuestion::getUserAnswers

(

$survey_id

)

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

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

Reimplemented from SurveyQuestion.

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

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

        {
                global $ilDB;
                
                $answers = array();

                $query = sprintf("SELECT survey_answer.* FROM survey_answer, survey_finished WHERE survey_finished.survey_fi = %s AND survey_answer.question_fi = %s AND survey_finished.finished_id = survey_answer.active_fi",
                        $ilDB->quote($survey_id),
                        $ilDB->quote($this->getId())
                );
                $result = $ilDB->query($query);
                while ($row = $result->fetchRow(MDB2_FETCHMODE_ASSOC))
                {
                        $answers[$row["active_fi"]] = $row["textanswer"];
                }
                return $answers;
        }

Here is the call graph for this function:

& SurveyTextQuestion::getWorkingDataFromUserInput

(

$post_data

)

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

Creates the user data of the survey_answer table from the POST data

Returns

array User data according to the survey_answer table public

Reimplemented from SurveyQuestion.

Definition at line 454 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:

SurveyTextQuestion::importResponses

(

$a_data

)

Import response data from the question import file.

Import response data from the question import file

Returns

array $a_data Array containing the response data public

Reimplemented from SurveyQuestion.

Definition at line 670 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:

SurveyTextQuestion::insertXML	(	&	$a_xml_writer,
			$a_include_header = TRUE,
			$obligatory_state = ""
	)

Adds the question XML to a given XMLWriter object.

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 316 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());
                $a_xml_writer->xmlStartTag("questiontext");
                $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:

SurveyTextQuestion::isComplete

(

)

Returns true if the question is complete for use.

Returns true if the question is complete for use

Returns

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

Reimplemented from SurveyQuestion.

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

Referenced by saveToDb(), and syncWithOriginal().

        {
                if ($this->title and $this->author and $this->questiontext)
                {
                        return 1;
                }
                else
                {
                        return 0;
                }
        }

Here is the caller graph for this function:

SurveyTextQuestion::loadFromDb

(

$id

)

Loads a SurveyTextQuestion object from the database.

Loads a SurveyTextQuestion object from the database

Parameters

integer

$id

The database id of the text survey question public

Reimplemented from SurveyQuestion.

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

References $data, SurveyQuestion\$id, $result, ilRTE\_replaceMediaObjectImageSrc(), and SurveyQuestion\loadMaterialFromDb().

        {
                global $ilDB;
                $query = sprintf("SELECT survey_question.*, survey_question_text.* FROM survey_question, survey_question_text WHERE survey_question.question_id = %s AND survey_question.question_id = survey_question_text.question_fi",
                        $ilDB->quote($id)
                );
                $result = $ilDB->query($query);
                if ($result->numRows() == 1)
                {
                        $data = $result->fetchRow(MDB2_FETCHMODE_OBJECT);
                        $this->id = $data->question_id;
                        $this->title = $data->title;
                        $this->description = $data->description;
                        $this->obj_id = $data->obj_fi;
                        $this->author = $data->author;
                        $this->obligatory = $data->obligatory;
                        $this->owner = $data->owner_fi;
                        $this->original_id = $data->original_id;
                        $this->maxchars = $data->maxchars;
                        $this->textwidth = $data->width;
                        $this->textheight = $data->height;
                        include_once("./Services/RTE/classes/class.ilRTE.php");
                        $this->questiontext = ilRTE::_replaceMediaObjectImageSrc($data->questiontext, 1);
                        $this->complete = $data->complete;
                        // loads materials uris from database
                        $this->loadMaterialFromDb($id);
                }
                parent::loadFromDb($id);
        }

Here is the call graph for this function:

SurveyTextQuestion::randomText

(

$length

)

Definition at line 488 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:

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 507 of file class.SurveyTextQuestion.php.

References $result, and randomText().

        {
                global $ilDB;
                // single response
                $randomtext = $this->randomText(rand(25,100));
                $query = sprintf("INSERT INTO survey_answer (answer_id, question_fi, active_fi, value, textanswer, TIMESTAMP) VALUES (NULL, %s, %s, NULL, %s, NULL)",
                        $ilDB->quote($this->getId()),
                        $ilDB->quote($active_id),
                        $ilDB->quote($randomtext)
                );
                $result = $ilDB->query($query);
        }

Here is the call graph for this function:

SurveyTextQuestion::saveToDb

(

$original_id = ""

)

Saves a SurveyTextQuestion object to a database.

Saves a SurveyTextQuestion object to a database

public

Reimplemented from SurveyQuestion.

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

References SurveyQuestion\$ilias, $maxchars, $result, ilRTE\_cleanupMediaObjectUsage(), ilRTE\_replaceMediaObjectImageSrc(), SurveyQuestion\getId(), getTextHeight(), getTextWidth(), isComplete(), and SurveyQuestion\saveMaterialsToDb().

  {
                global $ilDB;
                $maxchars = "NULL";
                if ($this->maxchars)
                {
                        $maxchars = $ilDB->quote($this->maxchars . "");
                }
                $complete = 0;
                if ($this->isComplete()) {
                        $complete = 1;
                }
                if ($original_id)
                {
                        $original_id = $ilDB->quote($original_id);
                }
                else
                {
                        $original_id = "NULL";
                }

                // cleanup RTE images which are not inserted into the question text
                include_once("./Services/RTE/classes/class.ilRTE.php");
                ilRTE::_cleanupMediaObjectUsage($this->questiontext, "spl:html",
                        $this->getId());

    if ($this->id == -1) 
                {
      // Write new dataset
      $now = getdate();
      $created = sprintf("%04d%02d%02d%02d%02d%02d", $now['year'], $now['mon'], $now['mday'], $now['hours'], $now['minutes'], $now['seconds']);
      $query = sprintf("INSERT INTO survey_question (question_id, questiontype_fi, obj_fi, owner_fi, title, description, author, questiontext, obligatory, complete, created, original_id, TIMESTAMP) VALUES (NULL, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, NULL)",
                                $ilDB->quote($this->getQuestionTypeID() . ""),
                                $ilDB->quote($this->obj_id),
                                $ilDB->quote($this->owner),
                                $ilDB->quote($this->title),
                                $ilDB->quote($this->description),
                                $ilDB->quote($this->author),
                                $ilDB->quote(ilRTE::_replaceMediaObjectImageSrc($this->questiontext, 0)),
                                $ilDB->quote(sprintf("%d", $this->obligatory)),
                                $ilDB->quote("$complete"),
                                $ilDB->quote($created),
                                $original_id
                        );
                        $result = $ilDB->query($query);
                        if (PEAR::isError($result)) 
                        {
                                global $ilias;
                                $ilias->raiseError($result->getMessage());
                        }
                        else
                        {
                                $this->id = $ilDB->getLastInsertId();
                                $query = sprintf("INSERT INTO survey_question_text (question_fi, maxchars, width, height) VALUES (%s, %s, %s, %s)",
                                        $ilDB->quote($this->id . ""),
                                        $maxchars,
                                        $ilDB->quote($this->getTextWidth() . ""),
                                        $ilDB->quote($this->getTextHeight() . ""),
                                        $maxchars
                                );
                                $ilDB->query($query);
                        }
                } 
                else 
                {
                        // update existing dataset
                        $query = sprintf("UPDATE survey_question SET title = %s, description = %s, author = %s, questiontext = %s, obligatory = %s, complete = %s WHERE question_id = %s",
                                $ilDB->quote($this->title),
                                $ilDB->quote($this->description),
                                $ilDB->quote($this->author),
                                $ilDB->quote(ilRTE::_replaceMediaObjectImageSrc($this->questiontext, 0)),
                                $ilDB->quote(sprintf("%d", $this->obligatory)),
                                $ilDB->quote("$complete"),
                                $ilDB->quote($this->id)
      );
      $result = $ilDB->query($query);
                        $query = sprintf("UPDATE survey_question_text SET maxchars = %s, width = %s, height = %s WHERE question_fi = %s",
                                $maxchars,
                                $ilDB->quote($this->getTextWidth() . ""),
                                $ilDB->quote($this->getTextHeight() . ""),
                                $ilDB->quote($this->id . "")
                        );
                        $result = $ilDB->query($query);
                }
                if (PEAR::isError($result)) 
                {
                        global $ilias;
                        $ilias->raiseError($result->getMessage());
                }
                else
                {
                        // saving material uris in the database
                        $this->saveMaterialsToDb();
                }
                parent::saveToDb($original_id);
        }

Here is the call graph for this function:

SurveyTextQuestion::saveUserInput	(		$post_data,
			$active_id
	)

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

References $maxchars, $result, 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 (strlen($entered_value) == 0) return;
                $entered_value = $ilDB->quote($entered_value . "");
                $query = sprintf("INSERT INTO survey_answer (answer_id, question_fi, active_fi, value, textanswer, TIMESTAMP) VALUES (NULL, %s, %s, %s, %s, NULL)",
                        $ilDB->quote($this->getId() . ""),
                        $ilDB->quote($active_id . ""),
                        "NULL",
                        $entered_value
                );
                $result = $ilDB->query($query);
        }

Here is the call graph for this function:

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

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

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

Reimplemented from SurveyQuestion.

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

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

        {
                include_once ("./classes/class.ilExcelUtils.php");
                $worksheet =& $workbook->addWorksheet();
                $worksheet->writeString(0, 0, ilExcelUtils::_convert_text($this->lng->txt("title")), $format_bold);
                $worksheet->writeString(0, 1, ilExcelUtils::_convert_text($this->getTitle()));
                $worksheet->writeString(1, 0, ilExcelUtils::_convert_text($this->lng->txt("question")), $format_bold);
                $worksheet->writeString(1, 1, ilExcelUtils::_convert_text($this->getQuestiontext()));
                $worksheet->writeString(2, 0, ilExcelUtils::_convert_text($this->lng->txt("question_type")), $format_bold);
                $worksheet->writeString(2, 1, ilExcelUtils::_convert_text($this->lng->txt($this->getQuestionType())));
                $worksheet->writeString(3, 0, ilExcelUtils::_convert_text($this->lng->txt("users_answered")), $format_bold);
                $worksheet->write(3, 1, $eval_data["USERS_ANSWERED"]);
                $worksheet->writeString(4, 0, ilExcelUtils::_convert_text($this->lng->txt("users_skipped")), $format_bold);
                $worksheet->write(4, 1, $eval_data["USERS_SKIPPED"]);
                $rowcounter = 5;

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

SurveyTextQuestion::setMaxChars

(

$maxchars = 0

)

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

Sets the maximum number of allowed characters for the text answer

public

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

References $maxchars.

Referenced by importResponses().

        {
                $this->maxchars = $maxchars;
        }

Here is the caller graph for this function:

SurveyTextQuestion::setTextHeight

(

$a_textheight

)

Sets the height of the answer field.

Sets the height of the answer field

Parameters

integer

$a_textheight

The height of the answer field in characters public

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

Referenced by importResponses().

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

Here is the caller graph for this function:

SurveyTextQuestion::setTextWidth

(

$a_textwidth

)

Sets the width of the answer field.

Sets the width of the answer field

Parameters

integer

$a_textwidth

The width of the answer field in characters public

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

Referenced by importResponses().

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

Here is the caller graph for this function:

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

SurveyTextQuestion constructor.

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

SurveyTextQuestion::syncWithOriginal

(

)

Reimplemented from SurveyQuestion.

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

References $result, and isComplete().

        {
                global $ilDB;
                if ($this->original_id)
                {
                        $complete = 0;
                        if ($this->isComplete()) 
                        {
                                $complete = 1;
                        }
      $query = sprintf("UPDATE survey_question SET title = %s, description = %s, author = %s, questiontext = %s, obligatory = %s, complete = %s WHERE question_id = %s",
                                $ilDB->quote($this->title . ""),
                                $ilDB->quote($this->description . ""),
                                $ilDB->quote($this->author . ""),
                                $ilDB->quote($this->questiontext . ""),
                                $ilDB->quote(sprintf("%d", $this->obligatory) . ""),
                                $ilDB->quote($complete . ""),
                                $ilDB->quote($this->original_id . "")
      );
      $result = $ilDB->query($query);
                        $query = sprintf("UPDATE survey_question_text SET maxchars = %s, width = %s, height = %s WHERE question_fi = %s",
                                $ilDB->quote($this->getMaxChars() . ""),
                                $ilDB->quote($this->getTextWidth() . ""),
                                $ilDB->quote($this->getTextHeight() . ""),
                                $ilDB->quote($this->original_id . "")
                        );
                        $result = $ilDB->query($query);
                }
                parent::syncWithOriginal();
        }

Here is the call graph for this function:

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

Returns an xml representation of the question.

Returns an xml representation of the question

Returns

string The xml representation of the question public

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

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

        {
                include_once("./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:

SurveyTextQuestion::usableForPrecondition

(

)

Returns if the question is usable for preconditions.

Returns if the question is usable for preconditions

Returns

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

Reimplemented from SurveyQuestion.

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

        {
                return FALSE;
        }

Field Documentation

SurveyTextQuestion::$maxchars

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

Referenced by getMaxChars(), saveToDb(), saveUserInput(), and setMaxChars().

SurveyTextQuestion::$textheight

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

Referenced by getTextHeight().

SurveyTextQuestion::$textwidth

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

Referenced by getTextWidth().

---

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

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