Your IP : 192.168.165.1
<?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/>.
/**
* The mod_lesson page_moved event class.
*
* @package mod_lesson
* @copyright 2015 Stephen Bourget
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
*/
namespace mod_lesson\event;
defined('MOODLE_INTERNAL') || die();
/**
* The mod_lesson page_moved event class.
*
* @property-read array $other {
* Extra information about event.
*
* - string pagetype: the name of the pagetype as defined in the individual page class
* - int prevpageid: the id of the previous lesson page
* - int nextpageid: the id of the next lesson page
* }
*
* @package mod_lesson
* @since Moodle 2.9
* @copyright 2015 Stephen Bourget
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
*/
class page_moved extends \core\event\base {
/**
* Set basic properties for the event.
*/
protected function init() {
$this->data['objecttable'] = 'lesson_pages';
$this->data['crud'] = 'u';
$this->data['edulevel'] = self::LEVEL_TEACHING;
}
/**
* Returns localised general event name.
*
* @return string
*/
public static function get_name() {
return get_string('eventpagemoved', 'mod_lesson');
}
/**
* Get URL related to the action.
*
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('/mod/lesson/view.php', array('id' => $this->contextinstanceid, 'pageid' => $this->objectid));
}
/**
* Returns non-localised event description with id's for admin use only.
*
* @return string
*/
public function get_description() {
return "The user with id '$this->userid' has moved a ".$this->other['pagetype']." page with the ".
"id '$this->objectid' to the slot after the page with the id '".$this->other['prevpageid'].
"' and before the page with the id '".$this->other['nextpageid'].
"' in the lesson activity with course module id '$this->contextinstanceid'.";
}
/**
* Custom validations.
*
* @throws \coding_exception when validation fails.
* @return void
*/
protected function validate_data() {
parent::validate_data();
// Make sure this class is never used without proper object details.
if (!$this->contextlevel === CONTEXT_MODULE) {
throw new \coding_exception('Context level must be CONTEXT_MODULE.');
}
if (!isset($this->other['pagetype'])) {
throw new \coding_exception('The \'pagetype\' value must be set in other.');
}
if (!isset($this->other['prevpageid'])) {
throw new \coding_exception('The \'prevpageid\' value must be set in other.');
}
if (!isset($this->other['nextpageid'])) {
throw new \coding_exception('The \'nextpageid\' value must be set in other.');
}
}
public static function get_objectid_mapping() {
return array('db' => 'lesson_pages', 'restore' => 'lesson_page');
}
public static function get_other_mapping() {
$othermapped = array();
$othermapped['prevpageid'] = array('db' => 'lesson_pages', 'restore' => 'lesson_page');
$othermapped['nextpageid'] = array('db' => 'lesson_pages', 'restore' => 'lesson_page');
return $othermapped;
}
}