source: moodle/trunk/fuentes/lib/classes/event/user_created.php @ 1331

Last change on this file since 1331 was 1331, checked in by jrpelegrina, 3 years ago

Updated to moodle 3.0.3

File size: 3.7 KB
Line 
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 * User created event.
19 *
20 * @package    core
21 * @copyright  2013 Rajesh Taneja <rajesh@moodle.com>
22 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24
25namespace core\event;
26
27defined('MOODLE_INTERNAL') || die();
28
29/**
30 * Event when new user profile is created.
31 *
32 * @package    core
33 * @since      Moodle 2.6
34 * @copyright  2013 Rajesh Taneja <rajesh@moodle.com>
35 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36 */
37class user_created extends base {
38
39    /**
40     * Initialise required event data properties.
41     */
42    protected function init() {
43        $this->data['objecttable'] = 'user';
44        $this->data['crud'] = 'c';
45        $this->data['edulevel'] = self::LEVEL_OTHER;
46    }
47
48    /**
49     * Returns localised event name.
50     *
51     * @return string
52     */
53    public static function get_name() {
54        return get_string('eventusercreated');
55    }
56
57    /**
58     * Returns non-localised event description with id's for admin use only.
59     *
60     * @return string
61     */
62    public function get_description() {
63        return "The user with id '$this->userid' created the user with id '$this->objectid'.";
64    }
65
66    /**
67     * Returns relevant URL.
68     *
69     * @return \moodle_url
70     */
71    public function get_url() {
72        return new \moodle_url('/user/view.php', array('id' => $this->objectid));
73    }
74
75    /**
76     * Return name of the legacy event, which is replaced by this event.
77     *
78     * @return string legacy event name
79     */
80    public static function get_legacy_eventname() {
81        return 'user_created';
82    }
83
84    /**
85     * Return user_created legacy event data.
86     *
87     * @return \stdClass user data.
88     */
89    protected function get_legacy_eventdata() {
90        return $this->get_record_snapshot('user', $this->objectid);
91    }
92
93    /**
94     * Returns array of parameters to be passed to legacy add_to_log() function.
95     *
96     * @return array
97     */
98    protected function get_legacy_logdata() {
99        return array(SITEID, 'user', 'add', '/view.php?id='.$this->objectid, fullname($this->get_legacy_eventdata()));
100    }
101
102    /**
103     * Custom validation.
104     *
105     * @throws \coding_exception
106     * @return void
107     */
108    protected function validate_data() {
109        parent::validate_data();
110
111        if (!isset($this->relateduserid)) {
112            debugging('The \'relateduserid\' value must be specified in the event.', DEBUG_DEVELOPER);
113            $this->relateduserid = $this->objectid;
114        }
115    }
116
117    /**
118     * Create instance of event.
119     *
120     * @since Moodle 2.6.4, 2.7.1
121     *
122     * @param int $userid id of user
123     * @return user_created
124     */
125    public static function create_from_userid($userid) {
126        $data = array(
127            'objectid' => $userid,
128            'relateduserid' => $userid,
129            'context' => \context_user::instance($userid)
130        );
131
132        // Create user_created event.
133        $event = self::create($data);
134        return $event;
135    }
136
137    public static function get_objectid_mapping() {
138        return array('db' => 'user', 'restore' => 'user');
139    }
140}
Note: See TracBrowser for help on using the repository browser.