question/renderer.php

   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  * Renderers for outputting parts of the question bank.
  19  *
  20  * @package    moodlecore
  21  * @subpackage questionbank
  22  * @copyright  2011 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  * This renderer outputs parts of the question bank.
  32  *
  33  * @copyright  2011 The Open University
  34  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35  */
  36 class core_question_bank_renderer extends plugin_renderer_base {
  37
  38     /**
  39      * Output the icon for a question type.
  40      *
  41      * @param string $qtype the question type.
  42      * @return string HTML fragment.
  43      */
  44     public function qtype_icon($qtype) {
  45         $qtype = question_bank::get_qtype($qtype, false);
  46         $namestr = $qtype->local_name();
  47
  48         return $this->pix_icon('icon', $namestr, $qtype->plugin_name(), array('title' => $namestr));
  49     }
  50
  51     /**
  52      * Render a qbank_chooser.
  53      *
  54      * @param renderable $qbankchooser The chooser.
  55      * @return string
  56      */
  57     public function render_qbank_chooser(renderable $qbankchooser) {
  58         return $this->render_from_template('core_question/qbank_chooser', $qbankchooser->export_for_template($this));
  59     }
  60
  61     /**
  62      * Build the HTML for the question chooser javascript popup.
  63      *
  64      * @param array $real A set of real question types
  65      * @param array $fake A set of fake question types
  66      * @param object $course The course that will be displayed
  67      * @param array $hiddenparams Any hidden parameters to add to the form
  68      * @return string The composed HTML for the questionbank chooser
  69      */
  70     public function qbank_chooser($real, $fake, $course, $hiddenparams) {
  71         debugging('Method core_question_bank_renderer::qbank_chooser() is deprecated, ' .
  72             'see core_question_bank_renderer::render_qbank_chooser().', DEBUG_DEVELOPER);
  73         return '';
  74     }
  75
  76     /**
  77      * Build the HTML for a specified set of question types.
  78      *
  79      * @param array $types A set of question types as used by the qbank_chooser_module function
  80      * @return string The composed HTML for the module
  81      */
  82     protected function qbank_chooser_types($types) {
  83         debugging('Method core_question_bank_renderer::qbank_chooser_types() is deprecated, ' .
  84             'see core_question_bank_renderer::render_qbank_chooser().', DEBUG_DEVELOPER);
  85         return '';
  86     }
  87
  88     /**
  89      * Return the HTML for the specified question type, adding any required classes.
  90      *
  91      * @param object $qtype An object containing the title, and link. An icon, and help text may optionally be specified.
  92      * If the module contains subtypes in the types option, then these will also be displayed.
  93      * @param array $classes Additional classes to add to the encompassing div element
  94      * @return string The composed HTML for the question type
  95      */
  96     protected function qbank_chooser_qtype($qtype, $classes = array()) {
  97         debugging('Method core_question_bank_renderer::qbank_chooser_qtype() is deprecated, ' .
  98             'see core_question_bank_renderer::render_qbank_chooser().', DEBUG_DEVELOPER);
  99         return '';
 100     }
 101
 102     /**
 103      * Return the title for the question bank chooser.
 104      *
 105      * @param string $title The language string identifier
 106      * @param string $identifier The component identifier
 107      * @return string The composed HTML for the title
 108      */
 109     protected function qbank_chooser_title($title, $identifier = null) {
 110         debugging('Method core_question_bank_renderer::qbank_chooser_title() is deprecated, ' .
 111             'see core_question_bank_renderer::render_qbank_chooser().', DEBUG_DEVELOPER);
 112         return '';
 113     }
 114 }