[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   * Defines the renderer base class for question behaviours.
  19   *
  20   * @package    moodlecore
  21   * @subpackage questionbehaviours
  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   * Renderer base class for question behaviours.
  32   *
  33   * The methods in this class are mostly called from {@link core_question_renderer}
  34   * which coordinates the overall output of questions.
  35   *
  36   * @copyright  2009 The Open University
  37   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  38   */
  39  abstract class qbehaviour_renderer extends plugin_renderer_base {
  40      /**
  41       * Generate some HTML (which may be blank) that appears in the question
  42       * formulation area, afer the question type generated output.
  43       *
  44       * For example.
  45       * immediatefeedback and interactive mode use this to show the Submit button,
  46       * and CBM use this to display the certainty choices.
  47       *
  48       * @param question_attempt $qa a question attempt.
  49       * @param question_display_options $options controls what should and should not be displayed.
  50       * @return string HTML fragment.
  51       */
  52      public function controls(question_attempt $qa, question_display_options $options) {
  53          return '';
  54      }
  55  
  56      /**
  57       * Generate some HTML (which may be blank) that appears in the outcome area,
  58       * after the question-type generated output.
  59       *
  60       * For example, the CBM models use this to display an explanation of the score
  61       * adjustment that was made based on the certainty selected.
  62       *
  63       * @param question_attempt $qa a question attempt.
  64       * @param question_display_options $options controls what should and should not be displayed.
  65       * @return string HTML fragment.
  66       */
  67      public function feedback(question_attempt $qa, question_display_options $options) {
  68          return '';
  69      }
  70  
  71      public function manual_comment_fields(question_attempt $qa, question_display_options $options) {
  72          $inputname = $qa->get_behaviour_field_name('comment');
  73          $id = $inputname . '_id';
  74          list($commenttext, $commentformat) = $qa->get_current_manual_comment();
  75  
  76          $editor = editors_get_preferred_editor($commentformat);
  77          $strformats = format_text_menu();
  78          $formats = $editor->get_supported_formats();
  79          foreach ($formats as $fid) {
  80              $formats[$fid] = $strformats[$fid];
  81          }
  82  
  83          $commenttext = format_text($commenttext, $commentformat, array('para' => false));
  84  
  85          $editor->use_editor($id, array('context' => $options->context));
  86  
  87          $commenteditor = html_writer::tag('div', html_writer::tag('textarea', s($commenttext),
  88                  array('id' => $id, 'name' => $inputname, 'rows' => 10, 'cols' => 60)));
  89  
  90          $editorformat = '';
  91          if (count($formats) == 1) {
  92              reset($formats);
  93              $editorformat .= html_writer::empty_tag('input', array('type' => 'hidden',
  94                      'name' => $inputname . 'format', 'value' => key($formats)));
  95          } else {
  96              $editorformat = html_writer::start_tag('div', array('class' => 'fitem'));
  97              $editorformat .= html_writer::start_tag('div', array('class' => 'fitemtitle'));
  98              $editorformat .= html_writer::tag('label', get_string('format'), array('for'=>'menu'.$inputname.'format'));
  99              $editorformat .= html_writer::end_tag('div');
 100              $editorformat .= html_writer::start_tag('div', array('class' => 'felement fhtmleditor'));
 101              $editorformat .= html_writer::select($formats, $inputname.'format', $commentformat, '');
 102              $editorformat .= html_writer::end_tag('div');
 103              $editorformat .= html_writer::end_tag('div');
 104          }
 105  
 106          $comment = html_writer::tag('div', html_writer::tag('div',
 107                  html_writer::tag('label', get_string('comment', 'question'),
 108                  array('for' => $id)), array('class' => 'fitemtitle')) .
 109                  html_writer::tag('div', $commenteditor, array('class' => 'felement fhtmleditor')),
 110                  array('class' => 'fitem'));
 111          $comment .= $editorformat;
 112  
 113          $mark = '';
 114          if ($qa->get_max_mark()) {
 115              $currentmark = $qa->get_current_manual_mark();
 116              $maxmark = $qa->get_max_mark();
 117  
 118              $fieldsize = strlen($qa->format_max_mark($options->markdp)) - 1;
 119              $markfield = $qa->get_behaviour_field_name('mark');
 120  
 121              $attributes = array(
 122                  'type' => 'text',
 123                  'size' => $fieldsize,
 124                  'name' => $markfield,
 125                  'id'=> $markfield
 126              );
 127              if (!is_null($currentmark)) {
 128                  $attributes['value'] = $qa->format_fraction_as_mark(
 129                          $currentmark / $maxmark, $options->markdp);
 130              }
 131              $a = new stdClass();
 132              $a->max = $qa->format_max_mark($options->markdp);
 133              $a->mark = html_writer::empty_tag('input', $attributes);
 134  
 135              $markrange = html_writer::empty_tag('input', array(
 136                  'type' => 'hidden',
 137                  'name' => $qa->get_behaviour_field_name('maxmark'),
 138                  'value' => $maxmark,
 139              )) . html_writer::empty_tag('input', array(
 140                  'type' => 'hidden',
 141                  'name' => $qa->get_control_field_name('minfraction'),
 142                  'value' => $qa->get_min_fraction(),
 143              )) . html_writer::empty_tag('input', array(
 144                  'type' => 'hidden',
 145                  'name' => $qa->get_control_field_name('maxfraction'),
 146                  'value' => $qa->get_max_fraction(),
 147              ));
 148  
 149              $errorclass = '';
 150              $error = '';
 151              if ($currentmark > $maxmark * $qa->get_max_fraction() || $currentmark < $maxmark * $qa->get_min_fraction()) {
 152                  $errorclass = ' error';
 153                  $error = html_writer::tag('span', get_string('manualgradeoutofrange', 'question'),
 154                          array('class' => 'error')) . html_writer::empty_tag('br');
 155              }
 156  
 157              $mark = html_writer::tag('div', html_writer::tag('div',
 158                          html_writer::tag('label', get_string('mark', 'question'),
 159                          array('for' => $markfield)),
 160                      array('class' => 'fitemtitle')) .
 161                      html_writer::tag('div', $error . get_string('xoutofmax', 'question', $a) .
 162                          $markrange, array('class' => 'felement ftext' . $errorclass)
 163                      ), array('class' => 'fitem'));
 164          }
 165  
 166          return html_writer::tag('fieldset', html_writer::tag('div', $comment . $mark,
 167                  array('class' => 'fcontainer clearfix')), array('class' => 'hidden'));
 168      }
 169  
 170      public function manual_comment_view(question_attempt $qa, question_display_options $options) {
 171          $output = '';
 172          if ($qa->has_manual_comment()) {
 173              $output .= get_string('commentx', 'question', $qa->get_behaviour()->format_comment());
 174          }
 175          if ($options->manualcommentlink) {
 176              $url = new moodle_url($options->manualcommentlink, array('slot' => $qa->get_slot()));
 177              $link = $this->output->action_link($url, get_string('commentormark', 'question'),
 178                      new popup_action('click', $url, 'commentquestion',
 179                      array('width' => 600, 'height' => 800)));
 180              $output .= html_writer::tag('div', $link, array('class' => 'commentlink'));
 181          }
 182          return $output;
 183      }
 184  
 185      /**
 186       * Display the manual comment, and a link to edit it, if appropriate.
 187       *
 188       * @param question_attempt $qa a question attempt.
 189       * @param question_display_options $options controls what should and should not be displayed.
 190       * @return string HTML fragment.
 191       */
 192      public function manual_comment(question_attempt $qa, question_display_options $options) {
 193          if ($options->manualcomment == question_display_options::EDITABLE) {
 194              return $this->manual_comment_fields($qa, $options);
 195  
 196          } else if ($options->manualcomment == question_display_options::VISIBLE) {
 197              return $this->manual_comment_view($qa, $options);
 198  
 199          } else {
 200              return '';
 201          }
 202      }
 203  
 204      /**
 205       * Several behaviours need a submit button, so put the common code here.
 206       * The button is disabled if the question is displayed read-only.
 207       * @param question_display_options $options controls what should and should not be displayed.
 208       * @return string HTML fragment.
 209       */
 210      protected function submit_button(question_attempt $qa, question_display_options $options) {
 211          $attributes = array(
 212              'type' => 'submit',
 213              'id' => $qa->get_behaviour_field_name('submit'),
 214              'name' => $qa->get_behaviour_field_name('submit'),
 215              'value' => get_string('check', 'question'),
 216              'class' => 'submit btn',
 217          );
 218          if ($options->readonly) {
 219              $attributes['disabled'] = 'disabled';
 220          }
 221          $output = html_writer::empty_tag('input', $attributes);
 222          if (!$options->readonly) {
 223              $this->page->requires->js_init_call('M.core_question_engine.init_submit_button',
 224                      array($attributes['id'], $qa->get_slot()));
 225          }
 226          return $output;
 227      }
 228  
 229      /**
 230       * Return any HTML that needs to be included in the page's <head> when
 231       * questions using this model are used.
 232       * @param $qa the question attempt that will be displayed on the page.
 233       * @return string HTML fragment.
 234       */
 235      public function head_code(question_attempt $qa) {
 236          return '';
 237      }
 238  
 239      /**
 240       * Generate the display of the marks for this question.
 241       * @param question_attempt $qa the question attempt to display.
 242       * @param core_question_renderer $qoutput the renderer for standard parts of questions.
 243       * @param question_display_options $options controls what should and should not be displayed.
 244       * @return HTML fragment.
 245       */
 246      public function mark_summary(question_attempt $qa, core_question_renderer $qoutput,
 247              question_display_options $options) {
 248          return $qoutput->standard_mark_summary($qa, $this, $options);
 249      }
 250  
 251      /**
 252       * Generate the display of the available marks for this question.
 253       * @param question_attempt $qa the question attempt to display.
 254       * @param core_question_renderer $qoutput the renderer for standard parts of questions.
 255       * @param question_display_options $options controls what should and should not be displayed.
 256       * @return HTML fragment.
 257       */
 258      public function marked_out_of_max(question_attempt $qa, core_question_renderer $qoutput,
 259              question_display_options $options) {
 260          return $qoutput->standard_marked_out_of_max($qa, $options);
 261      }
 262  
 263      /**
 264       * Generate the display of the marks for this question out of the available marks.
 265       * @param question_attempt $qa the question attempt to display.
 266       * @param core_question_renderer $qoutput the renderer for standard parts of questions.
 267       * @param question_display_options $options controls what should and should not be displayed.
 268       * @return HTML fragment.
 269       */
 270      public function mark_out_of_max(question_attempt $qa, core_question_renderer $qoutput,
 271              question_display_options $options) {
 272          return $qoutput->standard_mark_out_of_max($qa, $options);
 273      }
 274  }