Proyectos de Subversion Moodle

Rev

| Ultima modificación | Ver Log |

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