notes/lib.php

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