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