[Summary view]

Differences Between: [Versions 311 and 402] [Versions 311 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   * Event for when a new blog entry is added..
  19   *
  20   * @package    core
  21   * @copyright  2013 Ankit Agarwal
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core\event;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * Class blog_entry_created
  31   *
  32   * Class for event to be triggered when a blog entry is created.
  33   *
  34   * @package    core
  35   * @since      Moodle 2.6
  36   * @copyright  2013 Ankit Agarwal
  37   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  38   */
  39  class blog_entry_created extends base {
  40  
  41      /** @var \blog_entry A reference to the active blog_entry object. */
  42      protected $blogentry;
  43  
  44      /**
  45       * Set basic properties for the event.
  46       */
  47      protected function init() {
  48          $this->context = \context_system::instance();
  49          $this->data['objecttable'] = 'post';
  50          $this->data['crud'] = 'c';
  51          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  52      }
  53  
  54      /**
  55       * Set blog_entry object to be used by observers.
  56       *
  57       * @param \blog_entry $blogentry A reference to the active blog_entry object.
  58       */
  59      public function set_blog_entry(\blog_entry $blogentry) {
  60          $this->blogentry = $blogentry;
  61      }
  62  
  63      /**
  64       * Returns created blog_entry object for event observers.
  65       *
  66       * @throws \coding_exception
  67       * @return \blog_entry
  68       */
  69      public function get_blog_entry() {
  70          if ($this->is_restored()) {
  71              throw new \coding_exception('Function get_blog_entry() can not be used on restored events.');
  72          }
  73          return $this->blogentry;
  74      }
  75  
  76      /**
  77       * Returns localised general event name.
  78       *
  79       * @return string
  80       */
  81      public static function get_name() {
  82          return get_string('evententryadded', 'core_blog');
  83      }
  84  
  85      /**
  86       * Returns non-localised event description with id's for admin use only.
  87       *
  88       * @return string
  89       */
  90      public function get_description() {
  91          return "The user with id '$this->userid' created the blog entry with id '$this->objectid'.";
  92      }
  93  
  94      /**
  95       * Returns relevant URL.
  96       * @return \moodle_url
  97       */
  98      public function get_url() {
  99          return new \moodle_url('/blog/index.php', array('entryid' => $this->objectid));
 100      }
 101  
 102      /**
 103       * Does this event replace legacy event?
 104       *
 105       * @return string legacy event name
 106       */
 107      public static function get_legacy_eventname() {
 108          return 'blog_entry_added';
 109      }
 110  
 111      /**
 112       * Legacy event data if get_legacy_eventname() is not empty.
 113       *
 114       * @return \blog_entry
 115       */
 116      protected function get_legacy_eventdata() {
 117          return $this->blogentry;
 118      }
 119  
 120      /**
 121       * Replace add_to_log() statement.
 122       *
 123       * @return array of parameters to be passed to legacy add_to_log() function.
 124       */
 125      protected function get_legacy_logdata() {
 126          return array (SITEID, 'blog', 'add', 'index.php?userid=' . $this->relateduserid . '&entryid=' . $this->objectid,
 127              $this->blogentry->subject);
 128      }
 129  
 130      /**
 131       * Custom validations.
 132       *
 133       * @throws \coding_exception
 134       * @return void
 135       */
 136      protected function validate_data() {
 137          parent::validate_data();
 138  
 139          if (!isset($this->relateduserid)) {
 140              throw new \coding_exception('The \'relateduserid\' must be set.');
 141          }
 142      }
 143  
 144      public static function get_objectid_mapping() {
 145          // Blogs are not backed up, so no mapping required for restore.
 146          return array('db' => 'post', 'restore' => base::NOT_MAPPED);
 147      }
 148  }