Merge branch 'master_MDL-31360' of git://github.com/danmarsden/moodle
[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 object 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 object 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         $qa->set_slot(end(array_keys($this->questionattempts)));
175         $this->observer->notify_attempt_added($qa);
176         return $qa->get_slot();
177     }
179     /**
180      * Get the question_definition for a question in this attempt.
181      * @param int $slot the number used to identify this question within this usage.
182      * @return question_definition the requested question object.
183      */
184     public function get_question($slot) {
185         return $this->get_question_attempt($slot)->get_question();
186     }
188     /** @return array all the identifying numbers of all the questions in this usage. */
189     public function get_slots() {
190         return array_keys($this->questionattempts);
191     }
193     /** @return int the identifying number of the first question that was added to this usage. */
194     public function get_first_question_number() {
195         reset($this->questionattempts);
196         return key($this->questionattempts);
197     }
199     /** @return int the number of questions that are currently in this usage. */
200     public function question_count() {
201         return count($this->questionattempts);
202     }
204     /**
205      * Note the part of the {@link question_usage_by_activity} comment that explains
206      * that {@link question_attempt} objects should be considered part of the inner
207      * workings of the question engine, and should not, if possible, be accessed directly.
208      *
209      * @return question_attempt_iterator for iterating over all the questions being
210      * attempted. as part of this usage.
211      */
212     public function get_attempt_iterator() {
213         return new question_attempt_iterator($this);
214     }
216     /**
217      * Check whether $number actually corresponds to a question attempt that is
218      * part of this usage. Throws an exception if not.
219      *
220      * @param int $slot a number allegedly identifying a question within this usage.
221      */
222     protected function check_slot($slot) {
223         if (!array_key_exists($slot, $this->questionattempts)) {
224             throw new coding_exception('There is no question_attempt number ' . $slot .
225                     ' in this attempt.');
226         }
227     }
229     /**
230      * Note the part of the {@link question_usage_by_activity} comment that explains
231      * that {@link question_attempt} objects should be considered part of the inner
232      * workings of the question engine, and should not, if possible, be accessed directly.
233      *
234      * @param int $slot the number used to identify this question within this usage.
235      * @return question_attempt the corresponding {@link question_attempt} object.
236      */
237     public function get_question_attempt($slot) {
238         $this->check_slot($slot);
239         return $this->questionattempts[$slot];
240     }
242     /**
243      * Get the current state of the attempt at a question.
244      * @param int $slot the number used to identify this question within this usage.
245      * @return question_state.
246      */
247     public function get_question_state($slot) {
248         return $this->get_question_attempt($slot)->get_state();
249     }
251     /**
252      * @param int $slot the number used to identify this question within this usage.
253      * @param bool $showcorrectness Whether right/partial/wrong states should
254      * be distinguised.
255      * @return string A brief textual description of the current state.
256      */
257     public function get_question_state_string($slot, $showcorrectness) {
258         return $this->get_question_attempt($slot)->get_state_string($showcorrectness);
259     }
261     /**
262      * @param int $slot the number used to identify this question within this usage.
263      * @param bool $showcorrectness Whether right/partial/wrong states should
264      * be distinguised.
265      * @return string a CSS class name for the current state.
266      */
267     public function get_question_state_class($slot, $showcorrectness) {
268         return $this->get_question_attempt($slot)->get_state_class($showcorrectness);
269     }
271     /**
272      * Get the time of the most recent action performed on a question.
273      * @param int $slot the number used to identify this question within this usage.
274      * @return int timestamp.
275      */
276     public function get_question_action_time($slot) {
277         return $this->get_question_attempt($slot)->get_last_action_time();
278     }
280     /**
281      * Get the current fraction awarded for the attempt at a question.
282      * @param int $slot the number used to identify this question within this usage.
283      * @return number|null The current fraction for this question, or null if one has
284      * not been assigned yet.
285      */
286     public function get_question_fraction($slot) {
287         return $this->get_question_attempt($slot)->get_fraction();
288     }
290     /**
291      * Get the current mark awarded for the attempt at a question.
292      * @param int $slot the number used to identify this question within this usage.
293      * @return number|null The current mark for this question, or null if one has
294      * not been assigned yet.
295      */
296     public function get_question_mark($slot) {
297         return $this->get_question_attempt($slot)->get_mark();
298     }
300     /**
301      * Get the maximum mark possible for the attempt at a question.
302      * @param int $slot the number used to identify this question within this usage.
303      * @return number the available marks for this question.
304      */
305     public function get_question_max_mark($slot) {
306         return $this->get_question_attempt($slot)->get_max_mark();
307     }
309     /**
310      * Get the current mark awarded for the attempt at a question.
311      * @param int $slot the number used to identify this question within this usage.
312      * @return number|null The current mark for this question, or null if one has
313      * not been assigned yet.
314      */
315     public function get_total_mark() {
316         $mark = 0;
317         foreach ($this->questionattempts as $qa) {
318             if ($qa->get_max_mark() > 0 && $qa->get_state() == question_state::$needsgrading) {
319                 return null;
320             }
321             $mark += $qa->get_mark();
322         }
323         return $mark;
324     }
326     /**
327      * @return string a simple textual summary of the question that was asked.
328      */
329     public function get_question_summary($slot) {
330         return $this->get_question_attempt($slot)->get_question_summary();
331     }
333     /**
334      * @return string a simple textual summary of response given.
335      */
336     public function get_response_summary($slot) {
337         return $this->get_question_attempt($slot)->get_response_summary();
338     }
340     /**
341      * @return string a simple textual summary of the correct resonse.
342      */
343     public function get_right_answer_summary($slot) {
344         return $this->get_question_attempt($slot)->get_right_answer_summary();
345     }
347     /**
348      * Get the {@link core_question_renderer}, in collaboration with appropriate
349      * {@link qbehaviour_renderer} and {@link qtype_renderer} subclasses, to generate the
350      * HTML to display this question.
351      * @param int $slot the number used to identify this question within this usage.
352      * @param question_display_options $options controls how the question is rendered.
353      * @param string|null $number The question number to display. 'i' is a special
354      *      value that gets displayed as Information. Null means no number is displayed.
355      * @return string HTML fragment representing the question.
356      */
357     public function render_question($slot, $options, $number = null) {
358         $options->context = $this->context;
359         return $this->get_question_attempt($slot)->render($options, $number);
360     }
362     /**
363      * Generate any bits of HTML that needs to go in the <head> tag when this question
364      * is displayed in the body.
365      * @param int $slot the number used to identify this question within this usage.
366      * @return string HTML fragment.
367      */
368     public function render_question_head_html($slot) {
369         //$options->context = $this->context;
370         return $this->get_question_attempt($slot)->render_head_html();
371     }
373     /**
374      * Like {@link render_question()} but displays the question at the past step
375      * indicated by $seq, rather than showing the latest step.
376      *
377      * @param int $slot the number used to identify this question within this usage.
378      * @param int $seq the seq number of the past state to display.
379      * @param question_display_options $options controls how the question is rendered.
380      * @param string|null $number The question number to display. 'i' is a special
381      *      value that gets displayed as Information. Null means no number is displayed.
382      * @return string HTML fragment representing the question.
383      */
384     public function render_question_at_step($slot, $seq, $options, $number = null) {
385         $options->context = $this->context;
386         return $this->get_question_attempt($slot)->render_at_step(
387                 $seq, $options, $number, $this->preferredbehaviour);
388     }
390     /**
391      * Checks whether the users is allow to be served a particular file.
392      * @param int $slot the number used to identify this question within this usage.
393      * @param question_display_options $options the options that control display of the question.
394      * @param string $component the name of the component we are serving files for.
395      * @param string $filearea the name of the file area.
396      * @param array $args the remaining bits of the file path.
397      * @param bool $forcedownload whether the user must be forced to download the file.
398      * @return bool true if the user can access this file.
399      */
400     public function check_file_access($slot, $options, $component, $filearea,
401             $args, $forcedownload) {
402         return $this->get_question_attempt($slot)->check_file_access(
403                 $options, $component, $filearea, $args, $forcedownload);
404     }
406     /**
407      * Replace a particular question_attempt with a different one.
408      *
409      * For internal use only. Used when reloading the state of a question from the
410      * database.
411      *
412      * @param array $records Raw records loaded from the database.
413      * @param int $questionattemptid The id of the question_attempt to extract.
414      * @return question_attempt The newly constructed question_attempt_step.
415      */
416     public function replace_loaded_question_attempt_info($slot, $qa) {
417         $this->check_slot($slot);
418         $this->questionattempts[$slot] = $qa;
419     }
421     /**
422      * You should probably not use this method in code outside the question engine.
423      * The main reason for exposing it was for the benefit of unit tests.
424      * @param int $slot the number used to identify this question within this usage.
425      * @return string return the prefix that is pre-pended to field names in the HTML
426      * that is output.
427      */
428     public function get_field_prefix($slot) {
429         return $this->get_question_attempt($slot)->get_field_prefix();
430     }
432     /**
433      * Get the number of variants available for the question in this slot.
434      * @param int $slot the number used to identify this question within this usage.
435      * @return int the number of variants available.
436      */
437     public function get_num_variants($slot) {
438         return $this->get_question_attempt($slot)->get_question()->get_num_variants();
439     }
441     /**
442      * Get the variant of the question being used in a given slot.
443      * @param int $slot the number used to identify this question within this usage.
444      * @return int the variant of this question that is being used.
445      */
446     public function get_variant($slot) {
447         return $this->get_question_attempt($slot)->get_variant();
448     }
450     /**
451      * Start the attempt at a question that has been added to this usage.
452      * @param int $slot the number used to identify this question within this usage.
453      * @param int $variant which variant of the question to use. Must be between
454      *      1 and ->get_num_variants($slot) inclusive. If not give, a variant is
455      *      chosen at random.
456      */
457     public function start_question($slot, $variant = null) {
458         if (is_null($variant)) {
459             $variant = rand(1, $this->get_num_variants($slot));
460         }
462         $qa = $this->get_question_attempt($slot);
463         $qa->start($this->preferredbehaviour, $variant);
464         $this->observer->notify_attempt_modified($qa);
465     }
467     /**
468      * Start the attempt at all questions that has been added to this usage.
469      * @param question_variant_selection_strategy how to pick which variant of each question to use.
470      * @param int $timestamp optional, the timstamp to record for this action. Defaults to now.
471      * @param int $userid optional, the user to attribute this action to. Defaults to the current user.
472      */
473     public function start_all_questions(question_variant_selection_strategy $variantstrategy = null,
474             $timestamp = null, $userid = null) {
475         if (is_null($variantstrategy)) {
476             $variantstrategy = new question_variant_random_strategy();
477         }
479         foreach ($this->questionattempts as $qa) {
480             $qa->start($this->preferredbehaviour, $qa->select_variant($variantstrategy));
481             $this->observer->notify_attempt_modified($qa);
482         }
483     }
485     /**
486      * Start the attempt at a question, starting from the point where the previous
487      * question_attempt $oldqa had reached. This is used by the quiz 'Each attempt
488      * builds on last' mode.
489      * @param int $slot the number used to identify this question within this usage.
490      * @param question_attempt $oldqa a previous attempt at this quetsion that
491      *      defines the starting point.
492      */
493     public function start_question_based_on($slot, question_attempt $oldqa) {
494         $qa = $this->get_question_attempt($slot);
495         $qa->start_based_on($oldqa);
496         $this->observer->notify_attempt_modified($qa);
497     }
499     /**
500      * Process all the question actions in the current request.
501      *
502      * If there is a parameter slots included in the post data, then only
503      * those question numbers will be processed, otherwise all questions in this
504      * useage will be.
505      *
506      * This function also does {@link update_question_flags()}.
507      *
508      * @param int $timestamp optional, use this timestamp as 'now'.
509      * @param array $postdata optional, only intended for testing. Use this data
510      * instead of the data from $_POST.
511      */
512     public function process_all_actions($timestamp = null, $postdata = null) {
513         $slots = question_attempt::get_submitted_var('slots', PARAM_SEQUENCE, $postdata);
514         if (is_null($slots)) {
515             $slots = $this->get_slots();
516         } else if (!$slots) {
517             $slots = array();
518         } else {
519             $slots = explode(',', $slots);
520         }
521         foreach ($slots as $slot) {
522             if (!$this->validate_sequence_number($slot, $postdata)) {
523                 continue;
524             }
525             $submitteddata = $this->extract_responses($slot, $postdata);
526             $this->process_action($slot, $submitteddata, $timestamp);
527         }
528         $this->update_question_flags($postdata);
529     }
531     /**
532      * Get the submitted data from the current request that belongs to this
533      * particular question.
534      *
535      * @param int $slot the number used to identify this question within this usage.
536      * @param $postdata optional, only intended for testing. Use this data
537      * instead of the data from $_POST.
538      * @return array submitted data specific to this question.
539      */
540     public function extract_responses($slot, $postdata = null) {
541         return $this->get_question_attempt($slot)->get_submitted_data($postdata);
542     }
544     /**
545      * Process a specific action on a specific question.
546      * @param int $slot the number used to identify this question within this usage.
547      * @param $submitteddata the submitted data that constitutes the action.
548      */
549     public function process_action($slot, $submitteddata, $timestamp = null) {
550         $qa = $this->get_question_attempt($slot);
551         $qa->process_action($submitteddata, $timestamp);
552         $this->observer->notify_attempt_modified($qa);
553     }
555     /**
556      * Check that the sequence number, that detects weird things like the student
557      * clicking back, is OK. If the sequence check variable is not present, returns
558      * false. If the check variable is present and correct, returns true. If the
559      * variable is present and wrong, throws an exception.
560      * @param int $slot the number used to identify this question within this usage.
561      * @param array $submitteddata the submitted data that constitutes the action.
562      * @return bool true if the check variable is present and correct. False if it
563      * is missing. (Throws an exception if the check fails.)
564      */
565     public function validate_sequence_number($slot, $postdata = null) {
566         $qa = $this->get_question_attempt($slot);
567         $sequencecheck = $qa->get_submitted_var(
568                 $qa->get_control_field_name('sequencecheck'), PARAM_INT, $postdata);
569         if (is_null($sequencecheck)) {
570             return false;
571         } else if ($sequencecheck != $qa->get_num_steps()) {
572             throw new question_out_of_sequence_exception($this->id, $slot, $postdata);
573         } else {
574             return true;
575         }
576     }
577     /**
578      * Update the flagged state for all question_attempts in this usage, if their
579      * flagged state was changed in the request.
580      *
581      * @param $postdata optional, only intended for testing. Use this data
582      * instead of the data from $_POST.
583      */
584     public function update_question_flags($postdata = null) {
585         foreach ($this->questionattempts as $qa) {
586             $flagged = $qa->get_submitted_var(
587                     $qa->get_flag_field_name(), PARAM_BOOL, $postdata);
588             if (!is_null($flagged) && $flagged != $qa->is_flagged()) {
589                 $qa->set_flagged($flagged);
590             }
591         }
592     }
594     /**
595      * Get the correct response to a particular question. Passing the results of
596      * this method to {@link process_action()} will probably result in full marks.
597      * If it is not possible to compute a correct response, this method should return null.
598      * @param int $slot the number used to identify this question within this usage.
599      * @return array that constitutes a correct response to this question.
600      */
601     public function get_correct_response($slot) {
602         return $this->get_question_attempt($slot)->get_correct_response();
603     }
605     /**
606      * Finish the active phase of an attempt at a question.
607      *
608      * This is an external act of finishing the attempt. Think, for example, of
609      * the 'Submit all and finish' button in the quiz. Some behaviours,
610      * (for example, immediatefeedback) give a way of finishing the active phase
611      * of a question attempt as part of a {@link process_action()} call.
612      *
613      * After the active phase is over, the only changes possible are things like
614      * manual grading, or changing the flag state.
615      *
616      * @param int $slot the number used to identify this question within this usage.
617      */
618     public function finish_question($slot, $timestamp = null) {
619         $qa = $this->get_question_attempt($slot);
620         $qa->finish($timestamp);
621         $this->observer->notify_attempt_modified($qa);
622     }
624     /**
625      * Finish the active phase of an attempt at a question. See {@link finish_question()}
626      * for a fuller description of what 'finish' means.
627      */
628     public function finish_all_questions($timestamp = null) {
629         foreach ($this->questionattempts as $qa) {
630             $qa->finish($timestamp);
631             $this->observer->notify_attempt_modified($qa);
632         }
633     }
635     /**
636      * Perform a manual grading action on a question attempt.
637      * @param int $slot the number used to identify this question within this usage.
638      * @param string $comment the comment being added to the question attempt.
639      * @param number $mark the mark that is being assigned. Can be null to just
640      * add a comment.
641      */
642     public function manual_grade($slot, $comment, $mark) {
643         $qa = $this->get_question_attempt($slot);
644         $qa->manual_grade($comment, $mark);
645         $this->observer->notify_attempt_modified($qa);
646     }
648     /**
649      * Regrade a question in this usage. This replays the sequence of submitted
650      * actions to recompute the outcomes.
651      * @param int $slot the number used to identify this question within this usage.
652      * @param bool $finished whether the question attempt should be forced to be finished
653      *      after the regrade, or whether it may still be in progress (default false).
654      * @param number $newmaxmark (optional) if given, will change the max mark while regrading.
655      */
656     public function regrade_question($slot, $finished = false, $newmaxmark = null) {
657         $oldqa = $this->get_question_attempt($slot);
658         if (is_null($newmaxmark)) {
659             $newmaxmark = $oldqa->get_max_mark();
660         }
662         $newqa = new question_attempt($oldqa->get_question(), $oldqa->get_usage_id(),
663                 $this->observer, $newmaxmark);
664         $newqa->set_database_id($oldqa->get_database_id());
665         $newqa->set_slot($oldqa->get_slot());
666         $newqa->regrade($oldqa, $finished);
668         $this->questionattempts[$slot] = $newqa;
669         $this->observer->notify_attempt_modified($newqa);
670     }
672     /**
673      * Regrade all the questions in this usage (without changing their max mark).
674      * @param bool $finished whether each question should be forced to be finished
675      *      after the regrade, or whether it may still be in progress (default false).
676      */
677     public function regrade_all_questions($finished = false) {
678         foreach ($this->questionattempts as $slot => $notused) {
679             $this->regrade_question($slot, $finished);
680         }
681     }
683     /**
684      * Create a question_usage_by_activity from records loaded from the database.
685      *
686      * For internal use only.
687      *
688      * @param Iterator $records Raw records loaded from the database.
689      * @param int $questionattemptid The id of the question_attempt to extract.
690      * @return question_usage_by_activity The newly constructed usage.
691      */
692     public static function load_from_records($records, $qubaid) {
693         $record = $records->current();
694         while ($record->qubaid != $qubaid) {
695             $records->next();
696             if (!$records->valid()) {
697                 throw new coding_exception("Question usage $qubaid not found in the database.");
698             }
699             $record = $records->current();
700         }
702         $quba = new question_usage_by_activity($record->component,
703             get_context_instance_by_id($record->contextid));
704         $quba->set_id_from_database($record->qubaid);
705         $quba->set_preferred_behaviour($record->preferredbehaviour);
707         $quba->observer = new question_engine_unit_of_work($quba);
709         while ($record && $record->qubaid == $qubaid && !is_null($record->slot)) {
710             $quba->questionattempts[$record->slot] =
711                     question_attempt::load_from_records($records,
712                     $record->questionattemptid, $quba->observer,
713                     $quba->get_preferred_behaviour());
714             if ($records->valid()) {
715                 $record = $records->current();
716             } else {
717                 $record = false;
718             }
719         }
721         return $quba;
722     }
726 /**
727  * A class abstracting access to the
728  * {@link question_usage_by_activity::$questionattempts} array.
729  *
730  * This class snapshots the list of {@link question_attempts} to iterate over
731  * when it is created. If a question is added to the usage mid-iteration, it
732  * will now show up.
733  *
734  * To create an instance of this class, use
735  * {@link question_usage_by_activity::get_attempt_iterator()}
736  *
737  * @copyright  2009 The Open University
738  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
739  */
740 class question_attempt_iterator implements Iterator, ArrayAccess {
741     /** @var question_usage_by_activity that we are iterating over. */
742     protected $quba;
743     /** @var array of question numbers. */
744     protected $slots;
746     /**
747      * To create an instance of this class, use
748      * {@link question_usage_by_activity::get_attempt_iterator()}.
749      * @param $quba the usage to iterate over.
750      */
751     public function __construct(question_usage_by_activity $quba) {
752         $this->quba = $quba;
753         $this->slots = $quba->get_slots();
754         $this->rewind();
755     }
757     /** @return question_attempt_step */
758     public function current() {
759         return $this->offsetGet(current($this->slots));
760     }
761     /** @return int */
762     public function key() {
763         return current($this->slots);
764     }
765     public function next() {
766         next($this->slots);
767     }
768     public function rewind() {
769         reset($this->slots);
770     }
771     /** @return bool */
772     public function valid() {
773         return current($this->slots) !== false;
774     }
776     /** @return bool */
777     public function offsetExists($slot) {
778         return in_array($slot, $this->slots);
779     }
780     /** @return question_attempt_step */
781     public function offsetGet($slot) {
782         return $this->quba->get_question_attempt($slot);
783     }
784     public function offsetSet($slot, $value) {
785         throw new coding_exception('You are only allowed read-only access to ' .
786                 'question_attempt::states through a question_attempt_step_iterator. Cannot set.');
787     }
788     public function offsetUnset($slot) {
789         throw new coding_exception('You are only allowed read-only access to ' .
790                 'question_attempt::states through a question_attempt_step_iterator. Cannot unset.');
791     }
795 /**
796  * Interface for things that want to be notified of signficant changes to a
797  * {@link question_usage_by_activity}.
798  *
799  * A question behaviour controls the flow of actions a student can
800  * take as they work through a question, and later, as a teacher manually grades it.
801  *
802  * @copyright  2009 The Open University
803  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
804  */
805 interface question_usage_observer {
806     /** Called when a field of the question_usage_by_activity is changed. */
807     public function notify_modified();
809     /**
810      * Called when the fields of a question attempt in this usage are modified.
811      * @param question_attempt $qa the newly added question attempt.
812      */
813     public function notify_attempt_modified(question_attempt $qa);
815     /**
816      * Called when a new question attempt is added to this usage.
817      * @param question_attempt $qa the newly added question attempt.
818      */
819     public function notify_attempt_added(question_attempt $qa);
821     /**
822      * Called when a new step is added to a question attempt in this usage.
823      * @param question_attempt_step $step the new step.
824      * @param question_attempt $qa the usage it is being added to.
825      * @param int $seq the sequence number of the new step.
826      */
827     public function notify_step_added(question_attempt_step $step, question_attempt $qa, $seq);
829     /**
830      * Called when a new step is updated in a question attempt in this usage.
831      * @param question_attempt_step $step the step that was updated.
832      * @param question_attempt $qa the usage it is being added to.
833      * @param int $seq the sequence number of the new step.
834      */
835     public function notify_step_modified(question_attempt_step $step, question_attempt $qa, $seq);
837     /**
838      * Called when a new step is updated in a question attempt in this usage.
839      * @param question_attempt_step $step the step to delete.
840      * @param question_attempt $qa the usage it is being added to.
841      */
842     public function notify_step_deleted(question_attempt_step $step, question_attempt $qa);
847 /**
848  * Null implmentation of the {@link question_usage_watcher} interface.
849  * Does nothing.
850  *
851  * @copyright  2009 The Open University
852  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
853  */
854 class question_usage_null_observer implements question_usage_observer {
855     public function notify_modified() {
856     }
857     public function notify_attempt_modified(question_attempt $qa) {
858     }
859     public function notify_attempt_added(question_attempt $qa) {
860     }
861     public function notify_step_added(question_attempt_step $step, question_attempt $qa, $seq) {
862     }
863     public function notify_step_modified(question_attempt_step $step, question_attempt $qa, $seq) {
864     }
865     public function notify_step_deleted(question_attempt_step $step, question_attempt $qa) {
866     }