05fafde4d56d75c8cf0ea16d8bd6a5d0d8a8910a
[moodle.git] / question / engine / questionusage.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 defines the question usage class, and a few related classes.
19  *
20  * @package    moodlecore
21  * @subpackage questionengine
22  * @copyright  2009 The Open University
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
27 defined('MOODLE_INTERNAL') || die();
30 /**
31  * This class keeps track of a group of questions that are being attempted,
32  * and which state, and so on, each one is currently in.
33  *
34  * A quiz attempt or a lesson attempt could use an instance of this class to
35  * keep track of all the questions in the attempt and process student submissions.
36  * It is basically a collection of {@question_attempt} objects.
37  *
38  * The questions being attempted as part of this usage are identified by an integer
39  * that is passed into many of the methods as $slot. ($question->id is not
40  * used so that the same question can be used more than once in an attempt.)
41  *
42  * Normally, calling code should be able to do everything it needs to be calling
43  * methods of this class. You should not normally need to get individual
44  * {@question_attempt} objects and play around with their inner workind, in code
45  * that it outside the quetsion engine.
46  *
47  * Instances of this class correspond to rows in the question_usages table.
48  *
49  * @copyright  2009 The Open University
50  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
51  */
52 class question_usage_by_activity {
53     /**
54      * @var integer|string the id for this usage. If this usage was loaded from
55      * the database, then this is the database id. Otherwise a unique random
56      * string is used.
57      */
58     protected $id = null;
60     /**
61      * @var string name of an archetypal behaviour, that should be used
62      * by questions in this usage if possible.
63      */
64     protected $preferredbehaviour = null;
66     /** @var context the context this usage belongs to. */
67     protected $context;
69     /** @var string plugin name of the plugin this usage belongs to. */
70     protected $owningcomponent;
72     /** @var array {@link question_attempt}s that make up this usage. */
73     protected $questionattempts = array();
75     /** @var question_usage_observer that tracks changes to this usage. */
76     protected $observer;
78     /**
79      * Create a new instance. Normally, calling code should use
80      * {@link question_engine::make_questions_usage_by_activity()} or
81      * {@link question_engine::load_questions_usage_by_activity()} rather than
82      * calling this constructor directly.
83      *
84      * @param string $component the plugin creating this attempt. For example mod_quiz.
85      * @param object $context the context this usage belongs to.
86      */
87     public function __construct($component, $context) {
88         $this->owningcomponent = $component;
89         $this->context = $context;
90         $this->observer = new question_usage_null_observer();
91     }
93     /**
94      * @param string $behaviour the name of an archetypal behaviour, that should
95      * be used by questions in this usage if possible.
96      */
97     public function set_preferred_behaviour($behaviour) {
98         $this->preferredbehaviour = $behaviour;
99         $this->observer->notify_modified();
100     }
102     /** @return string the name of the preferred behaviour. */
103     public function get_preferred_behaviour() {
104         return $this->preferredbehaviour;
105     }
107     /** @return context the context this usage belongs to. */
108     public function get_owning_context() {
109         return $this->context;
110     }
112     /** @return string the name of the plugin that owns this attempt. */
113     public function get_owning_component() {
114         return $this->owningcomponent;
115     }
117     /** @return int|string If this usage came from the database, then the id
118      * from the question_usages table is returned. Otherwise a random string is
119      * returned. */
120     public function get_id() {
121         if (is_null($this->id)) {
122             $this->id = random_string(10);
123         }
124         return $this->id;
125     }
127     /**
128      * For internal use only. Used by {@link question_engine_data_mapper} to set
129      * the id when a usage is saved to the database.
130      * @param int $id the newly determined id for this usage.
131      */
132     public function set_id_from_database($id) {
133         $this->id = $id;
134         foreach ($this->questionattempts as $qa) {
135             $qa->set_usage_id($id);
136         }
137     }
139     /** @return question_usage_observer that is tracking changes made to this usage. */
140     public function get_observer() {
141         return $this->observer;
142     }
144     /**
145      * You should almost certainly not call this method from your code. It is for
146      * internal use only.
147      * @param question_usage_observer that should be used to tracking changes made to this usage.
148      */
149     public function set_observer($observer) {
150         $this->observer = $observer;
151         foreach ($this->questionattempts as $qa) {
152             $qa->set_observer($observer);
153         }
154     }
156     /**
157      * Add another question to this usage.
158      *
159      * The added question is not started until you call {@link start_question()}
160      * on it.
161      *
162      * @param question_definition $question the question to add.
163      * @param number $maxmark the maximum this question will be marked out of in
164      *      this attempt (optional). If not given, $question->defaultmark is used.
165      * @return int the number used to identify this question within this usage.
166      */
167     public function add_question(question_definition $question, $maxmark = null) {
168         $qa = new question_attempt($question, $this->get_id(), $this->observer, $maxmark);
169         if (count($this->questionattempts) == 0) {
170             $this->questionattempts[1] = $qa;
171         } else {
172             $this->questionattempts[] = $qa;
173         }
174         end($this->questionattempts); // Ready to get the last key on the next line.
175         $qa->set_slot(key($this->questionattempts));
176         $this->observer->notify_attempt_added($qa);
177         return $qa->get_slot();
178     }
180     /**
181      * Get the question_definition for a question in this attempt.
182      * @param int $slot the number used to identify this question within this usage.
183      * @return question_definition the requested question object.
184      */
185     public function get_question($slot) {
186         return $this->get_question_attempt($slot)->get_question();
187     }
189     /** @return array all the identifying numbers of all the questions in this usage. */
190     public function get_slots() {
191         return array_keys($this->questionattempts);
192     }
194     /** @return int the identifying number of the first question that was added to this usage. */
195     public function get_first_question_number() {
196         reset($this->questionattempts);
197         return key($this->questionattempts);
198     }
200     /** @return int the number of questions that are currently in this usage. */
201     public function question_count() {
202         return count($this->questionattempts);
203     }
205     /**
206      * Note the part of the {@link question_usage_by_activity} comment that explains
207      * that {@link question_attempt} objects should be considered part of the inner
208      * workings of the question engine, and should not, if possible, be accessed directly.
209      *
210      * @return question_attempt_iterator for iterating over all the questions being
211      * attempted. as part of this usage.
212      */
213     public function get_attempt_iterator() {
214         return new question_attempt_iterator($this);
215     }
217     /**
218      * Check whether $number actually corresponds to a question attempt that is
219      * part of this usage. Throws an exception if not.
220      *
221      * @param int $slot a number allegedly identifying a question within this usage.
222      */
223     protected function check_slot($slot) {
224         if (!array_key_exists($slot, $this->questionattempts)) {
225             throw new coding_exception('There is no question_attempt number ' . $slot .
226                     ' in this attempt.');
227         }
228     }
230     /**
231      * Note the part of the {@link question_usage_by_activity} comment that explains
232      * that {@link question_attempt} objects should be considered part of the inner
233      * workings of the question engine, and should not, if possible, be accessed directly.
234      *
235      * @param int $slot the number used to identify this question within this usage.
236      * @return question_attempt the corresponding {@link question_attempt} object.
237      */
238     public function get_question_attempt($slot) {
239         $this->check_slot($slot);
240         return $this->questionattempts[$slot];
241     }
243     /**
244      * Get the current state of the attempt at a question.
245      * @param int $slot the number used to identify this question within this usage.
246      * @return question_state.
247      */
248     public function get_question_state($slot) {
249         return $this->get_question_attempt($slot)->get_state();
250     }
252     /**
253      * @param int $slot the number used to identify this question within this usage.
254      * @param bool $showcorrectness Whether right/partial/wrong states should
255      * be distinguised.
256      * @return string A brief textual description of the current state.
257      */
258     public function get_question_state_string($slot, $showcorrectness) {
259         return $this->get_question_attempt($slot)->get_state_string($showcorrectness);
260     }
262     /**
263      * @param int $slot the number used to identify this question within this usage.
264      * @param bool $showcorrectness Whether right/partial/wrong states should
265      * be distinguised.
266      * @return string a CSS class name for the current state.
267      */
268     public function get_question_state_class($slot, $showcorrectness) {
269         return $this->get_question_attempt($slot)->get_state_class($showcorrectness);
270     }
272     /**
273      * Get the time of the most recent action performed on a question.
274      * @param int $slot the number used to identify this question within this usage.
275      * @return int timestamp.
276      */
277     public function get_question_action_time($slot) {
278         return $this->get_question_attempt($slot)->get_last_action_time();
279     }
281     /**
282      * Get the current fraction awarded for the attempt at a question.
283      * @param int $slot the number used to identify this question within this usage.
284      * @return number|null The current fraction for this question, or null if one has
285      * not been assigned yet.
286      */
287     public function get_question_fraction($slot) {
288         return $this->get_question_attempt($slot)->get_fraction();
289     }
291     /**
292      * Get the current mark awarded for the attempt at a question.
293      * @param int $slot the number used to identify this question within this usage.
294      * @return number|null The current mark for this question, or null if one has
295      * not been assigned yet.
296      */
297     public function get_question_mark($slot) {
298         return $this->get_question_attempt($slot)->get_mark();
299     }
301     /**
302      * Get the maximum mark possible for the attempt at a question.
303      * @param int $slot the number used to identify this question within this usage.
304      * @return number the available marks for this question.
305      */
306     public function get_question_max_mark($slot) {
307         return $this->get_question_attempt($slot)->get_max_mark();
308     }
310     /**
311      * Get the current mark awarded for the attempt at a question.
312      * @param int $slot the number used to identify this question within this usage.
313      * @return number|null The current mark for this question, or null if one has
314      * not been assigned yet.
315      */
316     public function get_total_mark() {
317         $mark = 0;
318         foreach ($this->questionattempts as $qa) {
319             if ($qa->get_max_mark() > 0 && $qa->get_state() == question_state::$needsgrading) {
320                 return null;
321             }
322             $mark += $qa->get_mark();
323         }
324         return $mark;
325     }
327     /**
328      * @return string a simple textual summary of the question that was asked.
329      */
330     public function get_question_summary($slot) {
331         return $this->get_question_attempt($slot)->get_question_summary();
332     }
334     /**
335      * @return string a simple textual summary of response given.
336      */
337     public function get_response_summary($slot) {
338         return $this->get_question_attempt($slot)->get_response_summary();
339     }
341     /**
342      * @return string a simple textual summary of the correct resonse.
343      */
344     public function get_right_answer_summary($slot) {
345         return $this->get_question_attempt($slot)->get_right_answer_summary();
346     }
348     /**
349      * Get the {@link core_question_renderer}, in collaboration with appropriate
350      * {@link qbehaviour_renderer} and {@link qtype_renderer} subclasses, to generate the
351      * HTML to display this question.
352      * @param int $slot the number used to identify this question within this usage.
353      * @param question_display_options $options controls how the question is rendered.
354      * @param string|null $number The question number to display. 'i' is a special
355      *      value that gets displayed as Information. Null means no number is displayed.
356      * @return string HTML fragment representing the question.
357      */
358     public function render_question($slot, $options, $number = null) {
359         $options->context = $this->context;
360         return $this->get_question_attempt($slot)->render($options, $number);
361     }
363     /**
364      * Generate any bits of HTML that needs to go in the <head> tag when this question
365      * is displayed in the body.
366      * @param int $slot the number used to identify this question within this usage.
367      * @return string HTML fragment.
368      */
369     public function render_question_head_html($slot) {
370         //$options->context = $this->context;
371         return $this->get_question_attempt($slot)->render_head_html();
372     }
374     /**
375      * Like {@link render_question()} but displays the question at the past step
376      * indicated by $seq, rather than showing the latest step.
377      *
378      * @param int $slot the number used to identify this question within this usage.
379      * @param int $seq the seq number of the past state to display.
380      * @param question_display_options $options controls how the question is rendered.
381      * @param string|null $number The question number to display. 'i' is a special
382      *      value that gets displayed as Information. Null means no number is displayed.
383      * @return string HTML fragment representing the question.
384      */
385     public function render_question_at_step($slot, $seq, $options, $number = null) {
386         $options->context = $this->context;
387         return $this->get_question_attempt($slot)->render_at_step(
388                 $seq, $options, $number, $this->preferredbehaviour);
389     }
391     /**
392      * Checks whether the users is allow to be served a particular file.
393      * @param int $slot the number used to identify this question within this usage.
394      * @param question_display_options $options the options that control display of the question.
395      * @param string $component the name of the component we are serving files for.
396      * @param string $filearea the name of the file area.
397      * @param array $args the remaining bits of the file path.
398      * @param bool $forcedownload whether the user must be forced to download the file.
399      * @return bool true if the user can access this file.
400      */
401     public function check_file_access($slot, $options, $component, $filearea,
402             $args, $forcedownload) {
403         return $this->get_question_attempt($slot)->check_file_access(
404                 $options, $component, $filearea, $args, $forcedownload);
405     }
407     /**
408      * Replace a particular question_attempt with a different one.
409      *
410      * For internal use only. Used when reloading the state of a question from the
411      * database.
412      *
413      * @param array $records Raw records loaded from the database.
414      * @param int $questionattemptid The id of the question_attempt to extract.
415      * @return question_attempt The newly constructed question_attempt_step.
416      */
417     public function replace_loaded_question_attempt_info($slot, $qa) {
418         $this->check_slot($slot);
419         $this->questionattempts[$slot] = $qa;
420     }
422     /**
423      * You should probably not use this method in code outside the question engine.
424      * The main reason for exposing it was for the benefit of unit tests.
425      * @param int $slot the number used to identify this question within this usage.
426      * @return string return the prefix that is pre-pended to field names in the HTML
427      * that is output.
428      */
429     public function get_field_prefix($slot) {
430         return $this->get_question_attempt($slot)->get_field_prefix();
431     }
433     /**
434      * Get the number of variants available for the question in this slot.
435      * @param int $slot the number used to identify this question within this usage.
436      * @return int the number of variants available.
437      */
438     public function get_num_variants($slot) {
439         return $this->get_question_attempt($slot)->get_question()->get_num_variants();
440     }
442     /**
443      * Get the variant of the question being used in a given slot.
444      * @param int $slot the number used to identify this question within this usage.
445      * @return int the variant of this question that is being used.
446      */
447     public function get_variant($slot) {
448         return $this->get_question_attempt($slot)->get_variant();
449     }
451     /**
452      * Start the attempt at a question that has been added to this usage.
453      * @param int $slot the number used to identify this question within this usage.
454      * @param int $variant which variant of the question to use. Must be between
455      *      1 and ->get_num_variants($slot) inclusive. If not give, a variant is
456      *      chosen at random.
457      */
458     public function start_question($slot, $variant = null) {
459         if (is_null($variant)) {
460             $variant = rand(1, $this->get_num_variants($slot));
461         }
463         $qa = $this->get_question_attempt($slot);
464         $qa->start($this->preferredbehaviour, $variant);
465         $this->observer->notify_attempt_modified($qa);
466     }
468     /**
469      * Start the attempt at all questions that has been added to this usage.
470      * @param question_variant_selection_strategy how to pick which variant of each question to use.
471      * @param int $timestamp optional, the timstamp to record for this action. Defaults to now.
472      * @param int $userid optional, the user to attribute this action to. Defaults to the current user.
473      */
474     public function start_all_questions(question_variant_selection_strategy $variantstrategy = null,
475             $timestamp = null, $userid = null) {
476         if (is_null($variantstrategy)) {
477             $variantstrategy = new question_variant_random_strategy();
478         }
480         foreach ($this->questionattempts as $qa) {
481             $qa->start($this->preferredbehaviour, $qa->select_variant($variantstrategy));
482             $this->observer->notify_attempt_modified($qa);
483         }
484     }
486     /**
487      * Start the attempt at a question, starting from the point where the previous
488      * question_attempt $oldqa had reached. This is used by the quiz 'Each attempt
489      * builds on last' mode.
490      * @param int $slot the number used to identify this question within this usage.
491      * @param question_attempt $oldqa a previous attempt at this quetsion that
492      *      defines the starting point.
493      */
494     public function start_question_based_on($slot, question_attempt $oldqa) {
495         $qa = $this->get_question_attempt($slot);
496         $qa->start_based_on($oldqa);
497         $this->observer->notify_attempt_modified($qa);
498     }
500     /**
501      * Process all the question actions in the current request.
502      *
503      * If there is a parameter slots included in the post data, then only
504      * those question numbers will be processed, otherwise all questions in this
505      * useage will be.
506      *
507      * This function also does {@link update_question_flags()}.
508      *
509      * @param int $timestamp optional, use this timestamp as 'now'.
510      * @param array $postdata optional, only intended for testing. Use this data
511      * instead of the data from $_POST.
512      */
513     public function process_all_actions($timestamp = null, $postdata = null) {
514         foreach ($this->get_slots_in_request($postdata) as $slot) {
515             if (!$this->validate_sequence_number($slot, $postdata)) {
516                 continue;
517             }
518             $submitteddata = $this->extract_responses($slot, $postdata);
519             $this->process_action($slot, $submitteddata, $timestamp);
520         }
521         $this->update_question_flags($postdata);
522     }
524     /**
525      * Process all the question autosave data in the current request.
526      *
527      * If there is a parameter slots included in the post data, then only
528      * those question numbers will be processed, otherwise all questions in this
529      * useage will be.
530      *
531      * This function also does {@link update_question_flags()}.
532      *
533      * @param int $timestamp optional, use this timestamp as 'now'.
534      * @param array $postdata optional, only intended for testing. Use this data
535      * instead of the data from $_POST.
536      */
537     public function process_all_autosaves($timestamp = null, $postdata = null) {
538         foreach ($this->get_slots_in_request($postdata) as $slot) {
539             if (!$this->is_autosave_required($slot, $postdata)) {
540                 continue;
541             }
542             $submitteddata = $this->extract_responses($slot, $postdata);
543             $this->process_autosave($slot, $submitteddata, $timestamp);
544         }
545         $this->update_question_flags($postdata);
546     }
548     /**
549      * Get the list of slot numbers that should be processed as part of processing
550      * the current request.
551      * @param array $postdata optional, only intended for testing. Use this data
552      * instead of the data from $_POST.
553      * @return array of slot numbers.
554      */
555     protected function get_slots_in_request($postdata = null) {
556         // Note: we must not use "question_attempt::get_submitted_var()" because there is no attempt instance!!!
557         if (is_null($postdata)) {
558             $slots = optional_param('slots', null, PARAM_SEQUENCE);
559         } else if (array_key_exists('slots', $postdata)) {
560             $slots = clean_param($postdata['slots'], PARAM_SEQUENCE);
561         } else {
562             $slots = null;
563         }
564         if (is_null($slots)) {
565             $slots = $this->get_slots();
566         } else if (!$slots) {
567             $slots = array();
568         } else {
569             $slots = explode(',', $slots);
570         }
571         return $slots;
572     }
574     /**
575      * Get the submitted data from the current request that belongs to this
576      * particular question.
577      *
578      * @param int $slot the number used to identify this question within this usage.
579      * @param $postdata optional, only intended for testing. Use this data
580      * instead of the data from $_POST.
581      * @return array submitted data specific to this question.
582      */
583     public function extract_responses($slot, $postdata = null) {
584         return $this->get_question_attempt($slot)->get_submitted_data($postdata);
585     }
587     /**
588      * Transform an array of response data for slots to an array of post data as you would get from quiz attempt form.
589      *
590      * @param $simulatedresponses array keys are slot nos => contains arrays representing student
591      *                                   responses which will be passed to question_definition::prepare_simulated_post_data method
592      *                                   and then have the appropriate prefix added.
593      * @return array simulated post data
594      */
595     public function prepare_simulated_post_data($simulatedresponses) {
596         $simulatedpostdata = array();
597         $simulatedpostdata['slots'] = implode(',', array_keys($simulatedresponses));
598         foreach ($simulatedresponses as $slot => $responsedata) {
599             $prefix = $this->get_field_prefix($slot);
600             $slotresponse = $this->get_question($slot)->prepare_simulated_post_data($responsedata);
601             $slotresponse[':sequencecheck'] =  $this->get_question_attempt($slot)->get_sequence_check_count();
602             foreach ($slotresponse as $key => $value) {
603                 $simulatedpostdata[$prefix.$key] = $value;
604             }
605         }
606         return $simulatedpostdata;
607     }
609     /**
610      * Process a specific action on a specific question.
611      * @param int $slot the number used to identify this question within this usage.
612      * @param $submitteddata the submitted data that constitutes the action.
613      */
614     public function process_action($slot, $submitteddata, $timestamp = null) {
615         $qa = $this->get_question_attempt($slot);
616         $qa->process_action($submitteddata, $timestamp);
617         $this->observer->notify_attempt_modified($qa);
618     }
620     /**
621      * Process an autosave action on a specific question.
622      * @param int $slot the number used to identify this question within this usage.
623      * @param $submitteddata the submitted data that constitutes the action.
624      */
625     public function process_autosave($slot, $submitteddata, $timestamp = null) {
626         $qa = $this->get_question_attempt($slot);
627         if ($qa->process_autosave($submitteddata, $timestamp)) {
628             $this->observer->notify_attempt_modified($qa);
629         }
630     }
632     /**
633      * Check that the sequence number, that detects weird things like the student
634      * clicking back, is OK. If the sequence check variable is not present, returns
635      * false. If the check variable is present and correct, returns true. If the
636      * variable is present and wrong, throws an exception.
637      * @param int $slot the number used to identify this question within this usage.
638      * @param array $submitteddata the submitted data that constitutes the action.
639      * @return bool true if the check variable is present and correct. False if it
640      * is missing. (Throws an exception if the check fails.)
641      */
642     public function validate_sequence_number($slot, $postdata = null) {
643         $qa = $this->get_question_attempt($slot);
644         $sequencecheck = $qa->get_submitted_var(
645                 $qa->get_control_field_name('sequencecheck'), PARAM_INT, $postdata);
646         if (is_null($sequencecheck)) {
647             return false;
648         } else if ($sequencecheck != $qa->get_sequence_check_count()) {
649             throw new question_out_of_sequence_exception($this->id, $slot, $postdata);
650         } else {
651             return true;
652         }
653     }
655     /**
656      * Check, based on the sequence number, whether this auto-save is still required.
657      * @param int $slot the number used to identify this question within this usage.
658      * @param array $submitteddata the submitted data that constitutes the action.
659      * @return bool true if the check variable is present and correct, otherwise false.
660      */
661     public function is_autosave_required($slot, $postdata = null) {
662         $qa = $this->get_question_attempt($slot);
663         $sequencecheck = $qa->get_submitted_var(
664                 $qa->get_control_field_name('sequencecheck'), PARAM_INT, $postdata);
665         if (is_null($sequencecheck)) {
666             return false;
667         } else if ($sequencecheck != $qa->get_sequence_check_count()) {
668             return false;
669         } else {
670             return true;
671         }
672     }
674     /**
675      * Update the flagged state for all question_attempts in this usage, if their
676      * flagged state was changed in the request.
677      *
678      * @param $postdata optional, only intended for testing. Use this data
679      * instead of the data from $_POST.
680      */
681     public function update_question_flags($postdata = null) {
682         foreach ($this->questionattempts as $qa) {
683             $flagged = $qa->get_submitted_var(
684                     $qa->get_flag_field_name(), PARAM_BOOL, $postdata);
685             if (!is_null($flagged) && $flagged != $qa->is_flagged()) {
686                 $qa->set_flagged($flagged);
687             }
688         }
689     }
691     /**
692      * Get the correct response to a particular question. Passing the results of
693      * this method to {@link process_action()} will probably result in full marks.
694      * If it is not possible to compute a correct response, this method should return null.
695      * @param int $slot the number used to identify this question within this usage.
696      * @return array that constitutes a correct response to this question.
697      */
698     public function get_correct_response($slot) {
699         return $this->get_question_attempt($slot)->get_correct_response();
700     }
702     /**
703      * Finish the active phase of an attempt at a question.
704      *
705      * This is an external act of finishing the attempt. Think, for example, of
706      * the 'Submit all and finish' button in the quiz. Some behaviours,
707      * (for example, immediatefeedback) give a way of finishing the active phase
708      * of a question attempt as part of a {@link process_action()} call.
709      *
710      * After the active phase is over, the only changes possible are things like
711      * manual grading, or changing the flag state.
712      *
713      * @param int $slot the number used to identify this question within this usage.
714      */
715     public function finish_question($slot, $timestamp = null) {
716         $qa = $this->get_question_attempt($slot);
717         $qa->finish($timestamp);
718         $this->observer->notify_attempt_modified($qa);
719     }
721     /**
722      * Finish the active phase of an attempt at a question. See {@link finish_question()}
723      * for a fuller description of what 'finish' means.
724      */
725     public function finish_all_questions($timestamp = null) {
726         foreach ($this->questionattempts as $qa) {
727             $qa->finish($timestamp);
728             $this->observer->notify_attempt_modified($qa);
729         }
730     }
732     /**
733      * Perform a manual grading action on a question attempt.
734      * @param int $slot the number used to identify this question within this usage.
735      * @param string $comment the comment being added to the question attempt.
736      * @param number $mark the mark that is being assigned. Can be null to just
737      * add a comment.
738      * @param int $commentformat one of the FORMAT_... constants. The format of $comment.
739      */
740     public function manual_grade($slot, $comment, $mark, $commentformat = null) {
741         $qa = $this->get_question_attempt($slot);
742         $qa->manual_grade($comment, $mark, $commentformat);
743         $this->observer->notify_attempt_modified($qa);
744     }
746     /**
747      * Regrade a question in this usage. This replays the sequence of submitted
748      * actions to recompute the outcomes.
749      * @param int $slot the number used to identify this question within this usage.
750      * @param bool $finished whether the question attempt should be forced to be finished
751      *      after the regrade, or whether it may still be in progress (default false).
752      * @param number $newmaxmark (optional) if given, will change the max mark while regrading.
753      */
754     public function regrade_question($slot, $finished = false, $newmaxmark = null) {
755         $oldqa = $this->get_question_attempt($slot);
756         if (is_null($newmaxmark)) {
757             $newmaxmark = $oldqa->get_max_mark();
758         }
760         $newqa = new question_attempt($oldqa->get_question(), $oldqa->get_usage_id(),
761                 $this->observer, $newmaxmark);
762         $newqa->set_database_id($oldqa->get_database_id());
763         $newqa->set_slot($oldqa->get_slot());
764         $newqa->regrade($oldqa, $finished);
766         $this->questionattempts[$slot] = $newqa;
767         $this->observer->notify_attempt_modified($newqa);
768     }
770     /**
771      * Regrade all the questions in this usage (without changing their max mark).
772      * @param bool $finished whether each question should be forced to be finished
773      *      after the regrade, or whether it may still be in progress (default false).
774      */
775     public function regrade_all_questions($finished = false) {
776         foreach ($this->questionattempts as $slot => $notused) {
777             $this->regrade_question($slot, $finished);
778         }
779     }
781     /**
782      * Create a question_usage_by_activity from records loaded from the database.
783      *
784      * For internal use only.
785      *
786      * @param Iterator $records Raw records loaded from the database.
787      * @param int $questionattemptid The id of the question_attempt to extract.
788      * @return question_usage_by_activity The newly constructed usage.
789      */
790     public static function load_from_records($records, $qubaid) {
791         $record = $records->current();
792         while ($record->qubaid != $qubaid) {
793             $records->next();
794             if (!$records->valid()) {
795                 throw new coding_exception("Question usage $qubaid not found in the database.");
796             }
797             $record = $records->current();
798         }
800         $quba = new question_usage_by_activity($record->component,
801             context::instance_by_id($record->contextid, IGNORE_MISSING));
802         $quba->set_id_from_database($record->qubaid);
803         $quba->set_preferred_behaviour($record->preferredbehaviour);
805         $quba->observer = new question_engine_unit_of_work($quba);
807         // If slot is null then the current pointer in $records will not be
808         // advanced in the while loop below, and we get stuck in an infinite loop,
809         // since this method is supposed to always consume at least one record.
810         // Therefore, in this case, advance the record here.
811         if (is_null($record->slot)) {
812             $records->next();
813         }
815         while ($record && $record->qubaid == $qubaid && !is_null($record->slot)) {
816             $quba->questionattempts[$record->slot] =
817                     question_attempt::load_from_records($records,
818                     $record->questionattemptid, $quba->observer,
819                     $quba->get_preferred_behaviour());
820             if ($records->valid()) {
821                 $record = $records->current();
822             } else {
823                 $record = false;
824             }
825         }
827         return $quba;
828     }
832 /**
833  * A class abstracting access to the
834  * {@link question_usage_by_activity::$questionattempts} array.
835  *
836  * This class snapshots the list of {@link question_attempts} to iterate over
837  * when it is created. If a question is added to the usage mid-iteration, it
838  * will now show up.
839  *
840  * To create an instance of this class, use
841  * {@link question_usage_by_activity::get_attempt_iterator()}
842  *
843  * @copyright  2009 The Open University
844  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
845  */
846 class question_attempt_iterator implements Iterator, ArrayAccess {
847     /** @var question_usage_by_activity that we are iterating over. */
848     protected $quba;
849     /** @var array of question numbers. */
850     protected $slots;
852     /**
853      * To create an instance of this class, use
854      * {@link question_usage_by_activity::get_attempt_iterator()}.
855      * @param $quba the usage to iterate over.
856      */
857     public function __construct(question_usage_by_activity $quba) {
858         $this->quba = $quba;
859         $this->slots = $quba->get_slots();
860         $this->rewind();
861     }
863     /** @return question_attempt_step */
864     public function current() {
865         return $this->offsetGet(current($this->slots));
866     }
867     /** @return int */
868     public function key() {
869         return current($this->slots);
870     }
871     public function next() {
872         next($this->slots);
873     }
874     public function rewind() {
875         reset($this->slots);
876     }
877     /** @return bool */
878     public function valid() {
879         return current($this->slots) !== false;
880     }
882     /** @return bool */
883     public function offsetExists($slot) {
884         return in_array($slot, $this->slots);
885     }
886     /** @return question_attempt_step */
887     public function offsetGet($slot) {
888         return $this->quba->get_question_attempt($slot);
889     }
890     public function offsetSet($slot, $value) {
891         throw new coding_exception('You are only allowed read-only access to ' .
892                 'question_attempt::states through a question_attempt_step_iterator. Cannot set.');
893     }
894     public function offsetUnset($slot) {
895         throw new coding_exception('You are only allowed read-only access to ' .
896                 'question_attempt::states through a question_attempt_step_iterator. Cannot unset.');
897     }
901 /**
902  * Interface for things that want to be notified of signficant changes to a
903  * {@link question_usage_by_activity}.
904  *
905  * A question behaviour controls the flow of actions a student can
906  * take as they work through a question, and later, as a teacher manually grades it.
907  *
908  * @copyright  2009 The Open University
909  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
910  */
911 interface question_usage_observer {
912     /** Called when a field of the question_usage_by_activity is changed. */
913     public function notify_modified();
915     /**
916      * Called when the fields of a question attempt in this usage are modified.
917      * @param question_attempt $qa the newly added question attempt.
918      */
919     public function notify_attempt_modified(question_attempt $qa);
921     /**
922      * Called when a new question attempt is added to this usage.
923      * @param question_attempt $qa the newly added question attempt.
924      */
925     public function notify_attempt_added(question_attempt $qa);
927     /**
928      * Called when a new step is added to a question attempt in this usage.
929      * @param question_attempt_step $step the new step.
930      * @param question_attempt $qa the usage it is being added to.
931      * @param int $seq the sequence number of the new step.
932      */
933     public function notify_step_added(question_attempt_step $step, question_attempt $qa, $seq);
935     /**
936      * Called when a new step is updated in a question attempt in this usage.
937      * @param question_attempt_step $step the step that was updated.
938      * @param question_attempt $qa the usage it is being added to.
939      * @param int $seq the sequence number of the new step.
940      */
941     public function notify_step_modified(question_attempt_step $step, question_attempt $qa, $seq);
943     /**
944      * Called when a new step is updated in a question attempt in this usage.
945      * @param question_attempt_step $step the step to delete.
946      * @param question_attempt $qa the usage it is being added to.
947      */
948     public function notify_step_deleted(question_attempt_step $step, question_attempt $qa);
953 /**
954  * Null implmentation of the {@link question_usage_watcher} interface.
955  * Does nothing.
956  *
957  * @copyright  2009 The Open University
958  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
959  */
960 class question_usage_null_observer implements question_usage_observer {
961     public function notify_modified() {
962     }
963     public function notify_attempt_modified(question_attempt $qa) {
964     }
965     public function notify_attempt_added(question_attempt $qa) {
966     }
967     public function notify_step_added(question_attempt_step $step, question_attempt $qa, $seq) {
968     }
969     public function notify_step_modified(question_attempt_step $step, question_attempt $qa, $seq) {
970     }
971     public function notify_step_deleted(question_attempt_step $step, question_attempt $qa) {
972     }