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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
|
<?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/>.
/**
* Library of interface functions and constants for module sqlbox
*
* All the core Moodle functions, neeeded to allow the module to work
* integrated in Moodle should be placed here.
* All the sqlbox specific functions, needed to implement all the module
* logic, should go to locallib.php. This will help to save some memory when
* Moodle is performing actions across all modules.
*
* @package mod
* @subpackage sqlbox
* @copyright 2011 Your Name
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
/** example constant */
//define('NEWMODULE_ULTIMATE_ANSWER', 42);
////////////////////////////////////////////////////////////////////////////////
// Moodle core API //
////////////////////////////////////////////////////////////////////////////////
/**
* Returns the information on whether the module supports a feature
*
* @see plugin_supports() in lib/moodlelib.php
* @param string $feature FEATURE_xx constant for requested feature
* @return mixed true if the feature is supported, null if unknown
*/
function sqlbox_supports($feature) {
switch($feature) {
case FEATURE_MOD_INTRO: return true;
default: return null;
}
}
/**
* Saves a new instance of the sqlbox 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 new instance.
*
* @param object $sqlbox An object from the form in mod_form.php
* @param mod_sqlbox_mod_form $mform
* @return int The id of the newly inserted sqlbox record
*/
function sqlbox_add_instance(stdClass $sqlbox, mod_sqlbox_mod_form $mform = null) {
global $DB;
$sqlbox->timecreated = time();
# You may have to add extra stuff in here #
return $DB->insert_record('sqlbox', $sqlbox);
}
/**
* Updates an instance of the sqlbox in the database
*
* Given an object containing all the necessary data,
* (defined by the form in mod_form.php) this function
* will update an existing instance with new data.
*
* @param object $sqlbox An object from the form in mod_form.php
* @param mod_sqlbox_mod_form $mform
* @return boolean Success/Fail
*/
function sqlbox_update_instance(stdClass $sqlbox, mod_sqlbox_mod_form $mform = null) {
global $DB;
$sqlbox->timemodified = time();
$sqlbox->id = $sqlbox->instance;
# You may have to add extra stuff in here #
return $DB->update_record('sqlbox', $sqlbox);
}
/**
* Removes an instance of the sqlbox from the database
*
* Given an ID of an instance of this module,
* this function will permanently delete the instance
* and any data that depends on it.
*
* @param int $id Id of the module instance
* @return boolean Success/Failure
*/
function sqlbox_delete_instance($id) {
global $DB;
if (! $sqlbox = $DB->get_record('sqlbox', array('id' => $id))) {
return false;
}
# Delete any dependent records here #
$DB->delete_records('sqlbox', array('id' => $sqlbox->id));
return true;
}
/**
* Returns a small object with summary information about what a
* user has done with a given particular instance of this module
* Used for user activity reports.
* $return->time = the time they did it
* $return->info = a short text description
*
* @return stdClass|null
*/
function sqlbox_user_outline($course, $user, $mod, $sqlbox) {
$return = new stdClass();
$return->time = 0;
$return->info = '';
return $return;
}
/**
* Prints a detailed representation of what a user has done with
* a given particular instance of this module, for user activity reports.
*
* @param stdClass $course the current course record
* @param stdClass $user the record of the user we are generating report for
* @param cm_info $mod course module info
* @param stdClass $sqlbox the module instance record
* @return void, is supposed to echp directly
*/
function sqlbox_user_complete($course, $user, $mod, $sqlbox) {
}
/**
* Given a course and a time, this module should find recent activity
* that has occurred in sqlbox activities and print it out.
* Return true if there was output, or false is there was none.
*
* @return boolean
*/
function sqlbox_print_recent_activity($course, $viewfullnames, $timestart) {
return false; // True if anything was printed, otherwise false
}
/**
* Prepares the recent activity data
*
* This callback function is supposed to populate the passed array with
* custom activity records. These records are then rendered into HTML via
* {@link sqlbox_print_recent_mod_activity()}.
*
* @param array $activities sequentially indexed array of objects with the 'cmid' property
* @param int $index the index in the $activities to use for the next record
* @param int $timestart append activity since this time
* @param int $courseid the id of the course we produce the report for
* @param int $cmid course module id
* @param int $userid check for a particular user's activity only, defaults to 0 (all users)
* @param int $groupid check for a particular group's activity only, defaults to 0 (all groups)
* @return void adds items into $activities and increases $index
*/
function sqlbox_get_recent_mod_activity(&$activities, &$index, $timestart, $courseid, $cmid, $userid=0, $groupid=0) {
}
/**
* Prints single activity item prepared by {@see sqlbox_get_recent_mod_activity()}
* @return void
*/
function sqlbox_print_recent_mod_activity($activity, $courseid, $detail, $modnames, $viewfullnames) {
}
/**
* Function to be run periodically according to the moodle cron
* This function searches for things that need to be done, such
* as sending out mail, toggling flags etc ...
*
* @return boolean
* @todo Finish documenting this function
**/
function sqlbox_cron () {
return true;
}
/**
* Returns all other caps used in the module
*
* @example return array('moodle/site:accessallgroups');
* @return array
*/
function sqlbox_get_extra_capabilities() {
return array();
}
////////////////////////////////////////////////////////////////////////////////
// Gradebook API //
////////////////////////////////////////////////////////////////////////////////
/**
* Is a given scale used by the instance of sqlbox?
*
* This function returns if a scale is being used by one sqlbox
* if it has support for grading and scales. Commented code should be
* modified if necessary. See forum, glossary or journal modules
* as reference.
*
* @param int $sqlboxid ID of an instance of this module
* @return bool true if the scale is used by the given sqlbox instance
*/
function sqlbox_scale_used($sqlboxid, $scaleid) {
global $DB;
/** @example */
if ($scaleid and $DB->record_exists('sqlbox', array('id' => $sqlboxid, 'grade' => -$scaleid))) {
return true;
} else {
return false;
}
}
/**
* Checks if scale is being used by any instance of sqlbox.
*
* This is used to find out if scale used anywhere.
*
* @param $scaleid int
* @return boolean true if the scale is used by any sqlbox instance
*/
function sqlbox_scale_used_anywhere($scaleid) {
global $DB;
/** @example */
if ($scaleid and $DB->record_exists('sqlbox', array('grade' => -$scaleid))) {
return true;
} else {
return false;
}
}
/**
* Creates or updates grade item for the give sqlbox instance
*
* Needed by grade_update_mod_grades() in lib/gradelib.php
*
* @param stdClass $sqlbox instance object with extra cmidnumber and modname property
* @return void
*/
function sqlbox_grade_item_update(stdClass $sqlbox) {
global $CFG;
require_once($CFG->libdir.'/gradelib.php');
/** @example */
$item = array();
$item['itemname'] = clean_param($sqlbox->name, PARAM_NOTAGS);
$item['gradetype'] = GRADE_TYPE_VALUE;
$item['grademax'] = $sqlbox->grade;
$item['grademin'] = 0;
grade_update('mod/sqlbox', $sqlbox->course, 'mod', 'sqlbox', $sqlbox->id, 0, null, $item);
}
/**
* Update sqlbox grades in the gradebook
*
* Needed by grade_update_mod_grades() in lib/gradelib.php
*
* @param stdClass $sqlbox instance object with extra cmidnumber and modname property
* @param int $userid update grade of specific user only, 0 means all participants
* @return void
*/
function sqlbox_update_grades(stdClass $sqlbox, $userid = 0) {
global $CFG, $DB;
require_once($CFG->libdir.'/gradelib.php');
/** @example */
$grades = array(); // populate array of grade objects indexed by userid
grade_update('mod/sqlbox', $sqlbox->course, 'mod', 'sqlbox', $sqlbox->id, 0, $grades);
}
////////////////////////////////////////////////////////////////////////////////
// File API //
////////////////////////////////////////////////////////////////////////////////
/**
* Returns the lists of all browsable file areas within the given module context
*
* The file area 'intro' for the activity introduction field is added automatically
* by {@link file_browser::get_file_info_context_module()}
*
* @param stdClass $course
* @param stdClass $cm
* @param stdClass $context
* @return array of [(string)filearea] => (string)description
*/
function sqlbox_get_file_areas($course, $cm, $context) {
return array();
}
/**
* File browsing support for sqlbox file areas
*
* @package mod_sqlbox
* @category files
*
* @param file_browser $browser
* @param array $areas
* @param stdClass $course
* @param stdClass $cm
* @param stdClass $context
* @param string $filearea
* @param int $itemid
* @param string $filepath
* @param string $filename
* @return file_info instance or null if not found
*/
function sqlbox_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
return null;
}
/**
* Serves the files from the sqlbox file areas
*
* @package mod_sqlbox
* @category files
*
* @param stdClass $course the course object
* @param stdClass $cm the course module object
* @param stdClass $context the sqlbox's context
* @param string $filearea the name of the file area
* @param array $args extra arguments (itemid, path)
* @param bool $forcedownload whether or not force download
* @param array $options additional options affecting the file serving
*/
function sqlbox_pluginfile($course, $cm, $context, $filearea, array $args, $forcedownload, array $options=array()) {
global $DB, $CFG;
if ($context->contextlevel != CONTEXT_MODULE) {
send_file_not_found();
}
require_login($course, true, $cm);
send_file_not_found();
}
////////////////////////////////////////////////////////////////////////////////
// Navigation API //
////////////////////////////////////////////////////////////////////////////////
/**
* Extends the global navigation tree by adding sqlbox nodes if there is a relevant content
*
* This can be called by an AJAX request so do not rely on $PAGE as it might not be set up properly.
*
* @param navigation_node $navref An object representing the navigation tree node of the sqlbox module instance
* @param stdClass $course
* @param stdClass $module
* @param cm_info $cm
*/
function sqlbox_extend_navigation(navigation_node $navref, stdclass $course, stdclass $module, cm_info $cm) {
}
/**
* Extends the settings navigation with the sqlbox settings
*
* This function is called when the context for the page is a sqlbox module. This is not called by AJAX
* so it is safe to rely on the $PAGE.
*
* @param settings_navigation $settingsnav {@link settings_navigation}
* @param navigation_node $sqlboxnode {@link navigation_node}
*/
function sqlbox_extend_settings_navigation(settings_navigation $settingsnav, navigation_node $sqlboxnode=null) {
}
|