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