83421d083de3bfa609b8b31cca810d7b535ab3db
[moodle.git] / mod / lesson / pagetypes / endofcluster.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  * End of cluster
20  *
21  * @package    mod
22  * @subpackage lesson
23  * @copyright  2009 Sam Hemelryk
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  **/
27 defined('MOODLE_INTERNAL') || die();
29  /** End of Cluster page */
30 define("LESSON_PAGE_ENDOFCLUSTER",   "31");
32 class lesson_page_type_endofcluster extends lesson_page {
34     protected $type = lesson_page::TYPE_STRUCTURE;
35     protected $typeidstring = 'endofcluster';
36     protected $typeid = LESSON_PAGE_ENDOFCLUSTER;
37     protected $string = null;
38     protected $jumpto = null;
40     public function display($renderer, $attempt) {
41         return '';
42     }
43     public function get_typeid() {
44         return $this->typeid;
45     }
46     public function get_typestring() {
47         if ($this->string===null) {
48             $this->string = get_string($this->typeidstring, 'lesson');
49         }
50         return $this->string;
51     }
52     public function get_idstring() {
53         return $this->typeidstring;
54     }
55     public function callback_on_view($canmanage) {
56         $this->redirect_to_next_page($canmanage);
57         exit;
58     }
59     public function redirect_to_next_page() {
60         global $PAGE;
61         if ($this->properties->nextpageid == 0) {
62             $nextpageid = LESSON_EOL;
63         } else {
64             $nextpageid = $this->properties->nextpageid;
65         }
66         redirect(new moodle_url('/mod/lesson/view.php', array('id'=>$PAGE->cm->id,'pageid'=>$nextpageid)));
67     }
68     public function get_grayout() {
69         return 1;
70     }
71     public function update($properties) {
72         global $DB, $PAGE;
74         $properties->id = $this->properties->id;
75         $properties->lessonid = $this->lesson->id;
76         if (empty($properties->qoption)) {
77             $properties->qoption = '0';
78         }
79         $properties = file_postupdate_standard_editor($properties, 'contents', array('noclean'=>true, 'maxfiles'=>EDITOR_UNLIMITED_FILES, 'maxbytes'=>$PAGE->course->maxbytes), get_context_instance(CONTEXT_MODULE, $PAGE->cm->id), 'mod_lesson', 'page_contents', $properties->id);
80         $DB->update_record("lesson_pages", $properties);
82         $answers  = $this->get_answers();
83         if (count($answers)>1) {
84             $answer = array_shift($answers);
85             foreach ($answers as $a) {
86                 $DB->delete_record('lesson_answers', array('id'=>$a->id));
87             }
88         } else if (count($answers)==1) {
89             $answer = array_shift($answers);
90         } else {
91             $answer = new stdClass;
92         }
94         $answer->timemodified = time();;
95         if (isset($properties->jumpto[0])) {
96             $answer->jumpto = $properties->jumpto[0];
97         }
98         if (isset($form->score[0])) {
99             $answer->score = $properties->score[0];
100         }
101         if (!empty($answer->id)) {
102             $DB->update_record("lesson_answers", $answer->properties());
103         } else {
104             $DB->insert_record("lesson_answers", $answer);
105         }
106         return true;
107     }
108     public function override_next_page() {
109         $jump = $DB->get_field("lesson_answers", "jumpto", array("pageid" => $this->properties->id, "lessonid" => $this->lesson->id));
110         if ($jump == LESSON_NEXTPAGE) {
111             if ($this->properties->nextpageid == 0) {
112                 return LESSON_EOL;
113             } else {
114                 return $this->properties->nextpageid;
115             }
116         } else {
117             return $jump;
118         }
119     }
120     public function add_page_link($previd) {
121         global $PAGE, $CFG;
122         if ($previd != 0) {
123             $addurl = new moodle_url('/mod/lesson/editpage.php', array('id'=>$PAGE->cm->id, 'pageid'=>$previd, 'sesskey'=>sesskey(), 'qtype'=>LESSON_PAGE_ENDOFCLUSTER));
124             return array('addurl'=>$addurl, 'type'=>LESSON_PAGE_ENDOFCLUSTER, 'name'=>get_string('addendofcluster', 'lesson'));
125         }
126         return false;
127     }
128     public function valid_page_and_view(&$validpages, &$pageviews) {
129         return $this->properties->nextpageid;
130     }
133 class lesson_add_page_form_endofcluster extends lesson_add_page_form_base {
135     public $qtype = LESSON_PAGE_ENDOFCLUSTER;
136     public $qtypestring = 'endofcluster';
137     protected $standard = false;
139     public function custom_definition() {
140         global $PAGE;
142         $mform = $this->_form;
143         $lesson = $this->_customdata['lesson'];
144         $jumptooptions = lesson_page_type_branchtable::get_jumptooptions(optional_param('firstpage', false, PARAM_BOOL), $lesson);
146         $mform->addElement('hidden', 'firstpage');
147         $mform->setType('firstpage', PARAM_BOOL);
149         $mform->addElement('hidden', 'qtype');
150         $mform->setType('qtype', PARAM_TEXT);
152         $mform->addElement('text', 'title', get_string("pagetitle", "lesson"), array('size'=>70));
153         $mform->setType('title', PARAM_TEXT);
155         $this->editoroptions = array('noclean'=>true, 'maxfiles'=>EDITOR_UNLIMITED_FILES, 'maxbytes'=>$PAGE->course->maxbytes);
156         $mform->addElement('editor', 'contents_editor', get_string("pagecontents", "lesson"), null, $this->editoroptions);
157         $mform->setType('contents_editor', PARAM_RAW);
159         $this->add_jumpto(0);
160     }
162     public function construction_override($pageid, $lesson) {
163         global $CFG, $PAGE, $DB;
164         require_sesskey();
166         $timenow = time();
168         // the new page is not the first page (end of cluster always comes after an existing page)
169         if (!$page = $DB->get_record("lesson_pages", array("id" => $pageid))) {
170             print_error('cannotfindpages', 'lesson');
171         }
173         // could put code in here to check if the user really can insert an end of cluster
175         $newpage = new stdClass;
176         $newpage->lessonid = $lesson->id;
177         $newpage->prevpageid = $pageid;
178         $newpage->nextpageid = $page->nextpageid;
179         $newpage->qtype = $this->qtype;
180         $newpage->timecreated = $timenow;
181         $newpage->title = get_string("endofclustertitle", "lesson");
182         $newpage->contents = get_string("endofclustertitle", "lesson");
183         $newpageid = $DB->insert_record("lesson_pages", $newpage);
184         // update the linked list...
185         $DB->set_field("lesson_pages", "nextpageid", $newpageid, array("id" => $pageid));
186         if ($page->nextpageid) {
187             // the new page is not the last page
188             $DB->set_field("lesson_pages", "prevpageid", $newpageid, array("id" => $page->nextpageid));
189         }
190         // ..and the single "answer"
191         $newanswer = new stdClass;
192         $newanswer->lessonid = $lesson->id;
193         $newanswer->pageid = $newpageid;
194         $newanswer->timecreated = $timenow;
195         $newanswer->jumpto = LESSON_NEXTPAGE;
196         $newanswerid = $DB->insert_record("lesson_answers", $newanswer);
197         $lesson->add_message(get_string('addedendofcluster', 'lesson'), 'notifysuccess');
198         redirect($CFG->wwwroot.'/mod/lesson/edit.php?id='.$PAGE->cm->id);
199     }