/
lib.php
223 lines (179 loc) · 6.09 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
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
<?php // $Id: lib.php,v 1.7.2.5 2009/04/22 21:30:57 skodak Exp $
/**
* Library of functions and constants for module shoppingcart
* This file should have two well differenced parts:
* - All the core Moodle functions, neeeded to allow
* the module to work integrated in Moodle.
* - All the shoppingcart specific functions, needed
* to implement all the module logic. Please, note
* that, if the module become complex and this lib
* grows a lot, it's HIGHLY recommended to move all
* these module specific functions to a new php file,
* called "locallib.php" (see forum, quiz...). This will
* help to save some memory when Moodle is performing
* actions across all modules.
*/
/// (replace shoppingcart with the name of your module and delete this line)
$shoppingcart_EXAMPLE_CONSTANT = 42; /// for example
/**
* 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 $shoppingcart An object from the form in mod_form.php
* @return int The id of the newly inserted shoppingcart record
*/
function shoppingcart_add_instance($shoppingcart) {
$shoppingcart->timecreated = time();
# You may have to add extra stuff in here #
return insert_record('shoppingcart', $shoppingcart);
}
/**
* 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 $shoppingcart An object from the form in mod_form.php
* @return boolean Success/Fail
*/
function shoppingcart_update_instance($shoppingcart) {
$shoppingcart->timemodified = time();
$shoppingcart->id = $shoppingcart->instance;
# You may have to add extra stuff in here #
return update_record('shoppingcart', $shoppingcart);
}
/**
* 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 shoppingcart_delete_instance($id) {
if (! $shoppingcart = get_record('shoppingcart', 'id', $id)) {
return false;
}
$result = true;
# Delete any dependent records here #
if (! delete_records('shoppingcart', 'id', $shoppingcart->id)) {
$result = false;
}
return $result;
}
/**
* Return 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 null
* @todo Finish documenting this function
*/
function shoppingcart_user_outline($course, $user, $mod, $shoppingcart) {
return $return;
}
/**
* Print a detailed representation of what a user has done with
* a given particular instance of this module, for user activity reports.
*
* @return boolean
* @todo Finish documenting this function
*/
function shoppingcart_user_complete($course, $user, $mod, $shoppingcart) {
return true;
}
/**
* Given a course and a time, this module should find recent activity
* that has occurred in shoppingcart activities and print it out.
* Return true if there was output, or false is there was none.
*
* @return boolean
* @todo Finish documenting this function
*/
function shoppingcart_print_recent_activity($course, $isteacher, $timestart) {
return false; // True if anything was printed, otherwise false
}
/**
* 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 shoppingcart_cron () {
return true;
}
/**
* Must return an array of user records (all data) who are participants
* for a given instance of shoppingcart. Must include every user involved
* in the instance, independient of his role (student, teacher, admin...)
* See other modules as example.
*
* @param int $shoppingcartid ID of an instance of this module
* @return mixed boolean/array of students
*/
function shoppingcart_get_participants($shoppingcartid) {
return false;
}
/**
* This function returns if a scale is being used by one shoppingcart
* 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 $shoppingcartid ID of an instance of this module
* @return mixed
* @todo Finish documenting this function
*/
function shoppingcart_scale_used($shoppingcartid, $scaleid) {
$return = false;
//$rec = get_record("shoppingcart","id","$shoppingcartid","scale","-$scaleid");
//
//if (!empty($rec) && !empty($scaleid)) {
// $return = true;
//}
return $return;
}
/**
* Checks if scale is being used by any instance of shoppingcart.
* This function was added in 1.9
*
* This is used to find out if scale used anywhere
* @param $scaleid int
* @return boolean True if the scale is used by any shoppingcart
*/
function shoppingcart_scale_used_anywhere($scaleid) {
if ($scaleid and record_exists('shoppingcart', 'grade', -$scaleid)) {
return true;
} else {
return false;
}
}
/**
* Execute post-install custom actions for the module
* This function was added in 1.9
*
* @return boolean true if success, false on error
*/
function shoppingcart_install() {
return true;
}
/**
* Execute post-uninstall custom actions for the module
* This function was added in 1.9
*
* @return boolean true if success, false on error
*/
function shoppingcart_uninstall() {
return true;
}
//////////////////////////////////////////////////////////////////////////////////////
/// Any other shoppingcart functions go here. Each of them must have a name that
/// starts with shoppingcart_
/// Remember (see note in first lines) that, if this section grows, it's HIGHLY
/// recommended to move all funcions below to a new "localib.php" file.
?>