[Summary view]

Differences Between: [Versions 400 and 402] [Versions 400 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_exportimscp book exported event.
  19   *
  20   * @package    booktool_exportimscp
  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_exportimscp\event;
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * booktool_exportimscp book exported event class.
  30   *
  31   * @package    booktool_exportimscp
  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 book_exported 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       * @return book_exported
  45       */
  46      public static function create_from_book(\stdClass $book, \context_module $context) {
  47          $data = array(
  48              'context' => $context,
  49              'objectid' => $book->id
  50          );
  51          /** @var book_exported $event */
  52          $event = self::create($data);
  53          $event->add_record_snapshot('book', $book);
  54          return $event;
  55      }
  56  
  57      /**
  58       * Returns description of what happened.
  59       *
  60       * @return string
  61       */
  62      public function get_description() {
  63          return "The user with id '$this->userid' has exported the book with course module id '$this->contextinstanceid'.";
  64      }
  65  
  66      /**
  67       * Return the legacy event log data.
  68       *
  69       * @return array|null
  70       */
  71      protected function get_legacy_logdata() {
  72          return array($this->courseid, 'book', 'exportimscp', 'tool/exportimscp/index.php?id=' . $this->contextinstanceid,
  73              $this->objectid, $this->contextinstanceid);
  74      }
  75  
  76      /**
  77       * Return localised event name.
  78       *
  79       * @return string
  80       */
  81      public static function get_name() {
  82          return get_string('eventbookexported', 'booktool_exportimscp');
  83      }
  84  
  85      /**
  86       * Get URL related to the action.
  87       *
  88       * @return \moodle_url
  89       */
  90      public function get_url() {
  91          return new \moodle_url('/mod/book/tool/exportimscp/index.php', array('id' => $this->contextinstanceid));
  92      }
  93  
  94      /**
  95       * Init method.
  96       *
  97       * @return void
  98       */
  99      protected function init() {
 100          $this->data['crud'] = 'r';
 101          $this->data['edulevel'] = self::LEVEL_OTHER;
 102          $this->data['objecttable'] = 'book';
 103      }
 104  
 105      public static function get_objectid_mapping() {
 106          return array('db' => 'book', 'restore' => 'book');
 107      }
 108  }