MDL-42957 quiz statistics : Hardcoded sql LIMIT clause
[moodle.git] / question / classes / statistics / responses / analyser.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  * This file contains the code to analyse all the responses to a particular
19  * question.
20  *
21  * @package    core_question
22  * @copyright  2013 Open University
23  * @author     Jamie Pratt <me@jamiep.org>
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 namespace core_question\statistics\responses;
28 defined('MOODLE_INTERNAL') || die();
30 /**
31  * This class can store and compute the analysis of the responses to a particular
32  * question.
33  *
34  * @copyright 2013 Open University
35  * @author    Jamie Pratt <me@jamiep.org>
36  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37  */
38 class analyser {
39     /** @var object full question data from db. */
40     protected $questiondata;
42     /**
43      * @var analysis_for_question
44      */
45     public $analysis;
47     /**
48      * @var array Two index array first index is unique for each sub question part, the second index is the 'class' that this sub
49      *          question part can be classified into. This is the return value from {@link \question_type::get_possible_responses()}
50      */
51     public $responseclasses = array();
53     /**
54      * Create a new instance of this class for holding/computing the statistics
55      * for a particular question.
56      *
57      * @param object $questiondata the full question data from the database defining this question.
58      */
59     public function __construct($questiondata) {
60         $this->questiondata = $questiondata;
61         $qtypeobj = \question_bank::get_qtype($this->questiondata->qtype);
62         $this->analysis = new analysis_for_question($qtypeobj->get_possible_responses($this->questiondata));
64     }
66     /**
67      * @return bool whether this analysis has more than one subpart.
68      */
69     public function has_subparts() {
70         return count($this->responseclasses) > 1;
71     }
73     /**
74      * @return bool whether this analysis has (a subpart with) more than one response class.
75      */
76     public function has_response_classes() {
77         foreach ($this->responseclasses as $partclasses) {
78             if (count($partclasses) > 1) {
79                 return true;
80             }
81         }
82         return false;
83     }
85     /**
86      * @return bool whether this analysis has a response class more than one
87      *      different acutal response, or if the actual response is different from
88      *      the model response.
89      */
90     public function has_actual_responses() {
91         foreach ($this->responseclasses as $subpartid => $partclasses) {
92             foreach ($partclasses as $responseclassid => $modelresponse) {
93                 $numresponses = count($this->responses[$subpartid][$responseclassid]);
94                 if ($numresponses > 1) {
95                     return true;
96                 }
97                 $actualresponse = key($this->responses[$subpartid][$responseclassid]);
98                 if ($numresponses == 1 && $actualresponse != $modelresponse->responseclass) {
99                     return true;
100                 }
101             }
102         }
103         return false;
104     }
106     /**
107      * Analyse all the response data for for all the specified attempts at
108      * this question.
109      * @param \qubaid_condition $qubaids which attempts to consider.
110      * @return analysis_for_question
111      */
112     public function calculate($qubaids) {
113         // Load data.
114         $dm = new \question_engine_data_mapper();
115         $questionattempts = $dm->load_attempts_at_question($this->questiondata->id, $qubaids);
117         // Analyse it.
118         foreach ($questionattempts as $qa) {
119             $responseparts = $qa->classify_response();
120             $this->analysis->count_response_parts($responseparts);
121         }
122         $this->analysis->cache($qubaids, $this->questiondata->id);
123         return $this->analysis;
124     }
126     /** @var integer Time after which responses are automatically reanalysed. */
127     const TIME_TO_CACHE = 900; // 15 minutes.
130     /**
131      * Retrieve the computed response analysis from the question_response_analysis table.
132      *
133      * @param \qubaid_condition $qubaids which attempts to get cached response analysis for.
134      * @return analysis_for_question|boolean analysis or false if no cached analysis found.
135      */
136     public function load_cached($qubaids) {
137         global $DB;
139         $timemodified = time() - self::TIME_TO_CACHE;
140         $rows = $DB->get_records_select('question_response_analysis', 'hashcode = ? AND questionid = ? AND timemodified > ?',
141                                         array($qubaids->get_hash_code(), $this->questiondata->id, $timemodified));
142         if (!$rows) {
143             return false;
144         }
146         foreach ($rows as $row) {
147             $class = $this->analysis->get_subpart($row->subqid)->get_response_class($row->aid);
148             $class->add_response_and_count($row->response, $row->credit, $row->rcount);
149         }
150         return $this->analysis;
151     }
154     /**
155      * Find time of non-expired analysis in the database.
156      *
157      * @param $qubaids \qubaid_condition
158      * @return integer|boolean Time of cached record that matches this qubaid_condition or false if none found.
159      */
160     public function get_last_analysed_time($qubaids) {
161         global $DB;
163         $timemodified = time() - self::TIME_TO_CACHE;
164         return $DB->get_field_select('question_response_analysis', 'hashcode = ? AND questionid = ? AND timemodified > ?',
165                                      array($qubaids->get_hash_code(), $this->questiondata->id, $timemodified), IGNORE_MULTIPLE);
166     }