Merge branch 'MDL-41760-master-v8' of https://github.com/jamiepratt/moodle
[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 question.
19  *
20  * @package    core_question
21  * @copyright  2014 Open University
22  * @author     Jamie Pratt <me@jamiep.org>
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 namespace core_question\statistics\responses;
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * This class can compute, store and cache the analysis of the responses to a particular question.
31  *
32  * @package    core_question
33  * @copyright  2014 The Open University
34  * @author     James Pratt me@jamiep.org
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class analyser {
38     /** @var int Time after which responses are automatically reanalysed. */
39     const TIME_TO_CACHE = 900; // 15 minutes.
41     /** @var object full question data from db. */
42     protected $questiondata;
44     /**
45      * @var analysis_for_question|analysis_for_question_all_tries
46      */
47     public $analysis;
49     /**
50      * @var array Two index array first index is unique string for each sub question part, the second string index is the 'class'
51      * that sub-question part can be classified into.
52      *
53      * This is the return value from {@link \question_type::get_possible_responses()} see that method for fuller documentation.
54      */
55     public $responseclasses = array();
57     /**
58      * @var bool whether to break down response analysis by variant. This only applies to questions that have variants and is
59      *           used to suppress the break down of analysis by variant when there are going to be very many variants.
60      */
61     protected $breakdownbyvariant;
63     /**
64      * Create a new instance of this class for holding/computing the statistics
65      * for a particular question.
66      *
67      * @param object $questiondata the full question data from the database defining this question.
68      * @param string $whichtries   which tries to analyse.
69      */
70     public function __construct($questiondata, $whichtries = \question_attempt::LAST_TRY) {
71         $this->questiondata = $questiondata;
72         $qtypeobj = \question_bank::get_qtype($this->questiondata->qtype);
73         if ($whichtries != \question_attempt::ALL_TRIES) {
74             $this->analysis = new analysis_for_question($qtypeobj->get_possible_responses($this->questiondata));
75         } else {
76             $this->analysis = new analysis_for_question_all_tries($qtypeobj->get_possible_responses($this->questiondata));
77         }
79         $this->breakdownbyvariant = $qtypeobj->break_down_stats_and_response_analysis_by_variant($this->questiondata);
80     }
82     /**
83      * Does the computed analysis have sub parts?
84      *
85      * @return bool whether this analysis has more than one subpart.
86      */
87     public function has_subparts() {
88         return count($this->responseclasses) > 1;
89     }
91     /**
92      * Does the computed analysis's sub parts have classes?
93      *
94      * @return bool whether this analysis has (a subpart with) more than one response class.
95      */
96     public function has_response_classes() {
97         foreach ($this->responseclasses as $partclasses) {
98             if (count($partclasses) > 1) {
99                 return true;
100             }
101         }
102         return false;
103     }
105     /**
106      * Analyse all the response data for for all the specified attempts at this question.
107      *
108      * @param \qubaid_condition $qubaids which attempts to consider.
109      * @param string $whichtries         which tries to analyse. Will be one of
110      *                                   \question_attempt::FIRST_TRY, LAST_TRY or ALL_TRIES.
111      * @return analysis_for_question
112      */
113     public function calculate($qubaids, $whichtries = \question_attempt::LAST_TRY) {
114         // Load data.
115         $dm = new \question_engine_data_mapper();
116         $questionattempts = $dm->load_attempts_at_question($this->questiondata->id, $qubaids);
118         // Analyse it.
119         foreach ($questionattempts as $qa) {
120             $responseparts = $qa->classify_response($whichtries);
121             if ($this->breakdownbyvariant) {
122                 $this->analysis->count_response_parts($qa->get_variant(), $responseparts);
123             } else {
124                 $this->analysis->count_response_parts(1, $responseparts);
125             }
127         }
128         $this->analysis->cache($qubaids, $whichtries, $this->questiondata->id);
129         return $this->analysis;
130     }
132     /**
133      * Retrieve the computed response analysis from the question_response_analysis table.
134      *
135      * @param \qubaid_condition $qubaids    load the analysis of which question usages?
136      * @param string            $whichtries load the analysis of which tries?
137      * @return analysis_for_question|boolean analysis or false if no cached analysis found.
138      */
139     public function load_cached($qubaids, $whichtries) {
140         global $DB;
142         $timemodified = time() - self::TIME_TO_CACHE;
143         // Variable name 'analyses' is the plural of 'analysis'.
144         $responseanalyses = $DB->get_records_select('question_response_analysis',
145                                             'hashcode = ? AND whichtries = ? AND questionid = ? AND timemodified > ?',
146                                             array($qubaids->get_hash_code(), $whichtries, $this->questiondata->id, $timemodified));
147         if (!$responseanalyses) {
148             return false;
149         }
151         $analysisids = array();
152         foreach ($responseanalyses as $responseanalysis) {
153             $analysisforsubpart = $this->analysis->get_analysis_for_subpart($responseanalysis->variant, $responseanalysis->subqid);
154             $class = $analysisforsubpart->get_response_class($responseanalysis->aid);
155             $class->add_response($responseanalysis->response, $responseanalysis->credit);
156             $analysisids[] = $responseanalysis->id;
157         }
158         list($sql, $params) = $DB->get_in_or_equal($analysisids);
159         $counts = $DB->get_records_select('question_response_count', "analysisid {$sql}", $params);
160         foreach ($counts as $count) {
161             $responseanalysis = $responseanalyses[$count->analysisid];
162             $analysisforsubpart = $this->analysis->get_analysis_for_subpart($responseanalysis->variant, $responseanalysis->subqid);
163             $class = $analysisforsubpart->get_response_class($responseanalysis->aid);
164             $class->set_response_count($responseanalysis->response, $count->try, $count->rcount);
166         }
167         return $this->analysis;
168     }
171     /**
172      * Find time of non-expired analysis in the database.
173      *
174      * @param \qubaid_condition $qubaids    check for the analysis of which question usages?
175      * @param string            $whichtries check for the analysis of which tries?
176      * @return integer|boolean Time of cached record that matches this qubaid_condition or false if none found.
177      */
178     public function get_last_analysed_time($qubaids, $whichtries) {
179         global $DB;
181         $timemodified = time() - self::TIME_TO_CACHE;
182         return $DB->get_field_select('question_response_analysis', 'timemodified',
183                                      'hashcode = ? AND whichtries = ? AND questionid = ? AND timemodified > ?',
184                                      array($qubaids->get_hash_code(), $whichtries, $this->questiondata->id, $timemodified),
185                                      IGNORE_MULTIPLE);
186     }