[Summary view] [Print] [Text view]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * Essay question renderer class.
  19   *
  20   * @package    qtype
  21   * @subpackage essay
  22   * @copyright  2009 The Open University
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  
  30  /**
  31   * Generates the output for essay questions.
  32   *
  33   * @copyright  2009 The Open University
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class qtype_essay_renderer extends qtype_renderer {
  37      public function formulation_and_controls(question_attempt $qa,
  38              question_display_options $options) {
  39  
  40          $question = $qa->get_question();
  41          $responseoutput = $question->get_format_renderer($this->page);
  42  
  43          // Answer field.
  44          $step = $qa->get_last_step_with_qt_var('answer');
  45  
  46          if (!$step->has_qt_var('answer') && empty($options->readonly)) {
  47              // Question has never been answered, fill it with response template.
  48              $step = new question_attempt_step(array('answer'=>$question->responsetemplate));
  49          }
  50  
  51          if (empty($options->readonly)) {
  52              $answer = $responseoutput->response_area_input('answer', $qa,
  53                      $step, $question->responsefieldlines, $options->context);
  54  
  55          } else {
  56              $answer = $responseoutput->response_area_read_only('answer', $qa,
  57                      $step, $question->responsefieldlines, $options->context);
  58          }
  59  
  60          $files = '';
  61          if ($question->attachments) {
  62              if (empty($options->readonly)) {
  63                  $files = $this->files_input($qa, $question->attachments, $options);
  64  
  65              } else {
  66                  $files = $this->files_read_only($qa, $options);
  67              }
  68          }
  69  
  70          $result = '';
  71          $result .= html_writer::tag('div', $question->format_questiontext($qa),
  72                  array('class' => 'qtext'));
  73  
  74          $result .= html_writer::start_tag('div', array('class' => 'ablock'));
  75          $result .= html_writer::tag('div', $answer, array('class' => 'answer'));
  76          $result .= html_writer::tag('div', $files, array('class' => 'attachments'));
  77          $result .= html_writer::end_tag('div');
  78  
  79          return $result;
  80      }
  81  
  82      /**
  83       * Displays any attached files when the question is in read-only mode.
  84       * @param question_attempt $qa the question attempt to display.
  85       * @param question_display_options $options controls what should and should
  86       *      not be displayed. Used to get the context.
  87       */
  88      public function files_read_only(question_attempt $qa, question_display_options $options) {
  89          $files = $qa->get_last_qt_files('attachments', $options->context->id);
  90          $output = array();
  91  
  92          foreach ($files as $file) {
  93              $output[] = html_writer::tag('p', html_writer::link($qa->get_response_file_url($file),
  94                      $this->output->pix_icon(file_file_icon($file), get_mimetype_description($file),
  95                      'moodle', array('class' => 'icon')) . ' ' . s($file->get_filename())));
  96          }
  97          return implode($output);
  98      }
  99  
 100      /**
 101       * Displays the input control for when the student should upload a single file.
 102       * @param question_attempt $qa the question attempt to display.
 103       * @param int $numallowed the maximum number of attachments allowed. -1 = unlimited.
 104       * @param question_display_options $options controls what should and should
 105       *      not be displayed. Used to get the context.
 106       */
 107      public function files_input(question_attempt $qa, $numallowed,
 108              question_display_options $options) {
 109          global $CFG;
 110          require_once($CFG->dirroot . '/lib/form/filemanager.php');
 111  
 112          $pickeroptions = new stdClass();
 113          $pickeroptions->mainfile = null;
 114          $pickeroptions->maxfiles = $numallowed;
 115          $pickeroptions->itemid = $qa->prepare_response_files_draft_itemid(
 116                  'attachments', $options->context->id);
 117          $pickeroptions->context = $options->context;
 118          $pickeroptions->return_types = FILE_INTERNAL;
 119  
 120          $pickeroptions->itemid = $qa->prepare_response_files_draft_itemid(
 121                  'attachments', $options->context->id);
 122  
 123          $fm = new form_filemanager($pickeroptions);
 124          $filesrenderer = $this->page->get_renderer('core', 'files');
 125          return $filesrenderer->render($fm). html_writer::empty_tag(
 126                  'input', array('type' => 'hidden', 'name' => $qa->get_qt_field_name('attachments'),
 127                  'value' => $pickeroptions->itemid));
 128      }
 129  
 130      public function manual_comment(question_attempt $qa, question_display_options $options) {
 131          if ($options->manualcomment != question_display_options::EDITABLE) {
 132              return '';
 133          }
 134  
 135          $question = $qa->get_question();
 136          return html_writer::nonempty_tag('div', $question->format_text(
 137                  $question->graderinfo, $question->graderinfo, $qa, 'qtype_essay',
 138                  'graderinfo', $question->id), array('class' => 'graderinfo'));
 139      }
 140  }
 141  
 142  
 143  /**
 144   * A base class to abstract out the differences between different type of
 145   * response format.
 146   *
 147   * @copyright  2011 The Open University
 148   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 149   */
 150  abstract class qtype_essay_format_renderer_base extends plugin_renderer_base {
 151      /**
 152       * Render the students respone when the question is in read-only mode.
 153       * @param string $name the variable name this input edits.
 154       * @param question_attempt $qa the question attempt being display.
 155       * @param question_attempt_step $step the current step.
 156       * @param int $lines approximate size of input box to display.
 157       * @param object $context the context teh output belongs to.
 158       * @return string html to display the response.
 159       */
 160      public abstract function response_area_read_only($name, question_attempt $qa,
 161              question_attempt_step $step, $lines, $context);
 162  
 163      /**
 164       * Render the students respone when the question is in read-only mode.
 165       * @param string $name the variable name this input edits.
 166       * @param question_attempt $qa the question attempt being display.
 167       * @param question_attempt_step $step the current step.
 168       * @param int $lines approximate size of input box to display.
 169       * @param object $context the context teh output belongs to.
 170       * @return string html to display the response for editing.
 171       */
 172      public abstract function response_area_input($name, question_attempt $qa,
 173              question_attempt_step $step, $lines, $context);
 174  
 175      /**
 176       * @return string specific class name to add to the input element.
 177       */
 178      protected abstract function class_name();
 179  }
 180  
 181  /**
 182   * An essay format renderer for essays where the student should not enter
 183   * any inline response.
 184   *
 185   * @copyright  2013 Binghamton University
 186   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 187   */
 188  class qtype_essay_format_noinline_renderer extends plugin_renderer_base {
 189  
 190      protected function class_name() {
 191          return 'qtype_essay_noinline';
 192      }
 193  
 194      public function response_area_read_only($name, $qa, $step, $lines, $context) {
 195          return '';
 196      }
 197  
 198      public function response_area_input($name, $qa, $step, $lines, $context) {
 199          return '';
 200      }
 201  
 202  }
 203  
 204  /**
 205   * An essay format renderer for essays where the student should use the HTML
 206   * editor without the file picker.
 207   *
 208   * @copyright  2011 The Open University
 209   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 210   */
 211  class qtype_essay_format_editor_renderer extends plugin_renderer_base {
 212      protected function class_name() {
 213          return 'qtype_essay_editor';
 214      }
 215  
 216      public function response_area_read_only($name, $qa, $step, $lines, $context) {
 217          return html_writer::tag('div', $this->prepare_response($name, $qa, $step, $context),
 218                  array('class' => $this->class_name() . ' qtype_essay_response readonly'));
 219      }
 220  
 221      public function response_area_input($name, $qa, $step, $lines, $context) {
 222          global $CFG;
 223          require_once($CFG->dirroot . '/repository/lib.php');
 224  
 225          $inputname = $qa->get_qt_field_name($name);
 226          $responseformat = $step->get_qt_var($name . 'format');
 227          $id = $inputname . '_id';
 228  
 229          $editor = editors_get_preferred_editor($responseformat);
 230          $strformats = format_text_menu();
 231          $formats = $editor->get_supported_formats();
 232          foreach ($formats as $fid) {
 233              $formats[$fid] = $strformats[$fid];
 234          }
 235  
 236          list($draftitemid, $response) = $this->prepare_response_for_editing(
 237                  $name, $step, $context);
 238  
 239          $editor->use_editor($id, $this->get_editor_options($context),
 240                  $this->get_filepicker_options($context, $draftitemid));
 241  
 242          $output = '';
 243          $output .= html_writer::start_tag('div', array('class' =>
 244                  $this->class_name() . ' qtype_essay_response'));
 245  
 246          $output .= html_writer::tag('div', html_writer::tag('textarea', s($response),
 247                  array('id' => $id, 'name' => $inputname, 'rows' => $lines, 'cols' => 60)));
 248  
 249          $output .= html_writer::start_tag('div');
 250          if (count($formats) == 1) {
 251              reset($formats);
 252              $output .= html_writer::empty_tag('input', array('type' => 'hidden',
 253                      'name' => $inputname . 'format', 'value' => key($formats)));
 254  
 255          } else {
 256              $output .= html_writer::label(get_string('format'), 'menu' . $inputname . 'format', false);
 257              $output .= ' ';
 258              $output .= html_writer::select($formats, $inputname . 'format', $responseformat, '');
 259          }
 260          $output .= html_writer::end_tag('div');
 261  
 262          $output .= $this->filepicker_html($inputname, $draftitemid);
 263  
 264          $output .= html_writer::end_tag('div');
 265          return $output;
 266      }
 267  
 268      /**
 269       * Prepare the response for read-only display.
 270       * @param string $name the variable name this input edits.
 271       * @param question_attempt $qa the question attempt being display.
 272       * @param question_attempt_step $step the current step.
 273       * @param object $context the context the attempt belongs to.
 274       * @return string the response prepared for display.
 275       */
 276      protected function prepare_response($name, question_attempt $qa,
 277              question_attempt_step $step, $context) {
 278          if (!$step->has_qt_var($name)) {
 279              return '';
 280          }
 281  
 282          $formatoptions = new stdClass();
 283          $formatoptions->para = false;
 284          return format_text($step->get_qt_var($name), $step->get_qt_var($name . 'format'),
 285                  $formatoptions);
 286      }
 287  
 288      /**
 289       * Prepare the response for editing.
 290       * @param string $name the variable name this input edits.
 291       * @param question_attempt_step $step the current step.
 292       * @param object $context the context the attempt belongs to.
 293       * @return string the response prepared for display.
 294       */
 295      protected function prepare_response_for_editing($name,
 296              question_attempt_step $step, $context) {
 297          return array(0, $step->get_qt_var($name));
 298      }
 299  
 300      /**
 301       * @param object $context the context the attempt belongs to.
 302       * @return array options for the editor.
 303       */
 304      protected function get_editor_options($context) {
 305          // Disable the text-editor autosave because quiz has it's own auto save function.
 306          return array('context' => $context, 'autosave' => false);
 307      }
 308  
 309      /**
 310       * @param object $context the context the attempt belongs to.
 311       * @param int $draftitemid draft item id.
 312       * @return array filepicker options for the editor.
 313       */
 314      protected function get_filepicker_options($context, $draftitemid) {
 315          return array('return_types'  => FILE_INTERNAL | FILE_EXTERNAL);
 316      }
 317  
 318      /**
 319       * @param string $inputname input field name.
 320       * @param int $draftitemid draft file area itemid.
 321       * @return string HTML for the filepicker, if used.
 322       */
 323      protected function filepicker_html($inputname, $draftitemid) {
 324          return '';
 325      }
 326  }
 327  
 328  
 329  /**
 330   * An essay format renderer for essays where the student should use the HTML
 331   * editor with the file picker.
 332   *
 333   * @copyright  2011 The Open University
 334   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 335   */
 336  class qtype_essay_format_editorfilepicker_renderer extends qtype_essay_format_editor_renderer {
 337      protected function class_name() {
 338          return 'qtype_essay_editorfilepicker';
 339      }
 340  
 341      protected function prepare_response($name, question_attempt $qa,
 342              question_attempt_step $step, $context) {
 343          if (!$step->has_qt_var($name)) {
 344              return '';
 345          }
 346  
 347          $formatoptions = new stdClass();
 348          $formatoptions->para = false;
 349          $text = $qa->rewrite_response_pluginfile_urls($step->get_qt_var($name),
 350                  $context->id, 'answer', $step);
 351          return format_text($text, $step->get_qt_var($name . 'format'), $formatoptions);
 352      }
 353  
 354      protected function prepare_response_for_editing($name,
 355              question_attempt_step $step, $context) {
 356          return $step->prepare_response_files_draft_itemid_with_text(
 357                  $name, $context->id, $step->get_qt_var($name));
 358      }
 359  
 360      protected function get_editor_options($context) {
 361          // Disable the text-editor autosave because quiz has it's own auto save function.
 362          return array(
 363              'subdirs' => 0,
 364              'maxbytes' => 0,
 365              'maxfiles' => -1,
 366              'context' => $context,
 367              'noclean' => 0,
 368              'trusttext'=> 0,
 369              'autosave' => false
 370          );
 371      }
 372  
 373      /**
 374       * Get the options required to configure the filepicker for one of the editor
 375       * toolbar buttons.
 376       * @param mixed $acceptedtypes array of types of '*'.
 377       * @param int $draftitemid the draft area item id.
 378       * @param object $context the context.
 379       * @return object the required options.
 380       */
 381      protected function specific_filepicker_options($acceptedtypes, $draftitemid, $context) {
 382          $filepickeroptions = new stdClass();
 383          $filepickeroptions->accepted_types = $acceptedtypes;
 384          $filepickeroptions->return_types = FILE_INTERNAL | FILE_EXTERNAL;
 385          $filepickeroptions->context = $context;
 386          $filepickeroptions->env = 'filepicker';
 387  
 388          $options = initialise_filepicker($filepickeroptions);
 389          $options->context = $context;
 390          $options->client_id = uniqid();
 391          $options->env = 'editor';
 392          $options->itemid = $draftitemid;
 393  
 394          return $options;
 395      }
 396  
 397      protected function get_filepicker_options($context, $draftitemid) {
 398          global $CFG;
 399  
 400          return array(
 401              'image' => $this->specific_filepicker_options(array('image'),
 402                              $draftitemid, $context),
 403              'media' => $this->specific_filepicker_options(array('video', 'audio'),
 404                              $draftitemid, $context),
 405              'link'  => $this->specific_filepicker_options('*',
 406                              $draftitemid, $context),
 407          );
 408      }
 409  
 410      protected function filepicker_html($inputname, $draftitemid) {
 411          $nonjspickerurl = new moodle_url('/repository/draftfiles_manager.php', array(
 412              'action' => 'browse',
 413              'env' => 'editor',
 414              'itemid' => $draftitemid,
 415              'subdirs' => false,
 416              'maxfiles' => -1,
 417              'sesskey' => sesskey(),
 418          ));
 419  
 420          return html_writer::empty_tag('input', array('type' => 'hidden',
 421                  'name' => $inputname . ':itemid', 'value' => $draftitemid)) .
 422                  html_writer::tag('noscript', html_writer::tag('div',
 423                      html_writer::tag('object', '', array('type' => 'text/html',
 424                          'data' => $nonjspickerurl, 'height' => 160, 'width' => 600,
 425                          'style' => 'border: 1px solid #000;'))));
 426      }
 427  }
 428  
 429  
 430  /**
 431   * An essay format renderer for essays where the student should use a plain
 432   * input box, but with a normal, proportional font.
 433   *
 434   * @copyright  2011 The Open University
 435   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 436   */
 437  class qtype_essay_format_plain_renderer extends plugin_renderer_base {
 438      /**
 439       * @return string the HTML for the textarea.
 440       */
 441      protected function textarea($response, $lines, $attributes) {
 442          $attributes['class'] = $this->class_name() . ' qtype_essay_response';
 443          $attributes['rows'] = $lines;
 444          $attributes['cols'] = 60;
 445          return html_writer::tag('textarea', s($response), $attributes);
 446      }
 447  
 448      protected function class_name() {
 449          return 'qtype_essay_plain';
 450      }
 451  
 452      public function response_area_read_only($name, $qa, $step, $lines, $context) {
 453          return $this->textarea($step->get_qt_var($name), $lines, array('readonly' => 'readonly'));
 454      }
 455  
 456      public function response_area_input($name, $qa, $step, $lines, $context) {
 457          $inputname = $qa->get_qt_field_name($name);
 458          return $this->textarea($step->get_qt_var($name), $lines, array('name' => $inputname)) .
 459                  html_writer::empty_tag('input', array('type' => 'hidden',
 460                      'name' => $inputname . 'format', 'value' => FORMAT_PLAIN));
 461      }
 462  }
 463  
 464  
 465  /**
 466   * An essay format renderer for essays where the student should use a plain
 467   * input box with a monospaced font. You might use this, for example, for a
 468   * question where the students should type computer code.
 469   *
 470   * @copyright  2011 The Open University
 471   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 472   */
 473  class qtype_essay_format_monospaced_renderer extends qtype_essay_format_plain_renderer {
 474      protected function class_name() {
 475          return 'qtype_essay_monospaced';
 476      }
 477  }