MDL-41758 quiz statistics : link to full break down of stats for slots
[moodle.git] / mod / quiz / report / statistics / statistics_table.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/>.
17 /**
18  * Quiz statistics report, table for showing statistics of each question in the quiz.
19  *
20  * @package   quiz_statistics
21  * @copyright 2008 Jamie Pratt
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 require_once($CFG->libdir.'/tablelib.php');
29 /**
30  * This table has one row for each question in the quiz, with sub-rows when
31  * random questions and variants appear.
32  *
33  * There are columns for the various item and position statistics.
34  *
35  * @copyright 2008 Jamie Pratt
36  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37  */
38 class quiz_statistics_table extends flexible_table {
39     /** @var object the quiz settings. */
40     protected $quiz;
42     /** @var integer the quiz course_module id. */
43     protected $cmid;
45     /**
46      * Constructor.
47      */
48     public function __construct() {
49         parent::__construct('mod-quiz-report-statistics-report');
50     }
52     /**
53      * Set up the columns and headers and other properties of the table and then
54      * call flexible_table::setup() method.
55      *
56      * @param object $quiz the quiz settings
57      * @param int $cmid the quiz course_module id
58      * @param moodle_url $reporturl the URL to redisplay this report.
59      * @param int $s number of attempts included in the statistics.
60      */
61     public function statistics_setup($quiz, $cmid, $reporturl, $s) {
62         $this->quiz = $quiz;
63         $this->cmid = $cmid;
65         // Define the table columns.
66         $columns = array();
67         $headers = array();
69         $columns[] = 'number';
70         $headers[] = get_string('questionnumber', 'quiz_statistics');
72         if (!$this->is_downloading()) {
73             $columns[] = 'icon';
74             $headers[] = '';
75             $columns[] = 'actions';
76             $headers[] = '';
77         } else {
78             $columns[] = 'qtype';
79             $headers[] = get_string('questiontype', 'quiz_statistics');
80         }
82         $columns[] = 'name';
83         $headers[] = get_string('questionname', 'quiz');
85         $columns[] = 's';
86         $headers[] = get_string('attempts', 'quiz_statistics');
88         if ($s > 1) {
89             $columns[] = 'facility';
90             $headers[] = get_string('facility', 'quiz_statistics');
92             $columns[] = 'sd';
93             $headers[] = get_string('standarddeviationq', 'quiz_statistics');
94         }
96         $columns[] = 'random_guess_score';
97         $headers[] = get_string('random_guess_score', 'quiz_statistics');
99         $columns[] = 'intended_weight';
100         $headers[] = get_string('intended_weight', 'quiz_statistics');
102         $columns[] = 'effective_weight';
103         $headers[] = get_string('effective_weight', 'quiz_statistics');
105         $columns[] = 'discrimination_index';
106         $headers[] = get_string('discrimination_index', 'quiz_statistics');
108         $columns[] = 'discriminative_efficiency';
109         $headers[] = get_string('discriminative_efficiency', 'quiz_statistics');
111         $this->define_columns($columns);
112         $this->define_headers($headers);
113         $this->sortable(false);
115         $this->column_class('s', 'numcol');
116         $this->column_class('facility', 'numcol');
117         $this->column_class('sd', 'numcol');
118         $this->column_class('random_guess_score', 'numcol');
119         $this->column_class('intended_weight', 'numcol');
120         $this->column_class('effective_weight', 'numcol');
121         $this->column_class('discrimination_index', 'numcol');
122         $this->column_class('discriminative_efficiency', 'numcol');
124         // Set up the table.
125         $this->define_baseurl($reporturl->out());
127         $this->collapsible(true);
129         $this->set_attribute('id', 'questionstatistics');
130         $this->set_attribute('class', 'generaltable generalbox boxaligncenter');
132         parent::setup();
133     }
135     /**
136      * The question number.
137      * @param \core_question\statistics\questions\calculated $questionstat stats for the question.
138      * @return string contents of this table cell.
139      */
140     protected function col_number($questionstat) {
141         if (!isset($questionstat->question->number)) {
142             return '';
143         }
144         $number = $questionstat->question->number;
146         if (isset($questionstat->subqdisplayorder)) {
147             $number = $number . '.'.$questionstat->subqdisplayorder;
148         }
150         if ($questionstat->question->qtype != 'random' && !is_null($questionstat->variant)) {
151             $number = $number . '.'.$questionstat->variant;
152         }
154         return $number;
155     }
157     /**
158      * The question type icon.
159      * @param \core_question\statistics\questions\calculated $questionstat stats for the question.
160      * @return string contents of this table cell.
161      */
162     protected function col_icon($questionstat) {
163         return print_question_icon($questionstat->question, true);
164     }
166     /**
167      * Actions that can be performed on the question by this user (e.g. edit or preview).
168      * @param \core_question\statistics\questions\calculated $questionstat stats for the question.
169      * @return string contents of this table cell.
170      */
171     protected function col_actions($questionstat) {
172         return quiz_question_action_icons($this->quiz, $this->cmid, $questionstat->question, $this->baseurl);
173     }
175     /**
176      * The question type name.
177      *
178      * @param \core_question\statistics\questions\calculated $questionstat stats for the question.
179      * @return string contents of this table cell.
180      */
181     protected function col_qtype($questionstat) {
182         return question_bank::get_qtype_name($questionstat->question->qtype);
183     }
185     /**
186      * The question name.
187      *
188      * @param \core_question\statistics\questions\calculated $questionstat stats for the question.
189      * @return string contents of this table cell.
190      */
191     protected function col_name($questionstat) {
192         $name = $questionstat->question->name;
194         if (!is_null($questionstat->variant)) {
195             $a = new stdClass();
196             $a->name = $name;
197             $a->variant = $questionstat->variant;
198             $name = get_string('nameforvariant', 'quiz_statistics', $a);
199         }
201         if ($this->is_downloading()) {
202             return $name;
203         }
205         $baseurl = new moodle_url($this->baseurl);
206         if (is_null($questionstat->variant)) {
207             if ($questionstat->subquestion && !$questionstat->get_variants()) {
208                 $url = new moodle_url($baseurl, array('qid' => $questionstat->questionid));
209                 $name = html_writer::link($url, $name, array('title' => get_string('detailedanalysis', 'quiz_statistics')));
210             } else if ($baseurl->param('slot') === null && $questionstat->slot) {
211                 $number = $questionstat->question->number;
212                 $url = new moodle_url($baseurl, array('slot' => $questionstat->slot));
213                 if ($questionstat->get_variants() || $questionstat->get_sub_question_ids()) {
214                     $name = html_writer::link($url,
215                                               $name,
216                                               array('title' => get_string('slotstructureanalysis', 'quiz_statistics', $number)));
217                 } else {
218                     $name = html_writer::link($url,
219                                               $name,
220                                               array('title' => get_string('detailedanalysis', 'quiz_statistics')));
221                 }
222             }
223         }
226         if ($this->is_dubious_question($questionstat)) {
227             $name = html_writer::tag('div', $name, array('class' => 'dubious'));
228         }
230         if (!empty($questionstat->minmedianmaxnotice)) {
231             $name = get_string($questionstat->minmedianmaxnotice, 'quiz_statistics') . '<br />' . $name;
232         }
234         return $name;
235     }
237     /**
238      * The number of attempts at this question.
239      *
240      * @param \core_question\statistics\questions\calculated $questionstat stats for the question.
241      * @return string contents of this table cell.
242      */
243     protected function col_s($questionstat) {
244         if (!isset($questionstat->s)) {
245             return 0;
246         }
248         return $questionstat->s;
249     }
251     /**
252      * The facility index (average fraction).
253      * @param \core_question\statistics\questions\calculated $questionstat stats for the question.
254      * @return string contents of this table cell.
255      */
256     protected function col_facility($questionstat) {
257         if (is_null($questionstat->facility)) {
258             return '';
259         }
261         return number_format($questionstat->facility*100, 2) . '%';
262     }
264     /**
265      * The standard deviation of the fractions.
266      * @param \core_question\statistics\questions\calculated $questionstat stats for the question.
267      * @return string contents of this table cell.
268      */
269     protected function col_sd($questionstat) {
270         if (is_null($questionstat->sd) || $questionstat->maxmark == 0) {
271             return '';
272         }
274         return number_format($questionstat->sd*100 / $questionstat->maxmark, 2) . '%';
275     }
277     /**
278      * An estimate of the fraction a student would get by guessing randomly.
279      * @param \core_question\statistics\questions\calculated $questionstat stats for the question.
280      * @return string contents of this table cell.
281      */
282     protected function col_random_guess_score($questionstat) {
283         if (is_null($questionstat->randomguessscore)) {
284             return '';
285         }
287         return number_format($questionstat->randomguessscore * 100, 2).'%';
288     }
290     /**
291      * The intended question weight. Maximum mark for the question as a percentage
292      * of maximum mark for the quiz. That is, the indended influence this question
293      * on the student's overall mark.
294      * @param \core_question\statistics\questions\calculated $questionstat stats for the question.
295      * @return string contents of this table cell.
296      */
297     protected function col_intended_weight($questionstat) {
298         return quiz_report_scale_summarks_as_percentage($questionstat->maxmark, $this->quiz);
299     }
301     /**
302      * The effective question weight. That is, an estimate of the actual
303      * influence this question has on the student's overall mark.
304      * @param \core_question\statistics\questions\calculated $questionstat stats for the question.
305      * @return string contents of this table cell.
306      */
307     protected function col_effective_weight($questionstat) {
308         global $OUTPUT;
310         if (is_null($questionstat->effectiveweight)) {
311             return '';
312         }
314         if ($questionstat->negcovar) {
315             $negcovar = get_string('negcovar', 'quiz_statistics');
317             if (!$this->is_downloading()) {
318                 $negcovar = html_writer::tag('div',
319                         $negcovar . $OUTPUT->help_icon('negcovar', 'quiz_statistics'),
320                         array('class' => 'negcovar'));
321             }
323             return $negcovar;
324         }
326         return number_format($questionstat->effectiveweight, 2) . '%';
327     }
329     /**
330      * Discrimination index. This is the product moment correlation coefficient
331      * between the fraction for this question, and the average fraction for the
332      * other questions in this quiz.
333      * @param \core_question\statistics\questions\calculated $questionstat stats for the question.
334      * @return string contents of this table cell.
335      */
336     protected function col_discrimination_index($questionstat) {
337         if (!is_numeric($questionstat->discriminationindex)) {
338             return $questionstat->discriminationindex;
339         }
341         return number_format($questionstat->discriminationindex, 2) . '%';
342     }
344     /**
345      * Discrimination efficiency, similar to, but different from, the Discrimination index.
346      *
347      * @param \core_question\statistics\questions\calculated $questionstat stats for the question.
348      * @return string contents of this table cell.
349      */
350     protected function col_discriminative_efficiency($questionstat) {
351         if (!is_numeric($questionstat->discriminativeefficiency)) {
352             return '';
353         }
355         return number_format($questionstat->discriminativeefficiency, 2) . '%';
356     }
358     /**
359      * This method encapsulates the test for wheter a question should be considered dubious.
360      * @param \core_question\statistics\questions\calculated $questionstat stats for the question.
361      * @return bool is this question possibly not pulling it's weight?
362      */
363     protected function is_dubious_question($questionstat) {
364         if (!is_numeric($questionstat->discriminativeefficiency)) {
365             return false;
366         }
368         return $questionstat->discriminativeefficiency < 15;
369     }
371     public function  wrap_html_start() {
372         // Horrible Moodle 2.0 wide-content work-around.
373         if (!$this->is_downloading()) {
374             echo html_writer::start_tag('div', array('id' => 'tablecontainer',
375                     'class' => 'statistics-tablecontainer'));
376         }
377     }
379     public function wrap_html_finish() {
380         if (!$this->is_downloading()) {
381             echo html_writer::end_tag('div');
382         }
383     }