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