191cf938b205091a83e063f855ce9814a4d3a0bd
[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 string for each sub question part, the second string index is the 'class'
49      * that sub-question part can be classified into.
50      *
51      * This is the return value from {@link \question_type::get_possible_responses()} see that method for fuller documentation.
52      */
53     public $responseclasses = array();
55     /**
56      * Create a new instance of this class for holding/computing the statistics
57      * for a particular question.
58      *
59      * @param object $questiondata the full question data from the database defining this question.
60      */
61     public function __construct($questiondata) {
62         $this->questiondata = $questiondata;
63         $qtypeobj = \question_bank::get_qtype($this->questiondata->qtype);
64         $this->analysis = new analysis_for_question($qtypeobj->get_possible_responses($this->questiondata));
66     }
68     /**
69      * @return bool whether this analysis has more than one subpart.
70      */
71     public function has_subparts() {
72         return count($this->responseclasses) > 1;
73     }
75     /**
76      * @return bool whether this analysis has (a subpart with) more than one response class.
77      */
78     public function has_response_classes() {
79         foreach ($this->responseclasses as $partclasses) {
80             if (count($partclasses) > 1) {
81                 return true;
82             }
83         }
84         return false;
85     }
87     /**
88      * @return bool whether this analysis has a response class more than one
89      *      different acutal response, or if the actual response is different from
90      *      the model response.
91      */
92     public function has_actual_responses() {
93         foreach ($this->responseclasses as $subpartid => $partclasses) {
94             foreach ($partclasses as $responseclassid => $modelresponse) {
95                 $numresponses = count($this->responses[$subpartid][$responseclassid]);
96                 if ($numresponses > 1) {
97                     return true;
98                 }
99                 $actualresponse = key($this->responses[$subpartid][$responseclassid]);
100                 if ($numresponses == 1 && $actualresponse != $modelresponse->responseclass) {
101                     return true;
102                 }
103             }
104         }
105         return false;
106     }
108     /**
109      * Analyse all the response data for for all the specified attempts at
110      * this question.
111      * @param \qubaid_condition $qubaids which attempts to consider.
112      * @return analysis_for_question
113      */
114     public function calculate($qubaids) {
115         // Load data.
116         $dm = new \question_engine_data_mapper();
117         $questionattempts = $dm->load_attempts_at_question($this->questiondata->id, $qubaids);
119         // Analyse it.
120         foreach ($questionattempts as $qa) {
121             $responseparts = $qa->classify_response();
122             $this->analysis->count_response_parts($qa->get_variant(), $responseparts);
123         }
124         $this->analysis->cache($qubaids, $this->questiondata->id);
125         return $this->analysis;
126     }
128     /** @var integer Time after which responses are automatically reanalysed. */
129     const TIME_TO_CACHE = 900; // 15 minutes.
132     /**
133      * Retrieve the computed response analysis from the question_response_analysis table.
134      *
135      * @param \qubaid_condition $qubaids which attempts to get cached response analysis for.
136      * @return analysis_for_question|boolean analysis or false if no cached analysis found.
137      */
138     public function load_cached($qubaids) {
139         global $DB;
141         $timemodified = time() - self::TIME_TO_CACHE;
142         $rows = $DB->get_records_select('question_response_analysis', 'hashcode = ? AND questionid = ? AND timemodified > ?',
143                                         array($qubaids->get_hash_code(), $this->questiondata->id, $timemodified));
144         if (!$rows) {
145             return false;
146         }
148         foreach ($rows as $row) {
149             $class = $this->analysis->get_analysis_for_subpart($row->variant, $row->subqid)->get_response_class($row->aid);
150             $class->add_response_and_count($row->response, $row->credit, $row->rcount);
151         }
152         return $this->analysis;
153     }
156     /**
157      * Find time of non-expired analysis in the database.
158      *
159      * @param $qubaids \qubaid_condition
160      * @return integer|boolean Time of cached record that matches this qubaid_condition or false if none found.
161      */
162     public function get_last_analysed_time($qubaids) {
163         global $DB;
165         $timemodified = time() - self::TIME_TO_CACHE;
166         return $DB->get_field_select('question_response_analysis', 'timemodified',
167                                      'hashcode = ? AND questionid = ? AND timemodified > ?',
168                                      array($qubaids->get_hash_code(), $this->questiondata->id, $timemodified), IGNORE_MULTIPLE);
169     }