MDL-14679 fixed references to mod.html
[moodle.git] / mod / label / lib.php
1 <?php  // $Id$
3 /// Library of functions and constants for module label
6 define("LABEL_MAX_NAME_LENGTH", 50);
8 function label_add_instance($label) {
9 /// Given an object containing all the necessary data, 
10 /// (defined by the form in mod_form.php) this function 
11 /// will create a new instance and return the id number 
12 /// of the new instance.
13     $textlib = textlib_get_instance();
15     $label->name = addslashes(strip_tags(format_string(stripslashes($label->content),true)));
16     if ($textlib->strlen($label->name) > LABEL_MAX_NAME_LENGTH) {
17         $label->name = $textlib->substr($label->name, 0, LABEL_MAX_NAME_LENGTH)."...";
18     }
19     $label->timemodified = time();
21     return insert_record("label", $label);
22 }
25 function label_update_instance($label) {
26 /// Given an object containing all the necessary data, 
27 /// (defined by the form in mod_form.php) this function 
28 /// will update an existing instance with new data.
29     $textlib = textlib_get_instance();
31     $label->name = addslashes(strip_tags(format_string(stripslashes($label->content),true)));
32     if ($textlib->strlen($label->name) > LABEL_MAX_NAME_LENGTH) {
33         $label->name = $textlib->substr($label->name, 0, LABEL_MAX_NAME_LENGTH)."...";
34     }
35     $label->timemodified = time();
36     $label->id = $label->instance;
38     return update_record("label", $label);
39 }
42 function label_delete_instance($id) {
43 /// Given an ID of an instance of this module, 
44 /// this function will permanently delete the instance 
45 /// and any data that depends on it.  
47     if (! $label = get_record("label", "id", "$id")) {
48         return false;
49     }
51     $result = true;
53     if (! delete_records("label", "id", "$label->id")) {
54         $result = false;
55     }
57     return $result;
58 }
60 function label_get_participants($labelid) {
61 //Returns the users with data in one resource
62 //(NONE, but must exist on EVERY mod !!)
64     return false;
65 }
67 /**
68  * Given a course_module object, this function returns any
69  * "extra" information that may be needed when printing
70  * this activity in a course listing.
71  * See get_array_of_activities() in course/lib.php
72  */
73 function label_get_coursemodule_info($coursemodule) {
74     if ($label = get_record('label', 'id', $coursemodule->instance, '', '', '', '', 'id, content, name')) {
75         $info = new object();
76         $info->extra = urlencode($label->content);
77         $info->name = urlencode($label->name);
78         return $info;
79     } else {
80         return null;
81     }
82 }
84 function label_get_view_actions() {
85     return array();
86 }
88 function label_get_post_actions() {
89     return array();
90 }
92 function label_get_types() {
93     $types = array();
95     $type = new object();
96     $type->modclass = MOD_CLASS_RESOURCE;
97     $type->type = "label";
98     $type->typestr = get_string('resourcetypelabel', 'resource');
99     $types[] = $type;
101     return $types;
104 /**
105  * This function is used by the reset_course_userdata function in moodlelib.
106  * @param $data the data submitted from the reset course.
107  * @return array status array
108  */
109 function label_reset_userdata($data) {
110     return array();
113 ?>