From: gustav_delius <gustav_delius>
Date: Sat, 25 Sep 2004 20:27:15 +0000 (+0000)
Subject: added explanation for format and visible fields in event table
X-Git-Url: http://git.mjollnir.org/gw?a=commitdiff_plain;h=7ecb19bba02c29377423950031d10e1b7a82247d;p=moodle.git

added explanation for format and visible fields in event table
---

diff --git a/lib/moodlelib.php b/lib/moodlelib.php
index ae7a9f036f..e75e65a244 100644
--- a/lib/moodlelib.php
+++ b/lib/moodlelib.php
@@ -3077,6 +3077,7 @@ function endecrypt ($pwd, $data, $case) {
  *  <ul>
  *    <li><b>$event->name</b> - Name for the event
  *    <li><b>$event->description</b> - Description of the event (defaults to '')
+ *    <li><b>$event->format</b> - Format for the description (using formatting types defined at the top of weblib.php)
  *    <li><b>$event->courseid</b> - The id of the course this event belongs to (0 = all courses)
  *    <li><b>$event->groupid</b> - The id of the group this event belongs to (0 = no group)
  *    <li><b>$event->userid</b> - The id of the user this event belongs to (0 = no user)
@@ -3086,6 +3087,7 @@ function endecrypt ($pwd, $data, $case) {
  *             be used by calendar plugins to decide how to display event
  *    <li><b>$event->timestart</b>- Timestamp for start of event
  *    <li><b>$event->timeduration</b> - Duration (defaults to zero)
+ *    <li><b>$event->>visible</b> - 0 if the event should be hidden (e.g. because the activity that created it is hidden)
  *  </ul>
  * @return int The id number of the resulting record
  * @todo Finish documenting this function
@@ -3987,4 +3989,4 @@ if(!function_exists('html_entity_decode')) {
 }
 
 // vim:autoindent:expandtab:shiftwidth=4:tabstop=4:tw=140:
-?>
\ No newline at end of file
+?>