* @author Yannick Warnier * @package chamilo.exercise */ /** * Code */ if ( count( get_included_files() ) == 1 ) die( '---' ); require dirname(__FILE__) . '/qti2_classes.php'; /** * Classes */ /** * An IMS/QTI item. It corresponds to a single question. * This class allows export from Claroline to IMS/QTI2.0 XML format of a single question. * It is not usable as-is, but must be subclassed, to support different kinds of questions. * * Every start_*() and corresponding end_*(), as well as export_*() methods return a string. * * note: Attached files are NOT exported. * @package chamilo.exercise */ class ImsAssessmentItem { var $question; var $question_ident; var $answer; /** * Constructor. * * @param $question The Question object we want to export. */ function ImsAssessmentItem($question) { $this->question = $question; //$this->answer = new Answer($question->id); $this->answer = $this->question->setAnswer(); $this->questionIdent = "QST_" . $question->id ; } /** * Start the XML flow. * * This opens the block, with correct attributes. * */ function start_item() { /* return ''."\n"; */ $string = ''."\n"; return $string; } /** * End the XML flow, closing the tag. * */ function end_item() { return "\n"; } /** * Start the itemBody * */ function start_item_body() { return ' ' . "\n"; } /** * End the itemBody part. * */ function end_item_body() { return " \n"; } /** * add the response processing template used. * */ function add_response_processing() { //return ' ' . "\n"; return ' ' . "\n"; } /** * Export the question as an IMS/QTI Item. * * This is a default behaviour, some classes may want to override this. * * @param $standalone: Boolean stating if it should be exported as a stand-alone question * @return A string, the XML flow for an Item. */ function export($standalone = false) { global $charset; $head = $foot = ""; if( $standalone ) { $head = '' . "\n"; } //TODO understand why answer might be a non-object sometimes if (!is_object($this->answer)) { return $head; } $res = $head . $this->start_item() .$this->answer->imsExportResponsesDeclaration($this->questionIdent) . $this->start_item_body() . $this->answer->imsExportResponses($this->questionIdent, $this->question->question, $this->question->description, $this->question->picture) . $this->end_item_body() . $this->add_response_processing() . $this->end_item() . $foot; return $res; } } /** * This class represents an entire exercise to be exported in IMS/QTI. * It will be represented by a single
containing several . * * Some properties cannot be exported, as IMS does not support them : * - type (one page or multiple pages) * - start_date and end_date * - max_attempts * - show_answer * - anonymous_attempts * * @author Amand Tihon * @package chamilo.exercise */ class ImsSection { var $exercise; /** * Constructor. * @param $exe The Exercise instance to export * @author Amand Tihon */ function ImsSection($exe) { $this->exercise = $exe; } function start_section() { $out = '
' . "\n"; return $out; } function end_section() { return "
\n"; } function export_duration() { if ($max_time = $this->exercise->selectTimeLimit()) { // return exercise duration in ISO8601 format. $minutes = floor($max_time / 60); $seconds = $max_time % 60; return 'PT' . $minutes . 'M' . $seconds . "S\n"; } else { return ''; } } /** * Export the presentation (Exercise's description) * @author Amand Tihon */ function export_presentation() { $out = "\n" . " exercise->selectDescription() . "]]>\n" . "\n"; return $out; } /** * Export the ordering information. * Either sequential, through all questions, or random, with a selected number of questions. * @author Amand Tihon */ function export_ordering() { $out = ''; if ($n = $this->exercise->getShuffle()) { $out.= "" . " \n" . " " . $n . "\n" . " \n" . ' ' . "\n\n"; } else { $out.= '' . "\n" . " \n" . "\n"; } return $out; } /** * Export the questions, as a succession of * @author Amand Tihon */ function export_questions() { $out = ""; foreach ($this->exercise->selectQuestionList() as $q) { $out .= export_question($q, false); } return $out; } /** * Export the exercise in IMS/QTI. * * @param bool $standalone Wether it should include XML tag and DTD line. * @return a string containing the XML flow * @author Amand Tihon */ function export($standalone) { global $charset; $head = $foot = ""; if ($standalone) { $head = '' . "\n" . '' . "\n" . "\n"; $foot = "\n"; } $out = $head . $this->start_section() . $this->export_duration() . $this->export_presentation() . $this->export_ordering() . $this->export_questions() . $this->end_section() . $foot; return $out; } } /* Some quick notes on identifiers generation. The IMS format requires some blocks, like items, responses, feedbacks, to be uniquely identified. The unicity is mandatory in a single XML, of course, but it's prefered that the identifier stays coherent for an entire site. Here's the method used to generate those identifiers. Question identifier :: "QST_" + + "_" + Response identifier :: + "_A_" + Condition identifier :: + "_C_" + Feedback identifier :: + "_F_" + */ /** * An IMS/QTI item. It corresponds to a single question. * This class allows export from Claroline to IMS/QTI XML format. * It is not usable as-is, but must be subclassed, to support different kinds of questions. * * Every start_*() and corresponding end_*(), as well as export_*() methods return a string. * * warning: Attached files are NOT exported. * @author Amand Tihon * @package chamilo.exercise */ class ImsItem { var $question; var $question_ident; var $answer; /** * Constructor. * * @param $question The Question object we want to export. * @author Anamd Tihon */ function ImsItem($question) { $this->question = $question; $this->answer = $question->answer; $this->questionIdent = "QST_" . $question->selectId() ; } /** * Start the XML flow. * * This opens the block, with correct attributes. * * @author Amand Tihon */ function start_item() { return '' . "\n"; } /** * End the XML flow, closing the tag. * * @author Amand Tihon */ function end_item() { return "\n"; } /** * Create the opening, with the question itself. * * This means it opens the but doesn't close it, as this is the role of end_presentation(). * Inbetween, the export_responses from the subclass should have been called. * * @author Amand Tihon */ function start_presentation() { return '' . "\n" . 'question->selectDescription() . "]]>\n"; } /** * End the part, opened by export_header. * * @author Amand Tihon */ function end_presentation() { return "\n"; } /** * Start the response processing, and declare the default variable, SCORE, at 0 in the outcomes. * * @author Amand Tihon */ function start_processing() { return '' . "\n"; } /** * End the response processing part. * * @author Amand Tihon */ function end_processing() { return "\n"; } /** * Export the question as an IMS/QTI Item. * * This is a default behaviour, some classes may want to override this. * * @param $standalone: Boolean stating if it should be exported as a stand-alone question * @return A string, the XML flow for an Item. * @author Amand Tihon */ function export($standalone = False) { global $charset; $head = $foot = ""; if( $standalone ) { $head = '' . "\n" . '' . "\n" . "\n"; $foot = "\n"; } return $head . $this->start_item() . $this->start_presentation() . $this->answer->imsExportResponses($this->questionIdent) . $this->end_presentation() . $this->start_processing() . $this->answer->imsExportProcessing($this->questionIdent) . $this->end_processing() . $this->answer->imsExportFeedback($this->questionIdent) . $this->end_item() . $foot; } } /*-------------------------------------------------------- Functions --------------------------------------------------------*/ /** * Send a complete exercise in IMS/QTI format, from its ID * * @param int $exerciseId The exercise to exporte * @param boolean $standalone Wether it should include XML tag and DTD line. * @return The XML as a string, or an empty string if there's no exercise with given ID. */ function export_exercise($exerciseId, $standalone=true) { $exercise = new Exercise(); if (! $exercise->read($exerciseId)) { return ''; } $ims = new ImsSection($exercise); $xml = $ims->export($standalone); return $xml; } /** * Returns the XML flow corresponding to one question * * @param int The question ID * @param bool standalone (ie including XML tag, DTD declaration, etc) */ function export_question($questionId, $standalone=true) { $question = new Ims2Question(); $qst = $question->read($questionId); if( !$qst or $qst->type == FREE_ANSWER) { return ''; } $question->id = $qst->id; $question->type = $qst->type; $question->question = $qst->question; $question->description = $qst->description; $question->weighting=$qst->weighting; $question->position=$qst->position; $question->picture=$qst->picture; $ims = new ImsAssessmentItem($question); return $ims->export($standalone); }