MDL-23864 auth/cas Coding error: Undefined index REQUEST_URI in auth/cas/CAS/CAS.php
[moodle.git] / notes / lib.php
CommitLineData
1d422980 1<?php
83e70cc2 2
3/**
4 * Library of functions and constants for notes
5 */
6
7/**
8 * Constants for states.
9 */
10define('NOTES_STATE_DRAFT', 'draft');
11define('NOTES_STATE_PUBLIC', 'public');
12define('NOTES_STATE_SITE', 'site');
13
14/**
15 * Constants for note parts (flags used by note_print and note_print_list).
16 */
17define('NOTES_SHOW_FULL', 0x07);
18define('NOTES_SHOW_HEAD', 0x02);
19define('NOTES_SHOW_BODY', 0x01);
20define('NOTES_SHOW_FOOT', 0x04);
21
22/**
23 * Retrieves a list of note objects with specific atributes.
24 *
25 * @param int $courseid id of the course in which the notes were posted (0 means any)
26 * @param int $userid id of the user to which the notes refer (0 means any)
27 * @param string $state state of the notes (i.e. draft, public, site) ('' means any)
28 * @param int $author id of the user who modified the note last time (0 means any)
29 * @param string $order an order to sort the results in
30 * @param int $limitfrom number of records to skip (offset)
31 * @param int $limitnum number of records to fetch
32 * @return array of note objects
33 */
34function note_list($courseid=0, $userid=0, $state = '', $author = 0, $order='lastmodified DESC', $limitfrom=0, $limitnum=0) {
b3829d0a 35 global $DB;
36
83e70cc2 37 // setup filters
db4ff7f8 38 $selects = array();
b3829d0a 39 $params = array();
40 if ($courseid) {
41 $selects[] = 'courseid=?';
42 $params[] = $courseid;
83e70cc2 43 }
b3829d0a 44 if ($userid) {
45 $selects[] = 'userid=?';
46 $params[] = $userid;
83e70cc2 47 }
b3829d0a 48 if ($author) {
49 $selects[] = 'usermodified=?';
50 $params[] = $author;
83e70cc2 51 }
b3829d0a 52 if ($state) {
53 $selects[] = 'publishstate=?';
54 $params[] = $state;
83e70cc2 55 }
b3829d0a 56 $selects[] = "module=?";
57 $params[] = 'notes';
58
83e70cc2 59 $select = implode(' AND ', $selects);
60 $fields = 'id,courseid,userid,content,format,created,lastmodified,usermodified,publishstate';
61 // retrieve data
b3829d0a 62 return $DB->get_records_select('post', $select, $params, $order, $fields, $limitfrom, $limitnum);
83e70cc2 63}
64
65/**
66 * Retrieves a note object based on its id.
67 *
68 * @param int $note_id id of the note to retrieve
69 * @return note object
70 */
71function note_load($note_id) {
b3829d0a 72 global $DB;
73
83e70cc2 74 $fields = 'id,courseid,userid,content,format,created,lastmodified,usermodified,publishstate';
b3829d0a 75 return $DB->get_record('post', array('id'=>$note_id, 'module'=>'notes'), $fields);
83e70cc2 76}
77
78/**
1519cdeb 79 * Saves a note object. The note object is passed by reference and its fields (i.e. id)
83e70cc2 80 * might change during the save.
81 *
82 * @param note $note object to save
83 * @return boolean true if the object was saved; false otherwise
84 */
85function note_save(&$note) {
b3829d0a 86 global $USER, $DB;
87
83e70cc2 88 // setup & clean fields
b3829d0a 89 $note->module = 'notes';
83e70cc2 90 $note->lastmodified = time();
91 $note->usermodified = $USER->id;
241bcec5 92 if (empty($note->format)) {
83e70cc2 93 $note->format = FORMAT_PLAIN;
94 }
241bcec5 95 if (empty($note->publishstate)) {
83e70cc2 96 $note->publishstate = NOTES_STATE_PUBLIC;
97 }
98 // save data
241bcec5 99 if (empty($note->id)) {
83e70cc2 100 // insert new note
101 $note->created = $note->lastmodified;
b3829d0a 102 if ($id = $DB->insert_record('post', $note)) {
241bcec5 103 $note = $DB->get_record('post', array('id'=>$id));
83e70cc2 104 $result = true;
105 } else {
106 $result = false;
107 }
108 } else {
109 // update old note
b3829d0a 110 $result = $DB->update_record('post', $note);
83e70cc2 111 }
112 unset($note->module);
113 return $result;
114}
115
116/**
117 * Deletes a note object based on its id.
118 *
119 * @param int $note_id id of the note to delete
120 * @return boolean true if the object was deleted; false otherwise
121 */
122function note_delete($noteid) {
b3829d0a 123 global $DB;
124
125 return $DB->delete_records('post', array('id'=>$noteid, 'module'=>'notes'));
83e70cc2 126}
127
128/**
129 * Converts a state value to its corespondent name
130 *
131 * @param string $state state value to convert
132 * @return string corespondent state name
133 */
134function note_get_state_name($state) {
135 // cache state names
136 static $states;
137 if (empty($states)) {
138 $states = note_get_state_names();
139 }
b3829d0a 140 if (isset($states[$state])) {
141 return $states[$state];
142 } else {
143 return null;
144 }
83e70cc2 145}
146
147/**
148 * Returns an array of mappings from state values to state names
149 *
150 * @return array of mappings
151 */
152function note_get_state_names() {
153 return array(
154 NOTES_STATE_DRAFT => get_string('personal', 'notes'),
155 NOTES_STATE_PUBLIC => get_string('course', 'notes'),
156 NOTES_STATE_SITE => get_string('site', 'notes'),
157 );
158}
159
160/**
161 * Prints a note object
162 *
163 * @param note $note the note object to print
164 * @param int $detail OR-ed NOTES_SHOW_xyz flags that specify which note parts to print
165 */
166function note_print($note, $detail = NOTES_SHOW_FULL) {
4fa7dc61 167 global $CFG, $USER, $DB, $OUTPUT;
83e70cc2 168
b3829d0a 169 if (!$user = $DB->get_record('user', array('id'=>$note->userid))) {
807188eb 170 debugging("User $note->userid not found");
171 return;
172 }
b3829d0a 173 if (!$author = $DB->get_record('user', array('id'=>$note->usermodified))) {
807188eb 174 debugging("User $note->usermodified not found");
175 return;
176 }
83e70cc2 177 $context = get_context_instance(CONTEXT_COURSE, $note->courseid);
241bcec5 178 $systemcontext = get_context_instance(CONTEXT_SYSTEM);
807188eb 179
b3829d0a 180 $authoring = new object();
807188eb 181 $authoring->name = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$author->id.'&amp;course='.$note->courseid.'">'.fullname($author).'</a>';
83e70cc2 182 $authoring->date = userdate($note->lastmodified);
807188eb 183
1519cdeb 184 echo '<div class="notepost '. $note->publishstate . 'notepost' .
83e70cc2 185 ($note->usermodified == $USER->id ? ' ownnotepost' : '') .
186 '" id="note-'. $note->id .'">';
187
188 // print note head (e.g. author, user refering to, etc)
241bcec5 189 if ($detail & NOTES_SHOW_HEAD) {
83e70cc2 190 echo '<div class="header">';
191 echo '<div class="user">';
812dbaf7 192 echo $OUTPUT->user_picture($user, array('courseid'=>$note->courseid));
83e70cc2 193 echo fullname($user) . '</div>';
1519cdeb 194 echo '<div class="info">' .
195 get_string('bynameondate', 'notes', $authoring) .
83e70cc2 196 ' (' . get_string('created', 'notes') . ': ' . userdate($note->created) . ')</div>';
197 echo '</div>';
198 }
1519cdeb 199
83e70cc2 200 // print note content
241bcec5 201 if ($detail & NOTES_SHOW_BODY) {
83e70cc2 202 echo '<div class="content">';
203 echo format_text($note->content, $note->format);
204 echo '</div>';
205 }
1519cdeb 206
83e70cc2 207 // print note options (e.g. delete, edit)
241bcec5 208 if ($detail & NOTES_SHOW_FOOT) {
209 if (has_capability('moodle/notes:manage', $systemcontext) && $note->publishstate == NOTES_STATE_SITE ||
83e70cc2 210 has_capability('moodle/notes:manage', $context) && ($note->publishstate == NOTES_STATE_PUBLIC || $note->usermodified == $USER->id)) {
211 echo '<div class="footer"><p>';
241bcec5 212 echo '<a href="'.$CFG->wwwroot.'/notes/edit.php?id='.$note->id. '">'. get_string('edit') .'</a> | ';
213 echo '<a href="'.$CFG->wwwroot.'/notes/delete.php?id='.$note->id. '">'. get_string('delete') .'</a>';
83e70cc2 214 echo '</p></div>';
215 }
216 }
217 echo '</div>';
218}
219
220/**
221 * Prints a list of note objects
222 *
223 * @param array $notes array of note objects to print
224 * @param int $detail OR-ed NOTES_SHOW_xyz flags that specify which note parts to print
225 */
226function note_print_list($notes, $detail = NOTES_SHOW_FULL) {
227
228 /// Start printing of the note
229 echo '<div class="notelist">';
230 foreach ($notes as $note) {
231 note_print($note, $detail);
232 }
233 echo '</div>';
234}
235
236/**
237 * Retrieves and prints a list of note objects with specific atributes.
238 *
239 * @param string $header HTML to print above the list
240 * @param int $addcourseid id of the course for the add notes link (0 hide link)
241 * @param boolean $viewnotes true if the notes should be printed; false otherwise (print notesnotvisible string)
242 * @param int $courseid id of the course in which the notes were posted (0 means any)
243 * @param int $userid id of the user to which the notes refer (0 means any)
244 * @param string $state state of the notes (i.e. draft, public, site) ('' means any)
245 * @param int $author id of the user who modified the note last time (0 means any)
246 */
b3829d0a 247function note_print_notes($header, $addcourseid = 0, $viewnotes = true, $courseid = 0, $userid = 0, $state = '', $author = 0) {
83e70cc2 248 global $CFG;
b3829d0a 249
83e70cc2 250 if ($header) {
251 echo '<h3 class="notestitle">' . $header . '</h3>';
252 echo '<div class="notesgroup">';
253 }
254 if ($addcourseid) {
9f26cce6 255 if ($userid) {
241bcec5 256 echo '<p><a href="'. $CFG->wwwroot .'/notes/edit.php?courseid=' . $addcourseid . '&amp;userid=' . $userid . '&amp;publishstate=' . $state . '">' . get_string('addnewnote', 'notes') . '</a></p>';
9f26cce6 257 } else {
258 echo '<p><a href="'. $CFG->wwwroot .'/user/index.php?id=' . $addcourseid. '">' . get_string('addnewnoteselect', 'notes') . '</a></p>';
259 }
83e70cc2 260 }
261 if ($viewnotes) {
b3829d0a 262 $notes = note_list($courseid, $userid, $state, $author);
83e70cc2 263 if ($notes) {
264 note_print_list($notes);
265 }
266 } else {
267 echo '<p>' . get_string('notesnotvisible', 'notes') . '</p>';
268 }
269 if ($header) {
270 echo '</div>'; // notesgroup
271 }
272}
273
0b5a80a1 274/**
275 * Delete all notes about users in course-
276 * @param int $courseid
277 * @return bool success
278 */
279function note_delete_all($courseid) {
b3829d0a 280 global $DB;
281
282 return $DB->delete_records('post', array('module'=>'notes', 'courseid'=>$courseid));
0b5a80a1 283}