MDL-29624 Media embedding system, part 3: resource module (and URL, lesson)
[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     $mediarenderer = $PAGE->get_renderer('core', 'media');
613     $embedoptions = array(
614         core_media::OPTION_TRUSTED => true,
615         core_media::OPTION_BLOCK => true
616     );
618     // find the correct type and print it out
619     if (in_array($mimetype, array('image/gif','image/jpeg','image/png'))) {  // It's an image
620         $code = resourcelib_embed_image($url, $title);
622     } else if ($mediarenderer->can_embed_url($url, $embedoptions)) {
623         // Media (audio/video) file.
624         $code = $mediarenderer->embed_url($url, $title, 0, 0, $embedoptions);
626     } else {
627         // anything else - just try object tag enlarged as much as possible
628         $code = resourcelib_embed_general($url, $title, $clicktoopen, $mimetype);
629     }
631     return $code;
635 /**
636  * Abstract class that page type's MUST inherit from.
637  *
638  * This is the abstract class that ALL add page type forms must extend.
639  * You will notice that all but two of the methods this class contains are final.
640  * Essentially the only thing that extending classes can do is extend custom_definition.
641  * OR if it has a special requirement on creation it can extend construction_override
642  *
643  * @abstract
644  * @copyright  2009 Sam Hemelryk
645  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
646  */
647 abstract class lesson_add_page_form_base extends moodleform {
649     /**
650      * This is the classic define that is used to identify this pagetype.
651      * Will be one of LESSON_*
652      * @var int
653      */
654     public $qtype;
656     /**
657      * The simple string that describes the page type e.g. truefalse, multichoice
658      * @var string
659      */
660     public $qtypestring;
662     /**
663      * An array of options used in the htmleditor
664      * @var array
665      */
666     protected $editoroptions = array();
668     /**
669      * True if this is a standard page of false if it does something special.
670      * Questions are standard pages, branch tables are not
671      * @var bool
672      */
673     protected $standard = true;
675     /**
676      * Each page type can and should override this to add any custom elements to
677      * the basic form that they want
678      */
679     public function custom_definition() {}
681     /**
682      * Used to determine if this is a standard page or a special page
683      * @return bool
684      */
685     public final function is_standard() {
686         return (bool)$this->standard;
687     }
689     /**
690      * Add the required basic elements to the form.
691      *
692      * This method adds the basic elements to the form including title and contents
693      * and then calls custom_definition();
694      */
695     public final function definition() {
696         $mform = $this->_form;
697         $editoroptions = $this->_customdata['editoroptions'];
699         $mform->addElement('header', 'qtypeheading', get_string('addaquestionpage', 'lesson', get_string($this->qtypestring, 'lesson')));
701         $mform->addElement('hidden', 'id');
702         $mform->setType('id', PARAM_INT);
704         $mform->addElement('hidden', 'pageid');
705         $mform->setType('pageid', PARAM_INT);
707         if ($this->standard === true) {
708             $mform->addElement('hidden', 'qtype');
709             $mform->setType('qtype', PARAM_INT);
711             $mform->addElement('text', 'title', get_string('pagetitle', 'lesson'), array('size'=>70));
712             $mform->setType('title', PARAM_TEXT);
713             $mform->addRule('title', get_string('required'), 'required', null, 'client');
715             $this->editoroptions = array('noclean'=>true, 'maxfiles'=>EDITOR_UNLIMITED_FILES, 'maxbytes'=>$this->_customdata['maxbytes']);
716             $mform->addElement('editor', 'contents_editor', get_string('pagecontents', 'lesson'), null, $this->editoroptions);
717             $mform->setType('contents_editor', PARAM_RAW);
718             $mform->addRule('contents_editor', get_string('required'), 'required', null, 'client');
719         }
721         $this->custom_definition();
723         if ($this->_customdata['edit'] === true) {
724             $mform->addElement('hidden', 'edit', 1);
725             $this->add_action_buttons(get_string('cancel'), get_string('savepage', 'lesson'));
726         } else {
727             $this->add_action_buttons(get_string('cancel'), get_string('addaquestionpage', 'lesson'));
728         }
729     }
731     /**
732      * Convenience function: Adds a jumpto select element
733      *
734      * @param string $name
735      * @param string|null $label
736      * @param int $selected The page to select by default
737      */
738     protected final function add_jumpto($name, $label=null, $selected=LESSON_NEXTPAGE) {
739         $title = get_string("jump", "lesson");
740         if ($label === null) {
741             $label = $title;
742         }
743         if (is_int($name)) {
744             $name = "jumpto[$name]";
745         }
746         $this->_form->addElement('select', $name, $label, $this->_customdata['jumpto']);
747         $this->_form->setDefault($name, $selected);
748         $this->_form->addHelpButton($name, 'jumps', 'lesson');
749     }
751     /**
752      * Convenience function: Adds a score input element
753      *
754      * @param string $name
755      * @param string|null $label
756      * @param mixed $value The default value
757      */
758     protected final function add_score($name, $label=null, $value=null) {
759         if ($label === null) {
760             $label = get_string("score", "lesson");
761         }
762         if (is_int($name)) {
763             $name = "score[$name]";
764         }
765         $this->_form->addElement('text', $name, $label, array('size'=>5));
766         if ($value !== null) {
767             $this->_form->setDefault($name, $value);
768         }
769     }
771     /**
772      * Convenience function: Adds an answer editor
773      *
774      * @param int $count The count of the element to add
775      * @param string $label, NULL means default
776      * @param bool $required
777      * @return void
778      */
779     protected final function add_answer($count, $label = NULL, $required = false) {
780         if ($label === NULL) {
781             $label = get_string('answer', 'lesson');
782         }
783         $this->_form->addElement('editor', 'answer_editor['.$count.']', $label, array('rows'=>'4', 'columns'=>'80'), array('noclean'=>true));
784         $this->_form->setDefault('answer_editor['.$count.']', array('text'=>'', 'format'=>FORMAT_MOODLE));
785         if ($required) {
786             $this->_form->addRule('answer_editor['.$count.']', get_string('required'), 'required', null, 'client');
787         }
788     }
789     /**
790      * Convenience function: Adds an response 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_response($count, $label = NULL, $required = false) {
798         if ($label === NULL) {
799             $label = get_string('response', 'lesson');
800         }
801         $this->_form->addElement('editor', 'response_editor['.$count.']', $label, array('rows'=>'4', 'columns'=>'80'), array('noclean'=>true));
802         $this->_form->setDefault('response_editor['.$count.']', array('text'=>'', 'format'=>FORMAT_MOODLE));
803         if ($required) {
804             $this->_form->addRule('response_editor['.$count.']', get_string('required'), 'required', null, 'client');
805         }
806     }
808     /**
809      * A function that gets called upon init of this object by the calling script.
810      *
811      * This can be used to process an immediate action if required. Currently it
812      * is only used in special cases by non-standard page types.
813      *
814      * @return bool
815      */
816     public function construction_override($pageid, lesson $lesson) {
817         return true;
818     }
823 /**
824  * Class representation of a lesson
825  *
826  * This class is used the interact with, and manage a lesson once instantiated.
827  * If you need to fetch a lesson object you can do so by calling
828  *
829  * <code>
830  * lesson::load($lessonid);
831  * // or
832  * $lessonrecord = $DB->get_record('lesson', $lessonid);
833  * $lesson = new lesson($lessonrecord);
834  * </code>
835  *
836  * The class itself extends lesson_base as all classes within the lesson module should
837  *
838  * These properties are from the database
839  * @property int $id The id of this lesson
840  * @property int $course The ID of the course this lesson belongs to
841  * @property string $name The name of this lesson
842  * @property int $practice Flag to toggle this as a practice lesson
843  * @property int $modattempts Toggle to allow the user to go back and review answers
844  * @property int $usepassword Toggle the use of a password for entry
845  * @property string $password The password to require users to enter
846  * @property int $dependency ID of another lesson this lesson is dependent on
847  * @property string $conditions Conditions of the lesson dependency
848  * @property int $grade The maximum grade a user can achieve (%)
849  * @property int $custom Toggle custom scoring on or off
850  * @property int $ongoing Toggle display of an ongoing score
851  * @property int $usemaxgrade How retakes are handled (max=1, mean=0)
852  * @property int $maxanswers The max number of answers or branches
853  * @property int $maxattempts The maximum number of attempts a user can record
854  * @property int $review Toggle use or wrong answer review button
855  * @property int $nextpagedefault Override the default next page
856  * @property int $feedback Toggles display of default feedback
857  * @property int $minquestions Sets a minimum value of pages seen when calculating grades
858  * @property int $maxpages Maximum number of pages this lesson can contain
859  * @property int $retake Flag to allow users to retake a lesson
860  * @property int $activitylink Relate this lesson to another lesson
861  * @property string $mediafile File to pop up to or webpage to display
862  * @property int $mediaheight Sets the height of the media file popup
863  * @property int $mediawidth Sets the width of the media file popup
864  * @property int $mediaclose Toggle display of a media close button
865  * @property int $slideshow Flag for whether branch pages should be shown as slideshows
866  * @property int $width Width of slideshow
867  * @property int $height Height of slideshow
868  * @property string $bgcolor Background colour of slideshow
869  * @property int $displayleft Display a left menu
870  * @property int $displayleftif Sets the condition on which the left menu is displayed
871  * @property int $progressbar Flag to toggle display of a lesson progress bar
872  * @property int $highscores Flag to toggle collection of high scores
873  * @property int $maxhighscores Number of high scores to limit to
874  * @property int $available Timestamp of when this lesson becomes available
875  * @property int $deadline Timestamp of when this lesson is no longer available
876  * @property int $timemodified Timestamp when lesson was last modified
877  *
878  * These properties are calculated
879  * @property int $firstpageid Id of the first page of this lesson (prevpageid=0)
880  * @property int $lastpageid Id of the last page of this lesson (nextpageid=0)
881  *
882  * @copyright  2009 Sam Hemelryk
883  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
884  */
885 class lesson extends lesson_base {
887     /**
888      * The id of the first page (where prevpageid = 0) gets set and retrieved by
889      * {@see get_firstpageid()} by directly calling <code>$lesson->firstpageid;</code>
890      * @var int
891      */
892     protected $firstpageid = null;
893     /**
894      * The id of the last page (where nextpageid = 0) gets set and retrieved by
895      * {@see get_lastpageid()} by directly calling <code>$lesson->lastpageid;</code>
896      * @var int
897      */
898     protected $lastpageid = null;
899     /**
900      * An array used to cache the pages associated with this lesson after the first
901      * time they have been loaded.
902      * A note to developers: If you are going to be working with MORE than one or
903      * two pages from a lesson you should probably call {@see $lesson->load_all_pages()}
904      * in order to save excess database queries.
905      * @var array An array of lesson_page objects
906      */
907     protected $pages = array();
908     /**
909      * Flag that gets set to true once all of the pages associated with the lesson
910      * have been loaded.
911      * @var bool
912      */
913     protected $loadedallpages = false;
915     /**
916      * Simply generates a lesson object given an array/object of properties
917      * Overrides {@see lesson_base->create()}
918      * @static
919      * @param object|array $properties
920      * @return lesson
921      */
922     public static function create($properties) {
923         return new lesson($properties);
924     }
926     /**
927      * Generates a lesson object from the database given its id
928      * @static
929      * @param int $lessonid
930      * @return lesson
931      */
932     public static function load($lessonid) {
933         global $DB;
935         if (!$lesson = $DB->get_record('lesson', array('id' => $lessonid))) {
936             print_error('invalidcoursemodule');
937         }
938         return new lesson($lesson);
939     }
941     /**
942      * Deletes this lesson from the database
943      */
944     public function delete() {
945         global $CFG, $DB;
946         require_once($CFG->libdir.'/gradelib.php');
947         require_once($CFG->dirroot.'/calendar/lib.php');
949         $DB->delete_records("lesson", array("id"=>$this->properties->id));;
950         $DB->delete_records("lesson_pages", array("lessonid"=>$this->properties->id));
951         $DB->delete_records("lesson_answers", array("lessonid"=>$this->properties->id));
952         $DB->delete_records("lesson_attempts", array("lessonid"=>$this->properties->id));
953         $DB->delete_records("lesson_grades", array("lessonid"=>$this->properties->id));
954         $DB->delete_records("lesson_timer", array("lessonid"=>$this->properties->id));
955         $DB->delete_records("lesson_branch", array("lessonid"=>$this->properties->id));
956         $DB->delete_records("lesson_high_scores", array("lessonid"=>$this->properties->id));
957         if ($events = $DB->get_records('event', array("modulename"=>'lesson', "instance"=>$this->properties->id))) {
958             foreach($events as $event) {
959                 $event = calendar_event::load($event);
960                 $event->delete();
961             }
962         }
964         grade_update('mod/lesson', $this->properties->course, 'mod', 'lesson', $this->properties->id, 0, NULL, array('deleted'=>1));
965         return true;
966     }
968     /**
969      * Fetches messages from the session that may have been set in previous page
970      * actions.
971      *
972      * <code>
973      * // Do not call this method directly instead use
974      * $lesson->messages;
975      * </code>
976      *
977      * @return array
978      */
979     protected function get_messages() {
980         global $SESSION;
982         $messages = array();
983         if (!empty($SESSION->lesson_messages) && is_array($SESSION->lesson_messages) && array_key_exists($this->properties->id, $SESSION->lesson_messages)) {
984             $messages = $SESSION->lesson_messages[$this->properties->id];
985             unset($SESSION->lesson_messages[$this->properties->id]);
986         }
988         return $messages;
989     }
991     /**
992      * Get all of the attempts for the current user.
993      *
994      * @param int $retries
995      * @param bool $correct Optional: only fetch correct attempts
996      * @param int $pageid Optional: only fetch attempts at the given page
997      * @param int $userid Optional: defaults to the current user if not set
998      * @return array|false
999      */
1000     public function get_attempts($retries, $correct=false, $pageid=null, $userid=null) {
1001         global $USER, $DB;
1002         $params = array("lessonid"=>$this->properties->id, "userid"=>$userid, "retry"=>$retries);
1003         if ($correct) {
1004             $params['correct'] = 1;
1005         }
1006         if ($pageid !== null) {
1007             $params['pageid'] = $pageid;
1008         }
1009         if ($userid === null) {
1010             $params['userid'] = $USER->id;
1011         }
1012         return $DB->get_records('lesson_attempts', $params, 'timeseen ASC');
1013     }
1015     /**
1016      * Returns the first page for the lesson or false if there isn't one.
1017      *
1018      * This method should be called via the magic method __get();
1019      * <code>
1020      * $firstpage = $lesson->firstpage;
1021      * </code>
1022      *
1023      * @return lesson_page|bool Returns the lesson_page specialised object or false
1024      */
1025     protected function get_firstpage() {
1026         $pages = $this->load_all_pages();
1027         if (count($pages) > 0) {
1028             foreach ($pages as $page) {
1029                 if ((int)$page->prevpageid === 0) {
1030                     return $page;
1031                 }
1032             }
1033         }
1034         return false;
1035     }
1037     /**
1038      * Returns the last page for the lesson or false if there isn't one.
1039      *
1040      * This method should be called via the magic method __get();
1041      * <code>
1042      * $lastpage = $lesson->lastpage;
1043      * </code>
1044      *
1045      * @return lesson_page|bool Returns the lesson_page specialised object or false
1046      */
1047     protected function get_lastpage() {
1048         $pages = $this->load_all_pages();
1049         if (count($pages) > 0) {
1050             foreach ($pages as $page) {
1051                 if ((int)$page->nextpageid === 0) {
1052                     return $page;
1053                 }
1054             }
1055         }
1056         return false;
1057     }
1059     /**
1060      * Returns the id of the first page of this lesson. (prevpageid = 0)
1061      * @return int
1062      */
1063     protected function get_firstpageid() {
1064         global $DB;
1065         if ($this->firstpageid == null) {
1066             if (!$this->loadedallpages) {
1067                 $firstpageid = $DB->get_field('lesson_pages', 'id', array('lessonid'=>$this->properties->id, 'prevpageid'=>0));
1068                 if (!$firstpageid) {
1069                     print_error('cannotfindfirstpage', 'lesson');
1070                 }
1071                 $this->firstpageid = $firstpageid;
1072             } else {
1073                 $firstpage = $this->get_firstpage();
1074                 $this->firstpageid = $firstpage->id;
1075             }
1076         }
1077         return $this->firstpageid;
1078     }
1080     /**
1081      * Returns the id of the last page of this lesson. (nextpageid = 0)
1082      * @return int
1083      */
1084     public function get_lastpageid() {
1085         global $DB;
1086         if ($this->lastpageid == null) {
1087             if (!$this->loadedallpages) {
1088                 $lastpageid = $DB->get_field('lesson_pages', 'id', array('lessonid'=>$this->properties->id, 'nextpageid'=>0));
1089                 if (!$lastpageid) {
1090                     print_error('cannotfindlastpage', 'lesson');
1091                 }
1092                 $this->lastpageid = $lastpageid;
1093             } else {
1094                 $lastpageid = $this->get_lastpage();
1095                 $this->lastpageid = $lastpageid->id;
1096             }
1097         }
1099         return $this->lastpageid;
1100     }
1102      /**
1103      * Gets the next page id to display after the one that is provided.
1104      * @param int $nextpageid
1105      * @return bool
1106      */
1107     public function get_next_page($nextpageid) {
1108         global $USER, $DB;
1109         $allpages = $this->load_all_pages();
1110         if ($this->properties->nextpagedefault) {
1111             // in Flash Card mode...first get number of retakes
1112             $nretakes = $DB->count_records("lesson_grades", array("lessonid" => $this->properties->id, "userid" => $USER->id));
1113             shuffle($allpages);
1114             $found = false;
1115             if ($this->properties->nextpagedefault == LESSON_UNSEENPAGE) {
1116                 foreach ($allpages as $nextpage) {
1117                     if (!$DB->count_records("lesson_attempts", array("pageid" => $nextpage->id, "userid" => $USER->id, "retry" => $nretakes))) {
1118                         $found = true;
1119                         break;
1120                     }
1121                 }
1122             } elseif ($this->properties->nextpagedefault == LESSON_UNANSWEREDPAGE) {
1123                 foreach ($allpages as $nextpage) {
1124                     if (!$DB->count_records("lesson_attempts", array('pageid' => $nextpage->id, 'userid' => $USER->id, 'correct' => 1, 'retry' => $nretakes))) {
1125                         $found = true;
1126                         break;
1127                     }
1128                 }
1129             }
1130             if ($found) {
1131                 if ($this->properties->maxpages) {
1132                     // check number of pages viewed (in the lesson)
1133                     if ($DB->count_records("lesson_attempts", array("lessonid" => $this->properties->id, "userid" => $USER->id, "retry" => $nretakes)) >= $this->properties->maxpages) {
1134                         return LESSON_EOL;
1135                     }
1136                 }
1137                 return $nextpage->id;
1138             }
1139         }
1140         // In a normal lesson mode
1141         foreach ($allpages as $nextpage) {
1142             if ((int)$nextpage->id === (int)$nextpageid) {
1143                 return $nextpage->id;
1144             }
1145         }
1146         return LESSON_EOL;
1147     }
1149     /**
1150      * Sets a message against the session for this lesson that will displayed next
1151      * time the lesson processes messages
1152      *
1153      * @param string $message
1154      * @param string $class
1155      * @param string $align
1156      * @return bool
1157      */
1158     public function add_message($message, $class="notifyproblem", $align='center') {
1159         global $SESSION;
1161         if (empty($SESSION->lesson_messages) || !is_array($SESSION->lesson_messages)) {
1162             $SESSION->lesson_messages = array();
1163             $SESSION->lesson_messages[$this->properties->id] = array();
1164         } else if (!array_key_exists($this->properties->id, $SESSION->lesson_messages)) {
1165             $SESSION->lesson_messages[$this->properties->id] = array();
1166         }
1168         $SESSION->lesson_messages[$this->properties->id][] = array($message, $class, $align);
1170         return true;
1171     }
1173     /**
1174      * Check if the lesson is accessible at the present time
1175      * @return bool True if the lesson is accessible, false otherwise
1176      */
1177     public function is_accessible() {
1178         $available = $this->properties->available;
1179         $deadline = $this->properties->deadline;
1180         return (($available == 0 || time() >= $available) && ($deadline == 0 || time() < $deadline));
1181     }
1183     /**
1184      * Starts the lesson time for the current user
1185      * @return bool Returns true
1186      */
1187     public function start_timer() {
1188         global $USER, $DB;
1189         $USER->startlesson[$this->properties->id] = true;
1190         $startlesson = new stdClass;
1191         $startlesson->lessonid = $this->properties->id;
1192         $startlesson->userid = $USER->id;
1193         $startlesson->starttime = time();
1194         $startlesson->lessontime = time();
1195         $DB->insert_record('lesson_timer', $startlesson);
1196         if ($this->properties->timed) {
1197             $this->add_message(get_string('maxtimewarning', 'lesson', $this->properties->maxtime), 'center');
1198         }
1199         return true;
1200     }
1202     /**
1203      * Updates the timer to the current time and returns the new timer object
1204      * @param bool $restart If set to true the timer is restarted
1205      * @param bool $continue If set to true AND $restart=true then the timer
1206      *                        will continue from a previous attempt
1207      * @return stdClass The new timer
1208      */
1209     public function update_timer($restart=false, $continue=false) {
1210         global $USER, $DB;
1211         // clock code
1212         // get time information for this user
1213         if (!$timer = $DB->get_records('lesson_timer', array ("lessonid" => $this->properties->id, "userid" => $USER->id), 'starttime DESC', '*', 0, 1)) {
1214             print_error('cannotfindtimer', 'lesson');
1215         } else {
1216             $timer = current($timer); // this will get the latest start time record
1217         }
1219         if ($restart) {
1220             if ($continue) {
1221                 // continue a previous test, need to update the clock  (think this option is disabled atm)
1222                 $timer->starttime = time() - ($timer->lessontime - $timer->starttime);
1223             } else {
1224                 // starting over, so reset the clock
1225                 $timer->starttime = time();
1226             }
1227         }
1229         $timer->lessontime = time();
1230         $DB->update_record('lesson_timer', $timer);
1231         return $timer;
1232     }
1234     /**
1235      * Updates the timer to the current time then stops it by unsetting the user var
1236      * @return bool Returns true
1237      */
1238     public function stop_timer() {
1239         global $USER, $DB;
1240         unset($USER->startlesson[$this->properties->id]);
1241         return $this->update_timer(false, false);
1242     }
1244     /**
1245      * Checks to see if the lesson has pages
1246      */
1247     public function has_pages() {
1248         global $DB;
1249         $pagecount = $DB->count_records('lesson_pages', array('lessonid'=>$this->properties->id));
1250         return ($pagecount>0);
1251     }
1253     /**
1254      * Returns the link for the related activity
1255      * @return array|false
1256      */
1257     public function link_for_activitylink() {
1258         global $DB;
1259         $module = $DB->get_record('course_modules', array('id' => $this->properties->activitylink));
1260         if ($module) {
1261             $modname = $DB->get_field('modules', 'name', array('id' => $module->module));
1262             if ($modname) {
1263                 $instancename = $DB->get_field($modname, 'name', array('id' => $module->instance));
1264                 if ($instancename) {
1265                     return html_writer::link(new moodle_url('/mod/'.$modname.'/view.php', array('id'=>$this->properties->activitylink)),
1266                         get_string('activitylinkname', 'lesson', $instancename),
1267                         array('class'=>'centerpadded lessonbutton standardbutton'));
1268                 }
1269             }
1270         }
1271         return '';
1272     }
1274     /**
1275      * Loads the requested page.
1276      *
1277      * This function will return the requested page id as either a specialised
1278      * lesson_page object OR as a generic lesson_page.
1279      * If the page has been loaded previously it will be returned from the pages
1280      * array, otherwise it will be loaded from the database first
1281      *
1282      * @param int $pageid
1283      * @return lesson_page A lesson_page object or an object that extends it
1284      */
1285     public function load_page($pageid) {
1286         if (!array_key_exists($pageid, $this->pages)) {
1287             $manager = lesson_page_type_manager::get($this);
1288             $this->pages[$pageid] = $manager->load_page($pageid, $this);
1289         }
1290         return $this->pages[$pageid];
1291     }
1293     /**
1294      * Loads ALL of the pages for this lesson
1295      *
1296      * @return array An array containing all pages from this lesson
1297      */
1298     public function load_all_pages() {
1299         if (!$this->loadedallpages) {
1300             $manager = lesson_page_type_manager::get($this);
1301             $this->pages = $manager->load_all_pages($this);
1302             $this->loadedallpages = true;
1303         }
1304         return $this->pages;
1305     }
1307     /**
1308      * Determines if a jumpto value is correct or not.
1309      *
1310      * returns true if jumpto page is (logically) after the pageid page or
1311      * if the jumpto value is a special value.  Returns false in all other cases.
1312      *
1313      * @param int $pageid Id of the page from which you are jumping from.
1314      * @param int $jumpto The jumpto number.
1315      * @return boolean True or false after a series of tests.
1316      **/
1317     public function jumpto_is_correct($pageid, $jumpto) {
1318         global $DB;
1320         // first test the special values
1321         if (!$jumpto) {
1322             // same page
1323             return false;
1324         } elseif ($jumpto == LESSON_NEXTPAGE) {
1325             return true;
1326         } elseif ($jumpto == LESSON_UNSEENBRANCHPAGE) {
1327             return true;
1328         } elseif ($jumpto == LESSON_RANDOMPAGE) {
1329             return true;
1330         } elseif ($jumpto == LESSON_CLUSTERJUMP) {
1331             return true;
1332         } elseif ($jumpto == LESSON_EOL) {
1333             return true;
1334         }
1336         $pages = $this->load_all_pages();
1337         $apageid = $pages[$pageid]->nextpageid;
1338         while ($apageid != 0) {
1339             if ($jumpto == $apageid) {
1340                 return true;
1341             }
1342             $apageid = $pages[$apageid]->nextpageid;
1343         }
1344         return false;
1345     }
1347     /**
1348      * Returns the time a user has remaining on this lesson
1349      * @param int $starttime Starttime timestamp
1350      * @return string
1351      */
1352     public function time_remaining($starttime) {
1353         $timeleft = $starttime + $this->maxtime * 60 - time();
1354         $hours = floor($timeleft/3600);
1355         $timeleft = $timeleft - ($hours * 3600);
1356         $minutes = floor($timeleft/60);
1357         $secs = $timeleft - ($minutes * 60);
1359         if ($minutes < 10) {
1360             $minutes = "0$minutes";
1361         }
1362         if ($secs < 10) {
1363             $secs = "0$secs";
1364         }
1365         $output   = array();
1366         $output[] = $hours;
1367         $output[] = $minutes;
1368         $output[] = $secs;
1369         $output = implode(':', $output);
1370         return $output;
1371     }
1373     /**
1374      * Interprets LESSON_CLUSTERJUMP jumpto value.
1375      *
1376      * This will select a page randomly
1377      * and the page selected will be inbetween a cluster page and end of clutter or end of lesson
1378      * and the page selected will be a page that has not been viewed already
1379      * and if any pages are within a branch table or end of branch then only 1 page within
1380      * the branch table or end of branch will be randomly selected (sub clustering).
1381      *
1382      * @param int $pageid Id of the current page from which we are jumping from.
1383      * @param int $userid Id of the user.
1384      * @return int The id of the next page.
1385      **/
1386     public function cluster_jump($pageid, $userid=null) {
1387         global $DB, $USER;
1389         if ($userid===null) {
1390             $userid = $USER->id;
1391         }
1392         // get the number of retakes
1393         if (!$retakes = $DB->count_records("lesson_grades", array("lessonid"=>$this->properties->id, "userid"=>$userid))) {
1394             $retakes = 0;
1395         }
1396         // get all the lesson_attempts aka what the user has seen
1397         $seenpages = array();
1398         if ($attempts = $this->get_attempts($retakes)) {
1399             foreach ($attempts as $attempt) {
1400                 $seenpages[$attempt->pageid] = $attempt->pageid;
1401             }
1403         }
1405         // get the lesson pages
1406         $lessonpages = $this->load_all_pages();
1407         // find the start of the cluster
1408         while ($pageid != 0) { // this condition should not be satisfied... should be a cluster page
1409             if ($lessonpages[$pageid]->qtype == LESSON_PAGE_CLUSTER) {
1410                 break;
1411             }
1412             $pageid = $lessonpages[$pageid]->prevpageid;
1413         }
1415         $clusterpages = array();
1416         $clusterpages = $this->get_sub_pages_of($pageid, array(LESSON_PAGE_ENDOFCLUSTER));
1417         $unseen = array();
1418         foreach ($clusterpages as $key=>$cluster) {
1419             if ($cluster->type !== lesson_page::TYPE_QUESTION) {
1420                 unset($clusterpages[$key]);
1421             } elseif ($cluster->is_unseen($seenpages)) {
1422                 $unseen[] = $cluster;
1423             }
1424         }
1426         if (count($unseen) > 0) {
1427             // it does not contain elements, then use exitjump, otherwise find out next page/branch
1428             $nextpage = $unseen[rand(0, count($unseen)-1)];
1429             if ($nextpage->qtype == LESSON_PAGE_BRANCHTABLE) {
1430                 // if branch table, then pick a random page inside of it
1431                 $branchpages = $this->get_sub_pages_of($nextpage->id, array(LESSON_PAGE_BRANCHTABLE, LESSON_PAGE_ENDOFBRANCH));
1432                 return $branchpages[rand(0, count($branchpages)-1)]->id;
1433             } else { // otherwise, return the page's id
1434                 return $nextpage->id;
1435             }
1436         } else {
1437             // seen all there is to see, leave the cluster
1438             if (end($clusterpages)->nextpageid == 0) {
1439                 return LESSON_EOL;
1440             } else {
1441                 $clusterendid = $pageid;
1442                 while ($clusterendid != 0) { // this condition should not be satisfied... should be a cluster page
1443                     if ($lessonpages[$clusterendid]->qtype == LESSON_PAGE_CLUSTER) {
1444                         break;
1445                     }
1446                     $clusterendid = $lessonpages[$clusterendid]->prevpageid;
1447                 }
1448                 $exitjump = $DB->get_field("lesson_answers", "jumpto", array("pageid" => $clusterendid, "lessonid" => $this->properties->id));
1449                 if ($exitjump == LESSON_NEXTPAGE) {
1450                     $exitjump = $lessonpages[$pageid]->nextpageid;
1451                 }
1452                 if ($exitjump == 0) {
1453                     return LESSON_EOL;
1454                 } else if (in_array($exitjump, array(LESSON_EOL, LESSON_PREVIOUSPAGE))) {
1455                     return $exitjump;
1456                 } else {
1457                     if (!array_key_exists($exitjump, $lessonpages)) {
1458                         $found = false;
1459                         foreach ($lessonpages as $page) {
1460                             if ($page->id === $clusterendid) {
1461                                 $found = true;
1462                             } else if ($page->qtype == LESSON_PAGE_ENDOFCLUSTER) {
1463                                 $exitjump = $DB->get_field("lesson_answers", "jumpto", array("pageid" => $page->id, "lessonid" => $this->properties->id));
1464                                 break;
1465                             }
1466                         }
1467                     }
1468                     if (!array_key_exists($exitjump, $lessonpages)) {
1469                         return LESSON_EOL;
1470                     }
1471                     return $exitjump;
1472                 }
1473             }
1474         }
1475     }
1477     /**
1478      * Finds all pages that appear to be a subtype of the provided pageid until
1479      * an end point specified within $ends is encountered or no more pages exist
1480      *
1481      * @param int $pageid
1482      * @param array $ends An array of LESSON_PAGE_* types that signify an end of
1483      *               the subtype
1484      * @return array An array of specialised lesson_page objects
1485      */
1486     public function get_sub_pages_of($pageid, array $ends) {
1487         $lessonpages = $this->load_all_pages();
1488         $pageid = $lessonpages[$pageid]->nextpageid;  // move to the first page after the branch table
1489         $pages = array();
1491         while (true) {
1492             if ($pageid == 0 || in_array($lessonpages[$pageid]->qtype, $ends)) {
1493                 break;
1494             }
1495             $pages[] = $lessonpages[$pageid];
1496             $pageid = $lessonpages[$pageid]->nextpageid;
1497         }
1499         return $pages;
1500     }
1502     /**
1503      * Checks to see if the specified page[id] is a subpage of a type specified in
1504      * the $types array, until either there are no more pages of we find a type
1505      * corresponding to that of a type specified in $ends
1506      *
1507      * @param int $pageid The id of the page to check
1508      * @param array $types An array of types that would signify this page was a subpage
1509      * @param array $ends An array of types that mean this is not a subpage
1510      * @return bool
1511      */
1512     public function is_sub_page_of_type($pageid, array $types, array $ends) {
1513         $pages = $this->load_all_pages();
1514         $pageid = $pages[$pageid]->prevpageid; // move up one
1516         array_unshift($ends, 0);
1517         // go up the pages till branch table
1518         while (true) {
1519             if ($pageid==0 || in_array($pages[$pageid]->qtype, $ends)) {
1520                 return false;
1521             } else if (in_array($pages[$pageid]->qtype, $types)) {
1522                 return true;
1523             }
1524             $pageid = $pages[$pageid]->prevpageid;
1525         }
1526     }
1530 /**
1531  * Abstract class to provide a core functions to the all lesson classes
1532  *
1533  * This class should be abstracted by ALL classes with the lesson module to ensure
1534  * that all classes within this module can be interacted with in the same way.
1535  *
1536  * This class provides the user with a basic properties array that can be fetched
1537  * or set via magic methods, or alternatively by defining methods get_blah() or
1538  * set_blah() within the extending object.
1539  *
1540  * @copyright  2009 Sam Hemelryk
1541  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1542  */
1543 abstract class lesson_base {
1545     /**
1546      * An object containing properties
1547      * @var stdClass
1548      */
1549     protected $properties;
1551     /**
1552      * The constructor
1553      * @param stdClass $properties
1554      */
1555     public function __construct($properties) {
1556         $this->properties = (object)$properties;
1557     }
1559     /**
1560      * Magic property method
1561      *
1562      * Attempts to call a set_$key method if one exists otherwise falls back
1563      * to simply set the property
1564      *
1565      * @param string $key
1566      * @param mixed $value
1567      */
1568     public function __set($key, $value) {
1569         if (method_exists($this, 'set_'.$key)) {
1570             $this->{'set_'.$key}($value);
1571         }
1572         $this->properties->{$key} = $value;
1573     }
1575     /**
1576      * Magic get method
1577      *
1578      * Attempts to call a get_$key method to return the property and ralls over
1579      * to return the raw property
1580      *
1581      * @param str $key
1582      * @return mixed
1583      */
1584     public function __get($key) {
1585         if (method_exists($this, 'get_'.$key)) {
1586             return $this->{'get_'.$key}();
1587         }
1588         return $this->properties->{$key};
1589     }
1591     /**
1592      * Stupid PHP needs an isset magic method if you use the get magic method and
1593      * still want empty calls to work.... blah ~!
1594      *
1595      * @param string $key
1596      * @return bool
1597      */
1598     public function __isset($key) {
1599         if (method_exists($this, 'get_'.$key)) {
1600             $val = $this->{'get_'.$key}();
1601             return !empty($val);
1602         }
1603         return !empty($this->properties->{$key});
1604     }
1606     //NOTE: E_STRICT does not allow to change function signature!
1608     /**
1609      * If implemented should create a new instance, save it in the DB and return it
1610      */
1611     //public static function create() {}
1612     /**
1613      * If implemented should load an instance from the DB and return it
1614      */
1615     //public static function load() {}
1616     /**
1617      * Fetches all of the properties of the object
1618      * @return stdClass
1619      */
1620     public function properties() {
1621         return $this->properties;
1622     }
1626 /**
1627  * Abstract class representation of a page associated with a lesson.
1628  *
1629  * This class should MUST be extended by all specialised page types defined in
1630  * mod/lesson/pagetypes/.
1631  * There are a handful of abstract methods that need to be defined as well as
1632  * severl methods that can optionally be defined in order to make the page type
1633  * operate in the desired way
1634  *
1635  * Database properties
1636  * @property int $id The id of this lesson page
1637  * @property int $lessonid The id of the lesson this page belongs to
1638  * @property int $prevpageid The id of the page before this one
1639  * @property int $nextpageid The id of the next page in the page sequence
1640  * @property int $qtype Identifies the page type of this page
1641  * @property int $qoption Used to record page type specific options
1642  * @property int $layout Used to record page specific layout selections
1643  * @property int $display Used to record page specific display selections
1644  * @property int $timecreated Timestamp for when the page was created
1645  * @property int $timemodified Timestamp for when the page was last modified
1646  * @property string $title The title of this page
1647  * @property string $contents The rich content shown to describe the page
1648  * @property int $contentsformat The format of the contents field
1649  *
1650  * Calculated properties
1651  * @property-read array $answers An array of answers for this page
1652  * @property-read bool $displayinmenublock Toggles display in the left menu block
1653  * @property-read array $jumps An array containing all the jumps this page uses
1654  * @property-read lesson $lesson The lesson this page belongs to
1655  * @property-read int $type The type of the page [question | structure]
1656  * @property-read typeid The unique identifier for the page type
1657  * @property-read typestring The string that describes this page type
1658  *
1659  * @abstract
1660  * @copyright  2009 Sam Hemelryk
1661  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1662  */
1663 abstract class lesson_page extends lesson_base {
1665     /**
1666      * A reference to the lesson this page belongs to
1667      * @var lesson
1668      */
1669     protected $lesson = null;
1670     /**
1671      * Contains the answers to this lesson_page once loaded
1672      * @var null|array
1673      */
1674     protected $answers = null;
1675     /**
1676      * This sets the type of the page, can be one of the constants defined below
1677      * @var int
1678      */
1679     protected $type = 0;
1681     /**
1682      * Constants used to identify the type of the page
1683      */
1684     const TYPE_QUESTION = 0;
1685     const TYPE_STRUCTURE = 1;
1687     /**
1688      * This method should return the integer used to identify the page type within
1689      * the database and throughout code. This maps back to the defines used in 1.x
1690      * @abstract
1691      * @return int
1692      */
1693     abstract protected function get_typeid();
1694     /**
1695      * This method should return the string that describes the pagetype
1696      * @abstract
1697      * @return string
1698      */
1699     abstract protected function get_typestring();
1701     /**
1702      * This method gets called to display the page to the user taking the lesson
1703      * @abstract
1704      * @param object $renderer
1705      * @param object $attempt
1706      * @return string
1707      */
1708     abstract public function display($renderer, $attempt);
1710     /**
1711      * Creates a new lesson_page within the database and returns the correct pagetype
1712      * object to use to interact with the new lesson
1713      *
1714      * @final
1715      * @static
1716      * @param object $properties
1717      * @param lesson $lesson
1718      * @return lesson_page Specialised object that extends lesson_page
1719      */
1720     final public static function create($properties, lesson $lesson, $context, $maxbytes) {
1721         global $DB;
1722         $newpage = new stdClass;
1723         $newpage->title = $properties->title;
1724         $newpage->contents = $properties->contents_editor['text'];
1725         $newpage->contentsformat = $properties->contents_editor['format'];
1726         $newpage->lessonid = $lesson->id;
1727         $newpage->timecreated = time();
1728         $newpage->qtype = $properties->qtype;
1729         $newpage->qoption = (isset($properties->qoption))?1:0;
1730         $newpage->layout = (isset($properties->layout))?1:0;
1731         $newpage->display = (isset($properties->display))?1:0;
1732         $newpage->prevpageid = 0; // this is a first page
1733         $newpage->nextpageid = 0; // this is the only page
1735         if ($properties->pageid) {
1736             $prevpage = $DB->get_record("lesson_pages", array("id" => $properties->pageid), 'id, nextpageid');
1737             if (!$prevpage) {
1738                 print_error('cannotfindpages', 'lesson');
1739             }
1740             $newpage->prevpageid = $prevpage->id;
1741             $newpage->nextpageid = $prevpage->nextpageid;
1742         } else {
1743             $nextpage = $DB->get_record('lesson_pages', array('lessonid'=>$lesson->id, 'prevpageid'=>0), 'id');
1744             if ($nextpage) {
1745                 // This is the first page, there are existing pages put this at the start
1746                 $newpage->nextpageid = $nextpage->id;
1747             }
1748         }
1750         $newpage->id = $DB->insert_record("lesson_pages", $newpage);
1752         $editor = new stdClass;
1753         $editor->id = $newpage->id;
1754         $editor->contents_editor = $properties->contents_editor;
1755         $editor = file_postupdate_standard_editor($editor, 'contents', array('noclean'=>true, 'maxfiles'=>EDITOR_UNLIMITED_FILES, 'maxbytes'=>$maxbytes), $context, 'mod_lesson', 'page_contents', $editor->id);
1756         $DB->update_record("lesson_pages", $editor);
1758         if ($newpage->prevpageid > 0) {
1759             $DB->set_field("lesson_pages", "nextpageid", $newpage->id, array("id" => $newpage->prevpageid));
1760         }
1761         if ($newpage->nextpageid > 0) {
1762             $DB->set_field("lesson_pages", "prevpageid", $newpage->id, array("id" => $newpage->nextpageid));
1763         }
1765         $page = lesson_page::load($newpage, $lesson);
1766         $page->create_answers($properties);
1768         $lesson->add_message(get_string('insertedpage', 'lesson').': '.format_string($newpage->title, true), 'notifysuccess');
1770         return $page;
1771     }
1773     /**
1774      * This method loads a page object from the database and returns it as a
1775      * specialised object that extends lesson_page
1776      *
1777      * @final
1778      * @static
1779      * @param int $id
1780      * @param lesson $lesson
1781      * @return lesson_page Specialised lesson_page object
1782      */
1783     final public static function load($id, lesson $lesson) {
1784         global $DB;
1786         if (is_object($id) && !empty($id->qtype)) {
1787             $page = $id;
1788         } else {
1789             $page = $DB->get_record("lesson_pages", array("id" => $id));
1790             if (!$page) {
1791                 print_error('cannotfindpages', 'lesson');
1792             }
1793         }
1794         $manager = lesson_page_type_manager::get($lesson);
1796         $class = 'lesson_page_type_'.$manager->get_page_type_idstring($page->qtype);
1797         if (!class_exists($class)) {
1798             $class = 'lesson_page';
1799         }
1801         return new $class($page, $lesson);
1802     }
1804     /**
1805      * Deletes a lesson_page from the database as well as any associated records.
1806      * @final
1807      * @return bool
1808      */
1809     final public function delete() {
1810         global $DB;
1811         // first delete all the associated records...
1812         $DB->delete_records("lesson_attempts", array("pageid" => $this->properties->id));
1813         // ...now delete the answers...
1814         $DB->delete_records("lesson_answers", array("pageid" => $this->properties->id));
1815         // ..and the page itself
1816         $DB->delete_records("lesson_pages", array("id" => $this->properties->id));
1818         // repair the hole in the linkage
1819         if (!$this->properties->prevpageid && !$this->properties->nextpageid) {
1820             //This is the only page, no repair needed
1821         } elseif (!$this->properties->prevpageid) {
1822             // this is the first page...
1823             $page = $this->lesson->load_page($this->properties->nextpageid);
1824             $page->move(null, 0);
1825         } elseif (!$this->properties->nextpageid) {
1826             // this is the last page...
1827             $page = $this->lesson->load_page($this->properties->prevpageid);
1828             $page->move(0);
1829         } else {
1830             // page is in the middle...
1831             $prevpage = $this->lesson->load_page($this->properties->prevpageid);
1832             $nextpage = $this->lesson->load_page($this->properties->nextpageid);
1834             $prevpage->move($nextpage->id);
1835             $nextpage->move(null, $prevpage->id);
1836         }
1837         return true;
1838     }
1840     /**
1841      * Moves a page by updating its nextpageid and prevpageid values within
1842      * the database
1843      *
1844      * @final
1845      * @param int $nextpageid
1846      * @param int $prevpageid
1847      */
1848     final public function move($nextpageid=null, $prevpageid=null) {
1849         global $DB;
1850         if ($nextpageid === null) {
1851             $nextpageid = $this->properties->nextpageid;
1852         }
1853         if ($prevpageid === null) {
1854             $prevpageid = $this->properties->prevpageid;
1855         }
1856         $obj = new stdClass;
1857         $obj->id = $this->properties->id;
1858         $obj->prevpageid = $prevpageid;
1859         $obj->nextpageid = $nextpageid;
1860         $DB->update_record('lesson_pages', $obj);
1861     }
1863     /**
1864      * Returns the answers that are associated with this page in the database
1865      *
1866      * @final
1867      * @return array
1868      */
1869     final public function get_answers() {
1870         global $DB;
1871         if ($this->answers === null) {
1872             $this->answers = array();
1873             $answers = $DB->get_records('lesson_answers', array('pageid'=>$this->properties->id, 'lessonid'=>$this->lesson->id), 'id');
1874             if (!$answers) {
1875                 // It is possible that a lesson upgraded from Moodle 1.9 still
1876                 // contains questions without any answers [MDL-25632].
1877                 // debugging(get_string('cannotfindanswer', 'lesson'));
1878                 return array();
1879             }
1880             foreach ($answers as $answer) {
1881                 $this->answers[count($this->answers)] = new lesson_page_answer($answer);
1882             }
1883         }
1884         return $this->answers;
1885     }
1887     /**
1888      * Returns the lesson this page is associated with
1889      * @final
1890      * @return lesson
1891      */
1892     final protected function get_lesson() {
1893         return $this->lesson;
1894     }
1896     /**
1897      * Returns the type of page this is. Not to be confused with page type
1898      * @final
1899      * @return int
1900      */
1901     final protected function get_type() {
1902         return $this->type;
1903     }
1905     /**
1906      * Records an attempt at this page
1907      *
1908      * @final
1909      * @global moodle_database $DB
1910      * @param stdClass $context
1911      * @return stdClass Returns the result of the attempt
1912      */
1913     final public function record_attempt($context) {
1914         global $DB, $USER, $OUTPUT;
1916         /**
1917          * This should be overridden by each page type to actually check the response
1918          * against what ever custom criteria they have defined
1919          */
1920         $result = $this->check_answer();
1922         $result->attemptsremaining  = 0;
1923         $result->maxattemptsreached = false;
1925         if ($result->noanswer) {
1926             $result->newpageid = $this->properties->id; // display same page again
1927             $result->feedback  = get_string('noanswer', 'lesson');
1928         } else {
1929             if (!has_capability('mod/lesson:manage', $context)) {
1930                 $nretakes = $DB->count_records("lesson_grades", array("lessonid"=>$this->lesson->id, "userid"=>$USER->id));
1931                 // record student's attempt
1932                 $attempt = new stdClass;
1933                 $attempt->lessonid = $this->lesson->id;
1934                 $attempt->pageid = $this->properties->id;
1935                 $attempt->userid = $USER->id;
1936                 $attempt->answerid = $result->answerid;
1937                 $attempt->retry = $nretakes;
1938                 $attempt->correct = $result->correctanswer;
1939                 if($result->userresponse !== null) {
1940                     $attempt->useranswer = $result->userresponse;
1941                 }
1943                 $attempt->timeseen = time();
1944                 // if allow modattempts, then update the old attempt record, otherwise, insert new answer record
1945                 if (isset($USER->modattempts[$this->lesson->id])) {
1946                     $attempt->retry = $nretakes - 1; // they are going through on review, $nretakes will be too high
1947                 }
1949                 if ($this->lesson->retake || (!$this->lesson->retake && $nretakes == 0)) {
1950                     $DB->insert_record("lesson_attempts", $attempt);
1951                 }
1952                 // "number of attempts remaining" message if $this->lesson->maxattempts > 1
1953                 // displaying of message(s) is at the end of page for more ergonomic display
1954                 if (!$result->correctanswer && ($result->newpageid == 0)) {
1955                     // wrong answer and student is stuck on this page - check how many attempts
1956                     // the student has had at this page/question
1957                     $nattempts = $DB->count_records("lesson_attempts", array("pageid"=>$this->properties->id, "userid"=>$USER->id, "retry" => $attempt->retry));
1958                     // retreive the number of attempts left counter for displaying at bottom of feedback page
1959                     if ($nattempts >= $this->lesson->maxattempts) {
1960                         if ($this->lesson->maxattempts > 1) { // don't bother with message if only one attempt
1961                             $result->maxattemptsreached = true;
1962                         }
1963                         $result->newpageid = LESSON_NEXTPAGE;
1964                     } else if ($this->lesson->maxattempts > 1) { // don't bother with message if only one attempt
1965                         $result->attemptsremaining = $this->lesson->maxattempts - $nattempts;
1966                     }
1967                 }
1968             }
1969             // TODO: merge this code with the jump code below.  Convert jumpto page into a proper page id
1970             if ($result->newpageid == 0) {
1971                 $result->newpageid = $this->properties->id;
1972             } elseif ($result->newpageid == LESSON_NEXTPAGE) {
1973                 $result->newpageid = $this->lesson->get_next_page($this->properties->nextpageid);
1974             }
1976             // Determine default feedback if necessary
1977             if (empty($result->response)) {
1978                 if (!$this->lesson->feedback && !$result->noanswer && !($this->lesson->review & !$result->correctanswer && !$result->isessayquestion)) {
1979                     // These conditions have been met:
1980                     //  1. The lesson manager has not supplied feedback to the student
1981                     //  2. Not displaying default feedback
1982                     //  3. The user did provide an answer
1983                     //  4. We are not reviewing with an incorrect answer (and not reviewing an essay question)
1985                     $result->nodefaultresponse = true;  // This will cause a redirect below
1986                 } else if ($result->isessayquestion) {
1987                     $result->response = get_string('defaultessayresponse', 'lesson');
1988                 } else if ($result->correctanswer) {
1989                     $result->response = get_string('thatsthecorrectanswer', 'lesson');
1990                 } else {
1991                     $result->response = get_string('thatsthewronganswer', 'lesson');
1992                 }
1993             }
1995             if ($result->response) {
1996                 if ($this->lesson->review && !$result->correctanswer && !$result->isessayquestion) {
1997                     $nretakes = $DB->count_records("lesson_grades", array("lessonid"=>$this->lesson->id, "userid"=>$USER->id));
1998                     $qattempts = $DB->count_records("lesson_attempts", array("userid"=>$USER->id, "retry"=>$nretakes, "pageid"=>$this->properties->id));
1999                     if ($qattempts == 1) {
2000                         $result->feedback = $OUTPUT->box(get_string("firstwrong", "lesson"), 'feedback');
2001                     } else {
2002                         $result->feedback = $OUTPUT->BOX(get_string("secondpluswrong", "lesson"), 'feedback');
2003                     }
2004                 } else {
2005                     $class = 'response';
2006                     if ($result->correctanswer) {
2007                         $class .= ' correct'; //CSS over-ride this if they exist (!important)
2008                     } else if (!$result->isessayquestion) {
2009                         $class .= ' incorrect'; //CSS over-ride this if they exist (!important)
2010                     }
2011                     $options = new stdClass;
2012                     $options->noclean = true;
2013                     $options->para = true;
2014                     $options->overflowdiv = true;
2015                     $result->feedback = $OUTPUT->box(format_text($this->get_contents(), $this->properties->contentsformat, $options), 'generalbox boxaligncenter');
2016                     $result->feedback .= '<div class="correctanswer generalbox"><em>'.get_string("youranswer", "lesson").'</em> : '.$result->studentanswer; // already in clean html
2017                     $result->feedback .= $OUTPUT->box($result->response, $class); // already conerted to HTML
2018                     $result->feedback .= '</div>';
2019                 }
2020             }
2021         }
2023         return $result;
2024     }
2026     /**
2027      * Returns the string for a jump name
2028      *
2029      * @final
2030      * @param int $jumpto Jump code or page ID
2031      * @return string
2032      **/
2033     final protected function get_jump_name($jumpto) {
2034         global $DB;
2035         static $jumpnames = array();
2037         if (!array_key_exists($jumpto, $jumpnames)) {
2038             if ($jumpto == LESSON_THISPAGE) {
2039                 $jumptitle = get_string('thispage', 'lesson');
2040             } elseif ($jumpto == LESSON_NEXTPAGE) {
2041                 $jumptitle = get_string('nextpage', 'lesson');
2042             } elseif ($jumpto == LESSON_EOL) {
2043                 $jumptitle = get_string('endoflesson', 'lesson');
2044             } elseif ($jumpto == LESSON_UNSEENBRANCHPAGE) {
2045                 $jumptitle = get_string('unseenpageinbranch', 'lesson');
2046             } elseif ($jumpto == LESSON_PREVIOUSPAGE) {
2047                 $jumptitle = get_string('previouspage', 'lesson');
2048             } elseif ($jumpto == LESSON_RANDOMPAGE) {
2049                 $jumptitle = get_string('randompageinbranch', 'lesson');
2050             } elseif ($jumpto == LESSON_RANDOMBRANCH) {
2051                 $jumptitle = get_string('randombranch', 'lesson');
2052             } elseif ($jumpto == LESSON_CLUSTERJUMP) {
2053                 $jumptitle = get_string('clusterjump', 'lesson');
2054             } else {
2055                 if (!$jumptitle = $DB->get_field('lesson_pages', 'title', array('id' => $jumpto))) {
2056                     $jumptitle = '<strong>'.get_string('notdefined', 'lesson').'</strong>';
2057                 }
2058             }
2059             $jumpnames[$jumpto] = format_string($jumptitle,true);
2060         }
2062         return $jumpnames[$jumpto];
2063     }
2065     /**
2066      * Constructor method
2067      * @param object $properties
2068      * @param lesson $lesson
2069      */
2070     public function __construct($properties, lesson $lesson) {
2071         parent::__construct($properties);
2072         $this->lesson = $lesson;
2073     }
2075     /**
2076      * Returns the score for the attempt
2077      * This may be overridden by page types that require manual grading
2078      * @param array $answers
2079      * @param object $attempt
2080      * @return int
2081      */
2082     public function earned_score($answers, $attempt) {
2083         return $answers[$attempt->answerid]->score;
2084     }
2086     /**
2087      * This is a callback method that can be override and gets called when ever a page
2088      * is viewed
2089      *
2090      * @param bool $canmanage True if the user has the manage cap
2091      * @return mixed
2092      */
2093     public function callback_on_view($canmanage) {
2094         return true;
2095     }
2097     /**
2098      * Updates a lesson page and its answers within the database
2099      *
2100      * @param object $properties
2101      * @return bool
2102      */
2103     public function update($properties, $context = null, $maxbytes = null) {
2104         global $DB, $PAGE;
2105         $answers  = $this->get_answers();
2106         $properties->id = $this->properties->id;
2107         $properties->lessonid = $this->lesson->id;
2108         if (empty($properties->qoption)) {
2109             $properties->qoption = '0';
2110         }
2111         if (empty($context)) {
2112             $context = $PAGE->context;
2113         }
2114         if ($maxbytes === null) {
2115             $maxbytes =get_max_upload_file_size();
2116         }
2117         $properties = file_postupdate_standard_editor($properties, 'contents', array('noclean'=>true, 'maxfiles'=>EDITOR_UNLIMITED_FILES, 'maxbytes'=>$maxbytes), $context, 'mod_lesson', 'page_contents', $properties->id);
2118         $DB->update_record("lesson_pages", $properties);
2120         for ($i = 0; $i < $this->lesson->maxanswers; $i++) {
2121             if (!array_key_exists($i, $this->answers)) {
2122                 $this->answers[$i] = new stdClass;
2123                 $this->answers[$i]->lessonid = $this->lesson->id;
2124                 $this->answers[$i]->pageid = $this->id;
2125                 $this->answers[$i]->timecreated = $this->timecreated;
2126             }
2128             if (!empty($properties->answer_editor[$i]) && is_array($properties->answer_editor[$i])) {
2129                 $this->answers[$i]->answer = $properties->answer_editor[$i]['text'];
2130                 $this->answers[$i]->answerformat = $properties->answer_editor[$i]['format'];
2131             }
2132             if (!empty($properties->response_editor[$i]) && is_array($properties->response_editor[$i])) {
2133                 $this->answers[$i]->response = $properties->response_editor[$i]['text'];
2134                 $this->answers[$i]->responseformat = $properties->response_editor[$i]['format'];
2135             }
2137             // we don't need to check for isset here because properties called it's own isset method.
2138             if ($this->answers[$i]->answer != '') {
2139                 if (isset($properties->jumpto[$i])) {
2140                     $this->answers[$i]->jumpto = $properties->jumpto[$i];
2141                 }
2142                 if ($this->lesson->custom && isset($properties->score[$i])) {
2143                     $this->answers[$i]->score = $properties->score[$i];
2144                 }
2145                 if (!isset($this->answers[$i]->id)) {
2146                     $this->answers[$i]->id =  $DB->insert_record("lesson_answers", $this->answers[$i]);
2147                 } else {
2148                     $DB->update_record("lesson_answers", $this->answers[$i]->properties());
2149                 }
2151             } else if (isset($this->answers[$i]->id)) {
2152                 $DB->delete_records('lesson_answers', array('id'=>$this->answers[$i]->id));
2153                 unset($this->answers[$i]);
2154             }
2155         }
2156         return true;
2157     }
2159     /**
2160      * Can be set to true if the page requires a static link to create a new instance
2161      * instead of simply being included in the dropdown
2162      * @param int $previd
2163      * @return bool
2164      */
2165     public function add_page_link($previd) {
2166         return false;
2167     }
2169     /**
2170      * Returns true if a page has been viewed before
2171      *
2172      * @param array|int $param Either an array of pages that have been seen or the
2173      *                   number of retakes a user has had
2174      * @return bool
2175      */
2176     public function is_unseen($param) {
2177         global $USER, $DB;
2178         if (is_array($param)) {
2179             $seenpages = $param;
2180             return (!array_key_exists($this->properties->id, $seenpages));
2181         } else {
2182             $nretakes = $param;
2183             if (!$DB->count_records("lesson_attempts", array("pageid"=>$this->properties->id, "userid"=>$USER->id, "retry"=>$nretakes))) {
2184                 return true;
2185             }
2186         }
2187         return false;
2188     }
2190     /**
2191      * Checks to see if a page has been answered previously
2192      * @param int $nretakes
2193      * @return bool
2194      */
2195     public function is_unanswered($nretakes) {
2196         global $DB, $USER;
2197         if (!$DB->count_records("lesson_attempts", array('pageid'=>$this->properties->id, 'userid'=>$USER->id, 'correct'=>1, 'retry'=>$nretakes))) {
2198             return true;
2199         }
2200         return false;
2201     }
2203     /**
2204      * Creates answers within the database for this lesson_page. Usually only ever
2205      * called when creating a new page instance
2206      * @param object $properties
2207      * @return array
2208      */
2209     public function create_answers($properties) {
2210         global $DB;
2211         // now add the answers
2212         $newanswer = new stdClass;
2213         $newanswer->lessonid = $this->lesson->id;
2214         $newanswer->pageid = $this->properties->id;
2215         $newanswer->timecreated = $this->properties->timecreated;
2217         $answers = array();
2219         for ($i = 0; $i < $this->lesson->maxanswers; $i++) {
2220             $answer = clone($newanswer);
2222             if (!empty($properties->answer_editor[$i]) && is_array($properties->answer_editor[$i])) {
2223                 $answer->answer = $properties->answer_editor[$i]['text'];
2224                 $answer->answerformat = $properties->answer_editor[$i]['format'];
2225             }
2226             if (!empty($properties->response_editor[$i]) && is_array($properties->response_editor[$i])) {
2227                 $answer->response = $properties->response_editor[$i]['text'];
2228                 $answer->responseformat = $properties->response_editor[$i]['format'];
2229             }
2231             if (isset($answer->answer) && $answer->answer != '') {
2232                 if (isset($properties->jumpto[$i])) {
2233                     $answer->jumpto = $properties->jumpto[$i];
2234                 }
2235                 if ($this->lesson->custom && isset($properties->score[$i])) {
2236                     $answer->score = $properties->score[$i];
2237                 }
2238                 $answer->id = $DB->insert_record("lesson_answers", $answer);
2239                 $answers[$answer->id] = new lesson_page_answer($answer);
2240             } else {
2241                 break;
2242             }
2243         }
2245         $this->answers = $answers;
2246         return $answers;
2247     }
2249     /**
2250      * This method MUST be overridden by all question page types, or page types that
2251      * wish to score a page.
2252      *
2253      * The structure of result should always be the same so it is a good idea when
2254      * overriding this method on a page type to call
2255      * <code>
2256      * $result = parent::check_answer();
2257      * </code>
2258      * before modifying it as required.
2259      *
2260      * @return stdClass
2261      */
2262     public function check_answer() {
2263         $result = new stdClass;
2264         $result->answerid        = 0;
2265         $result->noanswer        = false;
2266         $result->correctanswer   = false;
2267         $result->isessayquestion = false;   // use this to turn off review button on essay questions
2268         $result->response        = '';
2269         $result->newpageid       = 0;       // stay on the page
2270         $result->studentanswer   = '';      // use this to store student's answer(s) in order to display it on feedback page
2271         $result->userresponse    = null;
2272         $result->feedback        = '';
2273         $result->nodefaultresponse  = false; // Flag for redirecting when default feedback is turned off
2274         return $result;
2275     }
2277     /**
2278      * True if the page uses a custom option
2279      *
2280      * Should be override and set to true if the page uses a custom option.
2281      *
2282      * @return bool
2283      */
2284     public function has_option() {
2285         return false;
2286     }
2288     /**
2289      * Returns the maximum number of answers for this page given the maximum number
2290      * of answers permitted by the lesson.
2291      *
2292      * @param int $default
2293      * @return int
2294      */
2295     public function max_answers($default) {
2296         return $default;
2297     }
2299     /**
2300      * Returns the properties of this lesson page as an object
2301      * @return stdClass;
2302      */
2303     public function properties() {
2304         $properties = clone($this->properties);
2305         if ($this->answers === null) {
2306             $this->get_answers();
2307         }
2308         if (count($this->answers)>0) {
2309             $count = 0;
2310             foreach ($this->answers as $answer) {
2311                 $properties->{'answer_editor['.$count.']'} = array('text'=>$answer->answer, 'format'=>$answer->answerformat);
2312                 $properties->{'response_editor['.$count.']'} = array('text'=>$answer->response, 'format'=>$answer->responseformat);
2313                 $properties->{'jumpto['.$count.']'} = $answer->jumpto;
2314                 $properties->{'score['.$count.']'} = $answer->score;
2315                 $count++;
2316             }
2317         }
2318         return $properties;
2319     }
2321     /**
2322      * Returns an array of options to display when choosing the jumpto for a page/answer
2323      * @static
2324      * @param int $pageid
2325      * @param lesson $lesson
2326      * @return array
2327      */
2328     public static function get_jumptooptions($pageid, lesson $lesson) {
2329         global $DB;
2330         $jump = array();
2331         $jump[0] = get_string("thispage", "lesson");
2332         $jump[LESSON_NEXTPAGE] = get_string("nextpage", "lesson");
2333         $jump[LESSON_PREVIOUSPAGE] = get_string("previouspage", "lesson");
2334         $jump[LESSON_EOL] = get_string("endoflesson", "lesson");
2336         if ($pageid == 0) {
2337             return $jump;
2338         }
2340         $pages = $lesson->load_all_pages();
2341         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))) {
2342             $jump[LESSON_UNSEENBRANCHPAGE] = get_string("unseenpageinbranch", "lesson");
2343             $jump[LESSON_RANDOMPAGE] = get_string("randompageinbranch", "lesson");
2344         }
2345         if($pages[$pageid]->qtype == LESSON_PAGE_CLUSTER || $lesson->is_sub_page_of_type($pageid, array(LESSON_PAGE_CLUSTER), array(LESSON_PAGE_ENDOFCLUSTER))) {
2346             $jump[LESSON_CLUSTERJUMP] = get_string("clusterjump", "lesson");
2347         }
2348         if (!optional_param('firstpage', 0, PARAM_INT)) {
2349             $apageid = $DB->get_field("lesson_pages", "id", array("lessonid" => $lesson->id, "prevpageid" => 0));
2350             while (true) {
2351                 if ($apageid) {
2352                     $title = $DB->get_field("lesson_pages", "title", array("id" => $apageid));
2353                     $jump[$apageid] = strip_tags(format_string($title,true));
2354                     $apageid = $DB->get_field("lesson_pages", "nextpageid", array("id" => $apageid));
2355                 } else {
2356                     // last page reached
2357                     break;
2358                 }
2359             }
2360         }
2361         return $jump;
2362     }
2363     /**
2364      * Returns the contents field for the page properly formatted and with plugin
2365      * file url's converted
2366      * @return string
2367      */
2368     public function get_contents() {
2369         global $PAGE;
2370         if (!empty($this->properties->contents)) {
2371             if (!isset($this->properties->contentsformat)) {
2372                 $this->properties->contentsformat = FORMAT_HTML;
2373             }
2374             $context = get_context_instance(CONTEXT_MODULE, $PAGE->cm->id);
2375             $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()!!!!!!
2376             return format_text($contents, $this->properties->contentsformat, array('context'=>$context, 'noclean'=>true)); // page edit is marked with XSS, we want all content here
2377         } else {
2378             return '';
2379         }
2380     }
2382     /**
2383      * Set to true if this page should display in the menu block
2384      * @return bool
2385      */
2386     protected function get_displayinmenublock() {
2387         return false;
2388     }
2390     /**
2391      * Get the string that describes the options of this page type
2392      * @return string
2393      */
2394     public function option_description_string() {
2395         return '';
2396     }
2398     /**
2399      * Updates a table with the answers for this page
2400      * @param html_table $table
2401      * @return html_table
2402      */
2403     public function display_answers(html_table $table) {
2404         $answers = $this->get_answers();
2405         $i = 1;
2406         foreach ($answers as $answer) {
2407             $cells = array();
2408             $cells[] = "<span class=\"label\">".get_string("jump", "lesson")." $i<span>: ";
2409             $cells[] = $this->get_jump_name($answer->jumpto);
2410             $table->data[] = new html_table_row($cells);
2411             if ($i === 1){
2412                 $table->data[count($table->data)-1]->cells[0]->style = 'width:20%;';
2413             }
2414             $i++;
2415         }
2416         return $table;
2417     }
2419     /**
2420      * Determines if this page should be grayed out on the management/report screens
2421      * @return int 0 or 1
2422      */
2423     protected function get_grayout() {
2424         return 0;
2425     }
2427     /**
2428      * Adds stats for this page to the &pagestats object. This should be defined
2429      * for all page types that grade
2430      * @param array $pagestats
2431      * @param int $tries
2432      * @return bool
2433      */
2434     public function stats(array &$pagestats, $tries) {
2435         return true;
2436     }
2438     /**
2439      * Formats the answers of this page for a report
2440      *
2441      * @param object $answerpage
2442      * @param object $answerdata
2443      * @param object $useranswer
2444      * @param array $pagestats
2445      * @param int $i Count of first level answers
2446      * @param int $n Count of second level answers
2447      * @return object The answer page for this
2448      */
2449     public function report_answers($answerpage, $answerdata, $useranswer, $pagestats, &$i, &$n) {
2450         $answers = $this->get_answers();
2451         $formattextdefoptions = new stdClass;
2452         $formattextdefoptions->para = false;  //I'll use it widely in this page
2453         foreach ($answers as $answer) {
2454             $data = get_string('jumpsto', 'lesson', $this->get_jump_name($answer->jumpto));
2455             $answerdata->answers[] = array($data, "");
2456             $answerpage->answerdata = $answerdata;
2457         }
2458         return $answerpage;
2459     }
2461     /**
2462      * Gets an array of the jumps used by the answers of this page
2463      *
2464      * @return array
2465      */
2466     public function get_jumps() {
2467         global $DB;
2468         $jumps = array();
2469         $params = array ("lessonid" => $this->lesson->id, "pageid" => $this->properties->id);
2470         if ($answers = $this->get_answers()) {
2471             foreach ($answers as $answer) {
2472                 $jumps[] = $this->get_jump_name($answer->jumpto);
2473             }
2474         } else {
2475             $jumps[] = $this->get_jump_name($this->properties->nextpageid);
2476         }
2477         return $jumps;
2478     }
2479     /**
2480      * Informs whether this page type require manual grading or not
2481      * @return bool
2482      */
2483     public function requires_manual_grading() {
2484         return false;
2485     }
2487     /**
2488      * A callback method that allows a page to override the next page a user will
2489      * see during when this page is being completed.
2490      * @return false|int
2491      */
2492     public function override_next_page() {
2493         return false;
2494     }
2496     /**
2497      * This method is used to determine if this page is a valid page
2498      *
2499      * @param array $validpages
2500      * @param array $pageviews
2501      * @return int The next page id to check
2502      */
2503     public function valid_page_and_view(&$validpages, &$pageviews) {
2504         $validpages[$this->properties->id] = 1;
2505         return $this->properties->nextpageid;
2506     }
2511 /**
2512  * Class used to represent an answer to a page
2513  *
2514  * @property int $id The ID of this answer in the database
2515  * @property int $lessonid The ID of the lesson this answer belongs to
2516  * @property int $pageid The ID of the page this answer belongs to
2517  * @property int $jumpto Identifies where the user goes upon completing a page with this answer
2518  * @property int $grade The grade this answer is worth
2519  * @property int $score The score this answer will give
2520  * @property int $flags Used to store options for the answer
2521  * @property int $timecreated A timestamp of when the answer was created
2522  * @property int $timemodified A timestamp of when the answer was modified
2523  * @property string $answer The answer itself
2524  * @property string $response The response the user sees if selecting this answer
2525  *
2526  * @copyright  2009 Sam Hemelryk
2527  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2528  */
2529 class lesson_page_answer extends lesson_base {
2531     /**
2532      * Loads an page answer from the DB
2533      *
2534      * @param int $id
2535      * @return lesson_page_answer
2536      */
2537     public static function load($id) {
2538         global $DB;
2539         $answer = $DB->get_record("lesson_answers", array("id" => $id));
2540         return new lesson_page_answer($answer);
2541     }
2543     /**
2544      * Given an object of properties and a page created answer(s) and saves them
2545      * in the database.
2546      *
2547      * @param stdClass $properties
2548      * @param lesson_page $page
2549      * @return array
2550      */
2551     public static function create($properties, lesson_page $page) {
2552         return $page->create_answers($properties);
2553     }
2557 /**
2558  * A management class for page types
2559  *
2560  * This class is responsible for managing the different pages. A manager object can
2561  * be retrieved by calling the following line of code:
2562  * <code>
2563  * $manager  = lesson_page_type_manager::get($lesson);
2564  * </code>
2565  * The first time the page type manager is retrieved the it includes all of the
2566  * different page types located in mod/lesson/pagetypes.
2567  *
2568  * @copyright  2009 Sam Hemelryk
2569  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2570  */
2571 class lesson_page_type_manager {
2573     /**
2574      * An array of different page type classes
2575      * @var array
2576      */
2577     protected $types = array();
2579     /**
2580      * Retrieves the lesson page type manager object
2581      *
2582      * If the object hasn't yet been created it is created here.
2583      *
2584      * @staticvar lesson_page_type_manager $pagetypemanager
2585      * @param lesson $lesson
2586      * @return lesson_page_type_manager
2587      */
2588     public static function get(lesson $lesson) {
2589         static $pagetypemanager;
2590         if (!($pagetypemanager instanceof lesson_page_type_manager)) {
2591             $pagetypemanager = new lesson_page_type_manager();
2592             $pagetypemanager->load_lesson_types($lesson);
2593         }
2594         return $pagetypemanager;
2595     }
2597     /**
2598      * Finds and loads all lesson page types in mod/lesson/pagetypes
2599      *
2600      * @param lesson $lesson
2601      */
2602     public function load_lesson_types(lesson $lesson) {
2603         global $CFG;
2604         $basedir = $CFG->dirroot.'/mod/lesson/pagetypes/';
2605         $dir = dir($basedir);
2606         while (false !== ($entry = $dir->read())) {
2607             if (strpos($entry, '.')===0 || !preg_match('#^[a-zA-Z]+\.php#i', $entry)) {
2608                 continue;
2609             }
2610             require_once($basedir.$entry);
2611             $class = 'lesson_page_type_'.strtok($entry,'.');
2612             if (class_exists($class)) {
2613                 $pagetype = new $class(new stdClass, $lesson);
2614                 $this->types[$pagetype->typeid] = $pagetype;
2615             }
2616         }
2618     }
2620     /**
2621      * Returns an array of strings to describe the loaded page types
2622      *
2623      * @param int $type Can be used to return JUST the string for the requested type
2624      * @return array
2625      */
2626     public function get_page_type_strings($type=null, $special=true) {
2627         $types = array();
2628         foreach ($this->types as $pagetype) {
2629             if (($type===null || $pagetype->type===$type) && ($special===true || $pagetype->is_standard())) {
2630                 $types[$pagetype->typeid] = $pagetype->typestring;
2631             }
2632         }
2633         return $types;
2634     }
2636     /**
2637      * Returns the basic string used to identify a page type provided with an id
2638      *
2639      * This string can be used to instantiate or identify the page type class.
2640      * If the page type id is unknown then 'unknown' is returned
2641      *
2642      * @param int $id
2643      * @return string
2644      */
2645     public function get_page_type_idstring($id) {
2646         foreach ($this->types as $pagetype) {
2647             if ((int)$pagetype->typeid === (int)$id) {
2648                 return $pagetype->idstring;
2649             }
2650         }
2651         return 'unknown';
2652     }
2654     /**
2655      * Loads a page for the provided lesson given it's id
2656      *
2657      * This function loads a page from the lesson when given both the lesson it belongs
2658      * to as well as the page's id.
2659      * If the page doesn't exist an error is thrown
2660      *
2661      * @param int $pageid The id of the page to load
2662      * @param lesson $lesson The lesson the page belongs to
2663      * @return lesson_page A class that extends lesson_page
2664      */
2665     public function load_page($pageid, lesson $lesson) {
2666         global $DB;
2667         if (!($page =$DB->get_record('lesson_pages', array('id'=>$pageid, 'lessonid'=>$lesson->id)))) {
2668             print_error('cannotfindpages', 'lesson');
2669         }
2670         $pagetype = get_class($this->types[$page->qtype]);
2671         $page = new $pagetype($page, $lesson);
2672         return $page;
2673     }
2675     /**
2676      * This function loads ALL pages that belong to the lesson.
2677      *
2678      * @param lesson $lesson
2679      * @return array An array of lesson_page_type_*
2680      */
2681     public function load_all_pages(lesson $lesson) {
2682         global $DB;
2683         if (!($pages =$DB->get_records('lesson_pages', array('lessonid'=>$lesson->id)))) {
2684             print_error('cannotfindpages', 'lesson');
2685         }
2686         foreach ($pages as $key=>$page) {
2687             $pagetype = get_class($this->types[$page->qtype]);
2688             $pages[$key] = new $pagetype($page, $lesson);
2689         }
2691         $orderedpages = array();
2692         $lastpageid = 0;
2694         while (true) {
2695             foreach ($pages as $page) {
2696                 if ((int)$page->prevpageid === (int)$lastpageid) {
2697                     $orderedpages[$page->id] = $page;
2698                     unset($pages[$page->id]);
2699                     $lastpageid = $page->id;
2700                     if ((int)$page->nextpageid===0) {
2701                         break 2;
2702                     } else {
2703                         break 1;
2704                     }
2705                 }
2706             }
2707         }
2709         return $orderedpages;
2710     }
2712     /**
2713      * Fetches an mform that can be used to create/edit an page
2714      *
2715      * @param int $type The id for the page type
2716      * @param array $arguments Any arguments to pass to the mform
2717      * @return lesson_add_page_form_base
2718      */
2719     public function get_page_form($type, $arguments) {
2720         $class = 'lesson_add_page_form_'.$this->get_page_type_idstring($type);
2721         if (!class_exists($class) || get_parent_class($class)!=='lesson_add_page_form_base') {
2722             debugging('Lesson page type unknown class requested '.$class, DEBUG_DEVELOPER);
2723             $class = 'lesson_add_page_form_selection';
2724         } else if ($class === 'lesson_add_page_form_unknown') {
2725             $class = 'lesson_add_page_form_selection';
2726         }
2727         return new $class(null, $arguments);
2728     }
2730     /**
2731      * Returns an array of links to use as add page links
2732      * @param int $previd The id of the previous page
2733      * @return array
2734      */
2735     public function get_add_page_type_links($previd) {
2736         global $OUTPUT;
2738         $links = array();
2740         foreach ($this->types as $key=>$type) {
2741             if ($link = $type->add_page_link($previd)) {
2742                 $links[$key] = $link;
2743             }
2744         }
2746         return $links;
2747     }