| 1 | efrain | 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 framework updated event.
 | 
        
           |  |  | 19 |  *
 | 
        
           |  |  | 20 |  * @package    core_competency
 | 
        
           |  |  | 21 |  * @copyright  2016 Serge Gauthier <serge.gauthier.2@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_framework;
 | 
        
           |  |  | 29 |   | 
        
           |  |  | 30 | defined('MOODLE_INTERNAL') || die();
 | 
        
           |  |  | 31 |   | 
        
           |  |  | 32 | /**
 | 
        
           |  |  | 33 |  * Competency framework updated 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 Serge Gauthier <serge.gauthier.2@umontreal.ca>
 | 
        
           |  |  | 42 |  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 | 
        
           |  |  | 43 |  */
 | 
        
           |  |  | 44 | class competency_framework_updated extends base {
 | 
        
           |  |  | 45 |   | 
        
           |  |  | 46 |     /**
 | 
        
           |  |  | 47 |      * Convenience method to instantiate the event.
 | 
        
           |  |  | 48 |      *
 | 
        
           |  |  | 49 |      * @param competency_framework $framework The framework.
 | 
        
           |  |  | 50 |      * @return self
 | 
        
           |  |  | 51 |      */
 | 
        
           |  |  | 52 |     final public static function create_from_framework(competency_framework $framework) {
 | 
        
           |  |  | 53 |         if (!$framework->get('id')) {
 | 
        
           |  |  | 54 |             throw new \coding_exception('The competency framework ID must be set.');
 | 
        
           |  |  | 55 |         }
 | 
        
           |  |  | 56 |         $event = static::create(array(
 | 
        
           |  |  | 57 |             'contextid'  => $framework->get('contextid'),
 | 
        
           |  |  | 58 |             'objectid' => $framework->get('id')
 | 
        
           |  |  | 59 |         ));
 | 
        
           |  |  | 60 |         $event->add_record_snapshot(competency_framework::TABLE, $framework->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' updated the competency framework 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('eventcompetencyframeworkupdated', 'core_competency');
 | 
        
           |  |  | 80 |     }
 | 
        
           |  |  | 81 |   | 
        
           |  |  | 82 |     /**
 | 
        
           |  |  | 83 |      * Get URL related to the action
 | 
        
           |  |  | 84 |      *
 | 
        
           |  |  | 85 |      * @return \moodle_url
 | 
        
           |  |  | 86 |      */
 | 
        
           |  |  | 87 |     public function get_url() {
 | 
        
           |  |  | 88 |         return \core_competency\url::framework($this->objectid, $this->contextid);
 | 
        
           |  |  | 89 |     }
 | 
        
           |  |  | 90 |   | 
        
           |  |  | 91 |     /**
 | 
        
           |  |  | 92 |      * Init method.
 | 
        
           |  |  | 93 |      *
 | 
        
           |  |  | 94 |      * @return void
 | 
        
           |  |  | 95 |      */
 | 
        
           |  |  | 96 |     protected function init() {
 | 
        
           |  |  | 97 |         $this->data['crud'] = 'u';
 | 
        
           |  |  | 98 |         $this->data['edulevel'] = self::LEVEL_OTHER;
 | 
        
           |  |  | 99 |         $this->data['objecttable'] = competency_framework::TABLE;
 | 
        
           |  |  | 100 |     }
 | 
        
           |  |  | 101 |   | 
        
           |  |  | 102 |     /**
 | 
        
           |  |  | 103 |      * Get_objectid_mapping method.
 | 
        
           |  |  | 104 |      *
 | 
        
           |  |  | 105 |      * @return string the name of the restore mapping the objectid links to
 | 
        
           |  |  | 106 |      */
 | 
        
           |  |  | 107 |     public static function get_objectid_mapping() {
 | 
        
           |  |  | 108 |         return base::NOT_MAPPED;
 | 
        
           |  |  | 109 |     }
 | 
        
           |  |  | 110 |   | 
        
           |  |  | 111 | }
 |