[Summary view]

   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   * Plan deleted event.
  19   *
  20   * @package    core_competency
  21   * @copyright  2016 Issam Taboubi <issam.taboubi@umontreal.ca>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core\event;
  26  
  27  use core\event\base;
  28  use core_competency\plan;
  29  
  30  defined('MOODLE_INTERNAL') || die();
  31  
  32  /**
  33   * Plan deleted event class.
  34   *
  35   * @property-read array $other {
  36   *      Extra information about event.
  37   * }
  38   *
  39   * @package    core_competency
  40   * @since      Moodle 3.1
  41   * @copyright  2016 Issam Taboubi <issam.taboubi@umontreal.ca>
  42   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  43   */
  44  class competency_plan_deleted extends base {
  45  
  46      /**
  47       * Convenience method to instantiate the event.
  48       *
  49       * @param plan $plan The plan.
  50       * @return self
  51       */
  52      public static final function create_from_plan(plan $plan) {
  53          if (!$plan->get('id')) {
  54              throw new \coding_exception('The plan ID must be set.');
  55          }
  56          $event = static::create(array(
  57              'contextid'  => $plan->get_context()->id,
  58              'objectid' => $plan->get('id')
  59          ));
  60          $event->add_record_snapshot(plan::TABLE, $plan->to_record());
  61          return $event;
  62      }
  63  
  64      /**
  65       * Returns description of what happened.
  66       *
  67       * @return string
  68       */
  69      public function get_description() {
  70          return "The user with id '$this->userid' deleted the learning plan with id '$this->objectid'.";
  71      }
  72  
  73      /**
  74       * Return localised event name.
  75       *
  76       * @return string
  77       */
  78      public static function get_name() {
  79          return get_string('eventplandeleted', 'core_competency');
  80      }
  81  
  82      /**
  83       * Init method.
  84       *
  85       * @return void
  86       */
  87      protected function init() {
  88          $this->data['crud'] = 'd';
  89          $this->data['edulevel'] = self::LEVEL_OTHER;
  90          $this->data['objecttable'] = plan::TABLE;
  91      }
  92  
  93      /**
  94       * Get_objectid_mapping method.
  95       *
  96       * @return string the name of the restore mapping the objectid links to
  97       */
  98      public static function get_objectid_mapping() {
  99          return base::NOT_MAPPED;
 100      }
 101  
 102  }