2430d176a36eef6a7bade0e61b98f7c7f0ab2b44
[moodle.git] / mod / label / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Library of functions and constants for module label
20  *
21  * @package    mod
22  * @subpackage label
23  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 defined('MOODLE_INTERNAL') || die;
29 /** LABEL_MAX_NAME_LENGTH = 50 */
30 define("LABEL_MAX_NAME_LENGTH", 50);
32 /**
33  * @uses LABEL_MAX_NAME_LENGTH
34  * @param object $label
35  * @return string
36  */
37 function get_label_name($label) {
38     $name = strip_tags(format_string($label->intro,true));
39     if (textlib::strlen($name) > LABEL_MAX_NAME_LENGTH) {
40         $name = textlib::substr($name, 0, LABEL_MAX_NAME_LENGTH)."...";
41     }
43     if (empty($name)) {
44         // arbitrary name
45         $name = get_string('modulename','label');
46     }
48     return $name;
49 }
50 /**
51  * Given an object containing all the necessary data,
52  * (defined by the form in mod_form.php) this function
53  * will create a new instance and return the id number
54  * of the new instance.
55  *
56  * @global object
57  * @param object $label
58  * @return bool|int
59  */
60 function label_add_instance($label) {
61     global $DB;
63     $label->name = get_label_name($label);
64     $label->timemodified = time();
66     return $DB->insert_record("label", $label);
67 }
69 /**
70  * Given an object containing all the necessary data,
71  * (defined by the form in mod_form.php) this function
72  * will update an existing instance with new data.
73  *
74  * @global object
75  * @param object $label
76  * @return bool
77  */
78 function label_update_instance($label) {
79     global $DB;
81     $label->name = get_label_name($label);
82     $label->timemodified = time();
83     $label->id = $label->instance;
85     return $DB->update_record("label", $label);
86 }
88 /**
89  * Given an ID of an instance of this module,
90  * this function will permanently delete the instance
91  * and any data that depends on it.
92  *
93  * @global object
94  * @param int $id
95  * @return bool
96  */
97 function label_delete_instance($id) {
98     global $DB;
100     if (! $label = $DB->get_record("label", array("id"=>$id))) {
101         return false;
102     }
104     $result = true;
106     if (! $DB->delete_records("label", array("id"=>$label->id))) {
107         $result = false;
108     }
110     return $result;
113 /**
114  * Returns the users with data in one resource
115  * (NONE, but must exist on EVERY mod !!)
116  *
117  * @todo: deprecated - to be deleted in 2.2
118  *
119  * @param int $labelid
120  */
121 function label_get_participants($labelid) {
123     return false;
126 /**
127  * Given a course_module object, this function returns any
128  * "extra" information that may be needed when printing
129  * this activity in a course listing.
130  * See get_array_of_activities() in course/lib.php
131  *
132  * @global object
133  * @param object $coursemodule
134  * @return object|null
135  */
136 function label_get_coursemodule_info($coursemodule) {
137     global $DB;
139     if ($label = $DB->get_record('label', array('id'=>$coursemodule->instance), 'id, name, intro, introformat')) {
140         if (empty($label->name)) {
141             // label name missing, fix it
142             $label->name = "label{$label->id}";
143             $DB->set_field('label', 'name', $label->name, array('id'=>$label->id));
144         }
145         $info = new stdClass();
146         // no filtering hre because this info is cached and filtered later
147         $info->extra = format_module_intro('label', $label, $coursemodule->id, false);
148         $info->name  = $label->name;
149         return $info;
150     } else {
151         return null;
152     }
155 /**
156  * @return array
157  */
158 function label_get_view_actions() {
159     return array();
162 /**
163  * @return array
164  */
165 function label_get_post_actions() {
166     return array();
169 /**
170  * This function is used by the reset_course_userdata function in moodlelib.
171  *
172  * @param object $data the data submitted from the reset course.
173  * @return array status array
174  */
175 function label_reset_userdata($data) {
176     return array();
179 /**
180  * Returns all other caps used in module
181  *
182  * @return array
183  */
184 function label_get_extra_capabilities() {
185     return array('moodle/site:accessallgroups');
188 /**
189  * @uses FEATURE_IDNUMBER
190  * @uses FEATURE_GROUPS
191  * @uses FEATURE_GROUPINGS
192  * @uses FEATURE_GROUPMEMBERSONLY
193  * @uses FEATURE_MOD_INTRO
194  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
195  * @uses FEATURE_GRADE_HAS_GRADE
196  * @uses FEATURE_GRADE_OUTCOMES
197  * @param string $feature FEATURE_xx constant for requested feature
198  * @return bool|null True if module supports feature, false if not, null if doesn't know
199  */
200 function label_supports($feature) {
201     switch($feature) {
202         case FEATURE_IDNUMBER:                return false;
203         case FEATURE_GROUPS:                  return false;
204         case FEATURE_GROUPINGS:               return false;
205         case FEATURE_GROUPMEMBERSONLY:        return true;
206         case FEATURE_MOD_INTRO:               return true;
207         case FEATURE_COMPLETION_TRACKS_VIEWS: return false;
208         case FEATURE_GRADE_HAS_GRADE:         return false;
209         case FEATURE_GRADE_OUTCOMES:          return false;
210         case FEATURE_MOD_ARCHETYPE:           return MOD_ARCHETYPE_RESOURCE;
211         case FEATURE_BACKUP_MOODLE2:          return true;
212         case FEATURE_NO_VIEW_LINK:            return true;
214         default: return null;
215     }