<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Cluster
*
* @package mod_lesson
* @copyright 2009 Sam Hemelryk
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
**/
defined('MOODLE_INTERNAL') || die();
/** Start of Cluster page */
define("LESSON_PAGE_CLUSTER", "30");
class lesson_page_type_cluster extends lesson_page {
protected $type = lesson_page::TYPE_STRUCTURE;
protected $typeidstring = 'cluster';
protected $typeid = LESSON_PAGE_CLUSTER;
protected $string = null;
protected $jumpto = null;
public function display($renderer, $attempt) {
return '';
}
public function get_typeid() {
return $this->typeid;
}
public function get_typestring() {
if ($this->string===null) {
$this->string = get_string($this->typeidstring, 'lesson');
}
return $this->string;
}
public function get_idstring() {
return $this->typeidstring;
}
public function get_grayout() {
return 1;
}
public function callback_on_view($canmanage, $redirect = true) {
global $USER;
if (!$canmanage) {
// Get the next page in the lesson cluster jump
return (int) $this->lesson->cluster_jump($this->properties->id);
} else {
// get the next page
return (int) $this->properties->nextpageid;
}
}
public function override_next_page() {
global $USER;
return $this->lesson->cluster_jump($this->properties->id);
}
public function add_page_link($previd) {
global $PAGE, $CFG;
$addurl = new moodle_url('/mod/lesson/editpage.php', array('id'=>$PAGE->cm->id, 'pageid'=>$previd, 'sesskey'=>sesskey(), 'qtype'=>LESSON_PAGE_CLUSTER));
return array('addurl'=>$addurl, 'type'=>LESSON_PAGE_CLUSTER, 'name'=>get_string('addcluster', 'lesson'));
}
public function valid_page_and_view(&$validpages, &$pageviews) {
$validpages[$this->properties->id] = 1; // add the cluster page as a valid page
foreach ($this->lesson->get_sub_pages_of($this->properties->id, array(LESSON_PAGE_ENDOFCLUSTER)) as $subpage) {
if (in_array($subpage->id, $pageviews)) {
unset($pageviews[array_search($subpage->id, $pageviews)]); // remove it
// since the user did see one page in the cluster, add the cluster pageid to the viewedpageids
if (!in_array($this->properties->id, $pageviews)) {
$pageviews[] = $this->properties->id;
}
}
}
return $this->properties->nextpageid;
}
>
}
> /**
> * Creates answers within the database for this cluster page. Usually only ever
class lesson_add_page_form_cluster extends lesson_add_page_form_base {
> * called when creating a new page instance.
> * @param object $properties
public $qtype = LESSON_PAGE_CLUSTER;
> * @return array
public $qtypestring = 'cluster';
> */
protected $standard = false;
> public function create_answers($properties) {
> global $DB;
public function custom_definition() {
>
global $PAGE, $CFG;
> $newanswer = new stdClass;
> $newanswer->lessonid = $this->lesson->id;
$mform = $this->_form;
> $newanswer->pageid = $this->properties->id;
$lesson = $this->_customdata['lesson'];
> $newanswer->timecreated = $this->properties->timecreated;
$jumptooptions = lesson_page_type_branchtable::get_jumptooptions(optional_param('firstpage', false, PARAM_BOOL), $lesson);
>
> if (isset($properties->jumpto[0])) {
$mform->addElement('hidden', 'firstpage');
> $newanswer->jumpto = $properties->jumpto[0];
$mform->setType('firstpage', PARAM_BOOL);
> }
> $newanswer->id = $DB->insert_record('lesson_answers', $newanswer);
$mform->addElement('hidden', 'qtype');
> $answers = [$newanswer->id => new lesson_page_answer($newanswer)];
$mform->setType('qtype', PARAM_TEXT);
> $this->answers = $answers;
> return $answers;
$mform->addElement('text', 'title', get_string("pagetitle", "lesson"), array('size'=>70));
> }
if (!empty($CFG->formatstringstriptags)) {
$mform->setType('title', PARAM_TEXT);
} else {
$mform->setType('title', PARAM_CLEANHTML);
}
$this->editoroptions = array('noclean'=>true, 'maxfiles'=>EDITOR_UNLIMITED_FILES, 'maxbytes'=>$PAGE->course->maxbytes);
$mform->addElement('editor', 'contents_editor', get_string("pagecontents", "lesson"), null, $this->editoroptions);
$mform->setType('contents_editor', PARAM_RAW);
$this->add_jumpto(0);
}
public function construction_override($pageid, lesson $lesson) {
global $PAGE, $CFG, $DB;
require_sesskey();
$timenow = time();
if ($pageid == 0) {
if ($lesson->has_pages()) {
if (!$page = $DB->get_record("lesson_pages", array("prevpageid" => 0, "lessonid" => $lesson->id))) {
< print_error('cannotfindpagerecord', 'lesson');
> throw new \moodle_exception('cannotfindpagerecord', 'lesson');
}
} else {
// This is the ONLY page
$page = new stdClass;
$page->id = 0;
}
} else {
if (!$page = $DB->get_record("lesson_pages", array("id" => $pageid))) {
< print_error('cannotfindpagerecord', 'lesson');
> throw new \moodle_exception('cannotfindpagerecord', 'lesson');
}
}
$newpage = new stdClass;
$newpage->lessonid = $lesson->id;
$newpage->prevpageid = $pageid;
if ($pageid != 0) {
$newpage->nextpageid = $page->nextpageid;
} else {
$newpage->nextpageid = $page->id;
}
$newpage->qtype = $this->qtype;
$newpage->timecreated = $timenow;
$newpage->title = get_string("clustertitle", "lesson");
$newpage->contents = get_string("clustertitle", "lesson");
$newpageid = $DB->insert_record("lesson_pages", $newpage);
// update the linked list...
if ($pageid != 0) {
$DB->set_field("lesson_pages", "nextpageid", $newpageid, array("id" => $pageid));
}
if ($pageid == 0) {
$page->nextpageid = $page->id;
}
if ($page->nextpageid) {
// the new page is not the last page
$DB->set_field("lesson_pages", "prevpageid", $newpageid, array("id" => $page->nextpageid));
}
// ..and the single "answer"
$newanswer = new stdClass;
$newanswer->lessonid = $lesson->id;
$newanswer->pageid = $newpageid;
$newanswer->timecreated = $timenow;
$newanswer->jumpto = LESSON_CLUSTERJUMP;
$newanswerid = $DB->insert_record("lesson_answers", $newanswer);
$lesson->add_message(get_string('addedcluster', 'lesson'), 'notifysuccess');
redirect($CFG->wwwroot.'/mod/lesson/edit.php?id='.$PAGE->cm->id);
}
}