[Summary view]

Differences Between: [Versions 310 and 402] [Versions 310 and 403]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * The mod_book chapter updated event.
  19   *
  20   * @package    mod_book
  21   * @copyright  2013 Frédéric Massart
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace mod_book\event;
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * The mod_book chapter updated event class.
  30   *
  31   * @package    mod_book
  32   * @since      Moodle 2.6
  33   * @copyright  2013 Frédéric Massart
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class chapter_updated extends \core\event\base {
  37      /**
  38       * Create instance of event.
  39       *
  40       * @since Moodle 2.7
  41       *
  42       * @param \stdClass $book
  43       * @param \context_module $context
  44       * @param \stdClass $chapter
  45       * @return chapter_updated
  46       */
  47      public static function create_from_chapter(\stdClass $book, \context_module $context, \stdClass $chapter) {
  48          $data = array(
  49              'context' => $context,
  50              'objectid' => $chapter->id,
  51          );
  52          /** @var chapter_updated $event */
  53          $event = self::create($data);
  54          $event->add_record_snapshot('book', $book);
  55          $event->add_record_snapshot('book_chapters', $chapter);
  56          return $event;
  57      }
  58  
  59      /**
  60       * Returns description of what happened.
  61       *
  62       * @return string
  63       */
  64      public function get_description() {
  65          return "The user with id '$this->userid' updated the chapter with id '$this->objectid' for the book with " .
  66              "course module id '$this->contextinstanceid'.";
  67      }
  68  
  69      /**
  70       * Return the legacy event log data.
  71       *
  72       * @return array|null
  73       */
  74      protected function get_legacy_logdata() {
  75          return array($this->courseid, 'book', 'update chapter', 'view.php?id=' . $this->contextinstanceid . '&chapterid=' .
  76              $this->objectid, $this->objectid, $this->contextinstanceid);
  77      }
  78  
  79      /**
  80       * Return localised event name.
  81       *
  82       * @return string
  83       */
  84      public static function get_name() {
  85          return get_string('eventchapterupdated', 'mod_book');
  86      }
  87  
  88      /**
  89       * Get URL related to the action.
  90       *
  91       * @return \moodle_url
  92       */
  93      public function get_url() {
  94          return new \moodle_url('/mod/book/view.php', array(
  95              'id' => $this->contextinstanceid,
  96              'chapterid' => $this->objectid
  97          ));
  98      }
  99  
 100      /**
 101       * Init method.
 102       *
 103       * @return void
 104       */
 105      protected function init() {
 106          $this->data['crud'] = 'u';
 107          $this->data['edulevel'] = self::LEVEL_TEACHING;
 108          $this->data['objecttable'] = 'book_chapters';
 109      }
 110  
 111      public static function get_objectid_mapping() {
 112          return array('db' => 'book_chapters', 'restore' => 'book_chapter');
 113      }
 114  }