MDL-58428 renderer: Move renderer override from course management
[moodle.git] / question / renderer.php
CommitLineData
5cc021a0
TH
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
27defined('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 */
36class core_question_bank_renderer extends plugin_renderer_base {
37
0fa21eb7
AA
38 /**
39 * Display additional navigation if needed.
40 *
41 * @return string
42 */
43 public function extra_horizontal_navigation() {
44 // Overwrite in child themes if needed.
45 return '';
46 }
47
5cc021a0 48 /**
ac32c27e
ARN
49 * Output the icon for a question type.
50 *
5cc021a0
TH
51 * @param string $qtype the question type.
52 * @return string HTML fragment.
53 */
54 public function qtype_icon($qtype) {
55 $qtype = question_bank::get_qtype($qtype, false);
56 $namestr = $qtype->local_name();
57
b9b409cf 58 return $this->image_icon('icon', $namestr, $qtype->plugin_name(), array('title' => $namestr));
5cc021a0 59 }
ac32c27e 60
6f0993cc
FM
61 /**
62 * Render a qbank_chooser.
63 *
64 * @param renderable $qbankchooser The chooser.
65 * @return string
66 */
67 public function render_qbank_chooser(renderable $qbankchooser) {
68 return $this->render_from_template('core_question/qbank_chooser', $qbankchooser->export_for_template($this));
69 }
70
ac32c27e
ARN
71 /**
72 * Build the HTML for the question chooser javascript popup.
73 *
74 * @param array $real A set of real question types
75 * @param array $fake A set of fake question types
76 * @param object $course The course that will be displayed
77 * @param array $hiddenparams Any hidden parameters to add to the form
78 * @return string The composed HTML for the questionbank chooser
79 */
80 public function qbank_chooser($real, $fake, $course, $hiddenparams) {
891750bc
FM
81 debugging('Method core_question_bank_renderer::qbank_chooser() is deprecated, ' .
82 'see core_question_bank_renderer::render_qbank_chooser().', DEBUG_DEVELOPER);
83 return '';
ac32c27e
ARN
84 }
85
86 /**
87 * Build the HTML for a specified set of question types.
88 *
89 * @param array $types A set of question types as used by the qbank_chooser_module function
90 * @return string The composed HTML for the module
91 */
92 protected function qbank_chooser_types($types) {
6f0993cc
FM
93 debugging('Method core_question_bank_renderer::qbank_chooser_types() is deprecated, ' .
94 'see core_question_bank_renderer::render_qbank_chooser().', DEBUG_DEVELOPER);
95 return '';
ac32c27e
ARN
96 }
97
98 /**
99 * Return the HTML for the specified question type, adding any required classes.
100 *
101 * @param object $qtype An object containing the title, and link. An icon, and help text may optionally be specified.
102 * If the module contains subtypes in the types option, then these will also be displayed.
103 * @param array $classes Additional classes to add to the encompassing div element
104 * @return string The composed HTML for the question type
105 */
106 protected function qbank_chooser_qtype($qtype, $classes = array()) {
6f0993cc
FM
107 debugging('Method core_question_bank_renderer::qbank_chooser_qtype() is deprecated, ' .
108 'see core_question_bank_renderer::render_qbank_chooser().', DEBUG_DEVELOPER);
109 return '';
ac32c27e
ARN
110 }
111
112 /**
113 * Return the title for the question bank chooser.
114 *
115 * @param string $title The language string identifier
116 * @param string $identifier The component identifier
117 * @return string The composed HTML for the title
118 */
119 protected function qbank_chooser_title($title, $identifier = null) {
6f0993cc
FM
120 debugging('Method core_question_bank_renderer::qbank_chooser_title() is deprecated, ' .
121 'see core_question_bank_renderer::render_qbank_chooser().', DEBUG_DEVELOPER);
122 return '';
ac32c27e 123 }
5cc021a0 124}