-
Notifications
You must be signed in to change notification settings - Fork 0
/
lib.php
175 lines (154 loc) · 5.85 KB
/
lib.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Prints an instance of mod_findpartner.
*
* @package mod_findpartner
* @copyright 2020 Rodrigo Aguirregabiria Herrero
* @copyright 2020 Manuel Alfredo Collado Centeno
* @copyright 2020 GIETA Universidad Politécnica de Madrid (http://gieta.etsisi.upm.es/)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
/**
* Return if the plugin supports $feature.
*
* @param string $feature Constant representing the feature.
* @return true | null True if the feature is supported, null otherwise.
*/
function findpartner_supports($feature) {
switch ($feature) {
case FEATURE_MOD_INTRO:
return true;
default:
return null;
}
}
/**
* Saves a new instance of the mod_findpartner into the database.
*
* Given an object containing all the necessary data, (defined by the form
* in mod_form.php) this function will create a new instance and return the id
* number of the instance.
*
* @param object $moduleinstance An object from the form.
* @param mod_findpartner_mod_form $mform The form.
* @return int The id of the newly inserted record.
*/
function findpartner_add_instance($moduleinstance, $mform = null) {
global $DB;
$moduleinstance->timecreated = time();
$moduleinstance->timemodified = time();
$moduleinstance->id = $DB->insert_record('findpartner', $moduleinstance);
// Add calendar events if necessary.
findpartner_set_events($moduleinstance);
if (!empty($moduleinstance->completionexpected)) {
\core_completion\api::update_completion_date_event($moduleinstance->coursemodule, 'findpartner', $moduleinstance->id,
$moduleinstance->completionexpected);
}
return $moduleinstance->id;
}
/**
* Updates an instance of the mod_findpartner in the database.
*
* Given an object containing all the necessary data (defined in mod_form.php),
* this function will update an existing instance with new data.
*
* @param object $moduleinstance An object from the form in mod_form.php.
* @param mod_findpartner_mod_form $mform The form.
* @return bool True if successful, false otherwise.
*/
function findpartner_update_instance($moduleinstance, $mform = null) {
global $DB;
$moduleinstance->timemodified = time();
$moduleinstance->id = $moduleinstance->instance;
$DB->update_record('findpartner', $moduleinstance);
// Add calendar events if necessary.
findpartner_set_events($moduleinstance);
if (!empty($moduleinstance->completionexpected)) {
\core_completion\api::update_completion_date_event($moduleinstance->coursemodule, 'findpartner', $moduleinstance->id,
$moduleinstance->completionexpected);
}
return true;
}
/**
* Removes an instance of the mod_findpartner from the database.
*
* @param int $id Id of the module instance.
* @return bool True if successful, false on failure.
*/
function findpartner_delete_instance($id) {
global $DB;
$exists = $DB->get_record('findpartner', array('id' => $id));
if (!$exists) {
return false;
}
$DB->delete_records('findpartner', array('id' => $id));
return true;
}
/**
* This creates new events given as closeopen by $findpartner.
*
* @param stdClass $findpartner
* @return void
*/
function findpartner_set_events($findpartner) {
global $DB, $CFG;
// Include calendar/lib.php.
require_once($CFG->dirroot.'/calendar/lib.php');
require_once($CFG->dirroot . '/mod/findpartner/locallib.php');
// Get CMID if not sent as part of $findpartner.
if (!isset($findpartner->coursemodule)) {
$cm = get_coursemodule_from_instance('findpartner',
$findpartner->id, $findpartner->course);
$findpartner->coursemodule = $cm->id;
}
// Get old event.
$oldevent = null;
$oldevent = $DB->get_record('event',
array('modulename' => 'findpartner',
'instance' => $findpartner->id, 'eventtype' => FINDPARTNER_EVENT_TYPE_DUE));
if ($findpartner->dateclosuregroups) {
// Create calendar event.
$event = new stdClass();
$event->type = CALENDAR_EVENT_TYPE_ACTION;
$event->name = $findpartner->name .' ('.get_string('duedate', 'mod_findpartner').')';
$event->description = format_module_intro('findpartner', $findpartner, $findpartner->coursemodule);
$event->courseid = $findpartner->course;
$event->groupid = 0;
$event->userid = 0;
$event->modulename = 'findpartner';
$event->instance = $findpartner->id;
$event->eventtype = FINDPARTNER_EVENT_TYPE_DUE;
$event->visible = instance_is_visible('findpartner', $findpartner);
$event->timestart = $findpartner->dateclosuregroups;
$event->timeduration = 0;
$event->timesort = $event->timestart + $event->timeduration;
if ($oldevent) {
$event->id = $oldevent->id;
} else {
unset($event->id);
}
// Create also updates an existing event.
calendar_event::create($event);
} else {
// Delete calendar event.
if ($oldevent) {
$calendarevent = calendar_event::load($oldevent);
$calendarevent->delete();
}
}
}