0eefb5079d0f691aee56e485795fefdfc83d8f15
[moodle.git] / mod / lesson / locallib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Local library file for Lesson.  These are non-standard functions that are used
20  * only by Lesson.
21  *
22  * @package    mod
23  * @subpackage lesson
24  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
25  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or late
26  **/
28 /** Make sure this isn't being directly accessed */
29 defined('MOODLE_INTERNAL') || die();
31 /** Include the files that are required by this module */
32 require_once($CFG->dirroot.'/course/moodleform_mod.php');
33 require_once($CFG->dirroot . '/mod/lesson/lib.php');
34 require_once($CFG->libdir . '/filelib.php');
36 /** This page */
37 define('LESSON_THISPAGE', 0);
38 /** Next page -> any page not seen before */
39 define("LESSON_UNSEENPAGE", 1);
40 /** Next page -> any page not answered correctly */
41 define("LESSON_UNANSWEREDPAGE", 2);
42 /** Jump to Next Page */
43 define("LESSON_NEXTPAGE", -1);
44 /** End of Lesson */
45 define("LESSON_EOL", -9);
46 /** Jump to an unseen page within a branch and end of branch or end of lesson */
47 define("LESSON_UNSEENBRANCHPAGE", -50);
48 /** Jump to Previous Page */
49 define("LESSON_PREVIOUSPAGE", -40);
50 /** Jump to a random page within a branch and end of branch or end of lesson */
51 define("LESSON_RANDOMPAGE", -60);
52 /** Jump to a random Branch */
53 define("LESSON_RANDOMBRANCH", -70);
54 /** Cluster Jump */
55 define("LESSON_CLUSTERJUMP", -80);
56 /** Undefined */
57 define("LESSON_UNDEFINED", -99);
59 /** LESSON_MAX_EVENT_LENGTH = 432000 ; 5 days maximum */
60 define("LESSON_MAX_EVENT_LENGTH", "432000");
63 //////////////////////////////////////////////////////////////////////////////////////
64 /// Any other lesson functions go here.  Each of them must have a name that
65 /// starts with lesson_
67 /**
68  * Checks to see if a LESSON_CLUSTERJUMP or
69  * a LESSON_UNSEENBRANCHPAGE is used in a lesson.
70  *
71  * This function is only executed when a teacher is
72  * checking the navigation for a lesson.
73  *
74  * @param stdClass $lesson Id of the lesson that is to be checked.
75  * @return boolean True or false.
76  **/
77 function lesson_display_teacher_warning($lesson) {
78     global $DB;
80     // get all of the lesson answers
81     $params = array ("lessonid" => $lesson->id);
82     if (!$lessonanswers = $DB->get_records_select("lesson_answers", "lessonid = :lessonid", $params)) {
83         // no answers, then not using cluster or unseen
84         return false;
85     }
86     // just check for the first one that fulfills the requirements
87     foreach ($lessonanswers as $lessonanswer) {
88         if ($lessonanswer->jumpto == LESSON_CLUSTERJUMP || $lessonanswer->jumpto == LESSON_UNSEENBRANCHPAGE) {
89             return true;
90         }
91     }
93     // if no answers use either of the two jumps
94     return false;
95 }
97 /**
98  * Interprets the LESSON_UNSEENBRANCHPAGE jump.
99  *
100  * will return the pageid of a random unseen page that is within a branch
101  *
102  * @param lesson $lesson
103  * @param int $userid Id of the user.
104  * @param int $pageid Id of the page from which we are jumping.
105  * @return int Id of the next page.
106  **/
107 function lesson_unseen_question_jump($lesson, $user, $pageid) {
108     global $DB;
110     // get the number of retakes
111     if (!$retakes = $DB->count_records("lesson_grades", array("lessonid"=>$lesson->id, "userid"=>$user))) {
112         $retakes = 0;
113     }
115     // get all the lesson_attempts aka what the user has seen
116     if ($viewedpages = $DB->get_records("lesson_attempts", array("lessonid"=>$lesson->id, "userid"=>$user, "retry"=>$retakes), "timeseen DESC")) {
117         foreach($viewedpages as $viewed) {
118             $seenpages[] = $viewed->pageid;
119         }
120     } else {
121         $seenpages = array();
122     }
124     // get the lesson pages
125     $lessonpages = $lesson->load_all_pages();
127     if ($pageid == LESSON_UNSEENBRANCHPAGE) {  // this only happens when a student leaves in the middle of an unseen question within a branch series
128         $pageid = $seenpages[0];  // just change the pageid to the last page viewed inside the branch table
129     }
131     // go up the pages till branch table
132     while ($pageid != 0) { // this condition should never be satisfied... only happens if there are no branch tables above this page
133         if ($lessonpages[$pageid]->qtype == LESSON_PAGE_BRANCHTABLE) {
134             break;
135         }
136         $pageid = $lessonpages[$pageid]->prevpageid;
137     }
139     $pagesinbranch = $lesson->get_sub_pages_of($pageid, array(LESSON_PAGE_BRANCHTABLE, LESSON_PAGE_ENDOFBRANCH));
141     // this foreach loop stores all the pages that are within the branch table but are not in the $seenpages array
142     $unseen = array();
143     foreach($pagesinbranch as $page) {
144         if (!in_array($page->id, $seenpages)) {
145             $unseen[] = $page->id;
146         }
147     }
149     if(count($unseen) == 0) {
150         if(isset($pagesinbranch)) {
151             $temp = end($pagesinbranch);
152             $nextpage = $temp->nextpageid; // they have seen all the pages in the branch, so go to EOB/next branch table/EOL
153         } else {
154             // there are no pages inside the branch, so return the next page
155             $nextpage = $lessonpages[$pageid]->nextpageid;
156         }
157         if ($nextpage == 0) {
158             return LESSON_EOL;
159         } else {
160             return $nextpage;
161         }
162     } else {
163         return $unseen[rand(0, count($unseen)-1)];  // returns a random page id for the next page
164     }
167 /**
168  * Handles the unseen branch table jump.
169  *
170  * @param lesson $lesson
171  * @param int $userid User id.
172  * @return int Will return the page id of a branch table or end of lesson
173  **/
174 function lesson_unseen_branch_jump($lesson, $userid) {
175     global $DB;
177     if (!$retakes = $DB->count_records("lesson_grades", array("lessonid"=>$lesson->id, "userid"=>$userid))) {
178         $retakes = 0;
179     }
181     $params = array ("lessonid" => $lesson->id, "userid" => $userid, "retry" => $retakes);
182     if (!$seenbranches = $DB->get_records_select("lesson_branch", "lessonid = :lessonid AND userid = :userid AND retry = :retry", $params,
183                 "timeseen DESC")) {
184         print_error('cannotfindrecords', 'lesson');
185     }
187     // get the lesson pages
188     $lessonpages = $lesson->load_all_pages();
190     // this loads all the viewed branch tables into $seen until it finds the branch table with the flag
191     // which is the branch table that starts the unseenbranch function
192     $seen = array();
193     foreach ($seenbranches as $seenbranch) {
194         if (!$seenbranch->flag) {
195             $seen[$seenbranch->pageid] = $seenbranch->pageid;
196         } else {
197             $start = $seenbranch->pageid;
198             break;
199         }
200     }
201     // this function searches through the lesson pages to find all the branch tables
202     // that follow the flagged branch table
203     $pageid = $lessonpages[$start]->nextpageid; // move down from the flagged branch table
204     $branchtables = array();
205     while ($pageid != 0) {  // grab all of the branch table till eol
206         if ($lessonpages[$pageid]->qtype == LESSON_PAGE_BRANCHTABLE) {
207             $branchtables[] = $lessonpages[$pageid]->id;
208         }
209         $pageid = $lessonpages[$pageid]->nextpageid;
210     }
211     $unseen = array();
212     foreach ($branchtables as $branchtable) {
213         // load all of the unseen branch tables into unseen
214         if (!array_key_exists($branchtable, $seen)) {
215             $unseen[] = $branchtable;
216         }
217     }
218     if (count($unseen) > 0) {
219         return $unseen[rand(0, count($unseen)-1)];  // returns a random page id for the next page
220     } else {
221         return LESSON_EOL;  // has viewed all of the branch tables
222     }
225 /**
226  * Handles the random jump between a branch table and end of branch or end of lesson (LESSON_RANDOMPAGE).
227  *
228  * @param lesson $lesson
229  * @param int $pageid The id of the page that we are jumping from (?)
230  * @return int The pageid of a random page that is within a branch table
231  **/
232 function lesson_random_question_jump($lesson, $pageid) {
233     global $DB;
235     // get the lesson pages
236     $params = array ("lessonid" => $lesson->id);
237     if (!$lessonpages = $DB->get_records_select("lesson_pages", "lessonid = :lessonid", $params)) {
238         print_error('cannotfindpages', 'lesson');
239     }
241     // go up the pages till branch table
242     while ($pageid != 0) { // this condition should never be satisfied... only happens if there are no branch tables above this page
244         if ($lessonpages[$pageid]->qtype == LESSON_PAGE_BRANCHTABLE) {
245             break;
246         }
247         $pageid = $lessonpages[$pageid]->prevpageid;
248     }
250     // get the pages within the branch
251     $pagesinbranch = $lesson->get_sub_pages_of($pageid, array(LESSON_PAGE_BRANCHTABLE, LESSON_PAGE_ENDOFBRANCH));
253     if(count($pagesinbranch) == 0) {
254         // there are no pages inside the branch, so return the next page
255         return $lessonpages[$pageid]->nextpageid;
256     } else {
257         return $pagesinbranch[rand(0, count($pagesinbranch)-1)]->id;  // returns a random page id for the next page
258     }
261 /**
262  * Calculates a user's grade for a lesson.
263  *
264  * @param object $lesson The lesson that the user is taking.
265  * @param int $retries The attempt number.
266  * @param int $userid Id of the user (optional, default current user).
267  * @return object { nquestions => number of questions answered
268                     attempts => number of question attempts
269                     total => max points possible
270                     earned => points earned by student
271                     grade => calculated percentage grade
272                     nmanual => number of manually graded questions
273                     manualpoints => point value for manually graded questions }
274  */
275 function lesson_grade($lesson, $ntries, $userid = 0) {
276     global $USER, $DB;
278     if (empty($userid)) {
279         $userid = $USER->id;
280     }
282     // Zero out everything
283     $ncorrect     = 0;
284     $nviewed      = 0;
285     $score        = 0;
286     $nmanual      = 0;
287     $manualpoints = 0;
288     $thegrade     = 0;
289     $nquestions   = 0;
290     $total        = 0;
291     $earned       = 0;
293     $params = array ("lessonid" => $lesson->id, "userid" => $userid, "retry" => $ntries);
294     if ($useranswers = $DB->get_records_select("lesson_attempts",  "lessonid = :lessonid AND
295             userid = :userid AND retry = :retry", $params, "timeseen")) {
296         // group each try with its page
297         $attemptset = array();
298         foreach ($useranswers as $useranswer) {
299             $attemptset[$useranswer->pageid][] = $useranswer;
300         }
302         // Drop all attempts that go beyond max attempts for the lesson
303         foreach ($attemptset as $key => $set) {
304             $attemptset[$key] = array_slice($set, 0, $lesson->maxattempts);
305         }
307         // get only the pages and their answers that the user answered
308         list($usql, $parameters) = $DB->get_in_or_equal(array_keys($attemptset));
309         array_unshift($parameters, $lesson->id);
310         $pages = $DB->get_records_select("lesson_pages", "lessonid = ? AND id $usql", $parameters);
311         $answers = $DB->get_records_select("lesson_answers", "lessonid = ? AND pageid $usql", $parameters);
313         // Number of pages answered
314         $nquestions = count($pages);
316         foreach ($attemptset as $attempts) {
317             $page = lesson_page::load($pages[end($attempts)->pageid], $lesson);
318             if ($lesson->custom) {
319                 $attempt = end($attempts);
320                 // If essay question, handle it, otherwise add to score
321                 if ($page->requires_manual_grading()) {
322                     $useranswerobj = unserialize($attempt->useranswer);
323                     if (isset($useranswerobj->score)) {
324                         $earned += $useranswerobj->score;
325                     }
326                     $nmanual++;
327                     $manualpoints += $answers[$attempt->answerid]->score;
328                 } else if (!empty($attempt->answerid)) {
329                     $earned += $page->earned_score($answers, $attempt);
330                 }
331             } else {
332                 foreach ($attempts as $attempt) {
333                     $earned += $attempt->correct;
334                 }
335                 $attempt = end($attempts); // doesn't matter which one
336                 // If essay question, increase numbers
337                 if ($page->requires_manual_grading()) {
338                     $nmanual++;
339                     $manualpoints++;
340                 }
341             }
342             // Number of times answered
343             $nviewed += count($attempts);
344         }
346         if ($lesson->custom) {
347             $bestscores = array();
348             // Find the highest possible score per page to get our total
349             foreach ($answers as $answer) {
350                 if(!isset($bestscores[$answer->pageid])) {
351                     $bestscores[$answer->pageid] = $answer->score;
352                 } else if ($bestscores[$answer->pageid] < $answer->score) {
353                     $bestscores[$answer->pageid] = $answer->score;
354                 }
355             }
356             $total = array_sum($bestscores);
357         } else {
358             // Check to make sure the student has answered the minimum questions
359             if ($lesson->minquestions and $nquestions < $lesson->minquestions) {
360                 // Nope, increase number viewed by the amount of unanswered questions
361                 $total =  $nviewed + ($lesson->minquestions - $nquestions);
362             } else {
363                 $total = $nviewed;
364             }
365         }
366     }
368     if ($total) { // not zero
369         $thegrade = round(100 * $earned / $total, 5);
370     }
372     // Build the grade information object
373     $gradeinfo               = new stdClass;
374     $gradeinfo->nquestions   = $nquestions;
375     $gradeinfo->attempts     = $nviewed;
376     $gradeinfo->total        = $total;
377     $gradeinfo->earned       = $earned;
378     $gradeinfo->grade        = $thegrade;
379     $gradeinfo->nmanual      = $nmanual;
380     $gradeinfo->manualpoints = $manualpoints;
382     return $gradeinfo;
385 /**
386  * Determines if a user can view the left menu.  The determining factor
387  * is whether a user has a grade greater than or equal to the lesson setting
388  * of displayleftif
389  *
390  * @param object $lesson Lesson object of the current lesson
391  * @return boolean 0 if the user cannot see, or $lesson->displayleft to keep displayleft unchanged
392  **/
393 function lesson_displayleftif($lesson) {
394     global $CFG, $USER, $DB;
396     if (!empty($lesson->displayleftif)) {
397         // get the current user's max grade for this lesson
398         $params = array ("userid" => $USER->id, "lessonid" => $lesson->id);
399         if ($maxgrade = $DB->get_record_sql('SELECT userid, MAX(grade) AS maxgrade FROM {lesson_grades} WHERE userid = :userid AND lessonid = :lessonid GROUP BY userid', $params)) {
400             if ($maxgrade->maxgrade < $lesson->displayleftif) {
401                 return 0;  // turn off the displayleft
402             }
403         } else {
404             return 0; // no grades
405         }
406     }
408     // if we get to here, keep the original state of displayleft lesson setting
409     return $lesson->displayleft;
412 /**
413  *
414  * @param $cm
415  * @param $lesson
416  * @param $page
417  * @return unknown_type
418  */
419 function lesson_add_fake_blocks($page, $cm, $lesson, $timer = null) {
420     $bc = lesson_menu_block_contents($cm->id, $lesson);
421     if (!empty($bc)) {
422         $regions = $page->blocks->get_regions();
423         $firstregion = reset($regions);
424         $page->blocks->add_fake_block($bc, $firstregion);
425     }
427     $bc = lesson_mediafile_block_contents($cm->id, $lesson);
428     if (!empty($bc)) {
429         $page->blocks->add_fake_block($bc, $page->blocks->get_default_region());
430     }
432     if (!empty($timer)) {
433         $bc = lesson_clock_block_contents($cm->id, $lesson, $timer, $page);
434         if (!empty($bc)) {
435             $page->blocks->add_fake_block($bc, $page->blocks->get_default_region());
436         }
437     }
440 /**
441  * If there is a media file associated with this
442  * lesson, return a block_contents that displays it.
443  *
444  * @param int $cmid Course Module ID for this lesson
445  * @param object $lesson Full lesson record object
446  * @return block_contents
447  **/
448 function lesson_mediafile_block_contents($cmid, $lesson) {
449     global $OUTPUT;
450     if (empty($lesson->mediafile)) {
451         return null;
452     }
454     $options = array();
455     $options['menubar'] = 0;
456     $options['location'] = 0;
457     $options['left'] = 5;
458     $options['top'] = 5;
459     $options['scrollbars'] = 1;
460     $options['resizable'] = 1;
461     $options['width'] = $lesson->mediawidth;
462     $options['height'] = $lesson->mediaheight;
464     $link = new moodle_url('/mod/lesson/mediafile.php?id='.$cmid);
465     $action = new popup_action('click', $link, 'lessonmediafile', $options);
466     $content = $OUTPUT->action_link($link, get_string('mediafilepopup', 'lesson'), $action, array('title'=>get_string('mediafilepopup', 'lesson')));
468     $bc = new block_contents();
469     $bc->title = get_string('linkedmedia', 'lesson');
470     $bc->attributes['class'] = 'mediafile';
471     $bc->content = $content;
473     return $bc;
476 /**
477  * If a timed lesson and not a teacher, then
478  * return a block_contents containing the clock.
479  *
480  * @param int $cmid Course Module ID for this lesson
481  * @param object $lesson Full lesson record object
482  * @param object $timer Full timer record object
483  * @return block_contents
484  **/
485 function lesson_clock_block_contents($cmid, $lesson, $timer, $page) {
486     // Display for timed lessons and for students only
487     $context = get_context_instance(CONTEXT_MODULE, $cmid);
488     if(!$lesson->timed || has_capability('mod/lesson:manage', $context)) {
489         return null;
490     }
492     $content = '<div class="jshidewhenenabled">';
493     $content .=  $lesson->time_remaining($timer->starttime);
494     $content .= '</div>';
496     $clocksettings = array('starttime'=>$timer->starttime, 'servertime'=>time(),'testlength'=>($lesson->maxtime * 60));
497     $page->requires->data_for_js('clocksettings', $clocksettings);
498     $page->requires->js('/mod/lesson/timer.js');
499     $page->requires->js_function_call('show_clock');
501     $bc = new block_contents();
502     $bc->title = get_string('timeremaining', 'lesson');
503     $bc->attributes['class'] = 'clock block';
504     $bc->content = $content;
506     return $bc;
509 /**
510  * If left menu is turned on, then this will
511  * print the menu in a block
512  *
513  * @param int $cmid Course Module ID for this lesson
514  * @param lesson $lesson Full lesson record object
515  * @return void
516  **/
517 function lesson_menu_block_contents($cmid, $lesson) {
518     global $CFG, $DB;
520     if (!$lesson->displayleft) {
521         return null;
522     }
524     $pages = $lesson->load_all_pages();
525     foreach ($pages as $page) {
526         if ((int)$page->prevpageid === 0) {
527             $pageid = $page->id;
528             break;
529         }
530     }
531     $currentpageid = optional_param('pageid', $pageid, PARAM_INT);
533     if (!$pageid || !$pages) {
534         return null;
535     }
537     $content = '<a href="#maincontent" class="skip">'.get_string('skip', 'lesson')."</a>\n<div class=\"menuwrapper\">\n<ul>\n";
539     while ($pageid != 0) {
540         $page = $pages[$pageid];
542         // Only process branch tables with display turned on
543         if ($page->displayinmenublock && $page->display) {
544             if ($page->id == $currentpageid) {
545                 $content .= '<li class="selected">'.format_string($page->title,true)."</li>\n";
546             } else {
547                 $content .= "<li class=\"notselected\"><a href=\"$CFG->wwwroot/mod/lesson/view.php?id=$cmid&amp;pageid=$page->id\">".format_string($page->title,true)."</a></li>\n";
548             }
550         }
551         $pageid = $page->nextpageid;
552     }
553     $content .= "</ul>\n</div>\n";
555     $bc = new block_contents();
556     $bc->title = get_string('lessonmenu', 'lesson');
557     $bc->attributes['class'] = 'menu block';
558     $bc->content = $content;
560     return $bc;
563 /**
564  * Adds header buttons to the page for the lesson
565  *
566  * @param object $cm
567  * @param object $context
568  * @param bool $extraeditbuttons
569  * @param int $lessonpageid
570  */
571 function lesson_add_header_buttons($cm, $context, $extraeditbuttons=false, $lessonpageid=null) {
572     global $CFG, $PAGE, $OUTPUT;
573     if (has_capability('mod/lesson:edit', $context) && $extraeditbuttons) {
574         if ($lessonpageid === null) {
575             print_error('invalidpageid', 'lesson');
576         }
577         if (!empty($lessonpageid) && $lessonpageid != LESSON_EOL) {
578             $url = new moodle_url('/mod/lesson/editpage.php', array('id'=>$cm->id, 'pageid'=>$lessonpageid, 'edit'=>1));
579             $PAGE->set_button($OUTPUT->single_button($url, get_string('editpagecontent', 'lesson')));
580         }
581     }
584 /**
585  * This is a function used to detect media types and generate html code.
586  *
587  * @global object $CFG
588  * @global object $PAGE
589  * @param object $lesson
590  * @param object $context
591  * @return string $code the html code of media
592  */
593 function lesson_get_media_html($lesson, $context) {
594     global $CFG, $PAGE, $OUTPUT;
595     require_once("$CFG->libdir/resourcelib.php");
597     // get the media file link
598     if (strpos($lesson->mediafile, '://') !== false) {
599         $url = new moodle_url($lesson->mediafile);
600     } else {
601         // the timemodified is used to prevent caching problems, instead of '/' we should better read from files table and use sortorder
602         $url = moodle_url::make_pluginfile_url($context->id, 'mod_lesson', 'mediafile', $lesson->timemodified, '/', ltrim($lesson->mediafile, '/'));
603     }
604     $title = $lesson->mediafile;
606     $clicktoopen = html_writer::link($url, get_string('download'));
608     $mimetype = resourcelib_guess_url_mimetype($url);
610     $extension = resourcelib_get_extension($url->out(false));
612     // find the correct type and print it out
613     if (in_array($mimetype, array('image/gif','image/jpeg','image/png'))) {  // It's an image
614         $code = resourcelib_embed_image($url, $title);
616     } else if ($mimetype == 'audio/mp3') {
617         // MP3 audio file
618         $code = resourcelib_embed_mp3($url, $title, $clicktoopen);
620     } else if ($mimetype == 'video/x-flv' or $extension === 'f4v') {
621         // Flash video file
622         $code = resourcelib_embed_flashvideo($url, $title, $clicktoopen);
624     } else if ($mimetype == 'application/x-shockwave-flash') {
625         // Flash file
626         $code = resourcelib_embed_flash($url, $title, $clicktoopen);
628     } else if (substr($mimetype, 0, 10) == 'video/x-ms') {
629         // Windows Media Player file
630         $code = resourcelib_embed_mediaplayer($url, $title, $clicktoopen);
632     } else if ($mimetype == 'video/quicktime') {
633         // Quicktime file
634         $code = resourcelib_embed_quicktime($url, $title, $clicktoopen);
636     } else if ($mimetype == 'video/mpeg') {
637         // Mpeg file
638         $code = resourcelib_embed_mpeg($url, $title, $clicktoopen);
640     } else if ($mimetype == 'audio/x-pn-realaudio-plugin') {
641         // RealMedia file
642         $code = resourcelib_embed_real($url, $title, $clicktoopen);
644     } else {
645         // anything else - just try object tag enlarged as much as possible
646         $code = resourcelib_embed_general($url, $title, $clicktoopen, $mimetype);
647     }
649     return $code;
653 /**
654  * Abstract class that page type's MUST inherit from.
655  *
656  * This is the abstract class that ALL add page type forms must extend.
657  * You will notice that all but two of the methods this class contains are final.
658  * Essentially the only thing that extending classes can do is extend custom_definition.
659  * OR if it has a special requirement on creation it can extend construction_override
660  *
661  * @abstract
662  * @copyright  2009 Sam Hemelryk
663  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
664  */
665 abstract class lesson_add_page_form_base extends moodleform {
667     /**
668      * This is the classic define that is used to identify this pagetype.
669      * Will be one of LESSON_*
670      * @var int
671      */
672     public $qtype;
674     /**
675      * The simple string that describes the page type e.g. truefalse, multichoice
676      * @var string
677      */
678     public $qtypestring;
680     /**
681      * An array of options used in the htmleditor
682      * @var array
683      */
684     protected $editoroptions = array();
686     /**
687      * True if this is a standard page of false if it does something special.
688      * Questions are standard pages, branch tables are not
689      * @var bool
690      */
691     protected $standard = true;
693     /**
694      * Each page type can and should override this to add any custom elements to
695      * the basic form that they want
696      */
697     public function custom_definition() {}
699     /**
700      * Used to determine if this is a standard page or a special page
701      * @return bool
702      */
703     public final function is_standard() {
704         return (bool)$this->standard;
705     }
707     /**
708      * Add the required basic elements to the form.
709      *
710      * This method adds the basic elements to the form including title and contents
711      * and then calls custom_definition();
712      */
713     public final function definition() {
714         $mform = $this->_form;
715         $editoroptions = $this->_customdata['editoroptions'];
717         $mform->addElement('header', 'qtypeheading', get_string('addaquestionpage', 'lesson', get_string($this->qtypestring, 'lesson')));
719         $mform->addElement('hidden', 'id');
720         $mform->setType('id', PARAM_INT);
722         $mform->addElement('hidden', 'pageid');
723         $mform->setType('pageid', PARAM_INT);
725         if ($this->standard === true) {
726             $mform->addElement('hidden', 'qtype');
727             $mform->setType('qtype', PARAM_INT);
729             $mform->addElement('text', 'title', get_string('pagetitle', 'lesson'), array('size'=>70));
730             $mform->setType('title', PARAM_TEXT);
731             $mform->addRule('title', get_string('required'), 'required', null, 'client');
733             $this->editoroptions = array('noclean'=>true, 'maxfiles'=>EDITOR_UNLIMITED_FILES, 'maxbytes'=>$this->_customdata['maxbytes']);
734             $mform->addElement('editor', 'contents_editor', get_string('pagecontents', 'lesson'), null, $this->editoroptions);
735             $mform->setType('contents_editor', PARAM_RAW);
736             $mform->addRule('contents_editor', get_string('required'), 'required', null, 'client');
737         }
739         $this->custom_definition();
741         if ($this->_customdata['edit'] === true) {
742             $mform->addElement('hidden', 'edit', 1);
743             $this->add_action_buttons(get_string('cancel'), get_string('savepage', 'lesson'));
744         } else {
745             $this->add_action_buttons(get_string('cancel'), get_string('addaquestionpage', 'lesson'));
746         }
747     }
749     /**
750      * Convenience function: Adds a jumpto select element
751      *
752      * @param string $name
753      * @param string|null $label
754      * @param int $selected The page to select by default
755      */
756     protected final function add_jumpto($name, $label=null, $selected=LESSON_NEXTPAGE) {
757         $title = get_string("jump", "lesson");
758         if ($label === null) {
759             $label = $title;
760         }
761         if (is_int($name)) {
762             $name = "jumpto[$name]";
763         }
764         $this->_form->addElement('select', $name, $label, $this->_customdata['jumpto']);
765         $this->_form->setDefault($name, $selected);
766         $this->_form->addHelpButton($name, 'jumps', 'lesson');
767     }
769     /**
770      * Convenience function: Adds a score input element
771      *
772      * @param string $name
773      * @param string|null $label
774      * @param mixed $value The default value
775      */
776     protected final function add_score($name, $label=null, $value=null) {
777         if ($label === null) {
778             $label = get_string("score", "lesson");
779         }
780         if (is_int($name)) {
781             $name = "score[$name]";
782         }
783         $this->_form->addElement('text', $name, $label, array('size'=>5));
784         if ($value !== null) {
785             $this->_form->setDefault($name, $value);
786         }
787     }
789     /**
790      * Convenience function: Adds an answer editor
791      *
792      * @param int $count The count of the element to add
793      * @param string $label, NULL means default
794      * @param bool $required
795      * @return void
796      */
797     protected final function add_answer($count, $label = NULL, $required = false) {
798         if ($label === NULL) {
799             $label = get_string('answer', 'lesson');
800         }
801         $this->_form->addElement('editor', 'answer_editor['.$count.']', $label, array('rows'=>'4', 'columns'=>'80'), array('noclean'=>true));
802         $this->_form->setDefault('answer_editor['.$count.']', array('text'=>'', 'format'=>FORMAT_MOODLE));
803         if ($required) {
804             $this->_form->addRule('answer_editor['.$count.']', get_string('required'), 'required', null, 'client');
805         }
806     }
807     /**
808      * Convenience function: Adds an response editor
809      *
810      * @param int $count The count of the element to add
811      * @param string $label, NULL means default
812      * @param bool $required
813      * @return void
814      */
815     protected final function add_response($count, $label = NULL, $required = false) {
816         if ($label === NULL) {
817             $label = get_string('response', 'lesson');
818         }
819         $this->_form->addElement('editor', 'response_editor['.$count.']', $label, array('rows'=>'4', 'columns'=>'80'), array('noclean'=>true));
820         $this->_form->setDefault('response_editor['.$count.']', array('text'=>'', 'format'=>FORMAT_MOODLE));
821         if ($required) {
822             $this->_form->addRule('response_editor['.$count.']', get_string('required'), 'required', null, 'client');
823         }
824     }
826     /**
827      * A function that gets called upon init of this object by the calling script.
828      *
829      * This can be used to process an immediate action if required. Currently it
830      * is only used in special cases by non-standard page types.
831      *
832      * @return bool
833      */
834     public function construction_override($pageid, lesson $lesson) {
835         return true;
836     }
841 /**
842  * Class representation of a lesson
843  *
844  * This class is used the interact with, and manage a lesson once instantiated.
845  * If you need to fetch a lesson object you can do so by calling
846  *
847  * <code>
848  * lesson::load($lessonid);
849  * // or
850  * $lessonrecord = $DB->get_record('lesson', $lessonid);
851  * $lesson = new lesson($lessonrecord);
852  * </code>
853  *
854  * The class itself extends lesson_base as all classes within the lesson module should
855  *
856  * These properties are from the database
857  * @property int $id The id of this lesson
858  * @property int $course The ID of the course this lesson belongs to
859  * @property string $name The name of this lesson
860  * @property int $practice Flag to toggle this as a practice lesson
861  * @property int $modattempts Toggle to allow the user to go back and review answers
862  * @property int $usepassword Toggle the use of a password for entry
863  * @property string $password The password to require users to enter
864  * @property int $dependency ID of another lesson this lesson is dependent on
865  * @property string $conditions Conditions of the lesson dependency
866  * @property int $grade The maximum grade a user can achieve (%)
867  * @property int $custom Toggle custom scoring on or off
868  * @property int $ongoing Toggle display of an ongoing score
869  * @property int $usemaxgrade How retakes are handled (max=1, mean=0)
870  * @property int $maxanswers The max number of answers or branches
871  * @property int $maxattempts The maximum number of attempts a user can record
872  * @property int $review Toggle use or wrong answer review button
873  * @property int $nextpagedefault Override the default next page
874  * @property int $feedback Toggles display of default feedback
875  * @property int $minquestions Sets a minimum value of pages seen when calculating grades
876  * @property int $maxpages Maximum number of pages this lesson can contain
877  * @property int $retake Flag to allow users to retake a lesson
878  * @property int $activitylink Relate this lesson to another lesson
879  * @property string $mediafile File to pop up to or webpage to display
880  * @property int $mediaheight Sets the height of the media file popup
881  * @property int $mediawidth Sets the width of the media file popup
882  * @property int $mediaclose Toggle display of a media close button
883  * @property int $slideshow Flag for whether branch pages should be shown as slideshows
884  * @property int $width Width of slideshow
885  * @property int $height Height of slideshow
886  * @property string $bgcolor Background colour of slideshow
887  * @property int $displayleft Display a left menu
888  * @property int $displayleftif Sets the condition on which the left menu is displayed
889  * @property int $progressbar Flag to toggle display of a lesson progress bar
890  * @property int $highscores Flag to toggle collection of high scores
891  * @property int $maxhighscores Number of high scores to limit to
892  * @property int $available Timestamp of when this lesson becomes available
893  * @property int $deadline Timestamp of when this lesson is no longer available
894  * @property int $timemodified Timestamp when lesson was last modified
895  *
896  * These properties are calculated
897  * @property int $firstpageid Id of the first page of this lesson (prevpageid=0)
898  * @property int $lastpageid Id of the last page of this lesson (nextpageid=0)
899  *
900  * @copyright  2009 Sam Hemelryk
901  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
902  */
903 class lesson extends lesson_base {
905     /**
906      * The id of the first page (where prevpageid = 0) gets set and retrieved by
907      * {@see get_firstpageid()} by directly calling <code>$lesson->firstpageid;</code>
908      * @var int
909      */
910     protected $firstpageid = null;
911     /**
912      * The id of the last page (where nextpageid = 0) gets set and retrieved by
913      * {@see get_lastpageid()} by directly calling <code>$lesson->lastpageid;</code>
914      * @var int
915      */
916     protected $lastpageid = null;
917     /**
918      * An array used to cache the pages associated with this lesson after the first
919      * time they have been loaded.
920      * A note to developers: If you are going to be working with MORE than one or
921      * two pages from a lesson you should probably call {@see $lesson->load_all_pages()}
922      * in order to save excess database queries.
923      * @var array An array of lesson_page objects
924      */
925     protected $pages = array();
926     /**
927      * Flag that gets set to true once all of the pages associated with the lesson
928      * have been loaded.
929      * @var bool
930      */
931     protected $loadedallpages = false;
933     /**
934      * Simply generates a lesson object given an array/object of properties
935      * Overrides {@see lesson_base->create()}
936      * @static
937      * @param object|array $properties
938      * @return lesson
939      */
940     public static function create($properties) {
941         return new lesson($properties);
942     }
944     /**
945      * Generates a lesson object from the database given its id
946      * @static
947      * @param int $lessonid
948      * @return lesson
949      */
950     public static function load($lessonid) {
951         global $DB;
953         if (!$lesson = $DB->get_record('lesson', array('id' => $lessonid))) {
954             print_error('invalidcoursemodule');
955         }
956         return new lesson($lesson);
957     }
959     /**
960      * Deletes this lesson from the database
961      */
962     public function delete() {
963         global $CFG, $DB;
964         require_once($CFG->libdir.'/gradelib.php');
965         require_once($CFG->dirroot.'/calendar/lib.php');
967         $DB->delete_records("lesson", array("id"=>$this->properties->id));;
968         $DB->delete_records("lesson_pages", array("lessonid"=>$this->properties->id));
969         $DB->delete_records("lesson_answers", array("lessonid"=>$this->properties->id));
970         $DB->delete_records("lesson_attempts", array("lessonid"=>$this->properties->id));
971         $DB->delete_records("lesson_grades", array("lessonid"=>$this->properties->id));
972         $DB->delete_records("lesson_timer", array("lessonid"=>$this->properties->id));
973         $DB->delete_records("lesson_branch", array("lessonid"=>$this->properties->id));
974         $DB->delete_records("lesson_high_scores", array("lessonid"=>$this->properties->id));
975         if ($events = $DB->get_records('event', array("modulename"=>'lesson', "instance"=>$this->properties->id))) {
976             foreach($events as $event) {
977                 $event = calendar_event::load($event);
978                 $event->delete();
979             }
980         }
982         grade_update('mod/lesson', $this->properties->course, 'mod', 'lesson', $this->properties->id, 0, NULL, array('deleted'=>1));
983         return true;
984     }
986     /**
987      * Fetches messages from the session that may have been set in previous page
988      * actions.
989      *
990      * <code>
991      * // Do not call this method directly instead use
992      * $lesson->messages;
993      * </code>
994      *
995      * @return array
996      */
997     protected function get_messages() {
998         global $SESSION;
1000         $messages = array();
1001         if (!empty($SESSION->lesson_messages) && is_array($SESSION->lesson_messages) && array_key_exists($this->properties->id, $SESSION->lesson_messages)) {
1002             $messages = $SESSION->lesson_messages[$this->properties->id];
1003             unset($SESSION->lesson_messages[$this->properties->id]);
1004         }
1006         return $messages;
1007     }
1009     /**
1010      * Get all of the attempts for the current user.
1011      *
1012      * @param int $retries
1013      * @param bool $correct Optional: only fetch correct attempts
1014      * @param int $pageid Optional: only fetch attempts at the given page
1015      * @param int $userid Optional: defaults to the current user if not set
1016      * @return array|false
1017      */
1018     public function get_attempts($retries, $correct=false, $pageid=null, $userid=null) {
1019         global $USER, $DB;
1020         $params = array("lessonid"=>$this->properties->id, "userid"=>$userid, "retry"=>$retries);
1021         if ($correct) {
1022             $params['correct'] = 1;
1023         }
1024         if ($pageid !== null) {
1025             $params['pageid'] = $pageid;
1026         }
1027         if ($userid === null) {
1028             $params['userid'] = $USER->id;
1029         }
1030         return $DB->get_records('lesson_attempts', $params, 'timeseen ASC');
1031     }
1033     /**
1034      * Returns the first page for the lesson or false if there isn't one.
1035      *
1036      * This method should be called via the magic method __get();
1037      * <code>
1038      * $firstpage = $lesson->firstpage;
1039      * </code>
1040      *
1041      * @return lesson_page|bool Returns the lesson_page specialised object or false
1042      */
1043     protected function get_firstpage() {
1044         $pages = $this->load_all_pages();
1045         if (count($pages) > 0) {
1046             foreach ($pages as $page) {
1047                 if ((int)$page->prevpageid === 0) {
1048                     return $page;
1049                 }
1050             }
1051         }
1052         return false;
1053     }
1055     /**
1056      * Returns the last page for the lesson or false if there isn't one.
1057      *
1058      * This method should be called via the magic method __get();
1059      * <code>
1060      * $lastpage = $lesson->lastpage;
1061      * </code>
1062      *
1063      * @return lesson_page|bool Returns the lesson_page specialised object or false
1064      */
1065     protected function get_lastpage() {
1066         $pages = $this->load_all_pages();
1067         if (count($pages) > 0) {
1068             foreach ($pages as $page) {
1069                 if ((int)$page->nextpageid === 0) {
1070                     return $page;
1071                 }
1072             }
1073         }
1074         return false;
1075     }
1077     /**
1078      * Returns the id of the first page of this lesson. (prevpageid = 0)
1079      * @return int
1080      */
1081     protected function get_firstpageid() {
1082         global $DB;
1083         if ($this->firstpageid == null) {
1084             if (!$this->loadedallpages) {
1085                 $firstpageid = $DB->get_field('lesson_pages', 'id', array('lessonid'=>$this->properties->id, 'prevpageid'=>0));
1086                 if (!$firstpageid) {
1087                     print_error('cannotfindfirstpage', 'lesson');
1088                 }
1089                 $this->firstpageid = $firstpageid;
1090             } else {
1091                 $firstpage = $this->get_firstpage();
1092                 $this->firstpageid = $firstpage->id;
1093             }
1094         }
1095         return $this->firstpageid;
1096     }
1098     /**
1099      * Returns the id of the last page of this lesson. (nextpageid = 0)
1100      * @return int
1101      */
1102     public function get_lastpageid() {
1103         global $DB;
1104         if ($this->lastpageid == null) {
1105             if (!$this->loadedallpages) {
1106                 $lastpageid = $DB->get_field('lesson_pages', 'id', array('lessonid'=>$this->properties->id, 'nextpageid'=>0));
1107                 if (!$lastpageid) {
1108                     print_error('cannotfindlastpage', 'lesson');
1109                 }
1110                 $this->lastpageid = $lastpageid;
1111             } else {
1112                 $lastpageid = $this->get_lastpage();
1113                 $this->lastpageid = $lastpageid->id;
1114             }
1115         }
1117         return $this->lastpageid;
1118     }
1120      /**
1121      * Gets the next page id to display after the one that is provided.
1122      * @param int $nextpageid
1123      * @return bool
1124      */
1125     public function get_next_page($nextpageid) {
1126         global $USER, $DB;
1127         $allpages = $this->load_all_pages();
1128         if ($this->properties->nextpagedefault) {
1129             // in Flash Card mode...first get number of retakes
1130             $nretakes = $DB->count_records("lesson_grades", array("lessonid" => $this->properties->id, "userid" => $USER->id));
1131             shuffle($allpages);
1132             $found = false;
1133             if ($this->properties->nextpagedefault == LESSON_UNSEENPAGE) {
1134                 foreach ($allpages as $nextpage) {
1135                     if (!$DB->count_records("lesson_attempts", array("pageid" => $nextpage->id, "userid" => $USER->id, "retry" => $nretakes))) {
1136                         $found = true;
1137                         break;
1138                     }
1139                 }
1140             } elseif ($this->properties->nextpagedefault == LESSON_UNANSWEREDPAGE) {
1141                 foreach ($allpages as $nextpage) {
1142                     if (!$DB->count_records("lesson_attempts", array('pageid' => $nextpage->id, 'userid' => $USER->id, 'correct' => 1, 'retry' => $nretakes))) {
1143                         $found = true;
1144                         break;
1145                     }
1146                 }
1147             }
1148             if ($found) {
1149                 if ($this->properties->maxpages) {
1150                     // check number of pages viewed (in the lesson)
1151                     if ($DB->count_records("lesson_attempts", array("lessonid" => $this->properties->id, "userid" => $USER->id, "retry" => $nretakes)) >= $this->properties->maxpages) {
1152                         return LESSON_EOL;
1153                     }
1154                 }
1155                 return $nextpage->id;
1156             }
1157         }
1158         // In a normal lesson mode
1159         foreach ($allpages as $nextpage) {
1160             if ((int)$nextpage->id === (int)$nextpageid) {
1161                 return $nextpage->id;
1162             }
1163         }
1164         return LESSON_EOL;
1165     }
1167     /**
1168      * Sets a message against the session for this lesson that will displayed next
1169      * time the lesson processes messages
1170      *
1171      * @param string $message
1172      * @param string $class
1173      * @param string $align
1174      * @return bool
1175      */
1176     public function add_message($message, $class="notifyproblem", $align='center') {
1177         global $SESSION;
1179         if (empty($SESSION->lesson_messages) || !is_array($SESSION->lesson_messages)) {
1180             $SESSION->lesson_messages = array();
1181             $SESSION->lesson_messages[$this->properties->id] = array();
1182         } else if (!array_key_exists($this->properties->id, $SESSION->lesson_messages)) {
1183             $SESSION->lesson_messages[$this->properties->id] = array();
1184         }
1186         $SESSION->lesson_messages[$this->properties->id][] = array($message, $class, $align);
1188         return true;
1189     }
1191     /**
1192      * Check if the lesson is accessible at the present time
1193      * @return bool True if the lesson is accessible, false otherwise
1194      */
1195     public function is_accessible() {
1196         $available = $this->properties->available;
1197         $deadline = $this->properties->deadline;
1198         return (($available == 0 || time() >= $available) && ($deadline == 0 || time() < $deadline));
1199     }
1201     /**
1202      * Starts the lesson time for the current user
1203      * @return bool Returns true
1204      */
1205     public function start_timer() {
1206         global $USER, $DB;
1207         $USER->startlesson[$this->properties->id] = true;
1208         $startlesson = new stdClass;
1209         $startlesson->lessonid = $this->properties->id;
1210         $startlesson->userid = $USER->id;
1211         $startlesson->starttime = time();
1212         $startlesson->lessontime = time();
1213         $DB->insert_record('lesson_timer', $startlesson);
1214         if ($this->properties->timed) {
1215             $this->add_message(get_string('maxtimewarning', 'lesson', $this->properties->maxtime), 'center');
1216         }
1217         return true;
1218     }
1220     /**
1221      * Updates the timer to the current time and returns the new timer object
1222      * @param bool $restart If set to true the timer is restarted
1223      * @param bool $continue If set to true AND $restart=true then the timer
1224      *                        will continue from a previous attempt
1225      * @return stdClass The new timer
1226      */
1227     public function update_timer($restart=false, $continue=false) {
1228         global $USER, $DB;
1229         // clock code
1230         // get time information for this user
1231         if (!$timer = $DB->get_records('lesson_timer', array ("lessonid" => $this->properties->id, "userid" => $USER->id), 'starttime DESC', '*', 0, 1)) {
1232             print_error('cannotfindtimer', 'lesson');
1233         } else {
1234             $timer = current($timer); // this will get the latest start time record
1235         }
1237         if ($restart) {
1238             if ($continue) {
1239                 // continue a previous test, need to update the clock  (think this option is disabled atm)
1240                 $timer->starttime = time() - ($timer->lessontime - $timer->starttime);
1241             } else {
1242                 // starting over, so reset the clock
1243                 $timer->starttime = time();
1244             }
1245         }
1247         $timer->lessontime = time();
1248         $DB->update_record('lesson_timer', $timer);
1249         return $timer;
1250     }
1252     /**
1253      * Updates the timer to the current time then stops it by unsetting the user var
1254      * @return bool Returns true
1255      */
1256     public function stop_timer() {
1257         global $USER, $DB;
1258         unset($USER->startlesson[$this->properties->id]);
1259         return $this->update_timer(false, false);
1260     }
1262     /**
1263      * Checks to see if the lesson has pages
1264      */
1265     public function has_pages() {
1266         global $DB;
1267         $pagecount = $DB->count_records('lesson_pages', array('lessonid'=>$this->properties->id));
1268         return ($pagecount>0);
1269     }
1271     /**
1272      * Returns the link for the related activity
1273      * @return array|false
1274      */
1275     public function link_for_activitylink() {
1276         global $DB;
1277         $module = $DB->get_record('course_modules', array('id' => $this->properties->activitylink));
1278         if ($module) {
1279             $modname = $DB->get_field('modules', 'name', array('id' => $module->module));
1280             if ($modname) {
1281                 $instancename = $DB->get_field($modname, 'name', array('id' => $module->instance));
1282                 if ($instancename) {
1283                     return html_writer::link(new moodle_url('/mod/'.$modname.'/view.php', array('id'=>$this->properties->activitylink)),
1284                         get_string('activitylinkname', 'lesson', $instancename),
1285                         array('class'=>'centerpadded lessonbutton standardbutton'));
1286                 }
1287             }
1288         }
1289         return '';
1290     }
1292     /**
1293      * Loads the requested page.
1294      *
1295      * This function will return the requested page id as either a specialised
1296      * lesson_page object OR as a generic lesson_page.
1297      * If the page has been loaded previously it will be returned from the pages
1298      * array, otherwise it will be loaded from the database first
1299      *
1300      * @param int $pageid
1301      * @return lesson_page A lesson_page object or an object that extends it
1302      */
1303     public function load_page($pageid) {
1304         if (!array_key_exists($pageid, $this->pages)) {
1305             $manager = lesson_page_type_manager::get($this);
1306             $this->pages[$pageid] = $manager->load_page($pageid, $this);
1307         }
1308         return $this->pages[$pageid];
1309     }
1311     /**
1312      * Loads ALL of the pages for this lesson
1313      *
1314      * @return array An array containing all pages from this lesson
1315      */
1316     public function load_all_pages() {
1317         if (!$this->loadedallpages) {
1318             $manager = lesson_page_type_manager::get($this);
1319             $this->pages = $manager->load_all_pages($this);
1320             $this->loadedallpages = true;
1321         }
1322         return $this->pages;
1323     }
1325     /**
1326      * Determines if a jumpto value is correct or not.
1327      *
1328      * returns true if jumpto page is (logically) after the pageid page or
1329      * if the jumpto value is a special value.  Returns false in all other cases.
1330      *
1331      * @param int $pageid Id of the page from which you are jumping from.
1332      * @param int $jumpto The jumpto number.
1333      * @return boolean True or false after a series of tests.
1334      **/
1335     public function jumpto_is_correct($pageid, $jumpto) {
1336         global $DB;
1338         // first test the special values
1339         if (!$jumpto) {
1340             // same page
1341             return false;
1342         } elseif ($jumpto == LESSON_NEXTPAGE) {
1343             return true;
1344         } elseif ($jumpto == LESSON_UNSEENBRANCHPAGE) {
1345             return true;
1346         } elseif ($jumpto == LESSON_RANDOMPAGE) {
1347             return true;
1348         } elseif ($jumpto == LESSON_CLUSTERJUMP) {
1349             return true;
1350         } elseif ($jumpto == LESSON_EOL) {
1351             return true;
1352         }
1354         $pages = $this->load_all_pages();
1355         $apageid = $pages[$pageid]->nextpageid;
1356         while ($apageid != 0) {
1357             if ($jumpto == $apageid) {
1358                 return true;
1359             }
1360             $apageid = $pages[$apageid]->nextpageid;
1361         }
1362         return false;
1363     }
1365     /**
1366      * Returns the time a user has remaining on this lesson
1367      * @param int $starttime Starttime timestamp
1368      * @return string
1369      */
1370     public function time_remaining($starttime) {
1371         $timeleft = $starttime + $this->maxtime * 60 - time();
1372         $hours = floor($timeleft/3600);
1373         $timeleft = $timeleft - ($hours * 3600);
1374         $minutes = floor($timeleft/60);
1375         $secs = $timeleft - ($minutes * 60);
1377         if ($minutes < 10) {
1378             $minutes = "0$minutes";
1379         }
1380         if ($secs < 10) {
1381             $secs = "0$secs";
1382         }
1383         $output   = array();
1384         $output[] = $hours;
1385         $output[] = $minutes;
1386         $output[] = $secs;
1387         $output = implode(':', $output);
1388         return $output;
1389     }
1391     /**
1392      * Interprets LESSON_CLUSTERJUMP jumpto value.
1393      *
1394      * This will select a page randomly
1395      * and the page selected will be inbetween a cluster page and end of clutter or end of lesson
1396      * and the page selected will be a page that has not been viewed already
1397      * and if any pages are within a branch table or end of branch then only 1 page within
1398      * the branch table or end of branch will be randomly selected (sub clustering).
1399      *
1400      * @param int $pageid Id of the current page from which we are jumping from.
1401      * @param int $userid Id of the user.
1402      * @return int The id of the next page.
1403      **/
1404     public function cluster_jump($pageid, $userid=null) {
1405         global $DB, $USER;
1407         if ($userid===null) {
1408             $userid = $USER->id;
1409         }
1410         // get the number of retakes
1411         if (!$retakes = $DB->count_records("lesson_grades", array("lessonid"=>$this->properties->id, "userid"=>$userid))) {
1412             $retakes = 0;
1413         }
1414         // get all the lesson_attempts aka what the user has seen
1415         $seenpages = array();
1416         if ($attempts = $this->get_attempts($retakes)) {
1417             foreach ($attempts as $attempt) {
1418                 $seenpages[$attempt->pageid] = $attempt->pageid;
1419             }
1421         }
1423         // get the lesson pages
1424         $lessonpages = $this->load_all_pages();
1425         // find the start of the cluster
1426         while ($pageid != 0) { // this condition should not be satisfied... should be a cluster page
1427             if ($lessonpages[$pageid]->qtype == LESSON_PAGE_CLUSTER) {
1428                 break;
1429             }
1430             $pageid = $lessonpages[$pageid]->prevpageid;
1431         }
1433         $clusterpages = array();
1434         $clusterpages = $this->get_sub_pages_of($pageid, array(LESSON_PAGE_ENDOFCLUSTER));
1435         $unseen = array();
1436         foreach ($clusterpages as $key=>$cluster) {
1437             if ($cluster->type !== lesson_page::TYPE_QUESTION) {
1438                 unset($clusterpages[$key]);
1439             } elseif ($cluster->is_unseen($seenpages)) {
1440                 $unseen[] = $cluster;
1441             }
1442         }
1444         if (count($unseen) > 0) {
1445             // it does not contain elements, then use exitjump, otherwise find out next page/branch
1446             $nextpage = $unseen[rand(0, count($unseen)-1)];
1447             if ($nextpage->qtype == LESSON_PAGE_BRANCHTABLE) {
1448                 // if branch table, then pick a random page inside of it
1449                 $branchpages = $this->get_sub_pages_of($nextpage->id, array(LESSON_PAGE_BRANCHTABLE, LESSON_PAGE_ENDOFBRANCH));
1450                 return $branchpages[rand(0, count($branchpages)-1)]->id;
1451             } else { // otherwise, return the page's id
1452                 return $nextpage->id;
1453             }
1454         } else {
1455             // seen all there is to see, leave the cluster
1456             if (end($clusterpages)->nextpageid == 0) {
1457                 return LESSON_EOL;
1458             } else {
1459                 $clusterendid = $pageid;
1460                 while ($clusterendid != 0) { // this condition should not be satisfied... should be a cluster page
1461                     if ($lessonpages[$clusterendid]->qtype == LESSON_PAGE_CLUSTER) {
1462                         break;
1463                     }
1464                     $clusterendid = $lessonpages[$clusterendid]->prevpageid;
1465                 }
1466                 $exitjump = $DB->get_field("lesson_answers", "jumpto", array("pageid" => $clusterendid, "lessonid" => $this->properties->id));
1467                 if ($exitjump == LESSON_NEXTPAGE) {
1468                     $exitjump = $lessonpages[$pageid]->nextpageid;
1469                 }
1470                 if ($exitjump == 0) {
1471                     return LESSON_EOL;
1472                 } else if (in_array($exitjump, array(LESSON_EOL, LESSON_PREVIOUSPAGE))) {
1473                     return $exitjump;
1474                 } else {
1475                     if (!array_key_exists($exitjump, $lessonpages)) {
1476                         $found = false;
1477                         foreach ($lessonpages as $page) {
1478                             if ($page->id === $clusterendid) {
1479                                 $found = true;
1480                             } else if ($page->qtype == LESSON_PAGE_ENDOFCLUSTER) {
1481                                 $exitjump = $DB->get_field("lesson_answers", "jumpto", array("pageid" => $page->id, "lessonid" => $this->properties->id));
1482                                 break;
1483                             }
1484                         }
1485                     }
1486                     if (!array_key_exists($exitjump, $lessonpages)) {
1487                         return LESSON_EOL;
1488                     }
1489                     return $exitjump;
1490                 }
1491             }
1492         }
1493     }
1495     /**
1496      * Finds all pages that appear to be a subtype of the provided pageid until
1497      * an end point specified within $ends is encountered or no more pages exist
1498      *
1499      * @param int $pageid
1500      * @param array $ends An array of LESSON_PAGE_* types that signify an end of
1501      *               the subtype
1502      * @return array An array of specialised lesson_page objects
1503      */
1504     public function get_sub_pages_of($pageid, array $ends) {
1505         $lessonpages = $this->load_all_pages();
1506         $pageid = $lessonpages[$pageid]->nextpageid;  // move to the first page after the branch table
1507         $pages = array();
1509         while (true) {
1510             if ($pageid == 0 || in_array($lessonpages[$pageid]->qtype, $ends)) {
1511                 break;
1512             }
1513             $pages[] = $lessonpages[$pageid];
1514             $pageid = $lessonpages[$pageid]->nextpageid;
1515         }
1517         return $pages;
1518     }
1520     /**
1521      * Checks to see if the specified page[id] is a subpage of a type specified in
1522      * the $types array, until either there are no more pages of we find a type
1523      * corresponding to that of a type specified in $ends
1524      *
1525      * @param int $pageid The id of the page to check
1526      * @param array $types An array of types that would signify this page was a subpage
1527      * @param array $ends An array of types that mean this is not a subpage
1528      * @return bool
1529      */
1530     public function is_sub_page_of_type($pageid, array $types, array $ends) {
1531         $pages = $this->load_all_pages();
1532         $pageid = $pages[$pageid]->prevpageid; // move up one
1534         array_unshift($ends, 0);
1535         // go up the pages till branch table
1536         while (true) {
1537             if ($pageid==0 || in_array($pages[$pageid]->qtype, $ends)) {
1538                 return false;
1539             } else if (in_array($pages[$pageid]->qtype, $types)) {
1540                 return true;
1541             }
1542             $pageid = $pages[$pageid]->prevpageid;
1543         }
1544     }
1548 /**
1549  * Abstract class to provide a core functions to the all lesson classes
1550  *
1551  * This class should be abstracted by ALL classes with the lesson module to ensure
1552  * that all classes within this module can be interacted with in the same way.
1553  *
1554  * This class provides the user with a basic properties array that can be fetched
1555  * or set via magic methods, or alternatively by defining methods get_blah() or
1556  * set_blah() within the extending object.
1557  *
1558  * @copyright  2009 Sam Hemelryk
1559  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1560  */
1561 abstract class lesson_base {
1563     /**
1564      * An object containing properties
1565      * @var stdClass
1566      */
1567     protected $properties;
1569     /**
1570      * The constructor
1571      * @param stdClass $properties
1572      */
1573     public function __construct($properties) {
1574         $this->properties = (object)$properties;
1575     }
1577     /**
1578      * Magic property method
1579      *
1580      * Attempts to call a set_$key method if one exists otherwise falls back
1581      * to simply set the property
1582      *
1583      * @param string $key
1584      * @param mixed $value
1585      */
1586     public function __set($key, $value) {
1587         if (method_exists($this, 'set_'.$key)) {
1588             $this->{'set_'.$key}($value);
1589         }
1590         $this->properties->{$key} = $value;
1591     }
1593     /**
1594      * Magic get method
1595      *
1596      * Attempts to call a get_$key method to return the property and ralls over
1597      * to return the raw property
1598      *
1599      * @param str $key
1600      * @return mixed
1601      */
1602     public function __get($key) {
1603         if (method_exists($this, 'get_'.$key)) {
1604             return $this->{'get_'.$key}();
1605         }
1606         return $this->properties->{$key};
1607     }
1609     /**
1610      * Stupid PHP needs an isset magic method if you use the get magic method and
1611      * still want empty calls to work.... blah ~!
1612      *
1613      * @param string $key
1614      * @return bool
1615      */
1616     public function __isset($key) {
1617         if (method_exists($this, 'get_'.$key)) {
1618             $val = $this->{'get_'.$key}();
1619             return !empty($val);
1620         }
1621         return !empty($this->properties->{$key});
1622     }
1624     //NOTE: E_STRICT does not allow to change function signature!
1626     /**
1627      * If implemented should create a new instance, save it in the DB and return it
1628      */
1629     //public static function create() {}
1630     /**
1631      * If implemented should load an instance from the DB and return it
1632      */
1633     //public static function load() {}
1634     /**
1635      * Fetches all of the properties of the object
1636      * @return stdClass
1637      */
1638     public function properties() {
1639         return $this->properties;
1640     }
1644 /**
1645  * Abstract class representation of a page associated with a lesson.
1646  *
1647  * This class should MUST be extended by all specialised page types defined in
1648  * mod/lesson/pagetypes/.
1649  * There are a handful of abstract methods that need to be defined as well as
1650  * severl methods that can optionally be defined in order to make the page type
1651  * operate in the desired way
1652  *
1653  * Database properties
1654  * @property int $id The id of this lesson page
1655  * @property int $lessonid The id of the lesson this page belongs to
1656  * @property int $prevpageid The id of the page before this one
1657  * @property int $nextpageid The id of the next page in the page sequence
1658  * @property int $qtype Identifies the page type of this page
1659  * @property int $qoption Used to record page type specific options
1660  * @property int $layout Used to record page specific layout selections
1661  * @property int $display Used to record page specific display selections
1662  * @property int $timecreated Timestamp for when the page was created
1663  * @property int $timemodified Timestamp for when the page was last modified
1664  * @property string $title The title of this page
1665  * @property string $contents The rich content shown to describe the page
1666  * @property int $contentsformat The format of the contents field
1667  *
1668  * Calculated properties
1669  * @property-read array $answers An array of answers for this page
1670  * @property-read bool $displayinmenublock Toggles display in the left menu block
1671  * @property-read array $jumps An array containing all the jumps this page uses
1672  * @property-read lesson $lesson The lesson this page belongs to
1673  * @property-read int $type The type of the page [question | structure]
1674  * @property-read typeid The unique identifier for the page type
1675  * @property-read typestring The string that describes this page type
1676  *
1677  * @abstract
1678  * @copyright  2009 Sam Hemelryk
1679  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1680  */
1681 abstract class lesson_page extends lesson_base {
1683     /**
1684      * A reference to the lesson this page belongs to
1685      * @var lesson
1686      */
1687     protected $lesson = null;
1688     /**
1689      * Contains the answers to this lesson_page once loaded
1690      * @var null|array
1691      */
1692     protected $answers = null;
1693     /**
1694      * This sets the type of the page, can be one of the constants defined below
1695      * @var int
1696      */
1697     protected $type = 0;
1699     /**
1700      * Constants used to identify the type of the page
1701      */
1702     const TYPE_QUESTION = 0;
1703     const TYPE_STRUCTURE = 1;
1705     /**
1706      * This method should return the integer used to identify the page type within
1707      * the database and throughout code. This maps back to the defines used in 1.x
1708      * @abstract
1709      * @return int
1710      */
1711     abstract protected function get_typeid();
1712     /**
1713      * This method should return the string that describes the pagetype
1714      * @abstract
1715      * @return string
1716      */
1717     abstract protected function get_typestring();
1719     /**
1720      * This method gets called to display the page to the user taking the lesson
1721      * @abstract
1722      * @param object $renderer
1723      * @param object $attempt
1724      * @return string
1725      */
1726     abstract public function display($renderer, $attempt);
1728     /**
1729      * Creates a new lesson_page within the database and returns the correct pagetype
1730      * object to use to interact with the new lesson
1731      *
1732      * @final
1733      * @static
1734      * @param object $properties
1735      * @param lesson $lesson
1736      * @return lesson_page Specialised object that extends lesson_page
1737      */
1738     final public static function create($properties, lesson $lesson, $context, $maxbytes) {
1739         global $DB;
1740         $newpage = new stdClass;
1741         $newpage->title = $properties->title;
1742         $newpage->contents = $properties->contents_editor['text'];
1743         $newpage->contentsformat = $properties->contents_editor['format'];
1744         $newpage->lessonid = $lesson->id;
1745         $newpage->timecreated = time();
1746         $newpage->qtype = $properties->qtype;
1747         $newpage->qoption = (isset($properties->qoption))?1:0;
1748         $newpage->layout = (isset($properties->layout))?1:0;
1749         $newpage->display = (isset($properties->display))?1:0;
1750         $newpage->prevpageid = 0; // this is a first page
1751         $newpage->nextpageid = 0; // this is the only page
1753         if ($properties->pageid) {
1754             $prevpage = $DB->get_record("lesson_pages", array("id" => $properties->pageid), 'id, nextpageid');
1755             if (!$prevpage) {
1756                 print_error('cannotfindpages', 'lesson');
1757             }
1758             $newpage->prevpageid = $prevpage->id;
1759             $newpage->nextpageid = $prevpage->nextpageid;
1760         } else {
1761             $nextpage = $DB->get_record('lesson_pages', array('lessonid'=>$lesson->id, 'prevpageid'=>0), 'id');
1762             if ($nextpage) {
1763                 // This is the first page, there are existing pages put this at the start
1764                 $newpage->nextpageid = $nextpage->id;
1765             }
1766         }
1768         $newpage->id = $DB->insert_record("lesson_pages", $newpage);
1770         $editor = new stdClass;
1771         $editor->id = $newpage->id;
1772         $editor->contents_editor = $properties->contents_editor;
1773         $editor = file_postupdate_standard_editor($editor, 'contents', array('noclean'=>true, 'maxfiles'=>EDITOR_UNLIMITED_FILES, 'maxbytes'=>$maxbytes), $context, 'mod_lesson', 'page_contents', $editor->id);
1774         $DB->update_record("lesson_pages", $editor);
1776         if ($newpage->prevpageid > 0) {
1777             $DB->set_field("lesson_pages", "nextpageid", $newpage->id, array("id" => $newpage->prevpageid));
1778         }
1779         if ($newpage->nextpageid > 0) {
1780             $DB->set_field("lesson_pages", "prevpageid", $newpage->id, array("id" => $newpage->nextpageid));
1781         }
1783         $page = lesson_page::load($newpage, $lesson);
1784         $page->create_answers($properties);
1786         $lesson->add_message(get_string('insertedpage', 'lesson').': '.format_string($newpage->title, true), 'notifysuccess');
1788         return $page;
1789     }
1791     /**
1792      * This method loads a page object from the database and returns it as a
1793      * specialised object that extends lesson_page
1794      *
1795      * @final
1796      * @static
1797      * @param int $id
1798      * @param lesson $lesson
1799      * @return lesson_page Specialised lesson_page object
1800      */
1801     final public static function load($id, lesson $lesson) {
1802         global $DB;
1804         if (is_object($id) && !empty($id->qtype)) {
1805             $page = $id;
1806         } else {
1807             $page = $DB->get_record("lesson_pages", array("id" => $id));
1808             if (!$page) {
1809                 print_error('cannotfindpages', 'lesson');
1810             }
1811         }
1812         $manager = lesson_page_type_manager::get($lesson);
1814         $class = 'lesson_page_type_'.$manager->get_page_type_idstring($page->qtype);
1815         if (!class_exists($class)) {
1816             $class = 'lesson_page';
1817         }
1819         return new $class($page, $lesson);
1820     }
1822     /**
1823      * Deletes a lesson_page from the database as well as any associated records.
1824      * @final
1825      * @return bool
1826      */
1827     final public function delete() {
1828         global $DB;
1829         // first delete all the associated records...
1830         $DB->delete_records("lesson_attempts", array("pageid" => $this->properties->id));
1831         // ...now delete the answers...
1832         $DB->delete_records("lesson_answers", array("pageid" => $this->properties->id));
1833         // ..and the page itself
1834         $DB->delete_records("lesson_pages", array("id" => $this->properties->id));
1836         // repair the hole in the linkage
1837         if (!$this->properties->prevpageid && !$this->properties->nextpageid) {
1838             //This is the only page, no repair needed
1839         } elseif (!$this->properties->prevpageid) {
1840             // this is the first page...
1841             $page = $this->lesson->load_page($this->properties->nextpageid);
1842             $page->move(null, 0);
1843         } elseif (!$this->properties->nextpageid) {
1844             // this is the last page...
1845             $page = $this->lesson->load_page($this->properties->prevpageid);
1846             $page->move(0);
1847         } else {
1848             // page is in the middle...
1849             $prevpage = $this->lesson->load_page($this->properties->prevpageid);
1850             $nextpage = $this->lesson->load_page($this->properties->nextpageid);
1852             $prevpage->move($nextpage->id);
1853             $nextpage->move(null, $prevpage->id);
1854         }
1855         return true;
1856     }
1858     /**
1859      * Moves a page by updating its nextpageid and prevpageid values within
1860      * the database
1861      *
1862      * @final
1863      * @param int $nextpageid
1864      * @param int $prevpageid
1865      */
1866     final public function move($nextpageid=null, $prevpageid=null) {
1867         global $DB;
1868         if ($nextpageid === null) {
1869             $nextpageid = $this->properties->nextpageid;
1870         }
1871         if ($prevpageid === null) {
1872             $prevpageid = $this->properties->prevpageid;
1873         }
1874         $obj = new stdClass;
1875         $obj->id = $this->properties->id;
1876         $obj->prevpageid = $prevpageid;
1877         $obj->nextpageid = $nextpageid;
1878         $DB->update_record('lesson_pages', $obj);
1879     }
1881     /**
1882      * Returns the answers that are associated with this page in the database
1883      *
1884      * @final
1885      * @return array
1886      */
1887     final public function get_answers() {
1888         global $DB;
1889         if ($this->answers === null) {
1890             $this->answers = array();
1891             $answers = $DB->get_records('lesson_answers', array('pageid'=>$this->properties->id, 'lessonid'=>$this->lesson->id), 'id');
1892             if (!$answers) {
1893                 // It is possible that a lesson upgraded from Moodle 1.9 still
1894                 // contains questions without any answers [MDL-25632].
1895                 // debugging(get_string('cannotfindanswer', 'lesson'));
1896                 return array();
1897             }
1898             foreach ($answers as $answer) {
1899                 $this->answers[count($this->answers)] = new lesson_page_answer($answer);
1900             }
1901         }
1902         return $this->answers;
1903     }
1905     /**
1906      * Returns the lesson this page is associated with
1907      * @final
1908      * @return lesson
1909      */
1910     final protected function get_lesson() {
1911         return $this->lesson;
1912     }
1914     /**
1915      * Returns the type of page this is. Not to be confused with page type
1916      * @final
1917      * @return int
1918      */
1919     final protected function get_type() {
1920         return $this->type;
1921     }
1923     /**
1924      * Records an attempt at this page
1925      *
1926      * @final
1927      * @global moodle_database $DB
1928      * @param stdClass $context
1929      * @return stdClass Returns the result of the attempt
1930      */
1931     final public function record_attempt($context) {
1932         global $DB, $USER, $OUTPUT;
1934         /**
1935          * This should be overridden by each page type to actually check the response
1936          * against what ever custom criteria they have defined
1937          */
1938         $result = $this->check_answer();
1940         $result->attemptsremaining  = 0;
1941         $result->maxattemptsreached = false;
1943         if ($result->noanswer) {
1944             $result->newpageid = $this->properties->id; // display same page again
1945             $result->feedback  = get_string('noanswer', 'lesson');
1946         } else {
1947             if (!has_capability('mod/lesson:manage', $context)) {
1948                 $nretakes = $DB->count_records("lesson_grades", array("lessonid"=>$this->lesson->id, "userid"=>$USER->id));
1949                 // record student's attempt
1950                 $attempt = new stdClass;
1951                 $attempt->lessonid = $this->lesson->id;
1952                 $attempt->pageid = $this->properties->id;
1953                 $attempt->userid = $USER->id;
1954                 $attempt->answerid = $result->answerid;
1955                 $attempt->retry = $nretakes;
1956                 $attempt->correct = $result->correctanswer;
1957                 if($result->userresponse !== null) {
1958                     $attempt->useranswer = $result->userresponse;
1959                 }
1961                 $attempt->timeseen = time();
1962                 // if allow modattempts, then update the old attempt record, otherwise, insert new answer record
1963                 if (isset($USER->modattempts[$this->lesson->id])) {
1964                     $attempt->retry = $nretakes - 1; // they are going through on review, $nretakes will be too high
1965                 }
1967                 if ($this->lesson->retake || (!$this->lesson->retake && $nretakes == 0)) {
1968                     $DB->insert_record("lesson_attempts", $attempt);
1969                 }
1970                 // "number of attempts remaining" message if $this->lesson->maxattempts > 1
1971                 // displaying of message(s) is at the end of page for more ergonomic display
1972                 if (!$result->correctanswer && ($result->newpageid == 0)) {
1973                     // wrong answer and student is stuck on this page - check how many attempts
1974                     // the student has had at this page/question
1975                     $nattempts = $DB->count_records("lesson_attempts", array("pageid"=>$this->properties->id, "userid"=>$USER->id, "retry" => $attempt->retry));
1976                     // retreive the number of attempts left counter for displaying at bottom of feedback page
1977                     if ($nattempts >= $this->lesson->maxattempts) {
1978                         if ($this->lesson->maxattempts > 1) { // don't bother with message if only one attempt
1979                             $result->maxattemptsreached = true;
1980                         }
1981                         $result->newpageid = LESSON_NEXTPAGE;
1982                     } else if ($this->lesson->maxattempts > 1) { // don't bother with message if only one attempt
1983                         $result->attemptsremaining = $this->lesson->maxattempts - $nattempts;
1984                     }
1985                 }
1986             }
1987             // TODO: merge this code with the jump code below.  Convert jumpto page into a proper page id
1988             if ($result->newpageid == 0) {
1989                 $result->newpageid = $this->properties->id;
1990             } elseif ($result->newpageid == LESSON_NEXTPAGE) {
1991                 $result->newpageid = $this->lesson->get_next_page($this->properties->nextpageid);
1992             }
1994             // Determine default feedback if necessary
1995             if (empty($result->response)) {
1996                 if (!$this->lesson->feedback && !$result->noanswer && !($this->lesson->review & !$result->correctanswer && !$result->isessayquestion)) {
1997                     // These conditions have been met:
1998                     //  1. The lesson manager has not supplied feedback to the student
1999                     //  2. Not displaying default feedback
2000                     //  3. The user did provide an answer
2001                     //  4. We are not reviewing with an incorrect answer (and not reviewing an essay question)
2003                     $result->nodefaultresponse = true;  // This will cause a redirect below
2004                 } else if ($result->isessayquestion) {
2005                     $result->response = get_string('defaultessayresponse', 'lesson');
2006                 } else if ($result->correctanswer) {
2007                     $result->response = get_string('thatsthecorrectanswer', 'lesson');
2008                 } else {
2009                     $result->response = get_string('thatsthewronganswer', 'lesson');
2010                 }
2011             }
2013             if ($result->response) {
2014                 if ($this->lesson->review && !$result->correctanswer && !$result->isessayquestion) {
2015                     $nretakes = $DB->count_records("lesson_grades", array("lessonid"=>$this->lesson->id, "userid"=>$USER->id));
2016                     $qattempts = $DB->count_records("lesson_attempts", array("userid"=>$USER->id, "retry"=>$nretakes, "pageid"=>$this->properties->id));
2017                     if ($qattempts == 1) {
2018                         $result->feedback = $OUTPUT->box(get_string("firstwrong", "lesson"), 'feedback');
2019                     } else {
2020                         $result->feedback = $OUTPUT->BOX(get_string("secondpluswrong", "lesson"), 'feedback');
2021                     }
2022                 } else {
2023                     $class = 'response';
2024                     if ($result->correctanswer) {
2025                         $class .= ' correct'; //CSS over-ride this if they exist (!important)
2026                     } else if (!$result->isessayquestion) {
2027                         $class .= ' incorrect'; //CSS over-ride this if they exist (!important)
2028                     }
2029                     $options = new stdClass;
2030                     $options->noclean = true;
2031                     $options->para = true;
2032                     $options->overflowdiv = true;
2033                     $result->feedback = $OUTPUT->box(format_text($this->get_contents(), $this->properties->contentsformat, $options), 'generalbox boxaligncenter');
2034                     $result->feedback .= '<div class="correctanswer generalbox"><em>'.get_string("youranswer", "lesson").'</em> : '.$result->studentanswer; // already in clean html
2035                     $result->feedback .= $OUTPUT->box($result->response, $class); // already conerted to HTML
2036                     $result->feedback .= '</div>';
2037                 }
2038             }
2039         }
2041         return $result;
2042     }
2044     /**
2045      * Returns the string for a jump name
2046      *
2047      * @final
2048      * @param int $jumpto Jump code or page ID
2049      * @return string
2050      **/
2051     final protected function get_jump_name($jumpto) {
2052         global $DB;
2053         static $jumpnames = array();
2055         if (!array_key_exists($jumpto, $jumpnames)) {
2056             if ($jumpto == LESSON_THISPAGE) {
2057                 $jumptitle = get_string('thispage', 'lesson');
2058             } elseif ($jumpto == LESSON_NEXTPAGE) {
2059                 $jumptitle = get_string('nextpage', 'lesson');
2060             } elseif ($jumpto == LESSON_EOL) {
2061                 $jumptitle = get_string('endoflesson', 'lesson');
2062             } elseif ($jumpto == LESSON_UNSEENBRANCHPAGE) {
2063                 $jumptitle = get_string('unseenpageinbranch', 'lesson');
2064             } elseif ($jumpto == LESSON_PREVIOUSPAGE) {
2065                 $jumptitle = get_string('previouspage', 'lesson');
2066             } elseif ($jumpto == LESSON_RANDOMPAGE) {
2067                 $jumptitle = get_string('randompageinbranch', 'lesson');
2068             } elseif ($jumpto == LESSON_RANDOMBRANCH) {
2069                 $jumptitle = get_string('randombranch', 'lesson');
2070             } elseif ($jumpto == LESSON_CLUSTERJUMP) {
2071                 $jumptitle = get_string('clusterjump', 'lesson');
2072             } else {
2073                 if (!$jumptitle = $DB->get_field('lesson_pages', 'title', array('id' => $jumpto))) {
2074                     $jumptitle = '<strong>'.get_string('notdefined', 'lesson').'</strong>';
2075                 }
2076             }
2077             $jumpnames[$jumpto] = format_string($jumptitle,true);
2078         }
2080         return $jumpnames[$jumpto];
2081     }
2083     /**
2084      * Constructor method
2085      * @param object $properties
2086      * @param lesson $lesson
2087      */
2088     public function __construct($properties, lesson $lesson) {
2089         parent::__construct($properties);
2090         $this->lesson = $lesson;
2091     }
2093     /**
2094      * Returns the score for the attempt
2095      * This may be overridden by page types that require manual grading
2096      * @param array $answers
2097      * @param object $attempt
2098      * @return int
2099      */
2100     public function earned_score($answers, $attempt) {
2101         return $answers[$attempt->answerid]->score;
2102     }
2104     /**
2105      * This is a callback method that can be override and gets called when ever a page
2106      * is viewed
2107      *
2108      * @param bool $canmanage True if the user has the manage cap
2109      * @return mixed
2110      */
2111     public function callback_on_view($canmanage) {
2112         return true;
2113     }
2115     /**
2116      * Updates a lesson page and its answers within the database
2117      *
2118      * @param object $properties
2119      * @return bool
2120      */
2121     public function update($properties, $context = null, $maxbytes = null) {
2122         global $DB, $PAGE;
2123         $answers  = $this->get_answers();
2124         $properties->id = $this->properties->id;
2125         $properties->lessonid = $this->lesson->id;
2126         if (empty($properties->qoption)) {
2127             $properties->qoption = '0';
2128         }
2129         if (empty($context)) {
2130             $context = $PAGE->context;
2131         }
2132         if ($maxbytes === null) {
2133             $maxbytes =get_max_upload_file_size();
2134         }
2135         $properties = file_postupdate_standard_editor($properties, 'contents', array('noclean'=>true, 'maxfiles'=>EDITOR_UNLIMITED_FILES, 'maxbytes'=>$maxbytes), $context, 'mod_lesson', 'page_contents', $properties->id);
2136         $DB->update_record("lesson_pages", $properties);
2138         for ($i = 0; $i < $this->lesson->maxanswers; $i++) {
2139             if (!array_key_exists($i, $this->answers)) {
2140                 $this->answers[$i] = new stdClass;
2141                 $this->answers[$i]->lessonid = $this->lesson->id;
2142                 $this->answers[$i]->pageid = $this->id;
2143                 $this->answers[$i]->timecreated = $this->timecreated;
2144             }
2146             if (!empty($properties->answer_editor[$i]) && is_array($properties->answer_editor[$i])) {
2147                 $this->answers[$i]->answer = $properties->answer_editor[$i]['text'];
2148                 $this->answers[$i]->answerformat = $properties->answer_editor[$i]['format'];
2149             }
2150             if (!empty($properties->response_editor[$i]) && is_array($properties->response_editor[$i])) {
2151                 $this->answers[$i]->response = $properties->response_editor[$i]['text'];
2152                 $this->answers[$i]->responseformat = $properties->response_editor[$i]['format'];
2153             }
2155             // we don't need to check for isset here because properties called it's own isset method.
2156             if ($this->answers[$i]->answer != '') {
2157                 if (isset($properties->jumpto[$i])) {
2158                     $this->answers[$i]->jumpto = $properties->jumpto[$i];
2159                 }
2160                 if ($this->lesson->custom && isset($properties->score[$i])) {
2161                     $this->answers[$i]->score = $properties->score[$i];
2162                 }
2163                 if (!isset($this->answers[$i]->id)) {
2164                     $this->answers[$i]->id =  $DB->insert_record("lesson_answers", $this->answers[$i]);
2165                 } else {
2166                     $DB->update_record("lesson_answers", $this->answers[$i]->properties());
2167                 }
2169             } else if (isset($this->answers[$i]->id)) {
2170                 $DB->delete_records('lesson_answers', array('id'=>$this->answers[$i]->id));
2171                 unset($this->answers[$i]);
2172             }
2173         }
2174         return true;
2175     }
2177     /**
2178      * Can be set to true if the page requires a static link to create a new instance
2179      * instead of simply being included in the dropdown
2180      * @param int $previd
2181      * @return bool
2182      */
2183     public function add_page_link($previd) {
2184         return false;
2185     }
2187     /**
2188      * Returns true if a page has been viewed before
2189      *
2190      * @param array|int $param Either an array of pages that have been seen or the
2191      *                   number of retakes a user has had
2192      * @return bool
2193      */
2194     public function is_unseen($param) {
2195         global $USER, $DB;
2196         if (is_array($param)) {
2197             $seenpages = $param;
2198             return (!array_key_exists($this->properties->id, $seenpages));
2199         } else {
2200             $nretakes = $param;
2201             if (!$DB->count_records("lesson_attempts", array("pageid"=>$this->properties->id, "userid"=>$USER->id, "retry"=>$nretakes))) {
2202                 return true;
2203             }
2204         }
2205         return false;
2206     }
2208     /**
2209      * Checks to see if a page has been answered previously
2210      * @param int $nretakes
2211      * @return bool
2212      */
2213     public function is_unanswered($nretakes) {
2214         global $DB, $USER;
2215         if (!$DB->count_records("lesson_attempts", array('pageid'=>$this->properties->id, 'userid'=>$USER->id, 'correct'=>1, 'retry'=>$nretakes))) {
2216             return true;
2217         }
2218         return false;
2219     }
2221     /**
2222      * Creates answers within the database for this lesson_page. Usually only ever
2223      * called when creating a new page instance
2224      * @param object $properties
2225      * @return array
2226      */
2227     public function create_answers($properties) {
2228         global $DB;
2229         // now add the answers
2230         $newanswer = new stdClass;
2231         $newanswer->lessonid = $this->lesson->id;
2232         $newanswer->pageid = $this->properties->id;
2233         $newanswer->timecreated = $this->properties->timecreated;
2235         $answers = array();
2237         for ($i = 0; $i < $this->lesson->maxanswers; $i++) {
2238             $answer = clone($newanswer);
2240             if (!empty($properties->answer_editor[$i]) && is_array($properties->answer_editor[$i])) {
2241                 $answer->answer = $properties->answer_editor[$i]['text'];
2242                 $answer->answerformat = $properties->answer_editor[$i]['format'];
2243             }
2244             if (!empty($properties->response_editor[$i]) && is_array($properties->response_editor[$i])) {
2245                 $answer->response = $properties->response_editor[$i]['text'];
2246                 $answer->responseformat = $properties->response_editor[$i]['format'];
2247             }
2249             if (isset($answer->answer) && $answer->answer != '') {
2250                 if (isset($properties->jumpto[$i])) {
2251                     $answer->jumpto = $properties->jumpto[$i];
2252                 }
2253                 if ($this->lesson->custom && isset($properties->score[$i])) {
2254                     $answer->score = $properties->score[$i];
2255                 }
2256                 $answer->id = $DB->insert_record("lesson_answers", $answer);
2257                 $answers[$answer->id] = new lesson_page_answer($answer);
2258             } else {
2259                 break;
2260             }
2261         }
2263         $this->answers = $answers;
2264         return $answers;
2265     }
2267     /**
2268      * This method MUST be overridden by all question page types, or page types that
2269      * wish to score a page.
2270      *
2271      * The structure of result should always be the same so it is a good idea when
2272      * overriding this method on a page type to call
2273      * <code>
2274      * $result = parent::check_answer();
2275      * </code>
2276      * before modifying it as required.
2277      *
2278      * @return stdClass
2279      */
2280     public function check_answer() {
2281         $result = new stdClass;
2282         $result->answerid        = 0;
2283         $result->noanswer        = false;
2284         $result->correctanswer   = false;
2285         $result->isessayquestion = false;   // use this to turn off review button on essay questions
2286         $result->response        = '';
2287         $result->newpageid       = 0;       // stay on the page
2288         $result->studentanswer   = '';      // use this to store student's answer(s) in order to display it on feedback page
2289         $result->userresponse    = null;
2290         $result->feedback        = '';
2291         $result->nodefaultresponse  = false; // Flag for redirecting when default feedback is turned off
2292         return $result;
2293     }
2295     /**
2296      * True if the page uses a custom option
2297      *
2298      * Should be override and set to true if the page uses a custom option.
2299      *
2300      * @return bool
2301      */
2302     public function has_option() {
2303         return false;
2304     }
2306     /**
2307      * Returns the maximum number of answers for this page given the maximum number
2308      * of answers permitted by the lesson.
2309      *
2310      * @param int $default
2311      * @return int
2312      */
2313     public function max_answers($default) {
2314         return $default;
2315     }
2317     /**
2318      * Returns the properties of this lesson page as an object
2319      * @return stdClass;
2320      */
2321     public function properties() {
2322         $properties = clone($this->properties);
2323         if ($this->answers === null) {
2324             $this->get_answers();
2325         }
2326         if (count($this->answers)>0) {
2327             $count = 0;
2328             foreach ($this->answers as $answer) {
2329                 $properties->{'answer_editor['.$count.']'} = array('text'=>$answer->answer, 'format'=>$answer->answerformat);
2330                 $properties->{'response_editor['.$count.']'} = array('text'=>$answer->response, 'format'=>$answer->responseformat);
2331                 $properties->{'jumpto['.$count.']'} = $answer->jumpto;
2332                 $properties->{'score['.$count.']'} = $answer->score;
2333                 $count++;
2334             }
2335         }
2336         return $properties;
2337     }
2339     /**
2340      * Returns an array of options to display when choosing the jumpto for a page/answer
2341      * @static
2342      * @param int $pageid
2343      * @param lesson $lesson
2344      * @return array
2345      */
2346     public static function get_jumptooptions($pageid, lesson $lesson) {
2347         global $DB;
2348         $jump = array();
2349         $jump[0] = get_string("thispage", "lesson");
2350         $jump[LESSON_NEXTPAGE] = get_string("nextpage", "lesson");
2351         $jump[LESSON_PREVIOUSPAGE] = get_string("previouspage", "lesson");
2352         $jump[LESSON_EOL] = get_string("endoflesson", "lesson");
2354         if ($pageid == 0) {
2355             return $jump;
2356         }
2358         $pages = $lesson->load_all_pages();
2359         if ($pages[$pageid]->qtype == LESSON_PAGE_BRANCHTABLE || $lesson->is_sub_page_of_type($pageid, array(LESSON_PAGE_BRANCHTABLE), array(LESSON_PAGE_ENDOFBRANCH, LESSON_PAGE_CLUSTER))) {
2360             $jump[LESSON_UNSEENBRANCHPAGE] = get_string("unseenpageinbranch", "lesson");
2361             $jump[LESSON_RANDOMPAGE] = get_string("randompageinbranch", "lesson");
2362         }
2363         if($pages[$pageid]->qtype == LESSON_PAGE_CLUSTER || $lesson->is_sub_page_of_type($pageid, array(LESSON_PAGE_CLUSTER), array(LESSON_PAGE_ENDOFCLUSTER))) {
2364             $jump[LESSON_CLUSTERJUMP] = get_string("clusterjump", "lesson");
2365         }
2366         if (!optional_param('firstpage', 0, PARAM_INT)) {
2367             $apageid = $DB->get_field("lesson_pages", "id", array("lessonid" => $lesson->id, "prevpageid" => 0));
2368             while (true) {
2369                 if ($apageid) {
2370                     $title = $DB->get_field("lesson_pages", "title", array("id" => $apageid));
2371                     $jump[$apageid] = strip_tags(format_string($title,true));
2372                     $apageid = $DB->get_field("lesson_pages", "nextpageid", array("id" => $apageid));
2373                 } else {
2374                     // last page reached
2375                     break;
2376                 }
2377             }
2378         }
2379         return $jump;
2380     }
2381     /**
2382      * Returns the contents field for the page properly formatted and with plugin
2383      * file url's converted
2384      * @return string
2385      */
2386     public function get_contents() {
2387         global $PAGE;
2388         if (!empty($this->properties->contents)) {
2389             if (!isset($this->properties->contentsformat)) {
2390                 $this->properties->contentsformat = FORMAT_HTML;
2391             }
2392             $context = get_context_instance(CONTEXT_MODULE, $PAGE->cm->id);
2393             $contents = file_rewrite_pluginfile_urls($this->properties->contents, 'pluginfile.php', $context->id, 'mod_lesson', 'page_contents', $this->properties->id); // must do this BEFORE format_text()!!!!!!
2394             return format_text($contents, $this->properties->contentsformat, array('context'=>$context, 'noclean'=>true)); // page edit is marked with XSS, we want all content here
2395         } else {
2396             return '';
2397         }
2398     }
2400     /**
2401      * Set to true if this page should display in the menu block
2402      * @return bool
2403      */
2404     protected function get_displayinmenublock() {
2405         return false;
2406     }
2408     /**
2409      * Get the string that describes the options of this page type
2410      * @return string
2411      */
2412     public function option_description_string() {
2413         return '';
2414     }
2416     /**
2417      * Updates a table with the answers for this page
2418      * @param html_table $table
2419      * @return html_table
2420      */
2421     public function display_answers(html_table $table) {
2422         $answers = $this->get_answers();
2423         $i = 1;
2424         foreach ($answers as $answer) {
2425             $cells = array();
2426             $cells[] = "<span class=\"label\">".get_string("jump", "lesson")." $i<span>: ";
2427             $cells[] = $this->get_jump_name($answer->jumpto);
2428             $table->data[] = new html_table_row($cells);
2429             if ($i === 1){
2430                 $table->data[count($table->data)-1]->cells[0]->style = 'width:20%;';
2431             }
2432             $i++;
2433         }
2434         return $table;
2435     }
2437     /**
2438      * Determines if this page should be grayed out on the management/report screens
2439      * @return int 0 or 1
2440      */
2441     protected function get_grayout() {
2442         return 0;
2443     }
2445     /**
2446      * Adds stats for this page to the &pagestats object. This should be defined
2447      * for all page types that grade
2448      * @param array $pagestats
2449      * @param int $tries
2450      * @return bool
2451      */
2452     public function stats(array &$pagestats, $tries) {
2453         return true;
2454     }
2456     /**
2457      * Formats the answers of this page for a report
2458      *
2459      * @param object $answerpage
2460      * @param object $answerdata
2461      * @param object $useranswer
2462      * @param array $pagestats
2463      * @param int $i Count of first level answers
2464      * @param int $n Count of second level answers
2465      * @return object The answer page for this
2466      */
2467     public function report_answers($answerpage, $answerdata, $useranswer, $pagestats, &$i, &$n) {
2468         $answers = $this->get_answers();
2469         $formattextdefoptions = new stdClass;
2470         $formattextdefoptions->para = false;  //I'll use it widely in this page
2471         foreach ($answers as $answer) {
2472             $data = get_string('jumpsto', 'lesson', $this->get_jump_name($answer->jumpto));
2473             $answerdata->answers[] = array($data, "");
2474             $answerpage->answerdata = $answerdata;
2475         }
2476         return $answerpage;
2477     }
2479     /**
2480      * Gets an array of the jumps used by the answers of this page
2481      *
2482      * @return array
2483      */
2484     public function get_jumps() {
2485         global $DB;
2486         $jumps = array();
2487         $params = array ("lessonid" => $this->lesson->id, "pageid" => $this->properties->id);
2488         if ($answers = $this->get_answers()) {
2489             foreach ($answers as $answer) {
2490                 $jumps[] = $this->get_jump_name($answer->jumpto);
2491             }
2492         } else {
2493             $jumps[] = $this->get_jump_name($this->properties->nextpageid);
2494         }
2495         return $jumps;
2496     }
2497     /**
2498      * Informs whether this page type require manual grading or not
2499      * @return bool
2500      */
2501     public function requires_manual_grading() {
2502         return false;
2503     }
2505     /**
2506      * A callback method that allows a page to override the next page a user will
2507      * see during when this page is being completed.
2508      * @return false|int
2509      */
2510     public function override_next_page() {
2511         return false;
2512     }
2514     /**
2515      * This method is used to determine if this page is a valid page
2516      *
2517      * @param array $validpages
2518      * @param array $pageviews
2519      * @return int The next page id to check
2520      */
2521     public function valid_page_and_view(&$validpages, &$pageviews) {
2522         $validpages[$this->properties->id] = 1;
2523         return $this->properties->nextpageid;
2524     }
2529 /**
2530  * Class used to represent an answer to a page
2531  *
2532  * @property int $id The ID of this answer in the database
2533  * @property int $lessonid The ID of the lesson this answer belongs to
2534  * @property int $pageid The ID of the page this answer belongs to
2535  * @property int $jumpto Identifies where the user goes upon completing a page with this answer
2536  * @property int $grade The grade this answer is worth
2537  * @property int $score The score this answer will give
2538  * @property int $flags Used to store options for the answer
2539  * @property int $timecreated A timestamp of when the answer was created
2540  * @property int $timemodified A timestamp of when the answer was modified
2541  * @property string $answer The answer itself
2542  * @property string $response The response the user sees if selecting this answer
2543  *
2544  * @copyright  2009 Sam Hemelryk
2545  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2546  */
2547 class lesson_page_answer extends lesson_base {
2549     /**
2550      * Loads an page answer from the DB
2551      *
2552      * @param int $id
2553      * @return lesson_page_answer
2554      */
2555     public static function load($id) {
2556         global $DB;
2557         $answer = $DB->get_record("lesson_answers", array("id" => $id));
2558         return new lesson_page_answer($answer);
2559     }
2561     /**
2562      * Given an object of properties and a page created answer(s) and saves them
2563      * in the database.
2564      *
2565      * @param stdClass $properties
2566      * @param lesson_page $page
2567      * @return array
2568      */
2569     public static function create($properties, lesson_page $page) {
2570         return $page->create_answers($properties);
2571     }
2575 /**
2576  * A management class for page types
2577  *
2578  * This class is responsible for managing the different pages. A manager object can
2579  * be retrieved by calling the following line of code:
2580  * <code>
2581  * $manager  = lesson_page_type_manager::get($lesson);
2582  * </code>
2583  * The first time the page type manager is retrieved the it includes all of the
2584  * different page types located in mod/lesson/pagetypes.
2585  *
2586  * @copyright  2009 Sam Hemelryk
2587  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2588  */
2589 class lesson_page_type_manager {
2591     /**
2592      * An array of different page type classes
2593      * @var array
2594      */
2595     protected $types = array();
2597     /**
2598      * Retrieves the lesson page type manager object
2599      *
2600      * If the object hasn't yet been created it is created here.
2601      *
2602      * @staticvar lesson_page_type_manager $pagetypemanager
2603      * @param lesson $lesson
2604      * @return lesson_page_type_manager
2605      */
2606     public static function get(lesson $lesson) {
2607         static $pagetypemanager;
2608         if (!($pagetypemanager instanceof lesson_page_type_manager)) {
2609             $pagetypemanager = new lesson_page_type_manager();
2610             $pagetypemanager->load_lesson_types($lesson);
2611         }
2612         return $pagetypemanager;
2613     }
2615     /**
2616      * Finds and loads all lesson page types in mod/lesson/pagetypes
2617      *
2618      * @param lesson $lesson
2619      */
2620     public function load_lesson_types(lesson $lesson) {
2621         global $CFG;
2622         $basedir = $CFG->dirroot.'/mod/lesson/pagetypes/';
2623         $dir = dir($basedir);
2624         while (false !== ($entry = $dir->read())) {
2625             if (strpos($entry, '.')===0 || !preg_match('#^[a-zA-Z]+\.php#i', $entry)) {
2626                 continue;
2627             }
2628             require_once($basedir.$entry);
2629             $class = 'lesson_page_type_'.strtok($entry,'.');
2630             if (class_exists($class)) {
2631                 $pagetype = new $class(new stdClass, $lesson);
2632                 $this->types[$pagetype->typeid] = $pagetype;
2633             }
2634         }
2636     }
2638     /**
2639      * Returns an array of strings to describe the loaded page types
2640      *
2641      * @param int $type Can be used to return JUST the string for the requested type
2642      * @return array
2643      */
2644     public function get_page_type_strings($type=null, $special=true) {
2645         $types = array();
2646         foreach ($this->types as $pagetype) {
2647             if (($type===null || $pagetype->type===$type) && ($special===true || $pagetype->is_standard())) {
2648                 $types[$pagetype->typeid] = $pagetype->typestring;
2649             }
2650         }
2651         return $types;
2652     }
2654     /**
2655      * Returns the basic string used to identify a page type provided with an id
2656      *
2657      * This string can be used to instantiate or identify the page type class.
2658      * If the page type id is unknown then 'unknown' is returned
2659      *
2660      * @param int $id
2661      * @return string
2662      */
2663     public function get_page_type_idstring($id) {
2664         foreach ($this->types as $pagetype) {
2665             if ((int)$pagetype->typeid === (int)$id) {
2666                 return $pagetype->idstring;
2667             }
2668         }
2669         return 'unknown';
2670     }
2672     /**
2673      * Loads a page for the provided lesson given it's id
2674      *
2675      * This function loads a page from the lesson when given both the lesson it belongs
2676      * to as well as the page's id.
2677      * If the page doesn't exist an error is thrown
2678      *
2679      * @param int $pageid The id of the page to load
2680      * @param lesson $lesson The lesson the page belongs to
2681      * @return lesson_page A class that extends lesson_page
2682      */
2683     public function load_page($pageid, lesson $lesson) {
2684         global $DB;
2685         if (!($page =$DB->get_record('lesson_pages', array('id'=>$pageid, 'lessonid'=>$lesson->id)))) {
2686             print_error('cannotfindpages', 'lesson');
2687         }
2688         $pagetype = get_class($this->types[$page->qtype]);
2689         $page = new $pagetype($page, $lesson);
2690         return $page;
2691     }
2693     /**
2694      * This function loads ALL pages that belong to the lesson.
2695      *
2696      * @param lesson $lesson
2697      * @return array An array of lesson_page_type_*
2698      */
2699     public function load_all_pages(lesson $lesson) {
2700         global $DB;
2701         if (!($pages =$DB->get_records('lesson_pages', array('lessonid'=>$lesson->id)))) {
2702             print_error('cannotfindpages', 'lesson');
2703         }
2704         foreach ($pages as $key=>$page) {
2705             $pagetype = get_class($this->types[$page->qtype]);
2706             $pages[$key] = new $pagetype($page, $lesson);
2707         }
2709         $orderedpages = array();
2710         $lastpageid = 0;
2712         while (true) {
2713             foreach ($pages as $page) {
2714                 if ((int)$page->prevpageid === (int)$lastpageid) {
2715                     $orderedpages[$page->id] = $page;
2716                     unset($pages[$page->id]);
2717                     $lastpageid = $page->id;
2718                     if ((int)$page->nextpageid===0) {
2719                         break 2;
2720                     } else {
2721                         break 1;
2722                     }
2723                 }
2724             }
2725         }
2727         return $orderedpages;
2728     }
2730     /**
2731      * Fetches an mform that can be used to create/edit an page
2732      *
2733      * @param int $type The id for the page type
2734      * @param array $arguments Any arguments to pass to the mform
2735      * @return lesson_add_page_form_base
2736      */
2737     public function get_page_form($type, $arguments) {
2738         $class = 'lesson_add_page_form_'.$this->get_page_type_idstring($type);
2739         if (!class_exists($class) || get_parent_class($class)!=='lesson_add_page_form_base') {
2740             debugging('Lesson page type unknown class requested '.$class, DEBUG_DEVELOPER);
2741             $class = 'lesson_add_page_form_selection';
2742         } else if ($class === 'lesson_add_page_form_unknown') {
2743             $class = 'lesson_add_page_form_selection';
2744         }
2745         return new $class(null, $arguments);
2746     }
2748     /**
2749      * Returns an array of links to use as add page links
2750      * @param int $previd The id of the previous page
2751      * @return array
2752      */
2753     public function get_add_page_type_links($previd) {
2754         global $OUTPUT;
2756         $links = array();
2758         foreach ($this->types as $key=>$type) {
2759             if ($link = $type->add_page_link($previd)) {
2760                 $links[$key] = $link;
2761             }
2762         }
2764         return $links;
2765     }