[Summary view]

Differences Between: [Versions 310 and 403] [Versions 311 and 403] [Versions 39 and 403] [Versions 400 and 403] [Versions 401 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   * booktool_print chapter printed event.
  19   *
  20   * @package    booktool_print
  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 booktool_print\event;
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * booktool_print chapter printed event class.
  30   *
  31   * @package    booktool_print
  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_printed 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_printed
  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_printed $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' has printed the chapter with id '$this->objectid' of the book with " .
  66              "course module id '$this->contextinstanceid'.";
  67      }
  68  
  69      /**
  70       * Return localised event name.
  71       *
  72       * @return string
  73       */
  74      public static function get_name() {
  75          return get_string('eventchapterprinted', 'booktool_print');
  76      }
  77  
  78      /**
  79       * Get URL related to the action.
  80       *
  81       * @return \moodle_url
  82       */
  83      public function get_url() {
  84          return new \moodle_url('/mod/book/tool/print/index.php', array('id' => $this->contextinstanceid));
  85      }
  86  
  87      /**
  88       * Init method.
  89       *
  90       * @return void
  91       */
  92      protected function init() {
  93          $this->data['crud'] = 'r';
  94          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  95          $this->data['objecttable'] = 'book_chapters';
  96      }
  97  
  98      public static function get_objectid_mapping() {
  99          return array('db' => 'book_chapters', 'restore' => 'book_chapter');
 100      }
 101  }