lib/classes/event/competency_plan_approved.php

   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 approved 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 approved 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_approved extends base {
  45
  46     /**
  47      * Convenience method to instantiate the plan approved event.
  48      *
  49      *
  50      * @param plan $plan The plan.
  51      * @return self
  52      */
  53     public static final function create_from_plan(plan $plan) {
  54         if (!$plan->get('id')) {
  55             throw new \coding_exception('The plan ID must be set.');
  56         }
  57         $event = static::create(array(
  58             'contextid'  => $plan->get_context()->id,
  59             'objectid' => $plan->get('id'),
  60             'relateduserid' => $plan->get('userid'),
  61         ));
  62         $event->add_record_snapshot(plan::TABLE, $plan->to_record());
  63         return $event;
  64     }
  65
  66     /**
  67      * Returns description of what happened.
  68      *
  69      * @return string
  70      */
  71     public function get_description() {
  72         return "The user with id '$this->userid' approved the learning plan with id '$this->objectid'.";
  73     }
  74
  75     /**
  76      * Return localised event name.
  77      *
  78      * @return string
  79      */
  80     public static function get_name() {
  81         return get_string('eventplanapproved', 'core_competency');
  82     }
  83
  84     /**
  85      * Get URL related to the action
  86      *
  87      * @return \moodle_url
  88      */
  89     public function get_url() {
  90         return \core_competency\url::plan($this->objectid);
  91     }
  92
  93     /**
  94      * Init method.
  95      *
  96      * @return void
  97      */
  98     protected function init() {
  99         $this->data['crud'] = 'u';
 100         $this->data['edulevel'] = self::LEVEL_OTHER;
 101         $this->data['objecttable'] = plan::TABLE;
 102     }
 103
 104     /**
 105      * Get_objectid_mapping method.
 106      *
 107      * @return string the name of the restore mapping the objectid links to
 108      */
 109     public static function get_objectid_mapping() {
 110         return base::NOT_MAPPED;
 111     }
 112
 113 }