ILIAS  release_5-0 Revision 5.0.0-1144-gc4397b1f870
assSingleChoice Class Reference

Class for single choice questions. More...

+ Inheritance diagram for assSingleChoice:
+ Collaboration diagram for assSingleChoice:

Public Member Functions

 __construct ( $title="", $comment="", $author="", $owner=-1, $question="", $output_type=OUTPUT_ORDER)
 assSingleChoice constructor More...
 
 isComplete ()
 Returns true, if a single choice question is complete for use. More...
 
 getThumbPrefix ()
 
 loadFromDb ($question_id)
 Loads a assSingleChoice object from a database. More...
 
 duplicate ($for_test=true, $title="", $author="", $owner="", $testObjId=null)
 Duplicates an assSingleChoiceQuestion. More...
 
 copyObject ($target_questionpool_id, $title="")
 Copies an assSingleChoice object. More...
 
 createNewOriginalFromThisDuplicate ($targetParentId, $targetQuestionTitle="")
 
 getOutputType ()
 Gets the single choice output type which is either OUTPUT_ORDER (=0) or OUTPUT_RANDOM (=1). More...
 
 setOutputType ($output_type=OUTPUT_ORDER)
 Sets the output type of the assSingleChoice object. More...
 
 addAnswer ( $answertext="", $points=0.0, $order=0, $answerimage="")
 Adds a possible answer for a single choice question. More...
 
 getAnswerCount ()
 Returns the number of answers. More...
 
 getAnswer ($index=0)
 Returns an answer with a given index. More...
 
 deleteAnswer ($index=0)
 Deletes an answer with a given index. More...
 
 flushAnswers ()
 Deletes all answers. More...
 
 getMaximumPoints ()
 Returns the maximum points, a learner can reach answering the question. More...
 
 calculateReachedPoints ($active_id, $pass=NULL, $returndetails=FALSE)
 Returns the points, a learner has reached answering the question. More...
 
 calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $previewSession)
 
 saveWorkingData ($active_id, $pass=NULL)
 Saves the learners input of the question to the database. More...
 
 getQuestionType ()
 Returns the question type of the question. More...
 
 getAdditionalTableName ()
 Returns the name of the additional question data table in the database. More...
 
 getAnswerTableName ()
 Returns the name of the answer table in the database. More...
 
 setImageFile ($image_filename, $image_tempfilename="")
 Sets the image file and uploads the image to the object's image directory. More...
 
 deleteImage ($image_filename)
 Deletes an image file. More...
 
 duplicateImages ($question_id, $objectId=null)
 
 copyImages ($question_id, $source_questionpool)
 
 getRTETextWithMediaObjects ()
 Collects all text in the question which could contain media objects which were created with the Rich Text Editor. More...
 
getAnswers ()
 Returns a reference to the answers array. More...
 
 setExportDetailsXLS (&$worksheet, $startrow, $active_id, $pass, &$format_title, &$format_bold)
 Creates an Excel worksheet for the detailed cumulated results of this question. More...
 
 getThumbSize ()
 
 setThumbSize ($a_size)
 
 toJSON ()
 Returns a JSON representation of the question. More...
 
 removeAnswerImage ($index)
 
 createRandomSolution ($active_id, $pass)
 
 getMultilineAnswerSetting ()
 
 setMultilineAnswerSetting ($a_setting=0)
 
 setSpecificFeedbackSetting ($a_feedback_setting)
 Sets the feedback settings in effect for the question. More...
 
 getSpecificFeedbackSetting ()
 Gets the current feedback settings in effect for the question. More...
 
 isAnswered ($active_id, $pass)
 returns boolean wether the question is answered during test pass or not More...
 
 getOperators ($expression)
 Get all available operations for a specific question. More...
 
 getExpressionTypes ()
 Get all available expression types for a specific question. More...
 
 getAvailableAnswerOptions ($index=null)
 If index is null, the function returns an array with all anwser options Else it returns the specific answer option. More...
 
- Public Member Functions inherited from assQuestion
 __construct ( $title="", $comment="", $author="", $owner=-1, $question="")
 assQuestion constructor More...
 
 setProcessLocker ($processLocker)
 
 getProcessLocker ()
 
 fromXML (&$item, &$questionpool_id, &$tst_id, &$tst_object, &$question_counter, &$import_mapping)
 Receives parameters from a QTI parser and creates a valid ILIAS question object. More...
 
 toXML ($a_include_header=true, $a_include_binary=true, $a_shuffle=false, $test_output=false, $force_image_references=false)
 Returns a QTI xml representation of the question. More...
 
 isComplete ()
 Returns true, if a question is complete for use. More...
 
 questionTitleExists ($questionpool_id, $title)
 Returns TRUE if the question title exists in the database. More...
 
 setTitle ($title="")
 Sets the title string of the assQuestion object. More...
 
 setId ($id=-1)
 Sets the id of the assQuestion object. More...
 
 setTestId ($id=-1)
 Sets the test id of the assQuestion object. More...
 
 setComment ($comment="")
 Sets the comment string of the assQuestion object. More...
 
 setOutputType ($outputType=OUTPUT_HTML)
 Sets the output type. More...
 
 setShuffle ($shuffle=true)
 Sets the shuffle flag. More...
 
 setEstimatedWorkingTime ($hour=0, $min=0, $sec=0)
 Sets the estimated working time of a question from given hour, minute and second. More...
 
 setEstimatedWorkingTimeFromDurationString ($durationString)
 Sets the estimated working time of a question from a given datetime string. More...
 
 keyInArray ($searchkey, $array)
 returns TRUE if the key occurs in an array More...
 
 setAuthor ($author="")
 Sets the authors name of the assQuestion object. More...
 
 setOwner ($owner="")
 Sets the creator/owner ID of the assQuestion object. More...
 
 getTitle ()
 Gets the title string of the assQuestion object. More...
 
 getId ()
 Gets the id of the assQuestion object. More...
 
 getShuffle ()
 Gets the shuffle flag. More...
 
 getTestId ()
 Gets the test id of the assQuestion object. More...
 
 getComment ()
 Gets the comment string of the assQuestion object. More...
 
 getOutputType ()
 Gets the output type. More...
 
 supportsJavascriptOutput ()
 Returns true if the question type supports JavaScript output. More...
 
 supportsNonJsOutput ()
 
 requiresJsSwitch ()
 
 getEstimatedWorkingTime ()
 Gets the estimated working time of a question. More...
 
 getAuthor ()
 Gets the authors name of the assQuestion object. More...
 
 getOwner ()
 Gets the creator/owner ID of the assQuestion object. More...
 
 getObjId ()
 Get the object id of the container object. More...
 
 setObjId ($obj_id=0)
 Set the object id of the container object. More...
 
 setExternalId ($external_id)
 
 getExternalId ()
 
 _getMaximumPoints ($question_id)
 Returns the maximum points, a learner can reach answering the question. More...
 
_getQuestionInfo ($question_id)
 Returns question information from the database. More...
 
 getSuggestedSolutionOutput ()
 
_getSuggestedSolution ($question_id, $subquestion_index=0)
 Returns a suggested solution for a given subquestion index. More...
 
 getSuggestedSolutions ()
 Return the suggested solutions. More...
 
 _getReachedPoints ($active_id, $question_id, $pass=NULL)
 Returns the points, a learner has reached answering the question. More...
 
 getReachedPoints ($active_id, $pass=NULL)
 Returns the points, a learner has reached answering the question This is the fast way to get the points directly from the database. More...
 
 getMaximumPoints ()
 Returns the maximum points, a learner can reach answering the question. More...
 
 getAdjustedReachedPoints ($active_id, $pass=NULL)
 returns the reached points ... More...
 
 calculateResultsFromSolution ($active_id, $pass=NULL, $obligationsEnabled=false)
 Calculates the question results from a previously saved question solution. More...
 
 persistWorkingState ($active_id, $pass=NULL, $obligationsEnabled=false)
 persists the working state for current testactive and testpass More...
 
 persistPreviewState (ilAssQuestionPreviewSession $previewSession)
 persists the preview state for current user and question More...
 
 saveWorkingData ($active_id, $pass=NULL)
 Saves the learners input of the question to the database. More...
 
 _updateTestResultCache ($active_id, ilAssQuestionProcessLocker $processLocker=null)
 @TODO Move this to a proper place. More...
 
 logAction ($logtext="", $active_id="", $question_id="")
 Logs an action into the Test&Assessment log. More...
 
 _logAction ($logtext="", $active_id="", $question_id="")
 Logs an action into the Test&Assessment log. More...
 
 moveUploadedMediaFile ($file, $name)
 Move an uploaded media file to an public accessible temp dir to present it. More...
 
 getSuggestedSolutionPath ()
 Returns the path for a suggested solution. More...
 
 getJavaPath ()
 Returns the image path for web accessable images of a question. More...
 
 getImagePath ($question_id=null, $object_id=null)
 Returns the image path for web accessable images of a question. More...
 
 buildImagePath ($questionId, $parentObjectId)
 
 getFlashPath ()
 Returns the image path for web accessable flash files of a question. More...
 
 getJavaPathWeb ()
 Returns the web image path for web accessable java applets of a question. More...
 
 getSuggestedSolutionPathWeb ()
 Returns the web path for a suggested solution. More...
 
 getImagePathWeb ()
 Returns the web image path for web accessable images of a question. More...
 
 getFlashPathWeb ()
 Returns the web image path for web accessable flash applications of a question. More...
 
getSolutionValues ($active_id, $pass=NULL)
 Loads solutions of a given user from the database an returns it. More...
 
 isInUse ($question_id="")
 Checks whether the question is in use or not. More...
 
 isClone ($question_id="")
 Checks whether the question is a clone of another question or not. More...
 
 pcArrayShuffle ($array)
 Shuffles the values of a given array. More...
 
 getQuestionTypeFromDb ($question_id)
 get question type for question id More...
 
 getAdditionalTableName ()
 Returns the name of the additional question data table in the database. More...
 
 getAnswerTableName ()
 Returns the name of the answer table in the database. More...
 
 deleteAnswers ($question_id)
 Deletes datasets from answers tables. 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...
 
 getTotalAnswers ()
 get total number of answers More...
 
 _getTotalAnswers ($a_q_id)
 get number of answers for question id (static) note: do not use $this inside this method More...
 
 _getTitle ($a_q_id)
 Returns the title of a question. More...
 
 _getQuestionText ($a_q_id)
 Returns question text. More...
 
 copyXHTMLMediaObjectsOfQuestion ($a_q_id)
 
 syncXHTMLMediaObjectsOfQuestion ()
 
 createPageObject ()
 create page object of question More...
 
 copyPageOfQuestion ($a_q_id)
 
 getPageOfQuestion ()
 
 _getQuestionType ($question_id)
 Returns the question type of a question with a given id. More...
 
 _getQuestionTitle ($question_id)
 Returns the question title of a question with a given id. More...
 
 setOriginalId ($original_id)
 
 getOriginalId ()
 
 fixSvgToPng ($imageFilenameContainingString)
 
 fixUnavailableSkinImageSources ($html)
 
 loadFromDb ($question_id)
 Loads the question from the database. More...
 
 createNewQuestion ($a_create_page=true)
 Creates a new question without an owner 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...
 
 saveQuestionDataToDb ($original_id="")
 
 saveToDb ($original_id="")
 Saves the question to the database. More...
 
 setNewOriginalId ($newId)
 
 deleteSuggestedSolutions ()
 Deletes all suggestes solutions in the database. More...
 
 getSuggestedSolution ($subquestion_index=0)
 Returns a suggested solution for a given subquestion index. More...
 
 getSuggestedSolutionTitle ($subquestion_index=0)
 Returns the title of a suggested solution at a given subquestion_index. More...
 
 setSuggestedSolution ($solution_id="", $subquestion_index=0, $is_import=false)
 Sets a suggested solution for the question. More...
 
 _resolveInternalLink ($internal_link)
 
 _resolveIntLinks ($question_id)
 
 _getInternalLinkHref ($target="")
 
 syncWithOriginal ()
 
 createRandomSolution ($test_id, $user_id)
 
 _questionExists ($question_id)
 Returns true if the question already exists in the database. More...
 
 _questionExistsInPool ($question_id)
 Returns true if the question already exists in the database and is assigned to a question pool. More...
 
 getPoints ()
 Returns the maximum available points for the question. More...
 
 setPoints ($a_points)
 Sets the maximum available points for the question. More...
 
 getSolutionMaxPass ($active_id)
 Returns the maximum pass a users question solution. More...
 
 _getSolutionMaxPass ($question_id, $active_id)
 Returns the maximum pass a users question solution. More...
 
 _isWriteable ($question_id, $user_id)
 Returns true if the question is writeable by a certain user. More...
 
 _isUsedInRandomTest ($question_id="")
 Checks whether the question is used in a random test or not. More...
 
 calculateReachedPoints ($active_id, $pass=NULL, $returndetails=FALSE)
 Returns the points, a learner has reached answering the question. More...
 
 calculateReachedPointsFromPreviewSession (ilAssQuestionPreviewSession $previewSession)
 
 isPreviewSolutionCorrect (ilAssQuestionPreviewSession $previewSession)
 
 adjustReachedPointsByScoringOptions ($points, $active_id, $pass=NULL)
 Adjust the given reached points by checks for all special scoring options in the test container. More...
 
 isHTML ($a_text)
 Checks if a given string contains HTML or not. More...
 
 prepareTextareaOutput ($txt_output, $prepare_for_latex_output=FALSE)
 Prepares a string for a text area output in tests. More...
 
 QTIMaterialToString ($a_material)
 Reads an QTI material tag an creates a text string. More...
 
 addQTIMaterial (&$a_xml_writer, $a_material, $close_material_tag=TRUE, $add_mobs=TRUE)
 Creates a QTI material tag from a plain text or xhtml text. More...
 
 createNewImageFileName ($image_filename, $unique=false)
 
 _setReachedPoints ($active_id, $question_id, $points, $maxpoints, $pass, $manualscoring, $obligationsEnabled)
 Sets the points, a learner has reached answering the question Additionally objective results are updated. More...
 
 getQuestion ()
 Gets the question string of the question object. More...
 
 setQuestion ($question="")
 Sets the question string of the question object. More...
 
 getQuestionType ()
 Returns the question type of the question. More...
 
 getQuestionTypeID ()
 Returns the question type of the question. More...
 
 cleanupMediaObjectUsage ()
 synchronises appearances of media objects in the question with media object usage table More...
 
getInstances ()
 Gets all instances of the question. More...
 
 _needsManualScoring ($question_id)
 
 getActiveUserData ($active_id)
 Returns the user id and the test id for a given active id. More...
 
 setExportDetailsXLS (&$worksheet, $startrow, $active_id, $pass, &$format_title, &$format_bold)
 Creates an Excel worksheet for the detailed cumulated results of this question. More...
 
 __get ($value)
 Object getter. More...
 
 __set ($key, $value)
 Object setter. More...
 
 getNrOfTries ()
 
 setNrOfTries ($a_nr_of_tries)
 
 setExportImagePath ($a_path)
 
 _questionExistsInTest ($question_id, $test_id)
 
 formatSAQuestion ($a_q)
 Format self assessment question. More...
 
 setPreventRteUsage ($a_val)
 Set prevent rte usage. More...
 
 getPreventRteUsage ()
 Get prevent rte usage. More...
 
 setSelfAssessmentEditingMode ($a_selfassessmenteditingmode)
 Set Self-Assessment Editing Mode. More...
 
 getSelfAssessmentEditingMode ()
 Get Self-Assessment Editing Mode. More...
 
 setDefaultNrOfTries ($a_defaultnroftries)
 Set Default Nr of Tries. More...
 
 getDefaultNrOfTries ()
 Get Default Nr of Tries. More...
 
 isAnswered ($active_id, $pass=null)
 returns boolean wether the question is answered during test pass or not More...
 
 setObligationsToBeConsidered ($obligationsToBeConsidered=true)
 sets the flag wether obligations are to be considered or not More...
 
 areObligationsToBeConsidered ()
 gets the flag wether obligations are to be considered or not More...
 
 isAutosaveable ()
 
 getAdditionalContentEditingMode ()
 getter for additional content editing mode for this question More...
 
 setAdditionalContentEditingMode ($additinalContentEditingMode)
 setter for additional content editing mode for this question More...
 
 isAdditionalContentEditingModePageObject ()
 isser for additional "pageobject" content editing mode More...
 
 isValidAdditionalContentEditingMode ($additionalContentEditingMode)
 returns the fact wether the passed additional content mode is valid or not More...
 
 getValidAdditionalContentEditingModes ()
 getter for valid additional content editing modes More...
 
 addQuestionChangeListener (ilQuestionChangeListener $listener)
 
 getQuestionChangeListeners ()
 
 getHtmlUserSolutionPurifier ()
 
 getHtmlQuestionContentPurifier ()
 
 setLastChange ($lastChange)
 
 getLastChange ()
 
 setStep ($step)
 
 getStep ()
 
 toJSON ()
 
 duplicate ($for_test=true, $title="", $author="", $owner="", $testObjId=null)
 
- Public Member Functions inherited from ilObjQuestionScoringAdjustable
 saveAdditionalQuestionDataToDb ()
 Saves a record to the question types additional data table. More...
 
- Public Member Functions inherited from ilObjAnswerScoringAdjustable
 saveAnswerSpecificDataToDb ()
 Saves the answer specific records into a question types answer table. More...
 
- Public Member Functions inherited from iQuestionCondition
 getOperators ($expression)
 Get all available operations for a specific question. More...
 
 getExpressionTypes ()
 Get all available expression types for a specific question. More...
 
 getUserQuestionResult ($active_id, $pass)
 Get the user solution for a question by active_id and the test pass. More...
 
 getAvailableAnswerOptions ($index=null)
 If index is null, the function returns an array with all anwser options Else it returns the specific answer option. More...
 

Static Public Member Functions

static isObligationPossible ($questionId)
 returns boolean wether it is possible to set this question type as obligatory or not considering the current question configuration More...
 
- Static Public Member Functions inherited from assQuestion
static isAllowedImageMimeType ($mimeType)
 
static fetchMimeTypeIdentifier ($contentTypeString)
 
static getAllowedFileExtensionsForMimeType ($mimeType)
 
static isAllowedImageFileExtension ($mimeType, $fileExtension)
 
static getAllowedImageFileExtensions ()
 
static _getSuggestedSolutionCount ($question_id)
 Returns the number of suggested solutions associated with a question. More...
 
static _getSuggestedSolutionOutput ($question_id)
 Returns the output of the suggested solution. More...
 
static _getTotalRightAnswers ($a_q_id)
 get number of answers for question id (static) note: do not use $this inside this method More...
 
static isFileAvailable ($file)
 
static _getOriginalId ($question_id)
 Returns the original id of a question. More...
 
static originalQuestionExists ($questionId)
 
static _instanciateQuestion ($question_id)
 Creates an instance of a question with a given question id. More...
 
static _instantiateQuestion ($question_id)
 
static _isWorkedThrough ($active_id, $question_id, $pass=NULL)
 Returns true if the question was worked through in the given pass Worked through means that the user entered at least one value. More...
 
static _areAnswered ($a_user_id, $a_question_ids)
 Checks if an array of question ids is answered by an user or not. More...
 
static _includeClass ($question_type, $gui=0)
 Include the php class file for a given question type. More...
 
static getGuiClassNameByQuestionType ($questionType)
 
static getObjectClassNameByQuestionType ($questionType)
 
static getFeedbackClassNameByQuestionType ($questionType)
 
static isCoreQuestionType ($questionType)
 
static includeCoreClass ($questionType, $withGuiClass)
 
static includePluginClass ($questionType, $withGuiClass)
 
static _getQuestionTypeName ($type_tag)
 Return the translation for a given question type tag. More...
 
static & _instanciateQuestionGUI ($question_id)
 Creates an instance of a question gui with a given question id. More...
 
static instantiateQuestionGUI ($a_question_id)
 Creates an instance of a question gui with a given question id. More...
 
static lookupParentObjId ($questionId)
 @global ilDB $ilDB More...
 
static lookupOriginalParentObjId ($originalQuestionId)
 returns the parent object id for given original question id (should be a qpl id, but theoretically it can be a tst id, too) More...
 
static isObligationPossible ($questionId)
 returns boolean wether it is possible to set this question type as obligatory or not considering the current question configuration More...
 
static setResultGateway ($resultGateway)
 
static getResultGateway ()
 
static sumTimesInISO8601FormatH_i_s_Extended ($time1, $time2)
 
static convertISO8601FormatH_i_s_ExtendedToSeconds ($time)
 

Data Fields

 $answers
 
 $output_type
 
- Data Fields inherited from assQuestion
const IMG_MIME_TYPE_JPG = 'image/jpeg'
 
const IMG_MIME_TYPE_PNG = 'image/png'
 
const IMG_MIME_TYPE_GIF = 'image/gif'
 
const ADDITIONAL_CONTENT_EDITING_MODE_DEFAULT = 'default'
 constant for additional content editing mode "default" More...
 
const ADDITIONAL_CONTENT_EDITING_MODE_PAGE_OBJECT = 'pageobject'
 constant for additional content editing mode "pageobject" More...
 
 $feedbackOBJ = null
 
 $prevent_rte_usage = false
 
 $selfassessmenteditingmode = false
 
 $defaultnroftries = 0
 
 $questionActionCmd = 'handleQuestionAction'
 
- Data Fields inherited from iQuestionCondition
const StringResultExpression = '~TEXT~'
 
const PercentageResultExpression = '%n%'
 
const NumericResultExpression = '#n#'
 
const MatchingResultExpression = ';n:m;'
 
const OrderingResultExpression = '$n,m,o,p$'
 
const NumberOfResultExpression = '+n+'
 
const ExclusiveResultExpression = '*n,m,o,p*'
 
const EmptyAnswerExpression = "?"
 

Protected Member Functions

 rebuildThumbnails ()
 
 generateThumbForFile ($path, $file)
 
 savePreviewData (ilAssQuestionPreviewSession $previewSession)
 
 reworkWorkingData ($active_id, $pass, $obligationsAnswered)
 Reworks the allready saved working data if neccessary. More...
 
 syncImages ()
 Sync images of a MC question on synchronisation with the original question. More...
 
 afterSyncWithOriginal ($origQuestionId, $dupQuestionId, $origParentObjId, $dupParentObjId)
 {} More...
 
- Protected Member Functions inherited from assQuestion
 reworkWorkingData ($active_id, $pass, $obligationsAnswered)
 Reworks the allready saved working data if neccessary. More...
 
 savePreviewData (ilAssQuestionPreviewSession $previewSession)
 
 deletePageOfQuestion ($question_id)
 Deletes the page object of a question with a given ID. More...
 
 onDuplicate ($originalParentId, $originalQuestionId, $duplicateParentId, $duplicateQuestionId)
 Will be called when a question is duplicated (inside a question pool or for insertion in a test) More...
 
 beforeSyncWithOriginal ($origQuestionId, $dupQuestionId, $origParentObjId, $dupParentObjId)
 
 afterSyncWithOriginal ($origQuestionId, $dupQuestionId, $origParentObjId, $dupParentObjId)
 
 onCopy ($sourceParentId, $sourceQuestionId, $targetParentId, $targetQuestionId)
 Will be called when a question is copied (into another question pool) More...
 
 duplicateSuggestedSolutionFiles ($parent_id, $question_id)
 Duplicates the files of a suggested solution if the question is duplicated. More...
 
 syncSuggestedSolutionFiles ($original_id)
 Syncs the files of a suggested solution if the question is synced. More...
 
 copySuggestedSolutionFiles ($source_questionpool_id, $source_question_id)
 
 getRTETextWithMediaObjects ()
 Collects all text in the question which could contain media objects which were created with the Rich Text Editor. More...
 
 duplicateQuestionHints ($originalQuestionId, $duplicateQuestionId)
 
 buildQuestionDataQuery ()
 
 getSelfAssessmentFormatter ()
 

Protected Attributes

 $thumb_size
 
 $feedback_setting
 
- Protected Attributes inherited from assQuestion
 $id
 
 $title
 
 $comment
 
 $owner
 
 $author
 
 $question
 
 $points
 
 $est_working_time
 
 $shuffle
 
 $test_id
 
 $obj_id
 
 $ilias
 
 $tpl
 
 $lng
 
 $db
 
 $outputType
 
 $suggested_solutions
 
 $original_id
 
 $page
 
 $external_id = ''
 
 $questionChangeListeners = array()
 
 $processLocker
 
 $step = null
 
 $lastChange
 

Additional Inherited Members

- Static Protected Member Functions inherited from assQuestion
static getNumExistingSolutionRecords ($activeId, $pass, $questionId)
 returns the number of existing solution records for the given test active / pass and given question id More...
 
- Static Protected Attributes inherited from assQuestion
static $allowedFileExtensionsByMimeType
 
static $allowedCharsetsByMimeType
 
static $imageSourceFixReplaceMap
 

Detailed Description

Class for single choice questions.

assSingleChoice is a class for single choice questions.

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
Björn Heyser bheys.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de
Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de
Version
$Id$

Definition at line 24 of file class.assSingleChoice.php.

Constructor & Destructor Documentation

◆ __construct()

assSingleChoice::__construct (   $title = "",
  $comment = "",
  $author = "",
  $owner = -1,
  $question = "",
  $output_type = OUTPUT_ORDER 
)

assSingleChoice constructor

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

Parameters
string$titleA title string to describe the question
string$commentA comment string to describe the question
string$authorA string containing the name of the questions author
integer$ownerA numerical ID to identify the owner/creator
string$questionThe question string of the single choice question
int | string$output_typeThe output order of the single choice answers
See also
assQuestion:assQuestion()

Definition at line 74 of file class.assSingleChoice.php.

82 {
83 parent::__construct($title, $comment, $author, $owner, $question);
84 $this->thumb_size = 150;
85 $this->output_type = $output_type;
86 $this->answers = array();
87 $this->shuffle = 1;
88 $this->feedback_setting = 2;
89 }

References assQuestion\$author, assQuestion\$comment, $output_type, assQuestion\$owner, assQuestion\$question, and assQuestion\$title.

Member Function Documentation

◆ addAnswer()

assSingleChoice::addAnswer (   $answertext = "",
  $points = 0.0,
  $order = 0,
  $answerimage = "" 
)

Adds a possible answer for a single choice question.

A ASS_AnswerBinaryStateImage object will be created and assigned to the array $this->answers.

Parameters
string$answertextThe answer text
double$pointsThe points for selecting the answer (even negative points can be used)
boolean$stateDefines the answer as correct (TRUE) or incorrect (FALSE)
integer$orderA possible display order of the answer
double$pointsThe points for not selecting the answer (even negative points can be used) @access public
See also
$answers
ASS_AnswerBinaryStateImage

Definition at line 438 of file class.assSingleChoice.php.

444 {
445 include_once "./Modules/TestQuestionPool/classes/class.assAnswerBinaryStateImage.php";
446 if (array_key_exists($order, $this->answers))
447 {
448 // insert answer
449 $answer = new ASS_AnswerBinaryStateImage($answertext, $points, $order, 1, $answerimage);
450 $newchoices = array();
451 for ($i = 0; $i < $order; $i++)
452 {
453 array_push($newchoices, $this->answers[$i]);
454 }
455 array_push($newchoices, $answer);
456 for ($i = $order; $i < count($this->answers); $i++)
457 {
458 $changed = $this->answers[$i];
459 $changed->setOrder($i+1);
460 array_push($newchoices, $changed);
461 }
462 $this->answers = $newchoices;
463 }
464 else
465 {
466 // add answer
467 $answer = new ASS_AnswerBinaryStateImage($answertext, $points, count($this->answers), 1, $answerimage);
468 array_push($this->answers, $answer);
469 }
470 }
Class for answers with a binary state indicator.

References $changed, and assQuestion\$points.

◆ afterSyncWithOriginal()

assSingleChoice::afterSyncWithOriginal (   $origQuestionId,
  $dupQuestionId,
  $origParentObjId,
  $dupParentObjId 
)
protected

{}

Reimplemented from assQuestion.

Definition at line 1295 of file class.assSingleChoice.php.

1296 {
1297 parent::afterSyncWithOriginal($origQuestionId, $dupQuestionId, $origParentObjId, $dupParentObjId);
1298
1299 $origImagePath = $this->buildImagePath($origQuestionId, $origParentObjId);
1300 $dupImagePath = $this->buildImagePath($dupQuestionId, $dupParentObjId);
1301
1302 ilUtil::delDir($origImagePath);
1303 if(is_dir($dupImagePath))
1304 {
1305 ilUtil::makeDirParents($origImagePath);
1306 ilUtil::rCopy($dupImagePath, $origImagePath);
1307 }
1308 }
buildImagePath($questionId, $parentObjectId)
static delDir($a_dir, $a_clean_only=false)
removes a dir and all its content (subdirs and files) recursively
static rCopy($a_sdir, $a_tdir, $preserveTimeAttributes=false)
Copies content of a directory $a_sdir recursively to a directory $a_tdir.
static makeDirParents($a_dir)
Create a new directory and all parent directories.

References assQuestion\buildImagePath(), ilUtil\delDir(), ilUtil\makeDirParents(), and ilUtil\rCopy().

+ Here is the call graph for this function:

◆ calculateReachedPoints()

assSingleChoice::calculateReachedPoints (   $active_id,
  $pass = NULL,
  $returndetails = FALSE 
)

Returns the points, a learner has reached answering the question.

The points are calculated from the given answers.

@access public

Parameters
integer$active_id
integer$pass
boolean$returndetails(deprecated !!)
Returns
integer/array $points/$details (array $details is deprecated !!)

Reimplemented from assQuestion.

Definition at line 568 of file class.assSingleChoice.php.

569 {
570 if( $returndetails )
571 {
572 throw new ilTestException('return details not implemented for '.__METHOD__);
573 }
574
575 global $ilDB;
576
577 $found_values = array();
578 if (is_null($pass))
579 {
580 $pass = $this->getSolutionMaxPass($active_id);
581 }
582 $result = $this->getCurrentSolutionResultSet($active_id, $pass);
583 while ($data = $ilDB->fetchAssoc($result))
584 {
585 if (strcmp($data["value1"], "") != 0)
586 {
587 array_push($found_values, $data["value1"]);
588 }
589 }
590 $points = 0;
591 foreach ($this->answers as $key => $answer)
592 {
593 if (count($found_values) > 0)
594 {
595 if (in_array($key, $found_values))
596 {
597 $points += $answer->getPoints();
598 }
599 }
600 }
601
602 return $points;
603 }
$result
getSolutionMaxPass($active_id)
Returns the maximum pass a users question solution.
Base Exception for all Exceptions relating to Modules/Test.
global $ilDB

References $data, $ilDB, $pass, assQuestion\$points, $result, and assQuestion\getSolutionMaxPass().

+ Here is the call graph for this function:

◆ calculateReachedPointsFromPreviewSession()

assSingleChoice::calculateReachedPointsFromPreviewSession ( ilAssQuestionPreviewSession  $previewSession)

Reimplemented from assQuestion.

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

606 {
607 foreach ($this->answers as $key => $answer)
608 {
609 if( $key == $previewSession->getParticipantsSolution() )
610 {
611 return $answer->getPoints();
612 }
613 }
614
615 return 0;
616 }

References ilAssQuestionPreviewSession\getParticipantsSolution().

+ Here is the call graph for this function:

◆ copyImages()

assSingleChoice::copyImages (   $question_id,
  $source_questionpool 
)

Definition at line 907 of file class.assSingleChoice.php.

908 {
909 global $ilLog;
910 $imagepath = $this->getImagePath();
911 $imagepath_original = str_replace("/$this->id/images", "/$question_id/images", $imagepath);
912 $imagepath_original = str_replace("/$this->obj_id/", "/$source_questionpool/", $imagepath_original);
913 foreach ($this->answers as $answer)
914 {
915 $filename = $answer->getImage();
916 if (strlen($filename))
917 {
918 if (!file_exists($imagepath))
919 {
920 ilUtil::makeDirParents($imagepath);
921 }
922 if (!@copy($imagepath_original . $filename, $imagepath . $filename))
923 {
924 $ilLog->write("image could not be duplicated!!!!", $ilLog->ERROR);
925 $ilLog->write("object: " . print_r($this, TRUE), $ilLog->ERROR);
926 }
927 if (@file_exists($imagepath_original. $this->getThumbPrefix(). $filename))
928 {
929 if (!@copy($imagepath_original . $this->getThumbPrefix() . $filename, $imagepath . $this->getThumbPrefix() . $filename))
930 {
931 $ilLog->write("image thumbnail could not be duplicated!!!!", $ilLog->ERROR);
932 $ilLog->write("object: " . print_r($this, TRUE), $ilLog->ERROR);
933 }
934 }
935 }
936 }
937 }
$filename
Definition: buildRTE.php:89
getImagePath($question_id=null, $object_id=null)
Returns the image path for web accessable images of a question.

References $filename, $ilLog, assQuestion\getImagePath(), getThumbPrefix(), and ilUtil\makeDirParents().

+ Here is the call graph for this function:

◆ copyObject()

assSingleChoice::copyObject (   $target_questionpool_id,
  $title = "" 
)

Copies an assSingleChoice object.

@access public

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

334 {
335 if ($this->id <= 0)
336 {
337 // The question has not been saved. It cannot be duplicated
338 return;
339 }
340 // duplicate the question in database
341 $clone = $this;
342 include_once ("./Modules/TestQuestionPool/classes/class.assQuestion.php");
344 $clone->id = -1;
345 $source_questionpool_id = $this->getObjId();
346 $clone->setObjId($target_questionpool_id);
347 if ($title)
348 {
349 $clone->setTitle($title);
350 }
351 $clone->saveToDb();
352 // copy question page content
353 $clone->copyPageOfQuestion($original_id);
354 // copy XHTML media objects
355 $clone->copyXHTMLMediaObjectsOfQuestion($original_id);
356 // duplicate the image
357 $clone->copyImages($original_id, $source_questionpool_id);
358
359 $clone->onCopy($source_questionpool_id, $original_id, $clone->getObjId(), $clone->getId());
360
361 return $clone->id;
362 }
static _getOriginalId($question_id)
Returns the original id of a question.
getObjId()
Get the object id of the container object.

References assQuestion\$original_id, assQuestion\$title, assQuestion\_getOriginalId(), and assQuestion\getObjId().

+ Here is the call graph for this function:

◆ createNewOriginalFromThisDuplicate()

assSingleChoice::createNewOriginalFromThisDuplicate (   $targetParentId,
  $targetQuestionTitle = "" 
)

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

365 {
366 if ($this->id <= 0)
367 {
368 // The question has not been saved. It cannot be duplicated
369 return;
370 }
371
372 include_once ("./Modules/TestQuestionPool/classes/class.assQuestion.php");
373
374 $sourceQuestionId = $this->id;
375 $sourceParentId = $this->getObjId();
376
377 // duplicate the question in database
378 $clone = $this;
379 $clone->id = -1;
380
381 $clone->setObjId($targetParentId);
382
383 if ($targetQuestionTitle)
384 {
385 $clone->setTitle($targetQuestionTitle);
386 }
387
388 $clone->saveToDb();
389 // copy question page content
390 $clone->copyPageOfQuestion($sourceQuestionId);
391 // copy XHTML media objects
392 $clone->copyXHTMLMediaObjectsOfQuestion($sourceQuestionId);
393 // duplicate the image
394 $clone->copyImages($sourceQuestionId, $sourceParentId);
395
396 $clone->onCopy($sourceParentId, $sourceQuestionId, $clone->getObjId(), $clone->getId());
397
398 return $clone->id;
399 }

References assQuestion\$id, and assQuestion\getObjId().

+ Here is the call graph for this function:

◆ createRandomSolution()

assSingleChoice::createRandomSolution (   $active_id,
  $pass 
)

Reimplemented from assQuestion.

Definition at line 1115 of file class.assSingleChoice.php.

1116 {
1117 $value = rand(0, count($this->answers)-1);
1118 $_POST["multiple_choice_result"] = (strlen($value)) ? (string)$value : '0';
1119 $this->saveWorkingData($active_id, $pass);
1120 }
saveWorkingData($active_id, $pass=NULL)
Saves the learners input of the question to the database.
$_POST['username']
Definition: cron.php:12

References $_POST, $pass, and saveWorkingData().

+ Here is the call graph for this function:

◆ deleteAnswer()

assSingleChoice::deleteAnswer (   $index = 0)

Deletes an answer with a given index.

The index of the first answer is 0, the index of the second answer is 1 and so on.

Parameters
integer$indexA nonnegative index of the n-th answer @access public
See also
$answers

Definition at line 510 of file class.assSingleChoice.php.

511 {
512 if ($index < 0) return;
513 if (count($this->answers) < 1) return;
514 if ($index >= count($this->answers)) return;
515 $answer = $this->answers[$index];
516 if (strlen($answer->getImage())) $this->deleteImage($answer->getImage());
517 unset($this->answers[$index]);
518 $this->answers = array_values($this->answers);
519 for ($i = 0; $i < count($this->answers); $i++)
520 {
521 if ($this->answers[$i]->getOrder() > $index)
522 {
523 $this->answers[$i]->setOrder($i);
524 }
525 }
526 }
deleteImage($image_filename)
Deletes an image file.

References deleteImage().

+ Here is the call graph for this function:

◆ deleteImage()

assSingleChoice::deleteImage (   $image_filename)

Deletes an image file.

Parameters
string$image_filenameName of the image file to delete @access private

Definition at line 862 of file class.assSingleChoice.php.

863 {
864 $imagepath = $this->getImagePath();
865 @unlink($imagepath . $image_filename);
866 $thumbpath = $imagepath . $this->getThumbPrefix() . $image_filename;
867 @unlink($thumbpath);
868 }

References assQuestion\getImagePath(), and getThumbPrefix().

Referenced by deleteAnswer(), and removeAnswerImage().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ duplicate()

assSingleChoice::duplicate (   $for_test = true,
  $title = "",
  $author = "",
  $owner = "",
  $testObjId = null 
)

Duplicates an assSingleChoiceQuestion.

@access public

Reimplemented from assQuestion.

Definition at line 272 of file class.assSingleChoice.php.

273 {
274 if ($this->id <= 0)
275 {
276 // The question has not been saved. It cannot be duplicated
277 return;
278 }
279 // duplicate the question in database
280 $this_id = $this->getId();
281 $thisObjId = $this->getObjId();
282
283 $clone = $this;
284 include_once ("./Modules/TestQuestionPool/classes/class.assQuestion.php");
286 $clone->id = -1;
287
288 if( (int)$testObjId > 0 )
289 {
290 $clone->setObjId($testObjId);
291 }
292
293 if ($title)
294 {
295 $clone->setTitle($title);
296 }
297
298 if ($author)
299 {
300 $clone->setAuthor($author);
301 }
302 if ($owner)
303 {
304 $clone->setOwner($owner);
305 }
306 if ($for_test)
307 {
308 $clone->saveToDb($original_id);
309 }
310 else
311 {
312 $clone->saveToDb();
313 }
314
315 // copy question page content
316 $clone->copyPageOfQuestion($this_id);
317
318 // copy XHTML media objects
319 $clone->copyXHTMLMediaObjectsOfQuestion($this_id);
320 // duplicate the images
321 $clone->duplicateImages($this_id, $thisObjId);
322
323 $clone->onDuplicate($thisObjId, $this_id, $clone->getObjId(), $clone->getId());
324
325 return $clone->id;
326 }
getId()
Gets the id of the assQuestion object.

References assQuestion\$author, assQuestion\$original_id, assQuestion\$owner, assQuestion\$title, assQuestion\_getOriginalId(), assQuestion\getId(), and assQuestion\getObjId().

+ Here is the call graph for this function:

◆ duplicateImages()

assSingleChoice::duplicateImages (   $question_id,
  $objectId = null 
)

Definition at line 870 of file class.assSingleChoice.php.

871 {
872 global $ilLog;
873 $imagepath = $this->getImagePath();
874 $imagepath_original = str_replace("/$this->id/images", "/$question_id/images", $imagepath);
875
876 if( (int)$objectId > 0 )
877 {
878 $imagepath_original = str_replace("/$this->obj_id/", "/$objectId/", $imagepath_original);
879 }
880
881 foreach ($this->answers as $answer)
882 {
883 $filename = $answer->getImage();
884 if (strlen($filename))
885 {
886 if (!file_exists($imagepath))
887 {
888 ilUtil::makeDirParents($imagepath);
889 }
890 if (!@copy($imagepath_original . $filename, $imagepath . $filename))
891 {
892 $ilLog->write("image could not be duplicated!!!!", $ilLog->ERROR);
893 $ilLog->write("object: " . print_r($this, TRUE), $ilLog->ERROR);
894 }
895 if (@file_exists($imagepath_original. $this->getThumbPrefix(). $filename))
896 {
897 if (!@copy($imagepath_original . $this->getThumbPrefix() . $filename, $imagepath . $this->getThumbPrefix() . $filename))
898 {
899 $ilLog->write("image thumbnail could not be duplicated!!!!", $ilLog->ERROR);
900 $ilLog->write("object: " . print_r($this, TRUE), $ilLog->ERROR);
901 }
902 }
903 }
904 }
905 }

References $filename, $ilLog, assQuestion\getImagePath(), getThumbPrefix(), and ilUtil\makeDirParents().

+ Here is the call graph for this function:

◆ flushAnswers()

assSingleChoice::flushAnswers ( )

Deletes all answers.

@access public

See also
$answers

Definition at line 534 of file class.assSingleChoice.php.

535 {
536 $this->answers = array();
537 }

◆ generateThumbForFile()

assSingleChoice::generateThumbForFile (   $path,
  $file 
)
protected

Definition at line 172 of file class.assSingleChoice.php.

173 {
175 if (@file_exists($filename))
176 {
177 $thumbpath = $path . $this->getThumbPrefix() . $file;
178 $path_info = @pathinfo($filename);
179 $ext = "";
180 switch (strtoupper($path_info['extension']))
181 {
182 case 'PNG':
183 $ext = 'PNG';
184 break;
185 case 'GIF':
186 $ext = 'GIF';
187 break;
188 default:
189 $ext = 'JPEG';
190 break;
191 }
192 ilUtil::convertImage($filename, $thumbpath, $ext, $this->getThumbSize());
193 }
194 }
print $file
static convertImage($a_from, $a_to, $a_target_format="", $a_geometry="", $a_background_color="")
convert image
$path
Definition: index.php:22

References $file, $filename, $path, ilUtil\convertImage(), getThumbPrefix(), and getThumbSize().

Referenced by rebuildThumbnails(), and setImageFile().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getAdditionalTableName()

assSingleChoice::getAdditionalTableName ( )

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

Returns
string The additional table name @access public

Reimplemented from assQuestion.

Definition at line 794 of file class.assSingleChoice.php.

795 {
796 return "qpl_qst_sc";
797 }

Referenced by loadFromDb().

+ Here is the caller graph for this function:

◆ getAnswer()

assSingleChoice::getAnswer (   $index = 0)

Returns an answer with a given index.

The index of the first answer is 0, the index of the second answer is 1 and so on.

Parameters
integer$indexA nonnegative index of the n-th answer
Returns
object ASS_AnswerBinaryStateImage-Object containing the answer @access public
See also
$answers

Definition at line 493 of file class.assSingleChoice.php.

494 {
495 if ($index < 0) return NULL;
496 if (count($this->answers) < 1) return NULL;
497 if ($index >= count($this->answers)) return NULL;
498
499 return $this->answers[$index];
500 }

Referenced by getAvailableAnswerOptions().

+ Here is the caller graph for this function:

◆ getAnswerCount()

assSingleChoice::getAnswerCount ( )

Returns the number of answers.

Returns
integer The number of answers of the multiple choice question @access public
See also
$answers

Definition at line 479 of file class.assSingleChoice.php.

480 {
481 return count($this->answers);
482 }

◆ getAnswers()

& assSingleChoice::getAnswers ( )

Returns a reference to the answers array.

Definition at line 1001 of file class.assSingleChoice.php.

1002 {
1003 return $this->answers;
1004 }

References $answers.

Referenced by getAvailableAnswerOptions(), rebuildThumbnails(), setExportDetailsXLS(), and toJSON().

+ Here is the caller graph for this function:

◆ getAnswerTableName()

assSingleChoice::getAnswerTableName ( )

Returns the name of the answer table in the database.

Returns
string The answer table name @access public

Reimplemented from assQuestion.

Definition at line 805 of file class.assSingleChoice.php.

806 {
807 return "qpl_a_sc";
808 }

◆ getAvailableAnswerOptions()

assSingleChoice::getAvailableAnswerOptions (   $index = null)

If index is null, the function returns an array with all anwser options Else it returns the specific answer option.

Parameters
null | int$index
Returns
array|ASS_AnswerSimple

Implements iQuestionCondition.

Definition at line 1280 of file class.assSingleChoice.php.

1281 {
1282 if($index !== null)
1283 {
1284 return $this->getAnswer($index);
1285 }
1286 else
1287 {
1288 return $this->getAnswers();
1289 }
1290 }
& getAnswers()
Returns a reference to the answers array.
getAnswer($index=0)
Returns an answer with a given index.

References getAnswer(), and getAnswers().

+ Here is the call graph for this function:

◆ getExpressionTypes()

assSingleChoice::getExpressionTypes ( )

◆ getMaximumPoints()

assSingleChoice::getMaximumPoints ( )

Returns the maximum points, a learner can reach answering the question.

@access public

See also
$points

Reimplemented from assQuestion.

Definition at line 545 of file class.assSingleChoice.php.

546 {
547 $points = 0;
548 foreach ($this->answers as $key => $value)
549 {
550 if ($value->getPoints() > $points)
551 {
552 $points = $value->getPoints();
553 }
554 }
555 return $points;
556 }

References assQuestion\$points.

Referenced by isComplete().

+ Here is the caller graph for this function:

◆ getMultilineAnswerSetting()

assSingleChoice::getMultilineAnswerSetting ( )

Definition at line 1122 of file class.assSingleChoice.php.

1123 {
1124 global $ilUser;
1125
1126 $multilineAnswerSetting = $ilUser->getPref("tst_multiline_answers");
1127 if ($multilineAnswerSetting != 1)
1128 {
1129 $multilineAnswerSetting = 0;
1130 }
1131 return $multilineAnswerSetting;
1132 }
global $ilUser
Definition: imgupload.php:15

References $ilUser.

◆ getOperators()

assSingleChoice::getOperators (   $expression)

Get all available operations for a specific question.

Parameters
string$expression

Implements iQuestionCondition.

Definition at line 1215 of file class.assSingleChoice.php.

1216 {
1217 require_once "./Modules/TestQuestionPool/classes/class.ilOperatorsExpressionMapping.php";
1219 }

References ilOperatorsExpressionMapping\getOperatorsByExpression().

+ Here is the call graph for this function:

◆ getOutputType()

assSingleChoice::getOutputType ( )

Gets the single choice output type which is either OUTPUT_ORDER (=0) or OUTPUT_RANDOM (=1).

Returns
integer The output type of the assSingleChoice object @access public
See also
$output_type

Reimplemented from assQuestion.

Definition at line 408 of file class.assSingleChoice.php.

409 {
410 return $this->output_type;
411 }

References $output_type.

◆ getQuestionType()

assSingleChoice::getQuestionType ( )

Returns the question type of the question.

Returns
integer The question type of the question @access public

Reimplemented from assQuestion.

Definition at line 783 of file class.assSingleChoice.php.

784 {
785 return "assSingleChoice";
786 }

Referenced by toJSON().

+ Here is the caller graph for this function:

◆ getRTETextWithMediaObjects()

assSingleChoice::getRTETextWithMediaObjects ( )

Collects all text in the question which could contain media objects which were created with the Rich Text Editor.

Reimplemented from assQuestion.

Definition at line 986 of file class.assSingleChoice.php.

987 {
988 $text = parent::getRTETextWithMediaObjects();
989 foreach ($this->answers as $index => $answer)
990 {
991 $text .= $this->feedbackOBJ->getSpecificAnswerFeedbackContent($this->getId(), $index);
992 $answer_obj = $this->answers[$index];
993 $text .= $answer_obj->getAnswertext();
994 }
995 return $text;
996 }

References assQuestion\getId().

+ Here is the call graph for this function:

◆ getSpecificFeedbackSetting()

assSingleChoice::getSpecificFeedbackSetting ( )

Gets the current feedback settings in effect for the question.

Values are: 1 - Feedback is shown for all answer options. 2 - Feedback is shown for all checked/selected options. 3 - Feedback is shown for all correct options.

Returns
integer

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

1164 {
1165 if ($this->feedback_setting)
1166 {
1168 }
1169 else
1170 {
1171 return 1;
1172 }
1173 }

References $feedback_setting.

◆ getThumbPrefix()

assSingleChoice::getThumbPrefix ( )

Definition at line 167 of file class.assSingleChoice.php.

168 {
169 return "thumb.";
170 }

Referenced by copyImages(), deleteImage(), duplicateImages(), generateThumbForFile(), and syncImages().

+ Here is the caller graph for this function:

◆ getThumbSize()

assSingleChoice::getThumbSize ( )

Definition at line 1045 of file class.assSingleChoice.php.

1046 {
1047 return $this->thumb_size;
1048 }

References $thumb_size.

Referenced by generateThumbForFile(), rebuildThumbnails(), setImageFile(), and toJSON().

+ Here is the caller graph for this function:

◆ isAnswered()

assSingleChoice::isAnswered (   $active_id,
  $pass 
)

returns boolean wether the question is answered during test pass or not

(overwrites method in class assQuestion)

Parameters
integer$active_id
integer$pass
Returns
boolean $answered

Reimplemented from assQuestion.

Definition at line 1185 of file class.assSingleChoice.php.

1186 {
1187 $numExistingSolutionRecords = assQuestion::getNumExistingSolutionRecords($active_id, $pass, $this->getId());
1188
1189 return $numExistingSolutionRecords > 0;
1190 }
static getNumExistingSolutionRecords($activeId, $pass, $questionId)
returns the number of existing solution records for the given test active / pass and given question i...

References $pass, assQuestion\getId(), and assQuestion\getNumExistingSolutionRecords().

+ Here is the call graph for this function:

◆ isComplete()

assSingleChoice::isComplete ( )

Returns true, if a single choice question is complete for use.

Returns
boolean True, if the single choice question is complete for use, otherwise false @access public

Reimplemented from assQuestion.

Definition at line 97 of file class.assSingleChoice.php.

98 {
99 if (strlen($this->title) and ($this->author) and ($this->question) and (count($this->answers)) and ($this->getMaximumPoints() > 0))
100 {
101 foreach ($this->answers as $answer)
102 {
103 if ((strlen($answer->getAnswertext()) == 0) && (strlen($answer->getImage()) == 0)) return false;
104 }
105 return true;
106 }
107 else
108 {
109 return false;
110 }
111 }
getMaximumPoints()
Returns the maximum points, a learner can reach answering the question.

References getMaximumPoints().

+ Here is the call graph for this function:

◆ isObligationPossible()

static assSingleChoice::isObligationPossible (   $questionId)
static

returns boolean wether it is possible to set this question type as obligatory or not considering the current question configuration

(overwrites method in class assQuestion)

Parameters
integer$questionId
Returns
boolean $obligationPossible

Reimplemented from assQuestion.

Definition at line 1202 of file class.assSingleChoice.php.

1203 {
1204 return true;
1205 }

◆ loadFromDb()

assSingleChoice::loadFromDb (   $question_id)

Loads a assSingleChoice object from a database.

Parameters
object$dbA pear DB object
integer$question_idA unique key which defines the multiple choice test in the database @access public

Reimplemented from assQuestion.

Definition at line 203 of file class.assSingleChoice.php.

204 {
205 global $ilDB;
206
207 $hasimages = 0;
208
209 $result = $ilDB->queryF("SELECT qpl_questions.*, " . $this->getAdditionalTableName() . ".* FROM qpl_questions LEFT JOIN " . $this->getAdditionalTableName() . " ON " . $this->getAdditionalTableName() . ".question_fi = qpl_questions.question_id WHERE qpl_questions.question_id = %s",
210 array("integer"),
211 array($question_id)
212 );
213 if ($result->numRows() == 1)
214 {
215 $data = $ilDB->fetchAssoc($result);
216 $this->setId($question_id);
217 $this->setObjId($data["obj_fi"]);
218 $this->setTitle($data["title"]);
219 $this->setNrOfTries($data['nr_of_tries']);
220 $this->setComment($data["description"]);
221 $this->setOriginalId($data["original_id"]);
222 $this->setAuthor($data["author"]);
223 $this->setPoints($data["points"]);
224 $this->setOwner($data["owner"]);
225 include_once("./Services/RTE/classes/class.ilRTE.php");
226 $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc($data["question_text"], 1));
227 $shuffle = (is_null($data['shuffle'])) ? true : $data['shuffle'];
228 $this->setShuffle($shuffle);
229 $this->setEstimatedWorkingTime(substr($data["working_time"], 0, 2), substr($data["working_time"], 3, 2), substr($data["working_time"], 6, 2));
230 $this->setThumbSize($data['thumb_size']);
231 $this->isSingleline = ($data['allow_images']) ? false : true;
232 $this->lastChange = $data['tstamp'];
233 $this->feedback_setting = $data['feedback_setting'];
234
235 try
236 {
237 $this->setAdditionalContentEditingMode($data['add_cont_edit_mode']);
238 }
240 {
241 }
242 }
243
244 $result = $ilDB->queryF("SELECT * FROM qpl_a_sc WHERE question_fi = %s ORDER BY aorder ASC",
245 array('integer'),
246 array($question_id)
247 );
248 include_once "./Modules/TestQuestionPool/classes/class.assAnswerBinaryStateImage.php";
249 if ($result->numRows() > 0)
250 {
251 while ($data = $ilDB->fetchAssoc($result))
252 {
253 $imagefilename = $this->getImagePath() . $data["imagefile"];
254 if (!@file_exists($imagefilename))
255 {
256 $data["imagefile"] = "";
257 }
258 include_once("./Services/RTE/classes/class.ilRTE.php");
259 $data["answertext"] = ilRTE::_replaceMediaObjectImageSrc($data["answertext"], 1);
260 array_push($this->answers, new ASS_AnswerBinaryStateImage($data["answertext"], $data["points"], $data["aorder"], 1, $data["imagefile"]));
261 }
262 }
263
264 parent::loadFromDb($question_id);
265 }
setShuffle($shuffle=true)
Sets the shuffle flag.
setId($id=-1)
Sets the id of the assQuestion object.
setOriginalId($original_id)
setObjId($obj_id=0)
Set the object id of the container object.
setTitle($title="")
Sets the title string of the assQuestion object.
setOwner($owner="")
Sets the creator/owner ID of the assQuestion object.
setEstimatedWorkingTime($hour=0, $min=0, $sec=0)
Sets the estimated working time of a question from given hour, minute and second.
setAuthor($author="")
Sets the authors name of the assQuestion object.
setPoints($a_points)
Sets the maximum available points for the question.
setComment($comment="")
Sets the comment string of the assQuestion object.
setNrOfTries($a_nr_of_tries)
setAdditionalContentEditingMode($additinalContentEditingMode)
setter for additional content editing mode for this question
setQuestion($question="")
Sets the question string of the question object.
getAdditionalTableName()
Returns the name of the additional question data table in the database.
static _replaceMediaObjectImageSrc($a_text, $a_direction=0, $nic=IL_INST_ID)
replaces image source from mob image urls with the mob id or replaces mob id with the correct image s...

References $data, $ilDB, $result, assQuestion\$shuffle, ilRTE\_replaceMediaObjectImageSrc(), getAdditionalTableName(), assQuestion\getImagePath(), assQuestion\setAdditionalContentEditingMode(), assQuestion\setAuthor(), assQuestion\setComment(), assQuestion\setEstimatedWorkingTime(), assQuestion\setId(), assQuestion\setNrOfTries(), assQuestion\setObjId(), assQuestion\setOriginalId(), assQuestion\setOwner(), assQuestion\setPoints(), assQuestion\setQuestion(), assQuestion\setShuffle(), setThumbSize(), and assQuestion\setTitle().

+ Here is the call graph for this function:

◆ rebuildThumbnails()

assSingleChoice::rebuildThumbnails ( )
protected

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

154 {
155 if ($this->isSingleline && ($this->getThumbSize()))
156 {
157 foreach ($this->getAnswers() as $answer)
158 {
159 if (strlen($answer->getImage()))
160 {
161 $this->generateThumbForFile($this->getImagePath(), $answer->getImage());
162 }
163 }
164 }
165 }
generateThumbForFile($path, $file)

References generateThumbForFile(), getAnswers(), assQuestion\getImagePath(), and getThumbSize().

+ Here is the call graph for this function:

◆ removeAnswerImage()

assSingleChoice::removeAnswerImage (   $index)

Definition at line 1105 of file class.assSingleChoice.php.

1106 {
1107 $answer = $this->answers[$index];
1108 if (is_object($answer))
1109 {
1110 $this->deleteImage($answer->getImage());
1111 $answer->setImage('');
1112 }
1113 }

References deleteImage().

+ Here is the call graph for this function:

◆ reworkWorkingData()

assSingleChoice::reworkWorkingData (   $active_id,
  $pass,
  $obligationsAnswered 
)
protected

Reworks the allready saved working data if neccessary.

@access protected

Parameters
integer$active_id
integer$pass
boolean$obligationsAnswered

Reimplemented from assQuestion.

Definition at line 772 of file class.assSingleChoice.php.

773 {
774 // nothing to rework!
775 }

◆ savePreviewData()

assSingleChoice::savePreviewData ( ilAssQuestionPreviewSession  $previewSession)
protected

Reimplemented from assQuestion.

Definition at line 695 of file class.assSingleChoice.php.

696 {
697 if( strlen($_POST['multiple_choice_result'.$this->getId().'ID']) )
698 {
699 $previewSession->setParticipantsSolution($_POST['multiple_choice_result'.$this->getId().'ID']);
700 }
701 else
702 {
703 $previewSession->setParticipantsSolution(null);
704 }
705 }

References $_POST, assQuestion\getId(), and ilAssQuestionPreviewSession\setParticipantsSolution().

+ Here is the call graph for this function:

◆ saveWorkingData()

assSingleChoice::saveWorkingData (   $active_id,
  $pass = NULL 
)

Saves the learners input of the question to the database.

@access public

Parameters
integer$active_idActive id of the user
integer$passTest pass
Returns
boolean $status

Reimplemented from assQuestion.

Definition at line 626 of file class.assSingleChoice.php.

627 {
628 global $ilDB;
629 global $ilUser;
630
631 if (is_null($pass))
632 {
633 include_once "./Modules/Test/classes/class.ilObjTest.php";
634 $pass = ilObjTest::_getPass($active_id);
635 }
636 $entered_values = 0;
637
638 $this->getProcessLocker()->requestUserSolutionUpdateLock();
639
640 $result = $this->getCurrentSolutionResultSet($active_id, $pass);
641 $row = $ilDB->fetchAssoc($result);
642 $update = $row["solution_id"];
643
644 if ($update)
645 {
646 if (strlen($_POST["multiple_choice_result"]))
647 {
648 $affectedRows = $ilDB->update("tst_solutions", array(
649 "value1" => array("clob", $_POST["multiple_choice_result"]),
650 "tstamp" => array("integer", time())
651 ), array(
652 "solution_id" => array("integer", $update)
653 ));
654 $entered_values++;
655 }
656 else
657 {
658 $affectedRows = $ilDB->manipulateF("DELETE FROM tst_solutions WHERE solution_id = %s",
659 array('integer'),
660 array($update)
661 );
662 }
663 }
664 else
665 {
666 if (strlen($_POST["multiple_choice_result"]))
667 {
668 $affectedRows = $this->saveCurrentSolution($active_id, $pass, $_POST['multiple_choice_result'], null);
669 $entered_values++;
670 }
671 }
672
673 $this->getProcessLocker()->releaseUserSolutionUpdateLock();
674
675 if ($entered_values)
676 {
677 include_once ("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
679 {
680 $this->logAction($this->lng->txtlng("assessment", "log_user_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
681 }
682 }
683 else
684 {
685 include_once ("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
687 {
688 $this->logAction($this->lng->txtlng("assessment", "log_user_not_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
689 }
690 }
691
692 return true;
693 }
logAction($logtext="", $active_id="", $question_id="")
Logs an action into the Test&Assessment log.
_getLogLanguage()
retrieve the log language for assessment logging
_enabledAssessmentLogging()
check wether assessment logging is enabled or not
_getPass($active_id)
Retrieves the actual pass of a given user for a given test.

References $_POST, $ilDB, $ilUser, $pass, $result, $row, ilObjAssessmentFolder\_enabledAssessmentLogging(), ilObjAssessmentFolder\_getLogLanguage(), ilObjTest\_getPass(), assQuestion\getProcessLocker(), and assQuestion\logAction().

Referenced by createRandomSolution().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setExportDetailsXLS()

assSingleChoice::setExportDetailsXLS ( $worksheet,
  $startrow,
  $active_id,
  $pass,
$format_title,
$format_bold 
)

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

Parameters
object$worksheetReference to the parent excel worksheet
object$startrowStartrow of the output in the excel worksheet
object$active_idActive id of the participant
object$passTest pass
object$format_titleExcel title format
object$format_boldExcel bold format
array$eval_dataCumulated evaluation data @access public

Reimplemented from assQuestion.

Definition at line 1018 of file class.assSingleChoice.php.

1019 {
1020 include_once ("./Services/Excel/classes/class.ilExcelUtils.php");
1021 $solution = $this->getSolutionValues($active_id, $pass);
1022 $worksheet->writeString($startrow, 0, ilExcelUtils::_convert_text($this->lng->txt($this->getQuestionType())), $format_title);
1023 $worksheet->writeString($startrow, 1, ilExcelUtils::_convert_text($this->getTitle()), $format_title);
1024 $i = 1;
1025 foreach ($this->getAnswers() as $id => $answer)
1026 {
1027 $worksheet->writeString($startrow + $i, 0, ilExcelUtils::_convert_text($answer->getAnswertext()), $format_bold);
1028 if(
1029 count($solution) > 0 &&
1030 isset($solution[0]) &&
1031 is_array($solution[0]) &&
1032 strlen($solution[0]['value1']) > 0 && $id == $solution[0]['value1'])
1033 {
1034 $worksheet->write($startrow + $i, 1, 1);
1035 }
1036 else
1037 {
1038 $worksheet->write($startrow + $i, 1, 0);
1039 }
1040 $i++;
1041 }
1042 return $startrow + $i + 1;
1043 }
& getSolutionValues($active_id, $pass=NULL)
Loads solutions of a given user from the database an returns it.
getTitle()
Gets the title string of the assQuestion object.
_convert_text($a_text, $a_target="has been removed")

References assQuestion\$id, $pass, ilExcelUtils\_convert_text(), getAnswers(), assQuestion\getSolutionValues(), and assQuestion\getTitle().

+ Here is the call graph for this function:

◆ setImageFile()

assSingleChoice::setImageFile (   $image_filename,
  $image_tempfilename = "" 
)

Sets the image file and uploads the image to the object's image directory.

Parameters
string$image_filenameName of the original image file
string$image_tempfilenameName of the temporary uploaded image file
Returns
integer An errorcode if the image upload fails, 0 otherwise @access public

Definition at line 818 of file class.assSingleChoice.php.

819 {
820 $result = 0;
821 if (!empty($image_tempfilename))
822 {
823 $image_filename = str_replace(" ", "_", $image_filename);
824 $imagepath = $this->getImagePath();
825 if (!file_exists($imagepath))
826 {
827 ilUtil::makeDirParents($imagepath);
828 }
829 //if (!move_uploaded_file($image_tempfilename, $imagepath . $image_filename))
830 if (!ilUtil::moveUploadedFile($image_tempfilename, $image_filename, $imagepath.$image_filename))
831 {
832 $result = 2;
833 }
834 else
835 {
836 include_once "./Services/MediaObjects/classes/class.ilObjMediaObject.php";
837 $mimetype = ilObjMediaObject::getMimeType($imagepath . $image_filename);
838 if (!preg_match("/^image/", $mimetype))
839 {
840 unlink($imagepath . $image_filename);
841 $result = 1;
842 }
843 else
844 {
845 // create thumbnail file
846 if ($this->isSingleline && ($this->getThumbSize()))
847 {
848 $this->generateThumbForFile($imagepath, $image_filename);
849 }
850 }
851 }
852 }
853 return $result;
854 }
static getMimeType($a_file)
get mime type for file
static moveUploadedFile($a_file, $a_name, $a_target, $a_raise_errors=true, $a_mode="move_uploaded")
move uploaded file

References $result, generateThumbForFile(), assQuestion\getImagePath(), ilObjMediaObject\getMimeType(), getThumbSize(), ilUtil\makeDirParents(), and ilUtil\moveUploadedFile().

+ Here is the call graph for this function:

◆ setMultilineAnswerSetting()

assSingleChoice::setMultilineAnswerSetting (   $a_setting = 0)

Definition at line 1134 of file class.assSingleChoice.php.

1135 {
1136 global $ilUser;
1137 $ilUser->writePref("tst_multiline_answers", $a_setting);
1138 }

References $ilUser.

◆ setOutputType()

assSingleChoice::setOutputType (   $output_type = OUTPUT_ORDER)

Sets the output type of the assSingleChoice object.

Parameters
integer$output_typeA nonnegative integer value specifying the output type. It is OUTPUT_ORDER (=0) or OUTPUT_RANDOM (=1). @access public
See also
$response

Reimplemented from assQuestion.

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

421 {
422 $this->output_type = $output_type;
423 }

References $output_type.

◆ setSpecificFeedbackSetting()

assSingleChoice::setSpecificFeedbackSetting (   $a_feedback_setting)

Sets the feedback settings in effect for the question.

Options are: 1 - Feedback is shown for all answer options. 2 - Feedback is shown for all checked/selected options. 3 - Feedback is shown for all correct options.

Parameters
integer$a_feedback_setting

Definition at line 1149 of file class.assSingleChoice.php.

1150 {
1151 $this->feedback_setting = $a_feedback_setting;
1152 }

◆ setThumbSize()

assSingleChoice::setThumbSize (   $a_size)

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

1051 {
1052 $this->thumb_size = $a_size;
1053 }

Referenced by loadFromDb().

+ Here is the caller graph for this function:

◆ syncImages()

assSingleChoice::syncImages ( )
protected

Sync images of a MC question on synchronisation with the original question.

Definition at line 942 of file class.assSingleChoice.php.

943 {
944 global $ilLog;
945 $question_id = $this->getOriginalId();
946 $imagepath = $this->getImagePath();
947 $imagepath_original = str_replace("/$this->id/images", "/$question_id/images", $imagepath);
948 ilUtil::delDir($imagepath_original);
949 foreach ($this->answers as $answer)
950 {
951 $filename = $answer->getImage();
952 if (strlen($filename))
953 {
954 if (@file_exists($imagepath . $filename))
955 {
956 if (!file_exists($imagepath))
957 {
958 ilUtil::makeDirParents($imagepath);
959 }
960 if (!file_exists($imagepath_original))
961 {
962 ilUtil::makeDirParents($imagepath_original);
963 }
964 if (!@copy($imagepath . $filename, $imagepath_original . $filename))
965 {
966 $ilLog->write("image could not be duplicated!!!!", $ilLog->ERROR);
967 $ilLog->write("object: " . print_r($this, TRUE), $ilLog->ERROR);
968 }
969 }
970 if (@file_exists($imagepath . $this->getThumbPrefix() . $filename))
971 {
972 if (!@copy($imagepath . $this->getThumbPrefix() . $filename, $imagepath_original . $this->getThumbPrefix() . $filename))
973 {
974 $ilLog->write("image thumbnail could not be duplicated!!!!", $ilLog->ERROR);
975 $ilLog->write("object: " . print_r($this, TRUE), $ilLog->ERROR);
976 }
977 }
978 }
979 }
980 }

References $filename, $ilLog, ilUtil\delDir(), assQuestion\getImagePath(), assQuestion\getOriginalId(), getThumbPrefix(), and ilUtil\makeDirParents().

+ Here is the call graph for this function:

◆ toJSON()

assSingleChoice::toJSON ( )

Returns a JSON representation of the question.

Reimplemented from assQuestion.

Definition at line 1058 of file class.assSingleChoice.php.

1059 {
1060 include_once("./Services/RTE/classes/class.ilRTE.php");
1061 $result = array();
1062 $result['id'] = (int) $this->getId();
1063 $result['type'] = (string) $this->getQuestionType();
1064 $reilUtilsult['title'] = (string) $this->getTitle();
1065 $result['question'] = $this->formatSAQuestion($this->getQuestion());
1066 $result['nr_of_tries'] = (int) $this->getNrOfTries();
1067 $result['shuffle'] = (bool) $this->getShuffle();
1068
1069 $result['feedback'] = array(
1070 'onenotcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), false)),
1071 'allcorrect' => $this->formatSAQuestion($this->feedbackOBJ->getGenericFeedbackTestPresentation($this->getId(), true))
1072 );
1073
1074 $answers = array();
1075 $has_image = false;
1076 foreach ($this->getAnswers() as $key => $answer_obj)
1077 {
1078 if((string) $answer_obj->getImage())
1079 {
1080 $has_image = true;
1081 }
1082 array_push($answers, array(
1083 "answertext" => (string) $this->formatSAQuestion($answer_obj->getAnswertext()),
1084 "points" => (float)$answer_obj->getPoints(),
1085 "order" => (int)$answer_obj->getOrder(),
1086 "image" => (string) $answer_obj->getImage(),
1087 "feedback" => $this->formatSAQuestion(
1088 $this->feedbackOBJ->getSpecificAnswerFeedbackExportPresentation($this->getId(), $key)
1089 )
1090 ));
1091 }
1092 $result['answers'] = $answers;
1093 if($has_image)
1094 {
1095 $result['path'] = $this->getImagePathWeb();
1096 $result['thumb'] = $this->getThumbSize();
1097 }
1098
1099 $mobs = ilObjMediaObject::_getMobsOfObject("qpl:html", $this->getId());
1100 $result['mobs'] = $mobs;
1101
1102 return json_encode($result);
1103 }
formatSAQuestion($a_q)
Format self assessment question.
getShuffle()
Gets the shuffle flag.
getQuestion()
Gets the question string of the question object.
getImagePathWeb()
Returns the web image path for web accessable images of a question.
getQuestionType()
Returns the question type of the question.
_getMobsOfObject($a_type, $a_id, $a_usage_hist_nr=0, $a_lang="-")
get mobs of object
$mobs

References $answers, $mobs, $result, ilObjMediaObject\_getMobsOfObject(), assQuestion\formatSAQuestion(), getAnswers(), assQuestion\getId(), assQuestion\getImagePathWeb(), assQuestion\getNrOfTries(), assQuestion\getQuestion(), getQuestionType(), assQuestion\getShuffle(), getThumbSize(), and assQuestion\getTitle().

+ Here is the call graph for this function:

Field Documentation

◆ $answers

assSingleChoice::$answers

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

Referenced by getAnswers(), and toJSON().

◆ $feedback_setting

assSingleChoice::$feedback_setting
protected

Definition at line 58 of file class.assSingleChoice.php.

Referenced by getSpecificFeedbackSetting().

◆ $output_type

assSingleChoice::$output_type

Definition at line 43 of file class.assSingleChoice.php.

Referenced by __construct(), getOutputType(), and setOutputType().

◆ $thumb_size

assSingleChoice::$thumb_size
protected

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

Referenced by getThumbSize().


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