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 = $DB->get_record('post', array('id'=>$id));
 104     } else {
 105         // update old note
 106         $DB->update_record('post', $note);
 107     }
 108     unset($note->module);
 109     return true;
 110 }
 111
 112 /**
 113  * Deletes a note object based on its id.
 114  *
 115  * @param int    $note_id id of the note to delete
 116  * @return boolean true if the object was deleted; false otherwise
 117  */
 118 function note_delete($noteid) {
 119     global $DB;
 120
 121     return $DB->delete_records('post', array('id'=>$noteid, 'module'=>'notes'));
 122 }
 123
 124 /**
 125  * Converts a state value to its corespondent name
 126  *
 127  * @param string  $state state value to convert
 128  * @return string corespondent state name
 129  */
 130 function note_get_state_name($state) {
 131     // cache state names
 132     static $states;
 133     if (empty($states)) {
 134         $states = note_get_state_names();
 135     }
 136     if (isset($states[$state])) {
 137         return $states[$state];
 138     } else {
 139         return null;
 140     }
 141 }
 142
 143 /**
 144  * Returns an array of mappings from state values to state names
 145  *
 146  * @return array of mappings
 147  */
 148 function note_get_state_names() {
 149     return array(
 150         NOTES_STATE_DRAFT => get_string('personal', 'notes'),
 151         NOTES_STATE_PUBLIC => get_string('course', 'notes'),
 152         NOTES_STATE_SITE => get_string('site', 'notes'),
 153     );
 154 }
 155
 156 /**
 157  * Prints a note object
 158  *
 159  * @param note  $note the note object to print
 160  * @param int   $detail OR-ed NOTES_SHOW_xyz flags that specify which note parts to print
 161  */
 162 function note_print($note, $detail = NOTES_SHOW_FULL) {
 163     global $CFG, $USER, $DB, $OUTPUT;
 164
 165     if (!$user = $DB->get_record('user', array('id'=>$note->userid))) {
 166         debugging("User $note->userid not found");
 167         return;
 168     }
 169     if (!$author = $DB->get_record('user', array('id'=>$note->usermodified))) {
 170         debugging("User $note->usermodified not found");
 171         return;
 172     }
 173     $context = context_course::instance($note->courseid);
 174     $systemcontext = context_system::instance();
 175
 176     $authoring = new stdClass();
 177     $authoring->name = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$author->id.'&amp;course='.$note->courseid.'">'.fullname($author).'</a>';
 178     $authoring->date = userdate($note->lastmodified);
 179
 180     echo '<div class="notepost '. $note->publishstate . 'notepost' .
 181         ($note->usermodified == $USER->id ? ' ownnotepost' : '')  .
 182         '" id="note-'. $note->id .'">';
 183
 184     // print note head (e.g. author, user refering to, etc)
 185     if ($detail & NOTES_SHOW_HEAD) {
 186         echo '<div class="header">';
 187         echo '<div class="user">';
 188         echo $OUTPUT->user_picture($user, array('courseid'=>$note->courseid));
 189         echo fullname($user) . '</div>';
 190         echo '<div class="info">' .
 191             get_string('bynameondate', 'notes', $authoring) .
 192             ' (' . get_string('created', 'notes') . ': ' . userdate($note->created) . ')</div>';
 193         echo '</div>';
 194     }
 195
 196     // print note content
 197     if ($detail & NOTES_SHOW_BODY) {
 198         echo '<div class="content">';
 199         echo format_text($note->content, $note->format, array('overflowdiv'=>true));
 200         echo '</div>';
 201     }
 202
 203     // print note options (e.g. delete, edit)
 204     if ($detail & NOTES_SHOW_FOOT) {
 205         if (has_capability('moodle/notes:manage', $systemcontext) && $note->publishstate == NOTES_STATE_SITE ||
 206             has_capability('moodle/notes:manage', $context) && ($note->publishstate == NOTES_STATE_PUBLIC || $note->usermodified == $USER->id)) {
 207             echo '<div class="footer"><p>';
 208             echo '<a href="'.$CFG->wwwroot.'/notes/edit.php?id='.$note->id. '">'. get_string('edit') .'</a> | ';
 209             echo '<a href="'.$CFG->wwwroot.'/notes/delete.php?id='.$note->id. '">'. get_string('delete') .'</a>';
 210             echo '</p></div>';
 211         }
 212     }
 213     echo '</div>';
 214 }
 215
 216 /**
 217  * Prints a list of note objects
 218  *
 219  * @param array  $notes array of note objects to print
 220  * @param int   $detail OR-ed NOTES_SHOW_xyz flags that specify which note parts to print
 221  */
 222 function note_print_list($notes, $detail = NOTES_SHOW_FULL) {
 223
 224     /// Start printing of the note
 225     echo '<div class="notelist">';
 226     foreach ($notes as $note) {
 227         note_print($note, $detail);
 228     }
 229     echo '</div>';
 230 }
 231
 232 /**
 233  * Retrieves and prints a list of note objects with specific atributes.
 234  *
 235  * @param string  $header HTML to print above the list
 236  * @param int     $addcourseid id of the course for the add notes link (0 hide link)
 237  * @param boolean $viewnotes true if the notes should be printed; false otherwise (print notesnotvisible string)
 238  * @param int     $courseid id of the course in which the notes were posted (0 means any)
 239  * @param int     $userid id of the user to which the notes refer (0 means any)
 240  * @param string  $state state of the notes (i.e. draft, public, site) ('' means any)
 241  * @param int     $author id of the user who modified the note last time (0 means any)
 242  */
 243 function note_print_notes($header, $addcourseid = 0, $viewnotes = true, $courseid = 0, $userid = 0, $state = '', $author = 0) {
 244     global $CFG;
 245
 246     if ($header) {
 247         echo '<h3 class="notestitle">' . $header . '</h3>';
 248         echo '<div class="notesgroup">';
 249     }
 250     if ($addcourseid) {
 251         if ($userid) {
 252            echo '<p><a href="'. $CFG->wwwroot .'/notes/edit.php?courseid=' . $addcourseid . '&amp;userid=' . $userid . '&amp;publishstate=' . $state . '">' . get_string('addnewnote', 'notes') . '</a></p>';
 253         } else {
 254            echo '<p><a href="'. $CFG->wwwroot .'/user/index.php?id=' . $addcourseid. '">' . get_string('addnewnoteselect', 'notes') . '</a></p>';
 255         }
 256     }
 257     if ($viewnotes) {
 258         $notes = note_list($courseid, $userid, $state, $author);
 259         if ($notes) {
 260             note_print_list($notes);
 261         }
 262     } else {
 263         echo '<p>' . get_string('notesnotvisible', 'notes') . '</p>';
 264     }
 265     if ($header) {
 266         echo '</div>';  // notesgroup
 267     }
 268 }
 269
 270 /**
 271  * Delete all notes about users in course-
 272  * @param int $courseid
 273  * @return bool success
 274  */
 275 function note_delete_all($courseid) {
 276     global $DB;
 277
 278     return $DB->delete_records('post', array('module'=>'notes', 'courseid'=>$courseid));
 279 }
 280
 281 /**
 282  * Return a list of page types
 283  * @param string $pagetype current page type
 284  * @param stdClass $parentcontext Block's parent context
 285  * @param stdClass $currentcontext Current context of block
 286  */
 287 function note_page_type_list($pagetype, $parentcontext, $currentcontext) {
 288     return array('notes-*'=>get_string('page-notes-x', 'notes'));
 289 }