ILIAS
Release_4_4_x_branch Revision 61816
|
The SurveyMatrixQuestion class defines and encapsulates basic methods and attributes for matrix question types. More...
Public Member Functions | |
SurveyMatrixQuestion ($title="", $description="", $author="", $questiontext="", $owner=-1) | |
SurveyMatrixQuestion constructor The constructor takes possible arguments an creates an instance of the SurveyMatrixQuestion object. | |
getColumnCount () | |
Returns the number of columns. | |
removeColumn ($index) | |
Removes a column from the list of columns. | |
removeColumns ($array) | |
Removes many columns from the list of columns. | |
removeColumnWithName ($name) | |
Removes a column from the list of columns. | |
getColumns () | |
Return the columns. | |
getColumn ($index) | |
Returns the name of a column for a given index. | |
getColumnForScale ($scale) | |
getColumnIndex ($name) | |
Returns the index of a column with a given name. | |
flushColumns () | |
Empties the columns list. | |
getRowCount () | |
Returns the number of rows in the question. | |
addRow ($a_text, $a_other, $a_label) | |
Adds a row to the question. | |
addRowAtPosition ($a_text, $a_other, $a_position) | |
Adds a row at a given position. | |
flushRows () | |
Empties the row list. | |
getRow ($a_index) | |
Returns a specific row. | |
moveRowUp ($index) | |
moveRowDown ($index) | |
removeRows ($array) | |
Removes rows from the question. | |
removeRow ($index) | |
Removes a row. | |
getBipolarAdjective ($a_index) | |
Returns one of the bipolar adjectives. | |
setBipolarAdjective ($a_index, $a_value) | |
Sets one of the bipolar adjectives. | |
addPhrase ($phrase_id) | |
Adds a phrase to the question. | |
_getQuestionDataArray ($id) | |
Returns the question data fields from the database. | |
loadFromDb ($id) | |
Loads a SurveyMatrixQuestion object from the database. | |
isComplete () | |
Returns 1 if the question is complete for use. | |
saveToDb ($original_id=NULL, $withanswers=true) | |
Saves a SurveyMatrixQuestion object to a database. | |
saveBipolarAdjectives ($adjective1, $adjective2) | |
saveColumnToDb ($columntext, $neutral=0) | |
Saves a column to the database. | |
saveColumnsToDb ($original_id="") | |
saveRowsToDb ($original_id="") | |
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 () | |
addStandardNumbers ($lower_limit, $upper_limit) | |
Adds standard numbers as columns. | |
savePhrase ($title) | |
Saves a set of columns to a default phrase. | |
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 svy_answer table from the POST data. | |
checkUserInput ($post_data, $survey_id) | |
Checks the input of the active user for obligatory status and entered values. | |
saveRandomData ($active_id) | |
Saves random answers for a given active user in the database. | |
saveUserInput ($post_data, $active_id, $a_return=false) | |
deleteAdditionalTableData ($question_id) | |
Deletes datasets from the additional question table in the database. | |
getNrOfUsersAnswered ($survey_id, $finished_ids=null) | |
Returns the number of users that answered the question for a given survey. | |
& | getCumulatedResultsForRow ($rowindex, $survey_id, $nr_of_users, $finished_ids) |
Returns the cumulated results for a given row. | |
& | getCumulatedResults ($survey_id, $nr_of_users, $finished_ids) |
Returns the cumulated results for the question. | |
setExportCumulatedXLS (&$worksheet, &$format_title, &$format_bold, &$eval_data, $row, $export_label) | |
Creates the Excel output for the cumulated results of this question. | |
& | setExportCumulatedCVS (&$eval_data, $export_label) |
Creates the CSV output for the cumulated results of this question. | |
setExportDetailsXLS (&$workbook, &$format_title, &$format_bold, &$eval_data, $export_label) | |
Creates an Excel worksheet for the detailed cumulated results of this question. | |
addUserSpecificResultsExportTitles (&$a_array, $a_use_label=false, $a_substitute=true) | |
Adds the entries for the title row of the user specific results. | |
addUserSpecificResultsData (&$a_array, &$resultset) | |
Adds the values for the user specific results export for a given user. | |
& | getUserAnswers ($survey_id, $finished_ids) |
Returns an array containing all answers to this question in a given survey. | |
getSubtype () | |
Returns the subtype of the matrix question. | |
setSubtype ($a_subtype=0) | |
Sets the subtype of the matrix question. | |
setColumnSeparators ($enable=0) | |
Enables/Disables separators for the matrix columns. | |
getColumnSeparators () | |
Gets the separators enable state for the matrix columns. | |
setRowSeparators ($enable=0) | |
Enables/Disables separators for the matrix rows. | |
getRowSeparators () | |
Gets the separators enable state for the matrix rows. | |
setNeutralColumnSeparator ($enable=0) | |
Enables/Disables a separator for the neutral column. | |
getNeutralColumnSeparator () | |
Gets the separator enable state for the neutral column. | |
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. | |
importResponses ($a_data) | |
Import response data from the question import file. | |
usableForPrecondition () | |
Returns if the question is usable for preconditions. | |
getPreconditionValueOutput ($value) | |
Returns the output for a precondition value. | |
getPreconditionSelectValue ($default="", $title, $variable) | |
Creates a form property for the precondition value. | |
saveLayout ($percent_row, $percent_columns, $percent_bipolar_adjective1="", $percent_bipolar_adjective2="", $percent_neutral) | |
Saves the layout of a matrix question. | |
getLayout () | |
setLayout ($layout) | |
hasBipolarAdjectives () | |
Returns TRUE if bipolar adjectives exist. | |
hasNeutralColumn () | |
Returns TRUE if a neutral column exists. | |
setColumnPlaceholders ($a_value=0) | |
Set whether placeholders should be used for the column titles or not. | |
getColumnPlaceholders () | |
Get whether placeholders should be used for the column titles or not. | |
setLegend ($a_value=0) | |
Set whether the legend should be shown or not. | |
getLegend () | |
Get whether the legend should be shown or not. | |
setSingleLineRowCaption ($a_value=0) | |
getSingleLineRowCaption () | |
setRepeatColumnHeader ($a_value=0) | |
getRepeatColumnHeader () | |
setColumnHeaderPosition ($a_value) | |
getColumnHeaderPosition () | |
setRandomRows ($a_value=0) | |
getRandomRows () | |
setColumnOrder ($a_value) | |
getColumnOrder () | |
setColumnImages ($a_value=0) | |
getColumnImages () | |
setRowImages ($a_value=0) | |
getRowImages () | |
getRows () | |
getCumulatedResultData ($survey_id, $counter, $finished_ids) | |
Creates a the cumulated results data for the question. | |
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. | |
_SurveyQuestion () | |
setComplete ($a_complete) | |
Sets the complete state of the question. | |
questionTitleExists ($title, $questionpool_object="") | |
Returns TRUE if the question title exists in the database. | |
setTitle ($title="") | |
Sets the title string of the SurveyQuestion object. | |
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 of the SurveyQuestion object. | |
setSurveyId ($id=-1) | |
Sets the survey id of the SurveyQuestion object. | |
setDescription ($description="") | |
Sets the description string of the SurveyQuestion object. | |
addMaterials ($materials_file, $materials_name="") | |
Sets the materials uri. | |
setMaterialsfile ($materials_filename, $materials_tempfilename="", $materials_name="") | |
Sets and uploads the materials uri. | |
deleteMaterial ($materials_name="") | |
Deletes a materials uri with a given name. | |
flushMaterials () | |
Deletes all materials uris. | |
setAuthor ($author="") | |
Sets the authors name of the SurveyQuestion object. | |
setQuestiontext ($questiontext="") | |
Sets the questiontext of the SurveyQuestion object. | |
setOwner ($owner="") | |
Sets the creator/owner ID of the SurveyQuestion object. | |
getTitle () | |
Gets the title string of the SurveyQuestion object. | |
getId () | |
Gets the id of the SurveyQuestion object. | |
getObligatory ($survey_id="") | |
Gets the obligatory state of the question. | |
getSurveyId () | |
Gets the survey id of the SurveyQuestion object. | |
getOrientation () | |
Gets the orientation of the question output. | |
getDescription () | |
Gets the description string of the SurveyQuestion object. | |
getAuthor () | |
Gets the authors name of the SurveyQuestion object. | |
getOwner () | |
Gets the creator/owner ID of the SurveyQuestion object. | |
getQuestiontext () | |
Gets the questiontext of the SurveyQuestion object. | |
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. | |
_isComplete ($question_id) | |
Checks whether the question is complete or not. | |
saveCompletionStatus ($original_id="") | |
Saves the complete flag to the database. | |
saveToDb ($original_id="") | |
Saves a SurveyQuestion object to a database. | |
saveMaterial () | |
save material to db | |
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. | |
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 materials 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. | |
saveCategoryToDb ($categorytext, $neutral=0) | |
Saves a category to the database. | |
delete ($question_id) | |
Deletes a question and all materials 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, $a_return_question_id_if_no_original=true) | |
Returns the original id of a question. | |
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. | |
addInternalLink ($material_id, $title="") | |
deleteMaterials ($a_array) | |
Deletes materials. | |
duplicateMaterials ($question_id) | |
Duplicates the materials of a question. | |
addMaterial ($obj_material) | |
setMaterial ($material_id="", $is_import=false, $material_title="") | |
Sets a material link for the question. | |
_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. | |
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, $a_attrs=null) | |
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. | |
& | getUserAnswers ($survey_id) |
Returns an array containing all answers to this question in a given survey. | |
getAvailableRelations () | |
Returns the available relations for the question. | |
getPreconditionOptions () | |
Returns the options for preconditions. | |
outChart ($survey_id, $type="") | |
Creates an image visualising the results of the question. | |
setOriginalId ($original_id) | |
getOriginalId () | |
getMaterial () | |
__get ($value) | |
Object getter. | |
__set ($key, $value) | |
Object setter. | |
getCopyIds ($a_group_by_survey=false) | |
hasCopies () | |
getSkippedValue () |
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. | |
static | _changeOriginalId ($a_question_id, $a_original_id, $a_object_id) |
Change original id of existing question in db. | |
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. |
The SurveyMatrixQuestion class defines and encapsulates basic methods and attributes for matrix question types.
Definition at line 35 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::_getQuestionDataArray | ( | $id | ) |
Returns the question data fields from the database.
integer | $id | The question ID from the database |
Reimplemented from SurveyQuestion.
Definition at line 441 of file class.SurveyMatrixQuestion.php.
References SurveyQuestion\$id, $result, and getAdditionalTableName().
SurveyMatrixQuestion::addPhrase | ( | $phrase_id | ) |
Adds a phrase to the question.
integer | $phrase_id | The database id of the given phrase public |
Definition at line 411 of file class.SurveyMatrixQuestion.php.
References $ilUser, $result, and $row.
SurveyMatrixQuestion::addRow | ( | $a_text, | |
$a_other, | |||
$a_label | |||
) |
Adds a row to the question.
string | $a_text | The text of the row |
Definition at line 292 of file class.SurveyMatrixQuestion.php.
Referenced by importMatrix(), and loadFromDb().
SurveyMatrixQuestion::addRowAtPosition | ( | $a_text, | |
$a_other, | |||
$a_position | |||
) |
Adds a row at a given position.
string | $a_text | The text of the row |
integer | $a_position | The row position |
Definition at line 303 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::addStandardNumbers | ( | $lower_limit, | |
$upper_limit | |||
) |
Adds standard numbers as columns.
integer | $lower_limit | The lower limit |
integer | $upper_limit | The upper limit public |
Definition at line 900 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::addUserSpecificResultsData | ( | & | $a_array, |
& | $resultset | ||
) |
Adds the values for the user specific results export for a given user.
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 1813 of file class.SurveyMatrixQuestion.php.
References $result, $row, getColumn(), getColumnCount(), SurveyQuestion\getId(), getRow(), getRowCount(), SurveyQuestion\getSkippedValue(), and getSubtype().
SurveyMatrixQuestion::addUserSpecificResultsExportTitles | ( | & | $a_array, |
$a_use_label = false , |
|||
$a_substitute = true |
|||
) |
Adds the entries for the title row of the user specific results.
array | $a_array | An array which is used to append the title row entries public |
Reimplemented from SurveyQuestion.
Definition at line 1746 of file class.SurveyMatrixQuestion.php.
References $row, SurveyQuestion\$title, getColumn(), getColumnCount(), getRow(), getRowCount(), and getSubtype().
SurveyMatrixQuestion::checkUserInput | ( | $post_data, | |
$survey_id | |||
) |
Checks the input of the active user for obligatory status and entered values.
array | $post_data | The contents of the $_POST array |
integer | $survey_id | The database ID of the active survey |
Definition at line 1026 of file class.SurveyMatrixQuestion.php.
References SurveyQuestion\$survey_id, SurveyQuestion\getId(), SurveyQuestion\getObligatory(), getRowCount(), and getSubtype().
SurveyMatrixQuestion::deleteAdditionalTableData | ( | $question_id | ) |
Deletes datasets from the additional question table in the database.
integer | $question_id | The question id which should be deleted in the additional question table public |
Reimplemented from SurveyQuestion.
Definition at line 1183 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::flushColumns | ( | ) |
Empties the columns list.
public
Definition at line 271 of file class.SurveyMatrixQuestion.php.
Referenced by loadFromDb().
SurveyMatrixQuestion::flushRows | ( | ) |
Empties the row list.
public
Definition at line 314 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::getAdditionalTableName | ( | ) |
Returns the name of the additional question data table in the database.
Definition at line 962 of file class.SurveyMatrixQuestion.php.
Referenced by _getQuestionDataArray(), loadFromDb(), saveBipolarAdjectives(), saveLayout(), and saveToDb().
SurveyMatrixQuestion::getBipolarAdjective | ( | $a_index | ) |
Returns one of the bipolar adjectives.
integer | $a_index | The number of the bipolar adjective (0 for the first and 1 for the second adjective) |
Definition at line 369 of file class.SurveyMatrixQuestion.php.
Referenced by hasBipolarAdjectives(), insertXML(), and saveToDb().
SurveyMatrixQuestion::getColumn | ( | $index | ) |
Returns the name of a column for a given index.
integer | $index | The index of the column |
Definition at line 242 of file class.SurveyMatrixQuestion.php.
Referenced by addUserSpecificResultsData(), addUserSpecificResultsExportTitles(), getCumulatedResults(), getCumulatedResultsForRow(), hasNeutralColumn(), insertXML(), and saveColumnsToDb().
SurveyMatrixQuestion::getColumnCount | ( | ) |
Returns the number of columns.
Definition at line 185 of file class.SurveyMatrixQuestion.php.
Referenced by addUserSpecificResultsData(), addUserSpecificResultsExportTitles(), getCumulatedResults(), getCumulatedResultsForRow(), hasNeutralColumn(), insertXML(), isComplete(), saveColumnsToDb(), and saveRandomData().
SurveyMatrixQuestion::getColumnForScale | ( | $scale | ) |
Definition at line 247 of file class.SurveyMatrixQuestion.php.
Referenced by getCumulatedResults(), getCumulatedResultsForRow(), and getUserAnswers().
SurveyMatrixQuestion::getColumnHeaderPosition | ( | ) |
Definition at line 2411 of file class.SurveyMatrixQuestion.php.
Referenced by saveToDb().
SurveyMatrixQuestion::getColumnImages | ( | ) |
Definition at line 2441 of file class.SurveyMatrixQuestion.php.
Referenced by saveToDb().
SurveyMatrixQuestion::getColumnIndex | ( | $name | ) |
Returns the index of a column with a given name.
string | $name | The name of the column public |
Definition at line 259 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::getColumnOrder | ( | ) |
Definition at line 2431 of file class.SurveyMatrixQuestion.php.
Referenced by saveToDb().
SurveyMatrixQuestion::getColumnPlaceholders | ( | ) |
Get whether placeholders should be used for the column titles or not.
Definition at line 2361 of file class.SurveyMatrixQuestion.php.
Referenced by saveToDb().
SurveyMatrixQuestion::getColumns | ( | ) |
Return the columns.
Definition at line 229 of file class.SurveyMatrixQuestion.php.
References $columns.
SurveyMatrixQuestion::getColumnSeparators | ( | ) |
Gets the separators enable state for the matrix columns.
Definition at line 2036 of file class.SurveyMatrixQuestion.php.
Referenced by insertXML(), and saveToDb().
SurveyMatrixQuestion::getCumulatedResultData | ( | $survey_id, | |
$counter, | |||
$finished_ids | |||
) |
Creates a the cumulated results data for the question.
Reimplemented from SurveyQuestion.
Definition at line 2466 of file class.SurveyMatrixQuestion.php.
References SurveyQuestion\$cumulated, SurveyQuestion\$questiontext, $result, $row, SurveyQuestion\$survey_id, SurveyQuestion\calculateCumulatedResults(), and SurveyQuestion\getQuestiontext().
& SurveyMatrixQuestion::getCumulatedResults | ( | $survey_id, | |
$nr_of_users, | |||
$finished_ids | |||
) |
Returns the cumulated results for the question.
integer | $survey_id | The database ID of the survey |
Definition at line 1350 of file class.SurveyMatrixQuestion.php.
References SurveyQuestion\$cumulated, $result, $row, SurveyQuestion\$survey_id, $total, getColumn(), getColumnCount(), getColumnForScale(), getCumulatedResultsForRow(), SurveyQuestion\getId(), getNrOfUsersAnswered(), getRowCount(), and getSubtype().
& SurveyMatrixQuestion::getCumulatedResultsForRow | ( | $rowindex, | |
$survey_id, | |||
$nr_of_users, | |||
$finished_ids | |||
) |
Returns the cumulated results for a given row.
integer | $row | The index of the row |
integer | $survey_id | The database ID of the survey |
Definition at line 1232 of file class.SurveyMatrixQuestion.php.
References SurveyQuestion\$cumulated, $result, $row, SurveyQuestion\$survey_id, $total, getColumn(), getColumnCount(), getColumnForScale(), SurveyQuestion\getId(), getNrOfUsersAnswered(), getRow(), and getSubtype().
Referenced by getCumulatedResults().
SurveyMatrixQuestion::getLayout | ( | ) |
Definition at line 2254 of file class.SurveyMatrixQuestion.php.
References $layout, hasBipolarAdjectives(), and hasNeutralColumn().
Referenced by insertXML(), and saveToDb().
SurveyMatrixQuestion::getLegend | ( | ) |
Get whether the legend should be shown or not.
Definition at line 2381 of file class.SurveyMatrixQuestion.php.
Referenced by saveToDb().
SurveyMatrixQuestion::getNeutralColumnSeparator | ( | ) |
Gets the separator enable state for the neutral column.
Definition at line 2098 of file class.SurveyMatrixQuestion.php.
Referenced by insertXML(), and saveToDb().
SurveyMatrixQuestion::getNrOfUsersAnswered | ( | $survey_id, | |
$finished_ids = null |
|||
) |
Returns the number of users that answered the question for a given survey.
integer | $survey_id | The database ID of the survey |
Definition at line 1201 of file class.SurveyMatrixQuestion.php.
References $result, $row, SurveyQuestion\$survey_id, and SurveyQuestion\getId().
Referenced by getCumulatedResults(), and getCumulatedResultsForRow().
SurveyMatrixQuestion::getPreconditionSelectValue | ( | $default = "" , |
|
$title, | |||
$variable | |||
) |
Creates a form property for the precondition value.
Reimplemented from SurveyQuestion.
Definition at line 2218 of file class.SurveyMatrixQuestion.php.
References $options, SurveyQuestion\$title, and SurveyQuestion\getPreconditionOptions().
SurveyMatrixQuestion::getPreconditionValueOutput | ( | $value | ) |
Returns the output for a precondition value.
string | $value | The precondition value |
Reimplemented from SurveyQuestion.
Definition at line 2207 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::getQuestionType | ( | ) |
Returns the question type of the question.
Reimplemented from SurveyQuestion.
Definition at line 951 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::getRandomRows | ( | ) |
Definition at line 2421 of file class.SurveyMatrixQuestion.php.
Referenced by saveToDb().
SurveyMatrixQuestion::getRepeatColumnHeader | ( | ) |
Definition at line 2401 of file class.SurveyMatrixQuestion.php.
Referenced by saveToDb().
SurveyMatrixQuestion::getRow | ( | $a_index | ) |
Returns a specific row.
integer | $a_index | The index position of the row public |
Definition at line 325 of file class.SurveyMatrixQuestion.php.
Referenced by addUserSpecificResultsData(), addUserSpecificResultsExportTitles(), getCumulatedResultsForRow(), getUserAnswers(), insertXML(), and saveRowsToDb().
SurveyMatrixQuestion::getRowCount | ( | ) |
Returns the number of rows in the question.
Definition at line 282 of file class.SurveyMatrixQuestion.php.
Referenced by addUserSpecificResultsData(), addUserSpecificResultsExportTitles(), checkUserInput(), getCumulatedResults(), insertXML(), isComplete(), saveRandomData(), and saveRowsToDb().
SurveyMatrixQuestion::getRowImages | ( | ) |
Definition at line 2451 of file class.SurveyMatrixQuestion.php.
Referenced by saveToDb().
SurveyMatrixQuestion::getRows | ( | ) |
Definition at line 2456 of file class.SurveyMatrixQuestion.php.
References $rows.
SurveyMatrixQuestion::getRowSeparators | ( | ) |
Gets the separators enable state for the matrix rows.
Definition at line 2067 of file class.SurveyMatrixQuestion.php.
Referenced by insertXML(), and saveToDb().
SurveyMatrixQuestion::getSingleLineRowCaption | ( | ) |
Definition at line 2391 of file class.SurveyMatrixQuestion.php.
Referenced by saveToDb().
SurveyMatrixQuestion::getSubtype | ( | ) |
Returns the subtype of the matrix question.
Reimplemented from SurveyQuestion.
Definition at line 1980 of file class.SurveyMatrixQuestion.php.
References $subtype.
Referenced by addUserSpecificResultsData(), addUserSpecificResultsExportTitles(), checkUserInput(), getCumulatedResults(), getCumulatedResultsForRow(), getWorkingDataFromUserInput(), insertXML(), saveToDb(), and saveUserInput().
& SurveyMatrixQuestion::getUserAnswers | ( | $survey_id, | |
$finished_ids | |||
) |
Returns an array containing all answers to this question in a given survey.
integer | $survey_id | The database ID of the survey |
Definition at line 1943 of file class.SurveyMatrixQuestion.php.
References $result, $row, SurveyQuestion\$survey_id, getColumnForScale(), SurveyQuestion\getId(), and getRow().
& SurveyMatrixQuestion::getWorkingDataFromUserInput | ( | $post_data | ) |
Creates the user data of the svy_answer table from the POST data.
Reimplemented from SurveyQuestion.
Definition at line 973 of file class.SurveyMatrixQuestion.php.
References SurveyQuestion\getId(), and getSubtype().
SurveyMatrixQuestion::hasBipolarAdjectives | ( | ) |
Returns TRUE if bipolar adjectives exist.
Definition at line 2319 of file class.SurveyMatrixQuestion.php.
References getBipolarAdjective().
Referenced by getLayout().
SurveyMatrixQuestion::hasNeutralColumn | ( | ) |
Returns TRUE if a neutral column exists.
Definition at line 2336 of file class.SurveyMatrixQuestion.php.
References getColumn(), and getColumnCount().
Referenced by getLayout().
SurveyMatrixQuestion::importAdditionalMetadata | ( | $a_meta | ) |
Import additional meta data from the question import file.
Usually the meta data section is used to store question elements which are not part of the standard XML schema.
Reimplemented from SurveyQuestion.
Definition at line 2111 of file class.SurveyMatrixQuestion.php.
References setColumnSeparators(), setLayout(), setNeutralColumnSeparator(), and setRowSeparators().
SurveyMatrixQuestion::importAdjectives | ( | $a_data | ) |
Import bipolar adjectives from the question import file.
Reimplemented from SurveyQuestion.
Definition at line 2139 of file class.SurveyMatrixQuestion.php.
References setBipolarAdjective().
SurveyMatrixQuestion::importMatrix | ( | $a_data | ) |
Import matrix rows from the question import file.
Reimplemented from SurveyQuestion.
Definition at line 2162 of file class.SurveyMatrixQuestion.php.
References $row, and addRow().
SurveyMatrixQuestion::importResponses | ( | $a_data | ) |
Import response data from the question import file.
Reimplemented from SurveyQuestion.
Definition at line 2176 of file class.SurveyMatrixQuestion.php.
References SurveyQuestion\$id, and SurveyQuestion\$material.
SurveyMatrixQuestion::insertXML | ( | & | $a_xml_writer, |
$a_include_header = TRUE , |
|||
$obligatory_state = "" |
|||
) |
Adds the question XML to a given XMLWriter object.
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 753 of file class.SurveyMatrixQuestion.php.
References SurveyQuestion\addMaterialTag(), SurveyQuestion\getAuthor(), getBipolarAdjective(), getColumn(), getColumnCount(), getColumnSeparators(), SurveyQuestion\getDescription(), SurveyQuestion\getId(), getLayout(), getNeutralColumnSeparator(), SurveyQuestion\getObligatory(), SurveyQuestion\getQuestiontext(), getRow(), getRowCount(), getRowSeparators(), getSubtype(), and SurveyQuestion\getTitle().
Referenced by toXML().
SurveyMatrixQuestion::isComplete | ( | ) |
Returns 1 if the question is complete for use.
Reimplemented from SurveyQuestion.
Definition at line 535 of file class.SurveyMatrixQuestion.php.
References SurveyQuestion\getAuthor(), getColumnCount(), SurveyQuestion\getQuestiontext(), getRowCount(), and SurveyQuestion\getTitle().
SurveyMatrixQuestion::loadFromDb | ( | $id | ) |
Loads a SurveyMatrixQuestion object from the database.
integer | $id | The database id of the matrix question public |
Reimplemented from SurveyQuestion.
Definition at line 465 of file class.SurveyMatrixQuestion.php.
References SurveyQuestion\$id, $result, $row, ilRTE\_replaceMediaObjectImageSrc(), addRow(), flushColumns(), getAdditionalTableName(), SurveyQuestion\setAuthor(), setBipolarAdjective(), setColumnHeaderPosition(), setColumnImages(), setColumnOrder(), setColumnPlaceholders(), setColumnSeparators(), SurveyQuestion\setComplete(), SurveyQuestion\setDescription(), SurveyQuestion\setId(), setLayout(), setLegend(), setNeutralColumnSeparator(), SurveyQuestion\setObjId(), SurveyQuestion\setObligatory(), SurveyQuestion\setOriginalId(), SurveyQuestion\setOwner(), SurveyQuestion\setQuestiontext(), setRandomRows(), setRepeatColumnHeader(), setRowImages(), setRowSeparators(), setSingleLineRowCaption(), setSubtype(), and SurveyQuestion\setTitle().
SurveyMatrixQuestion::moveRowDown | ( | $index | ) |
Definition at line 335 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::moveRowUp | ( | $index | ) |
Definition at line 330 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::removeColumn | ( | $index | ) |
Removes a column from the list of columns.
integer | $index | The index of the column to be removed public |
Definition at line 197 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::removeColumns | ( | $array | ) |
Removes many columns from the list of columns.
array | $array | An array containing the index positions of the columns to be removed public |
Definition at line 209 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::removeColumnWithName | ( | $name | ) |
Removes a column from the list of columns.
string | $name | The name of the column to be removed public |
Definition at line 221 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::removeRow | ( | $index | ) |
Removes a row.
integer | $index | The index of the row to be removed |
Definition at line 357 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::removeRows | ( | $array | ) |
Removes rows from the question.
array | $array | An array containing the index positions of the rows to be removed public |
Definition at line 347 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::saveBipolarAdjectives | ( | $adjective1, | |
$adjective2 | |||
) |
Definition at line 609 of file class.SurveyMatrixQuestion.php.
References getAdditionalTableName(), and SurveyQuestion\getId().
SurveyMatrixQuestion::saveColumnsToDb | ( | $original_id = "" | ) |
Definition at line 665 of file class.SurveyMatrixQuestion.php.
References getColumn(), getColumnCount(), SurveyQuestion\getId(), saveColumnToDb(), and SurveyQuestion\saveCompletionStatus().
Referenced by saveToDb(), and syncWithOriginal().
SurveyMatrixQuestion::saveColumnToDb | ( | $columntext, | |
$neutral = 0 |
|||
) |
Saves a column to the database.
string | $columntext | The text of the column |
Definition at line 627 of file class.SurveyMatrixQuestion.php.
References $ilUser, $result, and $row.
Referenced by saveColumnsToDb().
SurveyMatrixQuestion::saveLayout | ( | $percent_row, | |
$percent_columns, | |||
$percent_bipolar_adjective1 = "" , |
|||
$percent_bipolar_adjective2 = "" , |
|||
$percent_neutral | |||
) |
Saves the layout of a matrix question.
double | $percent_row | The width in percent for the matrix rows |
double | $percent_columns | The width in percent for the matrix columns |
double | $percent_bipolar_adjective1 | The width in percent for the first bipolar adjective |
double | $percent_bipolar_adjective2 | The width in percent for the second bipolar adjective |
Definition at line 2237 of file class.SurveyMatrixQuestion.php.
References $layout, getAdditionalTableName(), and SurveyQuestion\getId().
SurveyMatrixQuestion::savePhrase | ( | $title | ) |
Saves a set of columns to a default phrase.
array | $phrases | The database ids of the seleted phrases |
string | $title | The title of the default phrase public |
Definition at line 915 of file class.SurveyMatrixQuestion.php.
References $_SESSION, $ilUser, and SurveyQuestion\$title.
SurveyMatrixQuestion::saveRandomData | ( | $active_id | ) |
Saves random answers for a given active user in the database.
integer | $active_id | The database ID of the active user |
Reimplemented from SurveyQuestion.
Definition at line 1074 of file class.SurveyMatrixQuestion.php.
References $row, getColumnCount(), SurveyQuestion\getId(), and getRowCount().
SurveyMatrixQuestion::saveRowsToDb | ( | $original_id = "" | ) |
Definition at line 695 of file class.SurveyMatrixQuestion.php.
References $row, SurveyQuestion\getId(), getRow(), getRowCount(), and SurveyQuestion\saveCompletionStatus().
Referenced by saveToDb(), and syncWithOriginal().
SurveyMatrixQuestion::saveToDb | ( | $original_id = NULL , |
|
$withanswers = true |
|||
) |
Saves a SurveyMatrixQuestion object to a database.
public
Definition at line 558 of file class.SurveyMatrixQuestion.php.
References getAdditionalTableName(), getBipolarAdjective(), getColumnHeaderPosition(), getColumnImages(), getColumnOrder(), getColumnPlaceholders(), getColumnSeparators(), SurveyQuestion\getId(), getLayout(), getLegend(), getNeutralColumnSeparator(), getRandomRows(), getRepeatColumnHeader(), getRowImages(), getRowSeparators(), getSingleLineRowCaption(), getSubtype(), saveColumnsToDb(), SurveyQuestion\saveMaterial(), and saveRowsToDb().
SurveyMatrixQuestion::saveUserInput | ( | $post_data, | |
$active_id, | |||
$a_return = false |
|||
) |
Definition at line 1108 of file class.SurveyMatrixQuestion.php.
References SurveyQuestion\getId(), and getSubtype().
SurveyMatrixQuestion::setBipolarAdjective | ( | $a_index, | |
$a_value | |||
) |
Sets one of the bipolar adjectives.
integer | $a_index | The number of the bipolar adjective (0 for the first and 1 for the second adjective) |
string | $a_value | The text of the bipolar adjective public |
Definition at line 391 of file class.SurveyMatrixQuestion.php.
Referenced by importAdjectives(), and loadFromDb().
SurveyMatrixQuestion::setColumnHeaderPosition | ( | $a_value | ) |
Definition at line 2406 of file class.SurveyMatrixQuestion.php.
Referenced by loadFromDb().
SurveyMatrixQuestion::setColumnImages | ( | $a_value = 0 | ) |
Definition at line 2436 of file class.SurveyMatrixQuestion.php.
Referenced by loadFromDb().
SurveyMatrixQuestion::setColumnOrder | ( | $a_value | ) |
Definition at line 2426 of file class.SurveyMatrixQuestion.php.
Referenced by loadFromDb().
SurveyMatrixQuestion::setColumnPlaceholders | ( | $a_value = 0 | ) |
Set whether placeholders should be used for the column titles or not.
integer | $a_value | 1 for placeholders, 0 otherwise |
Definition at line 2351 of file class.SurveyMatrixQuestion.php.
Referenced by loadFromDb().
SurveyMatrixQuestion::setColumnSeparators | ( | $enable = 0 | ) |
Enables/Disables separators for the matrix columns.
integer | $enable | 1 if the separators should be enabled, 0 otherwise public |
Definition at line 2016 of file class.SurveyMatrixQuestion.php.
Referenced by importAdditionalMetadata(), and loadFromDb().
& SurveyMatrixQuestion::setExportCumulatedCVS | ( | & | $eval_data, |
$export_label | |||
) |
Creates the CSV output for the cumulated results of this question.
object | $worksheet | Reference to the excel worksheet |
object | $format_title | Excel title format |
object | $format_bold | Excel bold format |
array | $eval_data | Cumulated evaluation data |
integer | $row | Actual row in the worksheet |
Reimplemented from SurveyQuestion.
Definition at line 1543 of file class.SurveyMatrixQuestion.php.
References $result, SurveyQuestion\getQuestiontext(), and SurveyQuestion\getTitle().
SurveyMatrixQuestion::setExportCumulatedXLS | ( | & | $worksheet, |
& | $format_title, | ||
& | $format_bold, | ||
& | $eval_data, | ||
$row, | |||
$export_label | |||
) |
Creates the Excel output for the cumulated results of this question.
object | $worksheet | Reference to the excel worksheet |
object | $format_title | Excel title format |
object | $format_bold | Excel bold format |
array | $eval_data | Cumulated evaluation data |
integer | $row | Actual row in the worksheet |
Reimplemented from SurveyQuestion.
Definition at line 1467 of file class.SurveyMatrixQuestion.php.
References $row, ilExcelUtils\_convert_text(), SurveyQuestion\getQuestiontext(), and SurveyQuestion\getTitle().
SurveyMatrixQuestion::setExportDetailsXLS | ( | & | $workbook, |
& | $format_title, | ||
& | $format_bold, | ||
& | $eval_data, | ||
$export_label | |||
) |
Creates an Excel worksheet for the detailed cumulated results of this question.
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 1593 of file class.SurveyMatrixQuestion.php.
References SurveyQuestion\$title, ilExcelUtils\_convert_text(), SurveyQuestion\getQuestiontext(), and SurveyQuestion\getTitle().
SurveyMatrixQuestion::setLayout | ( | $layout | ) |
Definition at line 2302 of file class.SurveyMatrixQuestion.php.
References $layout.
Referenced by importAdditionalMetadata(), and loadFromDb().
SurveyMatrixQuestion::setLegend | ( | $a_value = 0 | ) |
Set whether the legend should be shown or not.
integer | $a_value | Show legend |
Definition at line 2371 of file class.SurveyMatrixQuestion.php.
Referenced by loadFromDb().
SurveyMatrixQuestion::setNeutralColumnSeparator | ( | $enable = 0 | ) |
Enables/Disables a separator for the neutral column.
integer | $enable | 1 if the separator should be enabled, 0 otherwise public |
Definition at line 2078 of file class.SurveyMatrixQuestion.php.
Referenced by importAdditionalMetadata(), and loadFromDb().
SurveyMatrixQuestion::setRandomRows | ( | $a_value = 0 | ) |
Definition at line 2416 of file class.SurveyMatrixQuestion.php.
Referenced by loadFromDb().
SurveyMatrixQuestion::setRepeatColumnHeader | ( | $a_value = 0 | ) |
Definition at line 2396 of file class.SurveyMatrixQuestion.php.
Referenced by loadFromDb().
SurveyMatrixQuestion::setRowImages | ( | $a_value = 0 | ) |
Definition at line 2446 of file class.SurveyMatrixQuestion.php.
Referenced by loadFromDb().
SurveyMatrixQuestion::setRowSeparators | ( | $enable = 0 | ) |
Enables/Disables separators for the matrix rows.
integer | $enable | 1 if the separators should be enabled, 0 otherwise public |
Definition at line 2047 of file class.SurveyMatrixQuestion.php.
Referenced by importAdditionalMetadata(), and loadFromDb().
SurveyMatrixQuestion::setSingleLineRowCaption | ( | $a_value = 0 | ) |
Definition at line 2386 of file class.SurveyMatrixQuestion.php.
Referenced by loadFromDb().
SurveyMatrixQuestion::setSubtype | ( | $a_subtype = 0 | ) |
Sets the subtype of the matrix question.
Reimplemented from SurveyQuestion.
Definition at line 1991 of file class.SurveyMatrixQuestion.php.
Referenced by loadFromDb().
SurveyMatrixQuestion::SurveyMatrixQuestion | ( | $title = "" , |
|
$description = "" , |
|||
$author = "" , |
|||
$questiontext = "" , |
|||
$owner = -1 |
|||
) |
SurveyMatrixQuestion constructor The constructor takes possible arguments an creates an instance of the SurveyMatrixQuestion object.
string | $title | A title string to describe the question |
string | $description | A description string to describe the question |
string | $author | A string containing the name of the questions author |
integer | $owner | A numerical ID to identify the owner/creator public |
Definition at line 158 of file class.SurveyMatrixQuestion.php.
References SurveyQuestion\$author, SurveyQuestion\$description, SurveyQuestion\$owner, SurveyQuestion\$questiontext, SurveyQuestion\$title, and SurveyQuestion\SurveyQuestion().
SurveyMatrixQuestion::syncWithOriginal | ( | ) |
Reimplemented from SurveyQuestion.
Definition at line 882 of file class.SurveyMatrixQuestion.php.
References SurveyQuestion\getOriginalId(), saveColumnsToDb(), and saveRowsToDb().
SurveyMatrixQuestion::toXML | ( | $a_include_header = TRUE , |
|
$obligatory_state = "" |
|||
) |
Returns an xml representation of the question.
Definition at line 730 of file class.SurveyMatrixQuestion.php.
References insertXML(), and ilXmlWriter\xmlHeader().
SurveyMatrixQuestion::usableForPrecondition | ( | ) |
Returns if the question is usable for preconditions.
Reimplemented from SurveyQuestion.
Definition at line 2195 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::$bipolar_adjective1 |
Definition at line 56 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::$bipolar_adjective2 |
Definition at line 63 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::$columnHeaderPosition |
Definition at line 114 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::$columnImages |
Definition at line 125 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::$columnOrder |
Definition at line 123 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::$columnPlaceholders |
Definition at line 101 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::$columns |
Definition at line 42 of file class.SurveyMatrixQuestion.php.
Referenced by getColumns().
SurveyMatrixQuestion::$columnSeparators |
Definition at line 71 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::$layout |
Definition at line 94 of file class.SurveyMatrixQuestion.php.
Referenced by getLayout(), saveLayout(), and setLayout().
SurveyMatrixQuestion::$legend |
Definition at line 108 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::$neutralColumnSeparator |
Definition at line 87 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::$openRows |
Definition at line 129 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::$randomRows |
Definition at line 121 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::$repeatColumnHeader |
Definition at line 112 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::$rowImages |
Definition at line 127 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::$rows |
Definition at line 49 of file class.SurveyMatrixQuestion.php.
Referenced by getRows().
SurveyMatrixQuestion::$rowSeparators |
Definition at line 79 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::$singleLineRowCaption |
Definition at line 110 of file class.SurveyMatrixQuestion.php.
SurveyMatrixQuestion::$subtype |
Definition at line 146 of file class.SurveyMatrixQuestion.php.
Referenced by getSubtype().